diff --git a/content/reference/datatypes/BluePages_Container_EmployeeProfile/_index.md b/content/reference/datatypes/BluePages_Container_EmployeeProfile/_index.md index a3ceb6e1b3..0a0e4e558b 100644 --- a/content/reference/datatypes/BluePages_Container_EmployeeProfile/_index.md +++ b/content/reference/datatypes/BluePages_Container_EmployeeProfile/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [address1]: #address1 #### [address1] Employee address -Type: **string** +Type: **string** +
@@ -55,7 +58,8 @@ Employee address [address2]: #address2 #### [address2] Employee address -Type: **string** +Type: **string** +
@@ -65,7 +69,8 @@ Employee address [addressCountry]: #addresscountry #### [addressCountry] Country of employee's address -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Country of employee's address [city]: #city #### [city] Employee city -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ Employee city [departmentCode]: #departmentcode #### [departmentCode] Employee department code -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Employee department code [departmentCountry]: #departmentcountry #### [departmentCountry] Employee department country code -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ Employee department country code [divisionCode]: #divisioncode #### [divisionCode] Employee division code -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ Employee division code [emailAddress]: #emailaddress #### [emailAddress] Employee email address -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ Employee email address [firstName]: #firstname #### [firstName] Employee first name -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Employee first name [lastName]: #lastname #### [lastName] Employee last name -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ Employee last name [managerEmailAddress]: #manageremailaddress #### [managerEmailAddress] Email of employee's manager -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ Email of employee's manager [managerFirstName]: #managerfirstname #### [managerFirstName] Employee's manager's first name -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ Employee's manager's first name [managerLastName]: #managerlastname #### [managerLastName] Employee's manager's last name -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ Employee's manager's last name [managerUid]: #manageruid #### [managerUid] Employee' manager's identifier -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ Employee' manager's identifier [phone]: #phone #### [phone] Employee phone number -Type: **string** +Type: **string** + @@ -195,7 +212,8 @@ Employee phone number [postalCode]: #postalcode #### [postalCode] Employee postal code -Type: **string** +Type: **string** + @@ -205,7 +223,8 @@ Employee postal code [state]: #state #### [state] Employee state -Type: **string** +Type: **string** + @@ -215,7 +234,8 @@ Employee state [uid]: #uid #### [uid] Employee identifier -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/BluePages_Search/_index.md b/content/reference/datatypes/BluePages_Search/_index.md index 1077c44c40..7b98f6f4d2 100644 --- a/content/reference/datatypes/BluePages_Search/_index.md +++ b/content/reference/datatypes/BluePages_Search/_index.md @@ -24,6 +24,8 @@ classes: + +
diff --git a/content/reference/datatypes/IntegratedOfferingTeam_Container_Region/_index.md b/content/reference/datatypes/IntegratedOfferingTeam_Container_Region/_index.md index 9bb4083322..78249f5a82 100644 --- a/content/reference/datatypes/IntegratedOfferingTeam_Container_Region/_index.md +++ b/content/reference/datatypes/IntegratedOfferingTeam_Container_Region/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
@@ -55,7 +58,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
diff --git a/content/reference/datatypes/IntegratedOfferingTeam_Container_Region_Lead/_index.md b/content/reference/datatypes/IntegratedOfferingTeam_Container_Region_Lead/_index.md index bb44e3347f..3e7bce6b61 100644 --- a/content/reference/datatypes/IntegratedOfferingTeam_Container_Region_Lead/_index.md +++ b/content/reference/datatypes/IntegratedOfferingTeam_Container_Region_Lead/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [emailAddress]: #emailaddress #### [emailAddress] Regional lead's email address -Type: **string** +Type: **string** +
@@ -55,7 +58,8 @@ Regional lead's email address [firstName]: #firstname #### [firstName] Regional lead's first name -Type: **string** +Type: **string** +
@@ -65,7 +69,8 @@ Regional lead's first name [lastName]: #lastname #### [lastName] Regional lead's last name -Type: **string** +Type: **string** +
@@ -75,7 +80,8 @@ Regional lead's last name [regionKeyName]: #regionkeyname #### [regionKeyName] Key name of the region this lead is in charge of -Type: **string** +Type: **string** +
@@ -85,7 +91,8 @@ Key name of the region this lead is in charge of [regionName]: #regionname #### [regionName] Full name of the region this lead is in charge of -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/IntegratedOfferingTeam_Region/_index.md b/content/reference/datatypes/IntegratedOfferingTeam_Region/_index.md index da59218449..69c26fec4c 100644 --- a/content/reference/datatypes/IntegratedOfferingTeam_Region/_index.md +++ b/content/reference/datatypes/IntegratedOfferingTeam_Region/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class represents an Integrated Offering Team region. diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Agent_Details/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Agent_Details/_index.md index 6a89d3f38b..d8f436b949 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Agent_Details/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Agent_Details/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The McAfee_Epolicy_Orchestrator_Version36_Agent_Details data type represents a virus scan agent and contains details about its version. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version36_Agent_Details data type represents a v [agentVersion]: #agentversion #### [agentVersion] Version number of the anti-virus scan agent. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Version number of the anti-virus scan agent. [lastUpdate]: #lastupdate #### [lastUpdate] The date of the last time the anti-virus agent checked in. -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ The date of the last time the anti-virus agent checked in. [currentPolicy]: #currentpolicy #### [currentPolicy] The current anti-virus policy of an agent. -Type: **McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details** +Type: **McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details/_index.md index b8ff05944a..29189437bc 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details data type contains the name of an anti-virus policy. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details data type contain [name]: #name #### [name] The name of a policy. -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ The name of a policy. [currentPolicy]: #currentpolicy #### [currentPolicy] The current anti-virus policy of an agent. -Type: **McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details** +Type: **McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event/_index.md index 84442072cc..094d02fd66 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event data type represents a [eventLocalDateTime]: #eventlocaldatetime #### [eventLocalDateTime] The date when an anti-virus event occurs. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The date when an anti-virus event occurs. [filename]: #filename #### [filename] Name of the file found to be infected. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Name of the file found to be infected. [virusName]: #virusname #### [virusName] The name of a virus that is found. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The name of a virus that is found. [virusType]: #virustype #### [virusType] The type of virus that is found. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The type of virus that is found. [virusActionTaken]: #virusactiontaken #### [virusActionTaken] The action taken when a virus is detected. -Type: **McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_Filter_Description** +Type: **McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_Filter_Description** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_AccessProtection/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_AccessProtection/_index.md index dba3558952..a500cd16fc 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_AccessProtection/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_AccessProtection/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_AccessProtection data [eventLocalDateTime]: #eventlocaldatetime #### [eventLocalDateTime] The date that an access protection event occurs. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The date that an access protection event occurs. [filename]: #filename #### [filename] The name of the file that was protected from access. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The name of the file that was protected from access. [processName]: #processname #### [processName] The name of the process that was protected from access. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The name of the process that was protected from access. [ruleName]: #rulename #### [ruleName] The name of the rule that triggered an access protection event. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The name of the rule that triggered an access protection event. [source]: #source #### [source] The IP address that caused an access protection event. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_Filter_Description/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_Filter_Description/_index.md index e211769b02..784d20dd56 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_Filter_Description/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_Filter_Description/_index.md @@ -18,6 +18,8 @@ classes: ## 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. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_Filter_Description dat [name]: #name #### [name] The name of the rule that triggered an anti-virus event. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_BlockedApplicationEvent/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_BlockedApplicationEvent/_index.md index c5e242360b..7837b80409 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_BlockedApplicationEvent/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_BlockedApplicationEvent/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_BlockedApplicationEvent [applicationDescription]: #applicationdescription #### [applicationDescription] A brief description of the application that is blocked. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ A brief description of the application that is blocked. [incidentTime]: #incidenttime #### [incidentTime] The time that an application is blocked. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The time that an application is blocked. [processName]: #processname #### [processName] The name of a process that is blocked. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature/_index.md index 56361eb650..24ca31804a 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature data type contains the signature name of a rule that generated an IPS event. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature data typ [signatureName]: #signaturename #### [signatureName] The name of a rule that triggered an IPS event. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_IPSEvent/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_IPSEvent/_index.md index 390f43ad49..e868786d36 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_IPSEvent/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_IPSEvent/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_IPSEvent data type repre [incidentTime]: #incidenttime #### [incidentTime] The time when an IPS event occurred. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The time when an IPS event occurred. [processName]: #processname #### [processName] Name of the process that generated an IPS event. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Name of the process that generated an IPS event. [reactionText]: #reactiontext #### [reactionText] The action taken because of an IPS event. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The action taken because of an IPS event. [remoteIpAddress]: #remoteipaddress #### [remoteIpAddress] The IP address that generated an IPS event. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The IP address that generated an IPS event. [severityText]: #severitytext #### [severityText] The severity level for an IPS event. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The severity level for an IPS event. [signature]: #signature #### [signature] The signature that generated an IPS event. -Type: **McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature** +Type: **McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_BlockedApplicationEvent/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_BlockedApplicationEvent/_index.md index 12e8b57745..98ceb7cc85 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_BlockedApplicationEvent/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_BlockedApplicationEvent/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_BlockedApplicationEvent [applicationDescription]: #applicationdescription #### [applicationDescription] A brief description of the application that is blocked. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ A brief description of the application that is blocked. [incidentTime]: #incidenttime #### [incidentTime] The time that an application is blocked. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The time that an application is blocked. [processName]: #processname #### [processName] The name of a process that is blocked. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature/_index.md index 56d27f00fc..a5568c8a7e 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature data type contains the signature name of a rule that generated an IPS event. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature data typ [signatureName]: #signaturename #### [signatureName] The name of a rule that triggered an IPS event. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_IPSEvent/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_IPSEvent/_index.md index 93d8435511..17855b18e6 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_IPSEvent/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_IPSEvent/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_IPSEvent data type repre [incidentTime]: #incidenttime #### [incidentTime] The time when an IPS event occurred. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The time when an IPS event occurred. [processName]: #processname #### [processName] Name of the process that generated an IPS event. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Name of the process that generated an IPS event. [reactionText]: #reactiontext #### [reactionText] The action taken because of an IPS event. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The action taken because of an IPS event. [remoteIpAddress]: #remoteipaddress #### [remoteIpAddress] The IP address that generated an IPS event. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The IP address that generated an IPS event. [severityText]: #severitytext #### [severityText] The severity level for an IPS event. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The severity level for an IPS event. [signature]: #signature #### [signature] The signature that generated an IPS event. -Type: **McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature** +Type: **McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Policy_Object/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Policy_Object/_index.md index 2cb699cccc..7882a83792 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Policy_Object/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Policy_Object/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The McAfee_Epolicy_Orchestrator_Version36_Policy_Object data type contains the name of a policy that may be assigned to a server. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version36_Policy_Object data type contains the n [name]: #name #### [name] The name of a policy. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Product_Properties/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Product_Properties/_index.md index f53975a794..44a3a103d2 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Product_Properties/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version36_Product_Properties/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The McAfee_Epolicy_Orchestrator_Version36_Product_Properties data type contains the virus definition file version. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version36_Product_Properties data type contains [datVersion]: #datversion #### [datVersion] The virus definition file version. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Agent_Details/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Agent_Details/_index.md index 10c0024b6c..fea3e820b0 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Agent_Details/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Agent_Details/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The McAfee_Epolicy_Orchestrator_Version45_Agent_Details data type represents a virus scan agent and contains details about its version. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version45_Agent_Details data type represents a v [agentVersion]: #agentversion #### [agentVersion] Version number of the anti-virus scan agent. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Version number of the anti-virus scan agent. [lastUpdate]: #lastupdate #### [lastUpdate] The date of the last time the anti-virus agent checked in. -Type: **dateTime** +Type: **dateTime** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details/_index.md index 2967469a3a..0c676e70d4 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details data type contains the name of an anti-virus policy. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details data type contain [name]: #name #### [name] The name of a policy. -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ The name of a policy. [agentDetails]: #agentdetails #### [agentDetails] Additional information about an agent. -Type: **McAfee_Epolicy_Orchestrator_Version45_Agent_Details** +Type: **McAfee_Epolicy_Orchestrator_Version45_Agent_Details** + @@ -71,7 +75,8 @@ Additional information about an agent. [policies]: #policies #### [policies] The current anti-virus policy of an agent. -Type: **McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details[]** + @@ -83,7 +88,8 @@ The current anti-virus policy of an agent. [policyCount]: #policycount #### [policyCount] A count of the current anti-virus policy of an agent. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Event/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Event/_index.md index 7c6b321536..212f2e2d1f 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Event/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Event/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version45_Event data type represents a single ev [detectedUtc]: #detectedutc #### [detectedUtc] The time that an event was detected. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The time that an event was detected. [sourceIpv4]: #sourceipv4 #### [sourceIpv4] The IP address of the source that generated an event. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The IP address of the source that generated an event. [sourceProcessName]: #sourceprocessname #### [sourceProcessName] The name of the process that generated an event. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The name of the process that generated an event. [targetFilename]: #targetfilename #### [targetFilename] The name of the file that was the target of the event. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The name of the file that was the target of the event. [threatActionTaken]: #threatactiontaken #### [threatActionTaken] The action taken regarding a threat. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The action taken regarding a threat. [threatName]: #threatname #### [threatName] The name of the threat. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The name of the threat. [threatSeverityLabel]: #threatseveritylabel #### [threatSeverityLabel] The textual representation of the severity level. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The textual representation of the severity level. [threatType]: #threattype #### [threatType] The type of threat. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The type of threat. [agentDetails]: #agentdetails #### [agentDetails] Additional information about an agent. -Type: **McAfee_Epolicy_Orchestrator_Version45_Agent_Details** +Type: **McAfee_Epolicy_Orchestrator_Version45_Agent_Details** + @@ -141,7 +152,8 @@ Additional information about an agent. [virusActionTaken]: #virusactiontaken #### [virusActionTaken] The action taken when a virus is detected. -Type: **McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description** +Type: **McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description/_index.md index 7ff58d7118..d045867b5b 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description data type contains the name of the rule that was triggered by an event. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description data type con [name]: #name #### [name] The name of the rule that triggered an event. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Event_Version7/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Event_Version7/_index.md index 0879b2d939..99a638a71c 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Event_Version7/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Event_Version7/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version45_Event_Version7 data type represents a [detectedUtc]: #detectedutc #### [detectedUtc] The time that an event was detected. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The time that an event was detected. [sourceIpv4]: #sourceipv4 #### [sourceIpv4] The IP address of the source that generated an event. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The IP address of the source that generated an event. [sourceProcessName]: #sourceprocessname #### [sourceProcessName] The name of the process that generated an event. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The name of the process that generated an event. [targetFilename]: #targetfilename #### [targetFilename] The name of the file that was the target of the event. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The name of the file that was the target of the event. [threatActionTaken]: #threatactiontaken #### [threatActionTaken] The action taken regarding a threat. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The action taken regarding a threat. [threatName]: #threatname #### [threatName] The name of the threat. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The name of the threat. [threatSeverityLabel]: #threatseveritylabel #### [threatSeverityLabel] The textual representation of the severity level. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The textual representation of the severity level. [threatType]: #threattype #### [threatType] The type of threat. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The type of threat. [agentDetails]: #agentdetails #### [agentDetails] Additional information about an agent. -Type: **McAfee_Epolicy_Orchestrator_Version45_Agent_Details** +Type: **McAfee_Epolicy_Orchestrator_Version45_Agent_Details** + @@ -141,7 +152,8 @@ Additional information about an agent. [signature]: #signature #### [signature] The signature information for an event. -Type: **McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7** +Type: **McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7** + @@ -151,7 +163,8 @@ The signature information for an event. [virusActionTaken]: #virusactiontaken #### [virusActionTaken] The action taken when a virus is detected. -Type: **McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description** +Type: **McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Event_Version8/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Event_Version8/_index.md index b8e835b52a..abf0f7d8d6 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Event_Version8/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Event_Version8/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version45_Event_Version8 data type represents a [detectedUtc]: #detectedutc #### [detectedUtc] The time that an event was detected. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The time that an event was detected. [sourceIpv4]: #sourceipv4 #### [sourceIpv4] The IP address of the source that generated an event. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The IP address of the source that generated an event. [sourceProcessName]: #sourceprocessname #### [sourceProcessName] The name of the process that generated an event. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The name of the process that generated an event. [targetFilename]: #targetfilename #### [targetFilename] The name of the file that was the target of the event. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The name of the file that was the target of the event. [threatActionTaken]: #threatactiontaken #### [threatActionTaken] The action taken regarding a threat. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The action taken regarding a threat. [threatName]: #threatname #### [threatName] The name of the threat. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The name of the threat. [threatSeverityLabel]: #threatseveritylabel #### [threatSeverityLabel] The textual representation of the severity level. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The textual representation of the severity level. [threatType]: #threattype #### [threatType] The type of threat. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The type of threat. [agentDetails]: #agentdetails #### [agentDetails] Additional information about an agent. -Type: **McAfee_Epolicy_Orchestrator_Version45_Agent_Details** +Type: **McAfee_Epolicy_Orchestrator_Version45_Agent_Details** + @@ -141,7 +152,8 @@ Additional information about an agent. [signature]: #signature #### [signature] The signature information for an event. -Type: **McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8** +Type: **McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8** + @@ -151,7 +163,8 @@ The signature information for an event. [virusActionTaken]: #virusactiontaken #### [virusActionTaken] The action taken when a virus is detected. -Type: **McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description** +Type: **McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7/_index.md index 5409fef5cf..4bcbcc19e3 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7 data type contains the signature name of a rule that generated an IPS event. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7 data typ [signatureName]: #signaturename #### [signatureName] The name of a rule that triggered an IPS event. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8/_index.md index d89afbb24c..bfa9827019 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8 data type contains the signature name of a rule that generated an IPS event. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8 data typ [signatureName]: #signaturename #### [signatureName] The name of a rule that triggered an IPS event. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Policy_Object/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Policy_Object/_index.md index 896523c308..8671a11098 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Policy_Object/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Policy_Object/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The McAfee_Epolicy_Orchestrator_Version45_Policy_Object data type contains the name of a policy that may be assigned to a server. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version45_Policy_Object data type contains the n [name]: #name #### [name] The name of a policy. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Product_Properties/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Product_Properties/_index.md index e806b163ce..04f0ada13d 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Product_Properties/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version45_Product_Properties/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The McAfee_Epolicy_Orchestrator_Version45_Product_Properties data type contains the virus definition file version. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version45_Product_Properties data type contains [datVersion]: #datversion #### [datVersion] The virus definition file version. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version51_Agent_Details/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version51_Agent_Details/_index.md index 4b827b36d7..676ed2b317 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version51_Agent_Details/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version51_Agent_Details/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The McAfee_Epolicy_Orchestrator_Version51_Agent_Details data type represents a virus scan agent and contains details about its version. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version51_Agent_Details data type represents a v [agentVersion]: #agentversion #### [agentVersion] Version number of the anti-virus scan agent. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Version number of the anti-virus scan agent. [lastUpdate]: #lastupdate #### [lastUpdate] The date of the last time the anti-virus agent checked in. -Type: **dateTime** +Type: **dateTime** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version51_Policy_Object/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version51_Policy_Object/_index.md index 89a1ea5994..14e33eb4aa 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version51_Policy_Object/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version51_Policy_Object/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The McAfee_Epolicy_Orchestrator_Version51_Policy_Object data type represents a virus scan agent and contains details about its version. @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version51_Policy_Object data type represents a v [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version51_Product_Properties/_index.md b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version51_Product_Properties/_index.md index 6c8ac5ca60..bb46260b63 100644 --- a/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version51_Product_Properties/_index.md +++ b/content/reference/datatypes/McAfee_Epolicy_Orchestrator_Version51_Product_Properties/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The McAfee_Epolicy_Orchestrator_Version51_Product_Properties data type represents the version of the virus data file @@ -45,7 +47,8 @@ The McAfee_Epolicy_Orchestrator_Version51_Product_Properties data type represent [datVersion]: #datversion #### [datVersion] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Abuse_Lockdown_Resource/_index.md b/content/reference/datatypes/SoftLayer_Abuse_Lockdown_Resource/_index.md index 7762f525c2..166a889ee2 100644 --- a/content/reference/datatypes/SoftLayer_Abuse_Lockdown_Resource/_index.md +++ b/content/reference/datatypes/SoftLayer_Abuse_Lockdown_Resource/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -51,7 +53,8 @@ classes: [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** +
@@ -61,7 +64,8 @@ classes: [invoiceItem]: #invoiceitem #### [invoiceItem] -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** +
diff --git a/content/reference/datatypes/SoftLayer_Account/_index.md b/content/reference/datatypes/SoftLayer_Account/_index.md index 13d89d7152..a20bcd60c6 100644 --- a/content/reference/datatypes/SoftLayer_Account/_index.md +++ b/content/reference/datatypes/SoftLayer_Account/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -53,7 +55,8 @@ SoftLayer customers are unable to change their company account information in th [accountManagedResourcesFlag]: #accountmanagedresourcesflag #### [accountManagedResourcesFlag] A flag indicating that the account has a managed resource. -Type: **boolean** +Type: **boolean** + @@ -63,7 +66,8 @@ A flag indicating that the account has a managed resource. [accountStatusId]: #accountstatusid #### [accountStatusId] A number reflecting the state of an account. -Type: **integer** +Type: **integer** + @@ -73,7 +77,8 @@ A number reflecting the state of an account. [address1]: #address1 #### [address1] The first line of the mailing address belonging to an account. -Type: **string** +Type: **string** + @@ -83,7 +88,8 @@ The first line of the mailing address belonging to an account. [address2]: #address2 #### [address2] The second line of the mailing address belonging to an account. -Type: **string** +Type: **string** + @@ -93,7 +99,8 @@ The second line of the mailing address belonging to an account. [allowedPptpVpnQuantity]: #allowedpptpvpnquantity #### [allowedPptpVpnQuantity] The number of PPTP VPN users allowed on an account. -Type: **integer** +Type: **integer** + @@ -103,7 +110,8 @@ The number of PPTP VPN users allowed on an account. [alternatePhone]: #alternatephone #### [alternatePhone] A secondary phone number assigned to an account. -Type: **string** +Type: **string** + @@ -113,7 +121,8 @@ A secondary phone number assigned to an account. [brandId]: #brandid #### [brandId] The Brand tied to an account. -Type: **integer** +Type: **integer** + @@ -123,7 +132,8 @@ The Brand tied to an account. [city]: #city #### [city] The city of the mailing address belonging to an account. -Type: **string** +Type: **string** + @@ -133,7 +143,8 @@ The city of the mailing address belonging to an account. [claimedTaxExemptTxFlag]: #claimedtaxexempttxflag #### [claimedTaxExemptTxFlag] Whether an account is exempt from taxes on their invoices. -Type: **boolean** +Type: **boolean** + @@ -143,7 +154,8 @@ Whether an account is exempt from taxes on their invoices. [companyName]: #companyname #### [companyName] The company name associated with an account. -Type: **string** +Type: **string** + @@ -153,7 +165,8 @@ The company name associated with an account. [country]: #country #### [country] A two-letter abbreviation of the country in the mailing address belonging to an account. -Type: **string** +Type: **string** + @@ -163,7 +176,8 @@ A two-letter abbreviation of the country in the mailing address belonging to an [createDate]: #createdate #### [createDate] The date an account was created. -Type: **dateTime** +Type: **dateTime** + @@ -173,7 +187,8 @@ The date an account was created. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Used internally and can safely be ignored. -Type: **string** +Type: **string** + @@ -183,7 +198,8 @@ Device Fingerprint Identifier - Used internally and can safely be ignored. [email]: #email #### [email] A general email address assigned to an account. -Type: **string** +Type: **string** + @@ -193,7 +209,8 @@ A general email address assigned to an account. [faxPhone]: #faxphone #### [faxPhone] A fax phone number assigned to an account. -Type: **string** +Type: **string** + @@ -203,7 +220,8 @@ A fax phone number assigned to an account. [firstName]: #firstname #### [firstName] Each customer account is listed under a single individual. This is that individual's first name. -Type: **string** +Type: **string** + @@ -213,7 +231,8 @@ Each customer account is listed under a single individual. This is that individu [id]: #id #### [id] A customer account's internal identifier. Account numbers are typically preceded by the string "SL" in the customer portal. Every SoftLayer account has at least one portal user whose username follows the "SL" + account number naming scheme. -Type: **integer** +Type: **integer** + @@ -223,7 +242,8 @@ A customer account's internal identifier. Account numbers are typically preceded [isReseller]: #isreseller #### [isReseller] A flag indicating if an account belongs to a reseller or not. -Type: **integer** +Type: **integer** + @@ -233,7 +253,8 @@ A flag indicating if an account belongs to a reseller or not. [lastName]: #lastname #### [lastName] Each customer account is listed under a single individual. This is that individual's last name. -Type: **string** +Type: **string** + @@ -243,7 +264,8 @@ Each customer account is listed under a single individual. This is that individu [lateFeeProtectionFlag]: #latefeeprotectionflag #### [lateFeeProtectionFlag] Whether an account has late fee protection. -Type: **boolean** +Type: **boolean** + @@ -253,7 +275,8 @@ Whether an account has late fee protection. [modifyDate]: #modifydate #### [modifyDate] The date an account was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -263,7 +286,8 @@ The date an account was last modified. [officePhone]: #officephone #### [officePhone] An office phone number assigned to an account. -Type: **string** +Type: **string** + @@ -273,7 +297,8 @@ An office phone number assigned to an account. [postalCode]: #postalcode #### [postalCode] The postal code of the mailing address belonging to an account. -Type: **string** +Type: **string** + @@ -283,7 +308,8 @@ The postal code of the mailing address belonging to an account. [resellerLevel]: #resellerlevel #### [resellerLevel] The Reseller level of the account. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The Reseller level of the account. [state]: #state #### [state] A two-letter abbreviation of the state in the mailing address belonging to an account. If an account does not reside in a province then this is typically blank. -Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ A two-letter abbreviation of the state in the mailing address belonging to an ac [statusDate]: #statusdate #### [statusDate] The date of an account's last status change. -Type: **dateTime** +Type: **dateTime** + @@ -319,7 +347,8 @@ The date of an account's last status change. [abuseEmail]: #abuseemail #### [abuseEmail] An email address that is responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to this address. -Type: **string** +Type: **string** + @@ -329,7 +358,8 @@ An email address that is responsible for abuse and legal inquiries on behalf of [abuseEmails]: #abuseemails #### [abuseEmails] Email addresses that are responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to these addresses. -Type: **SoftLayer_Account_AbuseEmail[] ** +Type: **SoftLayer_Account_AbuseEmail[] ** + @@ -339,7 +369,8 @@ Email addresses that are responsible for abuse and legal inquiries on behalf of [accountContacts]: #accountcontacts #### [accountContacts] The account contacts on an account. -Type: **SoftLayer_Account_Contact[] ** +Type: **SoftLayer_Account_Contact[] ** + @@ -349,7 +380,8 @@ The account contacts on an account. [accountLicenses]: #accountlicenses #### [accountLicenses] The account software licenses owned by an account -Type: **SoftLayer_Software_AccountLicense[] ** +Type: **SoftLayer_Software_AccountLicense[] ** + @@ -359,7 +391,8 @@ The account software licenses owned by an account [accountLinks]: #accountlinks #### [accountLinks] -Type: **SoftLayer_Account_Link[] ** +Type: **SoftLayer_Account_Link[] ** + @@ -369,7 +402,8 @@ The account software licenses owned by an account [accountStatus]: #accountstatus #### [accountStatus] An account's status presented in a more detailed data type. -Type: **SoftLayer_Account_Status ** +Type: **SoftLayer_Account_Status ** + @@ -379,7 +413,8 @@ An account's status presented in a more detailed data type. [activeAccountDiscountBillingItem]: #activeaccountdiscountbillingitem #### [activeAccountDiscountBillingItem] The billing item associated with an account's monthly discount. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -389,7 +424,8 @@ The billing item associated with an account's monthly discount. [activeAccountLicenses]: #activeaccountlicenses #### [activeAccountLicenses] The active account software licenses owned by an account -Type: **SoftLayer_Software_AccountLicense[] ** +Type: **SoftLayer_Software_AccountLicense[] ** + @@ -399,7 +435,8 @@ The active account software licenses owned by an account [activeAddresses]: #activeaddresses #### [activeAddresses] The active address(es) that belong to an account. -Type: **SoftLayer_Account_Address[] ** +Type: **SoftLayer_Account_Address[] ** + @@ -409,7 +446,8 @@ The active address(es) that belong to an account. [activeAgreements]: #activeagreements #### [activeAgreements] All active agreements for an account -Type: **SoftLayer_Account_Agreement[] ** +Type: **SoftLayer_Account_Agreement[] ** + @@ -419,7 +457,8 @@ All active agreements for an account [activeBillingAgreements]: #activebillingagreements #### [activeBillingAgreements] All billing agreements for an account -Type: **SoftLayer_Account_Agreement[] ** +Type: **SoftLayer_Account_Agreement[] ** + @@ -429,7 +468,8 @@ All billing agreements for an account [activeCatalystEnrollment]: #activecatalystenrollment #### [activeCatalystEnrollment] -Type: **SoftLayer_Catalyst_Enrollment ** +Type: **SoftLayer_Catalyst_Enrollment ** + @@ -439,7 +479,8 @@ All billing agreements for an account [activeColocationContainers]: #activecolocationcontainers #### [activeColocationContainers] The account's active top level colocation containers. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -449,7 +490,8 @@ The account's active top level colocation containers. [activeFlexibleCreditEnrollment]: #activeflexiblecreditenrollment #### [activeFlexibleCreditEnrollment] [Deprecated] Please use SoftLayer_Account::activeFlexibleCreditEnrollments. -Type: **SoftLayer_FlexibleCredit_Enrollment ** +Type: **SoftLayer_FlexibleCredit_Enrollment ** + @@ -459,7 +501,8 @@ The account's active top level colocation containers. [activeFlexibleCreditEnrollments]: #activeflexiblecreditenrollments #### [activeFlexibleCreditEnrollments] -Type: **SoftLayer_FlexibleCredit_Enrollment[] ** +Type: **SoftLayer_FlexibleCredit_Enrollment[] ** + @@ -469,7 +512,8 @@ The account's active top level colocation containers. [activeNotificationSubscribers]: #activenotificationsubscribers #### [activeNotificationSubscribers] -Type: **SoftLayer_Notification_Subscriber[] ** +Type: **SoftLayer_Notification_Subscriber[] ** + @@ -479,7 +523,8 @@ The account's active top level colocation containers. [activeQuotes]: #activequotes #### [activeQuotes] An account's non-expired quotes. -Type: **SoftLayer_Billing_Order_Quote[] ** +Type: **SoftLayer_Billing_Order_Quote[] ** + @@ -489,7 +534,8 @@ An account's non-expired quotes. [activeReservedCapacityAgreements]: #activereservedcapacityagreements #### [activeReservedCapacityAgreements] Active reserved capacity agreements for an account -Type: **SoftLayer_Account_Agreement[] ** +Type: **SoftLayer_Account_Agreement[] ** + @@ -499,7 +545,8 @@ Active reserved capacity agreements for an account [activeVirtualLicenses]: #activevirtuallicenses #### [activeVirtualLicenses] The virtual software licenses controlled by an account -Type: **SoftLayer_Software_VirtualLicense[] ** +Type: **SoftLayer_Software_VirtualLicense[] ** + @@ -509,7 +556,8 @@ The virtual software licenses controlled by an account [adcLoadBalancers]: #adcloadbalancers #### [adcLoadBalancers] An account's associated load balancers. -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress[] ** + @@ -519,7 +567,8 @@ An account's associated load balancers. [addresses]: #addresses #### [addresses] All the address(es) that belong to an account. -Type: **SoftLayer_Account_Address[] ** +Type: **SoftLayer_Account_Address[] ** + @@ -529,7 +578,8 @@ All the address(es) that belong to an account. [affiliateId]: #affiliateid #### [affiliateId] An affiliate identifier associated with the customer account. -Type: **string** +Type: **string** + @@ -539,7 +589,8 @@ An affiliate identifier associated with the customer account. [allBillingItems]: #allbillingitems #### [allBillingItems] The billing items that will be on an account's next invoice. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -549,7 +600,8 @@ The billing items that will be on an account's next invoice. [allCommissionBillingItems]: #allcommissionbillingitems #### [allCommissionBillingItems] The billing items that will be on an account's next invoice. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -559,7 +611,8 @@ The billing items that will be on an account's next invoice. [allRecurringTopLevelBillingItems]: #allrecurringtoplevelbillingitems #### [allRecurringTopLevelBillingItems] The billing items that will be on an account's next invoice. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -569,7 +622,8 @@ The billing items that will be on an account's next invoice. [allRecurringTopLevelBillingItemsUnfiltered]: #allrecurringtoplevelbillingitemsunfiltered #### [allRecurringTopLevelBillingItemsUnfiltered] The billing items that will be on an account's next invoice. Does not consider associated items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -579,7 +633,8 @@ The billing items that will be on an account's next invoice. Does not consider a [allSubnetBillingItems]: #allsubnetbillingitems #### [allSubnetBillingItems] The billing items that will be on an account's next invoice. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -589,7 +644,8 @@ The billing items that will be on an account's next invoice. [allTopLevelBillingItems]: #alltoplevelbillingitems #### [allTopLevelBillingItems] All billing items of an account. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -599,7 +655,8 @@ All billing items of an account. [allTopLevelBillingItemsUnfiltered]: #alltoplevelbillingitemsunfiltered #### [allTopLevelBillingItemsUnfiltered] The billing items that will be on an account's next invoice. Does not consider associated items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -609,7 +666,8 @@ The billing items that will be on an account's next invoice. Does not consider a [allowIbmIdSilentMigrationFlag]: #allowibmidsilentmigrationflag #### [allowIbmIdSilentMigrationFlag] Indicates whether this account is allowed to silently migrate to use IBMid Authentication. -Type: **boolean** +Type: **boolean** + @@ -619,7 +677,8 @@ Indicates whether this account is allowed to silently migrate to use IBMid Authe [allowsBluemixAccountLinkingFlag]: #allowsbluemixaccountlinkingflag #### [allowsBluemixAccountLinkingFlag] Flag indicating if this account can be linked with Bluemix. -Type: **boolean** +Type: **boolean** + @@ -629,7 +688,8 @@ Flag indicating if this account can be linked with Bluemix. [applicationDeliveryControllers]: #applicationdeliverycontrollers #### [applicationDeliveryControllers] An account's associated application delivery controller records. -Type: **SoftLayer_Network_Application_Delivery_Controller[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller[] ** + @@ -639,7 +699,8 @@ An account's associated application delivery controller records. [attributes]: #attributes #### [attributes] The account attribute values for a SoftLayer customer account. -Type: **SoftLayer_Account_Attribute[] ** +Type: **SoftLayer_Account_Attribute[] ** + @@ -649,7 +710,8 @@ The account attribute values for a SoftLayer customer account. [availablePublicNetworkVlans]: #availablepublicnetworkvlans #### [availablePublicNetworkVlans] The public network VLANs assigned to an account. -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -659,7 +721,8 @@ The public network VLANs assigned to an account. [balance]: #balance #### [balance] The account balance of a SoftLayer customer account. An account's balance is the amount of money owed to SoftLayer by the account holder, returned as a floating point number with two decimal places, measured in US Dollars ($USD). A negative account balance means the account holder has overpaid and is owed money by SoftLayer. -Type: **decimal** +Type: **decimal** + @@ -669,7 +732,8 @@ The account balance of a SoftLayer customer account. An account's balance is the [bandwidthAllotments]: #bandwidthallotments #### [bandwidthAllotments] The bandwidth allotments for an account. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment[] ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment[] ** + @@ -679,7 +743,8 @@ The bandwidth allotments for an account. [bandwidthAllotmentsOverAllocation]: #bandwidthallotmentsoverallocation #### [bandwidthAllotmentsOverAllocation] The bandwidth allotments for an account currently over allocation. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment[] ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment[] ** + @@ -689,7 +754,8 @@ The bandwidth allotments for an account currently over allocation. [bandwidthAllotmentsProjectedOverAllocation]: #bandwidthallotmentsprojectedoverallocation #### [bandwidthAllotmentsProjectedOverAllocation] The bandwidth allotments for an account projected to go over allocation. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment[] ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment[] ** + @@ -699,7 +765,8 @@ The bandwidth allotments for an account projected to go over allocation. [bareMetalInstances]: #baremetalinstances #### [bareMetalInstances] An account's associated bare metal server objects. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -709,7 +776,8 @@ An account's associated bare metal server objects. [billingAgreements]: #billingagreements #### [billingAgreements] All billing agreements for an account -Type: **SoftLayer_Account_Agreement[] ** +Type: **SoftLayer_Account_Agreement[] ** + @@ -719,7 +787,8 @@ All billing agreements for an account [billingInfo]: #billinginfo #### [billingInfo] An account's billing information. -Type: **SoftLayer_Billing_Info ** +Type: **SoftLayer_Billing_Info ** + @@ -729,7 +798,8 @@ An account's billing information. [blockDeviceTemplateGroups]: #blockdevicetemplategroups #### [blockDeviceTemplateGroups] Private template group objects (parent and children) and the shared template group objects (parent only) for an account. -Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group[] ** +Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group[] ** + @@ -739,7 +809,8 @@ Private template group objects (parent and children) and the shared template gro [bluemixAccountLink]: #bluemixaccountlink #### [bluemixAccountLink] The Bluemix account link associated with this SoftLayer account, if one exists. -Type: **SoftLayer_Account_Link_Bluemix ** +Type: **SoftLayer_Account_Link_Bluemix ** + @@ -749,7 +820,8 @@ The Bluemix account link associated with this SoftLayer account, if one exists. [bluemixLinkedFlag]: #bluemixlinkedflag #### [bluemixLinkedFlag] Returns true if this account is linked to IBM Bluemix, false if not. -Type: **boolean** +Type: **boolean** + @@ -759,7 +831,8 @@ Returns true if this account is linked to IBM Bluemix, false if not. [brand]: #brand #### [brand] -Type: **SoftLayer_Brand ** +Type: **SoftLayer_Brand ** + @@ -769,7 +842,8 @@ Returns true if this account is linked to IBM Bluemix, false if not. [brandAccountFlag]: #brandaccountflag #### [brandAccountFlag] -Type: **boolean** +Type: **boolean** + @@ -779,7 +853,8 @@ Returns true if this account is linked to IBM Bluemix, false if not. [brandKeyName]: #brandkeyname #### [brandKeyName] The brand keyName. -Type: **string** +Type: **string** + @@ -789,17 +864,20 @@ The brand keyName. [businessPartner]: #businesspartner #### [businessPartner] The Business Partner details for the account. Country Enterprise Code, Channel, Segment, Reseller Level. -Type: **SoftLayer_Account_Business_Partner ** +Type: **SoftLayer_Account_Business_Partner ** + -
+
----- [canOrderAdditionalVlansFlag]: #canorderadditionalvlansflag #### [canOrderAdditionalVlansFlag] [DEPRECATED] All accounts may order VLANs. -Type: **boolean** +Type: **boolean** + +Deprecated
@@ -809,7 +887,8 @@ The Business Partner details for the account. Country Enterprise Code, Channel, [carts]: #carts #### [carts] An account's active carts. -Type: **SoftLayer_Billing_Order_Quote[] ** +Type: **SoftLayer_Billing_Order_Quote[] ** +
@@ -819,7 +898,8 @@ An account's active carts. [catalystEnrollments]: #catalystenrollments #### [catalystEnrollments] -Type: **SoftLayer_Catalyst_Enrollment[] ** +Type: **SoftLayer_Catalyst_Enrollment[] ** + @@ -829,7 +909,8 @@ An account's active carts. [closedTickets]: #closedtickets #### [closedTickets] All closed tickets associated with an account. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -839,7 +920,8 @@ All closed tickets associated with an account. [datacentersWithSubnetAllocations]: #datacenterswithsubnetallocations #### [datacentersWithSubnetAllocations] Datacenters which contain subnets that the account has access to route. -Type: **SoftLayer_Location[] ** +Type: **SoftLayer_Location[] ** + @@ -849,7 +931,8 @@ Datacenters which contain subnets that the account has access to route. [dedicatedHosts]: #dedicatedhosts #### [dedicatedHosts] An account's associated virtual dedicated host objects. -Type: **SoftLayer_Virtual_DedicatedHost[] ** +Type: **SoftLayer_Virtual_DedicatedHost[] ** + @@ -859,7 +942,8 @@ An account's associated virtual dedicated host objects. [disablePaymentProcessingFlag]: #disablepaymentprocessingflag #### [disablePaymentProcessingFlag] A flag indicating whether payments are processed for this account. -Type: **boolean** +Type: **boolean** + @@ -869,7 +953,8 @@ A flag indicating whether payments are processed for this account. [displaySupportRepresentativeAssignments]: #displaysupportrepresentativeassignments #### [displaySupportRepresentativeAssignments] The SoftLayer employees that an account is assigned to. -Type: **SoftLayer_Account_Attachment_Employee[] ** +Type: **SoftLayer_Account_Attachment_Employee[] ** + @@ -879,7 +964,8 @@ The SoftLayer employees that an account is assigned to. [domainRegistrations]: #domainregistrations #### [domainRegistrations] -Type: **SoftLayer_Dns_Domain_Registration[] ** +Type: **SoftLayer_Dns_Domain_Registration[] ** + @@ -889,7 +975,8 @@ The SoftLayer employees that an account is assigned to. [domains]: #domains #### [domains] The DNS domains associated with an account. -Type: **SoftLayer_Dns_Domain[] ** +Type: **SoftLayer_Dns_Domain[] ** + @@ -899,7 +986,8 @@ The DNS domains associated with an account. [domainsWithoutSecondaryDnsRecords]: #domainswithoutsecondarydnsrecords #### [domainsWithoutSecondaryDnsRecords] The DNS domains associated with an account that were not created as a result of a secondary DNS zone transfer. -Type: **SoftLayer_Dns_Domain[] ** +Type: **SoftLayer_Dns_Domain[] ** + @@ -909,7 +997,8 @@ The DNS domains associated with an account that were not created as a result of [euSupportedFlag]: #eusupportedflag #### [euSupportedFlag] Boolean flag dictating whether or not this account has the EU Supported flag. This flag indicates that this account uses IBM Cloud services to process EU citizen's personal data. -Type: **boolean** +Type: **boolean** + @@ -919,7 +1008,8 @@ Boolean flag dictating whether or not this account has the EU Supported flag. Th [evaultCapacityGB]: #evaultcapacitygb #### [evaultCapacityGB] The total capacity of Legacy EVault Volumes on an account, in GB. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -929,7 +1019,8 @@ The total capacity of Legacy EVault Volumes on an account, in GB. [evaultMasterUsers]: #evaultmasterusers #### [evaultMasterUsers] An account's master EVault user. This is only used when an account has EVault service. -Type: **SoftLayer_Account_Password[] ** +Type: **SoftLayer_Account_Password[] ** + @@ -939,7 +1030,8 @@ An account's master EVault user. This is only used when an account has EVault se [evaultNetworkStorage]: #evaultnetworkstorage #### [evaultNetworkStorage] An account's associated EVault storage volumes. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -949,7 +1041,8 @@ An account's associated EVault storage volumes. [expiredSecurityCertificates]: #expiredsecuritycertificates #### [expiredSecurityCertificates] Stored security certificates that are expired (ie. SSL) -Type: **SoftLayer_Security_Certificate[] ** +Type: **SoftLayer_Security_Certificate[] ** + @@ -959,7 +1052,8 @@ Stored security certificates that are expired (ie. SSL) [facilityLogs]: #facilitylogs #### [facilityLogs] Logs of who entered a colocation area which is assigned to this account, or when a user under this account enters a datacenter. -Type: **SoftLayer_User_Access_Facility_Log[] ** +Type: **SoftLayer_User_Access_Facility_Log[] ** + @@ -969,7 +1063,8 @@ Logs of who entered a colocation area which is assigned to this account, or when [fileBlockBetaAccessFlag]: #fileblockbetaaccessflag #### [fileBlockBetaAccessFlag] -Type: **boolean** +Type: **boolean** + @@ -979,7 +1074,8 @@ Logs of who entered a colocation area which is assigned to this account, or when [flexibleCreditEnrollments]: #flexiblecreditenrollments #### [flexibleCreditEnrollments] All of the account's current and former Flexible Credit enrollments. -Type: **SoftLayer_FlexibleCredit_Enrollment[] ** +Type: **SoftLayer_FlexibleCredit_Enrollment[] ** + @@ -989,7 +1085,8 @@ All of the account's current and former Flexible Credit enrollments. [forcePaasAccountLinkDate]: #forcepaasaccountlinkdate #### [forcePaasAccountLinkDate] Timestamp representing the point in time when an account is required to link with PaaS. -Type: **string** +Type: **string** + @@ -999,7 +1096,8 @@ Timestamp representing the point in time when an account is required to link wit [globalIpRecords]: #globaliprecords #### [globalIpRecords] -Type: **SoftLayer_Network_Subnet_IpAddress_Global[] ** +Type: **SoftLayer_Network_Subnet_IpAddress_Global[] ** + @@ -1009,7 +1107,8 @@ Timestamp representing the point in time when an account is required to link wit [globalIpv4Records]: #globalipv4records #### [globalIpv4Records] -Type: **SoftLayer_Network_Subnet_IpAddress_Global[] ** +Type: **SoftLayer_Network_Subnet_IpAddress_Global[] ** + @@ -1019,17 +1118,20 @@ Timestamp representing the point in time when an account is required to link wit [globalIpv6Records]: #globalipv6records #### [globalIpv6Records] -Type: **SoftLayer_Network_Subnet_IpAddress_Global[] ** +Type: **SoftLayer_Network_Subnet_IpAddress_Global[] ** + -
+
----- [globalLoadBalancerAccounts]: #globalloadbalanceraccounts #### [globalLoadBalancerAccounts] [Deprecated] The global load balancer accounts for a softlayer customer account. -Type: **SoftLayer_Network_LoadBalancer_Global_Account[] ** +Type: **SoftLayer_Network_LoadBalancer_Global_Account[] ** + +Deprecated
@@ -1039,7 +1141,8 @@ Timestamp representing the point in time when an account is required to link wit [hardware]: #hardware #### [hardware] An account's associated hardware objects. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** +
@@ -1049,7 +1152,8 @@ An account's associated hardware objects. [hardwareOverBandwidthAllocation]: #hardwareoverbandwidthallocation #### [hardwareOverBandwidthAllocation] An account's associated hardware objects currently over bandwidth allocation. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1059,7 +1163,8 @@ An account's associated hardware objects currently over bandwidth allocation. [hardwareProjectedOverBandwidthAllocation]: #hardwareprojectedoverbandwidthallocation #### [hardwareProjectedOverBandwidthAllocation] An account's associated hardware objects projected to go over bandwidth allocation. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1069,7 +1174,8 @@ An account's associated hardware objects projected to go over bandwidth allocati [hardwareWithCpanel]: #hardwarewithcpanel #### [hardwareWithCpanel] All hardware associated with an account that has the cPanel web hosting control panel installed. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1079,7 +1185,8 @@ All hardware associated with an account that has the cPanel web hosting control [hardwareWithHelm]: #hardwarewithhelm #### [hardwareWithHelm] All hardware associated with an account that has the Helm web hosting control panel installed. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1089,7 +1196,8 @@ All hardware associated with an account that has the Helm web hosting control pa [hardwareWithMcafee]: #hardwarewithmcafee #### [hardwareWithMcafee] All hardware associated with an account that has McAfee Secure software components. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1099,7 +1207,8 @@ All hardware associated with an account that has McAfee Secure software componen [hardwareWithMcafeeAntivirusRedhat]: #hardwarewithmcafeeantivirusredhat #### [hardwareWithMcafeeAntivirusRedhat] All hardware associated with an account that has McAfee Secure AntiVirus for Redhat software components. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1109,7 +1218,8 @@ All hardware associated with an account that has McAfee Secure AntiVirus for Red [hardwareWithMcafeeAntivirusWindows]: #hardwarewithmcafeeantiviruswindows #### [hardwareWithMcafeeAntivirusWindows] All hardware associated with an account that has McAfee Secure AntiVirus for Windows software components. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1119,7 +1229,8 @@ All hardware associated with an account that has McAfee Secure AntiVirus for Win [hardwareWithMcafeeIntrusionDetectionSystem]: #hardwarewithmcafeeintrusiondetectionsystem #### [hardwareWithMcafeeIntrusionDetectionSystem] All hardware associated with an account that has McAfee Secure Intrusion Detection System software components. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1129,7 +1240,8 @@ All hardware associated with an account that has McAfee Secure Intrusion Detecti [hardwareWithPlesk]: #hardwarewithplesk #### [hardwareWithPlesk] All hardware associated with an account that has the Plesk web hosting control panel installed. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1139,7 +1251,8 @@ All hardware associated with an account that has the Plesk web hosting control p [hardwareWithQuantastor]: #hardwarewithquantastor #### [hardwareWithQuantastor] All hardware associated with an account that has the QuantaStor storage system installed. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1149,7 +1262,8 @@ All hardware associated with an account that has the QuantaStor storage system i [hardwareWithUrchin]: #hardwarewithurchin #### [hardwareWithUrchin] All hardware associated with an account that has the Urchin web traffic analytics package installed. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1159,7 +1273,8 @@ All hardware associated with an account that has the Urchin web traffic analytic [hardwareWithWindows]: #hardwarewithwindows #### [hardwareWithWindows] All hardware associated with an account that is running a version of the Microsoft Windows operating system. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1169,7 +1284,8 @@ All hardware associated with an account that is running a version of the Microso [hasEvaultBareMetalRestorePluginFlag]: #hasevaultbaremetalrestorepluginflag #### [hasEvaultBareMetalRestorePluginFlag] Return 1 if one of the account's hardware has the EVault Bare Metal Server Restore Plugin otherwise 0. -Type: **boolean** +Type: **boolean** + @@ -1179,7 +1295,8 @@ Return 1 if one of the account's hardware has the EVault Bare Metal Server Resto [hasIderaBareMetalRestorePluginFlag]: #hasiderabaremetalrestorepluginflag #### [hasIderaBareMetalRestorePluginFlag] Return 1 if one of the account's hardware has an installation of Idera Server Backup otherwise 0. -Type: **boolean** +Type: **boolean** + @@ -1189,7 +1306,8 @@ Return 1 if one of the account's hardware has an installation of Idera Server Ba [hasPendingOrder]: #haspendingorder #### [hasPendingOrder] The number of orders in a PENDING status for a SoftLayer customer account. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1199,7 +1317,8 @@ The number of orders in a PENDING status for a SoftLayer customer account. [hasR1softBareMetalRestorePluginFlag]: #hasr1softbaremetalrestorepluginflag #### [hasR1softBareMetalRestorePluginFlag] Return 1 if one of the account's hardware has an installation of R1Soft CDP otherwise 0. -Type: **boolean** +Type: **boolean** + @@ -1209,7 +1328,8 @@ Return 1 if one of the account's hardware has an installation of R1Soft CDP othe [hourlyBareMetalInstances]: #hourlybaremetalinstances #### [hourlyBareMetalInstances] An account's associated hourly bare metal server objects. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1219,7 +1339,8 @@ An account's associated hourly bare metal server objects. [hourlyServiceBillingItems]: #hourlyservicebillingitems #### [hourlyServiceBillingItems] Hourly service billing items that will be on an account's next invoice. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -1229,7 +1350,8 @@ Hourly service billing items that will be on an account's next invoice. [hourlyVirtualGuests]: #hourlyvirtualguests #### [hourlyVirtualGuests] An account's associated hourly virtual guest objects. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -1239,7 +1361,8 @@ An account's associated hourly virtual guest objects. [hubNetworkStorage]: #hubnetworkstorage #### [hubNetworkStorage] An account's associated Virtual Storage volumes. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -1249,7 +1372,8 @@ An account's associated Virtual Storage volumes. [ibmCustomerNumber]: #ibmcustomernumber #### [ibmCustomerNumber] Unique identifier for a customer used throughout IBM. -Type: **string** +Type: **string** + @@ -1259,7 +1383,8 @@ Unique identifier for a customer used throughout IBM. [ibmIdAuthenticationRequiredFlag]: #ibmidauthenticationrequiredflag #### [ibmIdAuthenticationRequiredFlag] Indicates whether this account requires IBMid authentication. -Type: **boolean** +Type: **boolean** + @@ -1269,7 +1394,8 @@ Indicates whether this account requires IBMid authentication. [ibmIdMigrationExpirationTimestamp]: #ibmidmigrationexpirationtimestamp #### [ibmIdMigrationExpirationTimestamp] This key is deprecated and should not be used. -Type: **string** +Type: **string** + @@ -1279,7 +1405,8 @@ This key is deprecated and should not be used. [inProgressExternalAccountSetup]: #inprogressexternalaccountsetup #### [inProgressExternalAccountSetup] An in progress request to switch billing systems. -Type: **SoftLayer_Account_External_Setup ** +Type: **SoftLayer_Account_External_Setup ** + @@ -1289,7 +1416,8 @@ An in progress request to switch billing systems. [internalNotes]: #internalnotes #### [internalNotes] -Type: **SoftLayer_Account_Note[] ** +Type: **SoftLayer_Account_Note[] ** + @@ -1299,7 +1427,8 @@ An in progress request to switch billing systems. [invoices]: #invoices #### [invoices] An account's associated billing invoices. -Type: **SoftLayer_Billing_Invoice[] ** +Type: **SoftLayer_Billing_Invoice[] ** + @@ -1309,7 +1438,8 @@ An account's associated billing invoices. [ipAddresses]: #ipaddresses #### [ipAddresses] -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -1319,7 +1449,8 @@ An account's associated billing invoices. [iscsiIsolationDisabled]: #iscsiisolationdisabled #### [iscsiIsolationDisabled] -Type: **boolean** +Type: **boolean** + @@ -1329,7 +1460,8 @@ An account's associated billing invoices. [iscsiNetworkStorage]: #iscsinetworkstorage #### [iscsiNetworkStorage] An account's associated iSCSI storage volumes. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -1339,7 +1471,8 @@ An account's associated iSCSI storage volumes. [lastCanceledBillingItem]: #lastcanceledbillingitem #### [lastCanceledBillingItem] The most recently canceled billing item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -1349,7 +1482,8 @@ The most recently canceled billing item. [lastCancelledServerBillingItem]: #lastcancelledserverbillingitem #### [lastCancelledServerBillingItem] The most recent cancelled server billing item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -1359,7 +1493,8 @@ The most recent cancelled server billing item. [lastFiveClosedAbuseTickets]: #lastfiveclosedabusetickets #### [lastFiveClosedAbuseTickets] The five most recently closed abuse tickets associated with an account. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -1369,7 +1504,8 @@ The five most recently closed abuse tickets associated with an account. [lastFiveClosedAccountingTickets]: #lastfiveclosedaccountingtickets #### [lastFiveClosedAccountingTickets] The five most recently closed accounting tickets associated with an account. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -1379,7 +1515,8 @@ The five most recently closed accounting tickets associated with an account. [lastFiveClosedOtherTickets]: #lastfiveclosedothertickets #### [lastFiveClosedOtherTickets] The five most recently closed tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -1389,7 +1526,8 @@ The five most recently closed tickets that do not belong to the abuse, accountin [lastFiveClosedSalesTickets]: #lastfiveclosedsalestickets #### [lastFiveClosedSalesTickets] The five most recently closed sales tickets associated with an account. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -1399,7 +1537,8 @@ The five most recently closed sales tickets associated with an account. [lastFiveClosedSupportTickets]: #lastfiveclosedsupporttickets #### [lastFiveClosedSupportTickets] The five most recently closed support tickets associated with an account. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -1409,7 +1548,8 @@ The five most recently closed support tickets associated with an account. [lastFiveClosedTickets]: #lastfiveclosedtickets #### [lastFiveClosedTickets] The five most recently closed tickets associated with an account. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -1419,7 +1559,8 @@ The five most recently closed tickets associated with an account. [latestBillDate]: #latestbilldate #### [latestBillDate] An account's most recent billing date. -Type: **dateTime** +Type: **dateTime** + @@ -1429,7 +1570,8 @@ An account's most recent billing date. [latestRecurringInvoice]: #latestrecurringinvoice #### [latestRecurringInvoice] An account's latest recurring invoice. -Type: **SoftLayer_Billing_Invoice ** +Type: **SoftLayer_Billing_Invoice ** + @@ -1439,7 +1581,8 @@ An account's latest recurring invoice. [latestRecurringPendingInvoice]: #latestrecurringpendinginvoice #### [latestRecurringPendingInvoice] An account's latest recurring pending invoice. -Type: **SoftLayer_Billing_Invoice ** +Type: **SoftLayer_Billing_Invoice ** + @@ -1449,7 +1592,8 @@ An account's latest recurring pending invoice. [legacyBandwidthAllotments]: #legacybandwidthallotments #### [legacyBandwidthAllotments] The legacy bandwidth allotments for an account. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment[] ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment[] ** + @@ -1459,7 +1603,8 @@ The legacy bandwidth allotments for an account. [legacyIscsiCapacityGB]: #legacyiscsicapacitygb #### [legacyIscsiCapacityGB] The total capacity of Legacy iSCSI Volumes on an account, in GB. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1469,7 +1614,8 @@ The total capacity of Legacy iSCSI Volumes on an account, in GB. [loadBalancers]: #loadbalancers #### [loadBalancers] An account's associated load balancers. -Type: **SoftLayer_Network_LoadBalancer_VirtualIpAddress[] ** +Type: **SoftLayer_Network_LoadBalancer_VirtualIpAddress[] ** + @@ -1479,7 +1625,8 @@ An account's associated load balancers. [lockboxCapacityGB]: #lockboxcapacitygb #### [lockboxCapacityGB] The total capacity of Legacy lockbox Volumes on an account, in GB. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1489,7 +1636,8 @@ The total capacity of Legacy lockbox Volumes on an account, in GB. [lockboxNetworkStorage]: #lockboxnetworkstorage #### [lockboxNetworkStorage] An account's associated Lockbox storage volumes. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -1499,7 +1647,8 @@ An account's associated Lockbox storage volumes. [manualPaymentsUnderReview]: #manualpaymentsunderreview #### [manualPaymentsUnderReview] -Type: **SoftLayer_Billing_Payment_Card_ManualPayment[] ** +Type: **SoftLayer_Billing_Payment_Card_ManualPayment[] ** + @@ -1509,7 +1658,8 @@ An account's associated Lockbox storage volumes. [masterUser]: #masteruser #### [masterUser] An account's master user. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -1519,7 +1669,8 @@ An account's master user. [mediaDataTransferRequests]: #mediadatatransferrequests #### [mediaDataTransferRequests] An account's media transfer service requests. -Type: **SoftLayer_Account_Media_Data_Transfer_Request[] ** +Type: **SoftLayer_Account_Media_Data_Transfer_Request[] ** + @@ -1529,7 +1680,8 @@ An account's media transfer service requests. [migratedToIbmCloudPortalFlag]: #migratedtoibmcloudportalflag #### [migratedToIbmCloudPortalFlag] Flag indicating whether this account is restricted to the IBM Cloud portal. -Type: **boolean** +Type: **boolean** + @@ -1539,7 +1691,8 @@ Flag indicating whether this account is restricted to the IBM Cloud portal. [monthlyBareMetalInstances]: #monthlybaremetalinstances #### [monthlyBareMetalInstances] An account's associated monthly bare metal server objects. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1549,7 +1702,8 @@ An account's associated monthly bare metal server objects. [monthlyVirtualGuests]: #monthlyvirtualguests #### [monthlyVirtualGuests] An account's associated monthly virtual guest objects. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -1559,7 +1713,8 @@ An account's associated monthly virtual guest objects. [nasNetworkStorage]: #nasnetworkstorage #### [nasNetworkStorage] An account's associated NAS storage volumes. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -1569,7 +1724,8 @@ An account's associated NAS storage volumes. [networkCreationFlag]: #networkcreationflag #### [networkCreationFlag] [Deprecated] Whether or not this account can define their own networks. -Type: **boolean** +Type: **boolean** + @@ -1579,7 +1735,8 @@ An account's associated NAS storage volumes. [networkGateways]: #networkgateways #### [networkGateways] All network gateway devices on this account. -Type: **SoftLayer_Network_Gateway[] ** +Type: **SoftLayer_Network_Gateway[] ** + @@ -1589,7 +1746,8 @@ All network gateway devices on this account. [networkHardware]: #networkhardware #### [networkHardware] An account's associated network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1599,7 +1757,8 @@ An account's associated network hardware. [networkMessageDeliveryAccounts]: #networkmessagedeliveryaccounts #### [networkMessageDeliveryAccounts] -Type: **SoftLayer_Network_Message_Delivery[] ** +Type: **SoftLayer_Network_Message_Delivery[] ** + @@ -1609,7 +1768,8 @@ An account's associated network hardware. [networkMonitorDownHardware]: #networkmonitordownhardware #### [networkMonitorDownHardware] Hardware which is currently experiencing a service failure. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1619,7 +1779,8 @@ Hardware which is currently experiencing a service failure. [networkMonitorDownVirtualGuests]: #networkmonitordownvirtualguests #### [networkMonitorDownVirtualGuests] Virtual guest which is currently experiencing a service failure. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -1629,7 +1790,8 @@ Virtual guest which is currently experiencing a service failure. [networkMonitorRecoveringHardware]: #networkmonitorrecoveringhardware #### [networkMonitorRecoveringHardware] Hardware which is currently recovering from a service failure. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1639,7 +1801,8 @@ Hardware which is currently recovering from a service failure. [networkMonitorRecoveringVirtualGuests]: #networkmonitorrecoveringvirtualguests #### [networkMonitorRecoveringVirtualGuests] Virtual guest which is currently recovering from a service failure. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -1649,7 +1812,8 @@ Virtual guest which is currently recovering from a service failure. [networkMonitorUpHardware]: #networkmonitoruphardware #### [networkMonitorUpHardware] Hardware which is currently online. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1659,7 +1823,8 @@ Hardware which is currently online. [networkMonitorUpVirtualGuests]: #networkmonitorupvirtualguests #### [networkMonitorUpVirtualGuests] Virtual guest which is currently online. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -1669,7 +1834,8 @@ Virtual guest which is currently online. [networkStorage]: #networkstorage #### [networkStorage] An account's associated storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -1679,7 +1845,8 @@ An account's associated storage volumes. This includes Lockbox, NAS, EVault, and [networkStorageGroups]: #networkstoragegroups #### [networkStorageGroups] An account's Network Storage groups. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -1689,7 +1856,8 @@ An account's Network Storage groups. [networkTunnelContexts]: #networktunnelcontexts #### [networkTunnelContexts] IPSec network tunnels for an account. -Type: **SoftLayer_Network_Tunnel_Module_Context[] ** +Type: **SoftLayer_Network_Tunnel_Module_Context[] ** + @@ -1699,7 +1867,8 @@ IPSec network tunnels for an account. [networkVlanSpan]: #networkvlanspan #### [networkVlanSpan] Whether or not an account has automatic private VLAN spanning enabled. -Type: **SoftLayer_Account_Network_Vlan_Span ** +Type: **SoftLayer_Account_Network_Vlan_Span ** + @@ -1709,7 +1878,8 @@ Whether or not an account has automatic private VLAN spanning enabled. [networkVlans]: #networkvlans #### [networkVlans] All network VLANs assigned to an account. -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -1719,7 +1889,8 @@ All network VLANs assigned to an account. [nextBillingPublicAllotmentHardwareBandwidthDetails]: #nextbillingpublicallotmenthardwarebandwidthdetails #### [nextBillingPublicAllotmentHardwareBandwidthDetails] DEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED. The allotments for this account and their servers for the next billing cycle. The public inbound and outbound bandwidth is calculated for each server in addition to the daily average network traffic since the last billing date. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment[] ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment[] ** + @@ -1729,7 +1900,8 @@ DEPRECATED - This information can be pulled directly through tapping keys now - [nextInvoiceIncubatorExemptTotal]: #nextinvoiceincubatorexempttotal #### [nextInvoiceIncubatorExemptTotal] The pre-tax total amount exempt from incubator credit for the account's next invoice. This field is now deprecated and will soon be removed. Please update all references to instead use nextInvoiceTotalAmount -Type: **decimal** +Type: **decimal** + @@ -1739,7 +1911,8 @@ The pre-tax total amount exempt from incubator credit for the account's next inv [nextInvoiceRecurringAmountEligibleForAccountDiscount]: #nextinvoicerecurringamounteligibleforaccountdiscount #### [nextInvoiceRecurringAmountEligibleForAccountDiscount] The total recurring charge amount of an account's next invoice eligible for account discount measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. -Type: **decimal** +Type: **decimal** + @@ -1749,7 +1922,8 @@ The total recurring charge amount of an account's next invoice eligible for acco [nextInvoiceTopLevelBillingItems]: #nextinvoicetoplevelbillingitems #### [nextInvoiceTopLevelBillingItems] The billing items that will be on an account's next invoice. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -1759,7 +1933,8 @@ The billing items that will be on an account's next invoice. [nextInvoiceTotalAmount]: #nextinvoicetotalamount #### [nextInvoiceTotalAmount] The pre-tax total amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. -Type: **float** +Type: **float** + @@ -1769,7 +1944,8 @@ The pre-tax total amount of an account's next invoice measured in US Dollars ($U [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] The total one-time charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. -Type: **decimal** +Type: **decimal** + @@ -1779,7 +1955,8 @@ The total one-time charge amount of an account's next invoice measured in US Dol [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] The total one-time tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. -Type: **decimal** +Type: **decimal** + @@ -1789,7 +1966,8 @@ The total one-time tax amount of an account's next invoice measured in US Dollar [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] The total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. -Type: **decimal** +Type: **decimal** + @@ -1799,7 +1977,8 @@ The total recurring charge amount of an account's next invoice measured in US Do [nextInvoiceTotalRecurringAmountBeforeAccountDiscount]: #nextinvoicetotalrecurringamountbeforeaccountdiscount #### [nextInvoiceTotalRecurringAmountBeforeAccountDiscount] The total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. -Type: **decimal** +Type: **decimal** + @@ -1809,7 +1988,8 @@ The total recurring charge amount of an account's next invoice measured in US Do [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] The total recurring tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. -Type: **float** +Type: **float** + @@ -1819,7 +1999,8 @@ The total recurring tax amount of an account's next invoice measured in US Dolla [nextInvoiceTotalTaxableRecurringAmount]: #nextinvoicetotaltaxablerecurringamount #### [nextInvoiceTotalTaxableRecurringAmount] The total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. -Type: **decimal** +Type: **decimal** + @@ -1829,7 +2010,8 @@ The total recurring charge amount of an account's next invoice measured in US Do [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] -Type: **SoftLayer_Notification_Subscriber[] ** +Type: **SoftLayer_Notification_Subscriber[] ** + @@ -1839,7 +2021,8 @@ The total recurring charge amount of an account's next invoice measured in US Do [openAbuseTickets]: #openabusetickets #### [openAbuseTickets] The open abuse tickets associated with an account. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -1849,7 +2032,8 @@ The open abuse tickets associated with an account. [openAccountingTickets]: #openaccountingtickets #### [openAccountingTickets] The open accounting tickets associated with an account. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -1859,7 +2043,8 @@ The open accounting tickets associated with an account. [openBillingTickets]: #openbillingtickets #### [openBillingTickets] The open billing tickets associated with an account. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -1869,7 +2054,8 @@ The open billing tickets associated with an account. [openCancellationRequests]: #opencancellationrequests #### [openCancellationRequests] An open ticket requesting cancellation of this server, if one exists. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -1879,7 +2065,8 @@ An open ticket requesting cancellation of this server, if one exists. [openOtherTickets]: #openothertickets #### [openOtherTickets] The open tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -1889,7 +2076,8 @@ The open tickets that do not belong to the abuse, accounting, sales, or support [openRecurringInvoices]: #openrecurringinvoices #### [openRecurringInvoices] An account's recurring invoices. -Type: **SoftLayer_Billing_Invoice[] ** +Type: **SoftLayer_Billing_Invoice[] ** + @@ -1899,7 +2087,8 @@ An account's recurring invoices. [openSalesTickets]: #opensalestickets #### [openSalesTickets] The open sales tickets associated with an account. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -1909,7 +2098,8 @@ The open sales tickets associated with an account. [openStackAccountLinks]: #openstackaccountlinks #### [openStackAccountLinks] -Type: **SoftLayer_Account_Link[] ** +Type: **SoftLayer_Account_Link[] ** + @@ -1919,7 +2109,8 @@ The open sales tickets associated with an account. [openStackObjectStorage]: #openstackobjectstorage #### [openStackObjectStorage] An account's associated Openstack related Object Storage accounts. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -1929,7 +2120,8 @@ An account's associated Openstack related Object Storage accounts. [openSupportTickets]: #opensupporttickets #### [openSupportTickets] The open support tickets associated with an account. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -1939,7 +2131,8 @@ The open support tickets associated with an account. [openTickets]: #opentickets #### [openTickets] All open tickets associated with an account. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -1949,7 +2142,8 @@ All open tickets associated with an account. [openTicketsWaitingOnCustomer]: #openticketswaitingoncustomer #### [openTicketsWaitingOnCustomer] All open tickets associated with an account last edited by an employee. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -1959,7 +2153,8 @@ All open tickets associated with an account last edited by an employee. [orders]: #orders #### [orders] An account's associated billing orders excluding upgrades. -Type: **SoftLayer_Billing_Order[] ** +Type: **SoftLayer_Billing_Order[] ** + @@ -1969,7 +2164,8 @@ An account's associated billing orders excluding upgrades. [orphanBillingItems]: #orphanbillingitems #### [orphanBillingItems] The billing items that have no parent billing item. These are items that don't necessarily belong to a single server. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -1979,7 +2175,8 @@ The billing items that have no parent billing item. These are items that don't n [ownedBrands]: #ownedbrands #### [ownedBrands] -Type: **SoftLayer_Brand[] ** +Type: **SoftLayer_Brand[] ** + @@ -1989,7 +2186,8 @@ The billing items that have no parent billing item. These are items that don't n [ownedHardwareGenericComponentModels]: #ownedhardwaregenericcomponentmodels #### [ownedHardwareGenericComponentModels] -Type: **SoftLayer_Hardware_Component_Model_Generic[] ** +Type: **SoftLayer_Hardware_Component_Model_Generic[] ** + @@ -1999,7 +2197,8 @@ The billing items that have no parent billing item. These are items that don't n [paymentProcessors]: #paymentprocessors #### [paymentProcessors] -Type: **SoftLayer_Billing_Payment_Processor[] ** +Type: **SoftLayer_Billing_Payment_Processor[] ** + @@ -2009,7 +2208,8 @@ The billing items that have no parent billing item. These are items that don't n [pendingEvents]: #pendingevents #### [pendingEvents] -Type: **SoftLayer_Notification_Occurrence_Event[] ** +Type: **SoftLayer_Notification_Occurrence_Event[] ** + @@ -2019,7 +2219,8 @@ The billing items that have no parent billing item. These are items that don't n [pendingInvoice]: #pendinginvoice #### [pendingInvoice] An account's latest open (pending) invoice. -Type: **SoftLayer_Billing_Invoice ** +Type: **SoftLayer_Billing_Invoice ** + @@ -2029,7 +2230,8 @@ An account's latest open (pending) invoice. [pendingInvoiceTopLevelItems]: #pendinginvoicetoplevelitems #### [pendingInvoiceTopLevelItems] A list of top-level invoice items that are on an account's currently pending invoice. -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -2039,7 +2241,8 @@ A list of top-level invoice items that are on an account's currently pending inv [pendingInvoiceTotalAmount]: #pendinginvoicetotalamount #### [pendingInvoiceTotalAmount] The total amount of an account's pending invoice, if one exists. -Type: **decimal** +Type: **decimal** + @@ -2049,7 +2252,8 @@ The total amount of an account's pending invoice, if one exists. [pendingInvoiceTotalOneTimeAmount]: #pendinginvoicetotalonetimeamount #### [pendingInvoiceTotalOneTimeAmount] The total one-time charges for an account's pending invoice, if one exists. In other words, it is the sum of one-time charges, setup fees, and labor fees. It does not include taxes. -Type: **decimal** +Type: **decimal** + @@ -2059,7 +2263,8 @@ The total one-time charges for an account's pending invoice, if one exists. In o [pendingInvoiceTotalOneTimeTaxAmount]: #pendinginvoicetotalonetimetaxamount #### [pendingInvoiceTotalOneTimeTaxAmount] The sum of all the taxes related to one time charges for an account's pending invoice, if one exists. -Type: **decimal** +Type: **decimal** + @@ -2069,7 +2274,8 @@ The sum of all the taxes related to one time charges for an account's pending in [pendingInvoiceTotalRecurringAmount]: #pendinginvoicetotalrecurringamount #### [pendingInvoiceTotalRecurringAmount] The total recurring amount of an account's pending invoice, if one exists. -Type: **decimal** +Type: **decimal** + @@ -2079,7 +2285,8 @@ The total recurring amount of an account's pending invoice, if one exists. [pendingInvoiceTotalRecurringTaxAmount]: #pendinginvoicetotalrecurringtaxamount #### [pendingInvoiceTotalRecurringTaxAmount] The total amount of the recurring taxes on an account's pending invoice, if one exists. -Type: **decimal** +Type: **decimal** + @@ -2089,7 +2296,8 @@ The total amount of the recurring taxes on an account's pending invoice, if one [permissionGroups]: #permissiongroups #### [permissionGroups] An account's permission groups. -Type: **SoftLayer_User_Permission_Group[] ** +Type: **SoftLayer_User_Permission_Group[] ** + @@ -2099,7 +2307,8 @@ An account's permission groups. [permissionRoles]: #permissionroles #### [permissionRoles] An account's user roles. -Type: **SoftLayer_User_Permission_Role[] ** +Type: **SoftLayer_User_Permission_Role[] ** + @@ -2109,7 +2318,8 @@ An account's user roles. [placementGroups]: #placementgroups #### [placementGroups] An account's associated virtual placement groups. -Type: **SoftLayer_Virtual_PlacementGroup[] ** +Type: **SoftLayer_Virtual_PlacementGroup[] ** + @@ -2119,7 +2329,8 @@ An account's associated virtual placement groups. [portableStorageVolumes]: #portablestoragevolumes #### [portableStorageVolumes] -Type: **SoftLayer_Virtual_Disk_Image[] ** +Type: **SoftLayer_Virtual_Disk_Image[] ** + @@ -2129,7 +2340,8 @@ An account's associated virtual placement groups. [postProvisioningHooks]: #postprovisioninghooks #### [postProvisioningHooks] Customer specified URIs that are downloaded onto a newly provisioned or reloaded server. If the URI is sent over https it will be executed directly on the server. -Type: **SoftLayer_Provisioning_Hook[] ** +Type: **SoftLayer_Provisioning_Hook[] ** + @@ -2139,7 +2351,8 @@ Customer specified URIs that are downloaded onto a newly provisioned or reloaded [pptpVpnAllowedFlag]: #pptpvpnallowedflag #### [pptpVpnAllowedFlag] (Deprecated) Boolean flag dictating whether or not this account supports PPTP VPN Access. -Type: **boolean** +Type: **boolean** + @@ -2149,7 +2362,8 @@ Customer specified URIs that are downloaded onto a newly provisioned or reloaded [pptpVpnUsers]: #pptpvpnusers #### [pptpVpnUsers] An account's associated portal users with PPTP VPN access. (Deprecated) -Type: **SoftLayer_User_Customer[] ** +Type: **SoftLayer_User_Customer[] ** + @@ -2159,7 +2373,8 @@ An account's associated portal users with PPTP VPN access. (Deprecated) [previousRecurringRevenue]: #previousrecurringrevenue #### [previousRecurringRevenue] The total recurring amount for an accounts previous revenue. -Type: **decimal** +Type: **decimal** + @@ -2169,7 +2384,8 @@ The total recurring amount for an accounts previous revenue. [priceRestrictions]: #pricerestrictions #### [priceRestrictions] The item price that an account is restricted to. -Type: **SoftLayer_Product_Item_Price_Account_Restriction[] ** +Type: **SoftLayer_Product_Item_Price_Account_Restriction[] ** + @@ -2179,7 +2395,8 @@ The item price that an account is restricted to. [priorityOneTickets]: #priorityonetickets #### [priorityOneTickets] All priority one tickets associated with an account. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -2189,7 +2406,8 @@ All priority one tickets associated with an account. [privateAllotmentHardwareBandwidthDetails]: #privateallotmenthardwarebandwidthdetails #### [privateAllotmentHardwareBandwidthDetails] DEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED. The allotments for this account and their servers. The private inbound and outbound bandwidth is calculated for each server in addition to the daily average network traffic since the last billing date. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment[] ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment[] ** + @@ -2199,7 +2417,8 @@ DEPRECATED - This information can be pulled directly through tapping keys now - [privateBlockDeviceTemplateGroups]: #privateblockdevicetemplategroups #### [privateBlockDeviceTemplateGroups] Private and shared template group objects (parent only) for an account. -Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group[] ** +Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group[] ** + @@ -2209,7 +2428,8 @@ Private and shared template group objects (parent only) for an account. [privateIpAddresses]: #privateipaddresses #### [privateIpAddresses] -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -2219,7 +2439,8 @@ Private and shared template group objects (parent only) for an account. [privateNetworkVlans]: #privatenetworkvlans #### [privateNetworkVlans] The private network VLANs assigned to an account. -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -2229,7 +2450,8 @@ The private network VLANs assigned to an account. [privateSubnets]: #privatesubnets #### [privateSubnets] All private subnets associated with an account. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -2239,7 +2461,8 @@ All private subnets associated with an account. [proofOfConceptAccountFlag]: #proofofconceptaccountflag #### [proofOfConceptAccountFlag] Boolean flag indicating whether or not this account is a Proof of Concept account. -Type: **boolean** +Type: **boolean** + @@ -2249,7 +2472,8 @@ Boolean flag indicating whether or not this account is a Proof of Concept accoun [publicAllotmentHardwareBandwidthDetails]: #publicallotmenthardwarebandwidthdetails #### [publicAllotmentHardwareBandwidthDetails] DEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED. The allotments for this account and their servers. The public inbound and outbound bandwidth is calculated for each server in addition to the daily average network traffic since the last billing date. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment[] ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment[] ** + @@ -2259,7 +2483,8 @@ DEPRECATED - This information can be pulled directly through tapping keys now - [publicIpAddresses]: #publicipaddresses #### [publicIpAddresses] -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -2269,7 +2494,8 @@ DEPRECATED - This information can be pulled directly through tapping keys now - [publicNetworkVlans]: #publicnetworkvlans #### [publicNetworkVlans] The public network VLANs assigned to an account. -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -2279,7 +2505,8 @@ The public network VLANs assigned to an account. [publicSubnets]: #publicsubnets #### [publicSubnets] All public network subnets associated with an account. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -2289,7 +2516,8 @@ All public network subnets associated with an account. [quotes]: #quotes #### [quotes] An account's quotes. -Type: **SoftLayer_Billing_Order_Quote[] ** +Type: **SoftLayer_Billing_Order_Quote[] ** + @@ -2299,7 +2527,8 @@ An account's quotes. [recentEvents]: #recentevents #### [recentEvents] -Type: **SoftLayer_Notification_Occurrence_Event[] ** +Type: **SoftLayer_Notification_Occurrence_Event[] ** + @@ -2309,7 +2538,8 @@ An account's quotes. [referralPartner]: #referralpartner #### [referralPartner] The Referral Partner for this account, if any. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -2319,7 +2549,8 @@ The Referral Partner for this account, if any. [referredAccounts]: #referredaccounts #### [referredAccounts] If this is a account is a referral partner, the accounts this referral partner has referred -Type: **SoftLayer_Account[] ** +Type: **SoftLayer_Account[] ** + @@ -2329,7 +2560,8 @@ If this is a account is a referral partner, the accounts this referral partner h [regulatedWorkloads]: #regulatedworkloads #### [regulatedWorkloads] -Type: **SoftLayer_Legal_RegulatedWorkload[] ** +Type: **SoftLayer_Legal_RegulatedWorkload[] ** + @@ -2339,7 +2571,8 @@ If this is a account is a referral partner, the accounts this referral partner h [remoteManagementCommandRequests]: #remotemanagementcommandrequests #### [remoteManagementCommandRequests] Remote management command requests for an account -Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request[] ** + @@ -2349,7 +2582,8 @@ Remote management command requests for an account [replicationEvents]: #replicationevents #### [replicationEvents] The Replication events for all Network Storage volumes on an account. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -2359,7 +2593,8 @@ The Replication events for all Network Storage volumes on an account. [requireSilentIBMidUserCreation]: #requiresilentibmidusercreation #### [requireSilentIBMidUserCreation] Indicates whether newly created users under this account will be associated with IBMid via an email requiring a response, or not. -Type: **boolean** +Type: **boolean** + @@ -2369,7 +2604,8 @@ Indicates whether newly created users under this account will be associated with [reservedCapacityAgreements]: #reservedcapacityagreements #### [reservedCapacityAgreements] All reserved capacity agreements for an account -Type: **SoftLayer_Account_Agreement[] ** +Type: **SoftLayer_Account_Agreement[] ** + @@ -2379,7 +2615,8 @@ All reserved capacity agreements for an account [reservedCapacityGroups]: #reservedcapacitygroups #### [reservedCapacityGroups] The reserved capacity groups owned by this account. -Type: **SoftLayer_Virtual_ReservedCapacityGroup[] ** +Type: **SoftLayer_Virtual_ReservedCapacityGroup[] ** + @@ -2389,7 +2626,8 @@ The reserved capacity groups owned by this account. [resourceGroups]: #resourcegroups #### [resourceGroups] An account's associated top-level resource groups. -Type: **SoftLayer_Resource_Group[] ** +Type: **SoftLayer_Resource_Group[] ** + @@ -2399,17 +2637,20 @@ An account's associated top-level resource groups. [routers]: #routers #### [routers] All Routers that an accounts VLANs reside on -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + -
+
----- [rwhoisData]: #rwhoisdata #### [rwhoisData] DEPRECATED -Type: **SoftLayer_Network_Subnet_Rwhois_Data[] ** +Type: **SoftLayer_Network_Subnet_Rwhois_Data[] ** + +Deprecated
@@ -2419,7 +2660,8 @@ DEPRECATED [samlAuthentication]: #samlauthentication #### [samlAuthentication] The SAML configuration for this account. -Type: **SoftLayer_Account_Authentication_Saml ** +Type: **SoftLayer_Account_Authentication_Saml ** +
@@ -2429,7 +2671,8 @@ The SAML configuration for this account. [scaleGroups]: #scalegroups #### [scaleGroups] All scale groups on this account. -Type: **SoftLayer_Scale_Group[] ** +Type: **SoftLayer_Scale_Group[] ** + @@ -2439,7 +2682,8 @@ All scale groups on this account. [secondaryDomains]: #secondarydomains #### [secondaryDomains] The secondary DNS records for a SoftLayer customer account. -Type: **SoftLayer_Dns_Secondary[] ** +Type: **SoftLayer_Dns_Secondary[] ** + @@ -2449,7 +2693,8 @@ The secondary DNS records for a SoftLayer customer account. [securityCertificates]: #securitycertificates #### [securityCertificates] Stored security certificates (ie. SSL) -Type: **SoftLayer_Security_Certificate[] ** +Type: **SoftLayer_Security_Certificate[] ** + @@ -2459,7 +2704,8 @@ Stored security certificates (ie. SSL) [securityGroups]: #securitygroups #### [securityGroups] The security groups belonging to this account. -Type: **SoftLayer_Network_SecurityGroup[] ** +Type: **SoftLayer_Network_SecurityGroup[] ** + @@ -2469,7 +2715,8 @@ The security groups belonging to this account. [securityLevel]: #securitylevel #### [securityLevel] -Type: **SoftLayer_Security_Level ** +Type: **SoftLayer_Security_Level ** + @@ -2479,7 +2726,8 @@ The security groups belonging to this account. [securityScanRequests]: #securityscanrequests #### [securityScanRequests] An account's vulnerability scan requests. -Type: **SoftLayer_Network_Security_Scanner_Request[] ** +Type: **SoftLayer_Network_Security_Scanner_Request[] ** + @@ -2489,7 +2737,8 @@ An account's vulnerability scan requests. [serviceBillingItems]: #servicebillingitems #### [serviceBillingItems] The service billing items that will be on an account's next invoice. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -2499,7 +2748,8 @@ The service billing items that will be on an account's next invoice. [shipments]: #shipments #### [shipments] Shipments that belong to the customer's account. -Type: **SoftLayer_Account_Shipment[] ** +Type: **SoftLayer_Account_Shipment[] ** + @@ -2509,7 +2759,8 @@ Shipments that belong to the customer's account. [sshKeys]: #sshkeys #### [sshKeys] Customer specified SSH keys that can be implemented onto a newly provisioned or reloaded server. -Type: **SoftLayer_Security_Ssh_Key[] ** +Type: **SoftLayer_Security_Ssh_Key[] ** + @@ -2519,7 +2770,8 @@ Customer specified SSH keys that can be implemented onto a newly provisioned or [sslVpnUsers]: #sslvpnusers #### [sslVpnUsers] An account's associated portal users with SSL VPN access. -Type: **SoftLayer_User_Customer[] ** +Type: **SoftLayer_User_Customer[] ** + @@ -2529,7 +2781,8 @@ An account's associated portal users with SSL VPN access. [standardPoolVirtualGuests]: #standardpoolvirtualguests #### [standardPoolVirtualGuests] An account's virtual guest objects that are hosted on a user provisioned hypervisor. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -2539,7 +2792,8 @@ An account's virtual guest objects that are hosted on a user provisioned hypervi [subnetRegistrationDetails]: #subnetregistrationdetails #### [subnetRegistrationDetails] -Type: **SoftLayer_Account_Regional_Registry_Detail[] ** +Type: **SoftLayer_Account_Regional_Registry_Detail[] ** + @@ -2549,7 +2803,8 @@ An account's virtual guest objects that are hosted on a user provisioned hypervi [subnetRegistrations]: #subnetregistrations #### [subnetRegistrations] -Type: **SoftLayer_Network_Subnet_Registration[] ** +Type: **SoftLayer_Network_Subnet_Registration[] ** + @@ -2559,7 +2814,8 @@ An account's virtual guest objects that are hosted on a user provisioned hypervi [subnets]: #subnets #### [subnets] All network subnets associated with an account. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -2569,7 +2825,8 @@ All network subnets associated with an account. [supportRepresentatives]: #supportrepresentatives #### [supportRepresentatives] The SoftLayer employees that an account is assigned to. -Type: **SoftLayer_User_Employee[] ** +Type: **SoftLayer_User_Employee[] ** + @@ -2579,7 +2836,8 @@ The SoftLayer employees that an account is assigned to. [supportSubscriptions]: #supportsubscriptions #### [supportSubscriptions] The active support subscriptions for this account. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -2589,7 +2847,8 @@ The active support subscriptions for this account. [supportTier]: #supporttier #### [supportTier] -Type: **string** +Type: **string** + @@ -2599,7 +2858,8 @@ The active support subscriptions for this account. [suppressInvoicesFlag]: #suppressinvoicesflag #### [suppressInvoicesFlag] A flag indicating to suppress invoices. -Type: **boolean** +Type: **boolean** + @@ -2609,7 +2869,8 @@ A flag indicating to suppress invoices. [tags]: #tags #### [tags] -Type: **SoftLayer_Tag[] ** +Type: **SoftLayer_Tag[] ** + @@ -2619,7 +2880,8 @@ A flag indicating to suppress invoices. [tickets]: #tickets #### [tickets] An account's associated tickets. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -2629,7 +2891,8 @@ An account's associated tickets. [ticketsClosedInTheLastThreeDays]: #ticketsclosedinthelastthreedays #### [ticketsClosedInTheLastThreeDays] Tickets closed within the last 72 hours or last 10 tickets, whichever is less, associated with an account. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -2639,7 +2902,8 @@ Tickets closed within the last 72 hours or last 10 tickets, whichever is less, a [ticketsClosedToday]: #ticketsclosedtoday #### [ticketsClosedToday] Tickets closed today associated with an account. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -2649,7 +2913,8 @@ Tickets closed today associated with an account. [transcodeAccounts]: #transcodeaccounts #### [transcodeAccounts] An account's associated Transcode account. -Type: **SoftLayer_Network_Media_Transcode_Account[] ** +Type: **SoftLayer_Network_Media_Transcode_Account[] ** + @@ -2659,7 +2924,8 @@ An account's associated Transcode account. [upgradeRequests]: #upgraderequests #### [upgradeRequests] An account's associated upgrade requests. -Type: **SoftLayer_Product_Upgrade_Request[] ** +Type: **SoftLayer_Product_Upgrade_Request[] ** + @@ -2669,7 +2935,8 @@ An account's associated upgrade requests. [users]: #users #### [users] An account's portal users. -Type: **SoftLayer_User_Customer[] ** +Type: **SoftLayer_User_Customer[] ** + @@ -2679,7 +2946,8 @@ An account's portal users. [validSecurityCertificates]: #validsecuritycertificates #### [validSecurityCertificates] Stored security certificates that are not expired (ie. SSL) -Type: **SoftLayer_Security_Certificate[] ** +Type: **SoftLayer_Security_Certificate[] ** + @@ -2689,7 +2957,8 @@ Stored security certificates that are not expired (ie. SSL) [vdrUpdatesInProgressFlag]: #vdrupdatesinprogressflag #### [vdrUpdatesInProgressFlag] Return 0 if vpn updates are currently in progress on this account otherwise 1. -Type: **boolean** +Type: **boolean** + @@ -2699,7 +2968,8 @@ Return 0 if vpn updates are currently in progress on this account otherwise 1. [virtualDedicatedRacks]: #virtualdedicatedracks #### [virtualDedicatedRacks] The bandwidth pooling for this account. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment[] ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment[] ** + @@ -2709,7 +2979,8 @@ The bandwidth pooling for this account. [virtualDiskImages]: #virtualdiskimages #### [virtualDiskImages] An account's associated virtual server virtual disk images. -Type: **SoftLayer_Virtual_Disk_Image[] ** +Type: **SoftLayer_Virtual_Disk_Image[] ** + @@ -2719,7 +2990,8 @@ An account's associated virtual server virtual disk images. [virtualGuests]: #virtualguests #### [virtualGuests] An account's associated virtual guest objects. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -2729,7 +3001,8 @@ An account's associated virtual guest objects. [virtualGuestsOverBandwidthAllocation]: #virtualguestsoverbandwidthallocation #### [virtualGuestsOverBandwidthAllocation] An account's associated virtual guest objects currently over bandwidth allocation. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -2739,7 +3012,8 @@ An account's associated virtual guest objects currently over bandwidth allocatio [virtualGuestsProjectedOverBandwidthAllocation]: #virtualguestsprojectedoverbandwidthallocation #### [virtualGuestsProjectedOverBandwidthAllocation] An account's associated virtual guest objects currently over bandwidth allocation. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -2749,7 +3023,8 @@ An account's associated virtual guest objects currently over bandwidth allocatio [virtualGuestsWithCpanel]: #virtualguestswithcpanel #### [virtualGuestsWithCpanel] All virtual guests associated with an account that has the cPanel web hosting control panel installed. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -2759,7 +3034,8 @@ All virtual guests associated with an account that has the cPanel web hosting co [virtualGuestsWithMcafee]: #virtualguestswithmcafee #### [virtualGuestsWithMcafee] All virtual guests associated with an account that have McAfee Secure software components. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -2769,7 +3045,8 @@ All virtual guests associated with an account that have McAfee Secure software c [virtualGuestsWithMcafeeAntivirusRedhat]: #virtualguestswithmcafeeantivirusredhat #### [virtualGuestsWithMcafeeAntivirusRedhat] All virtual guests associated with an account that have McAfee Secure AntiVirus for Redhat software components. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -2779,7 +3056,8 @@ All virtual guests associated with an account that have McAfee Secure AntiVirus [virtualGuestsWithMcafeeAntivirusWindows]: #virtualguestswithmcafeeantiviruswindows #### [virtualGuestsWithMcafeeAntivirusWindows] All virtual guests associated with an account that has McAfee Secure AntiVirus for Windows software components. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -2789,7 +3067,8 @@ All virtual guests associated with an account that has McAfee Secure AntiVirus f [virtualGuestsWithMcafeeIntrusionDetectionSystem]: #virtualguestswithmcafeeintrusiondetectionsystem #### [virtualGuestsWithMcafeeIntrusionDetectionSystem] All virtual guests associated with an account that has McAfee Secure Intrusion Detection System software components. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -2799,7 +3078,8 @@ All virtual guests associated with an account that has McAfee Secure Intrusion D [virtualGuestsWithPlesk]: #virtualguestswithplesk #### [virtualGuestsWithPlesk] All virtual guests associated with an account that has the Plesk web hosting control panel installed. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -2809,7 +3089,8 @@ All virtual guests associated with an account that has the Plesk web hosting con [virtualGuestsWithQuantastor]: #virtualguestswithquantastor #### [virtualGuestsWithQuantastor] All virtual guests associated with an account that have the QuantaStor storage system installed. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -2819,7 +3100,8 @@ All virtual guests associated with an account that have the QuantaStor storage s [virtualGuestsWithUrchin]: #virtualguestswithurchin #### [virtualGuestsWithUrchin] All virtual guests associated with an account that has the Urchin web traffic analytics package installed. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -2829,7 +3111,8 @@ All virtual guests associated with an account that has the Urchin web traffic an [virtualPrivateRack]: #virtualprivaterack #### [virtualPrivateRack] The bandwidth pooling for this account. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** + @@ -2839,7 +3122,8 @@ The bandwidth pooling for this account. [virtualStorageArchiveRepositories]: #virtualstoragearchiverepositories #### [virtualStorageArchiveRepositories] An account's associated virtual server archived storage repositories. -Type: **SoftLayer_Virtual_Storage_Repository[] ** +Type: **SoftLayer_Virtual_Storage_Repository[] ** + @@ -2849,7 +3133,8 @@ An account's associated virtual server archived storage repositories. [virtualStoragePublicRepositories]: #virtualstoragepublicrepositories #### [virtualStoragePublicRepositories] An account's associated virtual server public storage repositories. -Type: **SoftLayer_Virtual_Storage_Repository[] ** +Type: **SoftLayer_Virtual_Storage_Repository[] ** + @@ -2859,7 +3144,8 @@ An account's associated virtual server public storage repositories. [vpcVirtualGuests]: #vpcvirtualguests #### [vpcVirtualGuests] An account's associated VPC configured virtual guest objects. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -2869,7 +3155,8 @@ An account's associated VPC configured virtual guest objects. [vpnConfigRequiresVPNManageFlag]: #vpnconfigrequiresvpnmanageflag #### [vpnConfigRequiresVPNManageFlag] -Type: **boolean** +Type: **boolean** + @@ -2881,7 +3168,8 @@ An account's associated VPC configured virtual guest objects. [abuseEmailCount]: #abuseemailcount #### [abuseEmailCount] A count of email addresses that are responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to these addresses. -Type: **unsigned long** +Type: **unsigned long** + @@ -2891,7 +3179,8 @@ A count of email addresses that are responsible for abuse and legal inquiries on [accountContactCount]: #accountcontactcount #### [accountContactCount] A count of the account contacts on an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -2901,7 +3190,8 @@ A count of the account contacts on an account. [accountLicenseCount]: #accountlicensecount #### [accountLicenseCount] A count of the account software licenses owned by an account -Type: **unsigned long** +Type: **unsigned long** + @@ -2911,7 +3201,8 @@ A count of the account software licenses owned by an account [accountLinkCount]: #accountlinkcount #### [accountLinkCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2921,7 +3212,8 @@ A count of [activeAccountLicenseCount]: #activeaccountlicensecount #### [activeAccountLicenseCount] A count of the active account software licenses owned by an account -Type: **unsigned long** +Type: **unsigned long** + @@ -2931,7 +3223,8 @@ A count of the active account software licenses owned by an account [activeAddressCount]: #activeaddresscount #### [activeAddressCount] A count of the active address(es) that belong to an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -2941,7 +3234,8 @@ A count of the active address(es) that belong to an account. [activeAgreementCount]: #activeagreementcount #### [activeAgreementCount] A count of all active agreements for an account -Type: **unsigned long** +Type: **unsigned long** + @@ -2951,7 +3245,8 @@ A count of all active agreements for an account [activeBillingAgreementCount]: #activebillingagreementcount #### [activeBillingAgreementCount] A count of all billing agreements for an account -Type: **unsigned long** +Type: **unsigned long** + @@ -2961,7 +3256,8 @@ A count of all billing agreements for an account [activeColocationContainerCount]: #activecolocationcontainercount #### [activeColocationContainerCount] A count of the account's active top level colocation containers. -Type: **unsigned long** +Type: **unsigned long** + @@ -2971,7 +3267,8 @@ A count of the account's active top level colocation containers. [activeFlexibleCreditEnrollmentCount]: #activeflexiblecreditenrollmentcount #### [activeFlexibleCreditEnrollmentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2981,7 +3278,8 @@ A count of [activeNotificationSubscriberCount]: #activenotificationsubscribercount #### [activeNotificationSubscriberCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2991,7 +3289,8 @@ A count of [activeQuoteCount]: #activequotecount #### [activeQuoteCount] A count of an account's non-expired quotes. -Type: **unsigned long** +Type: **unsigned long** + @@ -3001,7 +3300,8 @@ A count of an account's non-expired quotes. [activeReservedCapacityAgreementCount]: #activereservedcapacityagreementcount #### [activeReservedCapacityAgreementCount] A count of active reserved capacity agreements for an account -Type: **unsigned long** +Type: **unsigned long** + @@ -3011,7 +3311,8 @@ A count of active reserved capacity agreements for an account [activeVirtualLicenseCount]: #activevirtuallicensecount #### [activeVirtualLicenseCount] A count of the virtual software licenses controlled by an account -Type: **unsigned long** +Type: **unsigned long** + @@ -3021,7 +3322,8 @@ A count of the virtual software licenses controlled by an account [adcLoadBalancerCount]: #adcloadbalancercount #### [adcLoadBalancerCount] A count of an account's associated load balancers. -Type: **unsigned long** +Type: **unsigned long** + @@ -3031,7 +3333,8 @@ A count of an account's associated load balancers. [addressCount]: #addresscount #### [addressCount] A count of all the address(es) that belong to an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3041,7 +3344,8 @@ A count of all the address(es) that belong to an account. [allCommissionBillingItemCount]: #allcommissionbillingitemcount #### [allCommissionBillingItemCount] A count of the billing items that will be on an account's next invoice. -Type: **unsigned long** +Type: **unsigned long** + @@ -3051,7 +3355,8 @@ A count of the billing items that will be on an account's next invoice. [allRecurringTopLevelBillingItemCount]: #allrecurringtoplevelbillingitemcount #### [allRecurringTopLevelBillingItemCount] A count of the billing items that will be on an account's next invoice. -Type: **unsigned long** +Type: **unsigned long** + @@ -3061,7 +3366,8 @@ A count of the billing items that will be on an account's next invoice. [allRecurringTopLevelBillingItemsUnfilteredCount]: #allrecurringtoplevelbillingitemsunfilteredcount #### [allRecurringTopLevelBillingItemsUnfilteredCount] A count of the billing items that will be on an account's next invoice. Does not consider associated items. -Type: **unsigned long** +Type: **unsigned long** + @@ -3071,7 +3377,8 @@ A count of the billing items that will be on an account's next invoice. Does not [allSubnetBillingItemCount]: #allsubnetbillingitemcount #### [allSubnetBillingItemCount] A count of the billing items that will be on an account's next invoice. -Type: **unsigned long** +Type: **unsigned long** + @@ -3081,7 +3388,8 @@ A count of the billing items that will be on an account's next invoice. [allTopLevelBillingItemCount]: #alltoplevelbillingitemcount #### [allTopLevelBillingItemCount] A count of all billing items of an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3091,7 +3399,8 @@ A count of all billing items of an account. [allTopLevelBillingItemsUnfilteredCount]: #alltoplevelbillingitemsunfilteredcount #### [allTopLevelBillingItemsUnfilteredCount] A count of the billing items that will be on an account's next invoice. Does not consider associated items. -Type: **unsigned long** +Type: **unsigned long** + @@ -3101,7 +3410,8 @@ A count of the billing items that will be on an account's next invoice. Does not [applicationDeliveryControllerCount]: #applicationdeliverycontrollercount #### [applicationDeliveryControllerCount] A count of an account's associated application delivery controller records. -Type: **unsigned long** +Type: **unsigned long** + @@ -3111,7 +3421,8 @@ A count of an account's associated application delivery controller records. [attributeCount]: #attributecount #### [attributeCount] A count of the account attribute values for a SoftLayer customer account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3121,7 +3432,8 @@ A count of the account attribute values for a SoftLayer customer account. [availablePublicNetworkVlanCount]: #availablepublicnetworkvlancount #### [availablePublicNetworkVlanCount] A count of the public network VLANs assigned to an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3131,7 +3443,8 @@ A count of the public network VLANs assigned to an account. [bandwidthAllotmentCount]: #bandwidthallotmentcount #### [bandwidthAllotmentCount] A count of the bandwidth allotments for an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3141,7 +3454,8 @@ A count of the bandwidth allotments for an account. [bandwidthAllotmentsOverAllocationCount]: #bandwidthallotmentsoverallocationcount #### [bandwidthAllotmentsOverAllocationCount] A count of the bandwidth allotments for an account currently over allocation. -Type: **unsigned long** +Type: **unsigned long** + @@ -3151,7 +3465,8 @@ A count of the bandwidth allotments for an account currently over allocation. [bandwidthAllotmentsProjectedOverAllocationCount]: #bandwidthallotmentsprojectedoverallocationcount #### [bandwidthAllotmentsProjectedOverAllocationCount] A count of the bandwidth allotments for an account projected to go over allocation. -Type: **unsigned long** +Type: **unsigned long** + @@ -3161,7 +3476,8 @@ A count of the bandwidth allotments for an account projected to go over allocati [bareMetalInstanceCount]: #baremetalinstancecount #### [bareMetalInstanceCount] A count of an account's associated bare metal server objects. -Type: **unsigned long** +Type: **unsigned long** + @@ -3171,7 +3487,8 @@ A count of an account's associated bare metal server objects. [billingAgreementCount]: #billingagreementcount #### [billingAgreementCount] A count of all billing agreements for an account -Type: **unsigned long** +Type: **unsigned long** + @@ -3181,7 +3498,8 @@ A count of all billing agreements for an account [blockDeviceTemplateGroupCount]: #blockdevicetemplategroupcount #### [blockDeviceTemplateGroupCount] A count of private template group objects (parent and children) and the shared template group objects (parent only) for an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3191,7 +3509,8 @@ A count of private template group objects (parent and children) and the shared t [cartCount]: #cartcount #### [cartCount] A count of an account's active carts. -Type: **unsigned long** +Type: **unsigned long** + @@ -3201,7 +3520,8 @@ A count of an account's active carts. [catalystEnrollmentCount]: #catalystenrollmentcount #### [catalystEnrollmentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -3211,7 +3531,8 @@ A count of [closedTicketCount]: #closedticketcount #### [closedTicketCount] A count of all closed tickets associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3221,7 +3542,8 @@ A count of all closed tickets associated with an account. [datacentersWithSubnetAllocationCount]: #datacenterswithsubnetallocationcount #### [datacentersWithSubnetAllocationCount] A count of datacenters which contain subnets that the account has access to route. -Type: **unsigned long** +Type: **unsigned long** + @@ -3231,7 +3553,8 @@ A count of datacenters which contain subnets that the account has access to rout [dedicatedHostCount]: #dedicatedhostcount #### [dedicatedHostCount] A count of an account's associated virtual dedicated host objects. -Type: **unsigned long** +Type: **unsigned long** + @@ -3241,7 +3564,8 @@ A count of an account's associated virtual dedicated host objects. [displaySupportRepresentativeAssignmentCount]: #displaysupportrepresentativeassignmentcount #### [displaySupportRepresentativeAssignmentCount] A count of the SoftLayer employees that an account is assigned to. -Type: **unsigned long** +Type: **unsigned long** + @@ -3251,7 +3575,8 @@ A count of the SoftLayer employees that an account is assigned to. [domainCount]: #domaincount #### [domainCount] A count of the DNS domains associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3261,7 +3586,8 @@ A count of the DNS domains associated with an account. [domainRegistrationCount]: #domainregistrationcount #### [domainRegistrationCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -3271,7 +3597,8 @@ A count of [domainsWithoutSecondaryDnsRecordCount]: #domainswithoutsecondarydnsrecordcount #### [domainsWithoutSecondaryDnsRecordCount] A count of the DNS domains associated with an account that were not created as a result of a secondary DNS zone transfer. -Type: **unsigned long** +Type: **unsigned long** + @@ -3281,7 +3608,8 @@ A count of the DNS domains associated with an account that were not created as a [evaultMasterUserCount]: #evaultmasterusercount #### [evaultMasterUserCount] A count of an account's master EVault user. This is only used when an account has EVault service. -Type: **unsigned long** +Type: **unsigned long** + @@ -3291,7 +3619,8 @@ A count of an account's master EVault user. This is only used when an account ha [evaultNetworkStorageCount]: #evaultnetworkstoragecount #### [evaultNetworkStorageCount] A count of an account's associated EVault storage volumes. -Type: **unsigned long** +Type: **unsigned long** + @@ -3301,7 +3630,8 @@ A count of an account's associated EVault storage volumes. [expiredSecurityCertificateCount]: #expiredsecuritycertificatecount #### [expiredSecurityCertificateCount] A count of stored security certificates that are expired (ie. SSL) -Type: **unsigned long** +Type: **unsigned long** + @@ -3311,7 +3641,8 @@ A count of stored security certificates that are expired (ie. SSL) [facilityLogCount]: #facilitylogcount #### [facilityLogCount] A count of logs of who entered a colocation area which is assigned to this account, or when a user under this account enters a datacenter. -Type: **unsigned long** +Type: **unsigned long** + @@ -3321,7 +3652,8 @@ A count of logs of who entered a colocation area which is assigned to this accou [flexibleCreditEnrollmentCount]: #flexiblecreditenrollmentcount #### [flexibleCreditEnrollmentCount] A count of all of the account's current and former Flexible Credit enrollments. -Type: **unsigned long** +Type: **unsigned long** + @@ -3331,7 +3663,8 @@ A count of all of the account's current and former Flexible Credit enrollments. [globalIpRecordCount]: #globaliprecordcount #### [globalIpRecordCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -3341,7 +3674,8 @@ A count of [globalIpv4RecordCount]: #globalipv4recordcount #### [globalIpv4RecordCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -3351,7 +3685,8 @@ A count of [globalIpv6RecordCount]: #globalipv6recordcount #### [globalIpv6RecordCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -3361,7 +3696,8 @@ A count of [globalLoadBalancerAccountCount]: #globalloadbalanceraccountcount #### [globalLoadBalancerAccountCount] A count of [Deprecated] The global load balancer accounts for a softlayer customer account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3371,7 +3707,8 @@ A count of [Deprecated] The global load balancer accounts for a softlayer custom [hardwareCount]: #hardwarecount #### [hardwareCount] A count of an account's associated hardware objects. -Type: **unsigned long** +Type: **unsigned long** + @@ -3381,7 +3718,8 @@ A count of an account's associated hardware objects. [hardwareOverBandwidthAllocationCount]: #hardwareoverbandwidthallocationcount #### [hardwareOverBandwidthAllocationCount] A count of an account's associated hardware objects currently over bandwidth allocation. -Type: **unsigned long** +Type: **unsigned long** + @@ -3391,7 +3729,8 @@ A count of an account's associated hardware objects currently over bandwidth all [hardwareProjectedOverBandwidthAllocationCount]: #hardwareprojectedoverbandwidthallocationcount #### [hardwareProjectedOverBandwidthAllocationCount] A count of an account's associated hardware objects projected to go over bandwidth allocation. -Type: **unsigned long** +Type: **unsigned long** + @@ -3401,7 +3740,8 @@ A count of an account's associated hardware objects projected to go over bandwid [hardwareWithCpanelCount]: #hardwarewithcpanelcount #### [hardwareWithCpanelCount] A count of all hardware associated with an account that has the cPanel web hosting control panel installed. -Type: **unsigned long** +Type: **unsigned long** + @@ -3411,7 +3751,8 @@ A count of all hardware associated with an account that has the cPanel web hosti [hardwareWithHelmCount]: #hardwarewithhelmcount #### [hardwareWithHelmCount] A count of all hardware associated with an account that has the Helm web hosting control panel installed. -Type: **unsigned long** +Type: **unsigned long** + @@ -3421,7 +3762,8 @@ A count of all hardware associated with an account that has the Helm web hosting [hardwareWithMcafeeAntivirusRedhatCount]: #hardwarewithmcafeeantivirusredhatcount #### [hardwareWithMcafeeAntivirusRedhatCount] A count of all hardware associated with an account that has McAfee Secure AntiVirus for Redhat software components. -Type: **unsigned long** +Type: **unsigned long** + @@ -3431,7 +3773,8 @@ A count of all hardware associated with an account that has McAfee Secure AntiVi [hardwareWithMcafeeAntivirusWindowCount]: #hardwarewithmcafeeantiviruswindowcount #### [hardwareWithMcafeeAntivirusWindowCount] A count of all hardware associated with an account that has McAfee Secure AntiVirus for Windows software components. -Type: **unsigned long** +Type: **unsigned long** + @@ -3441,7 +3784,8 @@ A count of all hardware associated with an account that has McAfee Secure AntiVi [hardwareWithMcafeeCount]: #hardwarewithmcafeecount #### [hardwareWithMcafeeCount] A count of all hardware associated with an account that has McAfee Secure software components. -Type: **unsigned long** +Type: **unsigned long** + @@ -3451,7 +3795,8 @@ A count of all hardware associated with an account that has McAfee Secure softwa [hardwareWithMcafeeIntrusionDetectionSystemCount]: #hardwarewithmcafeeintrusiondetectionsystemcount #### [hardwareWithMcafeeIntrusionDetectionSystemCount] A count of all hardware associated with an account that has McAfee Secure Intrusion Detection System software components. -Type: **unsigned long** +Type: **unsigned long** + @@ -3461,7 +3806,8 @@ A count of all hardware associated with an account that has McAfee Secure Intrus [hardwareWithPleskCount]: #hardwarewithpleskcount #### [hardwareWithPleskCount] A count of all hardware associated with an account that has the Plesk web hosting control panel installed. -Type: **unsigned long** +Type: **unsigned long** + @@ -3471,7 +3817,8 @@ A count of all hardware associated with an account that has the Plesk web hostin [hardwareWithQuantastorCount]: #hardwarewithquantastorcount #### [hardwareWithQuantastorCount] A count of all hardware associated with an account that has the QuantaStor storage system installed. -Type: **unsigned long** +Type: **unsigned long** + @@ -3481,7 +3828,8 @@ A count of all hardware associated with an account that has the QuantaStor stora [hardwareWithUrchinCount]: #hardwarewithurchincount #### [hardwareWithUrchinCount] A count of all hardware associated with an account that has the Urchin web traffic analytics package installed. -Type: **unsigned long** +Type: **unsigned long** + @@ -3491,7 +3839,8 @@ A count of all hardware associated with an account that has the Urchin web traff [hardwareWithWindowCount]: #hardwarewithwindowcount #### [hardwareWithWindowCount] A count of all hardware associated with an account that is running a version of the Microsoft Windows operating system. -Type: **unsigned long** +Type: **unsigned long** + @@ -3501,7 +3850,8 @@ A count of all hardware associated with an account that is running a version of [hourlyBareMetalInstanceCount]: #hourlybaremetalinstancecount #### [hourlyBareMetalInstanceCount] A count of an account's associated hourly bare metal server objects. -Type: **unsigned long** +Type: **unsigned long** + @@ -3511,7 +3861,8 @@ A count of an account's associated hourly bare metal server objects. [hourlyServiceBillingItemCount]: #hourlyservicebillingitemcount #### [hourlyServiceBillingItemCount] A count of hourly service billing items that will be on an account's next invoice. -Type: **unsigned long** +Type: **unsigned long** + @@ -3521,7 +3872,8 @@ A count of hourly service billing items that will be on an account's next invoic [hourlyVirtualGuestCount]: #hourlyvirtualguestcount #### [hourlyVirtualGuestCount] A count of an account's associated hourly virtual guest objects. -Type: **unsigned long** +Type: **unsigned long** + @@ -3531,7 +3883,8 @@ A count of an account's associated hourly virtual guest objects. [hubNetworkStorageCount]: #hubnetworkstoragecount #### [hubNetworkStorageCount] A count of an account's associated Virtual Storage volumes. -Type: **unsigned long** +Type: **unsigned long** + @@ -3541,7 +3894,8 @@ A count of an account's associated Virtual Storage volumes. [internalNoteCount]: #internalnotecount #### [internalNoteCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -3551,7 +3905,8 @@ A count of [invoiceCount]: #invoicecount #### [invoiceCount] A count of an account's associated billing invoices. -Type: **unsigned long** +Type: **unsigned long** + @@ -3561,7 +3916,8 @@ A count of an account's associated billing invoices. [ipAddressCount]: #ipaddresscount #### [ipAddressCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -3571,7 +3927,8 @@ A count of [iscsiNetworkStorageCount]: #iscsinetworkstoragecount #### [iscsiNetworkStorageCount] A count of an account's associated iSCSI storage volumes. -Type: **unsigned long** +Type: **unsigned long** + @@ -3581,7 +3938,8 @@ A count of an account's associated iSCSI storage volumes. [lastFiveClosedAbuseTicketCount]: #lastfiveclosedabuseticketcount #### [lastFiveClosedAbuseTicketCount] A count of the five most recently closed abuse tickets associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3591,7 +3949,8 @@ A count of the five most recently closed abuse tickets associated with an accoun [lastFiveClosedAccountingTicketCount]: #lastfiveclosedaccountingticketcount #### [lastFiveClosedAccountingTicketCount] A count of the five most recently closed accounting tickets associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3601,7 +3960,8 @@ A count of the five most recently closed accounting tickets associated with an a [lastFiveClosedOtherTicketCount]: #lastfiveclosedotherticketcount #### [lastFiveClosedOtherTicketCount] A count of the five most recently closed tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3611,7 +3971,8 @@ A count of the five most recently closed tickets that do not belong to the abuse [lastFiveClosedSalesTicketCount]: #lastfiveclosedsalesticketcount #### [lastFiveClosedSalesTicketCount] A count of the five most recently closed sales tickets associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3621,7 +3982,8 @@ A count of the five most recently closed sales tickets associated with an accoun [lastFiveClosedSupportTicketCount]: #lastfiveclosedsupportticketcount #### [lastFiveClosedSupportTicketCount] A count of the five most recently closed support tickets associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3631,7 +3993,8 @@ A count of the five most recently closed support tickets associated with an acco [lastFiveClosedTicketCount]: #lastfiveclosedticketcount #### [lastFiveClosedTicketCount] A count of the five most recently closed tickets associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3641,7 +4004,8 @@ A count of the five most recently closed tickets associated with an account. [legacyBandwidthAllotmentCount]: #legacybandwidthallotmentcount #### [legacyBandwidthAllotmentCount] A count of the legacy bandwidth allotments for an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3651,7 +4015,8 @@ A count of the legacy bandwidth allotments for an account. [loadBalancerCount]: #loadbalancercount #### [loadBalancerCount] A count of an account's associated load balancers. -Type: **unsigned long** +Type: **unsigned long** + @@ -3661,7 +4026,8 @@ A count of an account's associated load balancers. [lockboxNetworkStorageCount]: #lockboxnetworkstoragecount #### [lockboxNetworkStorageCount] A count of an account's associated Lockbox storage volumes. -Type: **unsigned long** +Type: **unsigned long** + @@ -3671,7 +4037,8 @@ A count of an account's associated Lockbox storage volumes. [manualPaymentsUnderReviewCount]: #manualpaymentsunderreviewcount #### [manualPaymentsUnderReviewCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -3681,7 +4048,8 @@ A count of [mediaDataTransferRequestCount]: #mediadatatransferrequestcount #### [mediaDataTransferRequestCount] A count of an account's media transfer service requests. -Type: **unsigned long** +Type: **unsigned long** + @@ -3691,7 +4059,8 @@ A count of an account's media transfer service requests. [monthlyBareMetalInstanceCount]: #monthlybaremetalinstancecount #### [monthlyBareMetalInstanceCount] A count of an account's associated monthly bare metal server objects. -Type: **unsigned long** +Type: **unsigned long** + @@ -3701,7 +4070,8 @@ A count of an account's associated monthly bare metal server objects. [monthlyVirtualGuestCount]: #monthlyvirtualguestcount #### [monthlyVirtualGuestCount] A count of an account's associated monthly virtual guest objects. -Type: **unsigned long** +Type: **unsigned long** + @@ -3711,7 +4081,8 @@ A count of an account's associated monthly virtual guest objects. [nasNetworkStorageCount]: #nasnetworkstoragecount #### [nasNetworkStorageCount] A count of an account's associated NAS storage volumes. -Type: **unsigned long** +Type: **unsigned long** + @@ -3721,7 +4092,8 @@ A count of an account's associated NAS storage volumes. [networkGatewayCount]: #networkgatewaycount #### [networkGatewayCount] A count of all network gateway devices on this account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3731,7 +4103,8 @@ A count of all network gateway devices on this account. [networkHardwareCount]: #networkhardwarecount #### [networkHardwareCount] A count of an account's associated network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -3741,7 +4114,8 @@ A count of an account's associated network hardware. [networkMessageDeliveryAccountCount]: #networkmessagedeliveryaccountcount #### [networkMessageDeliveryAccountCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -3751,7 +4125,8 @@ A count of [networkMonitorDownHardwareCount]: #networkmonitordownhardwarecount #### [networkMonitorDownHardwareCount] A count of hardware which is currently experiencing a service failure. -Type: **unsigned long** +Type: **unsigned long** + @@ -3761,7 +4136,8 @@ A count of hardware which is currently experiencing a service failure. [networkMonitorDownVirtualGuestCount]: #networkmonitordownvirtualguestcount #### [networkMonitorDownVirtualGuestCount] A count of virtual guest which is currently experiencing a service failure. -Type: **unsigned long** +Type: **unsigned long** + @@ -3771,7 +4147,8 @@ A count of virtual guest which is currently experiencing a service failure. [networkMonitorRecoveringHardwareCount]: #networkmonitorrecoveringhardwarecount #### [networkMonitorRecoveringHardwareCount] A count of hardware which is currently recovering from a service failure. -Type: **unsigned long** +Type: **unsigned long** + @@ -3781,7 +4158,8 @@ A count of hardware which is currently recovering from a service failure. [networkMonitorRecoveringVirtualGuestCount]: #networkmonitorrecoveringvirtualguestcount #### [networkMonitorRecoveringVirtualGuestCount] A count of virtual guest which is currently recovering from a service failure. -Type: **unsigned long** +Type: **unsigned long** + @@ -3791,7 +4169,8 @@ A count of virtual guest which is currently recovering from a service failure. [networkMonitorUpHardwareCount]: #networkmonitoruphardwarecount #### [networkMonitorUpHardwareCount] A count of hardware which is currently online. -Type: **unsigned long** +Type: **unsigned long** + @@ -3801,7 +4180,8 @@ A count of hardware which is currently online. [networkMonitorUpVirtualGuestCount]: #networkmonitorupvirtualguestcount #### [networkMonitorUpVirtualGuestCount] A count of virtual guest which is currently online. -Type: **unsigned long** +Type: **unsigned long** + @@ -3811,7 +4191,8 @@ A count of virtual guest which is currently online. [networkStorageCount]: #networkstoragecount #### [networkStorageCount] A count of an account's associated storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes. -Type: **unsigned long** +Type: **unsigned long** + @@ -3821,7 +4202,8 @@ A count of an account's associated storage volumes. This includes Lockbox, NAS, [networkStorageGroupCount]: #networkstoragegroupcount #### [networkStorageGroupCount] A count of an account's Network Storage groups. -Type: **unsigned long** +Type: **unsigned long** + @@ -3831,7 +4213,8 @@ A count of an account's Network Storage groups. [networkTunnelContextCount]: #networktunnelcontextcount #### [networkTunnelContextCount] A count of iPSec network tunnels for an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3841,7 +4224,8 @@ A count of iPSec network tunnels for an account. [networkVlanCount]: #networkvlancount #### [networkVlanCount] A count of all network VLANs assigned to an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3851,7 +4235,8 @@ A count of all network VLANs assigned to an account. [nextBillingPublicAllotmentHardwareBandwidthDetailCount]: #nextbillingpublicallotmenthardwarebandwidthdetailcount #### [nextBillingPublicAllotmentHardwareBandwidthDetailCount] A count of dEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED. The allotments for this account and their servers for the next billing cycle. The public inbound and outbound bandwidth is calculated for each server in addition to the daily average network traffic since the last billing date. -Type: **unsigned long** +Type: **unsigned long** + @@ -3861,7 +4246,8 @@ A count of dEPRECATED - This information can be pulled directly through tapping [nextInvoiceTopLevelBillingItemCount]: #nextinvoicetoplevelbillingitemcount #### [nextInvoiceTopLevelBillingItemCount] A count of the billing items that will be on an account's next invoice. -Type: **unsigned long** +Type: **unsigned long** + @@ -3871,7 +4257,8 @@ A count of the billing items that will be on an account's next invoice. [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -3881,7 +4268,8 @@ A count of [openAbuseTicketCount]: #openabuseticketcount #### [openAbuseTicketCount] A count of the open abuse tickets associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3891,7 +4279,8 @@ A count of the open abuse tickets associated with an account. [openAccountingTicketCount]: #openaccountingticketcount #### [openAccountingTicketCount] A count of the open accounting tickets associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3901,7 +4290,8 @@ A count of the open accounting tickets associated with an account. [openBillingTicketCount]: #openbillingticketcount #### [openBillingTicketCount] A count of the open billing tickets associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3911,7 +4301,8 @@ A count of the open billing tickets associated with an account. [openCancellationRequestCount]: #opencancellationrequestcount #### [openCancellationRequestCount] A count of an open ticket requesting cancellation of this server, if one exists. -Type: **unsigned long** +Type: **unsigned long** + @@ -3921,7 +4312,8 @@ A count of an open ticket requesting cancellation of this server, if one exists. [openOtherTicketCount]: #openotherticketcount #### [openOtherTicketCount] A count of the open tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3931,7 +4323,8 @@ A count of the open tickets that do not belong to the abuse, accounting, sales, [openRecurringInvoiceCount]: #openrecurringinvoicecount #### [openRecurringInvoiceCount] A count of an account's recurring invoices. -Type: **unsigned long** +Type: **unsigned long** + @@ -3941,7 +4334,8 @@ A count of an account's recurring invoices. [openSalesTicketCount]: #opensalesticketcount #### [openSalesTicketCount] A count of the open sales tickets associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3951,7 +4345,8 @@ A count of the open sales tickets associated with an account. [openStackAccountLinkCount]: #openstackaccountlinkcount #### [openStackAccountLinkCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -3961,7 +4356,8 @@ A count of [openStackObjectStorageCount]: #openstackobjectstoragecount #### [openStackObjectStorageCount] A count of an account's associated Openstack related Object Storage accounts. -Type: **unsigned long** +Type: **unsigned long** + @@ -3971,7 +4367,8 @@ A count of an account's associated Openstack related Object Storage accounts. [openSupportTicketCount]: #opensupportticketcount #### [openSupportTicketCount] A count of the open support tickets associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3981,7 +4378,8 @@ A count of the open support tickets associated with an account. [openTicketCount]: #openticketcount #### [openTicketCount] A count of all open tickets associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -3991,7 +4389,8 @@ A count of all open tickets associated with an account. [openTicketsWaitingOnCustomerCount]: #openticketswaitingoncustomercount #### [openTicketsWaitingOnCustomerCount] A count of all open tickets associated with an account last edited by an employee. -Type: **unsigned long** +Type: **unsigned long** + @@ -4001,7 +4400,8 @@ A count of all open tickets associated with an account last edited by an employe [orderCount]: #ordercount #### [orderCount] A count of an account's associated billing orders excluding upgrades. -Type: **unsigned long** +Type: **unsigned long** + @@ -4011,7 +4411,8 @@ A count of an account's associated billing orders excluding upgrades. [orphanBillingItemCount]: #orphanbillingitemcount #### [orphanBillingItemCount] A count of the billing items that have no parent billing item. These are items that don't necessarily belong to a single server. -Type: **unsigned long** +Type: **unsigned long** + @@ -4021,7 +4422,8 @@ A count of the billing items that have no parent billing item. These are items t [ownedBrandCount]: #ownedbrandcount #### [ownedBrandCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -4031,7 +4433,8 @@ A count of [ownedHardwareGenericComponentModelCount]: #ownedhardwaregenericcomponentmodelcount #### [ownedHardwareGenericComponentModelCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -4041,7 +4444,8 @@ A count of [paymentProcessorCount]: #paymentprocessorcount #### [paymentProcessorCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -4051,7 +4455,8 @@ A count of [pendingEventCount]: #pendingeventcount #### [pendingEventCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -4061,7 +4466,8 @@ A count of [pendingInvoiceTopLevelItemCount]: #pendinginvoicetoplevelitemcount #### [pendingInvoiceTopLevelItemCount] A count of a list of top-level invoice items that are on an account's currently pending invoice. -Type: **unsigned long** +Type: **unsigned long** + @@ -4071,7 +4477,8 @@ A count of a list of top-level invoice items that are on an account's currently [permissionGroupCount]: #permissiongroupcount #### [permissionGroupCount] A count of an account's permission groups. -Type: **unsigned long** +Type: **unsigned long** + @@ -4081,7 +4488,8 @@ A count of an account's permission groups. [permissionRoleCount]: #permissionrolecount #### [permissionRoleCount] A count of an account's user roles. -Type: **unsigned long** +Type: **unsigned long** + @@ -4091,7 +4499,8 @@ A count of an account's user roles. [placementGroupCount]: #placementgroupcount #### [placementGroupCount] A count of an account's associated virtual placement groups. -Type: **unsigned long** +Type: **unsigned long** + @@ -4101,7 +4510,8 @@ A count of an account's associated virtual placement groups. [portableStorageVolumeCount]: #portablestoragevolumecount #### [portableStorageVolumeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -4111,7 +4521,8 @@ A count of [postProvisioningHookCount]: #postprovisioninghookcount #### [postProvisioningHookCount] A count of customer specified URIs that are downloaded onto a newly provisioned or reloaded server. If the URI is sent over https it will be executed directly on the server. -Type: **unsigned long** +Type: **unsigned long** + @@ -4121,7 +4532,8 @@ A count of customer specified URIs that are downloaded onto a newly provisioned [pptpVpnUserCount]: #pptpvpnusercount #### [pptpVpnUserCount] A count of an account's associated portal users with PPTP VPN access. (Deprecated) -Type: **unsigned long** +Type: **unsigned long** + @@ -4131,7 +4543,8 @@ A count of an account's associated portal users with PPTP VPN access. (Deprecate [priceRestrictionCount]: #pricerestrictioncount #### [priceRestrictionCount] A count of the item price that an account is restricted to. -Type: **unsigned long** +Type: **unsigned long** + @@ -4141,7 +4554,8 @@ A count of the item price that an account is restricted to. [priorityOneTicketCount]: #priorityoneticketcount #### [priorityOneTicketCount] A count of all priority one tickets associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -4151,7 +4565,8 @@ A count of all priority one tickets associated with an account. [privateAllotmentHardwareBandwidthDetailCount]: #privateallotmenthardwarebandwidthdetailcount #### [privateAllotmentHardwareBandwidthDetailCount] A count of dEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED. The allotments for this account and their servers. The private inbound and outbound bandwidth is calculated for each server in addition to the daily average network traffic since the last billing date. -Type: **unsigned long** +Type: **unsigned long** + @@ -4161,7 +4576,8 @@ A count of dEPRECATED - This information can be pulled directly through tapping [privateBlockDeviceTemplateGroupCount]: #privateblockdevicetemplategroupcount #### [privateBlockDeviceTemplateGroupCount] A count of private and shared template group objects (parent only) for an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -4171,7 +4587,8 @@ A count of private and shared template group objects (parent only) for an accoun [privateIpAddressCount]: #privateipaddresscount #### [privateIpAddressCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -4181,7 +4598,8 @@ A count of [privateNetworkVlanCount]: #privatenetworkvlancount #### [privateNetworkVlanCount] A count of the private network VLANs assigned to an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -4191,7 +4609,8 @@ A count of the private network VLANs assigned to an account. [privateSubnetCount]: #privatesubnetcount #### [privateSubnetCount] A count of all private subnets associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -4201,7 +4620,8 @@ A count of all private subnets associated with an account. [publicAllotmentHardwareBandwidthDetailCount]: #publicallotmenthardwarebandwidthdetailcount #### [publicAllotmentHardwareBandwidthDetailCount] A count of dEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED. The allotments for this account and their servers. The public inbound and outbound bandwidth is calculated for each server in addition to the daily average network traffic since the last billing date. -Type: **unsigned long** +Type: **unsigned long** + @@ -4211,7 +4631,8 @@ A count of dEPRECATED - This information can be pulled directly through tapping [publicIpAddressCount]: #publicipaddresscount #### [publicIpAddressCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -4221,7 +4642,8 @@ A count of [publicNetworkVlanCount]: #publicnetworkvlancount #### [publicNetworkVlanCount] A count of the public network VLANs assigned to an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -4231,7 +4653,8 @@ A count of the public network VLANs assigned to an account. [publicSubnetCount]: #publicsubnetcount #### [publicSubnetCount] A count of all public network subnets associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -4241,7 +4664,8 @@ A count of all public network subnets associated with an account. [quoteCount]: #quotecount #### [quoteCount] A count of an account's quotes. -Type: **unsigned long** +Type: **unsigned long** + @@ -4251,7 +4675,8 @@ A count of an account's quotes. [recentEventCount]: #recenteventcount #### [recentEventCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -4261,7 +4686,8 @@ A count of [referredAccountCount]: #referredaccountcount #### [referredAccountCount] A count of if this is a account is a referral partner, the accounts this referral partner has referred -Type: **unsigned long** +Type: **unsigned long** + @@ -4271,7 +4697,8 @@ A count of if this is a account is a referral partner, the accounts this referra [regulatedWorkloadCount]: #regulatedworkloadcount #### [regulatedWorkloadCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -4281,7 +4708,8 @@ A count of [remoteManagementCommandRequestCount]: #remotemanagementcommandrequestcount #### [remoteManagementCommandRequestCount] A count of remote management command requests for an account -Type: **unsigned long** +Type: **unsigned long** + @@ -4291,7 +4719,8 @@ A count of remote management command requests for an account [replicationEventCount]: #replicationeventcount #### [replicationEventCount] A count of the Replication events for all Network Storage volumes on an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -4301,7 +4730,8 @@ A count of the Replication events for all Network Storage volumes on an account. [reservedCapacityAgreementCount]: #reservedcapacityagreementcount #### [reservedCapacityAgreementCount] A count of all reserved capacity agreements for an account -Type: **unsigned long** +Type: **unsigned long** + @@ -4311,7 +4741,8 @@ A count of all reserved capacity agreements for an account [reservedCapacityGroupCount]: #reservedcapacitygroupcount #### [reservedCapacityGroupCount] A count of the reserved capacity groups owned by this account. -Type: **unsigned long** +Type: **unsigned long** + @@ -4321,7 +4752,8 @@ A count of the reserved capacity groups owned by this account. [resourceGroupCount]: #resourcegroupcount #### [resourceGroupCount] A count of an account's associated top-level resource groups. -Type: **unsigned long** +Type: **unsigned long** + @@ -4331,7 +4763,8 @@ A count of an account's associated top-level resource groups. [routerCount]: #routercount #### [routerCount] A count of all Routers that an accounts VLANs reside on -Type: **unsigned long** +Type: **unsigned long** + @@ -4341,7 +4774,8 @@ A count of all Routers that an accounts VLANs reside on [rwhoisDataCount]: #rwhoisdatacount #### [rwhoisDataCount] A count of dEPRECATED -Type: **unsigned long** +Type: **unsigned long** + @@ -4351,7 +4785,8 @@ A count of dEPRECATED [scaleGroupCount]: #scalegroupcount #### [scaleGroupCount] A count of all scale groups on this account. -Type: **unsigned long** +Type: **unsigned long** + @@ -4361,7 +4796,8 @@ A count of all scale groups on this account. [secondaryDomainCount]: #secondarydomaincount #### [secondaryDomainCount] A count of the secondary DNS records for a SoftLayer customer account. -Type: **unsigned long** +Type: **unsigned long** + @@ -4371,7 +4807,8 @@ A count of the secondary DNS records for a SoftLayer customer account. [securityCertificateCount]: #securitycertificatecount #### [securityCertificateCount] A count of stored security certificates (ie. SSL) -Type: **unsigned long** +Type: **unsigned long** + @@ -4381,7 +4818,8 @@ A count of stored security certificates (ie. SSL) [securityGroupCount]: #securitygroupcount #### [securityGroupCount] A count of the security groups belonging to this account. -Type: **unsigned long** +Type: **unsigned long** + @@ -4391,7 +4829,8 @@ A count of the security groups belonging to this account. [securityScanRequestCount]: #securityscanrequestcount #### [securityScanRequestCount] A count of an account's vulnerability scan requests. -Type: **unsigned long** +Type: **unsigned long** + @@ -4401,7 +4840,8 @@ A count of an account's vulnerability scan requests. [serviceBillingItemCount]: #servicebillingitemcount #### [serviceBillingItemCount] A count of the service billing items that will be on an account's next invoice. -Type: **unsigned long** +Type: **unsigned long** + @@ -4411,7 +4851,8 @@ A count of the service billing items that will be on an account's next invoice. [shipmentCount]: #shipmentcount #### [shipmentCount] A count of shipments that belong to the customer's account. -Type: **unsigned long** +Type: **unsigned long** + @@ -4421,7 +4862,8 @@ A count of shipments that belong to the customer's account. [sshKeyCount]: #sshkeycount #### [sshKeyCount] A count of customer specified SSH keys that can be implemented onto a newly provisioned or reloaded server. -Type: **unsigned long** +Type: **unsigned long** + @@ -4431,7 +4873,8 @@ A count of customer specified SSH keys that can be implemented onto a newly prov [sslVpnUserCount]: #sslvpnusercount #### [sslVpnUserCount] A count of an account's associated portal users with SSL VPN access. -Type: **unsigned long** +Type: **unsigned long** + @@ -4441,7 +4884,8 @@ A count of an account's associated portal users with SSL VPN access. [standardPoolVirtualGuestCount]: #standardpoolvirtualguestcount #### [standardPoolVirtualGuestCount] A count of an account's virtual guest objects that are hosted on a user provisioned hypervisor. -Type: **unsigned long** +Type: **unsigned long** + @@ -4451,7 +4895,8 @@ A count of an account's virtual guest objects that are hosted on a user provisio [subnetCount]: #subnetcount #### [subnetCount] A count of all network subnets associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -4461,7 +4906,8 @@ A count of all network subnets associated with an account. [subnetRegistrationCount]: #subnetregistrationcount #### [subnetRegistrationCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -4471,7 +4917,8 @@ A count of [subnetRegistrationDetailCount]: #subnetregistrationdetailcount #### [subnetRegistrationDetailCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -4481,7 +4928,8 @@ A count of [supportRepresentativeCount]: #supportrepresentativecount #### [supportRepresentativeCount] A count of the SoftLayer employees that an account is assigned to. -Type: **unsigned long** +Type: **unsigned long** + @@ -4491,7 +4939,8 @@ A count of the SoftLayer employees that an account is assigned to. [supportSubscriptionCount]: #supportsubscriptioncount #### [supportSubscriptionCount] A count of the active support subscriptions for this account. -Type: **unsigned long** +Type: **unsigned long** + @@ -4501,7 +4950,8 @@ A count of the active support subscriptions for this account. [tagCount]: #tagcount #### [tagCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -4511,7 +4961,8 @@ A count of [ticketCount]: #ticketcount #### [ticketCount] A count of an account's associated tickets. -Type: **unsigned long** +Type: **unsigned long** + @@ -4521,7 +4972,8 @@ A count of an account's associated tickets. [ticketsClosedInTheLastThreeDaysCount]: #ticketsclosedinthelastthreedayscount #### [ticketsClosedInTheLastThreeDaysCount] A count of tickets closed within the last 72 hours or last 10 tickets, whichever is less, associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -4531,7 +4983,8 @@ A count of tickets closed within the last 72 hours or last 10 tickets, whichever [ticketsClosedTodayCount]: #ticketsclosedtodaycount #### [ticketsClosedTodayCount] A count of tickets closed today associated with an account. -Type: **unsigned long** +Type: **unsigned long** + @@ -4541,7 +4994,8 @@ A count of tickets closed today associated with an account. [transcodeAccountCount]: #transcodeaccountcount #### [transcodeAccountCount] A count of an account's associated Transcode account. -Type: **unsigned long** +Type: **unsigned long** + @@ -4551,7 +5005,8 @@ A count of an account's associated Transcode account. [upgradeRequestCount]: #upgraderequestcount #### [upgradeRequestCount] A count of an account's associated upgrade requests. -Type: **unsigned long** +Type: **unsigned long** + @@ -4561,7 +5016,8 @@ A count of an account's associated upgrade requests. [userCount]: #usercount #### [userCount] A count of an account's portal users. -Type: **unsigned long** +Type: **unsigned long** + @@ -4571,7 +5027,8 @@ A count of an account's portal users. [validSecurityCertificateCount]: #validsecuritycertificatecount #### [validSecurityCertificateCount] A count of stored security certificates that are not expired (ie. SSL) -Type: **unsigned long** +Type: **unsigned long** + @@ -4581,7 +5038,8 @@ A count of stored security certificates that are not expired (ie. SSL) [virtualDedicatedRackCount]: #virtualdedicatedrackcount #### [virtualDedicatedRackCount] A count of the bandwidth pooling for this account. -Type: **unsigned long** +Type: **unsigned long** + @@ -4591,7 +5049,8 @@ A count of the bandwidth pooling for this account. [virtualDiskImageCount]: #virtualdiskimagecount #### [virtualDiskImageCount] A count of an account's associated virtual server virtual disk images. -Type: **unsigned long** +Type: **unsigned long** + @@ -4601,7 +5060,8 @@ A count of an account's associated virtual server virtual disk images. [virtualGuestCount]: #virtualguestcount #### [virtualGuestCount] A count of an account's associated virtual guest objects. -Type: **unsigned long** +Type: **unsigned long** + @@ -4611,7 +5071,8 @@ A count of an account's associated virtual guest objects. [virtualGuestsOverBandwidthAllocationCount]: #virtualguestsoverbandwidthallocationcount #### [virtualGuestsOverBandwidthAllocationCount] A count of an account's associated virtual guest objects currently over bandwidth allocation. -Type: **unsigned long** +Type: **unsigned long** + @@ -4621,7 +5082,8 @@ A count of an account's associated virtual guest objects currently over bandwidt [virtualGuestsProjectedOverBandwidthAllocationCount]: #virtualguestsprojectedoverbandwidthallocationcount #### [virtualGuestsProjectedOverBandwidthAllocationCount] A count of an account's associated virtual guest objects currently over bandwidth allocation. -Type: **unsigned long** +Type: **unsigned long** + @@ -4631,7 +5093,8 @@ A count of an account's associated virtual guest objects currently over bandwidt [virtualGuestsWithCpanelCount]: #virtualguestswithcpanelcount #### [virtualGuestsWithCpanelCount] A count of all virtual guests associated with an account that has the cPanel web hosting control panel installed. -Type: **unsigned long** +Type: **unsigned long** + @@ -4641,7 +5104,8 @@ A count of all virtual guests associated with an account that has the cPanel web [virtualGuestsWithMcafeeAntivirusRedhatCount]: #virtualguestswithmcafeeantivirusredhatcount #### [virtualGuestsWithMcafeeAntivirusRedhatCount] A count of all virtual guests associated with an account that have McAfee Secure AntiVirus for Redhat software components. -Type: **unsigned long** +Type: **unsigned long** + @@ -4651,7 +5115,8 @@ A count of all virtual guests associated with an account that have McAfee Secure [virtualGuestsWithMcafeeAntivirusWindowCount]: #virtualguestswithmcafeeantiviruswindowcount #### [virtualGuestsWithMcafeeAntivirusWindowCount] A count of all virtual guests associated with an account that has McAfee Secure AntiVirus for Windows software components. -Type: **unsigned long** +Type: **unsigned long** + @@ -4661,7 +5126,8 @@ A count of all virtual guests associated with an account that has McAfee Secure [virtualGuestsWithMcafeeCount]: #virtualguestswithmcafeecount #### [virtualGuestsWithMcafeeCount] A count of all virtual guests associated with an account that have McAfee Secure software components. -Type: **unsigned long** +Type: **unsigned long** + @@ -4671,7 +5137,8 @@ A count of all virtual guests associated with an account that have McAfee Secure [virtualGuestsWithMcafeeIntrusionDetectionSystemCount]: #virtualguestswithmcafeeintrusiondetectionsystemcount #### [virtualGuestsWithMcafeeIntrusionDetectionSystemCount] A count of all virtual guests associated with an account that has McAfee Secure Intrusion Detection System software components. -Type: **unsigned long** +Type: **unsigned long** + @@ -4681,7 +5148,8 @@ A count of all virtual guests associated with an account that has McAfee Secure [virtualGuestsWithPleskCount]: #virtualguestswithpleskcount #### [virtualGuestsWithPleskCount] A count of all virtual guests associated with an account that has the Plesk web hosting control panel installed. -Type: **unsigned long** +Type: **unsigned long** + @@ -4691,7 +5159,8 @@ A count of all virtual guests associated with an account that has the Plesk web [virtualGuestsWithQuantastorCount]: #virtualguestswithquantastorcount #### [virtualGuestsWithQuantastorCount] A count of all virtual guests associated with an account that have the QuantaStor storage system installed. -Type: **unsigned long** +Type: **unsigned long** + @@ -4701,7 +5170,8 @@ A count of all virtual guests associated with an account that have the QuantaSto [virtualGuestsWithUrchinCount]: #virtualguestswithurchincount #### [virtualGuestsWithUrchinCount] A count of all virtual guests associated with an account that has the Urchin web traffic analytics package installed. -Type: **unsigned long** +Type: **unsigned long** + @@ -4711,7 +5181,8 @@ A count of all virtual guests associated with an account that has the Urchin web [virtualStorageArchiveRepositoryCount]: #virtualstoragearchiverepositorycount #### [virtualStorageArchiveRepositoryCount] A count of an account's associated virtual server archived storage repositories. -Type: **unsigned long** +Type: **unsigned long** + @@ -4721,7 +5192,8 @@ A count of an account's associated virtual server archived storage repositories. [virtualStoragePublicRepositoryCount]: #virtualstoragepublicrepositorycount #### [virtualStoragePublicRepositoryCount] A count of an account's associated virtual server public storage repositories. -Type: **unsigned long** +Type: **unsigned long** + @@ -4731,7 +5203,8 @@ A count of an account's associated virtual server public storage repositories. [vpcVirtualGuestCount]: #vpcvirtualguestcount #### [vpcVirtualGuestCount] A count of an account's associated VPC configured virtual guest objects. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Account_AbuseEmail/_index.md b/content/reference/datatypes/SoftLayer_Account_AbuseEmail/_index.md index adfe786edb..4f1645d203 100644 --- a/content/reference/datatypes/SoftLayer_Account_AbuseEmail/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_AbuseEmail/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -51,7 +53,8 @@ An unfortunate facet of the hosting business is the necessity of with legal and [email]: #email #### [email] A valid email address. -Type: **string** +Type: **string** + @@ -67,7 +70,8 @@ A valid email address. [account]: #account #### [account] The account associated with an abuse email address. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Address/_index.md b/content/reference/datatypes/SoftLayer_Account_Address/_index.md index e0fc997b76..27cac91579 100644 --- a/content/reference/datatypes/SoftLayer_Account_Address/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Address/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Account_Address data type contains information on an address associated with a SoftLayer account. @@ -45,7 +47,8 @@ The SoftLayer_Account_Address data type contains information on an address assoc [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The SoftLayer_Account_Address data type contains information on an address assoc [address1]: #address1 #### [address1] Line 1 of the address (normally the street address). -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Line 1 of the address (normally the street address). [address2]: #address2 #### [address2] Line 2 of the address. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Line 2 of the address. [city]: #city #### [city] The city of the address. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The city of the address. [contactName]: #contactname #### [contactName] The contact name (person, office) of the address. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The contact name (person, office) of the address. [country]: #country #### [country] The country of the address. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The country of the address. [description]: #description #### [description] The description of the address. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The description of the address. [id]: #id #### [id] The unique id of the address. -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ The unique id of the address. [isActive]: #isactive #### [isActive] Flag to show whether the address is active. -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ Flag to show whether the address is active. [locationId]: #locationid #### [locationId] The location id of the address. -Type: **integer** +Type: **integer** + @@ -145,7 +157,8 @@ The location id of the address. [postalCode]: #postalcode #### [postalCode] The postal (zip) code of the address. -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ The postal (zip) code of the address. [state]: #state #### [state] The state of the address. -Type: **string** +Type: **string** + @@ -171,7 +185,8 @@ The state of the address. [account]: #account #### [account] The account to which this address belongs. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -181,7 +196,8 @@ The account to which this address belongs. [createUser]: #createuser #### [createUser] The customer user who created this address. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -191,7 +207,8 @@ The customer user who created this address. [location]: #location #### [location] The location of this address. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -201,7 +218,8 @@ The location of this address. [modifyEmployee]: #modifyemployee #### [modifyEmployee] The employee who last modified this address. -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -211,7 +229,8 @@ The employee who last modified this address. [modifyUser]: #modifyuser #### [modifyUser] The customer user who last modified this address. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -221,7 +240,8 @@ The customer user who last modified this address. [type]: #type #### [type] An account address' type. -Type: **SoftLayer_Account_Address_Type ** +Type: **SoftLayer_Account_Address_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Address_Type/_index.md b/content/reference/datatypes/SoftLayer_Account_Address_Type/_index.md index f1ccc0ed14..e412e5a2ee 100644 --- a/content/reference/datatypes/SoftLayer_Account_Address_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Address_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] DEPRECATED -Type: **dateTime** +Type: **dateTime** +
@@ -55,7 +58,8 @@ DEPRECATED [id]: #id #### [id] -Type: **integer** +Type: **integer** +
@@ -65,7 +69,8 @@ DEPRECATED [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ DEPRECATED [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Account_Affiliation/_index.md b/content/reference/datatypes/SoftLayer_Account_Affiliation/_index.md index fe353bf207..898833fce3 100644 --- a/content/reference/datatypes/SoftLayer_Account_Affiliation/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Affiliation/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This service allows for a unique identifier to be associated to an existing customer account. @@ -45,7 +47,8 @@ This service allows for a unique identifier to be associated to an existing cust [accountId]: #accountid #### [accountId] A customer account's internal identifier. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ A customer account's internal identifier. [affiliateId]: #affiliateid #### [affiliateId] An affiliate identifier associated with the customer account. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ An affiliate identifier associated with the customer account. [createDate]: #createdate #### [createDate] The date an account affiliation was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date an account affiliation was created. [id]: #id #### [id] A customer affiliation internal identifier. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ A customer affiliation internal identifier. [modifyDate]: #modifydate #### [modifyDate] The date an account affiliation was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -101,7 +108,8 @@ The date an account affiliation was last modified. [account]: #account #### [account] The account that an affiliation belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Agreement/_index.md b/content/reference/datatypes/SoftLayer_Account_Agreement/_index.md index 6db89dfe55..cd1118ad75 100644 --- a/content/reference/datatypes/SoftLayer_Account_Agreement/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Agreement/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [agreementTypeId]: #agreementtypeid #### [agreementTypeId] The type of agreement identifier. -Type: **integer** +Type: **integer** +
@@ -55,7 +58,8 @@ The type of agreement identifier. [autoRenew]: #autorenew #### [autoRenew] -Type: **integer** +Type: **integer** +
@@ -65,7 +69,8 @@ The type of agreement identifier. [cancellationFee]: #cancellationfee #### [cancellationFee] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The type of agreement identifier. [createDate]: #createdate #### [createDate] The date an agreement was created. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The date an agreement was created. [durationMonths]: #durationmonths #### [durationMonths] The duration in months of an agreement. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The duration in months of an agreement. [endDate]: #enddate #### [endDate] The end date of an agreement. -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ The end date of an agreement. [id]: #id #### [id] An agreement's internal identifier. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ An agreement's internal identifier. [startDate]: #startdate #### [startDate] The effective start date of an agreement. -Type: **dateTime** +Type: **dateTime** + @@ -125,7 +135,8 @@ The effective start date of an agreement. [statusId]: #statusid #### [statusId] The status identifier for an agreement. -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ The status identifier for an agreement. [title]: #title #### [title] The title of an agreement. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ The title of an agreement. [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -161,7 +174,8 @@ The title of an agreement. [agreementType]: #agreementtype #### [agreementType] The type of agreement. -Type: **SoftLayer_Account_Agreement_Type ** +Type: **SoftLayer_Account_Agreement_Type ** + @@ -171,7 +185,8 @@ The type of agreement. [attachedBillingAgreementFiles]: #attachedbillingagreementfiles #### [attachedBillingAgreementFiles] The files attached to an agreement. -Type: **SoftLayer_Account_MasterServiceAgreement[] ** +Type: **SoftLayer_Account_MasterServiceAgreement[] ** + @@ -181,7 +196,8 @@ The files attached to an agreement. [billingItems]: #billingitems #### [billingItems] The billing items associated with an agreement. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -191,7 +207,8 @@ The billing items associated with an agreement. [status]: #status #### [status] The status of the agreement. -Type: **SoftLayer_Account_Agreement_Status ** +Type: **SoftLayer_Account_Agreement_Status ** + @@ -201,7 +218,8 @@ The status of the agreement. [topLevelBillingItems]: #toplevelbillingitems #### [topLevelBillingItems] The top level billing item associated with an agreement. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -213,7 +231,8 @@ The top level billing item associated with an agreement. [attachedBillingAgreementFileCount]: #attachedbillingagreementfilecount #### [attachedBillingAgreementFileCount] A count of the files attached to an agreement. -Type: **unsigned long** +Type: **unsigned long** + @@ -223,7 +242,8 @@ A count of the files attached to an agreement. [billingItemCount]: #billingitemcount #### [billingItemCount] A count of the billing items associated with an agreement. -Type: **unsigned long** +Type: **unsigned long** + @@ -233,7 +253,8 @@ A count of the billing items associated with an agreement. [topLevelBillingItemCount]: #toplevelbillingitemcount #### [topLevelBillingItemCount] A count of the top level billing item associated with an agreement. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Account_Agreement_Status/_index.md b/content/reference/datatypes/SoftLayer_Account_Agreement_Status/_index.md index 29eda97e02..656fe5ba67 100644 --- a/content/reference/datatypes/SoftLayer_Account_Agreement_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Agreement_Status/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [name]: #name #### [name] The name of the agreement status. -Type: **string** +Type: **string** +
diff --git a/content/reference/datatypes/SoftLayer_Account_Agreement_Type/_index.md b/content/reference/datatypes/SoftLayer_Account_Agreement_Type/_index.md index d91c8448d9..4ffc588719 100644 --- a/content/reference/datatypes/SoftLayer_Account_Agreement_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Agreement_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [name]: #name #### [name] The name of the agreement type. -Type: **string** +Type: **string** +
diff --git a/content/reference/datatypes/SoftLayer_Account_Attachment_Employee/_index.md b/content/reference/datatypes/SoftLayer_Account_Attachment_Employee/_index.md index a0c547b668..5dfc7ee797 100644 --- a/content/reference/datatypes/SoftLayer_Account_Attachment_Employee/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Attachment_Employee/_index.md @@ -18,6 +18,8 @@ classes:
## Description + + A SoftLayer_Account_Attachment_Employee models an assignment of a single [SoftLayer_User_Employee]({{}}) @@ -45,7 +47,8 @@ A SoftLayer_Account_Attachment_Employee models an assignment of a single [SoftLa [roleId]: #roleid #### [roleId] Role identifier. -Type: **integer** +Type: **integer** +
@@ -61,7 +64,8 @@ Role identifier. [account]: #account #### [account] A [SoftLayer_Account]({{}}). -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -71,7 +75,8 @@ A [SoftLayer_Account]({{}}). [employee]: #employee #### [employee] A [SoftLayer_User_Employee]({{}}). -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -81,7 +86,8 @@ A [SoftLayer_User_Employee]({{}}). -Type: **SoftLayer_Account_Attachment_Employee_Role ** +Type: **SoftLayer_Account_Attachment_Employee_Role ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Attachment_Employee_Role/_index.md b/content/reference/datatypes/SoftLayer_Account_Attachment_Employee_Role/_index.md index 9ede77edb0..a92c64d3e8 100644 --- a/content/reference/datatypes/SoftLayer_Account_Attachment_Employee_Role/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Attachment_Employee_Role/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [keyname]: #keyname #### [keyname] -Type: **string** +Type: **string** +
@@ -55,7 +58,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
diff --git a/content/reference/datatypes/SoftLayer_Account_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Account_Attribute/_index.md index 1c68c55236..0955ddda8a 100644 --- a/content/reference/datatypes/SoftLayer_Account_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Attribute/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -58,7 +60,8 @@ Many SoftLayer customer accounts have individual attributes assigned to them tha [accountAttributeTypeId]: #accountattributetypeid #### [accountAttributeTypeId] The internal identifier of the type of attribute that a SoftLayer customer account attribute belongs to. -Type: **integer** +Type: **integer** + @@ -68,7 +71,8 @@ The internal identifier of the type of attribute that a SoftLayer customer accou [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account that is assigned an account attribute. -Type: **integer** +Type: **integer** + @@ -78,7 +82,8 @@ The internal identifier of the SoftLayer customer account that is assigned an ac [id]: #id #### [id] A SoftLayer customer account attribute's internal identifier. -Type: **integer** +Type: **integer** + @@ -88,7 +93,8 @@ A SoftLayer customer account attribute's internal identifier. [value]: #value #### [value] A SoftLayer account attribute's value. -Type: **string** +Type: **string** + @@ -104,7 +110,8 @@ A SoftLayer account attribute's value. [account]: #account #### [account] The SoftLayer customer account that has an attribute. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -114,7 +121,8 @@ The SoftLayer customer account that has an attribute. [accountAttributeType]: #accountattributetype #### [accountAttributeType] The type of attribute assigned to a SoftLayer customer account. -Type: **SoftLayer_Account_Attribute_Type ** +Type: **SoftLayer_Account_Attribute_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Attribute_Type/_index.md b/content/reference/datatypes/SoftLayer_Account_Attribute_Type/_index.md index 8e01c6943f..e9d86f14d5 100644 --- a/content/reference/datatypes/SoftLayer_Account_Attribute_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Attribute_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Account_Attribute_Type models the type of attribute that can be assigned to a SoftLayer customer account. @@ -50,7 +52,8 @@ SoftLayer_Account_Attribute_Type models the type of attribute that can be assign [description]: #description #### [description] A brief description of a SoftLayer account attribute type. -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ A brief description of a SoftLayer account attribute type. [id]: #id #### [id] A SoftLayer account attribute type's internal identifier. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ A SoftLayer account attribute type's internal identifier. [keyName]: #keyname #### [keyName] A SoftLayer account attribute type's key name. This is typically a shorter version of an attribute type's name. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ A SoftLayer account attribute type's key name. This is typically a shorter versi [name]: #name #### [name] A SoftLayer account attribute type's name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Account_Authentication_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Account_Authentication_Attribute/_index.md index 58d8fff72b..fb9ac1b004 100644 --- a/content/reference/datatypes/SoftLayer_Account_Authentication_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Authentication_Attribute/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Account authentication has many different settings that can be set. This class allows the customer or employee to set these settigns. @@ -58,7 +60,8 @@ Account authentication has many different settings that can be set. This class a [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account that is assigned an account authenction attribute. -Type: **integer** +Type: **integer** + @@ -68,7 +71,8 @@ The internal identifier of the SoftLayer customer account that is assigned an ac [id]: #id #### [id] A SoftLayer account authenction attribute's internal identifier. -Type: **integer** +Type: **integer** + @@ -78,7 +82,8 @@ A SoftLayer account authenction attribute's internal identifier. [typeId]: #typeid #### [typeId] The internal identifier of the type of attribute that a SoftLayer account authenction attribute belongs to. -Type: **integer** +Type: **integer** + @@ -88,7 +93,8 @@ The internal identifier of the type of attribute that a SoftLayer account authen [value]: #value #### [value] A SoftLayer account authenction attribute's value. -Type: **string** +Type: **string** + @@ -104,7 +110,8 @@ A SoftLayer account authenction attribute's value. [account]: #account #### [account] The SoftLayer customer account. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -114,7 +121,8 @@ The SoftLayer customer account. [authenticationRecord]: #authenticationrecord #### [authenticationRecord] The SoftLayer account authentication that has an attribute. -Type: **SoftLayer_Account_Authentication_Saml ** +Type: **SoftLayer_Account_Authentication_Saml ** + @@ -124,7 +132,8 @@ The SoftLayer account authentication that has an attribute. [type]: #type #### [type] The type of attribute assigned to a SoftLayer account authentication. -Type: **SoftLayer_Account_Authentication_Attribute_Type ** +Type: **SoftLayer_Account_Authentication_Attribute_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Authentication_Attribute_Type/_index.md b/content/reference/datatypes/SoftLayer_Account_Authentication_Attribute_Type/_index.md index 21c3b98eb5..f12cf44d15 100644 --- a/content/reference/datatypes/SoftLayer_Account_Authentication_Attribute_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Authentication_Attribute_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Account_Authentication_Attribute_Type models the type of attribute that can be assigned to a SoftLayer customer account authentication. @@ -50,7 +52,8 @@ SoftLayer_Account_Authentication_Attribute_Type models the type of attribute tha [description]: #description #### [description] A brief description of a SoftLayer account authentication attribute type. -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ A brief description of a SoftLayer account authentication attribute type. [id]: #id #### [id] A SoftLayer account authentication attribute type's internal identifier. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ A SoftLayer account authentication attribute type's internal identifier. [keyName]: #keyname #### [keyName] A SoftLayer account authentication attribute type's key name. This is typically a shorter version of an attribute type's name. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ A SoftLayer account authentication attribute type's key name. This is typically [name]: #name #### [name] A SoftLayer account authentication attribute type's name. -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ A SoftLayer account authentication attribute type's name. [valueExample]: #valueexample #### [valueExample] An example of what you can put in as your value. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Account_Authentication_OpenIdConnect_Option/_index.md b/content/reference/datatypes/SoftLayer_Account_Authentication_OpenIdConnect_Option/_index.md index 5e3bb51f10..1aa6f3d20e 100644 --- a/content/reference/datatypes/SoftLayer_Account_Authentication_OpenIdConnect_Option/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Authentication_OpenIdConnect_Option/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [key]: #key #### [key] -Type: **string** +Type: **string** +
@@ -55,7 +58,8 @@ classes: [value]: #value #### [value] -Type: **string** +Type: **string** +
diff --git a/content/reference/datatypes/SoftLayer_Account_Authentication_OpenIdConnect_RegistrationInformation/_index.md b/content/reference/datatypes/SoftLayer_Account_Authentication_OpenIdConnect_RegistrationInformation/_index.md index f2ef04c921..6b22d59eef 100644 --- a/content/reference/datatypes/SoftLayer_Account_Authentication_OpenIdConnect_RegistrationInformation/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Authentication_OpenIdConnect_RegistrationInformation/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [existingBlueIdFlag]: #existingblueidflag #### [existingBlueIdFlag] -Type: **boolean** +Type: **boolean** +
@@ -55,7 +58,8 @@ classes: [federatedEmailDomainFlag]: #federatedemaildomainflag #### [federatedEmailDomainFlag] -Type: **boolean** +Type: **boolean** +
@@ -65,7 +69,8 @@ classes: [user]: #user #### [user] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Authentication_Saml/_index.md b/content/reference/datatypes/SoftLayer_Account_Authentication_Saml/_index.md index e8af4f7eb1..0dd135ffad 100644 --- a/content/reference/datatypes/SoftLayer_Account_Authentication_Saml/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Authentication_Saml/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The saml account id. -Type: **string** +Type: **string** +
@@ -55,7 +58,8 @@ The saml account id. [certificate]: #certificate #### [certificate] The identity provider x509 certificate. -Type: **string** +Type: **string** +
@@ -65,7 +69,8 @@ The identity provider x509 certificate. [certificateFingerprint]: #certificatefingerprint #### [certificateFingerprint] The identity provider x509 certificate fingerprint. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The identity provider x509 certificate fingerprint. [entityId]: #entityid #### [entityId] The identity provider entity ID. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The identity provider entity ID. [id]: #id #### [id] The saml internal identifying number. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The saml internal identifying number. [serviceProviderCertificate]: #serviceprovidercertificate #### [serviceProviderCertificate] The service provider x509 certificate. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The service provider x509 certificate. [serviceProviderEntityId]: #serviceproviderentityid #### [serviceProviderEntityId] The service provider entity IDs. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The service provider entity IDs. [serviceProviderPublicKey]: #serviceproviderpublickey #### [serviceProviderPublicKey] The service provider public key. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The service provider public key. [serviceProviderSingleLogoutEncoding]: #serviceprovidersinglelogoutencoding #### [serviceProviderSingleLogoutEncoding] The service provider signle logout encoding. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The service provider signle logout encoding. [serviceProviderSingleLogoutUrl]: #serviceprovidersinglelogouturl #### [serviceProviderSingleLogoutUrl] The service provider signle logout address. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The service provider signle logout address. [serviceProviderSingleSignOnEncoding]: #serviceprovidersinglesignonencoding #### [serviceProviderSingleSignOnEncoding] The service provider signle sign on encoding. -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ The service provider signle sign on encoding. [serviceProviderSingleSignOnUrl]: #serviceprovidersinglesignonurl #### [serviceProviderSingleSignOnUrl] The service provider signle sign on address. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ The service provider signle sign on address. [singleLogoutEncoding]: #singlelogoutencoding #### [singleLogoutEncoding] The identity provider single logout encoding. -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ The identity provider single logout encoding. [singleLogoutUrl]: #singlelogouturl #### [singleLogoutUrl] The identity provider sigle logout address. -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ The identity provider sigle logout address. [singleSignOnEncoding]: #singlesignonencoding #### [singleSignOnEncoding] The identity provider single sign on encoding. -Type: **string** +Type: **string** + @@ -195,7 +212,8 @@ The identity provider single sign on encoding. [singleSignOnUrl]: #singlesignonurl #### [singleSignOnUrl] The identity provider signle sign on address. -Type: **string** +Type: **string** + @@ -211,7 +229,8 @@ The identity provider signle sign on address. [account]: #account #### [account] The account associated with this saml configuration. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -221,7 +240,8 @@ The account associated with this saml configuration. [attributes]: #attributes #### [attributes] The saml attribute values for a SoftLayer customer account. -Type: **SoftLayer_Account_Authentication_Attribute[] ** +Type: **SoftLayer_Account_Authentication_Attribute[] ** + @@ -233,7 +253,8 @@ The saml attribute values for a SoftLayer customer account. [attributeCount]: #attributecount #### [attributeCount] A count of the saml attribute values for a SoftLayer customer account. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Account_Business_Partner/_index.md b/content/reference/datatypes/SoftLayer_Account_Business_Partner/_index.md index 32dbe4ca6c..c9f3b38d52 100644 --- a/content/reference/datatypes/SoftLayer_Account_Business_Partner/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Business_Partner/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Contains business partner details associated with an account. Country Enterprise Identifier (CEID), Channel ID, Segment ID and Reseller Level. @@ -45,7 +47,8 @@ Contains business partner details associated with an account. Country Enterprise [channelId]: #channelid #### [channelId] Account business partner channel identifier -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Account business partner channel identifier [countryEnterpriseCode]: #countryenterprisecode #### [countryEnterpriseCode] Account business partner country enterprise code -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Account business partner country enterprise code [resellerLevel]: #resellerlevel #### [resellerLevel] Reseller level of an account business partner -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ Reseller level of an account business partner [segmentId]: #segmentid #### [segmentId] Account business partner segment identifier -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ Account business partner segment identifier [account]: #account #### [account] Account associated with the business partner data -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -101,7 +108,8 @@ Account associated with the business partner data [channel]: #channel #### [channel] Channel indicator used to categorize business partner revenue. -Type: **SoftLayer_Business_Partner_Channel ** +Type: **SoftLayer_Business_Partner_Channel ** + @@ -111,7 +119,8 @@ Channel indicator used to categorize business partner revenue. [segment]: #segment #### [segment] Segment indicator used to categorize business partner revenue. -Type: **SoftLayer_Business_Partner_Segment ** +Type: **SoftLayer_Business_Partner_Segment ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Classification_Group_Type/_index.md b/content/reference/datatypes/SoftLayer_Account_Classification_Group_Type/_index.md index e3f98a8bbf..9fbe49e70f 100644 --- a/content/reference/datatypes/SoftLayer_Account_Classification_Group_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Classification_Group_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
diff --git a/content/reference/datatypes/SoftLayer_Account_Contact/_index.md b/content/reference/datatypes/SoftLayer_Account_Contact/_index.md index 1c890d21ee..3c0df76b8a 100644 --- a/content/reference/datatypes/SoftLayer_Account_Contact/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Contact/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** +
@@ -55,7 +58,8 @@ classes: [address1]: #address1 #### [address1] -Type: **string** +Type: **string** +
@@ -65,7 +69,8 @@ classes: [address2]: #address2 #### [address2] -Type: **string** +Type: **string** +
@@ -75,7 +80,8 @@ classes: [alternatePhone]: #alternatephone #### [alternatePhone] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [city]: #city #### [city] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [companyName]: #companyname #### [companyName] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ classes: [country]: #country #### [country] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -125,7 +135,8 @@ classes: [email]: #email #### [email] -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ classes: [faxPhone]: #faxphone #### [faxPhone] -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ classes: [firstName]: #firstname #### [firstName] -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -165,7 +179,8 @@ classes: [jobTitle]: #jobtitle #### [jobTitle] -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ classes: [lastName]: #lastname #### [lastName] -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ classes: [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -195,7 +212,8 @@ classes: [officePhone]: #officephone #### [officePhone] -Type: **string** +Type: **string** + @@ -205,7 +223,8 @@ classes: [postalCode]: #postalcode #### [postalCode] -Type: **string** +Type: **string** + @@ -215,7 +234,8 @@ classes: [profileName]: #profilename #### [profileName] -Type: **string** +Type: **string** + @@ -225,7 +245,8 @@ classes: [state]: #state #### [state] -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ classes: [typeId]: #typeid #### [typeId] -Type: **integer** +Type: **integer** + @@ -245,7 +267,8 @@ classes: [url]: #url #### [url] -Type: **string** +Type: **string** + @@ -261,7 +284,8 @@ classes: [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -271,7 +295,8 @@ classes: [type]: #type #### [type] -Type: **SoftLayer_Account_Contact_Type ** +Type: **SoftLayer_Account_Contact_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Contact_Type/_index.md b/content/reference/datatypes/SoftLayer_Account_Contact_Type/_index.md index 6e2288aea6..c025a9c38d 100644 --- a/content/reference/datatypes/SoftLayer_Account_Contact_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Contact_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
@@ -55,7 +58,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
@@ -65,7 +69,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Account_External_Setup/_index.md b/content/reference/datatypes/SoftLayer_Account_External_Setup/_index.md index 1ca946c794..70e445c2ec 100644 --- a/content/reference/datatypes/SoftLayer_Account_External_Setup/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_External_Setup/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The SoftLayer customer account the request belongs to. -Type: **integer** +Type: **integer** +
@@ -55,7 +58,8 @@ The SoftLayer customer account the request belongs to. [currencyId]: #currencyid #### [currencyId] The currency requested after the billing switch. -Type: **integer** +Type: **integer** +
@@ -65,7 +69,8 @@ The currency requested after the billing switch. [id]: #id #### [id] The unique identifier for this setup request. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The unique identifier for this setup request. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] The external system that will handle billing. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The external system that will handle billing. [statusCode]: #statuscode #### [statusCode] The status of the account setup request. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The status of the account setup request. [typeCode]: #typecode #### [typeCode] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The status of the account setup request. [verifyCardTransactionId]: #verifycardtransactionid #### [verifyCardTransactionId] The related credit card transaction record for card verification. -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ The related credit card transaction record for card verification. [verifyCardTransaction]: #verifycardtransaction #### [verifyCardTransaction] The transaction information related to verifying the customer credit card. -Type: **SoftLayer_Billing_Payment_Card_Transaction ** +Type: **SoftLayer_Billing_Payment_Card_Transaction ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Internal_Ibm/_index.md b/content/reference/datatypes/SoftLayer_Account_Internal_Ibm/_index.md index 43f8efaadc..762c8918eb 100644 --- a/content/reference/datatypes/SoftLayer_Account_Internal_Ibm/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Internal_Ibm/_index.md @@ -21,6 +21,8 @@ classes: + + ### associatedMethods * [SoftLayer_Account_Internal_Ibm::requestAccount](/reference/services/SoftLayer_Account_Internal_Ibm/requestAccount ) diff --git a/content/reference/datatypes/SoftLayer_Account_Link/_index.md b/content/reference/datatypes/SoftLayer_Account_Link/_index.md index 901991cf24..8e108036d3 100644 --- a/content/reference/datatypes/SoftLayer_Account_Link/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Link/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** +
@@ -55,7 +58,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
@@ -65,7 +69,8 @@ classes: [destinationAccountAlphanumericId]: #destinationaccountalphanumericid #### [destinationAccountAlphanumericId] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [destinationAccountId]: #destinationaccountid #### [destinationAccountId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [serviceProviderId]: #serviceproviderid #### [serviceProviderId] -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ classes: [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -121,7 +130,8 @@ classes: [serviceProvider]: #serviceprovider #### [serviceProvider] -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Link_Bluemix/_index.md b/content/reference/datatypes/SoftLayer_Account_Link_Bluemix/_index.md index 853bfc5c45..39db937ca8 100644 --- a/content/reference/datatypes/SoftLayer_Account_Link_Bluemix/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Link_Bluemix/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** +
@@ -55,7 +58,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
@@ -65,7 +69,8 @@ classes: [destinationAccountAlphanumericId]: #destinationaccountalphanumericid #### [destinationAccountAlphanumericId] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [destinationAccountId]: #destinationaccountid #### [destinationAccountId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [serviceProviderId]: #serviceproviderid #### [serviceProviderId] -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ classes: [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -121,7 +130,8 @@ classes: [serviceProvider]: #serviceprovider #### [serviceProvider] -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Link_OpenStack/_index.md b/content/reference/datatypes/SoftLayer_Account_Link_OpenStack/_index.md index e041167f78..2eb36a8aad 100644 --- a/content/reference/datatypes/SoftLayer_Account_Link_OpenStack/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Link_OpenStack/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** +
@@ -55,7 +58,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
@@ -65,7 +69,8 @@ classes: [destinationAccountAlphanumericId]: #destinationaccountalphanumericid #### [destinationAccountAlphanumericId] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [destinationAccountId]: #destinationaccountid #### [destinationAccountId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [domainId]: #domainid #### [domainId] Pseudonym for destinationAccountAlphanumericId -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Pseudonym for destinationAccountAlphanumericId [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ Pseudonym for destinationAccountAlphanumericId [serviceProviderId]: #serviceproviderid #### [serviceProviderId] -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ Pseudonym for destinationAccountAlphanumericId [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -131,7 +141,8 @@ Pseudonym for destinationAccountAlphanumericId [serviceProvider]: #serviceprovider #### [serviceProvider] -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Link_OpenStack_DomainCreationDetails/_index.md b/content/reference/datatypes/SoftLayer_Account_Link_OpenStack_DomainCreationDetails/_index.md index 3940f2f8b4..e05d913322 100644 --- a/content/reference/datatypes/SoftLayer_Account_Link_OpenStack_DomainCreationDetails/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Link_OpenStack_DomainCreationDetails/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + OpenStack domain creation details @@ -45,7 +47,8 @@ OpenStack domain creation details [domainId]: #domainid #### [domainId] Id for the domain this user was added to. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Id for the domain this user was added to. [userId]: #userid #### [userId] Id for the user given the Cloud Admin role for this domain. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Id for the user given the Cloud Admin role for this domain. [userName]: #username #### [userName] Name for the user given the Cloud Admin role for this domain. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Account_Link_OpenStack_LinkRequest/_index.md b/content/reference/datatypes/SoftLayer_Account_Link_OpenStack_LinkRequest/_index.md index b37bec8293..1e4d197a3a 100644 --- a/content/reference/datatypes/SoftLayer_Account_Link_OpenStack_LinkRequest/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Link_OpenStack_LinkRequest/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Details required for OpenStack link request @@ -45,7 +47,8 @@ Details required for OpenStack link request [desiredPassword]: #desiredpassword #### [desiredPassword] Optional password -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Optional password [desiredProjectName]: #desiredprojectname #### [desiredProjectName] Optional projectName -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Optional projectName [desiredUsername]: #desiredusername #### [desiredUsername] Required username -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Account_Link_OpenStack_ProjectCreationDetails/_index.md b/content/reference/datatypes/SoftLayer_Account_Link_OpenStack_ProjectCreationDetails/_index.md index 4bd8c6cc1e..c2edbebbb9 100644 --- a/content/reference/datatypes/SoftLayer_Account_Link_OpenStack_ProjectCreationDetails/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Link_OpenStack_ProjectCreationDetails/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + OpenStack project creation details @@ -45,7 +47,8 @@ OpenStack project creation details [domainId]: #domainid #### [domainId] Id for the domain this project was added to. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Id for the domain this project was added to. [projectId]: #projectid #### [projectId] Id for this project. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Id for this project. [projectName]: #projectname #### [projectName] Name for this project. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Name for this project. [userId]: #userid #### [userId] Id for the user given the Project Admin role for this project. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ Id for the user given the Project Admin role for this project. [userName]: #username #### [userName] Name for the user given the Project Admin role for this project. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Account_Link_OpenStack_ProjectDetails/_index.md b/content/reference/datatypes/SoftLayer_Account_Link_OpenStack_ProjectDetails/_index.md index 245ff4ae6a..819f07f9bf 100644 --- a/content/reference/datatypes/SoftLayer_Account_Link_OpenStack_ProjectDetails/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Link_OpenStack_ProjectDetails/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + OpenStack project details @@ -45,7 +47,8 @@ OpenStack project details [projectId]: #projectid #### [projectId] Id for this project. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Id for this project. [projectName]: #projectname #### [projectName] Name for this project. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Account_Link_Vendor/_index.md b/content/reference/datatypes/SoftLayer_Account_Link_Vendor/_index.md index 8da9d61600..e7d438ad2b 100644 --- a/content/reference/datatypes/SoftLayer_Account_Link_Vendor/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Link_Vendor/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
@@ -55,7 +58,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
diff --git a/content/reference/datatypes/SoftLayer_Account_Lockdown_Request/_index.md b/content/reference/datatypes/SoftLayer_Account_Lockdown_Request/_index.md index 3801534742..055d9f65fb 100644 --- a/content/reference/datatypes/SoftLayer_Account_Lockdown_Request/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Lockdown_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Account_Lockdown_Request data type holds information on API requests from brand customers. @@ -45,7 +47,8 @@ The SoftLayer_Account_Lockdown_Request data type holds information on API reques [accountId]: #accountid #### [accountId] Account ID associated with this lockdown request. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Account ID associated with this lockdown request. [action]: #action #### [action] Type of request. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Type of request. [createDate]: #createdate #### [createDate] Timestamp when the lockdown request was initially made. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ Timestamp when the lockdown request was initially made. [id]: #id #### [id] ID of this lockdown request. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ ID of this lockdown request. [modifyDate]: #modifydate #### [modifyDate] Timestamp when the lockdown request was modified. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ Timestamp when the lockdown request was modified. [status]: #status #### [status] Status of the lockdown request denoting whether it's been completed. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Account_MasterServiceAgreement/_index.md b/content/reference/datatypes/SoftLayer_Account_MasterServiceAgreement/_index.md index 766293fdf5..7204c95379 100644 --- a/content/reference/datatypes/SoftLayer_Account_MasterServiceAgreement/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_MasterServiceAgreement/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** +
@@ -55,7 +58,8 @@ classes: [guid]: #guid #### [guid] -Type: **string** +Type: **string** +
@@ -65,7 +69,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ classes: [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Media/_index.md b/content/reference/datatypes/SoftLayer_Account_Media/_index.md index 253151a9ec..0afa18bb4e 100644 --- a/content/reference/datatypes/SoftLayer_Account_Media/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Media/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Account_Media data type contains information on a single piece of media associated with a Data Transfer Service request. @@ -45,7 +47,8 @@ The SoftLayer_Account_Media data type contains information on a single piece of [description]: #description #### [description] The description of the media. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The description of the media. [id]: #id #### [id] The unique id of the media. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The unique id of the media. [requestId]: #requestid #### [requestId] The request id of the media. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The request id of the media. [serialNumber]: #serialnumber #### [serialNumber] The manufacturer's serial number of the media. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The manufacturer's serial number of the media. [typeId]: #typeid #### [typeId] The type id of the media. -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ The type id of the media. [account]: #account #### [account] The account to which the media belongs. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -111,7 +119,8 @@ The account to which the media belongs. [createUser]: #createuser #### [createUser] The customer user who created the media object. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -121,7 +130,8 @@ The customer user who created the media object. [datacenter]: #datacenter #### [datacenter] The datacenter where the media resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -131,7 +141,8 @@ The datacenter where the media resides. [modifyEmployee]: #modifyemployee #### [modifyEmployee] The employee who last modified the media. -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -141,7 +152,8 @@ The employee who last modified the media. [modifyUser]: #modifyuser #### [modifyUser] The customer user who last modified the media. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -151,7 +163,8 @@ The customer user who last modified the media. [request]: #request #### [request] The request to which the media belongs. -Type: **SoftLayer_Account_Media_Data_Transfer_Request ** +Type: **SoftLayer_Account_Media_Data_Transfer_Request ** + @@ -161,7 +174,8 @@ The request to which the media belongs. [type]: #type #### [type] The media's type. -Type: **SoftLayer_Account_Media_Type ** +Type: **SoftLayer_Account_Media_Type ** + @@ -171,7 +185,8 @@ The media's type. [volume]: #volume #### [volume] A guest's associated EVault network storage service account. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Media_Data_Transfer_Request/_index.md b/content/reference/datatypes/SoftLayer_Account_Media_Data_Transfer_Request/_index.md index e4c8ae52da..d61147adc9 100644 --- a/content/reference/datatypes/SoftLayer_Account_Media_Data_Transfer_Request/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Media_Data_Transfer_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Account_Media_Data_Transfer_Request data type contains information [accountId]: #accountid #### [accountId] The account id of the request. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The account id of the request. [createUserId]: #createuserid #### [createUserId] The create user id of the request. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The create user id of the request. [endDate]: #enddate #### [endDate] The end date of the request. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The end date of the request. [id]: #id #### [id] The unique id of the request. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The unique id of the request. [modifyUserId]: #modifyuserid #### [modifyUserId] The modify user id of the request. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The modify user id of the request. [startDate]: #startdate #### [startDate] The start date of the request. -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ The start date of the request. [statusId]: #statusid #### [statusId] The status id of the request. -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ The status id of the request. [account]: #account #### [account] The account to which the request belongs. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -131,7 +141,8 @@ The account to which the request belongs. [activeTickets]: #activetickets #### [activeTickets] The active tickets that are attached to the data transfer request. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -141,7 +152,8 @@ The active tickets that are attached to the data transfer request. [billingItem]: #billingitem #### [billingItem] The billing item for the original request. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -151,7 +163,8 @@ The billing item for the original request. [createUser]: #createuser #### [createUser] The customer user who created the request. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -161,7 +174,8 @@ The customer user who created the request. [media]: #media #### [media] The media of the request. -Type: **SoftLayer_Account_Media ** +Type: **SoftLayer_Account_Media ** + @@ -171,7 +185,8 @@ The media of the request. [modifyEmployee]: #modifyemployee #### [modifyEmployee] The employee who last modified the request. -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -181,7 +196,8 @@ The employee who last modified the request. [modifyUser]: #modifyuser #### [modifyUser] The customer user who last modified the request. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -191,7 +207,8 @@ The customer user who last modified the request. [shipments]: #shipments #### [shipments] The shipments of the request. -Type: **SoftLayer_Account_Shipment[] ** +Type: **SoftLayer_Account_Shipment[] ** + @@ -201,7 +218,8 @@ The shipments of the request. [status]: #status #### [status] The status of the request. -Type: **SoftLayer_Account_Media_Data_Transfer_Request_Status ** +Type: **SoftLayer_Account_Media_Data_Transfer_Request_Status ** + @@ -211,7 +229,8 @@ The status of the request. [tickets]: #tickets #### [tickets] All tickets that are attached to the data transfer request. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -223,7 +242,8 @@ All tickets that are attached to the data transfer request. [activeTicketCount]: #activeticketcount #### [activeTicketCount] A count of the active tickets that are attached to the data transfer request. -Type: **unsigned long** +Type: **unsigned long** + @@ -233,7 +253,8 @@ A count of the active tickets that are attached to the data transfer request. [shipmentCount]: #shipmentcount #### [shipmentCount] A count of the shipments of the request. -Type: **unsigned long** +Type: **unsigned long** + @@ -243,7 +264,8 @@ A count of the shipments of the request. [ticketCount]: #ticketcount #### [ticketCount] A count of all tickets that are attached to the data transfer request. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Account_Media_Data_Transfer_Request_Status/_index.md b/content/reference/datatypes/SoftLayer_Account_Media_Data_Transfer_Request_Status/_index.md index 9c94fbb40a..b1e730b3f1 100644 --- a/content/reference/datatypes/SoftLayer_Account_Media_Data_Transfer_Request_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Media_Data_Transfer_Request_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Account_Media_Data_Transfer_Request_Status data type contains gene [description]: #description #### [description] The description of the request status. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The description of the request status. [id]: #id #### [id] The unique id of the request status. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The unique id of the request status. [keyName]: #keyname #### [keyName] The unique keyname of the request status. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The unique keyname of the request status. [name]: #name #### [name] The name of the request status. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Account_Media_Type/_index.md b/content/reference/datatypes/SoftLayer_Account_Media_Type/_index.md index 91555a29da..d5c197df61 100644 --- a/content/reference/datatypes/SoftLayer_Account_Media_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Media_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Account_Media_Type data type contains general information relating [description]: #description #### [description] The description of the media type. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The description of the media type. [id]: #id #### [id] The unique id of the media type. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The unique id of the media type. [keyName]: #keyname #### [keyName] The unique keyname of the media type. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The unique keyname of the media type. [name]: #name #### [name] The name of the media type. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Account_Network_Vlan_Span/_index.md b/content/reference/datatypes/SoftLayer_Account_Network_Vlan_Span/_index.md index 9dbbda3a86..ebea1faacf 100644 --- a/content/reference/datatypes/SoftLayer_Account_Network_Vlan_Span/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Network_Vlan_Span/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ The SoftLayer_Account_Network_Vlan_Span data type exposes the setting which cont [enabledFlag]: #enabledflag #### [enabledFlag] Flag indicating whether the customer wishes to have all private network VLANs associated with account automatically joined [0 or 1] -Type: **boolean** +Type: **boolean** + @@ -60,7 +63,8 @@ Flag indicating whether the customer wishes to have all private network VLANs as [id]: #id #### [id] The unique internal identifier of the SoftLayer_Account_Network_Vlan_Span object. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ The unique internal identifier of the SoftLayer_Account_Network_Vlan_Span object [lastAppliedDate]: #lastapplieddate #### [lastAppliedDate] Timestamp of the last time the ACL for this account was applied. -Type: **dateTime** +Type: **dateTime** + @@ -80,7 +85,8 @@ Timestamp of the last time the ACL for this account was applied. [lastVerifiedDate]: #lastverifieddate #### [lastVerifiedDate] Timestamp of the last time the subnet hash was verified for this VLAN span record. -Type: **dateTime** +Type: **dateTime** + @@ -90,7 +96,8 @@ Timestamp of the last time the subnet hash was verified for this VLAN span recor [modifyDate]: #modifydate #### [modifyDate] Timestamp of the last edit of the record. -Type: **dateTime** +Type: **dateTime** + @@ -106,7 +113,8 @@ Timestamp of the last edit of the record. [account]: #account #### [account] The SoftLayer customer account associated with a VLAN. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Note/_index.md b/content/reference/datatypes/SoftLayer_Account_Note/_index.md index c3cf587523..c2078aa04a 100644 --- a/content/reference/datatypes/SoftLayer_Account_Note/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Note/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** +
@@ -55,7 +58,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
@@ -65,7 +69,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ classes: [note]: #note #### [note] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [noteTypeId]: #notetypeid #### [noteTypeId] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [userId]: #userid #### [userId] -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ classes: [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -131,7 +141,8 @@ classes: [customer]: #customer #### [customer] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -141,7 +152,8 @@ classes: [noteHistory]: #notehistory #### [noteHistory] -Type: **SoftLayer_Account_Note_History[] ** +Type: **SoftLayer_Account_Note_History[] ** + @@ -153,7 +165,8 @@ classes: [noteHistoryCount]: #notehistorycount #### [noteHistoryCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Account_Note_History/_index.md b/content/reference/datatypes/SoftLayer_Account_Note_History/_index.md index 98c7467986..9a2172ff56 100644 --- a/content/reference/datatypes/SoftLayer_Account_Note_History/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Note_History/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [accountNoteId]: #accountnoteid #### [accountNoteId] -Type: **integer** +Type: **integer** +
@@ -55,7 +58,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
@@ -65,7 +69,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ classes: [note]: #note #### [note] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [userId]: #userid #### [userId] -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ classes: [accountNote]: #accountnote #### [accountNote] -Type: **SoftLayer_Account_Note ** +Type: **SoftLayer_Account_Note ** + @@ -121,7 +130,8 @@ classes: [customer]: #customer #### [customer] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Partner_Referral_Prospect/_index.md b/content/reference/datatypes/SoftLayer_Account_Partner_Referral_Prospect/_index.md index a67e071245..5d9c61f87e 100644 --- a/content/reference/datatypes/SoftLayer_Account_Partner_Referral_Prospect/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Partner_Referral_Prospect/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [companyName]: #companyname #### [companyName] -Type: **string** +Type: **string** +
@@ -55,7 +58,8 @@ classes: [emailAddress]: #emailaddress #### [emailAddress] -Type: **string** +Type: **string** +
@@ -65,7 +69,8 @@ classes: [firstName]: #firstname #### [firstName] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [lastName]: #lastname #### [lastName] -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ classes: [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -111,7 +119,8 @@ classes: [assignedEmployees]: #assignedemployees #### [assignedEmployees] -Type: **SoftLayer_User_Employee[] ** +Type: **SoftLayer_User_Employee[] ** + @@ -121,7 +130,8 @@ classes: [quotes]: #quotes #### [quotes] -Type: **SoftLayer_Billing_Order_Quote[] ** +Type: **SoftLayer_Billing_Order_Quote[] ** + @@ -131,7 +141,8 @@ classes: [type]: #type #### [type] -Type: **SoftLayer_User_Customer_Prospect_Type ** +Type: **SoftLayer_User_Customer_Prospect_Type ** + @@ -143,7 +154,8 @@ classes: [assignedEmployeeCount]: #assignedemployeecount #### [assignedEmployeeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -153,7 +165,8 @@ A count of [quoteCount]: #quotecount #### [quoteCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Account_Password/_index.md b/content/reference/datatypes/SoftLayer_Account_Password/_index.md index 596c05afb9..e3e944a050 100644 --- a/content/reference/datatypes/SoftLayer_Account_Password/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Password/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -55,7 +57,8 @@ The SoftLayer_Account_Password contains username, passwords and notes for servic [accountId]: #accountid #### [accountId] The SoftLayer customer account id that a username/password combination is associated with. -Type: **integer** +Type: **integer** + @@ -65,7 +68,8 @@ The SoftLayer customer account id that a username/password combination is associ [id]: #id #### [id] A username/password combination's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +79,8 @@ A username/password combination's internal identifier. [notes]: #notes #### [notes] A simple description of a username/password combination. These notes don't affect portal functionality. -Type: **string** +Type: **string** + @@ -85,7 +90,8 @@ A simple description of a username/password combination. These notes don't affec [password]: #password #### [password] The password portion of a username/password combination. -Type: **string** +Type: **string** + @@ -95,7 +101,8 @@ The password portion of a username/password combination. [typeId]: #typeid #### [typeId] An identifier relating to a username/password combinations's associated service. -Type: **integer** +Type: **integer** + @@ -105,7 +112,8 @@ An identifier relating to a username/password combinations's associated service. [username]: #username #### [username] The username portion of a username/password combination. -Type: **string** +Type: **string** + @@ -121,7 +129,8 @@ The username portion of a username/password combination. [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -131,7 +140,8 @@ The username portion of a username/password combination. [type]: #type #### [type] The service that an account/password combination is tied to. -Type: **SoftLayer_Account_Password_Type ** +Type: **SoftLayer_Account_Password_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Password_Type/_index.md b/content/reference/datatypes/SoftLayer_Account_Password_Type/_index.md index 0871416221..1ec1fff5ec 100644 --- a/content/reference/datatypes/SoftLayer_Account_Password_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Password_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ Every username and password combination associated with a SoftLayer customer acc [description]: #description #### [description] A description of the use for the account username/password combination. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Account_PersonalData_RemoveRequestReview/_index.md b/content/reference/datatypes/SoftLayer_Account_PersonalData_RemoveRequestReview/_index.md index 9dc115c4d1..4960511cfd 100644 --- a/content/reference/datatypes/SoftLayer_Account_PersonalData_RemoveRequestReview/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_PersonalData_RemoveRequestReview/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -51,7 +53,8 @@ classes: [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** +
@@ -61,7 +64,8 @@ classes: [approvedFlag]: #approvedflag #### [approvedFlag] -Type: **SoftLayer_Account_PersonalData_RemoveRequestReview ** +Type: **SoftLayer_Account_PersonalData_RemoveRequestReview ** +
diff --git a/content/reference/datatypes/SoftLayer_Account_ProofOfConcept/_index.md b/content/reference/datatypes/SoftLayer_Account_ProofOfConcept/_index.md index c68417aeb7..fd908ab667 100644 --- a/content/reference/datatypes/SoftLayer_Account_ProofOfConcept/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_ProofOfConcept/_index.md @@ -24,6 +24,8 @@ classes: + +
diff --git a/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Approver/_index.md b/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Approver/_index.md index d86e6b15d1..a70bccf340 100644 --- a/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Approver/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Approver/_index.md @@ -18,6 +18,8 @@ classes:
## Description + + This class represents a Proof of Concept account approver. @@ -45,7 +47,8 @@ This class represents a Proof of Concept account approver. [approvalOrder]: #approvalorder #### [approvalOrder] Approval slot of the approver. -Type: **integer** +Type: **integer** +
@@ -55,7 +58,8 @@ Approval slot of the approver. [bluepagesUid]: #bluepagesuid #### [bluepagesUid] Internal identifier. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Internal identifier. [email]: #email #### [email] Email of the approver. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Email of the approver. [firstName]: #firstname #### [firstName] First name of the approver. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ First name of the approver. [id]: #id #### [id] Internal identifier of a Proof of Concept account approver. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ Internal identifier of a Proof of Concept account approver. [lastName]: #lastname #### [lastName] Last name of the approver. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ Last name of the approver. [regionKeyName]: #regionkeyname #### [regionKeyName] SoftLayer_Account_ProofOfConcept_Approver_Region identifier of the approver. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ SoftLayer_Account_ProofOfConcept_Approver_Region identifier of the approver. [roleId]: #roleid #### [roleId] SoftLayer_Account_ProofOfConcept_Approver_Role identifier of the approver. -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ SoftLayer_Account_ProofOfConcept_Approver_Role identifier of the approver. [typeId]: #typeid #### [typeId] SoftLayer_Account_ProofOfConcept_Approver_Type identifier of the approver. -Type: **integer** +Type: **integer** + @@ -141,7 +152,8 @@ SoftLayer_Account_ProofOfConcept_Approver_Type identifier of the approver. [role]: #role #### [role] -Type: **SoftLayer_Account_ProofOfConcept_Approver_Role ** +Type: **SoftLayer_Account_ProofOfConcept_Approver_Role ** + @@ -151,7 +163,8 @@ SoftLayer_Account_ProofOfConcept_Approver_Type identifier of the approver. [type]: #type #### [type] -Type: **SoftLayer_Account_ProofOfConcept_Approver_Type ** +Type: **SoftLayer_Account_ProofOfConcept_Approver_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Approver_Role/_index.md b/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Approver_Role/_index.md index 44906951c5..7cbbb04a96 100644 --- a/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Approver_Role/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Approver_Role/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class represents a Proof of Concept account approver type. The current roles are Primary and Backup approvers. @@ -45,7 +47,8 @@ This class represents a Proof of Concept account approver type. The current role [description]: #description #### [description] Description of a Proof of Concept account approver role. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Description of a Proof of Concept account approver role. [id]: #id #### [id] Internal identifier of a Proof of Concept account approver role. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Internal identifier of a Proof of Concept account approver role. [keyName]: #keyname #### [keyName] Key name of a Proof of Concept account approver role. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Key name of a Proof of Concept account approver role. [name]: #name #### [name] Name of a Proof of Concept account approver role. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Approver_Type/_index.md b/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Approver_Type/_index.md index 76e7676ea4..156b8b52c9 100644 --- a/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Approver_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Approver_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class represents a Proof of Concept account approver type. @@ -45,7 +47,8 @@ This class represents a Proof of Concept account approver type. [description]: #description #### [description] Description for a Proof of Concept account approver type. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Description for a Proof of Concept account approver type. [id]: #id #### [id] Internal identifier of a Proof of Concept account approver type. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Internal identifier of a Proof of Concept account approver type. [keyName]: #keyname #### [keyName] Key name for a Proof of Concept account approver type. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Key name for a Proof of Concept account approver type. [name]: #name #### [name] Name of a Proof of Concept account approver type. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ Name of a Proof of Concept account approver type. [approvers]: #approvers #### [approvers] -Type: **SoftLayer_Account_ProofOfConcept_Approver[] ** +Type: **SoftLayer_Account_ProofOfConcept_Approver[] ** + @@ -103,7 +110,8 @@ Name of a Proof of Concept account approver type. [approverCount]: #approvercount #### [approverCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Campaign_Code/_index.md b/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Campaign_Code/_index.md index cee35c8bb0..d43e0cf00d 100644 --- a/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Campaign_Code/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Campaign_Code/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A [SoftLayer_Account_ProofOfConcept_Campaign_Code] provides a `code` and an optional `description`. @@ -51,7 +53,8 @@ A [SoftLayer_Account_ProofOfConcept_Campaign_Code] provides a `code` and an opti [code]: #code #### [code] -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ A [SoftLayer_Account_ProofOfConcept_Campaign_Code] provides a `code` and an opti [description]: #description #### [description] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Funding_Type/_index.md b/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Funding_Type/_index.md index cc525f41ec..91ba9ed5f1 100644 --- a/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Funding_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_ProofOfConcept_Funding_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
@@ -45,7 +47,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
@@ -61,7 +64,8 @@ classes: [approverTypes]: #approvertypes #### [approverTypes] -Type: **SoftLayer_Account_ProofOfConcept_Approver_Type[] ** +Type: **SoftLayer_Account_ProofOfConcept_Approver_Type[] ** +
@@ -71,7 +75,8 @@ classes: [approvers]: #approvers #### [approvers] -Type: **SoftLayer_Account_ProofOfConcept_Approver[] ** +Type: **SoftLayer_Account_ProofOfConcept_Approver[] ** + @@ -83,7 +88,8 @@ classes: [approverCount]: #approvercount #### [approverCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -93,7 +99,8 @@ A count of [approverTypeCount]: #approvertypecount #### [approverTypeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail/_index.md b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail/_index.md index d26e4d2f3a..0ed8346475 100644 --- a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail/_index.md @@ -28,6 +28,8 @@ classes: + +
@@ -49,7 +51,8 @@ classes: [accountId]: #accountid #### [accountId] The detail object's associated [SoftLayer_Account]({{}}) id -Type: **integer** +Type: **integer** +
@@ -59,7 +62,8 @@ The detail object's associated [SoftLayer_Account]({{Type: **dateTime** +Type: **dateTime** +
@@ -69,7 +73,8 @@ The date and time the detail object was created [detailTypeId]: #detailtypeid #### [detailTypeId] The detail object's associated [SoftLayer_Account_Regional_Registry_Detail_Type]({{}}) id -Type: **integer** +Type: **integer** + @@ -79,7 +84,8 @@ The detail object's associated [SoftLayer_Account_Regional_Registry_Detail_Type] [id]: #id #### [id] Unique ID of the detail object -Type: **integer** +Type: **integer** + @@ -89,7 +95,8 @@ Unique ID of the detail object [modifyDate]: #modifydate #### [modifyDate] The date and time the detail object was last modified -Type: **dateTime** +Type: **dateTime** + @@ -99,7 +106,8 @@ The date and time the detail object was last modified [regionalInternetRegistryHandleId]: #regionalinternetregistryhandleid #### [regionalInternetRegistryHandleId] The detail object's associated [SoftLayer_Account_Rwhois_Handle]({{}}) id -Type: **integer** +Type: **integer** + @@ -115,7 +123,8 @@ The detail object's associated [SoftLayer_Account_Rwhois_Handle]({{Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -125,7 +134,8 @@ The account that this detail object belongs to. [detailType]: #detailtype #### [detailType] The associated type of this detail object. -Type: **SoftLayer_Account_Regional_Registry_Detail_Type ** +Type: **SoftLayer_Account_Regional_Registry_Detail_Type ** + @@ -135,7 +145,8 @@ The associated type of this detail object. [details]: #details #### [details] References to the [SoftLayer_Network_Subnet_Registration]({{}}) that consume this detail object. -Type: **SoftLayer_Network_Subnet_Registration_Details[] ** +Type: **SoftLayer_Network_Subnet_Registration_Details[] ** + @@ -145,7 +156,8 @@ References to the [SoftLayer_Network_Subnet_Registration]({{Type: **SoftLayer_Account_Regional_Registry_Detail_Property[] ** +Type: **SoftLayer_Account_Regional_Registry_Detail_Property[] ** + @@ -155,7 +167,8 @@ The individual properties that define this detail object's values. [regionalInternetRegistryHandle]: #regionalinternetregistryhandle #### [regionalInternetRegistryHandle] The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary. -Type: **SoftLayer_Account_Rwhois_Handle ** +Type: **SoftLayer_Account_Rwhois_Handle ** + @@ -167,7 +180,8 @@ The associated RWhois handle of this detail object. Used only when detailed reas [detailCount]: #detailcount #### [detailCount] A count of references to the [SoftLayer_Network_Subnet_Registration]({{}}) that consume this detail object. -Type: **unsigned long** +Type: **unsigned long** + @@ -177,7 +191,8 @@ A count of references to the [SoftLayer_Network_Subnet_Registration]({{Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property/_index.md b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property/_index.md index 4d2114100f..baf09c02fa 100644 --- a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Subnet registration properties are used to define various attributes of the [SoftLayer_Account_Regional_Registry_Detail]({{}}) objects, which describe the available value formats. @@ -45,7 +47,8 @@ Subnet registration properties are used to define various attributes of the [Sof [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ Subnet registration properties are used to define various attributes of the [Sof [id]: #id #### [id] Unique ID of the property object -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Unique ID of the property object [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ Unique ID of the property object [propertyTypeId]: #propertytypeid #### [propertyTypeId] The numeric ID of the related [SoftLayer_Account_Regional_Registry_Detail_Property_Type]({{}}) -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The numeric ID of the related [SoftLayer_Account_Regional_Registry_Detail_Proper [registrationDetailId]: #registrationdetailid #### [registrationDetailId] The numeric ID of the related [SoftLayer_Account_Regional_Registry_Detail]({{}}) -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The numeric ID of the related [SoftLayer_Account_Regional_Registry_Detail]({{Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ When multiple properties exist for a property type, defines the position in the [value]: #value #### [value] The value of the property -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The value of the property [detail]: #detail #### [detail] The [SoftLayer_Account_Regional_Registry_Detail]({{}}) object this property belongs to -Type: **SoftLayer_Account_Regional_Registry_Detail ** +Type: **SoftLayer_Account_Regional_Registry_Detail ** + @@ -131,7 +141,8 @@ The [SoftLayer_Account_Regional_Registry_Detail]({{}}) object this property belongs to -Type: **SoftLayer_Account_Regional_Registry_Detail_Property_Type ** +Type: **SoftLayer_Account_Regional_Registry_Detail_Property_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type/_index.md b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type/_index.md index 120b797c86..036fed3d87 100644 --- a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Subnet Registration Detail Property Type objects describe the nature of a [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. @@ -45,7 +47,8 @@ Subnet Registration Detail Property Type objects describe the nature of a [SoftL [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ Subnet Registration Detail Property Type objects describe the nature of a [SoftL [id]: #id #### [id] Unique numeric ID of the property type object -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Unique numeric ID of the property type object [keyName]: #keyname #### [keyName] Code-friendly string name of the property type -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Code-friendly string name of the property type [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ Code-friendly string name of the property type [name]: #name #### [name] Human-readable name of the property type -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Human-readable name of the property type [valueExpression]: #valueexpression #### [valueExpression] A Perl-compatible regular expression used to describe the valid format of the property -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Type/_index.md b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Type/_index.md index 3c60861232..03701fcf93 100644 --- a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Subnet Registration Detail Type objects describe the nature of a [SoftLayer_Account_Regional_Registry_Detail]({{}}) object. The standard values for these objects are as follows:
  • NETWORK - The detail object represents the information for a [SoftLayer_Network_Subnet]({{}})
  • PERSON - The detail object represents the information for a customer with the RIR
@@ -47,7 +49,8 @@ The standard values for these objects are as follows:
  • NETWORKType: **dateTime** +Type: **dateTime** + @@ -57,7 +60,8 @@ The standard values for these objects are as follows:
    • NETWORKType: **integer** +Type: **integer** + @@ -67,7 +71,8 @@ Unique numeric ID of the detail type object [keyName]: #keyname #### [keyName] Code-friendly string name of the detail type -Type: **string** +Type: **string** + @@ -77,7 +82,8 @@ Code-friendly string name of the detail type [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -87,7 +93,8 @@ Code-friendly string name of the detail type [name]: #name #### [name] Human-readable name of the detail type -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default/_index.md b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default/_index.md index 9098631a2d..6a33ca1d84 100644 --- a/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default data type [accountId]: #accountid #### [accountId] The detail object's associated [SoftLayer_Account]({{}}) id -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The detail object's associated [SoftLayer_Account]({{Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The date and time the detail object was created [detailTypeId]: #detailtypeid #### [detailTypeId] The detail object's associated [SoftLayer_Account_Regional_Registry_Detail_Type]({{}}) id -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The detail object's associated [SoftLayer_Account_Regional_Registry_Detail_Type] [id]: #id #### [id] Unique ID of the detail object -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Unique ID of the detail object [modifyDate]: #modifydate #### [modifyDate] The date and time the detail object was last modified -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date and time the detail object was last modified [regionalInternetRegistryHandleId]: #regionalinternetregistryhandleid #### [regionalInternetRegistryHandleId] The detail object's associated [SoftLayer_Account_Rwhois_Handle]({{}}) id -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The detail object's associated [SoftLayer_Account_Rwhois_Handle]({{Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -121,7 +130,8 @@ The account that this detail object belongs to. [detailType]: #detailtype #### [detailType] The associated type of this detail object. -Type: **SoftLayer_Account_Regional_Registry_Detail_Type ** +Type: **SoftLayer_Account_Regional_Registry_Detail_Type ** + @@ -131,7 +141,8 @@ The associated type of this detail object. [details]: #details #### [details] References to the [SoftLayer_Network_Subnet_Registration]({{}}) that consume this detail object. -Type: **SoftLayer_Network_Subnet_Registration_Details[] ** +Type: **SoftLayer_Network_Subnet_Registration_Details[] ** + @@ -141,7 +152,8 @@ References to the [SoftLayer_Network_Subnet_Registration]({{Type: **SoftLayer_Account_Regional_Registry_Detail_Property[] ** +Type: **SoftLayer_Account_Regional_Registry_Detail_Property[] ** + @@ -151,7 +163,8 @@ The individual properties that define this detail object's values. [regionalInternetRegistryHandle]: #regionalinternetregistryhandle #### [regionalInternetRegistryHandle] The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary. -Type: **SoftLayer_Account_Rwhois_Handle ** +Type: **SoftLayer_Account_Rwhois_Handle ** + @@ -163,7 +176,8 @@ The associated RWhois handle of this detail object. Used only when detailed reas [detailCount]: #detailcount #### [detailCount] A count of references to the [SoftLayer_Network_Subnet_Registration]({{}}) that consume this detail object. -Type: **unsigned long** +Type: **unsigned long** + @@ -173,7 +187,8 @@ A count of references to the [SoftLayer_Network_Subnet_Registration]({{Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Account_Reports_Request/_index.md b/content/reference/datatypes/SoftLayer_Account_Reports_Request/_index.md index d2fc7ba762..85875ff3a4 100644 --- a/content/reference/datatypes/SoftLayer_Account_Reports_Request/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Reports_Request/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountContactId]: #accountcontactid #### [accountContactId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [complianceReportTypeId]: #compliancereporttypeid #### [complianceReportTypeId] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ classes: [employeeRecordId]: #employeerecordid #### [employeeRecordId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ classes: [nda]: #nda #### [nda] -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ classes: [notes]: #notes #### [notes] -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ classes: [report]: #report #### [report] -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ classes: [requestKey]: #requestkey #### [requestKey] -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ classes: [requestorContactId]: #requestorcontactid #### [requestorContactId] -Type: **integer** +Type: **integer** + @@ -165,7 +179,8 @@ classes: [status]: #status #### [status] -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ classes: [ticketId]: #ticketid #### [ticketId] -Type: **integer** +Type: **integer** + @@ -185,7 +201,8 @@ classes: [usrRecordId]: #usrrecordid #### [usrRecordId] -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ classes: [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -211,7 +229,8 @@ classes: [accountContact]: #accountcontact #### [accountContact] A request's corresponding external contact, if one exists. -Type: **SoftLayer_Account_Contact ** +Type: **SoftLayer_Account_Contact ** + @@ -221,7 +240,8 @@ A request's corresponding external contact, if one exists. [reportType]: #reporttype #### [reportType] Type of the report customer is requesting for. -Type: **SoftLayer_Compliance_Report_Type ** +Type: **SoftLayer_Compliance_Report_Type ** + @@ -231,7 +251,8 @@ Type of the report customer is requesting for. [requestorContact]: #requestorcontact #### [requestorContact] A request's corresponding requestor contact, if one exists. -Type: **SoftLayer_Account_Contact ** +Type: **SoftLayer_Account_Contact ** + @@ -241,7 +262,8 @@ A request's corresponding requestor contact, if one exists. [ticket]: #ticket #### [ticket] -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -251,7 +273,8 @@ A request's corresponding requestor contact, if one exists. [user]: #user #### [user] The customer user that initiated a report request. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Rwhois_Handle/_index.md b/content/reference/datatypes/SoftLayer_Account_Rwhois_Handle/_index.md index 92941289cf..37add53a89 100644 --- a/content/reference/datatypes/SoftLayer_Account_Rwhois_Handle/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Rwhois_Handle/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Provides a means of tracking handle identifiers at the various regional internet registries (RIRs). These objects are used by the [SoftLayer_Network_Subnet_Registration]({{}}) objects to identify a customer or organization when a subnet is registered. @@ -45,7 +47,8 @@ Provides a means of tracking handle identifiers at the various regional internet [accountId]: #accountid #### [accountId] The handle object's associated [SoftLayer_Account]({{}}) id -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The handle object's associated [SoftLayer_Account]({{Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The handle object's associated [SoftLayer_Account]({{Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The handle object's unique identifier as assigned by the RIR. [id]: #id #### [id] Unique ID of the handle object -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Unique ID of the handle object [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -101,7 +108,8 @@ Unique ID of the handle object [account]: #account #### [account] The account that this handle belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Shipment/_index.md b/content/reference/datatypes/SoftLayer_Account_Shipment/_index.md index 3d7b308cfd..a85f008afa 100644 --- a/content/reference/datatypes/SoftLayer_Account_Shipment/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Shipment/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Account_Shipment data type contains information relating to a ship [accountId]: #accountid #### [accountId] The account id of the shipment. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The account id of the shipment. [courierId]: #courierid #### [courierId] The courier id of the shipment. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The courier id of the shipment. [courierName]: #couriername #### [courierName] The courier name of the shipment. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The courier name of the shipment. [createUserId]: #createuserid #### [createUserId] The create user id of the shipment. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The create user id of the shipment. [destinationAddressId]: #destinationaddressid #### [destinationAddressId] The destination address id of the shipment. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The destination address id of the shipment. [destinationDate]: #destinationdate #### [destinationDate] The destination date of the shipment. -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ The destination date of the shipment. [id]: #id #### [id] The unique id of the shipment. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ The unique id of the shipment. [modifyUserId]: #modifyuserid #### [modifyUserId] The modify user id of the shipment. -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ The modify user id of the shipment. [note]: #note #### [note] The shipment note (special handling instructions). -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The shipment note (special handling instructions). [originationAddressId]: #originationaddressid #### [originationAddressId] The origination address id of the shipment. -Type: **integer** +Type: **integer** + @@ -145,7 +157,8 @@ The origination address id of the shipment. [originationDate]: #originationdate #### [originationDate] The origination date of the shipment. -Type: **dateTime** +Type: **dateTime** + @@ -155,7 +168,8 @@ The origination date of the shipment. [statusId]: #statusid #### [statusId] The status id of the shipment. -Type: **integer** +Type: **integer** + @@ -165,7 +179,8 @@ The status id of the shipment. [typeId]: #typeid #### [typeId] The type id of the shipment. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The type id of the shipment. [viaAddressId]: #viaaddressid #### [viaAddressId] The via address id of the shipment. -Type: **integer** +Type: **integer** + @@ -191,7 +207,8 @@ The via address id of the shipment. [account]: #account #### [account] The account to which the shipment belongs. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -201,7 +218,8 @@ The account to which the shipment belongs. [courier]: #courier #### [courier] The courier handling the shipment. -Type: **SoftLayer_Auxiliary_Shipping_Courier ** +Type: **SoftLayer_Auxiliary_Shipping_Courier ** + @@ -211,7 +229,8 @@ The courier handling the shipment. [createEmployee]: #createemployee #### [createEmployee] The employee who created the shipment. -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -221,7 +240,8 @@ The employee who created the shipment. [createUser]: #createuser #### [createUser] The customer user who created the shipment. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -231,7 +251,8 @@ The customer user who created the shipment. [currency]: #currency #### [currency] -Type: **SoftLayer_Billing_Currency ** +Type: **SoftLayer_Billing_Currency ** + @@ -241,7 +262,8 @@ The customer user who created the shipment. [destinationAddress]: #destinationaddress #### [destinationAddress] The address at which the shipment is received. -Type: **SoftLayer_Account_Address ** +Type: **SoftLayer_Account_Address ** + @@ -251,7 +273,8 @@ The address at which the shipment is received. [masterTrackingData]: #mastertrackingdata #### [masterTrackingData] The one master tracking data for the shipment. -Type: **SoftLayer_Account_Shipment_Tracking_Data ** +Type: **SoftLayer_Account_Shipment_Tracking_Data ** + @@ -261,7 +284,8 @@ The one master tracking data for the shipment. [modifyEmployee]: #modifyemployee #### [modifyEmployee] The employee who last modified the shipment. -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -271,7 +295,8 @@ The employee who last modified the shipment. [modifyUser]: #modifyuser #### [modifyUser] The customer user who last modified the shipment. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -281,7 +306,8 @@ The customer user who last modified the shipment. [originationAddress]: #originationaddress #### [originationAddress] The address from which the shipment is sent. -Type: **SoftLayer_Account_Address ** +Type: **SoftLayer_Account_Address ** + @@ -291,7 +317,8 @@ The address from which the shipment is sent. [shipmentItems]: #shipmentitems #### [shipmentItems] The items in the shipment. -Type: **SoftLayer_Account_Shipment_Item[] ** +Type: **SoftLayer_Account_Shipment_Item[] ** + @@ -301,7 +328,8 @@ The items in the shipment. [status]: #status #### [status] The status of the shipment. -Type: **SoftLayer_Account_Shipment_Status ** +Type: **SoftLayer_Account_Shipment_Status ** + @@ -311,7 +339,8 @@ The status of the shipment. [trackingData]: #trackingdata #### [trackingData] All tracking data for the shipment and packages. -Type: **SoftLayer_Account_Shipment_Tracking_Data[] ** +Type: **SoftLayer_Account_Shipment_Tracking_Data[] ** + @@ -321,7 +350,8 @@ All tracking data for the shipment and packages. [type]: #type #### [type] The type of shipment (e.g. for Data Transfer Service or Colocation Service). -Type: **SoftLayer_Account_Shipment_Type ** +Type: **SoftLayer_Account_Shipment_Type ** + @@ -331,7 +361,8 @@ The type of shipment (e.g. for Data Transfer Service or Colocation Service). [viaAddress]: #viaaddress #### [viaAddress] The address at which the shipment is received. -Type: **SoftLayer_Account_Address ** +Type: **SoftLayer_Account_Address ** + @@ -343,7 +374,8 @@ The address at which the shipment is received. [shipmentItemCount]: #shipmentitemcount #### [shipmentItemCount] A count of the items in the shipment. -Type: **unsigned long** +Type: **unsigned long** + @@ -353,7 +385,8 @@ A count of the items in the shipment. [trackingDataCount]: #trackingdatacount #### [trackingDataCount] A count of all tracking data for the shipment and packages. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Account_Shipment_Item/_index.md b/content/reference/datatypes/SoftLayer_Account_Shipment_Item/_index.md index 61f4fae882..32cb13db94 100644 --- a/content/reference/datatypes/SoftLayer_Account_Shipment_Item/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Shipment_Item/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Account_Shipment_Item data type contains information relating to a [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The SoftLayer_Account_Shipment_Item data type contains information relating to a [description]: #description #### [description] The description of the shipping item. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The description of the shipping item. [id]: #id #### [id] The unique id of the shipping item. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The unique id of the shipping item. [packageId]: #packageid #### [packageId] The package id of the shipping item. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The package id of the shipping item. [shipmentId]: #shipmentid #### [shipmentId] The shipment id of the shipping item. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The shipment id of the shipping item. [shipmentItemId]: #shipmentitemid #### [shipmentItemId] The item id of the shipping item. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The item id of the shipping item. [shipmentItemTypeId]: #shipmentitemtypeid #### [shipmentItemTypeId] The item type id of the shipping item. -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ The item type id of the shipping item. [shipment]: #shipment #### [shipment] The shipment to which this item belongs. -Type: **SoftLayer_Account_Shipment ** +Type: **SoftLayer_Account_Shipment ** + @@ -131,7 +141,8 @@ The shipment to which this item belongs. [shipmentItemType]: #shipmentitemtype #### [shipmentItemType] The type of this shipment item. -Type: **SoftLayer_Account_Shipment_Item_Type ** +Type: **SoftLayer_Account_Shipment_Item_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Shipment_Item_Type/_index.md b/content/reference/datatypes/SoftLayer_Account_Shipment_Item_Type/_index.md index 44a823ad31..a437546c3a 100644 --- a/content/reference/datatypes/SoftLayer_Account_Shipment_Item_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Shipment_Item_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] DEPRECATED -Type: **dateTime** +Type: **dateTime** +
      @@ -55,7 +58,8 @@ DEPRECATED [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ DEPRECATED [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ DEPRECATED [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Account_Shipment_Resource_Type/_index.md b/content/reference/datatypes/SoftLayer_Account_Shipment_Resource_Type/_index.md index 7c86c5b510..c9ba2aadd8 100644 --- a/content/reference/datatypes/SoftLayer_Account_Shipment_Resource_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Shipment_Resource_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      diff --git a/content/reference/datatypes/SoftLayer_Account_Shipment_Status/_index.md b/content/reference/datatypes/SoftLayer_Account_Shipment_Status/_index.md index a284bcd886..963862ce63 100644 --- a/content/reference/datatypes/SoftLayer_Account_Shipment_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Shipment_Status/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] DEPRECATED -Type: **dateTime** +Type: **dateTime** +
      @@ -55,7 +58,8 @@ DEPRECATED [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ DEPRECATED [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
      @@ -75,7 +80,8 @@ DEPRECATED [name]: #name #### [name] -Type: **string** +Type: **string** +
      diff --git a/content/reference/datatypes/SoftLayer_Account_Shipment_Tracking_Data/_index.md b/content/reference/datatypes/SoftLayer_Account_Shipment_Tracking_Data/_index.md index f30722b6a8..abfb67c124 100644 --- a/content/reference/datatypes/SoftLayer_Account_Shipment_Tracking_Data/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Shipment_Tracking_Data/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Account_Shipment_Tracking_Data data type contains information on a [createUserId]: #createuserid #### [createUserId] The create user id of the tracking data. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The create user id of the tracking data. [id]: #id #### [id] The unique id of the tracking data. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The unique id of the tracking data. [modifyUserId]: #modifyuserid #### [modifyUserId] The user id of the tracking data. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The user id of the tracking data. [packageId]: #packageid #### [packageId] The package id of the tracking data. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The package id of the tracking data. [sequence]: #sequence #### [sequence] The sequence of the tracking data. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The sequence of the tracking data. [shipmentId]: #shipmentid #### [shipmentId] The shipment id of the tracking data. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The shipment id of the tracking data. [trackingData]: #trackingdata #### [trackingData] The tracking data (tracking number/reference number). -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The tracking data (tracking number/reference number). [createEmployee]: #createemployee #### [createEmployee] The employee who created the tracking datum. -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -131,7 +141,8 @@ The employee who created the tracking datum. [createUser]: #createuser #### [createUser] The customer user who created the tracking datum. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -141,7 +152,8 @@ The customer user who created the tracking datum. [modifyEmployee]: #modifyemployee #### [modifyEmployee] The employee who last modified the tracking datum. -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -151,7 +163,8 @@ The employee who last modified the tracking datum. [modifyUser]: #modifyuser #### [modifyUser] The customer user who last modified the tracking datum. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -161,7 +174,8 @@ The customer user who last modified the tracking datum. [shipment]: #shipment #### [shipment] The shipment of the tracking datum. -Type: **SoftLayer_Account_Shipment ** +Type: **SoftLayer_Account_Shipment ** + diff --git a/content/reference/datatypes/SoftLayer_Account_Shipment_Type/_index.md b/content/reference/datatypes/SoftLayer_Account_Shipment_Type/_index.md index a62adf9260..1e031552e3 100644 --- a/content/reference/datatypes/SoftLayer_Account_Shipment_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Shipment_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] DEPRECATED -Type: **dateTime** +Type: **dateTime** +
      @@ -55,7 +58,8 @@ DEPRECATED [description]: #description #### [description] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ DEPRECATED [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ DEPRECATED [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ DEPRECATED [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Account_Status/_index.md b/content/reference/datatypes/SoftLayer_Account_Status/_index.md index 4e8c424231..456ffaeaf9 100644 --- a/content/reference/datatypes/SoftLayer_Account_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Account_Status/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
      diff --git a/content/reference/datatypes/SoftLayer_Auxiliary_Marketing_Event/_index.md b/content/reference/datatypes/SoftLayer_Auxiliary_Marketing_Event/_index.md index 57067dcba8..4612d14ccd 100644 --- a/content/reference/datatypes/SoftLayer_Auxiliary_Marketing_Event/_index.md +++ b/content/reference/datatypes/SoftLayer_Auxiliary_Marketing_Event/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
      @@ -55,7 +58,8 @@ classes: [enabledFlag]: #enabledflag #### [enabledFlag] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [endDate]: #enddate #### [endDate] -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ classes: [location]: #location #### [location] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ classes: [startDate]: #startdate #### [startDate] -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ classes: [title]: #title #### [title] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [url]: #url #### [url] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Auxiliary_Notification_Emergency/_index.md b/content/reference/datatypes/SoftLayer_Auxiliary_Notification_Emergency/_index.md index 19f8a654a9..b0a9ea5bf4 100644 --- a/content/reference/datatypes/SoftLayer_Auxiliary_Notification_Emergency/_index.md +++ b/content/reference/datatypes/SoftLayer_Auxiliary_Notification_Emergency/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -58,7 +60,8 @@ A SoftLayer_Auxiliary_Notification_Emergency data object represents a notificati [createDate]: #createdate #### [createDate] The date this event was created. -Type: **dateTime** +Type: **dateTime** + @@ -68,7 +71,8 @@ The date this event was created. [device]: #device #### [device] The device (if any) effected by this event. -Type: **string** +Type: **string** + @@ -78,7 +82,8 @@ The device (if any) effected by this event. [duration]: #duration #### [duration] The duration of this event. -Type: **string** +Type: **string** + @@ -88,7 +93,8 @@ The duration of this event. [id]: #id #### [id] The device (if any) effected by this event. -Type: **integer** +Type: **integer** + @@ -98,7 +104,8 @@ The device (if any) effected by this event. [location]: #location #### [location] The location effected by this event. -Type: **string** +Type: **string** + @@ -108,7 +115,8 @@ The location effected by this event. [message]: #message #### [message] A message describing this event. -Type: **string** +Type: **string** + @@ -118,7 +126,8 @@ A message describing this event. [modifyDate]: #modifydate #### [modifyDate] The last date this event was modified. -Type: **dateTime** +Type: **dateTime** + @@ -128,7 +137,8 @@ The last date this event was modified. [servicesAffected]: #servicesaffected #### [servicesAffected] The service(s) (if any) effected by this event. -Type: **string** +Type: **string** + @@ -138,7 +148,8 @@ The service(s) (if any) effected by this event. [startDate]: #startdate #### [startDate] The date this event will start. -Type: **dateTime** +Type: **dateTime** + @@ -148,7 +159,8 @@ The date this event will start. [statusId]: #statusid #### [statusId] Current status record for this event. -Type: **integer** +Type: **integer** + @@ -164,7 +176,8 @@ Current status record for this event. [signature]: #signature #### [signature] The signature of the SoftLayer employee department associated with this notification. -Type: **SoftLayer_Auxiliary_Notification_Emergency_Signature ** +Type: **SoftLayer_Auxiliary_Notification_Emergency_Signature ** + @@ -174,7 +187,8 @@ The signature of the SoftLayer employee department associated with this notifica [status]: #status #### [status] The status of this notification. -Type: **SoftLayer_Auxiliary_Notification_Emergency_Status ** +Type: **SoftLayer_Auxiliary_Notification_Emergency_Status ** + diff --git a/content/reference/datatypes/SoftLayer_Auxiliary_Notification_Emergency_Signature/_index.md b/content/reference/datatypes/SoftLayer_Auxiliary_Notification_Emergency_Signature/_index.md index 76385512c7..38702eb985 100644 --- a/content/reference/datatypes/SoftLayer_Auxiliary_Notification_Emergency_Signature/_index.md +++ b/content/reference/datatypes/SoftLayer_Auxiliary_Notification_Emergency_Signature/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ Every SoftLayer_Auxiliary_Notification_Emergency has a signatureId that referenc [name]: #name #### [name] The name or signature for the current Emergency Notification. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Auxiliary_Notification_Emergency_Status/_index.md b/content/reference/datatypes/SoftLayer_Auxiliary_Notification_Emergency_Status/_index.md index 35b11b71e0..87fd50035c 100644 --- a/content/reference/datatypes/SoftLayer_Auxiliary_Notification_Emergency_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Auxiliary_Notification_Emergency_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ Every SoftLayer_Auxiliary_Notification_Emergency has a statusId that references [name]: #name #### [name] A name describing the status of the current Emergency Notification. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release/_index.md b/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release/_index.md index 6e9c4595c9..eef6e18456 100644 --- a/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release/_index.md +++ b/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release/_index.md @@ -21,6 +21,8 @@ classes: + + ### associatedMethods * [SoftLayer_Auxiliary_Press_Prelease::getObject](/reference/services/SoftLayer_Auxiliary_Press_Prelease/getObject ) @@ -64,7 +66,8 @@ classes: [id]: #id #### [id] A press release's internal identifier. -Type: **integer** +Type: **integer** + @@ -74,7 +77,8 @@ A press release's internal identifier. [publishDate]: #publishdate #### [publishDate] The data a press release was published. -Type: **dateTime** +Type: **dateTime** + @@ -84,7 +88,8 @@ The data a press release was published. [releaseLocation]: #releaselocation #### [releaseLocation] A press release's location. -Type: **string** +Type: **string** + @@ -94,7 +99,8 @@ A press release's location. [subTitle]: #subtitle #### [subTitle] A press release's sub-title. -Type: **string** +Type: **string** + @@ -104,7 +110,8 @@ A press release's sub-title. [title]: #title #### [title] A press release's title. -Type: **string** +Type: **string** + @@ -114,7 +121,8 @@ A press release's title. [websiteHighlightFlag]: #websitehighlightflag #### [websiteHighlightFlag] Whether or not a press release is highlighted on the SoftLayer Website. -Type: **boolean** +Type: **boolean** + @@ -130,7 +138,8 @@ Whether or not a press release is highlighted on the SoftLayer Website. [about]: #about #### [about] -Type: **SoftLayer_Auxiliary_Press_Release_About_Press_Release[] ** +Type: **SoftLayer_Auxiliary_Press_Release_About_Press_Release[] ** + @@ -140,7 +149,8 @@ Whether or not a press release is highlighted on the SoftLayer Website. [contacts]: #contacts #### [contacts] -Type: **SoftLayer_Auxiliary_Press_Release_Contact_Press_Release[] ** +Type: **SoftLayer_Auxiliary_Press_Release_Contact_Press_Release[] ** + @@ -150,7 +160,8 @@ Whether or not a press release is highlighted on the SoftLayer Website. [mediaPartners]: #mediapartners #### [mediaPartners] -Type: **SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release[] ** +Type: **SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release[] ** + @@ -160,7 +171,8 @@ Whether or not a press release is highlighted on the SoftLayer Website. [pressReleaseContent]: #pressreleasecontent #### [pressReleaseContent] -Type: **SoftLayer_Auxiliary_Press_Release_Content ** +Type: **SoftLayer_Auxiliary_Press_Release_Content ** + @@ -172,7 +184,8 @@ Whether or not a press release is highlighted on the SoftLayer Website. [aboutCount]: #aboutcount #### [aboutCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -182,7 +195,8 @@ A count of [contactCount]: #contactcount #### [contactCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -192,7 +206,8 @@ A count of [mediaPartnerCount]: #mediapartnercount #### [mediaPartnerCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_About/_index.md b/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_About/_index.md index 7b7bee6637..a7f8ea66ff 100644 --- a/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_About/_index.md +++ b/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_About/_index.md @@ -21,6 +21,8 @@ classes: + + ### associatedMethods * [SoftLayer_Auxiliary_Press_Release_About::getObject](/reference/services/SoftLayer_Auxiliary_Press_Release_About/getObject ) @@ -55,7 +57,8 @@ classes: [content]: #content #### [content] A press release about's content. -Type: **string** +Type: **string** + @@ -65,7 +68,8 @@ A press release about's content. [id]: #id #### [id] A press release about's internal -Type: **integer** +Type: **integer** + @@ -75,7 +79,8 @@ A press release about's internal [title]: #title #### [title] A press release about's title. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_About_Press_Release/_index.md b/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_About_Press_Release/_index.md index fd93c48534..5291da734c 100644 --- a/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_About_Press_Release/_index.md +++ b/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_About_Press_Release/_index.md @@ -21,6 +21,8 @@ classes: + + ### associatedMethods * [SoftLayer_Auxiliary_Press_Release_About_Press_Release::getObject](/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/getObject ) @@ -55,7 +57,8 @@ classes: [id]: #id #### [id] A press release about cross -Type: **integer** +Type: **integer** + @@ -65,7 +68,8 @@ A press release about cross [pressReleaseAboutId]: #pressreleaseaboutid #### [pressReleaseAboutId] A press release about's internal -Type: **integer** +Type: **integer** + @@ -75,7 +79,8 @@ A press release about's internal [pressReleaseId]: #pressreleaseid #### [pressReleaseId] A press release internal identifier. -Type: **integer** +Type: **integer** + @@ -85,7 +90,8 @@ A press release internal identifier. [sortOrder]: #sortorder #### [sortOrder] The number that associated an about -Type: **integer** +Type: **integer** + @@ -101,7 +107,8 @@ The number that associated an about [aboutParagraphs]: #aboutparagraphs #### [aboutParagraphs] -Type: **SoftLayer_Auxiliary_Press_Release_About[] ** +Type: **SoftLayer_Auxiliary_Press_Release_About[] ** + @@ -111,7 +118,8 @@ The number that associated an about [pressReleases]: #pressreleases #### [pressReleases] -Type: **SoftLayer_Auxiliary_Press_Release[] ** +Type: **SoftLayer_Auxiliary_Press_Release[] ** + @@ -123,7 +131,8 @@ The number that associated an about [aboutParagraphCount]: #aboutparagraphcount #### [aboutParagraphCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -133,7 +142,8 @@ A count of [pressReleaseCount]: #pressreleasecount #### [pressReleaseCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Contact/_index.md b/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Contact/_index.md index 134494bcdb..01f1ee666f 100644 --- a/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Contact/_index.md +++ b/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Contact/_index.md @@ -21,6 +21,8 @@ classes: + + ### associatedMethods * [SoftLayer_Auxiliary_Press_Release_Contact::getObject](/reference/services/SoftLayer_Auxiliary_Press_Release_Contact/getObject ) @@ -55,7 +57,8 @@ classes: [email]: #email #### [email] A press release contact's email -Type: **string** +Type: **string** + @@ -65,7 +68,8 @@ A press release contact's email [firstName]: #firstname #### [firstName] A press release contact's first name. -Type: **string** +Type: **string** + @@ -75,7 +79,8 @@ A press release contact's first name. [id]: #id #### [id] A press release contact's internal -Type: **integer** +Type: **integer** + @@ -85,7 +90,8 @@ A press release contact's internal [lastName]: #lastname #### [lastName] A press release contact's last name. -Type: **string** +Type: **string** + @@ -95,7 +101,8 @@ A press release contact's last name. [phone]: #phone #### [phone] A press release contact's phone -Type: **string** +Type: **string** + @@ -105,7 +112,8 @@ A press release contact's phone [professionalTitle]: #professionaltitle #### [professionalTitle] A press release contact's -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/_index.md b/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/_index.md index 5a0789ae04..abaaf9e94a 100644 --- a/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/_index.md +++ b/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/_index.md @@ -21,6 +21,8 @@ classes: + + ### associatedMethods * [SoftLayer_Auxiliary_Press_Release_Contact_Press_Release::getObject](/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/getObject ) @@ -55,7 +57,8 @@ classes: [id]: #id #### [id] A press release contact cross -Type: **integer** +Type: **integer** + @@ -65,7 +68,8 @@ A press release contact cross [pressReleaseContactId]: #pressreleasecontactid #### [pressReleaseContactId] A press release contact's internal -Type: **integer** +Type: **integer** + @@ -75,7 +79,8 @@ A press release contact's internal [pressReleaseId]: #pressreleaseid #### [pressReleaseId] A press release internal identifier. -Type: **integer** +Type: **integer** + @@ -85,7 +90,8 @@ A press release internal identifier. [sortOrder]: #sortorder #### [sortOrder] The number that associated a contact -Type: **integer** +Type: **integer** + @@ -101,7 +107,8 @@ The number that associated a contact [contacts]: #contacts #### [contacts] -Type: **SoftLayer_Auxiliary_Press_Release_Contact[] ** +Type: **SoftLayer_Auxiliary_Press_Release_Contact[] ** + @@ -111,7 +118,8 @@ The number that associated a contact [pressReleases]: #pressreleases #### [pressReleases] -Type: **SoftLayer_Auxiliary_Press_Release[] ** +Type: **SoftLayer_Auxiliary_Press_Release[] ** + @@ -123,7 +131,8 @@ The number that associated a contact [contactCount]: #contactcount #### [contactCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -133,7 +142,8 @@ A count of [pressReleaseCount]: #pressreleasecount #### [pressReleaseCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Content/_index.md b/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Content/_index.md index a6bdcda239..0e23a93b59 100644 --- a/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Content/_index.md +++ b/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Content/_index.md @@ -21,6 +21,8 @@ classes: + + ### associatedMethods * [SoftLayer_Auxiliary_Press_Release_Content::getObject](/reference/services/SoftLayer_Auxiliary_Press_Release_Content/getObject ) @@ -50,7 +52,8 @@ classes: [id]: #id #### [id] the id of a single press release -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ the id of a single press release [pressReleaseId]: #pressreleaseid #### [pressReleaseId] the press release id that the content -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ the press release id that the content [text]: #text #### [text] the content of a press release -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Media_Partner/_index.md b/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Media_Partner/_index.md index 5727984049..c3370f9100 100644 --- a/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Media_Partner/_index.md +++ b/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Media_Partner/_index.md @@ -21,6 +21,8 @@ classes: + + ### associatedMethods * [SoftLayer_Auxiliary_Press_Release_Contact::getObject](/reference/services/SoftLayer_Auxiliary_Press_Release_Contact/getObject ) @@ -55,7 +57,8 @@ classes: [id]: #id #### [id] A press release media partner's -Type: **integer** +Type: **integer** + @@ -65,7 +68,8 @@ A press release media partner's [name]: #name #### [name] A press release media partner's name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/_index.md b/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/_index.md index 2d37be40a0..68e8f7d96f 100644 --- a/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/_index.md +++ b/content/reference/datatypes/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/_index.md @@ -21,6 +21,8 @@ classes: + + ### associatedMethods * [SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release::getObject](/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/getObject ) @@ -55,7 +57,8 @@ classes: [id]: #id #### [id] A press release media partner cross -Type: **integer** +Type: **integer** + @@ -65,7 +68,8 @@ A press release media partner cross [mediaPartnerId]: #mediapartnerid #### [mediaPartnerId] A press release media partner's -Type: **integer** +Type: **integer** + @@ -75,7 +79,8 @@ A press release media partner's [pressReleaseId]: #pressreleaseid #### [pressReleaseId] A press release internal identifier. -Type: **integer** +Type: **integer** + @@ -91,7 +96,8 @@ A press release internal identifier. [mediaPartners]: #mediapartners #### [mediaPartners] -Type: **SoftLayer_Auxiliary_Press_Release_Media_Partner[] ** +Type: **SoftLayer_Auxiliary_Press_Release_Media_Partner[] ** + @@ -101,7 +107,8 @@ A press release internal identifier. [pressReleases]: #pressreleases #### [pressReleases] -Type: **SoftLayer_Auxiliary_Press_Release[] ** +Type: **SoftLayer_Auxiliary_Press_Release[] ** + @@ -113,7 +120,8 @@ A press release internal identifier. [mediaPartnerCount]: #mediapartnercount #### [mediaPartnerCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -123,7 +131,8 @@ A count of [pressReleaseCount]: #pressreleasecount #### [pressReleaseCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Auxiliary_Shipping_Courier/_index.md b/content/reference/datatypes/SoftLayer_Auxiliary_Shipping_Courier/_index.md index df4adebb8f..be7057e36c 100644 --- a/content/reference/datatypes/SoftLayer_Auxiliary_Shipping_Courier/_index.md +++ b/content/reference/datatypes/SoftLayer_Auxiliary_Shipping_Courier/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Auxiliary_Shipping_Courier data type contains general information relating the different (major) couriers that SoftLayer may use for shipping. @@ -45,7 +47,8 @@ The SoftLayer_Auxiliary_Shipping_Courier data type contains general information [id]: #id #### [id] The unique id of the shipping courier. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The unique id of the shipping courier. [keyName]: #keyname #### [keyName] The unique keyname of the shipping courier. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The unique keyname of the shipping courier. [name]: #name #### [name] The name of the shipping courier. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The name of the shipping courier. [url]: #url #### [url] The url to shipping courier's website. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Auxiliary_Shipping_Courier_Type/_index.md b/content/reference/datatypes/SoftLayer_Auxiliary_Shipping_Courier_Type/_index.md index 9ff8d77501..1ca484587b 100644 --- a/content/reference/datatypes/SoftLayer_Auxiliary_Shipping_Courier_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Auxiliary_Shipping_Courier_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ classes: [courier]: #courier #### [courier] -Type: **SoftLayer_Auxiliary_Shipping_Courier[] ** +Type: **SoftLayer_Auxiliary_Shipping_Courier[] ** + @@ -103,7 +110,8 @@ classes: [courierCount]: #couriercount #### [courierCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Currency/_index.md b/content/reference/datatypes/SoftLayer_Billing_Currency/_index.md index 9528830a95..a86a324b65 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Currency/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Currency/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ classes: [currentExchangeRate]: #currentexchangerate #### [currentExchangeRate] The current exchange rate -Type: **SoftLayer_Billing_Currency_ExchangeRate ** +Type: **SoftLayer_Billing_Currency_ExchangeRate ** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Currency_Country/_index.md b/content/reference/datatypes/SoftLayer_Billing_Currency_Country/_index.md index 4f57df5c24..a5bfb7a7cb 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Currency_Country/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Currency_Country/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Currency_Country data type maps what currencies are valid [countryId]: #countryid #### [countryId] A unique identifier for the related country. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ A unique identifier for the related country. [currencyId]: #currencyid #### [currencyId] A unique identifier for the related currency. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A unique identifier for the related currency. [id]: #id #### [id] A unique identifier for a map between a country and currency. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A unique identifier for a map between a country and currency. [locale]: #locale #### [locale] The country currency locale. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Currency_ExchangeRate/_index.md b/content/reference/datatypes/SoftLayer_Billing_Currency_ExchangeRate/_index.md index 9b9504694e..ec5b91255a 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Currency_ExchangeRate/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Currency_ExchangeRate/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [effectiveDate]: #effectivedate #### [effectiveDate] -Type: **dateTime** +Type: **dateTime** +
      @@ -55,7 +58,8 @@ classes: [expirationDate]: #expirationdate #### [expirationDate] -Type: **dateTime** +Type: **dateTime** +
      @@ -65,7 +69,8 @@ classes: [id]: #id #### [id] The id of the exchange rate record. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The id of the exchange rate record. [rate]: #rate #### [rate] -Type: **decimal** +Type: **decimal** + @@ -91,7 +97,8 @@ The id of the exchange rate record. [fundingCurrency]: #fundingcurrency #### [fundingCurrency] -Type: **SoftLayer_Billing_Currency ** +Type: **SoftLayer_Billing_Currency ** + @@ -101,7 +108,8 @@ The id of the exchange rate record. [localCurrency]: #localcurrency #### [localCurrency] -Type: **SoftLayer_Billing_Currency ** +Type: **SoftLayer_Billing_Currency ** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Info/_index.md b/content/reference/datatypes/SoftLayer_Billing_Info/_index.md index 0cf37fb6ee..9b0bac2f85 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Info/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Info/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ Every SoftLayer customer account has billing specific information which is kept [accountId]: #accountid #### [accountId] A SoftLayer account's identifier. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ A SoftLayer account's identifier. [anniversaryDayOfMonth]: #anniversarydayofmonth #### [anniversaryDayOfMonth] The day of the month that a SoftLayer customer is billed. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ The day of the month that a SoftLayer customer is billed. [cardAccountNumber]: #cardaccountnumber #### [cardAccountNumber] This value doesn't persist to this object. It's used as part of the account creation process only; -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ This value doesn't persist to this object. It's used as part of the account crea [cardExpirationMonth]: #cardexpirationmonth #### [cardExpirationMonth] the expiration month of the credit card on file -Type: **integer** +Type: **integer** + @@ -90,7 +96,8 @@ the expiration month of the credit card on file [cardExpirationYear]: #cardexpirationyear #### [cardExpirationYear] the expiration year of the credit card on file -Type: **integer** +Type: **integer** + @@ -100,7 +107,8 @@ the expiration year of the credit card on file [cardNickname]: #cardnickname #### [cardNickname] -Type: **string** +Type: **string** + @@ -110,7 +118,8 @@ the expiration year of the credit card on file [cardType]: #cardtype #### [cardType] the type of the credit card on file -Type: **string** +Type: **string** + @@ -120,7 +129,8 @@ the type of the credit card on file [cardVerificationNumber]: #cardverificationnumber #### [cardVerificationNumber] This value doesn't persist to this object. It's used as part of the account creation process only. -Type: **string** +Type: **string** + @@ -130,7 +140,8 @@ This value doesn't persist to this object. It's used as part of the account crea [createDate]: #createdate #### [createDate] The date a customer's billing information was created. -Type: **dateTime** +Type: **dateTime** + @@ -140,7 +151,8 @@ The date a customer's billing information was created. [id]: #id #### [id] A SoftLayer customer's billing information identifier. -Type: **integer** +Type: **integer** + @@ -150,7 +162,8 @@ A SoftLayer customer's billing information identifier. [lastFourPaymentCardDigits]: #lastfourpaymentcarddigits #### [lastFourPaymentCardDigits] The last four digits of the credit card currently on the account. This is the only portion of the card that we store. For Paypal customers, this value will be empty. -Type: **integer** +Type: **integer** + @@ -160,7 +173,8 @@ The last four digits of the credit card currently on the account. This is the on [lastPaymentDate]: #lastpaymentdate #### [lastPaymentDate] The date of the last payment received by SoftLayer from the account holder. -Type: **dateTime** +Type: **dateTime** + @@ -170,7 +184,8 @@ The date of the last payment received by SoftLayer from the account holder. [modifyDate]: #modifydate #### [modifyDate] The date a customer's billing information was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -180,7 +195,8 @@ The date a customer's billing information was last modified. [paymentTerms]: #paymentterms #### [paymentTerms] The payment terms for an account. -Type: **integer** +Type: **integer** + @@ -190,7 +206,8 @@ The payment terms for an account. [percentDiscountOnetime]: #percentdiscountonetime #### [percentDiscountOnetime] The percentage discount received on all one-time charges on a customer's monthly bill. -Type: **integer** +Type: **integer** + @@ -200,7 +217,8 @@ The percentage discount received on all one-time charges on a customer's monthly [percentDiscountRecurring]: #percentdiscountrecurring #### [percentDiscountRecurring] The percentage discount received on all recurring charges on a customer's monthly bill. -Type: **integer** +Type: **integer** + @@ -210,7 +228,8 @@ The percentage discount received on all recurring charges on a customer's monthl [sparePoolAmount]: #sparepoolamount #### [sparePoolAmount] The total recurring fee amount for servers that are in the spare pool status. -Type: **integer** +Type: **integer** + @@ -220,7 +239,8 @@ The total recurring fee amount for servers that are in the spare pool status. [taxCertificateId]: #taxcertificateid #### [taxCertificateId] This property has been deprecated. -Type: **string** +Type: **string** + @@ -230,7 +250,8 @@ This property has been deprecated. [vatId]: #vatid #### [vatId] -Type: **string** +Type: **string** + @@ -246,7 +267,8 @@ This property has been deprecated. [account]: #account #### [account] The SoftLayer customer account associated with this billing information. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -256,7 +278,8 @@ The SoftLayer customer account associated with this billing information. [achInformation]: #achinformation #### [achInformation] -Type: **SoftLayer_Billing_Info_Ach[] ** +Type: **SoftLayer_Billing_Info_Ach[] ** + @@ -266,7 +289,8 @@ The SoftLayer customer account associated with this billing information. [currency]: #currency #### [currency] Currency to be used by this customer account. -Type: **SoftLayer_Billing_Currency ** +Type: **SoftLayer_Billing_Currency ** + @@ -276,7 +300,8 @@ Currency to be used by this customer account. [currentBillingCycle]: #currentbillingcycle #### [currentBillingCycle] Information related to an account's current and previous billing cycles. -Type: **SoftLayer_Billing_Info_Cycle ** +Type: **SoftLayer_Billing_Info_Cycle ** + @@ -286,7 +311,8 @@ Information related to an account's current and previous billing cycles. [lastBillDate]: #lastbilldate #### [lastBillDate] The date on which an account was last billed. -Type: **dateTime** +Type: **dateTime** + @@ -296,7 +322,8 @@ The date on which an account was last billed. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which an account will be billed next. -Type: **dateTime** +Type: **dateTime** + @@ -308,7 +335,8 @@ The date on which an account will be billed next. [achInformationCount]: #achinformationcount #### [achInformationCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Info_Ach/_index.md b/content/reference/datatypes/SoftLayer_Billing_Info_Ach/_index.md index ebfd524b3e..4070521d32 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Info_Ach/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Info_Ach/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [accountNumber]: #accountnumber #### [accountNumber] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [accountType]: #accounttype #### [accountType] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [bankTransitNumber]: #banktransitnumber #### [bankTransitNumber] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [city]: #city #### [city] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [country]: #country #### [country] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ classes: [firstName]: #firstname #### [firstName] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ classes: [lastName]: #lastname #### [lastName] -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ classes: [phoneNumber]: #phonenumber #### [phoneNumber] -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ classes: [postalcode]: #postalcode #### [postalcode] -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ classes: [state]: #state #### [state] -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ classes: [status]: #status #### [status] -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ classes: [street1]: #street1 #### [street1] -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ classes: [street2]: #street2 #### [street2] -Type: **string** +Type: **string** + @@ -195,7 +212,8 @@ classes: [verifiedDate]: #verifieddate #### [verifiedDate] -Type: **dateTime** +Type: **dateTime** + @@ -211,7 +229,8 @@ classes: [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Info_Cycle/_index.md b/content/reference/datatypes/SoftLayer_Billing_Info_Cycle/_index.md index 7169a86f66..fa9402f2fa 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Info_Cycle/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Info_Cycle/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ The SoftLayer_Billing_Info_Cycle data type models basic information concerning a [currentCycleEndDate]: #currentcycleenddate #### [currentCycleEndDate] The ending date of an account's current billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -60,7 +63,8 @@ The ending date of an account's current billing cycle. [currentCycleStartDate]: #currentcyclestartdate #### [currentCycleStartDate] The starting date of an account's current billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -70,7 +74,8 @@ The starting date of an account's current billing cycle. [nextCycleStartDate]: #nextcyclestartdate #### [nextCycleStartDate] The start date of an account's next billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -80,7 +85,8 @@ The start date of an account's next billing cycle. [previousCycleEndDate]: #previouscycleenddate #### [previousCycleEndDate] The ending date of an account's previous billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -90,7 +96,8 @@ The ending date of an account's previous billing cycle. [previousCycleStartDate]: #previouscyclestartdate #### [previousCycleStartDate] The starting date of an account's previous billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -106,7 +113,8 @@ The starting date of an account's previous billing cycle. [account]: #account #### [account] The account that a current billing cycle is associated with. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Invoice/_index.md b/content/reference/datatypes/SoftLayer_Billing_Invoice/_index.md index 6f06cf8aa7..b3d6f88e8f 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Invoice/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Invoice/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -56,7 +58,8 @@ The SoftLayer_Billing_Invoice data type contains general information relating to [accountId]: #accountid #### [accountId] The SoftLayer customer account that an invoice belongs to. -Type: **integer** +Type: **integer** + @@ -66,7 +69,8 @@ The SoftLayer customer account that an invoice belongs to. [address1]: #address1 #### [address1] The first line of an address belonging to an account at the time an invoice is created. -Type: **string** +Type: **string** + @@ -76,7 +80,8 @@ The first line of an address belonging to an account at the time an invoice is c [address2]: #address2 #### [address2] The second line of an address belonging to an account at the time an invoice is created. -Type: **string** +Type: **string** + @@ -86,7 +91,8 @@ The second line of an address belonging to an account at the time an invoice is [city]: #city #### [city] The city portion of an address belonging to an account at the time an invoice is created. -Type: **string** +Type: **string** + @@ -96,7 +102,8 @@ The city portion of an address belonging to an account at the time an invoice is [claimedTaxExemptTxFlag]: #claimedtaxexempttxflag #### [claimedTaxExemptTxFlag] Whether an account was exempt from taxes on their invoices at the time an invoice is created. -Type: **boolean** +Type: **boolean** + @@ -106,7 +113,8 @@ Whether an account was exempt from taxes on their invoices at the time an invoic [closedDate]: #closeddate #### [closedDate] The date an invoice was closed. Open invoices have a null closed date. -Type: **dateTime** +Type: **dateTime** + @@ -116,7 +124,8 @@ The date an invoice was closed. Open invoices have a null closed date. [companyName]: #companyname #### [companyName] The company name belonging to an account at the time an invoice is created. -Type: **string** +Type: **string** + @@ -126,7 +135,8 @@ The company name belonging to an account at the time an invoice is created. [country]: #country #### [country] A two-letter abbreviation of the country portion of an address belonging to an account at the time an invoice is created. -Type: **string** +Type: **string** + @@ -136,7 +146,8 @@ A two-letter abbreviation of the country portion of an address belonging to an a [createDate]: #createdate #### [createDate] The date an invoice was created. -Type: **dateTime** +Type: **dateTime** + @@ -146,7 +157,8 @@ The date an invoice was created. [documentsGeneratedFlag]: #documentsgeneratedflag #### [documentsGeneratedFlag] -Type: **boolean** +Type: **boolean** + @@ -156,7 +168,8 @@ The date an invoice was created. [email]: #email #### [email] The email address belonging to an account at the time an invoice is created. -Type: **string** +Type: **string** + @@ -166,7 +179,8 @@ The email address belonging to an account at the time an invoice is created. [endingBalance]: #endingbalance #### [endingBalance] An SoftLayer account's balance at the time an invoice is closed. This value is measured in US Dollar ($USD) currency. -Type: **decimal** +Type: **decimal** + @@ -176,7 +190,8 @@ An SoftLayer account's balance at the time an invoice is closed. This value is m [faxPhone]: #faxphone #### [faxPhone] The fax telephone number belonging to an account at the time an invoice is created. -Type: **string** +Type: **string** + @@ -186,7 +201,8 @@ The fax telephone number belonging to an account at the time an invoice is creat [firstName]: #firstname #### [firstName] The first name of the account holder at the time an invoice is created. -Type: **string** +Type: **string** + @@ -196,7 +212,8 @@ The first name of the account holder at the time an invoice is created. [id]: #id #### [id] An invoice's internal identifier. -Type: **integer** +Type: **integer** + @@ -206,7 +223,8 @@ An invoice's internal identifier. [lastName]: #lastname #### [lastName] The last name of the account holder at the time an invoice is created. -Type: **string** +Type: **string** + @@ -216,7 +234,8 @@ The last name of the account holder at the time an invoice is created. [modifyDate]: #modifydate #### [modifyDate] The date an invoice was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -226,7 +245,8 @@ The date an invoice was last modified. [officePhone]: #officephone #### [officePhone] The telephone number belonging to an account at the time an invoice is created. -Type: **string** +Type: **string** + @@ -236,7 +256,8 @@ The telephone number belonging to an account at the time an invoice is created. [postalCode]: #postalcode #### [postalCode] The postal code portion of an address belonging to an account at the time an invoice is created. -Type: **string** +Type: **string** + @@ -246,7 +267,8 @@ The postal code portion of an address belonging to an account at the time an inv [purchaseOrderNumber]: #purchaseordernumber #### [purchaseOrderNumber] -Type: **string** +Type: **string** + @@ -256,7 +278,8 @@ The postal code portion of an address belonging to an account at the time an inv [startingBalance]: #startingbalance #### [startingBalance] An SoftLayer account's balance at the time an invoice is created. This value is measured in US Dollar ($USD) currency. -Type: **decimal** +Type: **decimal** + @@ -266,7 +289,8 @@ An SoftLayer account's balance at the time an invoice is created. This value is [state]: #state #### [state] A two-letter abbreviation of the state portion of an address belonging to an account at the time an invoice is created. If the account that the invoice was generated for resides outside a province then this is set to "other". -Type: **string** +Type: **string** + @@ -276,7 +300,8 @@ A two-letter abbreviation of the state portion of an address belonging to an acc [statusCode]: #statuscode #### [statusCode] An invoice's status. The "OPEN" status means SoftLayer has not yet received payment for this invoice. "CLOSED" status means that SoftLayer has received payment and closed the invoice. The "CLOSED_FAILED" status code means SoftLayer closed the invoice without receiving a payment. Invoices are usually set to CLOSED_FAILED status in cases where customer accounts are terminated for non-payment. -Type: **string** +Type: **string** + @@ -286,7 +311,8 @@ An invoice's status. The "OPEN" status means SoftLayer has not yet received paym [taxStatusId]: #taxstatusid #### [taxStatusId] -Type: **integer** +Type: **integer** + @@ -296,7 +322,8 @@ An invoice's status. The "OPEN" status means SoftLayer has not yet received paym [taxTypeId]: #taxtypeid #### [taxTypeId] -Type: **integer** +Type: **integer** + @@ -306,7 +333,8 @@ An invoice's status. The "OPEN" status means SoftLayer has not yet received paym [typeCode]: #typecode #### [typeCode] An invoice's type. SoftLayer invoices and service credits are differentiated by their type. The "NEW" type code signifies an invoice for new service. A SoftLayer customer's first invoice has the NEW type code. "RECURRING" invoices are generated on a SoftLayer customer's anniversary billing date for monthly services. "ONE-TIME-CHARGE" invoices are generated when one-time charges are applied to an account. "CREDIT" invoices are generated whenever SoftLayer applies a credit against an account's balance. There are two special types of service credits. "REFUND" type credits are applied against a customer's account balance along with the receivables on their account. "MANUAL_PAYMENT_CREDIT" invoice credits are generated whenever a customer makes an unscheduled payment. -Type: **string** +Type: **string** + @@ -322,7 +350,8 @@ An invoice's type. SoftLayer invoices and service credits are differentiated by [account]: #account #### [account] The account that an invoice belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -332,7 +361,8 @@ The account that an invoice belongs to. [amount]: #amount #### [amount] This is the amount of this invoice. -Type: **decimal** +Type: **decimal** + @@ -342,7 +372,8 @@ This is the amount of this invoice. [brandAtInvoiceCreation]: #brandatinvoicecreation #### [brandAtInvoiceCreation] -Type: **SoftLayer_Brand ** +Type: **SoftLayer_Brand ** + @@ -352,7 +383,8 @@ This is the amount of this invoice. [detailedPdfGeneratedFlag]: #detailedpdfgeneratedflag #### [detailedPdfGeneratedFlag] A flag that will reflect whether the detailed version of the pdf has been generated. -Type: **boolean** +Type: **boolean** + @@ -362,7 +394,8 @@ A flag that will reflect whether the detailed version of the pdf has been genera [invoiceTopLevelItems]: #invoicetoplevelitems #### [invoiceTopLevelItems] A list of top-level invoice items that are on the currently pending invoice. -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -372,7 +405,8 @@ A list of top-level invoice items that are on the currently pending invoice. [invoiceTotalAmount]: #invoicetotalamount #### [invoiceTotalAmount] The total amount of this invoice. -Type: **decimal** +Type: **decimal** + @@ -382,7 +416,8 @@ The total amount of this invoice. [invoiceTotalOneTimeAmount]: #invoicetotalonetimeamount #### [invoiceTotalOneTimeAmount] The total one-time charges for this invoice. This is the sum of one-time charges + setup fees + labor fees. This does not include taxes. -Type: **decimal** +Type: **decimal** + @@ -392,7 +427,8 @@ The total one-time charges for this invoice. This is the sum of one-time charges [invoiceTotalOneTimeTaxAmount]: #invoicetotalonetimetaxamount #### [invoiceTotalOneTimeTaxAmount] A sum of all the taxes related to one time charges for this invoice. -Type: **decimal** +Type: **decimal** + @@ -402,7 +438,8 @@ A sum of all the taxes related to one time charges for this invoice. [invoiceTotalPreTaxAmount]: #invoicetotalpretaxamount #### [invoiceTotalPreTaxAmount] The total amount of this invoice. This does not include taxes. -Type: **decimal** +Type: **decimal** + @@ -412,7 +449,8 @@ The total amount of this invoice. This does not include taxes. [invoiceTotalRecurringAmount]: #invoicetotalrecurringamount #### [invoiceTotalRecurringAmount] The total Recurring amount of this invoice. This amount does not include taxes or one time charges. -Type: **decimal** +Type: **decimal** + @@ -422,7 +460,8 @@ The total Recurring amount of this invoice. This amount does not include taxes o [invoiceTotalRecurringTaxAmount]: #invoicetotalrecurringtaxamount #### [invoiceTotalRecurringTaxAmount] The total amount of the recurring taxes on this invoice. -Type: **decimal** +Type: **decimal** + @@ -432,7 +471,8 @@ The total amount of the recurring taxes on this invoice. [items]: #items #### [items] The items that belong to this invoice. -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -442,7 +482,8 @@ The items that belong to this invoice. [localCurrencyExchangeRate]: #localcurrencyexchangerate #### [localCurrencyExchangeRate] Exchange rate used for billing this invoice. -Type: **SoftLayer_Billing_Currency_ExchangeRate ** +Type: **SoftLayer_Billing_Currency_ExchangeRate ** + @@ -452,7 +493,8 @@ Exchange rate used for billing this invoice. [payment]: #payment #### [payment] This is the total payment made on this invoice. -Type: **decimal** +Type: **decimal** + @@ -462,7 +504,8 @@ This is the total payment made on this invoice. [payments]: #payments #### [payments] The payments for the invoice. -Type: **SoftLayer_Billing_Invoice_Receivable_Payment[] ** +Type: **SoftLayer_Billing_Invoice_Receivable_Payment[] ** + @@ -472,7 +515,8 @@ The payments for the invoice. [sellerRegistration]: #sellerregistration #### [sellerRegistration] This is the seller's tax registration. -Type: **string** +Type: **string** + @@ -482,7 +526,8 @@ This is the seller's tax registration. [taxInfo]: #taxinfo #### [taxInfo] This is the tax information that applies to tax auditing. This is the official tax record for this invoice. -Type: **SoftLayer_Billing_Invoice_Tax_Info ** +Type: **SoftLayer_Billing_Invoice_Tax_Info ** + @@ -492,7 +537,8 @@ This is the tax information that applies to tax auditing. This is the official t [taxInfoHistory]: #taxinfohistory #### [taxInfoHistory] This is the set of tax information for any tax calculation for this invoice. Note that not all of these are necessarily official, so use the taxInfo key to get the final information. -Type: **SoftLayer_Billing_Invoice_Tax_Info[] ** +Type: **SoftLayer_Billing_Invoice_Tax_Info[] ** + @@ -502,7 +548,8 @@ This is the set of tax information for any tax calculation for this invoice. Not [taxMessage]: #taxmessage #### [taxMessage] This is a message explaining the tax treatment for this invoice. -Type: **string** +Type: **string** + @@ -512,7 +559,8 @@ This is a message explaining the tax treatment for this invoice. [taxType]: #taxtype #### [taxType] This is the strategy used to calculate tax on this invoice. -Type: **SoftLayer_Billing_Invoice_Tax_Type ** +Type: **SoftLayer_Billing_Invoice_Tax_Type ** + @@ -524,7 +572,8 @@ This is the strategy used to calculate tax on this invoice. [invoiceTopLevelItemCount]: #invoicetoplevelitemcount #### [invoiceTopLevelItemCount] A count of a list of top-level invoice items that are on the currently pending invoice. -Type: **unsigned long** +Type: **unsigned long** + @@ -534,7 +583,8 @@ A count of a list of top-level invoice items that are on the currently pending i [itemCount]: #itemcount #### [itemCount] A count of the items that belong to this invoice. -Type: **unsigned long** +Type: **unsigned long** + @@ -544,7 +594,8 @@ A count of the items that belong to this invoice. [paymentCount]: #paymentcount #### [paymentCount] A count of the payments for the invoice. -Type: **unsigned long** +Type: **unsigned long** + @@ -554,7 +605,8 @@ A count of the payments for the invoice. [taxInfoHistoryCount]: #taxinfohistorycount #### [taxInfoHistoryCount] A count of this is the set of tax information for any tax calculation for this invoice. Note that not all of these are necessarily official, so use the taxInfo key to get the final information. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Invoice_Item/_index.md b/content/reference/datatypes/SoftLayer_Billing_Invoice_Item/_index.md index 2be793fdd8..9d65d6e418 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Invoice_Item/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Invoice_Item/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -55,7 +57,8 @@ Each billing invoice item makes up a record within an invoice. This provides you [associatedInvoiceItemId]: #associatedinvoiceitemid #### [associatedInvoiceItemId] The associated invoice Item ID. -Type: **integer** +Type: **integer** + @@ -65,7 +68,8 @@ The associated invoice Item ID. [billingItemId]: #billingitemid #### [billingItemId] The billing item from which this invoice item was generated. -Type: **integer** +Type: **integer** + @@ -75,7 +79,8 @@ The billing item from which this invoice item was generated. [categoryCode]: #categorycode #### [categoryCode] The item category of the invoice item being invoiced. -Type: **string** +Type: **string** + @@ -85,7 +90,8 @@ The item category of the invoice item being invoiced. [createDate]: #createdate #### [createDate] The date the invoice item was created. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +101,8 @@ The date the invoice item was created. [description]: #description #### [description] The item description for this invoice item. -Type: **string** +Type: **string** + @@ -105,7 +112,8 @@ The item description for this invoice item. [domainName]: #domainname #### [domainName] The domain name of the invoiced item. This is only used on invoice items whose category is "server". -Type: **string** +Type: **string** + @@ -115,7 +123,8 @@ The domain name of the invoiced item. This is only used on invoice items whose c [hostName]: #hostname #### [hostName] The Host name of the invoiced item. This is only used on invoice items whose category is "server". -Type: **string** +Type: **string** + @@ -125,7 +134,8 @@ The Host name of the invoiced item. This is only used on invoice items whose cat [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The hourly recurring fee of the invoice item represented by a floating point decimal in US Dollars ($USD) -Type: **decimal** +Type: **decimal** + @@ -135,7 +145,8 @@ The hourly recurring fee of the invoice item represented by a floating point dec [id]: #id #### [id] The ID of the invoice item. -Type: **integer** +Type: **integer** + @@ -145,7 +156,8 @@ The ID of the invoice item. [invoiceId]: #invoiceid #### [invoiceId] The invoice to which this invoice item belongs. -Type: **integer** +Type: **integer** + @@ -155,7 +167,8 @@ The invoice to which this invoice item belongs. [laborAfterTaxAmount]: #laboraftertaxamount #### [laborAfterTaxAmount] An invoice item's labor fee total after taxes. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -165,7 +178,8 @@ An invoice item's labor fee total after taxes. This does not include any child i [laborFee]: #laborfee #### [laborFee] This also a one-time fee of a special type. -Type: **decimal** +Type: **decimal** + @@ -175,7 +189,8 @@ This also a one-time fee of a special type. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The tax rate at which the labor fee is taxed. -Type: **decimal** +Type: **decimal** + @@ -185,7 +200,8 @@ The tax rate at which the labor fee is taxed. [laborTaxAmount]: #labortaxamount #### [laborTaxAmount] An invoice item's labor tax amount. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -195,7 +211,8 @@ An invoice item's labor tax amount. This does not include any child invoice item [notes]: #notes #### [notes] A note to help describe more about the item. This normally holds usernames, or some other bit of extra information. -Type: **string** +Type: **string** + @@ -205,7 +222,8 @@ A note to help describe more about the item. This normally holds usernames, or s [oneTimeAfterTaxAmount]: #onetimeaftertaxamount #### [oneTimeAfterTaxAmount] An invoice item's one-time fee total after taxes. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -215,7 +233,8 @@ An invoice item's one-time fee total after taxes. This does not include any chil [oneTimeFee]: #onetimefee #### [oneTimeFee] If there are any one-time charges assessed, it will show up here represented by a floating point decimal in US Dollars ($USD) -Type: **decimal** +Type: **decimal** + @@ -225,7 +244,8 @@ If there are any one-time charges assessed, it will show up here represented by [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which the one-time fee is taxed. -Type: **decimal** +Type: **decimal** + @@ -235,7 +255,8 @@ The rate at which the one-time fee is taxed. [oneTimeTaxAmount]: #onetimetaxamount #### [oneTimeTaxAmount] An invoice item's one-time tax amount. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -245,7 +266,8 @@ An invoice item's one-time tax amount. This does not include any child invoice i [parentId]: #parentid #### [parentId] The parent invoice item, usually the server invoice item. -Type: **integer** +Type: **integer** + @@ -255,7 +277,8 @@ The parent invoice item, usually the server invoice item. [productItemId]: #productitemid #### [productItemId] The entry in the product catalog that a invoice item is based upon. -Type: **integer** +Type: **integer** + @@ -265,7 +288,8 @@ The entry in the product catalog that a invoice item is based upon. [recurringAfterTaxAmount]: #recurringaftertaxamount #### [recurringAfterTaxAmount] An invoice item's recurring fee total after taxes. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -275,7 +299,8 @@ An invoice item's recurring fee total after taxes. This does not include any chi [recurringFee]: #recurringfee #### [recurringFee] The recurring fee of the invoice item represented by a floating point decimal in US Dollars ($USD) -Type: **decimal** +Type: **decimal** + @@ -285,7 +310,8 @@ The recurring fee of the invoice item represented by a floating point decimal in [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] the rate at which the recurring fee is taxed. -Type: **decimal** +Type: **decimal** + @@ -295,7 +321,8 @@ the rate at which the recurring fee is taxed. [recurringTaxAmount]: #recurringtaxamount #### [recurringTaxAmount] An invoice item's recurring tax amount. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -305,7 +332,8 @@ An invoice item's recurring tax amount. This does not include any child invoice [resourceTableId]: #resourcetableid #### [resourceTableId] A unique identifier for a SoftLayer Service that is associated to an invoice item. -Type: **integer** +Type: **integer** + @@ -315,7 +343,8 @@ A unique identifier for a SoftLayer Service that is associated to an invoice ite [serviceProviderId]: #serviceproviderid #### [serviceProviderId] The service provider for the invoice item. -Type: **integer** +Type: **integer** + @@ -325,7 +354,8 @@ The service provider for the invoice item. [setupAfterTaxAmount]: #setupaftertaxamount #### [setupAfterTaxAmount] An invoice item's setup fee total after taxes. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -335,7 +365,8 @@ An invoice item's setup fee total after taxes. This does not include any child i [setupFee]: #setupfee #### [setupFee] If there were any setup fees they will show up here. These are normally a one-time fee. -Type: **decimal** +Type: **decimal** + @@ -345,7 +376,8 @@ If there were any setup fees they will show up here. These are normally a one-ti [setupFeeDeferralMonths]: #setupfeedeferralmonths #### [setupFeeDeferralMonths] The number of months the setup fee is being deferred. -Type: **integer** +Type: **integer** + @@ -355,7 +387,8 @@ The number of months the setup fee is being deferred. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The tax rate at which the setup fee is taxed. -Type: **decimal** +Type: **decimal** + @@ -365,7 +398,8 @@ The tax rate at which the setup fee is taxed. [setupTaxAmount]: #setuptaxamount #### [setupTaxAmount] An invoice item's setup tax amount. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -381,7 +415,8 @@ An invoice item's setup tax amount. This does not include any child invoice item [associatedChildren]: #associatedchildren #### [associatedChildren] An Invoice Item's associated child invoice items. Only parent invoice items have associated children. For instance, a server invoice item may have associated children. -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -391,7 +426,8 @@ An Invoice Item's associated child invoice items. Only parent invoice items have [associatedInvoiceItem]: #associatedinvoiceitem #### [associatedInvoiceItem] An Invoice Item's associated invoice item. If this is populated, it means this is an orphaned invoice item, but logically belongs to the associated invoice item. -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -401,7 +437,8 @@ An Invoice Item's associated invoice item. If this is populated, it means this i [billingItem]: #billingitem #### [billingItem] An Invoice Item's billing item, from which this item was generated. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -411,7 +448,8 @@ An Invoice Item's billing item, from which this item was generated. [category]: #category #### [category] This invoice item's "item category". -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -421,7 +459,8 @@ This invoice item's "item category". [children]: #children #### [children] An Invoice Item's child invoice items. Only parent invoice items have children. For instance, a server invoice item will have children. -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -431,7 +470,8 @@ An Invoice Item's child invoice items. Only parent invoice items have children. [filteredAssociatedChildren]: #filteredassociatedchildren #### [filteredAssociatedChildren] An Invoice Item's associated child invoice items, excluding some items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children. -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -441,7 +481,8 @@ An Invoice Item's associated child invoice items, excluding some items with a $0 [hourlyFlag]: #hourlyflag #### [hourlyFlag] Indicating whether this invoice item is billed on an hourly basis. -Type: **boolean** +Type: **boolean** + @@ -451,7 +492,8 @@ Indicating whether this invoice item is billed on an hourly basis. [invoice]: #invoice #### [invoice] The invoice to which this item belongs. -Type: **SoftLayer_Billing_Invoice ** +Type: **SoftLayer_Billing_Invoice ** + @@ -461,7 +503,8 @@ The invoice to which this item belongs. [location]: #location #### [location] An invoice item's location, if one exists.' -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -471,7 +514,8 @@ An invoice item's location, if one exists.' [nonZeroAssociatedChildren]: #nonzeroassociatedchildren #### [nonZeroAssociatedChildren] An Invoice Item's associated child invoice items, excluding ALL items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children. -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -481,7 +525,8 @@ An Invoice Item's associated child invoice items, excluding ALL items with a $0. [parent]: #parent #### [parent] Every item tied to a server should have a parent invoice item which is the server line item. This is how we associate items to a server. -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -491,7 +536,8 @@ Every item tied to a server should have a parent invoice item which is the serve [product]: #product #### [product] The entry in the product catalog that a invoice item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -501,7 +547,8 @@ The entry in the product catalog that a invoice item is based upon. [topLevelProductGroupName]: #toplevelproductgroupname #### [topLevelProductGroupName] A string representing the name of parent level product group of an invoice item. -Type: **string** +Type: **string** + @@ -511,7 +558,8 @@ A string representing the name of parent level product group of an invoice item. [totalOneTimeAmount]: #totalonetimeamount #### [totalOneTimeAmount] An invoice Item's total, including any child invoice items if they exist. -Type: **float** +Type: **float** + @@ -521,7 +569,8 @@ An invoice Item's total, including any child invoice items if they exist. [totalOneTimeTaxAmount]: #totalonetimetaxamount #### [totalOneTimeTaxAmount] An invoice Item's total, including any child invoice items if they exist. -Type: **float** +Type: **float** + @@ -531,7 +580,8 @@ An invoice Item's total, including any child invoice items if they exist. [totalRecurringAmount]: #totalrecurringamount #### [totalRecurringAmount] An invoice Item's total, including any child invoice items if they exist. -Type: **float** +Type: **float** + @@ -541,7 +591,8 @@ An invoice Item's total, including any child invoice items if they exist. [totalRecurringTaxAmount]: #totalrecurringtaxamount #### [totalRecurringTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -551,7 +602,8 @@ A Billing Item's total, including any child billing items if they exist.' [usageChargeFlag]: #usagechargeflag #### [usageChargeFlag] Indicating whether this invoice item is for the usage charge. -Type: **boolean** +Type: **boolean** + @@ -563,7 +615,8 @@ Indicating whether this invoice item is for the usage charge. [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of an Invoice Item's associated child invoice items. Only parent invoice items have associated children. For instance, a server invoice item may have associated children. -Type: **unsigned long** +Type: **unsigned long** + @@ -573,7 +626,8 @@ A count of an Invoice Item's associated child invoice items. Only parent invoice [childrenCount]: #childrencount #### [childrenCount] A count of an Invoice Item's child invoice items. Only parent invoice items have children. For instance, a server invoice item will have children. -Type: **unsigned long** +Type: **unsigned long** + @@ -583,7 +637,8 @@ A count of an Invoice Item's child invoice items. Only parent invoice items have [filteredAssociatedChildrenCount]: #filteredassociatedchildrencount #### [filteredAssociatedChildrenCount] A count of an Invoice Item's associated child invoice items, excluding some items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children. -Type: **unsigned long** +Type: **unsigned long** + @@ -593,7 +648,8 @@ A count of an Invoice Item's associated child invoice items, excluding some item [nonZeroAssociatedChildrenCount]: #nonzeroassociatedchildrencount #### [nonZeroAssociatedChildrenCount] A count of an Invoice Item's associated child invoice items, excluding ALL items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Invoice_Item_Hardware/_index.md b/content/reference/datatypes/SoftLayer_Billing_Invoice_Item_Hardware/_index.md index 6235c1b465..9f0095a42d 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Invoice_Item_Hardware/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Invoice_Item_Hardware/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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". @@ -45,7 +47,8 @@ The SoftLayer_Billing_Invoice_Item_Hardware data type contains a "resource". Thi [associatedInvoiceItemId]: #associatedinvoiceitemid #### [associatedInvoiceItemId] The associated invoice Item ID. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The associated invoice Item ID. [billingItemId]: #billingitemid #### [billingItemId] The billing item from which this invoice item was generated. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The billing item from which this invoice item was generated. [categoryCode]: #categorycode #### [categoryCode] The item category of the invoice item being invoiced. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The item category of the invoice item being invoiced. [createDate]: #createdate #### [createDate] The date the invoice item was created. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The date the invoice item was created. [description]: #description #### [description] The item description for this invoice item. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The item description for this invoice item. [domainName]: #domainname #### [domainName] The domain name of the invoiced item. This is only used on invoice items whose category is "server". -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The domain name of the invoiced item. This is only used on invoice items whose c [hostName]: #hostname #### [hostName] The Host name of the invoiced item. This is only used on invoice items whose category is "server". -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The Host name of the invoiced item. This is only used on invoice items whose cat [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The hourly recurring fee of the invoice item represented by a floating point decimal in US Dollars ($USD) -Type: **decimal** +Type: **decimal** + @@ -125,7 +135,8 @@ The hourly recurring fee of the invoice item represented by a floating point dec [id]: #id #### [id] The ID of the invoice item. -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ The ID of the invoice item. [invoiceId]: #invoiceid #### [invoiceId] The invoice to which this invoice item belongs. -Type: **integer** +Type: **integer** + @@ -145,7 +157,8 @@ The invoice to which this invoice item belongs. [laborAfterTaxAmount]: #laboraftertaxamount #### [laborAfterTaxAmount] An invoice item's labor fee total after taxes. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ An invoice item's labor fee total after taxes. This does not include any child i [laborFee]: #laborfee #### [laborFee] This also a one-time fee of a special type. -Type: **decimal** +Type: **decimal** + @@ -165,7 +179,8 @@ This also a one-time fee of a special type. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The tax rate at which the labor fee is taxed. -Type: **decimal** +Type: **decimal** + @@ -175,7 +190,8 @@ The tax rate at which the labor fee is taxed. [laborTaxAmount]: #labortaxamount #### [laborTaxAmount] An invoice item's labor tax amount. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ An invoice item's labor tax amount. This does not include any child invoice item [notes]: #notes #### [notes] A note to help describe more about the item. This normally holds usernames, or some other bit of extra information. -Type: **string** +Type: **string** + @@ -195,7 +212,8 @@ A note to help describe more about the item. This normally holds usernames, or s [oneTimeAfterTaxAmount]: #onetimeaftertaxamount #### [oneTimeAfterTaxAmount] An invoice item's one-time fee total after taxes. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -205,7 +223,8 @@ An invoice item's one-time fee total after taxes. This does not include any chil [oneTimeFee]: #onetimefee #### [oneTimeFee] If there are any one-time charges assessed, it will show up here represented by a floating point decimal in US Dollars ($USD) -Type: **decimal** +Type: **decimal** + @@ -215,7 +234,8 @@ If there are any one-time charges assessed, it will show up here represented by [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which the one-time fee is taxed. -Type: **decimal** +Type: **decimal** + @@ -225,7 +245,8 @@ The rate at which the one-time fee is taxed. [oneTimeTaxAmount]: #onetimetaxamount #### [oneTimeTaxAmount] An invoice item's one-time tax amount. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -235,7 +256,8 @@ An invoice item's one-time tax amount. This does not include any child invoice i [parentId]: #parentid #### [parentId] The parent invoice item, usually the server invoice item. -Type: **integer** +Type: **integer** + @@ -245,7 +267,8 @@ The parent invoice item, usually the server invoice item. [productItemId]: #productitemid #### [productItemId] The entry in the product catalog that a invoice item is based upon. -Type: **integer** +Type: **integer** + @@ -255,7 +278,8 @@ The entry in the product catalog that a invoice item is based upon. [recurringAfterTaxAmount]: #recurringaftertaxamount #### [recurringAfterTaxAmount] An invoice item's recurring fee total after taxes. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -265,7 +289,8 @@ An invoice item's recurring fee total after taxes. This does not include any chi [recurringFee]: #recurringfee #### [recurringFee] The recurring fee of the invoice item represented by a floating point decimal in US Dollars ($USD) -Type: **decimal** +Type: **decimal** + @@ -275,7 +300,8 @@ The recurring fee of the invoice item represented by a floating point decimal in [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] the rate at which the recurring fee is taxed. -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ the rate at which the recurring fee is taxed. [recurringTaxAmount]: #recurringtaxamount #### [recurringTaxAmount] An invoice item's recurring tax amount. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ An invoice item's recurring tax amount. This does not include any child invoice [resourceTableId]: #resourcetableid #### [resourceTableId] The unique Identifier of the hardware attached to an invoice item. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The unique Identifier of the hardware attached to an invoice item. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] The service provider for the invoice item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ The service provider for the invoice item. [setupAfterTaxAmount]: #setupaftertaxamount #### [setupAfterTaxAmount] An invoice item's setup fee total after taxes. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ An invoice item's setup fee total after taxes. This does not include any child i [setupFee]: #setupfee #### [setupFee] If there were any setup fees they will show up here. These are normally a one-time fee. -Type: **decimal** +Type: **decimal** + @@ -335,7 +366,8 @@ If there were any setup fees they will show up here. These are normally a one-ti [setupFeeDeferralMonths]: #setupfeedeferralmonths #### [setupFeeDeferralMonths] The number of months the setup fee is being deferred. -Type: **integer** +Type: **integer** + @@ -345,7 +377,8 @@ The number of months the setup fee is being deferred. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The tax rate at which the setup fee is taxed. -Type: **decimal** +Type: **decimal** + @@ -355,7 +388,8 @@ The tax rate at which the setup fee is taxed. [setupTaxAmount]: #setuptaxamount #### [setupTaxAmount] An invoice item's setup tax amount. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -371,7 +405,8 @@ An invoice item's setup tax amount. This does not include any child invoice item [associatedChildren]: #associatedchildren #### [associatedChildren] An Invoice Item's associated child invoice items. Only parent invoice items have associated children. For instance, a server invoice item may have associated children. -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -381,7 +416,8 @@ An Invoice Item's associated child invoice items. Only parent invoice items have [associatedInvoiceItem]: #associatedinvoiceitem #### [associatedInvoiceItem] An Invoice Item's associated invoice item. If this is populated, it means this is an orphaned invoice item, but logically belongs to the associated invoice item. -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -391,7 +427,8 @@ An Invoice Item's associated invoice item. If this is populated, it means this i [billingItem]: #billingitem #### [billingItem] An Invoice Item's billing item, from which this item was generated. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -401,7 +438,8 @@ An Invoice Item's billing item, from which this item was generated. [category]: #category #### [category] This invoice item's "item category". -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -411,7 +449,8 @@ This invoice item's "item category". [children]: #children #### [children] An Invoice Item's child invoice items. Only parent invoice items have children. For instance, a server invoice item will have children. -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -421,7 +460,8 @@ An Invoice Item's child invoice items. Only parent invoice items have children. [filteredAssociatedChildren]: #filteredassociatedchildren #### [filteredAssociatedChildren] An Invoice Item's associated child invoice items, excluding some items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children. -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -431,7 +471,8 @@ An Invoice Item's associated child invoice items, excluding some items with a $0 [hourlyFlag]: #hourlyflag #### [hourlyFlag] Indicating whether this invoice item is billed on an hourly basis. -Type: **boolean** +Type: **boolean** + @@ -441,7 +482,8 @@ Indicating whether this invoice item is billed on an hourly basis. [invoice]: #invoice #### [invoice] The invoice to which this item belongs. -Type: **SoftLayer_Billing_Invoice ** +Type: **SoftLayer_Billing_Invoice ** + @@ -451,7 +493,8 @@ The invoice to which this item belongs. [location]: #location #### [location] An invoice item's location, if one exists.' -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -461,7 +504,8 @@ An invoice item's location, if one exists.' [nonZeroAssociatedChildren]: #nonzeroassociatedchildren #### [nonZeroAssociatedChildren] An Invoice Item's associated child invoice items, excluding ALL items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children. -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -471,7 +515,8 @@ An Invoice Item's associated child invoice items, excluding ALL items with a $0. [parent]: #parent #### [parent] Every item tied to a server should have a parent invoice item which is the server line item. This is how we associate items to a server. -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -481,7 +526,8 @@ Every item tied to a server should have a parent invoice item which is the serve [product]: #product #### [product] The entry in the product catalog that a invoice item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -491,7 +537,8 @@ The entry in the product catalog that a invoice item is based upon. [resource]: #resource #### [resource] The resource for a server invoice item. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -501,7 +548,8 @@ The resource for a server invoice item. [topLevelProductGroupName]: #toplevelproductgroupname #### [topLevelProductGroupName] A string representing the name of parent level product group of an invoice item. -Type: **string** +Type: **string** + @@ -511,7 +559,8 @@ A string representing the name of parent level product group of an invoice item. [totalOneTimeAmount]: #totalonetimeamount #### [totalOneTimeAmount] An invoice Item's total, including any child invoice items if they exist. -Type: **float** +Type: **float** + @@ -521,7 +570,8 @@ An invoice Item's total, including any child invoice items if they exist. [totalOneTimeTaxAmount]: #totalonetimetaxamount #### [totalOneTimeTaxAmount] An invoice Item's total, including any child invoice items if they exist. -Type: **float** +Type: **float** + @@ -531,7 +581,8 @@ An invoice Item's total, including any child invoice items if they exist. [totalRecurringAmount]: #totalrecurringamount #### [totalRecurringAmount] An invoice Item's total, including any child invoice items if they exist. -Type: **float** +Type: **float** + @@ -541,7 +592,8 @@ An invoice Item's total, including any child invoice items if they exist. [totalRecurringTaxAmount]: #totalrecurringtaxamount #### [totalRecurringTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -551,7 +603,8 @@ A Billing Item's total, including any child billing items if they exist.' [usageChargeFlag]: #usagechargeflag #### [usageChargeFlag] Indicating whether this invoice item is for the usage charge. -Type: **boolean** +Type: **boolean** + @@ -563,7 +616,8 @@ Indicating whether this invoice item is for the usage charge. [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of an Invoice Item's associated child invoice items. Only parent invoice items have associated children. For instance, a server invoice item may have associated children. -Type: **unsigned long** +Type: **unsigned long** + @@ -573,7 +627,8 @@ A count of an Invoice Item's associated child invoice items. Only parent invoice [childrenCount]: #childrencount #### [childrenCount] A count of an Invoice Item's child invoice items. Only parent invoice items have children. For instance, a server invoice item will have children. -Type: **unsigned long** +Type: **unsigned long** + @@ -583,7 +638,8 @@ A count of an Invoice Item's child invoice items. Only parent invoice items have [filteredAssociatedChildrenCount]: #filteredassociatedchildrencount #### [filteredAssociatedChildrenCount] A count of an Invoice Item's associated child invoice items, excluding some items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children. -Type: **unsigned long** +Type: **unsigned long** + @@ -593,7 +649,8 @@ A count of an Invoice Item's associated child invoice items, excluding some item [nonZeroAssociatedChildrenCount]: #nonzeroassociatedchildrencount #### [nonZeroAssociatedChildrenCount] A count of an Invoice Item's associated child invoice items, excluding ALL items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Invoice_Item_Tax_Info/_index.md b/content/reference/datatypes/SoftLayer_Billing_Invoice_Item_Tax_Info/_index.md index 66d2d03886..6f1e3021e4 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Invoice_Item_Tax_Info/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Invoice_Item_Tax_Info/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Information about the tax rates that apply to a particular invoice item. @@ -45,7 +47,8 @@ Information about the tax rates that apply to a particular invoice item. [createDate]: #createdate #### [createDate] The date and time the tax information was recorded. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The date and time the tax information was recorded. [description]: #description #### [description] The invoice description with special information about the invoice. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The invoice description with special information about the invoice. [effectiveTaxRate]: #effectivetaxrate #### [effectiveTaxRate] The tax rate that can be multiplied by the subtotal to get the -Type: **float** +Type: **float** + @@ -75,7 +80,8 @@ The tax rate that can be multiplied by the subtotal to get the [exemptAmount]: #exemptamount #### [exemptAmount] The amount that is exempt from tax. -Type: **float** +Type: **float** + @@ -85,7 +91,8 @@ The amount that is exempt from tax. [feeProperty]: #feeproperty #### [feeProperty] The type of fee being tracked for this particular set of tax information. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The type of fee being tracked for this particular set of tax information. [id]: #id #### [id] An invoice item's tax information internal identifier. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ An invoice item's tax information internal identifier. [invoiceItemId]: #invoiceitemid #### [invoiceItemId] A reference to the related invoice item. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A reference to the related invoice item. [invoiceTaxInfoId]: #invoicetaxinfoid #### [invoiceTaxInfoId] A reference to the tax information for the parent invoice. -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ A reference to the tax information for the parent invoice. [modifyDate]: #modifydate #### [modifyDate] The date and time the tax information was modified. -Type: **dateTime** +Type: **dateTime** + @@ -135,7 +146,8 @@ The date and time the tax information was modified. [nonTaxableBasis]: #nontaxablebasis #### [nonTaxableBasis] The amount that is exempt from tax. -Type: **float** +Type: **float** + @@ -145,7 +157,8 @@ The amount that is exempt from tax. [reportedFlag]: #reportedflag #### [reportedFlag] A flag to indicate whether this is the official record for this invoice item. -Type: **boolean** +Type: **boolean** + @@ -155,7 +168,8 @@ A flag to indicate whether this is the official record for this invoice item. [sellerRegistration]: #sellerregistration #### [sellerRegistration] The registration that the seller will use to report the invoice. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ The registration that the seller will use to report the invoice. [taxAmount]: #taxamount #### [taxAmount] The tax amount associated with this line item. -Type: **float** +Type: **float** + @@ -175,7 +190,8 @@ The tax amount associated with this line item. [taxAmountToCurrency]: #taxamounttocurrency #### [taxAmountToCurrency] The tax amount (converted to the 'to' currency) associated with this line item. -Type: **float** +Type: **float** + @@ -185,7 +201,8 @@ The tax amount (converted to the 'to' currency) associated with this line item. [taxRate]: #taxrate #### [taxRate] The tax rate used. Note that this might apply to only part of the -Type: **float** +Type: **float** + @@ -195,7 +212,8 @@ The tax rate used. Note that this might apply to only part of the [taxableBasis]: #taxablebasis #### [taxableBasis] The amount that is subject to tax. -Type: **float** +Type: **float** + @@ -205,7 +223,8 @@ The amount that is subject to tax. [toCurrencyId]: #tocurrencyid #### [toCurrencyId] The currency code that the invoice is being converted to. -Type: **integer** +Type: **integer** + @@ -221,7 +240,8 @@ The currency code that the invoice is being converted to. [invoiceItem]: #invoiceitem #### [invoiceItem] -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -231,7 +251,8 @@ The currency code that the invoice is being converted to. [invoiceTaxInfo]: #invoicetaxinfo #### [invoiceTaxInfo] -Type: **SoftLayer_Billing_Invoice_Tax_Info ** +Type: **SoftLayer_Billing_Invoice_Tax_Info ** + @@ -241,7 +262,8 @@ The currency code that the invoice is being converted to. [toCurrency]: #tocurrency #### [toCurrency] This is the currency the invoice will be converted to. -Type: **SoftLayer_Billing_Currency ** +Type: **SoftLayer_Billing_Currency ** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Invoice_Next/_index.md b/content/reference/datatypes/SoftLayer_Billing_Invoice_Next/_index.md index 539c9e1227..60ae35571d 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Invoice_Next/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Invoice_Next/_index.md @@ -24,6 +24,8 @@ classes: + +
      diff --git a/content/reference/datatypes/SoftLayer_Billing_Invoice_Receivable_Payment/_index.md b/content/reference/datatypes/SoftLayer_Billing_Invoice_Receivable_Payment/_index.md index 52bed693b2..89251af920 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Invoice_Receivable_Payment/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Invoice_Receivable_Payment/_index.md @@ -18,6 +18,8 @@ classes:
      ## Description + + The SoftLayer_Billing_Invoice_Receivable_Payment data type contains general information relating to payments made against invoices. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Invoice_Receivable_Payment data type contains general info [amount]: #amount #### [amount] The amount of the payment. -Type: **decimal** +Type: **decimal** +
      @@ -55,7 +58,8 @@ The amount of the payment. [createDate]: #createdate #### [createDate] The date of the payment. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The date of the payment. [invoiceId]: #invoiceid #### [invoiceId] The invoice that the payment is for. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The invoice that the payment is for. [typeCode]: #typecode #### [typeCode] The type of payment. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The type of payment. [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -101,7 +108,8 @@ The type of payment. [creditCardTransaction]: #creditcardtransaction #### [creditCardTransaction] -Type: **SoftLayer_Billing_Payment_Card_Transaction ** +Type: **SoftLayer_Billing_Payment_Card_Transaction ** + @@ -111,7 +119,8 @@ The type of payment. [exchangeRate]: #exchangerate #### [exchangeRate] -Type: **SoftLayer_Billing_Currency_ExchangeRate ** +Type: **SoftLayer_Billing_Currency_ExchangeRate ** + @@ -121,7 +130,8 @@ The type of payment. [invoice]: #invoice #### [invoice] -Type: **SoftLayer_Billing_Invoice ** +Type: **SoftLayer_Billing_Invoice ** + @@ -131,7 +141,8 @@ The type of payment. [paypalTransaction]: #paypaltransaction #### [paypalTransaction] -Type: **SoftLayer_Billing_Payment_PayPal_Transaction ** +Type: **SoftLayer_Billing_Payment_PayPal_Transaction ** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Invoice_Tax_Info/_index.md b/content/reference/datatypes/SoftLayer_Billing_Invoice_Tax_Info/_index.md index 62bfc55ada..b1e71f45ef 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Invoice_Tax_Info/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Invoice_Tax_Info/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Invoice tax information contains top-level information about the taxes recorded for a particular invoice. @@ -45,7 +47,8 @@ Invoice tax information contains top-level information about the taxes recorded [createDate]: #createdate #### [createDate] The date and time this tax information was recorded. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The date and time this tax information was recorded. [currencyId]: #currencyid #### [currencyId] The currency code that the invoice should be recorded in. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The currency code that the invoice should be recorded in. [id]: #id #### [id] The internal identifier for this invoice tax information. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The internal identifier for this invoice tax information. [invoiceId]: #invoiceid #### [invoiceId] A reference to the related invoice. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ A reference to the related invoice. [modifyDate]: #modifydate #### [modifyDate] The date and time this tax information was updated. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date and time this tax information was updated. [reportedFlag]: #reportedflag #### [reportedFlag] A flag to indicate whether the invoice will be auditable. -Type: **boolean** +Type: **boolean** + @@ -111,7 +119,8 @@ A flag to indicate whether the invoice will be auditable. [currency]: #currency #### [currency] This is the currency used for the invoice. -Type: **SoftLayer_Billing_Currency ** +Type: **SoftLayer_Billing_Currency ** + @@ -121,7 +130,8 @@ This is the currency used for the invoice. [functionalCurrency]: #functionalcurrency #### [functionalCurrency] This is the functional currency used for the invoice. -Type: **SoftLayer_Billing_Currency ** +Type: **SoftLayer_Billing_Currency ** + @@ -131,7 +141,8 @@ This is the functional currency used for the invoice. [invoice]: #invoice #### [invoice] This is the related invoice for this tax-related information. -Type: **SoftLayer_Billing_Invoice ** +Type: **SoftLayer_Billing_Invoice ** + @@ -141,7 +152,8 @@ This is the related invoice for this tax-related information. [itemWithCurrencyInfo]: #itemwithcurrencyinfo #### [itemWithCurrencyInfo] This tax information on the invoice item that includes currency details. -Type: **SoftLayer_Billing_Invoice_Item_Tax_Info ** +Type: **SoftLayer_Billing_Invoice_Item_Tax_Info ** + @@ -151,7 +163,8 @@ This tax information on the invoice item that includes currency details. [items]: #items #### [items] This is the collection of tax information for each of the related invoice items. -Type: **SoftLayer_Billing_Invoice_Item_Tax_Info[] ** +Type: **SoftLayer_Billing_Invoice_Item_Tax_Info[] ** + @@ -161,7 +174,8 @@ This is the collection of tax information for each of the related invoice items. [totalTaxAmountToCurrency]: #totaltaxamounttocurrency #### [totalTaxAmountToCurrency] This the total tax amount (converted to the 'to' currency) for the invoice. -Type: **float** +Type: **float** + @@ -173,7 +187,8 @@ This the total tax amount (converted to the 'to' currency) for the invoice. [itemCount]: #itemcount #### [itemCount] A count of this is the collection of tax information for each of the related invoice items. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Invoice_Tax_Status/_index.md b/content/reference/datatypes/SoftLayer_Billing_Invoice_Tax_Status/_index.md index 4a661a9fcd..5766a74c6f 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Invoice_Tax_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Invoice_Tax_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The invoice tax status data type models a single status or state that an invoice [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The invoice tax status data type models a single status or state that an invoice [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The invoice tax status data type models a single status or state that an invoice [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The invoice tax status data type models a single status or state that an invoice [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The invoice tax status data type models a single status or state that an invoice [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Invoice_Tax_Type/_index.md b/content/reference/datatypes/SoftLayer_Billing_Invoice_Tax_Type/_index.md index a03ae57494..4c7cb47349 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Invoice_Tax_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Invoice_Tax_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The invoice tax type data type models a single strategy for handling tax calculations. @@ -45,7 +47,8 @@ The invoice tax type data type models a single strategy for handling tax calcula [id]: #id #### [id] A tax type's internal identifier. Each type of tax calculation strategy has a unique ID value. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ A tax type's internal identifier. Each type of tax calculation strategy has a un [keyName]: #keyname #### [keyName] A unique string that identifies each strategy and is guaranteed to be stable over time. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ A unique string that identifies each strategy and is guaranteed to be stable ove [name]: #name #### [name] A human-readable label for each tax strategy. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item/_index.md index ac6415a44a..c3a92190a1 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) 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. @@ -61,7 +63,8 @@ Billing items exist in a tree relationship. Items are associated with each other [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -71,7 +74,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -81,7 +85,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -91,7 +96,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -101,7 +107,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -111,7 +118,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -121,7 +129,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -131,7 +140,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -141,7 +151,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -151,7 +162,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -161,7 +173,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -171,7 +184,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -181,7 +195,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -191,7 +206,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -201,7 +217,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -211,7 +228,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -221,7 +239,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -231,7 +250,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -241,7 +261,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -251,7 +272,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -261,7 +283,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -271,7 +294,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -281,7 +305,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -291,7 +316,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -301,7 +327,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -311,7 +338,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -321,7 +349,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -331,7 +360,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -341,7 +371,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -357,7 +388,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -367,7 +399,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -377,7 +410,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -387,7 +421,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -397,7 +432,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -407,7 +443,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -417,7 +454,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -427,7 +465,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -437,7 +476,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -447,7 +487,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -457,7 +498,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -467,7 +509,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -477,7 +520,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -487,7 +531,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -497,7 +542,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -507,7 +553,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -517,7 +564,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -527,7 +575,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -537,7 +586,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -547,7 +597,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -557,7 +608,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -567,7 +619,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -577,7 +630,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -587,7 +641,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -597,7 +652,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -607,7 +663,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -617,7 +674,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -627,7 +685,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -637,7 +696,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -647,7 +707,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -657,7 +718,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -667,7 +729,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -677,7 +740,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -687,7 +751,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -697,7 +762,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -707,7 +773,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -717,7 +784,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -727,7 +795,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -737,7 +806,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -747,7 +817,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -757,7 +828,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -767,7 +839,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -777,7 +850,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -787,7 +861,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -797,7 +872,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -807,7 +883,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -817,7 +894,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -827,7 +905,8 @@ Provisioning transaction for this billing item [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -837,7 +916,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -847,7 +927,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -859,7 +940,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -869,7 +951,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -879,7 +962,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -889,7 +973,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -899,7 +984,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -909,7 +995,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -919,7 +1006,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -929,7 +1017,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -939,7 +1028,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -949,7 +1039,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -959,7 +1050,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -969,7 +1061,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -979,7 +1072,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -989,7 +1083,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -999,7 +1094,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1009,7 +1105,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1019,7 +1116,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1029,7 +1127,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1039,7 +1138,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1049,7 +1149,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1059,7 +1160,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1069,7 +1171,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1079,7 +1182,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Account_Media_Data_Transfer_Request/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Account_Media_Data_Transfer_Request/_index.md index a0acc87b30..1ffb9eaadf 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Account_Media_Data_Transfer_Request/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Account_Media_Data_Transfer_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Account_Media_Data_Transfer_Request data type contain [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The data transfer request to which the billing item points. -Type: **SoftLayer_Account_Media_Data_Transfer_Request ** +Type: **SoftLayer_Account_Media_Data_Transfer_Request ** + @@ -821,7 +900,8 @@ The data transfer request to which the billing item points. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -831,7 +911,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -841,7 +922,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -853,7 +935,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Association_History/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Association_History/_index.md index f1e74b1275..928cc66c44 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Association_History/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Association_History/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) 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. @@ -57,7 +59,8 @@ The SoftLayer_Billing_Item_Association_History type keeps a record of which serv [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] The internal identifier of the server billing item that an orphaned billing item was associated with. -Type: **integer** +Type: **integer** + @@ -67,7 +70,8 @@ The internal identifier of the server billing item that an orphaned billing item [billingItemId]: #billingitemid #### [billingItemId] The internal identifier of the billing item that was associated with a server billing item. -Type: **integer** +Type: **integer** + @@ -77,7 +81,8 @@ The internal identifier of the billing item that was associated with a server bi [createDate]: #createdate #### [createDate] The date that a billing item association was last changed. -Type: **dateTime** +Type: **dateTime** + @@ -87,7 +92,8 @@ The date that a billing item association was last changed. [id]: #id #### [id] A billing item association history's internal identifier. -Type: **integer** +Type: **integer** + @@ -103,7 +109,8 @@ A billing item association history's internal identifier. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] The server billing item that an orphaned billing item was associated with. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -113,7 +120,8 @@ The server billing item that an orphaned billing item was associated with. [billingItem]: #billingitem #### [billingItem] The billing item that was associated with a server billing item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Reason/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Reason/_index.md index 5c3a7db931..af6daf0ca9 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Reason/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Reason/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Cancellation_Reason data type contains cancellation reasons. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Cancellation_Reason data type contains cancellation r [billingCancelReasonCategoryId]: #billingcancelreasoncategoryid #### [billingCancelReasonCategoryId] A cancel reason category internal identifier. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ A cancel reason category internal identifier. [id]: #id #### [id] A reason internal identifier. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A reason internal identifier. [keyName]: #keyname #### [keyName] A standardized reason internal identifier. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A standardized reason internal identifier. [reason]: #reason #### [reason] The descriptoin of the reason -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The descriptoin of the reason [billingCancellationReasonCategory]: #billingcancellationreasoncategory #### [billingCancellationReasonCategory] An billing cancellation reason category. -Type: **SoftLayer_Billing_Item_Cancellation_Reason_Category ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason_Category ** + @@ -101,7 +108,8 @@ An billing cancellation reason category. [billingItems]: #billingitems #### [billingItems] The corresponding billing items having the specific cancellation reason. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -111,7 +119,8 @@ The corresponding billing items having the specific cancellation reason. [translatedReason]: #translatedreason #### [translatedReason] -Type: **string** +Type: **string** + @@ -123,7 +132,8 @@ The corresponding billing items having the specific cancellation reason. [billingItemCount]: #billingitemcount #### [billingItemCount] A count of the corresponding billing items having the specific cancellation reason. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Reason_Category/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Reason_Category/_index.md index 28d0a20bc4..0b8374ca0c 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Reason_Category/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Reason_Category/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Cancellation_Reason_Category data type contains cancellation reason categories. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Cancellation_Reason_Category data type contains cance [id]: #id #### [id] A category internal identifier. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ A category internal identifier. [name]: #name #### [name] The description of the category -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ The description of the category [billingCancellationReasons]: #billingcancellationreasons #### [billingCancellationReasons] The corresponding billing cancellation reasons having the specific billing cancellation reason category. -Type: **SoftLayer_Billing_Item_Cancellation_Reason[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason[] ** + @@ -83,7 +88,8 @@ The corresponding billing cancellation reasons having the specific billing cance [billingCancellationReasonCount]: #billingcancellationreasoncount #### [billingCancellationReasonCount] A count of the corresponding billing cancellation reasons having the specific billing cancellation reason category. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Request/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Request/_index.md index 4d87612579..8811f0d4b6 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Request/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Billing_Item_Cancellation_Request data type is used to cancel service billing items. @@ -45,7 +47,8 @@ SoftLayer_Billing_Item_Cancellation_Request data type is used to cancel service [accountId]: #accountid #### [accountId] The internal identifier of the customer account that a service cancellation record belongs to. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of the customer account that a service cancellation reco [billingCancelReasonId]: #billingcancelreasonid #### [billingCancelReasonId] The last modified date. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The last modified date. [createDate]: #createdate #### [createDate] The date that a cancellation request was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date that a cancellation request was created. [id]: #id #### [id] A cancellation record's internal identifier. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ A cancellation record's internal identifier. [modifyDate]: #modifydate #### [modifyDate] The last modified date. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The last modified date. [notes]: #notes #### [notes] Brief cancellation note. -Type: **string** +Type: **string** + @@ -107,7 +115,8 @@ Brief cancellation note. An internal identifier of the service cancellation status that this request is associated with. When a service cancellation is submitted, it will be in "Pending" status until SoftLayer Sales team reviews it. The status of a cancellation request will be updated to "Approved" or "Voided" by SoftLayer Sales. It will be updated to "Complete" when all services are reclaimed. -Type: **integer** +Type: **integer** + @@ -117,7 +126,8 @@ It will be updated to "Complete" when all services are reclaimed. [ticketId]: #ticketid #### [ticketId] An internal identifier of the ticket that is associated with a service cancellation request. When a service cancellation is submitted, a support ticket will be created. This ticket contains details on your service cancellation details and SoftLayer Sales team will use it to further communicate with you. -Type: **integer** +Type: **integer** + @@ -133,7 +143,8 @@ An internal identifier of the ticket that is associated with a service cancellat [account]: #account #### [account] The SoftLayer account that a service cancellation request belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -143,7 +154,8 @@ The SoftLayer account that a service cancellation request belongs to. [items]: #items #### [items] A collection of service cancellation items. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item[] ** + @@ -153,7 +165,8 @@ A collection of service cancellation items. [status]: #status #### [status] The status of a service cancellation request. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Status ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Status ** + @@ -163,7 +176,8 @@ The status of a service cancellation request. [ticket]: #ticket #### [ticket] The ticket that is associated with the service cancellation request. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -173,7 +187,8 @@ The ticket that is associated with the service cancellation request. [user]: #user #### [user] The user that initiated a service cancellation request. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -185,7 +200,8 @@ The user that initiated a service cancellation request. [itemCount]: #itemcount #### [itemCount] A count of a collection of service cancellation items. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Request_Item/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Request_Item/_index.md index 8e8511c43e..f05e4b10d9 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Request_Item/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Request_Item/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ SoftLayer_Billing_Item_Cancellation_Request_Item data type contains a billing it [billingItemId]: #billingitemid #### [billingItemId] The internal identifier of a billing item -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of a billing item [cancellationRequestId]: #cancellationrequestid #### [cancellationRequestId] A cancellation request's internal identifier. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A cancellation request's internal identifier. [id]: #id #### [id] A cancellation request item's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A cancellation request item's internal identifier. [immediateCancellationFlag]: #immediatecancellationflag #### [immediateCancellationFlag] This flag indicated if a billing item should be canceled immediately or not. Set this flag to true when creating a cancellation request. -Type: **boolean** +Type: **boolean** + @@ -85,7 +91,8 @@ This flag indicated if a billing item should be canceled immediately or not. Se [scheduledCancellationDate]: #scheduledcancellationdate #### [scheduledCancellationDate] The scheduled cancellation date -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The scheduled cancellation date [serviceReclaimStatusCode]: #servicereclaimstatuscode #### [serviceReclaimStatusCode] The reclaim status of a service. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ The reclaim status of a service. [billingItem]: #billingitem #### [billingItem] The billing item for cancellation. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -121,7 +130,8 @@ The billing item for cancellation. [cancellationRequest]: #cancellationrequest #### [cancellationRequest] The service cancellation request that a cancellation item belongs to. -Type: **SoftLayer_Billing_Item_Cancellation_Request ** +Type: **SoftLayer_Billing_Item_Cancellation_Request ** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Request_Status/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Request_Status/_index.md index ff440389c1..41031e438d 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Request_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Cancellation_Request_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Billing_Item_Cancellation_Request_Status data type represents the status of a service cancellation request. @@ -45,7 +47,8 @@ SoftLayer_Billing_Item_Cancellation_Request_Status data type represents the stat [description]: #description #### [description] The short description of a cancellation request status -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The short description of a cancellation request status [id]: #id #### [id] The internal identifier of a cancellation request status. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The internal identifier of a cancellation request status. [keyName]: #keyname #### [keyName] status key name -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ status key name [name]: #name #### [name] The status name -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Ctc_Account/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Ctc_Account/_index.md index 5c502468ac..7c1552a51e 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Ctc_Account/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Ctc_Account/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Ctc_Account data type contains general information relating to a single SoftLayer billing item for a CTC client account creation @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Ctc_Account data type contains general information re [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -821,7 +900,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -831,7 +911,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -843,7 +924,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -853,7 +935,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Gateway_Appliance_Cluster/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Gateway_Appliance_Cluster/_index.md index 8876a8dab7..2ef425ab28 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Gateway_Appliance_Cluster/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Gateway_Appliance_Cluster/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Big_Data_Cluster data type contains general information relating to a single SoftLayer billing item for a big data cluster. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Big_Data_Cluster data type contains general informati [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The resource for a resource group billing item. -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -821,7 +900,8 @@ The resource for a resource group billing item. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -831,7 +911,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -841,7 +922,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -853,7 +935,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Hardware/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Hardware/_index.md index 277f3e92c8..b518997d0b 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Hardware/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Hardware/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Hardware data type contains general information relat [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [resourceTableId]: #resourcetableid #### [resourceTableId] The resource (unique identifier) for a server billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ The resource (unique identifier) for a server billing item. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -325,7 +355,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -335,7 +366,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -351,7 +383,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -381,7 +416,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -411,7 +449,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -421,7 +460,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -461,7 +504,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -471,7 +515,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -481,7 +526,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -511,7 +559,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -521,7 +570,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -531,7 +581,8 @@ A billing item's recurring child items that have once been billed and are schedu [billingCycleBandwidthUsage]: #billingcyclebandwidthusage #### [billingCycleBandwidthUsage] The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -541,7 +592,8 @@ The raw bandwidth usage data for the current billing cycle. One object will be r [billingCyclePrivateBandwidthUsage]: #billingcycleprivatebandwidthusage #### [billingCyclePrivateBandwidthUsage] The raw private bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -551,7 +603,8 @@ The raw private bandwidth usage data for the current billing cycle. [billingCyclePrivateUsageIn]: #billingcycleprivateusagein #### [billingCyclePrivateUsageIn] The total private inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -561,7 +614,8 @@ The total private inbound bandwidth for this hardware for the current billing cy [billingCyclePrivateUsageOut]: #billingcycleprivateusageout #### [billingCyclePrivateUsageOut] The total private outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -571,7 +625,8 @@ The total private outbound bandwidth for this hardware for the current billing c [billingCyclePrivateUsageTotal]: #billingcycleprivateusagetotal #### [billingCyclePrivateUsageTotal] The total private bandwidth for this hardware for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -581,7 +636,8 @@ The total private bandwidth for this hardware for the current billing cycle. [billingCyclePublicBandwidthUsage]: #billingcyclepublicbandwidthusage #### [billingCyclePublicBandwidthUsage] The raw public bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -591,7 +647,8 @@ The raw public bandwidth usage data for the current billing cycle. [billingCyclePublicUsageIn]: #billingcyclepublicusagein #### [billingCyclePublicUsageIn] The total public inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -601,7 +658,8 @@ The total public inbound bandwidth for this hardware for the current billing cyc [billingCyclePublicUsageOut]: #billingcyclepublicusageout #### [billingCyclePublicUsageOut] The total public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -611,7 +669,8 @@ The total public outbound bandwidth for this hardware for the current billing cy [billingCyclePublicUsageTotal]: #billingcyclepublicusagetotal #### [billingCyclePublicUsageTotal] The total public bandwidth for this hardware for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -621,7 +680,8 @@ The total public bandwidth for this hardware for the current billing cycle. [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -631,7 +691,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -641,7 +702,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -651,7 +713,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -661,7 +724,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -671,7 +735,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -681,7 +746,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -691,7 +757,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -701,7 +768,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -711,7 +779,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -721,7 +790,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -731,7 +801,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -741,7 +812,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -751,7 +823,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -761,7 +834,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -771,7 +845,8 @@ The location of the billing item. Some billing items have physical properties su [lockboxNetworkStorage]: #lockboxnetworkstorage #### [lockboxNetworkStorage] A lockbox account associated with a server. -Type: **SoftLayer_Billing_Item_Network_Storage ** +Type: **SoftLayer_Billing_Item_Network_Storage ** + @@ -781,7 +856,8 @@ A lockbox account associated with a server. [monitoringBillingItems]: #monitoringbillingitems #### [monitoringBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -791,7 +867,8 @@ A lockbox account associated with a server. [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -801,7 +878,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -811,7 +889,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -821,7 +900,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -831,7 +911,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -841,7 +922,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -851,7 +933,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -861,7 +944,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -871,7 +955,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -881,7 +966,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -891,7 +977,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -901,7 +988,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -911,7 +999,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -921,7 +1010,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -931,7 +1021,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The resource for a server billing item. -Type: **SoftLayer_Hardware_Server ** +Type: **SoftLayer_Hardware_Server ** + @@ -941,7 +1032,8 @@ The resource for a server billing item. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -951,7 +1043,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -961,7 +1054,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -973,7 +1067,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1188,8 @@ A count of a billing item's recurring child items that have once been billed and [billingCycleBandwidthUsageCount]: #billingcyclebandwidthusagecount #### [billingCycleBandwidthUsageCount] A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1093,7 +1199,8 @@ A count of the raw bandwidth usage data for the current billing cycle. One objec [billingCyclePrivateBandwidthUsageCount]: #billingcycleprivatebandwidthusagecount #### [billingCyclePrivateBandwidthUsageCount] A count of the raw private bandwidth usage data for the current billing cycle. -Type: **unsigned long** +Type: **unsigned long** + @@ -1103,7 +1210,8 @@ A count of the raw private bandwidth usage data for the current billing cycle. [billingCyclePublicBandwidthUsageCount]: #billingcyclepublicbandwidthusagecount #### [billingCyclePublicBandwidthUsageCount] A count of the raw public bandwidth usage data for the current billing cycle. -Type: **unsigned long** +Type: **unsigned long** + @@ -1113,7 +1221,8 @@ A count of the raw public bandwidth usage data for the current billing cycle. [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -1123,7 +1232,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1133,7 +1243,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1143,7 +1254,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1153,7 +1265,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1163,7 +1276,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1173,7 +1287,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1183,7 +1298,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1193,7 +1309,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1203,7 +1320,8 @@ A count of all invoice items associated with the billing item [monitoringBillingItemCount]: #monitoringbillingitemcount #### [monitoringBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1213,7 +1331,8 @@ A count of [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1223,7 +1342,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1233,7 +1353,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Hardware_Colocation/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Hardware_Colocation/_index.md index 467e24fb30..9263e16db8 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Hardware_Colocation/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Hardware_Colocation/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Hardware data type contains general information relat [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [resourceTableId]: #resourcetableid #### [resourceTableId] The resource (unique identifier) for a server billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ The resource (unique identifier) for a server billing item. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -325,7 +355,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -335,7 +366,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -351,7 +383,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -381,7 +416,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -411,7 +449,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -421,7 +460,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -461,7 +504,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -471,7 +515,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -481,7 +526,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -511,7 +559,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -521,7 +570,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -531,7 +581,8 @@ A billing item's recurring child items that have once been billed and are schedu [billingCycleBandwidthUsage]: #billingcyclebandwidthusage #### [billingCycleBandwidthUsage] The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -541,7 +592,8 @@ The raw bandwidth usage data for the current billing cycle. One object will be r [billingCyclePrivateBandwidthUsage]: #billingcycleprivatebandwidthusage #### [billingCyclePrivateBandwidthUsage] The raw private bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -551,7 +603,8 @@ The raw private bandwidth usage data for the current billing cycle. [billingCyclePrivateUsageIn]: #billingcycleprivateusagein #### [billingCyclePrivateUsageIn] The total private inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -561,7 +614,8 @@ The total private inbound bandwidth for this hardware for the current billing cy [billingCyclePrivateUsageOut]: #billingcycleprivateusageout #### [billingCyclePrivateUsageOut] The total private outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -571,7 +625,8 @@ The total private outbound bandwidth for this hardware for the current billing c [billingCyclePrivateUsageTotal]: #billingcycleprivateusagetotal #### [billingCyclePrivateUsageTotal] The total private bandwidth for this hardware for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -581,7 +636,8 @@ The total private bandwidth for this hardware for the current billing cycle. [billingCyclePublicBandwidthUsage]: #billingcyclepublicbandwidthusage #### [billingCyclePublicBandwidthUsage] The raw public bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -591,7 +647,8 @@ The raw public bandwidth usage data for the current billing cycle. [billingCyclePublicUsageIn]: #billingcyclepublicusagein #### [billingCyclePublicUsageIn] The total public inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -601,7 +658,8 @@ The total public inbound bandwidth for this hardware for the current billing cyc [billingCyclePublicUsageOut]: #billingcyclepublicusageout #### [billingCyclePublicUsageOut] The total public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -611,7 +669,8 @@ The total public outbound bandwidth for this hardware for the current billing cy [billingCyclePublicUsageTotal]: #billingcyclepublicusagetotal #### [billingCyclePublicUsageTotal] The total public bandwidth for this hardware for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -621,7 +680,8 @@ The total public bandwidth for this hardware for the current billing cycle. [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -631,7 +691,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -641,7 +702,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -651,7 +713,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -661,7 +724,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -671,7 +735,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -681,7 +746,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -691,7 +757,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -701,7 +768,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -711,7 +779,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -721,7 +790,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -731,7 +801,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -741,7 +812,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -751,7 +823,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -761,7 +834,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -771,7 +845,8 @@ The location of the billing item. Some billing items have physical properties su [lockboxNetworkStorage]: #lockboxnetworkstorage #### [lockboxNetworkStorage] A lockbox account associated with a server. -Type: **SoftLayer_Billing_Item_Network_Storage ** +Type: **SoftLayer_Billing_Item_Network_Storage ** + @@ -781,7 +856,8 @@ A lockbox account associated with a server. [monitoringBillingItems]: #monitoringbillingitems #### [monitoringBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -791,7 +867,8 @@ A lockbox account associated with a server. [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -801,7 +878,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -811,7 +889,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -821,7 +900,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -831,7 +911,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -841,7 +922,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -851,7 +933,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -861,7 +944,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -871,7 +955,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -881,7 +966,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -891,7 +977,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -901,7 +988,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -911,7 +999,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -921,7 +1010,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -931,7 +1021,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The resource for a server billing item. -Type: **SoftLayer_Hardware_Server ** +Type: **SoftLayer_Hardware_Server ** + @@ -941,7 +1032,8 @@ The resource for a server billing item. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -951,7 +1043,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -961,7 +1054,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -973,7 +1067,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1188,8 @@ A count of a billing item's recurring child items that have once been billed and [billingCycleBandwidthUsageCount]: #billingcyclebandwidthusagecount #### [billingCycleBandwidthUsageCount] A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1093,7 +1199,8 @@ A count of the raw bandwidth usage data for the current billing cycle. One objec [billingCyclePrivateBandwidthUsageCount]: #billingcycleprivatebandwidthusagecount #### [billingCyclePrivateBandwidthUsageCount] A count of the raw private bandwidth usage data for the current billing cycle. -Type: **unsigned long** +Type: **unsigned long** + @@ -1103,7 +1210,8 @@ A count of the raw private bandwidth usage data for the current billing cycle. [billingCyclePublicBandwidthUsageCount]: #billingcyclepublicbandwidthusagecount #### [billingCyclePublicBandwidthUsageCount] A count of the raw public bandwidth usage data for the current billing cycle. -Type: **unsigned long** +Type: **unsigned long** + @@ -1113,7 +1221,8 @@ A count of the raw public bandwidth usage data for the current billing cycle. [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -1123,7 +1232,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1133,7 +1243,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1143,7 +1254,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1153,7 +1265,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1163,7 +1276,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1173,7 +1287,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1183,7 +1298,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1193,7 +1309,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1203,7 +1320,8 @@ A count of all invoice items associated with the billing item [monitoringBillingItemCount]: #monitoringbillingitemcount #### [monitoringBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1213,7 +1331,8 @@ A count of [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1223,7 +1342,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1233,7 +1353,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Hardware_Component/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Hardware_Component/_index.md index 618997cd68..10aeda80bd 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Hardware_Component/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Hardware_Component/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware components. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Hardware data type contains general information relat [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [resourceTableId]: #resourcetableid #### [resourceTableId] The resource (unique identifier) for a server billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ The resource (unique identifier) for a server billing item. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -325,7 +355,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -335,7 +366,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -351,7 +383,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -381,7 +416,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -411,7 +449,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -421,7 +460,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -461,7 +504,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -471,7 +515,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -481,7 +526,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -511,7 +559,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -521,7 +570,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -531,7 +581,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -561,7 +614,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -571,7 +625,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -581,7 +636,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -591,7 +647,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -611,7 +669,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -621,7 +680,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -631,7 +691,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -641,7 +702,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -651,7 +713,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -661,7 +724,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -671,7 +735,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -681,7 +746,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -691,7 +757,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -731,7 +801,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -741,7 +812,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -751,7 +823,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -761,7 +834,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -771,7 +845,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -791,7 +867,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -801,7 +878,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -811,7 +889,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -821,7 +900,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The hardware component that this billing item points to. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -831,7 +911,8 @@ The hardware component that this billing item points to. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -841,7 +922,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -851,7 +933,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -863,7 +946,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1188,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [resourceCount]: #resourcecount #### [resourceCount] A count of the hardware component that this billing item points to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1093,7 +1199,8 @@ A count of the hardware component that this billing item points to. [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Hardware_Security_Module/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Hardware_Security_Module/_index.md index 6aa78a8797..b434cf5d35 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Hardware_Security_Module/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Hardware_Security_Module/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Hardware_Security_Module data type contains general information relating to a single SoftLayer billing item for a hardware security module. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Hardware_Security_Module data type contains general i [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [resourceTableId]: #resourcetableid #### [resourceTableId] The resource (unique identifier) for a server billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ The resource (unique identifier) for a server billing item. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -325,7 +355,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -335,7 +366,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -351,7 +383,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -381,7 +416,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -411,7 +449,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -421,7 +460,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -461,7 +504,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -471,7 +515,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -481,7 +526,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -511,7 +559,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -521,7 +570,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -531,7 +581,8 @@ A billing item's recurring child items that have once been billed and are schedu [billingCycleBandwidthUsage]: #billingcyclebandwidthusage #### [billingCycleBandwidthUsage] The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -541,7 +592,8 @@ The raw bandwidth usage data for the current billing cycle. One object will be r [billingCyclePrivateBandwidthUsage]: #billingcycleprivatebandwidthusage #### [billingCyclePrivateBandwidthUsage] The raw private bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -551,7 +603,8 @@ The raw private bandwidth usage data for the current billing cycle. [billingCyclePrivateUsageIn]: #billingcycleprivateusagein #### [billingCyclePrivateUsageIn] The total private inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -561,7 +614,8 @@ The total private inbound bandwidth for this hardware for the current billing cy [billingCyclePrivateUsageOut]: #billingcycleprivateusageout #### [billingCyclePrivateUsageOut] The total private outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -571,7 +625,8 @@ The total private outbound bandwidth for this hardware for the current billing c [billingCyclePrivateUsageTotal]: #billingcycleprivateusagetotal #### [billingCyclePrivateUsageTotal] The total private bandwidth for this hardware for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -581,7 +636,8 @@ The total private bandwidth for this hardware for the current billing cycle. [billingCyclePublicBandwidthUsage]: #billingcyclepublicbandwidthusage #### [billingCyclePublicBandwidthUsage] The raw public bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -591,7 +647,8 @@ The raw public bandwidth usage data for the current billing cycle. [billingCyclePublicUsageIn]: #billingcyclepublicusagein #### [billingCyclePublicUsageIn] The total public inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -601,7 +658,8 @@ The total public inbound bandwidth for this hardware for the current billing cyc [billingCyclePublicUsageOut]: #billingcyclepublicusageout #### [billingCyclePublicUsageOut] The total public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -611,7 +669,8 @@ The total public outbound bandwidth for this hardware for the current billing cy [billingCyclePublicUsageTotal]: #billingcyclepublicusagetotal #### [billingCyclePublicUsageTotal] The total public bandwidth for this hardware for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -621,7 +680,8 @@ The total public bandwidth for this hardware for the current billing cycle. [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -631,7 +691,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -641,7 +702,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -651,7 +713,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -661,7 +724,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -671,7 +735,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -681,7 +746,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -691,7 +757,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -701,7 +768,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -711,7 +779,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -721,7 +790,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -731,7 +801,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -741,7 +812,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -751,7 +823,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -761,7 +834,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -771,7 +845,8 @@ The location of the billing item. Some billing items have physical properties su [lockboxNetworkStorage]: #lockboxnetworkstorage #### [lockboxNetworkStorage] A lockbox account associated with a server. -Type: **SoftLayer_Billing_Item_Network_Storage ** +Type: **SoftLayer_Billing_Item_Network_Storage ** + @@ -781,7 +856,8 @@ A lockbox account associated with a server. [monitoringBillingItems]: #monitoringbillingitems #### [monitoringBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -791,7 +867,8 @@ A lockbox account associated with a server. [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -801,7 +878,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -811,7 +889,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -821,7 +900,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -831,7 +911,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -841,7 +922,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -851,7 +933,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -861,7 +944,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -871,7 +955,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -881,7 +966,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -891,7 +977,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -901,7 +988,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -911,7 +999,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -921,7 +1010,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -931,7 +1021,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The resource for a hardware security module billing item. -Type: **SoftLayer_Hardware_SecurityModule ** +Type: **SoftLayer_Hardware_SecurityModule ** + @@ -941,7 +1032,8 @@ The resource for a hardware security module billing item. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -951,7 +1043,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -961,7 +1054,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -973,7 +1067,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1188,8 @@ A count of a billing item's recurring child items that have once been billed and [billingCycleBandwidthUsageCount]: #billingcyclebandwidthusagecount #### [billingCycleBandwidthUsageCount] A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1093,7 +1199,8 @@ A count of the raw bandwidth usage data for the current billing cycle. One objec [billingCyclePrivateBandwidthUsageCount]: #billingcycleprivatebandwidthusagecount #### [billingCyclePrivateBandwidthUsageCount] A count of the raw private bandwidth usage data for the current billing cycle. -Type: **unsigned long** +Type: **unsigned long** + @@ -1103,7 +1210,8 @@ A count of the raw private bandwidth usage data for the current billing cycle. [billingCyclePublicBandwidthUsageCount]: #billingcyclepublicbandwidthusagecount #### [billingCyclePublicBandwidthUsageCount] A count of the raw public bandwidth usage data for the current billing cycle. -Type: **unsigned long** +Type: **unsigned long** + @@ -1113,7 +1221,8 @@ A count of the raw public bandwidth usage data for the current billing cycle. [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -1123,7 +1232,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1133,7 +1243,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1143,7 +1254,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1153,7 +1265,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1163,7 +1276,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1173,7 +1287,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1183,7 +1298,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1193,7 +1309,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1203,7 +1320,8 @@ A count of all invoice items associated with the billing item [monitoringBillingItemCount]: #monitoringbillingitemcount #### [monitoringBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1213,7 +1331,8 @@ A count of [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1223,7 +1342,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1233,7 +1353,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Hardware_Server/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Hardware_Server/_index.md index 9d437b1b15..733b6d1950 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Hardware_Server/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Hardware_Server/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Hardware_Server data type contains billing information about a bare metal server and its relationship to a particular customer account. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Hardware_Server data type contains billing informatio [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [resourceTableId]: #resourcetableid #### [resourceTableId] The resource (unique identifier) for a server billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ The resource (unique identifier) for a server billing item. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -325,7 +355,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -335,7 +366,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -351,7 +383,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -381,7 +416,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -411,7 +449,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -421,7 +460,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -461,7 +504,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -471,7 +515,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -481,7 +526,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -511,7 +559,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -521,7 +570,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -531,7 +581,8 @@ A billing item's recurring child items that have once been billed and are schedu [billingCycleBandwidthUsage]: #billingcyclebandwidthusage #### [billingCycleBandwidthUsage] The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -541,7 +592,8 @@ The raw bandwidth usage data for the current billing cycle. One object will be r [billingCyclePrivateBandwidthUsage]: #billingcycleprivatebandwidthusage #### [billingCyclePrivateBandwidthUsage] The raw private bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -551,7 +603,8 @@ The raw private bandwidth usage data for the current billing cycle. [billingCyclePrivateUsageIn]: #billingcycleprivateusagein #### [billingCyclePrivateUsageIn] The total private inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -561,7 +614,8 @@ The total private inbound bandwidth for this hardware for the current billing cy [billingCyclePrivateUsageOut]: #billingcycleprivateusageout #### [billingCyclePrivateUsageOut] The total private outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -571,7 +625,8 @@ The total private outbound bandwidth for this hardware for the current billing c [billingCyclePrivateUsageTotal]: #billingcycleprivateusagetotal #### [billingCyclePrivateUsageTotal] The total private bandwidth for this hardware for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -581,7 +636,8 @@ The total private bandwidth for this hardware for the current billing cycle. [billingCyclePublicBandwidthUsage]: #billingcyclepublicbandwidthusage #### [billingCyclePublicBandwidthUsage] The raw public bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -591,7 +647,8 @@ The raw public bandwidth usage data for the current billing cycle. [billingCyclePublicUsageIn]: #billingcyclepublicusagein #### [billingCyclePublicUsageIn] The total public inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -601,7 +658,8 @@ The total public inbound bandwidth for this hardware for the current billing cyc [billingCyclePublicUsageOut]: #billingcyclepublicusageout #### [billingCyclePublicUsageOut] The total public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -611,7 +669,8 @@ The total public outbound bandwidth for this hardware for the current billing cy [billingCyclePublicUsageTotal]: #billingcyclepublicusagetotal #### [billingCyclePublicUsageTotal] The total public bandwidth for this hardware for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -621,7 +680,8 @@ The total public bandwidth for this hardware for the current billing cycle. [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -631,7 +691,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -641,7 +702,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -651,7 +713,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -661,7 +724,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -671,7 +735,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -681,7 +746,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -691,7 +757,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -701,7 +768,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -711,7 +779,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -721,7 +790,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -731,7 +801,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -741,7 +812,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -751,7 +823,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -761,7 +834,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -771,7 +845,8 @@ The location of the billing item. Some billing items have physical properties su [lockboxNetworkStorage]: #lockboxnetworkstorage #### [lockboxNetworkStorage] A lockbox account associated with a server. -Type: **SoftLayer_Billing_Item_Network_Storage ** +Type: **SoftLayer_Billing_Item_Network_Storage ** + @@ -781,7 +856,8 @@ A lockbox account associated with a server. [monitoringBillingItems]: #monitoringbillingitems #### [monitoringBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -791,7 +867,8 @@ A lockbox account associated with a server. [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -801,7 +878,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -811,7 +889,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -821,7 +900,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -831,7 +911,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -841,7 +922,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -851,7 +933,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -861,7 +944,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -871,7 +955,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -881,7 +966,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -891,7 +977,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -901,7 +988,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -911,7 +999,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -921,7 +1010,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -931,7 +1021,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The resource for a server billing item. -Type: **SoftLayer_Hardware_Server ** +Type: **SoftLayer_Hardware_Server ** + @@ -941,7 +1032,8 @@ The resource for a server billing item. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -951,7 +1043,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -961,7 +1054,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -973,7 +1067,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1188,8 @@ A count of a billing item's recurring child items that have once been billed and [billingCycleBandwidthUsageCount]: #billingcyclebandwidthusagecount #### [billingCycleBandwidthUsageCount] A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1093,7 +1199,8 @@ A count of the raw bandwidth usage data for the current billing cycle. One objec [billingCyclePrivateBandwidthUsageCount]: #billingcycleprivatebandwidthusagecount #### [billingCyclePrivateBandwidthUsageCount] A count of the raw private bandwidth usage data for the current billing cycle. -Type: **unsigned long** +Type: **unsigned long** + @@ -1103,7 +1210,8 @@ A count of the raw private bandwidth usage data for the current billing cycle. [billingCyclePublicBandwidthUsageCount]: #billingcyclepublicbandwidthusagecount #### [billingCyclePublicBandwidthUsageCount] A count of the raw public bandwidth usage data for the current billing cycle. -Type: **unsigned long** +Type: **unsigned long** + @@ -1113,7 +1221,8 @@ A count of the raw public bandwidth usage data for the current billing cycle. [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -1123,7 +1232,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1133,7 +1243,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1143,7 +1254,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1153,7 +1265,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1163,7 +1276,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1173,7 +1287,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1183,7 +1298,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1193,7 +1309,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1203,7 +1320,8 @@ A count of all invoice items associated with the billing item [monitoringBillingItemCount]: #monitoringbillingitemcount #### [monitoringBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1213,7 +1331,8 @@ A count of [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1223,7 +1342,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1233,7 +1353,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Application_Delivery_Controller/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Application_Delivery_Controller/_index.md index 9188e238b3..cd483c1dc0 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Application_Delivery_Controller/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Application_Delivery_Controller/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Network_Application_Delivery_Controller data type describes the billing item related to a NetScaler VPX @@ -53,7 +55,8 @@ The SoftLayer_Billing_Item_Network_Application_Delivery_Controller data type des [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -63,7 +66,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -73,7 +77,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -83,7 +88,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -93,7 +99,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -103,7 +110,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -113,7 +121,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -123,7 +132,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -133,7 +143,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -143,7 +154,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -153,7 +165,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -163,7 +176,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -173,7 +187,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -183,7 +198,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -193,7 +209,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -203,7 +220,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -213,7 +231,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -223,7 +242,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -233,7 +253,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -243,7 +264,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -253,7 +275,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -263,7 +286,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -273,7 +297,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -283,7 +308,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -293,7 +319,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -303,7 +330,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -313,7 +341,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -323,7 +352,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -349,7 +380,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -359,7 +391,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -369,7 +402,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -379,7 +413,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -389,7 +424,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -399,7 +435,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -409,7 +446,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -419,7 +457,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -429,7 +468,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -439,7 +479,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -449,7 +490,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -459,7 +501,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -469,7 +512,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -479,7 +523,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -489,7 +534,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -499,7 +545,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -509,7 +556,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -519,7 +567,8 @@ The bandwidth allocation for a billing item. [bandwidthAllotmentDetail]: #bandwidthallotmentdetail #### [bandwidthAllotmentDetail] The bandwidth allotment detail for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** + @@ -529,7 +578,8 @@ The bandwidth allotment detail for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -539,7 +589,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -549,7 +600,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -559,7 +611,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -569,7 +622,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -579,7 +633,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -589,7 +644,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -599,7 +655,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -609,7 +666,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -619,7 +677,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -629,7 +688,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -639,7 +699,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -649,7 +710,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -659,7 +721,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -669,7 +732,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -679,7 +743,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -689,7 +754,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -699,7 +765,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -709,7 +776,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -719,7 +787,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -729,7 +798,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -739,7 +809,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -749,7 +820,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -759,7 +831,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -769,7 +842,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -779,7 +853,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -789,7 +864,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -799,7 +875,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -809,7 +886,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -819,7 +897,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -829,7 +908,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The network application controller that a billing item is associated with. -Type: **SoftLayer_Network_Application_Delivery_Controller ** +Type: **SoftLayer_Network_Application_Delivery_Controller ** + @@ -839,7 +919,8 @@ The network application controller that a billing item is associated with. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -849,7 +930,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -859,7 +941,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -871,7 +954,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -881,7 +965,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -891,7 +976,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -901,7 +987,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -911,7 +998,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -921,7 +1009,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -931,7 +1020,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -941,7 +1031,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -951,7 +1042,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -961,7 +1053,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -971,7 +1064,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -981,7 +1075,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -991,7 +1086,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1001,7 +1097,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1011,7 +1108,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1021,7 +1119,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1031,7 +1130,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1041,7 +1141,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1051,7 +1152,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1061,7 +1163,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1071,7 +1174,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1081,7 +1185,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1091,7 +1196,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/_index.md index bc431fadeb..5aeae773b7 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer represents the [SoftLayer_Billing_Item]({{}}) instance. @@ -53,7 +55,8 @@ A SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer re [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -63,7 +66,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -73,7 +77,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -83,7 +88,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -93,7 +99,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -103,7 +110,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -113,7 +121,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -123,7 +132,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -133,7 +143,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -143,7 +154,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -153,7 +165,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -163,7 +176,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -173,7 +187,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -183,7 +198,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -193,7 +209,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -203,7 +220,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -213,7 +231,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -223,7 +242,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -233,7 +253,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -243,7 +264,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -253,7 +275,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -263,7 +286,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -273,7 +297,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -283,7 +308,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -293,7 +319,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -303,7 +330,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -313,7 +341,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -323,7 +352,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -349,7 +380,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -359,7 +391,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -369,7 +402,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -379,7 +413,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -389,7 +424,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -399,7 +435,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -409,7 +446,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -419,7 +457,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -429,7 +468,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -439,7 +479,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -449,7 +490,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -459,7 +501,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -469,7 +512,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -479,7 +523,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -489,7 +534,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -499,7 +545,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -509,7 +556,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -519,7 +567,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -529,7 +578,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -539,7 +589,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -549,7 +600,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -559,7 +611,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -569,7 +622,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -579,7 +633,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -589,7 +644,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -599,7 +655,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -609,7 +666,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -619,7 +677,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -629,7 +688,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -639,7 +699,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -649,7 +710,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -659,7 +721,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -669,7 +732,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -679,7 +743,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -689,7 +754,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -699,7 +765,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -709,7 +776,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -719,7 +787,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -729,7 +798,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -739,7 +809,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -749,7 +820,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -759,7 +831,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -769,7 +842,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -779,7 +853,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -789,7 +864,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -799,7 +875,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -809,7 +886,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -819,7 +897,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The load balancer that a load balancer billing item is associated with. -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress ** + @@ -829,7 +908,8 @@ The load balancer that a load balancer billing item is associated with. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -839,7 +919,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -849,7 +930,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -861,7 +943,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -871,7 +954,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -881,7 +965,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -891,7 +976,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -901,7 +987,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -911,7 +998,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -921,7 +1009,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -931,7 +1020,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -941,7 +1031,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -951,7 +1042,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -961,7 +1053,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -971,7 +1064,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -981,7 +1075,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -991,7 +1086,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1001,7 +1097,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1011,7 +1108,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1021,7 +1119,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1031,7 +1130,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1041,7 +1141,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1051,7 +1152,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1061,7 +1163,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1071,7 +1174,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1081,7 +1185,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Bandwidth/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Bandwidth/_index.md index e94248d172..ccbdad62e8 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Bandwidth/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Bandwidth/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Hardware data type contains general information relat [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -821,7 +900,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -831,7 +911,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -843,7 +924,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -853,7 +935,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Firewall/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Firewall/_index.md index f2c82fcd45..41d298511d 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Firewall/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Firewall/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Network_Firewall data type contains general information relating to a single SoftLayer billing item whose item category code is 'firewall' @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Network_Firewall data type contains general informati [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The VLAN firewall that a VLAN firewall billing item is associated with. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -821,7 +900,8 @@ The VLAN firewall that a VLAN firewall billing item is associated with. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -831,7 +911,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -841,7 +922,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -853,7 +935,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Firewall_Module_Context/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Firewall_Module_Context/_index.md index 7dac716258..a778df4f86 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Firewall_Module_Context/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Firewall_Module_Context/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Network_Firewall_Module_Context data type describes the billing items related to VLAN Firewalls. @@ -53,7 +55,8 @@ The SoftLayer_Billing_Item_Network_Firewall_Module_Context data type describes t [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -63,7 +66,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -73,7 +77,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -83,7 +88,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -93,7 +99,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -103,7 +110,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -113,7 +121,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -123,7 +132,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -133,7 +143,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -143,7 +154,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -153,7 +165,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -163,7 +176,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -173,7 +187,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -183,7 +198,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -193,7 +209,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -203,7 +220,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -213,7 +231,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -223,7 +242,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -233,7 +253,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -243,7 +264,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -253,7 +275,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -263,7 +286,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -273,7 +297,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -283,7 +308,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -293,7 +319,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -303,7 +330,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -313,7 +341,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -323,7 +352,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -349,7 +380,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -359,7 +391,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -369,7 +402,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -379,7 +413,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -389,7 +424,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -399,7 +435,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -409,7 +446,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -419,7 +457,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -429,7 +468,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -439,7 +479,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -449,7 +490,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -459,7 +501,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -469,7 +512,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -479,7 +523,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -489,7 +534,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -499,7 +545,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -509,7 +556,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -519,7 +567,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -529,7 +578,8 @@ A billing item's recurring child items that have once been billed and are schedu [billingCyclePublicUsageOut]: #billingcyclepublicusageout #### [billingCyclePublicUsageOut] The total public outbound bandwidth for this firewall for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -539,7 +589,8 @@ The total public outbound bandwidth for this firewall for the current billing cy [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -549,7 +600,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -559,7 +611,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -569,7 +622,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -579,7 +633,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -589,7 +644,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -599,7 +655,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -609,7 +666,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -619,7 +677,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -629,7 +688,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -639,7 +699,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -649,7 +710,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -659,7 +721,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -669,7 +732,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -679,7 +743,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -689,7 +754,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -699,7 +765,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -709,7 +776,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -719,7 +787,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -729,7 +798,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -739,7 +809,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -749,7 +820,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -759,7 +831,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -769,7 +842,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -779,7 +853,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -789,7 +864,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -799,7 +875,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -809,7 +886,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -819,7 +897,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -829,7 +908,8 @@ Provisioning transaction for this billing item [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -839,7 +919,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -849,7 +930,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -861,7 +943,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -871,7 +954,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -881,7 +965,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -891,7 +976,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -901,7 +987,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -911,7 +998,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -921,7 +1009,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -931,7 +1020,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -941,7 +1031,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -951,7 +1042,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -961,7 +1053,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -971,7 +1064,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -981,7 +1075,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -991,7 +1086,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1001,7 +1097,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1011,7 +1108,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1021,7 +1119,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1031,7 +1130,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1041,7 +1141,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1051,7 +1152,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1061,7 +1163,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1071,7 +1174,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1081,7 +1185,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Interconnect/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Interconnect/_index.md index c42c78c97d..e47118eccd 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Interconnect/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Interconnect/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A SoftLayer_Billing_Item_Network_Interconnect represents the [SoftLayer_Billing_Item]({{}}) related to a network interconnect instance. @@ -50,7 +52,8 @@ A SoftLayer_Billing_Item_Network_Interconnect represents the [SoftLayer_Billing_ [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -80,7 +85,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -100,7 +107,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -110,7 +118,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -120,7 +129,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -130,7 +140,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -140,7 +151,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -150,7 +162,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -160,7 +173,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -170,7 +184,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -180,7 +195,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -190,7 +206,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -200,7 +217,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -210,7 +228,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -220,7 +239,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -230,7 +250,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -240,7 +261,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -250,7 +272,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -260,7 +283,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -270,7 +294,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -280,7 +305,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -290,7 +316,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -300,7 +327,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -310,7 +338,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -320,7 +349,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -330,7 +360,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -346,7 +377,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -356,7 +388,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -366,7 +399,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -376,7 +410,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -386,7 +421,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -396,7 +432,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -406,7 +443,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -416,7 +454,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -426,7 +465,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -436,7 +476,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -446,7 +487,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -456,7 +498,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -466,7 +509,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -476,7 +520,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -486,7 +531,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -496,7 +542,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -506,7 +553,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -516,7 +564,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -526,7 +575,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -536,7 +586,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -546,7 +597,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -556,7 +608,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -566,7 +619,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -576,7 +630,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -586,7 +641,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -596,7 +652,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -606,7 +663,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -616,7 +674,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -626,7 +685,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -636,7 +696,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -646,7 +707,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -656,7 +718,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -666,7 +729,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -676,7 +740,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -686,7 +751,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -696,7 +762,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -706,7 +773,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -716,7 +784,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -726,7 +795,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -736,7 +806,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -746,7 +817,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -756,7 +828,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -766,7 +839,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -776,7 +850,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -786,7 +861,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -796,7 +872,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -806,7 +883,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -816,7 +894,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The interconnect tenant that the billing item is associated with. -Type: **SoftLayer_Network_Interconnect_Tenant ** +Type: **SoftLayer_Network_Interconnect_Tenant ** + @@ -826,7 +905,8 @@ The interconnect tenant that the billing item is associated with. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -836,7 +916,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -846,7 +927,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -858,7 +940,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -868,7 +951,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -878,7 +962,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -888,7 +973,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -898,7 +984,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -908,7 +995,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -918,7 +1006,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -928,7 +1017,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -938,7 +1028,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -948,7 +1039,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -958,7 +1050,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -968,7 +1061,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -978,7 +1072,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -988,7 +1083,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -998,7 +1094,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1008,7 +1105,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1018,7 +1116,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1028,7 +1127,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1038,7 +1138,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1048,7 +1149,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1058,7 +1160,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1068,7 +1171,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1078,7 +1182,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Interconnect_Routing/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Interconnect_Routing/_index.md index 499bf7ef11..72124eba28 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Interconnect_Routing/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Interconnect_Routing/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A SoftLayer_Billing_Item_Network_Interconnect_Routing represents the [SoftLayer_Billing_Item]({{}}) related to a network interconnect global routing. @@ -50,7 +52,8 @@ A SoftLayer_Billing_Item_Network_Interconnect_Routing represents the [SoftLayer_ [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -80,7 +85,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -100,7 +107,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -110,7 +118,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -120,7 +129,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -130,7 +140,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -140,7 +151,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -150,7 +162,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -160,7 +173,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -170,7 +184,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -180,7 +195,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -190,7 +206,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -200,7 +217,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -210,7 +228,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -220,7 +239,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -230,7 +250,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -240,7 +261,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -250,7 +272,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -260,7 +283,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -270,7 +294,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -280,7 +305,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -290,7 +316,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -300,7 +327,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -310,7 +338,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -320,7 +349,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -330,7 +360,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -346,7 +377,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -356,7 +388,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -366,7 +399,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -376,7 +410,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -386,7 +421,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -396,7 +432,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -406,7 +443,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -416,7 +454,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -426,7 +465,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -436,7 +476,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -446,7 +487,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -456,7 +498,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -466,7 +509,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -476,7 +520,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -486,7 +531,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -496,7 +542,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -506,7 +553,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -516,7 +564,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -526,7 +575,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -536,7 +586,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -546,7 +597,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -556,7 +608,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -566,7 +619,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -576,7 +630,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -586,7 +641,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -596,7 +652,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -606,7 +663,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -616,7 +674,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -626,7 +685,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -636,7 +696,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -646,7 +707,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -656,7 +718,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -666,7 +729,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -676,7 +740,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -686,7 +751,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -696,7 +762,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -706,7 +773,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -716,7 +784,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -726,7 +795,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -736,7 +806,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -746,7 +817,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -756,7 +828,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -766,7 +839,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -776,7 +850,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -786,7 +861,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -796,7 +872,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -806,7 +883,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -816,7 +894,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The interconnect tenant that the billing item is associated with. -Type: **SoftLayer_Network_Interconnect_Tenant ** +Type: **SoftLayer_Network_Interconnect_Tenant ** + @@ -826,7 +905,8 @@ The interconnect tenant that the billing item is associated with. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -836,7 +916,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -846,7 +927,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -858,7 +940,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -868,7 +951,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -878,7 +962,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -888,7 +973,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -898,7 +984,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -908,7 +995,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -918,7 +1006,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -928,7 +1017,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -938,7 +1028,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -948,7 +1039,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -958,7 +1050,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -968,7 +1061,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -978,7 +1072,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -988,7 +1083,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -998,7 +1094,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1008,7 +1105,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1018,7 +1116,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1028,7 +1127,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1038,7 +1138,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1048,7 +1149,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1058,7 +1160,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1068,7 +1171,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1078,7 +1182,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer/_index.md index 0717d23c5b..bc1009c413 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A SoftLayer_Billing_Item_Network_LoadBalancer represents the [SoftLayer_Billing_Item]({{}}) instance. @@ -53,7 +55,8 @@ A SoftLayer_Billing_Item_Network_LoadBalancer represents the [SoftLayer_Billing_ [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -63,7 +66,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -73,7 +77,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -83,7 +88,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -93,7 +99,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -103,7 +110,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -113,7 +121,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -123,7 +132,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -133,7 +143,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -143,7 +154,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -153,7 +165,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -163,7 +176,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -173,7 +187,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -183,7 +198,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -193,7 +209,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -203,7 +220,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -213,7 +231,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -223,7 +242,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -233,7 +253,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -243,7 +264,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -253,7 +275,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -263,7 +286,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -273,7 +297,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -283,7 +308,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -293,7 +319,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -303,7 +330,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -313,7 +341,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -323,7 +352,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -349,7 +380,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -359,7 +391,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -369,7 +402,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -379,7 +413,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -389,7 +424,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -399,7 +435,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -409,7 +446,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -419,7 +457,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -429,7 +468,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -439,7 +479,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -449,7 +490,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -459,7 +501,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -469,7 +512,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -479,7 +523,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -489,7 +534,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -499,7 +545,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -509,7 +556,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -519,7 +567,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -529,7 +578,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -539,7 +589,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -549,7 +600,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -559,7 +611,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -569,7 +622,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -579,7 +633,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -589,7 +644,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -599,7 +655,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -609,7 +666,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -619,7 +677,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -629,7 +688,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -639,7 +699,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -649,7 +710,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -659,7 +721,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -669,7 +732,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -679,7 +743,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -689,7 +754,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -699,7 +765,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -709,7 +776,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -719,7 +787,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -729,7 +798,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -739,7 +809,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -749,7 +820,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -759,7 +831,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -769,7 +842,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -779,7 +853,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -789,7 +864,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -799,7 +875,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -809,7 +886,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -819,7 +897,8 @@ Provisioning transaction for this billing item [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -829,7 +908,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -839,7 +919,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -851,7 +932,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -861,7 +943,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -871,7 +954,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -881,7 +965,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -891,7 +976,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -901,7 +987,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -911,7 +998,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -921,7 +1009,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -931,7 +1020,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -941,7 +1031,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -951,7 +1042,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -961,7 +1053,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -971,7 +1064,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -981,7 +1075,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -991,7 +1086,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1001,7 +1097,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1011,7 +1108,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1021,7 +1119,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1031,7 +1130,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1041,7 +1141,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1051,7 +1152,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1061,7 +1163,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1071,7 +1174,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_Global/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_Global/_index.md index e618584ac8..6abeb34a85 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_Global/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_Global/_index.md @@ -20,6 +20,9 @@ classes: ## Description + +
      Deprecated
      + The global load balancer service has been deprecated and is no longer available. The SoftLayer_Billing_Item_Network_LoadBalancer_Global data type contains general information relating to a single SoftLayer billing item whose item category code is 'global_load_balancer' @@ -49,7 +52,8 @@ The SoftLayer_Billing_Item_Network_LoadBalancer_Global data type contains genera [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -59,7 +63,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -69,7 +74,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -79,7 +85,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -89,7 +96,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -99,7 +107,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -109,7 +118,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -119,7 +129,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -129,7 +140,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -139,7 +151,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -149,7 +162,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -159,7 +173,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -169,7 +184,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -179,7 +195,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -189,7 +206,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -199,7 +217,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -209,7 +228,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -219,7 +239,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -229,7 +250,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -239,7 +261,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -249,7 +272,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -259,7 +283,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -269,7 +294,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -279,7 +305,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -289,7 +316,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -299,7 +327,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -309,7 +338,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -319,7 +349,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -329,7 +360,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -345,7 +377,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -355,7 +388,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -365,7 +399,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -375,7 +410,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -385,7 +421,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -395,7 +432,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -405,7 +443,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -415,7 +454,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -425,7 +465,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -435,7 +476,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -445,7 +487,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -455,7 +498,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -465,7 +509,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -475,7 +520,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -485,7 +531,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -495,7 +542,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -505,7 +553,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -515,7 +564,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -525,7 +575,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -535,7 +586,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -545,7 +597,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -555,7 +608,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -565,7 +619,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -575,7 +630,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -585,7 +641,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -595,7 +652,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -605,7 +663,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -615,7 +674,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -625,7 +685,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -635,7 +696,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -645,7 +707,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -655,7 +718,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -665,7 +729,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -675,7 +740,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -685,7 +751,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -695,7 +762,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -705,7 +773,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -715,7 +784,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -725,7 +795,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -735,7 +806,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -745,7 +817,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -755,7 +828,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -765,7 +839,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -775,7 +850,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -785,7 +861,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -795,7 +872,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -805,7 +883,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -815,7 +894,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The resource for a global load balancer billing item. -Type: **SoftLayer_Network_LoadBalancer_Global_Account ** +Type: **SoftLayer_Network_LoadBalancer_Global_Account ** + @@ -825,7 +905,8 @@ The resource for a global load balancer billing item. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -835,7 +916,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -845,7 +927,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -857,7 +940,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -867,7 +951,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -877,7 +962,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -887,7 +973,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -897,7 +984,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -907,7 +995,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -917,7 +1006,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -927,7 +1017,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -937,7 +1028,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -947,7 +1039,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -957,7 +1050,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -967,7 +1061,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -977,7 +1072,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -987,7 +1083,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -997,7 +1094,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1007,7 +1105,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1017,7 +1116,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1027,7 +1127,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1037,7 +1138,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1047,7 +1149,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1057,7 +1160,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1067,7 +1171,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1077,7 +1182,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress/_index.md index 9d06a18773..06123977ff 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress represents the [SoftLayer_Billing_Item]({{}}) instance. @@ -53,7 +55,8 @@ A SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress represents the [S [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -63,7 +66,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -73,7 +77,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -83,7 +88,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -93,7 +99,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -103,7 +110,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -113,7 +121,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -123,7 +132,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -133,7 +143,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -143,7 +154,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -153,7 +165,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -163,7 +176,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -173,7 +187,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -183,7 +198,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -193,7 +209,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -203,7 +220,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -213,7 +231,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -223,7 +242,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -233,7 +253,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -243,7 +264,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -253,7 +275,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -263,7 +286,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -273,7 +297,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -283,7 +308,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -293,7 +319,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -303,7 +330,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -313,7 +341,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -323,7 +352,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -349,7 +380,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -359,7 +391,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -369,7 +402,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -379,7 +413,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -389,7 +424,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -399,7 +435,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -409,7 +446,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -419,7 +457,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -429,7 +468,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -439,7 +479,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -449,7 +490,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -459,7 +501,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -469,7 +512,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -479,7 +523,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -489,7 +534,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -499,7 +545,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -509,7 +556,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -519,7 +567,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -529,7 +578,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -539,7 +589,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -549,7 +600,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -559,7 +611,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -569,7 +622,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -579,7 +633,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -589,7 +644,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -599,7 +655,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -609,7 +666,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -619,7 +677,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -629,7 +688,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -639,7 +699,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -649,7 +710,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -659,7 +721,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -669,7 +732,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -679,7 +743,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -689,7 +754,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -699,7 +765,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -709,7 +776,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -719,7 +787,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -729,7 +798,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -739,7 +809,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -749,7 +820,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -759,7 +831,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -769,7 +842,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -779,7 +853,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -789,7 +864,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -799,7 +875,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -809,7 +886,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -819,7 +897,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The load balancer's virtual IP address that the billing item is associated with. -Type: **SoftLayer_Network_LoadBalancer_VirtualIpAddress ** +Type: **SoftLayer_Network_LoadBalancer_VirtualIpAddress ** + @@ -829,7 +908,8 @@ The load balancer's virtual IP address that the billing item is associated with. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -839,7 +919,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -849,7 +930,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -861,7 +943,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -871,7 +954,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -881,7 +965,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -891,7 +976,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -901,7 +987,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -911,7 +998,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -921,7 +1009,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -931,7 +1020,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -941,7 +1031,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -951,7 +1042,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -961,7 +1053,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -971,7 +1064,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -981,7 +1075,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -991,7 +1086,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1001,7 +1097,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1011,7 +1108,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1021,7 +1119,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1031,7 +1130,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1041,7 +1141,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1051,7 +1152,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1061,7 +1163,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1071,7 +1174,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1081,7 +1185,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Message_Delivery/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Message_Delivery/_index.md index e3350215a8..03a0a989c2 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Message_Delivery/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Message_Delivery/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Network_Message_Delivery data describes the related billing item. @@ -53,7 +55,8 @@ The SoftLayer_Billing_Item_Network_Message_Delivery data describes the related b [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -63,7 +66,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -73,7 +77,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -83,7 +88,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -93,7 +99,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -103,7 +110,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -113,7 +121,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -123,7 +132,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -133,7 +143,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -143,7 +154,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -153,7 +165,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -163,7 +176,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -173,7 +187,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -183,7 +198,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -193,7 +209,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -203,7 +220,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -213,7 +231,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -223,7 +242,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -233,7 +253,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -243,7 +264,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -253,7 +275,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -263,7 +286,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -273,7 +297,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -283,7 +308,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -293,7 +319,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -303,7 +330,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -313,7 +341,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -323,7 +352,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -349,7 +380,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -359,7 +391,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -369,7 +402,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -379,7 +413,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -389,7 +424,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -399,7 +435,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -409,7 +446,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -419,7 +457,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -429,7 +468,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -439,7 +479,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -449,7 +490,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -459,7 +501,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -469,7 +512,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -479,7 +523,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -489,7 +534,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -499,7 +545,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -509,7 +556,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -519,7 +567,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -529,7 +578,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -539,7 +589,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -549,7 +600,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -559,7 +611,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -569,7 +622,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -579,7 +633,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -589,7 +644,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -599,7 +655,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -609,7 +666,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -619,7 +677,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -629,7 +688,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -639,7 +699,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -649,7 +710,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -659,7 +721,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -669,7 +732,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -679,7 +743,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -689,7 +754,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -699,7 +765,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -709,7 +776,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -719,7 +787,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -729,7 +798,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -739,7 +809,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -749,7 +820,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -759,7 +831,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -769,7 +842,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -779,7 +853,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -789,7 +864,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -799,7 +875,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -809,7 +886,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -819,7 +897,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The object this billing item is associated with. -Type: **SoftLayer_Network_Message_Delivery ** +Type: **SoftLayer_Network_Message_Delivery ** + @@ -829,7 +908,8 @@ The object this billing item is associated with. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -839,7 +919,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -849,7 +930,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -861,7 +943,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -871,7 +954,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -881,7 +965,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -891,7 +976,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -901,7 +987,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -911,7 +998,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -921,7 +1009,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -931,7 +1020,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -941,7 +1031,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -951,7 +1042,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -961,7 +1053,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -971,7 +1064,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -981,7 +1075,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -991,7 +1086,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1001,7 +1097,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1011,7 +1108,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1021,7 +1119,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1031,7 +1130,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1041,7 +1141,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1051,7 +1152,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1061,7 +1163,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1071,7 +1174,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1081,7 +1185,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi/_index.md index bd9ca74f74..ebbc9b915b 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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' @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi data type contains g [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The StorageLayer account that a network storage billing item is associated with. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -821,7 +900,8 @@ The StorageLayer account that a network storage billing item is associated with. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -831,7 +911,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -841,7 +922,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -853,7 +935,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs/_index.md index 23217585b0..8c5451e1ce 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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' @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs data type contains gen [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The StorageLayer account that a network storage billing item is associated with. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -821,7 +900,8 @@ The StorageLayer account that a network storage billing item is associated with. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -831,7 +911,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -841,7 +922,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -853,7 +935,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Storage/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Storage/_index.md index b938f4c2a2..15c819e588 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Storage/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Storage/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Network_Storage data type describes the billing items related to StorageLayer accounts. @@ -53,7 +55,8 @@ The SoftLayer_Billing_Item_Network_Storage data type describes the billing items [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -63,7 +66,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -73,7 +77,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -83,7 +88,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -93,7 +99,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -103,7 +110,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -113,7 +121,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -123,7 +132,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -133,7 +143,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -143,7 +154,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -153,7 +165,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -163,7 +176,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -173,7 +187,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -183,7 +198,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -193,7 +209,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -203,7 +220,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -213,7 +231,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -223,7 +242,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -233,7 +253,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -243,7 +264,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -253,7 +275,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -263,7 +286,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -273,7 +297,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -283,7 +308,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -293,7 +319,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -303,7 +330,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -313,7 +341,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -323,7 +352,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -349,7 +380,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -359,7 +391,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -369,7 +402,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -379,7 +413,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -389,7 +424,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -399,7 +435,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -409,7 +446,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -419,7 +457,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -429,7 +468,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -439,7 +479,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -449,7 +490,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -459,7 +501,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -469,7 +512,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -479,7 +523,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -489,7 +534,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -499,7 +545,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -509,7 +556,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -519,7 +567,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -529,7 +578,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -539,7 +589,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -549,7 +600,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -559,7 +611,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -569,7 +622,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -579,7 +633,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -589,7 +644,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -599,7 +655,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -609,7 +666,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -619,7 +677,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -629,7 +688,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -639,7 +699,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -649,7 +710,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -659,7 +721,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -669,7 +732,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -679,7 +743,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -689,7 +754,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -699,7 +765,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -709,7 +776,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -719,7 +787,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -729,7 +798,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -739,7 +809,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -749,7 +820,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -759,7 +831,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -769,7 +842,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -779,7 +853,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -789,7 +864,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -799,7 +875,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -809,7 +886,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -819,7 +897,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The StorageLayer account that a network storage billing item is associated with. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -829,7 +908,8 @@ The StorageLayer account that a network storage billing item is associated with. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -839,7 +919,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -849,7 +930,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -861,7 +943,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -871,7 +954,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -881,7 +965,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -891,7 +976,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -901,7 +987,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -911,7 +998,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -921,7 +1009,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -931,7 +1020,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -941,7 +1031,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -951,7 +1042,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -961,7 +1053,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -971,7 +1064,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -981,7 +1075,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -991,7 +1086,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1001,7 +1097,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1011,7 +1108,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1021,7 +1119,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1031,7 +1130,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1041,7 +1141,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1051,7 +1152,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1061,7 +1163,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1071,7 +1174,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1081,7 +1185,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Storage_Hub/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Storage_Hub/_index.md index 9a78407f7e..978c47632a 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Storage_Hub/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Storage_Hub/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Network_Storage_Hub models all billing items related to hub-based StorageLayer offerings, such as CloudLayer storage. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Network_Storage_Hub models all billing items related [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The StorageLayer account that a network storage billing item is associated with. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -821,7 +900,8 @@ The StorageLayer account that a network storage billing item is associated with. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -831,7 +911,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -841,7 +922,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -853,7 +935,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth/_index.md index e256dbd43e..5d8369ba2f 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ The SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth data type models the bi [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -80,7 +85,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -100,7 +107,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -110,7 +118,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -120,7 +129,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -130,7 +140,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -140,7 +151,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -150,7 +162,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -160,7 +173,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -170,7 +184,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -180,7 +195,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -190,7 +206,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -200,7 +217,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -210,7 +228,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -220,7 +239,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -230,7 +250,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -240,7 +261,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -250,7 +272,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -260,7 +283,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -270,7 +294,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -280,7 +305,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -290,7 +316,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -300,7 +327,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -310,7 +338,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -320,7 +349,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -330,7 +360,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -346,7 +377,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -356,7 +388,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -366,7 +399,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -376,7 +410,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -386,7 +421,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -396,7 +432,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -406,7 +443,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -416,7 +454,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -426,7 +465,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -436,7 +476,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -446,7 +487,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -456,7 +498,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -466,7 +509,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -476,7 +520,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -486,7 +531,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -496,7 +542,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -506,7 +553,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -516,7 +564,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -526,7 +575,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -536,7 +586,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -546,7 +597,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -556,7 +608,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -566,7 +619,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -576,7 +630,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -586,7 +641,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -596,7 +652,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -606,7 +663,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -616,7 +674,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -626,7 +685,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -636,7 +696,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -646,7 +707,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -656,7 +718,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -666,7 +729,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -676,7 +740,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -686,7 +751,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -696,7 +762,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -706,7 +773,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -716,7 +784,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -726,7 +795,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -736,7 +806,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -746,7 +817,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -756,7 +828,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -766,7 +839,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -776,7 +850,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -786,7 +861,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -796,7 +872,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -806,7 +883,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -816,7 +894,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The StorageLayer account that a network storage billing item is associated with. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -826,7 +905,8 @@ The StorageLayer account that a network storage billing item is associated with. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -836,7 +916,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -846,7 +927,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -858,7 +940,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -868,7 +951,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -878,7 +962,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -888,7 +973,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -898,7 +984,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -908,7 +995,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -918,7 +1006,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -928,7 +1017,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -938,7 +1028,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -948,7 +1039,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -958,7 +1050,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -968,7 +1061,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -978,7 +1072,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -988,7 +1083,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -998,7 +1094,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1008,7 +1105,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1018,7 +1116,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1028,7 +1127,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1038,7 +1138,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1048,7 +1149,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1058,7 +1160,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1068,7 +1171,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1078,7 +1182,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Subnet/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Subnet/_index.md index bfa5748170..6b05102dd7 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Subnet/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Subnet/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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) @@ -54,7 +56,8 @@ These item categories denote that the billing item has subnet information attach [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -64,7 +67,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -74,7 +78,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -84,7 +89,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -94,7 +100,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -104,7 +111,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -114,7 +122,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -124,7 +133,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -134,7 +144,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -144,7 +155,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -154,7 +166,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -164,7 +177,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -174,7 +188,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -184,7 +199,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -194,7 +210,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -204,7 +221,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -214,7 +232,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -224,7 +243,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -234,7 +254,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -244,7 +265,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -254,7 +276,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -264,7 +287,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -274,7 +298,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -284,7 +309,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -294,7 +320,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -304,7 +331,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -314,7 +342,8 @@ The number of months in which the recurring fees will be incurred. [resourceName]: #resourcename #### [resourceName] The resource name for a subnet billing item. -Type: **string** +Type: **string** + @@ -324,7 +353,8 @@ The resource name for a subnet billing item. [resourceTableId]: #resourcetableid #### [resourceTableId] The resource (unique identifier) for a server billing item. -Type: **integer** +Type: **integer** + @@ -334,7 +364,8 @@ The resource (unique identifier) for a server billing item. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -344,7 +375,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -354,7 +386,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -370,7 +403,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -380,7 +414,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -390,7 +425,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -400,7 +436,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -410,7 +447,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -420,7 +458,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -430,7 +469,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -440,7 +480,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -450,7 +491,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -460,7 +502,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -470,7 +513,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -480,7 +524,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -490,7 +535,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -500,7 +546,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -510,7 +557,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -520,7 +568,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -530,7 +579,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -540,7 +590,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -550,7 +601,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -560,7 +612,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -570,7 +623,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -580,7 +634,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -590,7 +645,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -600,7 +656,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -610,7 +667,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -620,7 +678,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -630,7 +689,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -640,7 +700,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -650,7 +711,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -660,7 +722,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -670,7 +733,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -680,7 +744,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -690,7 +755,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -700,7 +766,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -710,7 +777,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -720,7 +788,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -730,7 +799,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -740,7 +810,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -750,7 +821,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -760,7 +832,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -770,7 +843,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -780,7 +854,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -790,7 +865,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -800,7 +876,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -810,7 +887,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -820,7 +898,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -830,7 +909,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -840,7 +920,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The resource for a subnet-related billing item. -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + @@ -850,7 +931,8 @@ The resource for a subnet-related billing item. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -860,7 +942,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -870,7 +953,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -882,7 +966,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -892,7 +977,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -902,7 +988,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -912,7 +999,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -922,7 +1010,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -932,7 +1021,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -942,7 +1032,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -952,7 +1043,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -962,7 +1054,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -972,7 +1065,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -982,7 +1076,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -992,7 +1087,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -1002,7 +1098,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1012,7 +1109,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1022,7 +1120,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1032,7 +1131,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1042,7 +1142,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1052,7 +1153,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1062,7 +1164,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1072,7 +1175,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1082,7 +1186,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1092,7 +1197,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1102,7 +1208,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Subnet_IpAddress_Global/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Subnet_IpAddress_Global/_index.md index e8b99174ff..c3a021c631 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Subnet_IpAddress_Global/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Subnet_IpAddress_Global/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -50,7 +52,8 @@ These item categories denote that the billing item has subnet information attach [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -80,7 +85,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -100,7 +107,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -110,7 +118,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -120,7 +129,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -130,7 +140,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -140,7 +151,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -150,7 +162,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -160,7 +173,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -170,7 +184,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -180,7 +195,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -190,7 +206,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -200,7 +217,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -210,7 +228,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -220,7 +239,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -230,7 +250,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -240,7 +261,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -250,7 +272,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -260,7 +283,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -270,7 +294,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -280,7 +305,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -290,7 +316,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -300,7 +327,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -310,7 +338,8 @@ The number of months in which the recurring fees will be incurred. [resourceName]: #resourcename #### [resourceName] The resource name for a subnet billing item. -Type: **string** +Type: **string** + @@ -320,7 +349,8 @@ The resource name for a subnet billing item. [resourceTableId]: #resourcetableid #### [resourceTableId] The resource (unique identifier) for a server billing item. -Type: **integer** +Type: **integer** + @@ -330,7 +360,8 @@ The resource (unique identifier) for a server billing item. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -340,7 +371,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -350,7 +382,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -366,7 +399,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -376,7 +410,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -386,7 +421,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -396,7 +432,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -406,7 +443,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -416,7 +454,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -426,7 +465,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -436,7 +476,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -446,7 +487,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -456,7 +498,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -466,7 +509,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -476,7 +520,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -486,7 +531,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -496,7 +542,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -506,7 +553,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -516,7 +564,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -526,7 +575,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -536,7 +586,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -546,7 +597,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -556,7 +608,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -566,7 +619,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -576,7 +630,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -586,7 +641,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -596,7 +652,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -606,7 +663,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -616,7 +674,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -626,7 +685,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -636,7 +696,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -646,7 +707,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -656,7 +718,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -666,7 +729,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -676,7 +740,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -686,7 +751,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -696,7 +762,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -706,7 +773,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -716,7 +784,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -726,7 +795,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -736,7 +806,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -746,7 +817,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -756,7 +828,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -766,7 +839,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -776,7 +850,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -786,7 +861,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -796,7 +872,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -806,7 +883,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -816,7 +894,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -826,7 +905,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -836,7 +916,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The resource for a global IP address billing item. -Type: **SoftLayer_Network_Subnet_IpAddress_Global ** +Type: **SoftLayer_Network_Subnet_IpAddress_Global ** + @@ -846,7 +927,8 @@ The resource for a global IP address billing item. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -856,7 +938,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -866,7 +949,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -878,7 +962,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -888,7 +973,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -898,7 +984,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -908,7 +995,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -918,7 +1006,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -928,7 +1017,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -938,7 +1028,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -948,7 +1039,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -958,7 +1050,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -968,7 +1061,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -978,7 +1072,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -988,7 +1083,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -998,7 +1094,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1008,7 +1105,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1018,7 +1116,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1028,7 +1127,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1038,7 +1138,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1048,7 +1149,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1058,7 +1160,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1068,7 +1171,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1078,7 +1182,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1088,7 +1193,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1098,7 +1204,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Tunnel/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Tunnel/_index.md index c5c0cf2ae2..0a1200cf80 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Tunnel/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Tunnel/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Network_Storage data type describes the billing items related to StorageLayer accounts. @@ -53,7 +55,8 @@ The SoftLayer_Billing_Item_Network_Storage data type describes the billing items [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -63,7 +66,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -73,7 +77,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -83,7 +88,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -93,7 +99,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -103,7 +110,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -113,7 +121,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -123,7 +132,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -133,7 +143,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -143,7 +154,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -153,7 +165,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -163,7 +176,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -173,7 +187,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -183,7 +198,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -193,7 +209,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -203,7 +220,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -213,7 +231,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -223,7 +242,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -233,7 +253,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -243,7 +264,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -253,7 +275,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -263,7 +286,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -273,7 +297,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -283,7 +308,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -293,7 +319,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -303,7 +330,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -313,7 +341,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -323,7 +352,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -349,7 +380,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -359,7 +391,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -369,7 +402,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -379,7 +413,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -389,7 +424,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -399,7 +435,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -409,7 +446,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -419,7 +457,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -429,7 +468,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -439,7 +479,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -449,7 +490,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -459,7 +501,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -469,7 +512,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -479,7 +523,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -489,7 +534,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -499,7 +545,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -509,7 +556,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -519,7 +567,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -529,7 +578,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -539,7 +589,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -549,7 +600,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -559,7 +611,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -569,7 +622,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -579,7 +633,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -589,7 +644,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -599,7 +655,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -609,7 +666,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -619,7 +677,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -629,7 +688,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -639,7 +699,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -649,7 +710,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -659,7 +721,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -669,7 +732,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -679,7 +743,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -689,7 +754,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -699,7 +765,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -709,7 +776,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -719,7 +787,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -729,7 +798,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -739,7 +809,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -749,7 +820,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -759,7 +831,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -769,7 +842,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -779,7 +853,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -789,7 +864,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -799,7 +875,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -809,7 +886,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -819,7 +897,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The IPsec VPN that a network tunnel billing item is associated with. -Type: **SoftLayer_Network_Tunnel_Module_Context ** +Type: **SoftLayer_Network_Tunnel_Module_Context ** + @@ -829,7 +908,8 @@ The IPsec VPN that a network tunnel billing item is associated with. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -839,7 +919,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -849,7 +930,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -861,7 +943,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -871,7 +954,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -881,7 +965,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -891,7 +976,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -901,7 +987,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -911,7 +998,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -921,7 +1009,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -931,7 +1020,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -941,7 +1031,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -951,7 +1042,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -961,7 +1053,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -971,7 +1064,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -981,7 +1075,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -991,7 +1086,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1001,7 +1097,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1011,7 +1108,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1021,7 +1119,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1031,7 +1130,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1041,7 +1141,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1051,7 +1152,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1061,7 +1163,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1071,7 +1174,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1081,7 +1185,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Vlan/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Vlan/_index.md index 2958b9776b..7559fd1522 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Vlan/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Vlan/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -49,7 +51,8 @@ These item categories denote that the billing item has network vlan information [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -59,7 +62,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -69,7 +73,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -79,7 +84,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -89,7 +95,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -99,7 +106,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -109,7 +117,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -119,7 +128,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -129,7 +139,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -139,7 +150,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -149,7 +161,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -159,7 +172,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -169,7 +183,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -179,7 +194,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -189,7 +205,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -199,7 +216,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -209,7 +227,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -219,7 +238,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -229,7 +249,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -239,7 +260,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -249,7 +271,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -259,7 +282,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -269,7 +293,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -279,7 +304,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -289,7 +315,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -299,7 +326,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -309,7 +337,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -319,7 +348,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -329,7 +359,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -345,7 +376,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -355,7 +387,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -365,7 +398,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -375,7 +409,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -385,7 +420,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -395,7 +431,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -405,7 +442,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -415,7 +453,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -425,7 +464,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -435,7 +475,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -445,7 +486,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -455,7 +497,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -465,7 +508,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -475,7 +519,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -485,7 +530,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -495,7 +541,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -505,7 +552,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -515,7 +563,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -525,7 +574,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -535,7 +585,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -545,7 +596,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -555,7 +607,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -565,7 +618,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -575,7 +629,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -585,7 +640,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -595,7 +651,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -605,7 +662,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -615,7 +673,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -625,7 +684,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -635,7 +695,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -645,7 +706,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -655,7 +717,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -665,7 +728,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -675,7 +739,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -685,7 +750,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -695,7 +761,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -705,7 +772,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -715,7 +783,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -725,7 +794,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -735,7 +805,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -745,7 +816,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -755,7 +827,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -765,7 +838,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -775,7 +849,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -785,7 +860,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -795,7 +871,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -805,7 +882,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -815,7 +893,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The network vlan resource for this billing item. -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + @@ -825,7 +904,8 @@ The network vlan resource for this billing item. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -835,7 +915,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -845,7 +926,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -857,7 +939,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -867,7 +950,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -877,7 +961,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -887,7 +972,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -897,7 +983,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -907,7 +994,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -917,7 +1005,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -927,7 +1016,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -937,7 +1027,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -947,7 +1038,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -957,7 +1049,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -967,7 +1060,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -977,7 +1071,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -987,7 +1082,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -997,7 +1093,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1007,7 +1104,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1017,7 +1115,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1027,7 +1126,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1037,7 +1137,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1047,7 +1148,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1057,7 +1159,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1067,7 +1170,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1077,7 +1181,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_NewCustomerSetup/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_NewCustomerSetup/_index.md index 56f6ea20d8..10f6f300f4 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_NewCustomerSetup/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_NewCustomerSetup/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -821,7 +900,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -831,7 +911,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -843,7 +924,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -853,7 +935,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Private_Cloud/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Private_Cloud/_index.md index c120a0768f..eadc59b62d 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Private_Cloud/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Private_Cloud/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Private_Cloud data type contains general information relating to a single billing item for a private cloud. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Private_Cloud data type contains general information [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -821,7 +900,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -831,7 +911,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -843,7 +924,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -853,7 +935,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component/_index.md index bc5f78686e..14cf7eb52d 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware components. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Hardware data type contains general information relat [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [resourceTableId]: #resourcetableid #### [resourceTableId] The resource (unique identifier) for a software component billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ The resource (unique identifier) for a software component billing item. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -325,7 +355,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -335,7 +366,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -351,7 +383,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -381,7 +416,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -411,7 +449,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -421,7 +460,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -461,7 +504,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -471,7 +515,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -481,7 +526,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -511,7 +559,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -521,7 +570,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -531,7 +581,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -561,7 +614,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -571,7 +625,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -581,7 +636,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -591,7 +647,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -611,7 +669,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -621,7 +680,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -631,7 +691,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -641,7 +702,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -651,7 +713,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -661,7 +724,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -671,7 +735,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -681,7 +746,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -691,7 +757,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -731,7 +801,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -741,7 +812,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -751,7 +823,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -761,7 +834,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -771,7 +845,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -791,7 +867,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -801,7 +878,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -811,7 +889,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -821,7 +900,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The software component that this billing item points to. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -831,7 +911,8 @@ The software component that this billing item points to. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -841,7 +922,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -851,7 +933,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -863,7 +946,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1188,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_Analytics_Urchin/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_Analytics_Urchin/_index.md index b9b20df359..ece8649cea 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_Analytics_Urchin/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_Analytics_Urchin/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Software_Component_Analytics_Urchin data type contains general information relating to a single SoftLayer billing item for Urchin software components. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Software_Component_Analytics_Urchin data type contain [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -821,7 +900,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -831,7 +911,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -843,7 +924,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -853,7 +935,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_ControlPanel/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_ControlPanel/_index.md index 8a641fc564..27c00f5c9c 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_ControlPanel/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_ControlPanel/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Software_Component_ControlPanel data type contains general information relating to a single SoftLayer billing item for control panel software components. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Software_Component_ControlPanel data type contains ge [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -821,7 +900,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -831,7 +911,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -843,7 +924,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -853,7 +935,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_ControlPanel_Parallels_Plesk_Billing/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_ControlPanel_Parallels_Plesk_Billing/_index.md index 5b4a23df3a..c771638b63 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_ControlPanel_Parallels_Plesk_Billing/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_ControlPanel_Parallels_Plesk_Billing/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Software_Component_ControlPanel data type contains general information relating to a single SoftLayer billing item for control panel software components. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Software_Component_ControlPanel data type contains ge [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -821,7 +900,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -831,7 +911,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -843,7 +924,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -853,7 +935,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon/_index.md index 1ccfbc02af..b21bb16d3f 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon data type co [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -821,7 +900,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -831,7 +911,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -843,7 +924,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -853,7 +935,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon_Citrix_Essentials/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon_Citrix_Essentials/_index.md index e9b925965c..7226010700 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon_Citrix_Essentials/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon_Citrix_Essentials/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon_Citrix_Essen [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The Citrix Essentials software component that a billing item is associated with. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -821,7 +900,8 @@ The Citrix Essentials software component that a billing item is associated with. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -831,7 +911,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -841,7 +922,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -853,7 +935,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem/_index.md index 62274b5f4f..cd5e7a8464 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem data type [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -821,7 +900,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -831,7 +911,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -843,7 +924,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -853,7 +935,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft/_index.md index 688a687698..3a6a2e7b84 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [resourceTableId]: #resourcetableid #### [resourceTableId] The resource (unique identifier) for a software virtual license billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ The resource (unique identifier) for a software virtual license billing item. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -325,7 +355,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -335,7 +366,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -351,7 +383,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -381,7 +416,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -411,7 +449,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -421,7 +460,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -461,7 +504,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -471,7 +515,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -481,7 +526,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -511,7 +559,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -521,7 +570,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -531,7 +581,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -561,7 +614,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -571,7 +625,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -581,7 +636,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -591,7 +647,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -611,7 +669,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -621,7 +680,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -631,7 +691,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -641,7 +702,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -651,7 +713,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -661,7 +724,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -671,7 +735,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -681,7 +746,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -691,7 +757,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -731,7 +801,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -741,7 +812,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -751,7 +823,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -761,7 +834,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -771,7 +845,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -791,7 +867,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -801,7 +878,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -811,7 +889,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -821,7 +900,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The software virtual license to which this billing item points. -Type: **SoftLayer_Software_VirtualLicense ** +Type: **SoftLayer_Software_VirtualLicense ** + @@ -831,7 +911,8 @@ The software virtual license to which this billing item points. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -841,7 +922,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -851,7 +933,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -863,7 +946,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1188,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Redhat/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Redhat/_index.md index 7a1fef8393..551ad52deb 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Redhat/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Redhat/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [resourceTableId]: #resourcetableid #### [resourceTableId] The resource (unique identifier) for a software component billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ The resource (unique identifier) for a software component billing item. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -325,7 +355,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -335,7 +366,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -351,7 +383,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -381,7 +416,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -411,7 +449,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -421,7 +460,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -461,7 +504,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -471,7 +515,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -481,7 +526,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -511,7 +559,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -521,7 +570,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -531,7 +581,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -561,7 +614,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -571,7 +625,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -581,7 +636,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -591,7 +647,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -611,7 +669,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -621,7 +680,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -631,7 +691,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -641,7 +702,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -651,7 +713,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -661,7 +724,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -671,7 +735,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -681,7 +746,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -691,7 +757,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -731,7 +801,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -741,7 +812,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -751,7 +823,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -761,7 +834,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -771,7 +845,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -791,7 +867,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -801,7 +878,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -811,7 +889,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -821,7 +900,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The software component to which this billing item points. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -831,7 +911,8 @@ The software component to which this billing item points. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -841,7 +922,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -851,7 +933,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -863,7 +946,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1188,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Software_License/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Software_License/_index.md index 356ad4a101..c052e1dd57 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Software_License/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Software_License/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Software_License data type contains general information relating to a single SoftLayer billing item for a software license. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Software_License data type contains general informati [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The resource for a software license billing item. -Type: **SoftLayer_Software_AccountLicense ** +Type: **SoftLayer_Software_AccountLicense ** + @@ -821,7 +900,8 @@ The resource for a software license billing item. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -831,7 +911,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -841,7 +922,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -853,7 +935,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Support/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Support/_index.md index b8ad4e212e..1689720e65 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Support/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Support/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Support data type contains general information relating to a premium support offering @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Support data type contains general information relati [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -821,7 +900,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -831,7 +911,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -843,7 +924,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -853,7 +935,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_User_Customer_External_Binding/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_User_Customer_External_Binding/_index.md index d42141c6b3..5f70c4e1ee 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_User_Customer_External_Binding/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_User_Customer_External_Binding/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Network_Application_Delivery_Controller data type describes the billing item related to an external authentication binding @@ -50,7 +52,8 @@ The SoftLayer_Billing_Item_Network_Application_Delivery_Controller data type des [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -80,7 +85,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -100,7 +107,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -110,7 +118,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -120,7 +129,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -130,7 +140,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -140,7 +151,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -150,7 +162,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -160,7 +173,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -170,7 +184,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -180,7 +195,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -190,7 +206,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -200,7 +217,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -210,7 +228,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -220,7 +239,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -230,7 +250,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -240,7 +261,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -250,7 +272,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -260,7 +283,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -270,7 +294,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -280,7 +305,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -290,7 +316,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -300,7 +327,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -310,7 +338,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -320,7 +349,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -330,7 +360,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -346,7 +377,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -356,7 +388,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -366,7 +399,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -376,7 +410,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -386,7 +421,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -396,7 +432,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -406,7 +443,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -416,7 +454,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -426,7 +465,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -436,7 +476,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -446,7 +487,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -456,7 +498,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -466,7 +509,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -476,7 +520,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -486,7 +531,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -496,7 +542,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -506,7 +553,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -516,7 +564,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -526,7 +575,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -536,7 +586,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -546,7 +597,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -556,7 +608,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -566,7 +619,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -576,7 +630,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -586,7 +641,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -596,7 +652,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -606,7 +663,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -616,7 +674,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -626,7 +685,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -636,7 +696,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -646,7 +707,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -656,7 +718,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -666,7 +729,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -676,7 +740,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -686,7 +751,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -696,7 +762,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -706,7 +773,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -716,7 +784,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -726,7 +795,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -736,7 +806,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -746,7 +817,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -756,7 +828,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -766,7 +839,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -776,7 +850,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -786,7 +861,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -796,7 +872,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -806,7 +883,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -816,7 +894,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The external authentication binding that a billing item is associated with. -Type: **SoftLayer_User_Customer_External_Binding ** +Type: **SoftLayer_User_Customer_External_Binding ** + @@ -826,7 +905,8 @@ The external authentication binding that a billing item is associated with. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -836,7 +916,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -846,7 +927,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -858,7 +940,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -868,7 +951,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -878,7 +962,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -888,7 +973,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -898,7 +984,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -908,7 +995,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -918,7 +1006,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -928,7 +1017,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -938,7 +1028,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -948,7 +1039,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -958,7 +1050,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -968,7 +1061,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -978,7 +1072,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -988,7 +1083,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -998,7 +1094,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1008,7 +1105,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1018,7 +1116,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1028,7 +1127,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1038,7 +1138,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1048,7 +1149,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1058,7 +1160,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1068,7 +1171,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1078,7 +1182,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_DedicatedHost/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_DedicatedHost/_index.md index ca06d35821..7c57504aca 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_DedicatedHost/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_DedicatedHost/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [resourceTableId]: #resourcetableid #### [resourceTableId] The resource (unique identifier) for a server billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ The resource (unique identifier) for a server billing item. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -325,7 +355,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -335,7 +366,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -351,7 +383,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -381,7 +416,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -411,7 +449,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -421,7 +460,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -461,7 +504,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -471,7 +515,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -481,7 +526,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -511,7 +559,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -521,7 +570,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -531,7 +581,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -561,7 +614,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -571,7 +625,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -581,7 +636,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -591,7 +647,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -611,7 +669,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -621,7 +680,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -631,7 +691,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -641,7 +702,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -651,7 +713,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -661,7 +724,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -671,7 +735,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -681,7 +746,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -691,7 +757,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -731,7 +801,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -741,7 +812,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -751,7 +823,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -761,7 +834,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -771,7 +845,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -791,7 +867,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -801,7 +878,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -811,7 +889,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -821,7 +900,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The resource for a virtual dedicated host billing item. -Type: **SoftLayer_Virtual_DedicatedHost ** +Type: **SoftLayer_Virtual_DedicatedHost ** + @@ -831,7 +911,8 @@ The resource for a virtual dedicated host billing item. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -841,7 +922,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -851,7 +933,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -863,7 +946,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1188,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_Dedicated_Rack/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_Dedicated_Rack/_index.md index 0eef7958bc..f6b28317da 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_Dedicated_Rack/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_Dedicated_Rack/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ A SoftLayer_Billing_Item_Virtual_Dedicated_Rack data type models the billing inf [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -80,7 +85,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -100,7 +107,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -110,7 +118,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -120,7 +129,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -130,7 +140,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -140,7 +151,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -150,7 +162,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -160,7 +173,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -170,7 +184,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -180,7 +195,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -190,7 +206,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -200,7 +217,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -210,7 +228,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -220,7 +239,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -230,7 +250,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -240,7 +261,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -250,7 +272,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -260,7 +283,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -270,7 +294,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -280,7 +305,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -290,7 +316,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -300,7 +327,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -310,7 +338,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -320,7 +349,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -330,7 +360,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -346,7 +377,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -356,7 +388,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -366,7 +399,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -376,7 +410,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -386,7 +421,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -396,7 +432,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -406,7 +443,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -416,7 +454,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -426,7 +465,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -436,7 +476,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -446,7 +487,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -456,7 +498,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -466,7 +509,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -476,7 +520,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -486,7 +531,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -496,7 +542,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -506,7 +553,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -516,7 +564,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -526,7 +575,8 @@ A billing item's recurring child items that have once been billed and are schedu [billingCycleBandwidthUsage]: #billingcyclebandwidthusage #### [billingCycleBandwidthUsage] The raw bandwidth usage data for the current billing cycle. One object is returned for each network a virtual rack is attached to. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -536,7 +586,8 @@ The raw bandwidth usage data for the current billing cycle. One object is return [billingCyclePrivateBandwidthUsage]: #billingcycleprivatebandwidthusage #### [billingCyclePrivateBandwidthUsage] The raw private bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -546,7 +597,8 @@ The raw private bandwidth usage data for the current billing cycle. [billingCyclePrivateUsageIn]: #billingcycleprivateusagein #### [billingCyclePrivateUsageIn] The total private network inbound bandwidth for this virtual rack for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -556,7 +608,8 @@ The total private network inbound bandwidth for this virtual rack for the curren [billingCyclePrivateUsageOut]: #billingcycleprivateusageout #### [billingCyclePrivateUsageOut] The total private network outbound bandwidth for this virtual rack for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -566,7 +619,8 @@ The total private network outbound bandwidth for this virtual rack for the curre [billingCyclePrivateUsageTotal]: #billingcycleprivateusagetotal #### [billingCyclePrivateUsageTotal] The total private network bandwidth for this virtual rack for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -576,7 +630,8 @@ The total private network bandwidth for this virtual rack for the current billin [billingCyclePublicBandwidthUsage]: #billingcyclepublicbandwidthusage #### [billingCyclePublicBandwidthUsage] The raw public bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -586,7 +641,8 @@ The raw public bandwidth usage data for the current billing cycle. [billingCyclePublicUsageIn]: #billingcyclepublicusagein #### [billingCyclePublicUsageIn] The total public inbound bandwidth for this virtual rack for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -596,7 +652,8 @@ The total public inbound bandwidth for this virtual rack for the current billing [billingCyclePublicUsageOut]: #billingcyclepublicusageout #### [billingCyclePublicUsageOut] The total public outbound bandwidth for this virtual rack for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -606,7 +663,8 @@ The total public outbound bandwidth for this virtual rack for the current billin [billingCyclePublicUsageTotal]: #billingcyclepublicusagetotal #### [billingCyclePublicUsageTotal] The total public bandwidth for this virtual rack for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -616,7 +674,8 @@ The total public bandwidth for this virtual rack for the current billing cycle. [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -626,7 +685,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -636,7 +696,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -646,7 +707,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -656,7 +718,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -666,7 +729,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -676,7 +740,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -686,7 +751,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -696,7 +762,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -706,7 +773,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -716,7 +784,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -726,7 +795,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -736,7 +806,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -746,7 +817,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -756,7 +828,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -766,7 +839,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -776,7 +850,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -786,7 +861,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -796,7 +872,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -806,7 +883,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -816,7 +894,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -826,7 +905,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -836,7 +916,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -846,7 +927,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -856,7 +938,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -866,7 +949,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -876,7 +960,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -886,7 +971,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -896,7 +982,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -906,7 +993,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The virtual rack that a virtual rack billing item is associated with. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** + @@ -916,7 +1004,8 @@ The virtual rack that a virtual rack billing item is associated with. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -926,7 +1015,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -936,7 +1026,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -948,7 +1039,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -958,7 +1050,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -968,7 +1061,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -978,7 +1072,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -988,7 +1083,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -998,7 +1094,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1008,7 +1105,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -1018,7 +1116,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1028,7 +1127,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -1038,7 +1138,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1048,7 +1149,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -1058,7 +1160,8 @@ A count of a billing item's recurring child items that have once been billed and [billingCycleBandwidthUsageCount]: #billingcyclebandwidthusagecount #### [billingCycleBandwidthUsageCount] A count of the raw bandwidth usage data for the current billing cycle. One object is returned for each network a virtual rack is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1068,7 +1171,8 @@ A count of the raw bandwidth usage data for the current billing cycle. One objec [billingCyclePrivateBandwidthUsageCount]: #billingcycleprivatebandwidthusagecount #### [billingCyclePrivateBandwidthUsageCount] A count of the raw private bandwidth usage data for the current billing cycle. -Type: **unsigned long** +Type: **unsigned long** + @@ -1078,7 +1182,8 @@ A count of the raw private bandwidth usage data for the current billing cycle. [billingCyclePublicBandwidthUsageCount]: #billingcyclepublicbandwidthusagecount #### [billingCyclePublicBandwidthUsageCount] A count of the raw public bandwidth usage data for the current billing cycle. -Type: **unsigned long** +Type: **unsigned long** + @@ -1088,7 +1193,8 @@ A count of the raw public bandwidth usage data for the current billing cycle. [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -1098,7 +1204,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1108,7 +1215,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1118,7 +1226,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1128,7 +1237,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1138,7 +1248,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1148,7 +1259,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1158,7 +1270,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1168,7 +1281,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1178,7 +1292,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1188,7 +1303,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1198,7 +1314,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_Disk_Image/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_Disk_Image/_index.md index 5ba546889b..1a93cdc912 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_Disk_Image/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_Disk_Image/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Virtual_Disk_Image data type contains general information relating to a single SoftLayer billing item for disk images. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Virtual_Disk_Image data type contains general informa [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [resourceTableId]: #resourcetableid #### [resourceTableId] The resource (unique identifier) for a disk image billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ The resource (unique identifier) for a disk image billing item. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -325,7 +355,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -335,7 +366,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -351,7 +383,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -381,7 +416,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -411,7 +449,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -421,7 +460,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -461,7 +504,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -471,7 +515,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -481,7 +526,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -511,7 +559,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -521,7 +570,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -531,7 +581,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -561,7 +614,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -571,7 +625,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -581,7 +636,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -591,7 +647,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -611,7 +669,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -621,7 +680,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -631,7 +691,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -641,7 +702,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -651,7 +713,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -661,7 +724,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -671,7 +735,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -681,7 +746,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -691,7 +757,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -731,7 +801,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -741,7 +812,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -751,7 +823,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -761,7 +834,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -771,7 +845,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -791,7 +867,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -801,7 +878,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -811,7 +889,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -821,7 +900,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The disk image to which the billing item points. -Type: **SoftLayer_Virtual_Disk_Image ** +Type: **SoftLayer_Virtual_Disk_Image ** + @@ -831,7 +911,8 @@ The disk image to which the billing item points. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -841,7 +922,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -851,7 +933,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -863,7 +946,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1188,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_Guest/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_Guest/_index.md index 5c8404750f..3dcf711972 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_Guest/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_Guest/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Virtual_Guest data type contains general information relating to a single SoftLayer billing item for guests. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Virtual_Guest data type contains general information [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [resourceTableId]: #resourcetableid #### [resourceTableId] The resource (unique identifier) for a server billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ The resource (unique identifier) for a server billing item. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -325,7 +355,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -335,7 +366,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -351,7 +383,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -381,7 +416,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -411,7 +449,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -421,7 +460,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -461,7 +504,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -471,7 +515,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -481,7 +526,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -511,7 +559,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -521,7 +570,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -531,7 +581,8 @@ A billing item's recurring child items that have once been billed and are schedu [billingCycleBandwidthUsage]: #billingcyclebandwidthusage #### [billingCycleBandwidthUsage] The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -541,7 +592,8 @@ The raw bandwidth usage data for the current billing cycle. One object will be r [billingCyclePrivateBandwidthUsage]: #billingcycleprivatebandwidthusage #### [billingCyclePrivateBandwidthUsage] The raw private bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -551,7 +603,8 @@ The raw private bandwidth usage data for the current billing cycle. [billingCyclePrivateUsageIn]: #billingcycleprivateusagein #### [billingCyclePrivateUsageIn] The total private inbound bandwidth for this virtual server for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -561,7 +614,8 @@ The total private inbound bandwidth for this virtual server for the current bill [billingCyclePrivateUsageOut]: #billingcycleprivateusageout #### [billingCyclePrivateUsageOut] The total private outbound bandwidth for this virtual server for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -571,7 +625,8 @@ The total private outbound bandwidth for this virtual server for the current bil [billingCyclePrivateUsageTotal]: #billingcycleprivateusagetotal #### [billingCyclePrivateUsageTotal] The total private bandwidth for this virtual server for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -581,7 +636,8 @@ The total private bandwidth for this virtual server for the current billing cycl [billingCyclePublicBandwidthUsage]: #billingcyclepublicbandwidthusage #### [billingCyclePublicBandwidthUsage] The raw public bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -591,7 +647,8 @@ The raw public bandwidth usage data for the current billing cycle. [billingCyclePublicUsageIn]: #billingcyclepublicusagein #### [billingCyclePublicUsageIn] The total public inbound bandwidth for this virtual server for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -601,7 +658,8 @@ The total public inbound bandwidth for this virtual server for the current billi [billingCyclePublicUsageOut]: #billingcyclepublicusageout #### [billingCyclePublicUsageOut] The total public outbound bandwidth for this virtual server for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -611,7 +669,8 @@ The total public outbound bandwidth for this virtual server for the current bill [billingCyclePublicUsageTotal]: #billingcyclepublicusagetotal #### [billingCyclePublicUsageTotal] The total public bandwidth for this virtual server for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -621,7 +680,8 @@ The total public bandwidth for this virtual server for the current billing cycle [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -631,7 +691,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -641,7 +702,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -651,7 +713,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -661,7 +724,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -671,7 +735,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -681,7 +746,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -691,7 +757,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -701,7 +768,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -711,7 +779,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -721,7 +790,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -731,7 +801,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -741,7 +812,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -751,7 +823,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -761,7 +834,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -771,7 +845,8 @@ The location of the billing item. Some billing items have physical properties su [monitoringBillingItems]: #monitoringbillingitems #### [monitoringBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -781,7 +856,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -791,7 +867,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -801,7 +878,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -811,7 +889,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -821,7 +900,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -831,7 +911,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -841,7 +922,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -851,7 +933,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -861,7 +944,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -871,7 +955,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -881,7 +966,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -891,7 +977,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -901,7 +988,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -911,7 +999,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -921,7 +1010,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The resource for a cloud server billing item. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -931,7 +1021,8 @@ The resource for a cloud server billing item. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -941,7 +1032,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -951,7 +1043,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -963,7 +1056,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of a billing item's recurring child items that have once been billed and [billingCycleBandwidthUsageCount]: #billingcyclebandwidthusagecount #### [billingCycleBandwidthUsageCount] A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1188,8 @@ A count of the raw bandwidth usage data for the current billing cycle. One objec [billingCyclePrivateBandwidthUsageCount]: #billingcycleprivatebandwidthusagecount #### [billingCyclePrivateBandwidthUsageCount] A count of the raw private bandwidth usage data for the current billing cycle. -Type: **unsigned long** +Type: **unsigned long** + @@ -1093,7 +1199,8 @@ A count of the raw private bandwidth usage data for the current billing cycle. [billingCyclePublicBandwidthUsageCount]: #billingcyclepublicbandwidthusagecount #### [billingCyclePublicBandwidthUsageCount] A count of the raw public bandwidth usage data for the current billing cycle. -Type: **unsigned long** +Type: **unsigned long** + @@ -1103,7 +1210,8 @@ A count of the raw public bandwidth usage data for the current billing cycle. [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -1113,7 +1221,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1123,7 +1232,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1133,7 +1243,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1143,7 +1254,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1153,7 +1265,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1163,7 +1276,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1173,7 +1287,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1183,7 +1298,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1193,7 +1309,8 @@ A count of all invoice items associated with the billing item [monitoringBillingItemCount]: #monitoringbillingitemcount #### [monitoringBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1203,7 +1320,8 @@ A count of [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1213,7 +1331,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1223,7 +1342,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_Host_Usage/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_Host_Usage/_index.md index a5acde73c9..9a13d20818 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_Host_Usage/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_Host_Usage/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Virtual_Host_Usage data type contains general information relating to a single SoftLayer billing item for virtual machine peak usage @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Virtual_Host_Usage data type contains general informa [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [resourceTableId]: #resourcetableid #### [resourceTableId] The resource (unique identifier) for a server billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ The resource (unique identifier) for a server billing item. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -325,7 +355,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -335,7 +366,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -351,7 +383,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -381,7 +416,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -411,7 +449,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -421,7 +460,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -461,7 +504,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -471,7 +515,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -481,7 +526,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -511,7 +559,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -521,7 +570,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -531,7 +581,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -561,7 +614,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -571,7 +625,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -581,7 +636,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -591,7 +647,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -611,7 +669,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -621,7 +680,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -631,7 +691,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -641,7 +702,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -651,7 +713,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -661,7 +724,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -671,7 +735,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -681,7 +746,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -691,7 +757,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -731,7 +801,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -741,7 +812,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -751,7 +823,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -761,7 +834,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -771,7 +845,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -791,7 +867,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -801,7 +878,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -811,7 +889,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -821,7 +900,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The resource for a peak virtual machine usage billing item. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -831,7 +911,8 @@ The resource for a peak virtual machine usage billing item. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -841,7 +922,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -851,7 +933,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -863,7 +946,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1188,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_ReservedCapacity/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_ReservedCapacity/_index.md index 69f3698787..1d37bb208b 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_ReservedCapacity/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Virtual_ReservedCapacity/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [resource]: #resource #### [resource] The resource for a virtual dedicated host billing item. -Type: **SoftLayer_Virtual_ReservedCapacityGroup_Instance ** +Type: **SoftLayer_Virtual_ReservedCapacityGroup_Instance ** + @@ -821,7 +900,8 @@ The resource for a virtual dedicated host billing item. [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -831,7 +911,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -841,7 +922,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -853,7 +935,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Workspace/_index.md b/content/reference/datatypes/SoftLayer_Billing_Item_Workspace/_index.md index a2ef897d92..e4bd1e0c8f 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Workspace/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Item_Workspace/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Item_Workspace data type contains general information relating to a single SoftLayer billing item whose item category code is 'workspace' @@ -45,7 +47,8 @@ The SoftLayer_Billing_Item_Workspace data type contains general information rela [allowCancellationFlag]: #allowcancellationflag #### [allowCancellationFlag] Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. [associatedBillingItemId]: #associatedbillingitemid #### [associatedBillingItemId] This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling [SoftLayer_Billing_Item::setAssociationId]({{}}). This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is sometimes populated for orphan billing items that are not attached to se [cancellationDate]: #cancellationdate #### [cancellationDate] A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ A billing item's cancellation date. A billing item with a cancellation date in t [categoryCode]: #categorycode #### [categoryCode] The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The category code of this billing item. It is used to tell us the difference bet [createDate]: #createdate #### [createDate] The date the billing item was created. You can see this date on the invoice. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date the billing item was created. You can see this date on the invoice. [currentHourlyCharge]: #currenthourlycharge #### [currentHourlyCharge] This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the total charge for the billing item for this billing item. It is calcu [cycleStartDate]: #cyclestartdate #### [cycleStartDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The last time this billing item was charged. [description]: #description #### [description] A brief description of a billing item. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A brief description of a billing item. [domainName]: #domainname #### [domainName] The domain name is provided for server billing items. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The domain name is provided for server billing items. [hostName]: #hostname #### [hostName] The hostname is provided for server billing items -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The hostname is provided for server billing items [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -155,7 +168,8 @@ The amount of money charged per hour for a billing item, if applicable. hourlyRe [hoursUsed]: #hoursused #### [hoursUsed] This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ This is the number of hours the hourly billing item has been in use this billing [id]: #id #### [id] The unique identifier for this billing item. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The unique identifier for this billing item. [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [lastBillDate]: #lastbilldate #### [lastBillDate] The last time this billing item was charged. -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ The last time this billing item was charged. [modifyDate]: #modifydate #### [modifyDate] The date that a billing item was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +234,8 @@ The date that a billing item was last modified. [nextBillDate]: #nextbilldate #### [nextBillDate] The date on which your account will be charged for this billing item. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date on which your account will be charged for this billing item. [notes]: #notes #### [notes] Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Extra information provided to help you identify this billing item. This is often [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of money charged as a one-time charge for a billing item, if applicab [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -255,7 +278,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [orderItemId]: #orderitemid #### [orderItemId] the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. -Type: **integer** +Type: **integer** + @@ -265,7 +289,8 @@ the SoftLayer_Billing_Order_Item ID. This is a reference to the original order i [parentId]: #parentid #### [parentId] The unique identifier of the parent of this billing item. -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ The unique identifier of the parent of this billing item. [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -285,7 +311,8 @@ The amount of money charged per month for a billing item, if applicable. recurri [recurringFeeTaxRate]: #recurringfeetaxrate #### [recurringFeeTaxRate] The rate at which recurring fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -295,7 +322,8 @@ The rate at which recurring fees are taxed if you are a taxable customer. [recurringMonths]: #recurringmonths #### [recurringMonths] The number of months in which the recurring fees will be incurred. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of months in which the recurring fees will be incurred. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] This is the service provider for this billing item. -Type: **integer** +Type: **integer** + @@ -315,7 +344,8 @@ This is the service provider for this billing item. [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -325,7 +355,8 @@ The setup fee, if any. This is a one time charge. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -341,7 +372,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -351,7 +383,8 @@ The account that a billing item belongs to. [activeAgreement]: #activeagreement #### [activeAgreement] -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -361,7 +394,8 @@ The account that a billing item belongs to. [activeAgreementFlag]: #activeagreementflag #### [activeAgreementFlag] A flag indicating that the billing item is under an active agreement. -Type: **SoftLayer_Account_Agreement ** +Type: **SoftLayer_Account_Agreement ** + @@ -371,7 +405,8 @@ A flag indicating that the billing item is under an active agreement. [activeAssociatedChildren]: #activeassociatedchildren #### [activeAssociatedChildren] A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -381,7 +416,8 @@ A billing item's active associated child billing items. This includes "floating" [activeAssociatedGuestDiskBillingItems]: #activeassociatedguestdiskbillingitems #### [activeAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -391,7 +427,8 @@ A billing item's active associated child billing items. This includes "floating" [activeBundledItems]: #activebundleditems #### [activeBundledItems] A Billing Item's active bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -401,7 +438,8 @@ A Billing Item's active bundled billing items. [activeCancellationItem]: #activecancellationitem #### [activeCancellationItem] A service cancellation request item that corresponds to the billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** +Type: **SoftLayer_Billing_Item_Cancellation_Request_Item ** + @@ -411,7 +449,8 @@ A service cancellation request item that corresponds to the billing item. [activeChildren]: #activechildren #### [activeChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -421,7 +460,8 @@ A Billing Item's active child billing items. [activeFlag]: #activeflag #### [activeFlag] -Type: **boolean** +Type: **boolean** + @@ -431,7 +471,8 @@ A Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItems]: #activesparepoolassociatedguestdiskbillingitems #### [activeSparePoolAssociatedGuestDiskBillingItems] -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -441,7 +482,8 @@ A Billing Item's active child billing items. [activeSparePoolBundledItems]: #activesparepoolbundleditems #### [activeSparePoolBundledItems] A Billing Item's spare pool bundled billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -451,7 +493,8 @@ A Billing Item's spare pool bundled billing items. [associatedBillingItem]: #associatedbillingitem #### [associatedBillingItem] A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -461,7 +504,8 @@ A billing item's associated parent. This is to be used for billing items that ar [associatedBillingItemHistory]: #associatedbillingitemhistory #### [associatedBillingItemHistory] A history of billing items which a billing item has been associated with. -Type: **SoftLayer_Billing_Item_Association_History[] ** +Type: **SoftLayer_Billing_Item_Association_History[] ** + @@ -471,7 +515,8 @@ A history of billing items which a billing item has been associated with. [associatedChildren]: #associatedchildren #### [associatedChildren] A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -481,7 +526,8 @@ A Billing Item's associated child billing items. This includes "floating" items [associatedParent]: #associatedparent #### [associatedParent] A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -491,7 +537,8 @@ A billing item's associated parent billing item. This object will be the same as [availableMatchingVlans]: #availablematchingvlans #### [availableMatchingVlans] -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -501,7 +548,8 @@ A billing item's associated parent billing item. This object will be the same as [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] The bandwidth allocation for a billing item. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -511,7 +559,8 @@ The bandwidth allocation for a billing item. [billableChildren]: #billablechildren #### [billableChildren] A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -521,7 +570,8 @@ A billing item's recurring child items that have once been billed and are schedu [bundleItems]: #bundleitems #### [bundleItems] A Billing Item's bundled billing items -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -531,7 +581,8 @@ A Billing Item's bundled billing items [bundledItems]: #bundleditems #### [bundledItems] A Billing Item's bundled billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -541,7 +592,8 @@ A Billing Item's bundled billing items' [canceledChildren]: #canceledchildren #### [canceledChildren] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -551,7 +603,8 @@ A Billing Item's active child billing items. [cancellationReason]: #cancellationreason #### [cancellationReason] The billing item's cancellation reason. -Type: **SoftLayer_Billing_Item_Cancellation_Reason ** +Type: **SoftLayer_Billing_Item_Cancellation_Reason ** + @@ -561,7 +614,8 @@ The billing item's cancellation reason. [cancellationRequests]: #cancellationrequests #### [cancellationRequests] This will return any cancellation requests that are associated with this billing item. -Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** +Type: **SoftLayer_Billing_Item_Cancellation_Request[] ** + @@ -571,7 +625,8 @@ This will return any cancellation requests that are associated with this billing [category]: #category #### [category] The item category to which the billing item's item belongs. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -581,7 +636,8 @@ The item category to which the billing item's item belongs. [children]: #children #### [children] A Billing Item's child billing items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -591,7 +647,8 @@ A Billing Item's child billing items' [childrenWithActiveAgreement]: #childrenwithactiveagreement #### [childrenWithActiveAgreement] A Billing Item's active child billing items. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -601,7 +658,8 @@ A Billing Item's active child billing items. [downgradeItems]: #downgradeitems #### [downgradeItems] For product items which have a downgrade path defined, this will return those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -611,7 +669,8 @@ For product items which have a downgrade path defined, this will return those pr [filteredNextInvoiceChildren]: #filterednextinvoicechildren #### [filteredNextInvoiceChildren] A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -621,7 +680,8 @@ A Billing Item's associated child billing items, excluding some items with a $0. [hourlyFlag]: #hourlyflag #### [hourlyFlag] A flag that will reflect whether this billing item is billed on an hourly basis or not. -Type: **boolean** +Type: **boolean** + @@ -631,7 +691,8 @@ A flag that will reflect whether this billing item is billed on an hourly basis [invoiceItem]: #invoiceitem #### [invoiceItem] Invoice items associated with this billing item -Type: **SoftLayer_Billing_Invoice_Item ** +Type: **SoftLayer_Billing_Invoice_Item ** + @@ -641,7 +702,8 @@ Invoice items associated with this billing item [invoiceItems]: #invoiceitems #### [invoiceItems] All invoice items associated with the billing item -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -651,7 +713,8 @@ All invoice items associated with the billing item [item]: #item #### [item] The entry in the SoftLayer product catalog that a billing item is based upon. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -661,7 +724,8 @@ The entry in the SoftLayer product catalog that a billing item is based upon. [location]: #location #### [location] The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -671,7 +735,8 @@ The location of the billing item. Some billing items have physical properties su [nextInvoiceChildren]: #nextinvoicechildren #### [nextInvoiceChildren] A Billing Item's child billing items and associated items' -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -681,7 +746,8 @@ A Billing Item's child billing items and associated items' [nextInvoiceTotalOneTimeAmount]: #nextinvoicetotalonetimeamount #### [nextInvoiceTotalOneTimeAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -691,7 +757,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalOneTimeTaxAmount]: #nextinvoicetotalonetimetaxamount #### [nextInvoiceTotalOneTimeTaxAmount] A Billing Item's total, including any child billing items if they exist.' -Type: **float** +Type: **float** + @@ -701,7 +768,8 @@ A Billing Item's total, including any child billing items if they exist.' [nextInvoiceTotalRecurringAmount]: #nextinvoicetotalrecurringamount #### [nextInvoiceTotalRecurringAmount] A Billing Item's total, including any child billing items and associated billing items if they exist.' -Type: **float** +Type: **float** + @@ -711,7 +779,8 @@ A Billing Item's total, including any child billing items and associated billing [nextInvoiceTotalRecurringTaxAmount]: #nextinvoicetotalrecurringtaxamount #### [nextInvoiceTotalRecurringTaxAmount] This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. -Type: **float** +Type: **float** + @@ -721,7 +790,8 @@ This is deprecated and will always be zero. Because tax is calculated in real-ti [nonZeroNextInvoiceChildren]: #nonzeronextinvoicechildren #### [nonZeroNextInvoiceChildren] A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -731,7 +801,8 @@ A Billing Item's associated child billing items, excluding ALL items with a $0.0 [orderItem]: #orderitem #### [orderItem] A billing item's original order item. Simply a reference to the original order from which this billing item was created. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -741,7 +812,8 @@ A billing item's original order item. Simply a reference to the original order f [originalLocation]: #originallocation #### [originalLocation] The original physical location for this billing item--may differ from current. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -751,7 +823,8 @@ The original physical location for this billing item--may differ from current. [package]: #package #### [package] The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -761,7 +834,8 @@ The package under which this billing item was sold. A Package is the general gro [parent]: #parent #### [parent] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -771,7 +845,8 @@ A billing item's parent item. If a billing item has no parent item then this val [parentVirtualGuestBillingItem]: #parentvirtualguestbillingitem #### [parentVirtualGuestBillingItem] A billing item's parent item. If a billing item has no parent item then this value is null. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -781,7 +856,8 @@ A billing item's parent item. If a billing item has no parent item then this val [pendingCancellationFlag]: #pendingcancellationflag #### [pendingCancellationFlag] This flag indicates whether a billing item is scheduled to be canceled or not. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ This flag indicates whether a billing item is scheduled to be canceled or not. [pendingOrderItem]: #pendingorderitem #### [pendingOrderItem] The new order item that will replace this billing item. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -801,7 +878,8 @@ The new order item that will replace this billing item. [provisionTransaction]: #provisiontransaction #### [provisionTransaction] Provisioning transaction for this billing item -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -811,7 +889,8 @@ Provisioning transaction for this billing item [softwareDescription]: #softwaredescription #### [softwareDescription] A friendly description of software component -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -821,7 +900,8 @@ A friendly description of software component [upgradeItem]: #upgradeitem #### [upgradeItem] Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -831,7 +911,8 @@ Billing items whose product item has an upgrade path defined in our system will [upgradeItems]: #upgradeitems #### [upgradeItems] Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -843,7 +924,8 @@ Billing items whose product item has an upgrade path defined in our system will [activeAssociatedChildrenCount]: #activeassociatedchildrencount #### [activeAssociatedChildrenCount] A count of a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -853,7 +935,8 @@ A count of a billing item's active associated child billing items. This includes [activeAssociatedGuestDiskBillingItemCount]: #activeassociatedguestdiskbillingitemcount #### [activeAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -863,7 +946,8 @@ A count of [activeBundledItemCount]: #activebundleditemcount #### [activeBundledItemCount] A count of a Billing Item's active bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -873,7 +957,8 @@ A count of a Billing Item's active bundled billing items. [activeChildrenCount]: #activechildrencount #### [activeChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -883,7 +968,8 @@ A count of a Billing Item's active child billing items. [activeSparePoolAssociatedGuestDiskBillingItemCount]: #activesparepoolassociatedguestdiskbillingitemcount #### [activeSparePoolAssociatedGuestDiskBillingItemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -893,7 +979,8 @@ A count of [activeSparePoolBundledItemCount]: #activesparepoolbundleditemcount #### [activeSparePoolBundledItemCount] A count of a Billing Item's spare pool bundled billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -903,7 +990,8 @@ A count of a Billing Item's spare pool bundled billing items. [associatedBillingItemHistoryCount]: #associatedbillingitemhistorycount #### [associatedBillingItemHistoryCount] A count of a history of billing items which a billing item has been associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -913,7 +1001,8 @@ A count of a history of billing items which a billing item has been associated w [associatedChildrenCount]: #associatedchildrencount #### [associatedChildrenCount] A count of a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -923,7 +1012,8 @@ A count of a Billing Item's associated child billing items. This includes "float [associatedParentCount]: #associatedparentcount #### [associatedParentCount] A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. -Type: **unsigned long** +Type: **unsigned long** + @@ -933,7 +1023,8 @@ A count of a billing item's associated parent billing item. This object will be [availableMatchingVlanCount]: #availablematchingvlancount #### [availableMatchingVlanCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -943,7 +1034,8 @@ A count of [billableChildrenCount]: #billablechildrencount #### [billableChildrenCount] A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. -Type: **unsigned long** +Type: **unsigned long** + @@ -953,7 +1045,8 @@ A count of a billing item's recurring child items that have once been billed and [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of a Billing Item's bundled billing items -Type: **unsigned long** +Type: **unsigned long** + @@ -963,7 +1056,8 @@ A count of a Billing Item's bundled billing items [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of a Billing Item's bundled billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -973,7 +1067,8 @@ A count of a Billing Item's bundled billing items' [canceledChildrenCount]: #canceledchildrencount #### [canceledChildrenCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of a Billing Item's active child billing items. [cancellationRequestCount]: #cancellationrequestcount #### [cancellationRequestCount] A count of this will return any cancellation requests that are associated with this billing item. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of this will return any cancellation requests that are associated with t [childrenCount]: #childrencount #### [childrenCount] A count of a Billing Item's child billing items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a Billing Item's child billing items' [childrenWithActiveAgreementCount]: #childrenwithactiveagreementcount #### [childrenWithActiveAgreementCount] A count of a Billing Item's active child billing items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a Billing Item's active child billing items. [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of for product items which have a downgrade path defined, this will return those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of for product items which have a downgrade path defined, this will retu [filteredNextInvoiceChildrenCount]: #filterednextinvoicechildrencount #### [filteredNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of a Billing Item's associated child billing items, excluding some items [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of all invoice items associated with the billing item -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of all invoice items associated with the billing item [nextInvoiceChildrenCount]: #nextinvoicechildrencount #### [nextInvoiceChildrenCount] A count of a Billing Item's child billing items and associated items' -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a Billing Item's child billing items and associated items' [nonZeroNextInvoiceChildrenCount]: #nonzeronextinvoicechildrencount #### [nonZeroNextInvoiceChildrenCount] A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of a Billing Item's associated child billing items, excluding ALL items [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Order/_index.md b/content/reference/datatypes/SoftLayer_Billing_Order/_index.md index 721869dd96..9f6908ca7f 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Order/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Order/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -55,7 +57,8 @@ The SoftLayer_Billing_Order data type contains general information relating to a [accountId]: #accountid #### [accountId] The account ID to which an order belongs. -Type: **integer** +Type: **integer** + @@ -65,7 +68,8 @@ The account ID to which an order belongs. [createDate]: #createdate #### [createDate] The point in time at which a billing item was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +79,8 @@ The point in time at which a billing item was created. [id]: #id #### [id] * -Type: **integer** +Type: **integer** + @@ -85,7 +90,8 @@ The point in time at which a billing item was created. [impersonatingUserRecordId]: #impersonatinguserrecordid #### [impersonatingUserRecordId] The SoftLayer_User_Customer id of the portal or API user who impersonated the user which submitted an order. -Type: **integer** +Type: **integer** + @@ -95,7 +101,8 @@ The SoftLayer_User_Customer id of the portal or API user who impersonated the us [modifyDate]: #modifydate #### [modifyDate] The last time an order was updated. -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +112,8 @@ The last time an order was updated. [orderQuoteId]: #orderquoteid #### [orderQuoteId] The SoftLayer_Billing_Order_Quote id of the quote's user who finalized an order. -Type: **integer** +Type: **integer** + @@ -115,7 +123,8 @@ The SoftLayer_Billing_Order_Quote id of the quote's user who finalized an order. [orderTypeId]: #ordertypeid #### [orderTypeId] The SoftLayer_Billing_Order_Type id of the order. -Type: **integer** +Type: **integer** + @@ -125,7 +134,8 @@ The SoftLayer_Billing_Order_Type id of the order. [presaleEventId]: #presaleeventid #### [presaleEventId] -Type: **integer** +Type: **integer** + @@ -135,7 +145,8 @@ The SoftLayer_Billing_Order_Type id of the order. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag indicating a private cloud solution order (Deprecated) -Type: **boolean** +Type: **boolean** + @@ -145,7 +156,8 @@ Flag indicating a private cloud solution order (Deprecated) [status]: #status #### [status] Purchaser current status e.i. Approved, Pending_Approval -Type: **string** +Type: **string** + @@ -155,7 +167,8 @@ Purchaser current status e.i. Approved, Pending_Approval [userRecordId]: #userrecordid #### [userRecordId] The SoftLayer_User_Customer id of the portal or API user who submitted an order. -Type: **integer** +Type: **integer** + @@ -171,7 +184,8 @@ The SoftLayer_User_Customer id of the portal or API user who submitted an order. [account]: #account #### [account] The [SoftLayer_Account]({{}}) to which an order belongs. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -181,7 +195,8 @@ The [SoftLayer_Account]({{}}) to wh [brand]: #brand #### [brand] -Type: **SoftLayer_Brand ** +Type: **SoftLayer_Brand ** + @@ -191,7 +206,8 @@ The [SoftLayer_Account]({{}}) to wh [cart]: #cart #### [cart] A cart is similar to a quote, except that it can be continually modified by the customer and does not have locked-in prices. Not all orders will have a cart associated with them. See [SoftLayer_Billing_Order_Cart]({{}}) for more information. -Type: **SoftLayer_Billing_Order_Cart ** +Type: **SoftLayer_Billing_Order_Cart ** + @@ -201,7 +217,8 @@ A cart is similar to a quote, except that it can be continually modified by the [coreRestrictedItems]: #corerestricteditems #### [coreRestrictedItems] The [SoftLayer_Billing_Order_Item]({{}}) that are core restricted -Type: **SoftLayer_Billing_Order_Item[] ** +Type: **SoftLayer_Billing_Order_Item[] ** + @@ -211,7 +228,8 @@ The [SoftLayer_Billing_Order_Item]({{Type: **SoftLayer_Billing_Payment_Card_Transaction[] ** +Type: **SoftLayer_Billing_Payment_Card_Transaction[] ** + @@ -221,7 +239,8 @@ All credit card transactions associated with this order. If this order was not p [exchangeRate]: #exchangerate #### [exchangeRate] -Type: **SoftLayer_Billing_Currency_ExchangeRate ** +Type: **SoftLayer_Billing_Currency_ExchangeRate ** + @@ -231,7 +250,8 @@ All credit card transactions associated with this order. If this order was not p [initialInvoice]: #initialinvoice #### [initialInvoice] -Type: **SoftLayer_Billing_Invoice ** +Type: **SoftLayer_Billing_Invoice ** + @@ -241,7 +261,8 @@ All credit card transactions associated with this order. If this order was not p [items]: #items #### [items] The SoftLayer_Billing_Order_items included in an order. -Type: **SoftLayer_Billing_Order_Item[] ** +Type: **SoftLayer_Billing_Order_Item[] ** + @@ -251,7 +272,8 @@ The SoftLayer_Billing_Order_items included in an order. [orderApprovalDate]: #orderapprovaldate #### [orderApprovalDate] -Type: **dateTime** +Type: **dateTime** + @@ -261,7 +283,8 @@ The SoftLayer_Billing_Order_items included in an order. [orderNonServerMonthlyAmount]: #ordernonservermonthlyamount #### [orderNonServerMonthlyAmount] An order's non-server items total monthly fee. -Type: **decimal** +Type: **decimal** + @@ -271,7 +294,8 @@ An order's non-server items total monthly fee. [orderServerMonthlyAmount]: #orderservermonthlyamount #### [orderServerMonthlyAmount] An order's server items total monthly fee. -Type: **decimal** +Type: **decimal** + @@ -281,7 +305,8 @@ An order's server items total monthly fee. [orderTopLevelItems]: #ordertoplevelitems #### [orderTopLevelItems] An order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI. -Type: **SoftLayer_Billing_Order_Item[] ** +Type: **SoftLayer_Billing_Order_Item[] ** + @@ -291,7 +316,8 @@ An order's top level items. This normally includes the server line item and any [orderTotalAmount]: #ordertotalamount #### [orderTotalAmount] This amount represents the order's initial charge including set up fee and taxes. -Type: **decimal** +Type: **decimal** + @@ -301,7 +327,8 @@ This amount represents the order's initial charge including set up fee and taxes [orderTotalOneTime]: #ordertotalonetime #### [orderTotalOneTime] An order's total one time amount summing all the set up fees, the labor fees and the one time fees. Taxes will be applied for non-tax-exempt. This amount represents the initial fees that will be charged. -Type: **decimal** +Type: **decimal** + @@ -311,7 +338,8 @@ An order's total one time amount summing all the set up fees, the labor fees and [orderTotalOneTimeAmount]: #ordertotalonetimeamount #### [orderTotalOneTimeAmount] An order's total one time amount. This amount represents the initial fees before tax. -Type: **decimal** +Type: **decimal** + @@ -321,7 +349,8 @@ An order's total one time amount. This amount represents the initial fees before [orderTotalOneTimeTaxAmount]: #ordertotalonetimetaxamount #### [orderTotalOneTimeTaxAmount] An order's total one time tax amount. This amount represents the tax that will be applied to the total charge, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account. -Type: **decimal** +Type: **decimal** + @@ -331,7 +360,8 @@ An order's total one time tax amount. This amount represents the tax that will b [orderTotalRecurring]: #ordertotalrecurring #### [orderTotalRecurring] An order's total recurring amount. Taxes will be applied for non-tax-exempt. This amount represents the fees that will be charged on a recurring (usually monthly) basis. -Type: **decimal** +Type: **decimal** + @@ -341,7 +371,8 @@ An order's total recurring amount. Taxes will be applied for non-tax-exempt. Thi [orderTotalRecurringAmount]: #ordertotalrecurringamount #### [orderTotalRecurringAmount] An order's total recurring amount. This amount represents the fees that will be charged on a recurring (usually monthly) basis. -Type: **decimal** +Type: **decimal** + @@ -351,7 +382,8 @@ An order's total recurring amount. This amount represents the fees that will be [orderTotalRecurringTaxAmount]: #ordertotalrecurringtaxamount #### [orderTotalRecurringTaxAmount] The total tax amount of the recurring fees, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account. -Type: **decimal** +Type: **decimal** + @@ -361,7 +393,8 @@ The total tax amount of the recurring fees, if the SoftLayer_Account tied to a S [orderTotalSetupAmount]: #ordertotalsetupamount #### [orderTotalSetupAmount] An order's total setup fee. -Type: **decimal** +Type: **decimal** + @@ -371,7 +404,8 @@ An order's total setup fee. [orderType]: #ordertype #### [orderType] The type of an order. This lets you know where this order was generated from. -Type: **SoftLayer_Billing_Order_Type ** +Type: **SoftLayer_Billing_Order_Type ** + @@ -381,7 +415,8 @@ The type of an order. This lets you know where this order was generated from. [paypalTransactions]: #paypaltransactions #### [paypalTransactions] All PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty. -Type: **SoftLayer_Billing_Payment_PayPal_Transaction[] ** +Type: **SoftLayer_Billing_Payment_PayPal_Transaction[] ** + @@ -391,7 +426,8 @@ All PayPal transactions associated with this order. If this order was not placed [presaleEvent]: #presaleevent #### [presaleEvent] -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -401,7 +437,8 @@ All PayPal transactions associated with this order. If this order was not placed [quote]: #quote #### [quote] The quote of an order. This quote holds information about its expiration date, creation date, name and status. This information is tied to an order having the status 'QUOTE' -Type: **SoftLayer_Billing_Order_Quote ** +Type: **SoftLayer_Billing_Order_Quote ** + @@ -411,7 +448,8 @@ The quote of an order. This quote holds information about its expiration date, c [referralPartner]: #referralpartner #### [referralPartner] The Referral Partner who referred this order. (Only necessary for new customer orders) -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -421,7 +459,8 @@ The Referral Partner who referred this order. (Only necessary for new customer o [upgradeRequestFlag]: #upgraderequestflag #### [upgradeRequestFlag] This flag indicates an order is an upgrade. -Type: **boolean** +Type: **boolean** + @@ -431,7 +470,8 @@ This flag indicates an order is an upgrade. [userRecord]: #userrecord #### [userRecord] The SoftLayer_User_Customer object tied to an order. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -443,7 +483,8 @@ The SoftLayer_User_Customer object tied to an order. [coreRestrictedItemCount]: #corerestricteditemcount #### [coreRestrictedItemCount] A count of the [SoftLayer_Billing_Order_Item]({{}}) that are core restricted -Type: **unsigned long** +Type: **unsigned long** + @@ -453,7 +494,8 @@ A count of the [SoftLayer_Billing_Order_Item]({{Type: **unsigned long** +Type: **unsigned long** + @@ -463,7 +505,8 @@ A count of all credit card transactions associated with this order. If this orde [itemCount]: #itemcount #### [itemCount] A count of the SoftLayer_Billing_Order_items included in an order. -Type: **unsigned long** +Type: **unsigned long** + @@ -473,7 +516,8 @@ A count of the SoftLayer_Billing_Order_items included in an order. [orderTopLevelItemCount]: #ordertoplevelitemcount #### [orderTopLevelItemCount] A count of an order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI. -Type: **unsigned long** +Type: **unsigned long** + @@ -483,7 +527,8 @@ A count of an order's top level items. This normally includes the server line it [paypalTransactionCount]: #paypaltransactioncount #### [paypalTransactionCount] A count of all PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Order_Cart/_index.md b/content/reference/datatypes/SoftLayer_Billing_Order_Cart/_index.md index d48aeb04ff..a959d69451 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Order_Cart/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Order_Cart/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] Identification Number of the account record tied to the quote -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ Identification Number of the account record tied to the quote [completedPurchaseDataId]: #completedpurchasedataid #### [completedPurchaseDataId] Identification Number of the order record tied to the quote. -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ Identification Number of the order record tied to the quote. [createDate]: #createdate #### [createDate] Holds the date the quote record was created -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ Holds the date the quote record was created [expirationDate]: #expirationdate #### [expirationDate] This property holds the date of expiration of a quote, after that date the quote would be deem expired -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ This property holds the date of expiration of a quote, after that date the quote [id]: #id #### [id] The id use to identify a quote. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The id use to identify a quote. [modifyDate]: #modifydate #### [modifyDate] Holds the date when the quote record was modified with reference to its creation date -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ Holds the date when the quote record was modified with reference to its creation [name]: #name #### [name] The name given to quote by the initiator -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The name given to quote by the initiator [publicNote]: #publicnote #### [publicNote] This property Holds system generated notes. In our case if a quote is tied to an order where one of the order item has an inactive promotion code, the quote will be considered invalid. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ This property Holds system generated notes. In our case if a quote is tied to an [quoteKey]: #quotekey #### [quoteKey] Holds system generated hash password for the Quote -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Holds system generated hash password for the Quote [status]: #status #### [status] This property Holds the current status of a Quote: pending,expired, saved or deleted -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This property Holds the current status of a Quote: pending,expired, saved or del [account]: #account #### [account] A quote's corresponding account. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -161,7 +174,8 @@ A quote's corresponding account. [doNotContactFlag]: #donotcontactflag #### [doNotContactFlag] Indicates whether the owner of the quote chosen to no longer be contacted. -Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ Indicates whether the owner of the quote chosen to no longer be contacted. [order]: #order #### [order] This order contains the records for which products were selected for this quote. -Type: **SoftLayer_Billing_Order ** +Type: **SoftLayer_Billing_Order ** + @@ -181,7 +196,8 @@ This order contains the records for which products were selected for this quote. [ordersFromQuote]: #ordersfromquote #### [ordersFromQuote] These are all the orders that were created from this quote. -Type: **SoftLayer_Billing_Order[] ** +Type: **SoftLayer_Billing_Order[] ** + @@ -193,7 +209,8 @@ These are all the orders that were created from this quote. [ordersFromQuoteCount]: #ordersfromquotecount #### [ordersFromQuoteCount] A count of these are all the orders that were created from this quote. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Order_Item/_index.md b/content/reference/datatypes/SoftLayer_Billing_Order_Item/_index.md index d8ce47091e..616b13caf3 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Order_Item/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Order_Item/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) 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. @@ -61,7 +63,8 @@ Billing items exist in a tree relationship. Items are associated with each other [categoryCode]: #categorycode #### [categoryCode] The category code for the order item. -Type: **string** +Type: **string** + @@ -71,7 +74,8 @@ The category code for the order item. [description]: #description #### [description] friendly description of purchase item. -Type: **string** +Type: **string** + @@ -81,7 +85,8 @@ friendly description of purchase item. [domainName]: #domainname #### [domainName] The domain name of the server as designated by the purchaser at the time of order placement. -Type: **string** +Type: **string** + @@ -91,7 +96,8 @@ The domain name of the server as designated by the purchaser at the time of orde [hostName]: #hostname #### [hostName] The hostname of the server as designated by the purchaser at the time of order placement. -Type: **string** +Type: **string** + @@ -101,7 +107,8 @@ The hostname of the server as designated by the purchaser at the time of order p [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The amount of money charged per hourly for an order item, if applicable, and only if it was ordered this day. hourlyRecurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -111,7 +118,8 @@ The amount of money charged per hourly for an order item, if applicable, and onl [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -121,7 +129,8 @@ The amount of money charged per hourly for an order item, if applicable, and onl [itemId]: #itemid #### [itemId] The SoftLayer_Product_Item ID for this order item. -Type: **integer** +Type: **integer** + @@ -131,7 +140,8 @@ The SoftLayer_Product_Item ID for this order item. [itemPriceId]: #itempriceid #### [itemPriceId] the item price id (SoftLayer_Product_Item_Price->id) of the ordered item. -Type: **decimal** +Type: **decimal** + @@ -141,7 +151,8 @@ the item price id (SoftLayer_Product_Item_Price->id) of the ordered item. [laborAfterTaxAmount]: #laboraftertaxamount #### [laborAfterTaxAmount] An order item's labor fee total after taxes. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -151,7 +162,8 @@ An order item's labor fee total after taxes. This does not include any child inv [laborFee]: #laborfee #### [laborFee] The labor fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -161,7 +173,8 @@ The labor fee, if any. This is a one time charge. [laborFeeTaxRate]: #laborfeetaxrate #### [laborFeeTaxRate] The rate at which labor fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -171,7 +184,8 @@ The rate at which labor fees are taxed if you are a taxable customer. [laborTaxAmount]: #labortaxamount #### [laborTaxAmount] An order item's labor tax amount. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -181,7 +195,8 @@ An order item's labor tax amount. This does not include any child invoice items. [oneTimeAfterTaxAmount]: #onetimeaftertaxamount #### [oneTimeAfterTaxAmount] An order item's one-time fee total after taxes. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -191,7 +206,8 @@ An order item's one-time fee total after taxes. This does not include any child [oneTimeFee]: #onetimefee #### [oneTimeFee] The amount of money charged as a one-time charge for an order item, if applicable. oneTimeFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -201,7 +217,8 @@ The amount of money charged as a one-time charge for an order item, if applicabl [oneTimeFeeTaxRate]: #onetimefeetaxrate #### [oneTimeFeeTaxRate] The rate at which one time fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -211,7 +228,8 @@ The rate at which one time fees are taxed if you are a taxable customer. [oneTimeTaxAmount]: #onetimetaxamount #### [oneTimeTaxAmount] An order item's one-time tax amount. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -221,7 +239,8 @@ An order item's one-time tax amount. This does not include any child invoice ite [parentId]: #parentid #### [parentId] -Type: **integer** +Type: **integer** + @@ -231,7 +250,8 @@ An order item's one-time tax amount. This does not include any child invoice ite [presetId]: #presetid #### [presetId] The id for the preset configuration ordered. -Type: **integer** +Type: **integer** + @@ -241,7 +261,8 @@ The id for the preset configuration ordered. [promoCodeId]: #promocodeid #### [promoCodeId] -Type: **integer** +Type: **integer** + @@ -251,7 +272,8 @@ The id for the preset configuration ordered. [quantity]: #quantity #### [quantity] the quantity of the ordered item in a quote. -Type: **integer** +Type: **integer** + @@ -261,7 +283,8 @@ the quantity of the ordered item in a quote. [recurringAfterTaxAmount]: #recurringaftertaxamount #### [recurringAfterTaxAmount] An order item's recurring fee total after taxes. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -271,7 +294,8 @@ An order item's recurring fee total after taxes. This does not include any child [recurringFee]: #recurringfee #### [recurringFee] The amount of money charged per month for an order item, if applicable. recurringFee is measured in US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -281,7 +305,8 @@ The amount of money charged per month for an order item, if applicable. recurrin [recurringTaxAmount]: #recurringtaxamount #### [recurringTaxAmount] An order item's recurring tax amount. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -291,7 +316,8 @@ An order item's recurring tax amount. This does not include any child invoice it [setupAfterTaxAmount]: #setupaftertaxamount #### [setupAfterTaxAmount] An order item's setup fee total after taxes. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -301,7 +327,8 @@ An order item's setup fee total after taxes. This does not include any child inv [setupFee]: #setupfee #### [setupFee] The setup fee, if any. This is a one time charge. -Type: **decimal** +Type: **decimal** + @@ -311,7 +338,8 @@ The setup fee, if any. This is a one time charge. [setupFeeDeferralMonths]: #setupfeedeferralmonths #### [setupFeeDeferralMonths] The month set up fee deferral. -Type: **integer** +Type: **integer** + @@ -321,7 +349,8 @@ The month set up fee deferral. [setupFeeTaxRate]: #setupfeetaxrate #### [setupFeeTaxRate] The rate at which setup fees are taxed if you are a taxable customer. -Type: **decimal** +Type: **decimal** + @@ -331,7 +360,8 @@ The rate at which setup fees are taxed if you are a taxable customer. [setupTaxAmount]: #setuptaxamount #### [setupTaxAmount] An order item's setup tax amount. This does not include any child invoice items. -Type: **decimal** +Type: **decimal** + @@ -347,7 +377,8 @@ An order item's setup tax amount. This does not include any child invoice items. [billingItem]: #billingitem #### [billingItem] The SoftLayer_Billing_Item tied to the order item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -357,7 +388,8 @@ The SoftLayer_Billing_Item tied to the order item. [bundledItems]: #bundleditems #### [bundledItems] The other items included with an ordered item. -Type: **SoftLayer_Billing_Order_Item[] ** +Type: **SoftLayer_Billing_Order_Item[] ** + @@ -367,7 +399,8 @@ The other items included with an ordered item. [category]: #category #### [category] The item category tied to an order item. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -377,7 +410,8 @@ The item category tied to an order item. [children]: #children #### [children] The child order items for an order item. All server order items should have children. These children are considered a part of the server. -Type: **SoftLayer_Billing_Order_Item[] ** +Type: **SoftLayer_Billing_Order_Item[] ** + @@ -387,7 +421,8 @@ The child order items for an order item. All server order items should have chil [globalIdentifier]: #globalidentifier #### [globalIdentifier] A hardware's universally unique identifier. -Type: **string** +Type: **string** + @@ -397,7 +432,8 @@ A hardware's universally unique identifier. [hardwareGenericComponent]: #hardwaregenericcomponent #### [hardwareGenericComponent] The component type tied to an order item. All hardware-specific items should have a generic hardware component. -Type: **SoftLayer_Hardware_Component_Model_Generic ** +Type: **SoftLayer_Hardware_Component_Model_Generic ** + @@ -407,7 +443,8 @@ The component type tied to an order item. All hardware-specific items should hav [item]: #item #### [item] The SoftLayer_Product_Item tied to an order item. The item is the actual definition of the product being sold. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -417,7 +454,8 @@ The SoftLayer_Product_Item tied to an order item. The item is the actual definit [itemCategoryAnswers]: #itemcategoryanswers #### [itemCategoryAnswers] This is an item's category answers. -Type: **SoftLayer_Billing_Order_Item_Category_Answer[] ** +Type: **SoftLayer_Billing_Order_Item_Category_Answer[] ** + @@ -427,7 +465,8 @@ This is an item's category answers. [itemPrice]: #itemprice #### [itemPrice] The SoftLayer_Product_Item_Price tied to an order item. The item price object describes the cost of an item. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -437,7 +476,8 @@ The SoftLayer_Product_Item_Price tied to an order item. The item price object de [location]: #location #### [location] The location of an ordered item. This is usually the same as the server it is being ordered with. Otherwise it describes the location of the additional service being ordered. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -447,7 +487,8 @@ The location of an ordered item. This is usually the same as the server it is be [nextOrderChildren]: #nextorderchildren #### [nextOrderChildren] -Type: **SoftLayer_Billing_Order_Item[] ** +Type: **SoftLayer_Billing_Order_Item[] ** + @@ -457,7 +498,8 @@ The location of an ordered item. This is usually the same as the server it is be [oldBillingItem]: #oldbillingitem #### [oldBillingItem] This is only populated when an upgrade order is placed. The old billing item represents what the billing was before the upgrade happened. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -467,7 +509,8 @@ This is only populated when an upgrade order is placed. The old billing item rep [order]: #order #### [order] The order to which this item belongs. The order contains all the information related to the items included in an order -Type: **SoftLayer_Billing_Order ** +Type: **SoftLayer_Billing_Order ** + @@ -477,7 +520,8 @@ The order to which this item belongs. The order contains all the information rel [orderApprovalDate]: #orderapprovaldate #### [orderApprovalDate] -Type: **dateTime** +Type: **dateTime** + @@ -487,7 +531,8 @@ The order to which this item belongs. The order contains all the information rel [package]: #package #### [package] The SoftLayer_Product_Package an order item is a part of. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -497,7 +542,8 @@ The SoftLayer_Product_Package an order item is a part of. [parent]: #parent #### [parent] The parent order item ID for an item. Items that are associated with a server will have a parent. The parent will be the server item itself. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -507,7 +553,8 @@ The parent order item ID for an item. Items that are associated with a server wi [preset]: #preset #### [preset] The SoftLayer_Product_Package_Preset related to this order item. -Type: **SoftLayer_Product_Package_Preset ** +Type: **SoftLayer_Product_Package_Preset ** + @@ -517,7 +564,8 @@ The SoftLayer_Product_Package_Preset related to this order item. [promoCode]: #promocode #### [promoCode] -Type: **SoftLayer_Product_Promotion ** +Type: **SoftLayer_Product_Promotion ** + @@ -527,7 +575,8 @@ The SoftLayer_Product_Package_Preset related to this order item. [redundantPowerSupplyCount]: #redundantpowersupplycount #### [redundantPowerSupplyCount] A count of power supplies contained within this SoftLayer_Billing_Order -Type: **unsigned integer** +Type: **unsigned integer** + @@ -537,7 +586,8 @@ A count of power supplies contained within this SoftLayer_Billing_Order [softwareDescription]: #softwaredescription #### [softwareDescription] For ordered items that are software items, a full description of that software can be found with this property. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -547,7 +597,8 @@ For ordered items that are software items, a full description of that software c [storageGroups]: #storagegroups #### [storageGroups] The drive storage groups that are attached to this billing order item. -Type: **SoftLayer_Configuration_Storage_Group_Order[] ** +Type: **SoftLayer_Configuration_Storage_Group_Order[] ** + @@ -557,7 +608,8 @@ The drive storage groups that are attached to this billing order item. [totalRecurringAmount]: #totalrecurringamount #### [totalRecurringAmount] The recurring fee of an ordered item. This amount represents the fees that will be charged on a recurring (usually monthly) basis. -Type: **float** +Type: **float** + @@ -567,7 +619,8 @@ The recurring fee of an ordered item. This amount represents the fees that will [upgradeItem]: #upgradeitem #### [upgradeItem] The next SoftLayer_Product_Item in the upgrade path for this order item. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -579,7 +632,8 @@ The next SoftLayer_Product_Item in the upgrade path for this order item. [bundledItemCount]: #bundleditemcount #### [bundledItemCount] A count of the other items included with an ordered item. -Type: **unsigned long** +Type: **unsigned long** + @@ -589,7 +643,8 @@ A count of the other items included with an ordered item. [childrenCount]: #childrencount #### [childrenCount] A count of the child order items for an order item. All server order items should have children. These children are considered a part of the server. -Type: **unsigned long** +Type: **unsigned long** + @@ -599,7 +654,8 @@ A count of the child order items for an order item. All server order items shoul [itemCategoryAnswerCount]: #itemcategoryanswercount #### [itemCategoryAnswerCount] A count of this is an item's category answers. -Type: **unsigned long** +Type: **unsigned long** + @@ -609,7 +665,8 @@ A count of this is an item's category answers. [nextOrderChildrenCount]: #nextorderchildrencount #### [nextOrderChildrenCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -619,7 +676,8 @@ A count of [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of the drive storage groups that are attached to this billing order item. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Order_Item_Category_Answer/_index.md b/content/reference/datatypes/SoftLayer_Billing_Order_Item_Category_Answer/_index.md index 9bca92ed17..ec4288c1b5 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Order_Item_Category_Answer/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Order_Item_Category_Answer/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Order_Item_Category_Answer data type represents a single answer to an item category question. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Order_Item_Category_Answer data type represents a single a [answer]: #answer #### [answer] The answer to the question. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The answer to the question. [createDate]: #createdate #### [createDate] The date that the answer was created. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The date that the answer was created. [questionId]: #questionid #### [questionId] The identifier for the question that the answer belongs to. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ The identifier for the question that the answer belongs to. [orderItem]: #orderitem #### [orderItem] The billing order item that the answer is for. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -91,7 +97,8 @@ The billing order item that the answer is for. [question]: #question #### [question] The question that is being answered. -Type: **SoftLayer_Product_Item_Category_Question ** +Type: **SoftLayer_Product_Item_Category_Question ** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Order_Quote/_index.md b/content/reference/datatypes/SoftLayer_Billing_Order_Quote/_index.md index c5aea6b0bb..cd3b06d188 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Order_Quote/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Order_Quote/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -55,7 +57,8 @@ The SoftLayer_Billing_Oder_Quote data type contains general information relating [accountId]: #accountid #### [accountId] Identification Number of the account record tied to the quote -Type: **integer** +Type: **integer** + @@ -65,7 +68,8 @@ Identification Number of the account record tied to the quote [completedPurchaseDataId]: #completedpurchasedataid #### [completedPurchaseDataId] Identification Number of the order record tied to the quote. -Type: **integer** +Type: **integer** + @@ -75,7 +79,8 @@ Identification Number of the order record tied to the quote. [createDate]: #createdate #### [createDate] Holds the date the quote record was created -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +90,8 @@ Holds the date the quote record was created [expirationDate]: #expirationdate #### [expirationDate] This property holds the date of expiration of a quote, after that date the quote would be deem expired -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +101,8 @@ This property holds the date of expiration of a quote, after that date the quote [id]: #id #### [id] The id use to identify a quote. -Type: **integer** +Type: **integer** + @@ -105,7 +112,8 @@ The id use to identify a quote. [modifyDate]: #modifydate #### [modifyDate] Holds the date when the quote record was modified with reference to its creation date -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +123,8 @@ Holds the date when the quote record was modified with reference to its creation [name]: #name #### [name] The name given to quote by the initiator -Type: **string** +Type: **string** + @@ -125,7 +134,8 @@ The name given to quote by the initiator [publicNote]: #publicnote #### [publicNote] This property Holds system generated notes. In our case if a quote is tied to an order where one of the order item has an inactive promotion code, the quote will be considered invalid. -Type: **string** +Type: **string** + @@ -135,7 +145,8 @@ This property Holds system generated notes. In our case if a quote is tied to an [quoteKey]: #quotekey #### [quoteKey] Holds system generated hash password for the Quote -Type: **string** +Type: **string** + @@ -145,7 +156,8 @@ Holds system generated hash password for the Quote [status]: #status #### [status] This property Holds the current status of a Quote: pending,expired, saved or deleted -Type: **string** +Type: **string** + @@ -161,7 +173,8 @@ This property Holds the current status of a Quote: pending,expired, saved or del [account]: #account #### [account] A quote's corresponding account. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -171,7 +184,8 @@ A quote's corresponding account. [doNotContactFlag]: #donotcontactflag #### [doNotContactFlag] Indicates whether the owner of the quote chosen to no longer be contacted. -Type: **boolean** +Type: **boolean** + @@ -181,7 +195,8 @@ Indicates whether the owner of the quote chosen to no longer be contacted. [order]: #order #### [order] This order contains the records for which products were selected for this quote. -Type: **SoftLayer_Billing_Order ** +Type: **SoftLayer_Billing_Order ** + @@ -191,7 +206,8 @@ This order contains the records for which products were selected for this quote. [ordersFromQuote]: #ordersfromquote #### [ordersFromQuote] These are all the orders that were created from this quote. -Type: **SoftLayer_Billing_Order[] ** +Type: **SoftLayer_Billing_Order[] ** + @@ -203,7 +219,8 @@ These are all the orders that were created from this quote. [ordersFromQuoteCount]: #ordersfromquotecount #### [ordersFromQuoteCount] A count of these are all the orders that were created from this quote. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Order_Type/_index.md b/content/reference/datatypes/SoftLayer_Billing_Order_Type/_index.md index 8bd5f95ba7..e21edad1ab 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Order_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Order_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ The SoftLayer_Billing_Oder_Type data type contains general information relating [description]: #description #### [description] A brief description of where a SoftLayer order originated from. -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ A brief description of where a SoftLayer order originated from. [id]: #id #### [id] A SoftLayer order type's internal identifier. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ A SoftLayer order type's internal identifier. [type]: #type #### [type] A simple keyname stating where a SoftLayer order originated from. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Payment_Card_ChangeRequest/_index.md b/content/reference/datatypes/SoftLayer_Billing_Payment_Card_ChangeRequest/_index.md index ac2ebcb5c2..0d97fb64d9 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Payment_Card_ChangeRequest/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Payment_Card_ChangeRequest/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -54,7 +56,8 @@ The SoftLayer_Billing_Payment_Card_ChangeRequest data type contains general info [accountId]: #accountid #### [accountId] The account ID to which the credit card and billing information is associated with. -Type: **integer** +Type: **integer** + @@ -64,7 +67,8 @@ The account ID to which the credit card and billing information is associated wi [amount]: #amount #### [amount] The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -74,7 +78,8 @@ The total amount of the attempted transaction, represented in decimal format as [billingAddressLine1]: #billingaddressline1 #### [billingAddressLine1] The physical street address. Reserve information such as "apartment #123" or "Suite 2" for line 1. -Type: **string** +Type: **string** + @@ -84,7 +89,8 @@ The physical street address. Reserve information such as "apartment #123" or "Su [billingAddressLine2]: #billingaddressline2 #### [billingAddressLine2] The second line in the address. Information such as suite number goes here. -Type: **string** +Type: **string** + @@ -94,7 +100,8 @@ The second line in the address. Information such as suite number goes here. [billingCity]: #billingcity #### [billingCity] The city in which a customer's account resides. -Type: **string** +Type: **string** + @@ -104,7 +111,8 @@ The city in which a customer's account resides. [billingCountryCode]: #billingcountrycode #### [billingCountryCode] The 2-character Country code for an account's address. (i.e. US) -Type: **string** +Type: **string** + @@ -114,7 +122,8 @@ The 2-character Country code for an account's address. (i.e. US) [billingEmail]: #billingemail #### [billingEmail] The email address associated with a customer account. -Type: **string** +Type: **string** + @@ -124,7 +133,8 @@ The email address associated with a customer account. [billingNameCompany]: #billingnamecompany #### [billingNameCompany] the company name for an account. -Type: **string** +Type: **string** + @@ -134,7 +144,8 @@ the company name for an account. [billingNameFirst]: #billingnamefirst #### [billingNameFirst] The first name of the customer account owner. -Type: **string** +Type: **string** + @@ -144,7 +155,8 @@ The first name of the customer account owner. [billingNameLast]: #billingnamelast #### [billingNameLast] The last name of the customer account owner -Type: **string** +Type: **string** + @@ -154,7 +166,8 @@ The last name of the customer account owner [billingPhoneFax]: #billingphonefax #### [billingPhoneFax] The fax number associated with a customer account. -Type: **string** +Type: **string** + @@ -164,7 +177,8 @@ The fax number associated with a customer account. [billingPhoneVoice]: #billingphonevoice #### [billingPhoneVoice] The phone number associated with a customer account. -Type: **string** +Type: **string** + @@ -174,7 +188,8 @@ The phone number associated with a customer account. [billingPostalCode]: #billingpostalcode #### [billingPostalCode] The Zip or Postal Code for the billing address on an account. -Type: **string** +Type: **string** + @@ -184,7 +199,8 @@ The Zip or Postal Code for the billing address on an account. [billingState]: #billingstate #### [billingState] The State for the account. -Type: **string** +Type: **string** + @@ -194,7 +210,8 @@ The State for the account. [cardAccountLast4]: #cardaccountlast4 #### [cardAccountLast4] The last 4 digits of a customer's credit card. -Type: **string** +Type: **string** + @@ -204,7 +221,8 @@ The last 4 digits of a customer's credit card. [cardAccountNumber]: #cardaccountnumber #### [cardAccountNumber] The card number submitted in the change request. -Type: **string** +Type: **string** + @@ -214,7 +232,8 @@ The card number submitted in the change request. [cardExpirationMonth]: #cardexpirationmonth #### [cardExpirationMonth] The month (MM) in which a customer's payment card will expire. -Type: **string** +Type: **string** + @@ -224,7 +243,8 @@ The month (MM) in which a customer's payment card will expire. [cardExpirationYear]: #cardexpirationyear #### [cardExpirationYear] The year (YYYY) in which a customer's payment card will expire. -Type: **string** +Type: **string** + @@ -234,7 +254,8 @@ The year (YYYY) in which a customer's payment card will expire. [cardNickname]: #cardnickname #### [cardNickname] -Type: **string** +Type: **string** + @@ -244,7 +265,8 @@ The year (YYYY) in which a customer's payment card will expire. [cardType]: #cardtype #### [cardType] The type of payment card a customer has. (i.e. Visa, MasterCard, American Express). -Type: **string** +Type: **string** + @@ -254,7 +276,8 @@ The type of payment card a customer has. (i.e. Visa, MasterCard, American Expres [creditCardVerificationNumber]: #creditcardverificationnumber #### [creditCardVerificationNumber] The credit card verification number submitted in the change request. -Type: **string** +Type: **string** + @@ -264,7 +287,8 @@ The credit card verification number submitted in the change request. [currencyShortName]: #currencyshortname #### [currencyShortName] Describes the currency selected for payment -Type: **string** +Type: **string** + @@ -274,7 +298,8 @@ Describes the currency selected for payment [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Used internally and can safely be ignored. -Type: **string** +Type: **string** + @@ -284,7 +309,8 @@ Device Fingerprint Identifier - Used internally and can safely be ignored. [id]: #id #### [id] The unique identifier for a single change request. -Type: **integer** +Type: **integer** + @@ -294,7 +320,8 @@ The unique identifier for a single change request. [notes]: #notes #### [notes] the notes stored about a customer's payment card. -Type: **string** +Type: **string** + @@ -306,7 +333,8 @@ the notes stored about a customer's payment card. The purpose of this property is to allow enablement of 3D Secure (3DS). This is the Reference ID that corresponds to the device data for Payer Authentication. In order to properly enable 3DS, this will require implementation of Cardinal Cruise Hybrid. Please refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under "DFReferenceId / ReferenceId" to populate this property accordingly. -Type: **string** +Type: **string** + @@ -318,7 +346,8 @@ Please refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/C "Continue with Consumer Authentication" decoded response JWT (JSON Web Token) after successful authentication. The response is part of the implementation of Cardinal Cruise Hybrid. Please refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under "Continue with Consumer Authentication" to populate this property accordingly based on the CCA response. -Type: **string** +Type: **string** + @@ -328,7 +357,8 @@ Please refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/C [paymentRoleId]: #paymentroleid #### [paymentRoleId] -Type: **integer** +Type: **integer** + @@ -338,7 +368,8 @@ Please refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/C [paymentType]: #paymenttype #### [paymentType] The description of the type of payment sent in a change transaction. -Type: **string** +Type: **string** + @@ -348,7 +379,8 @@ The description of the type of payment sent in a change transaction. [ticketId]: #ticketid #### [ticketId] Unique identifier for a ticket discussing the switch between payment methods. -Type: **integer** +Type: **integer** + @@ -364,7 +396,8 @@ Unique identifier for a ticket discussing the switch between payment methods. [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -374,7 +407,8 @@ Unique identifier for a ticket discussing the switch between payment methods. [authorizedCreditCardTransaction]: #authorizedcreditcardtransaction #### [authorizedCreditCardTransaction] The SoftLayer_Billing_Payment_Card_Transaction tied to the authorization performed as part of this change request. -Type: **SoftLayer_Billing_Payment_Card_Transaction ** +Type: **SoftLayer_Billing_Payment_Card_Transaction ** + @@ -384,7 +418,8 @@ The SoftLayer_Billing_Payment_Card_Transaction tied to the authorization perform [captureCreditCardTransaction]: #capturecreditcardtransaction #### [captureCreditCardTransaction] The SoftLayer_Billing_Payment_Card_Transaction tied to the capture of funds performed as part of this change request. -Type: **SoftLayer_Billing_Payment_Card_Transaction ** +Type: **SoftLayer_Billing_Payment_Card_Transaction ** + @@ -394,7 +429,8 @@ The SoftLayer_Billing_Payment_Card_Transaction tied to the capture of funds perf [ticketAttachmentReferences]: #ticketattachmentreferences #### [ticketAttachmentReferences] These are tickets tied to a credit card change request. -Type: **SoftLayer_Ticket_Attachment[] ** +Type: **SoftLayer_Ticket_Attachment[] ** + @@ -406,7 +442,8 @@ These are tickets tied to a credit card change request. [ticketAttachmentReferenceCount]: #ticketattachmentreferencecount #### [ticketAttachmentReferenceCount] A count of these are tickets tied to a credit card change request. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Payment_Card_ManualPayment/_index.md b/content/reference/datatypes/SoftLayer_Billing_Payment_Card_ManualPayment/_index.md index 164bba4334..1b52c7dadb 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Payment_Card_ManualPayment/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Payment_Card_ManualPayment/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -54,7 +56,8 @@ The SoftLayer_Billing_Payment_Card_ManualPayment data type contains general info [accountId]: #accountid #### [accountId] The account ID to which the credit card and billing information is associated with. -Type: **integer** +Type: **integer** + @@ -64,7 +67,8 @@ The account ID to which the credit card and billing information is associated wi [amount]: #amount #### [amount] The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -74,7 +78,8 @@ The total amount of the attempted transaction, represented in decimal format as [authorizedCreditCardTransactionId]: #authorizedcreditcardtransactionid #### [authorizedCreditCardTransactionId] The unique identifier of an attempted credit card transaction. -Type: **integer** +Type: **integer** + @@ -84,7 +89,8 @@ The unique identifier of an attempted credit card transaction. [authorizedPayPalTransactionId]: #authorizedpaypaltransactionid #### [authorizedPayPalTransactionId] The unique identifier of an attempted PayPal transaction. -Type: **integer** +Type: **integer** + @@ -94,7 +100,8 @@ The unique identifier of an attempted PayPal transaction. [billingAddressLine1]: #billingaddressline1 #### [billingAddressLine1] The physical street address. Reserve information such as "apartment #123" or "Suite 2" for line 1. -Type: **string** +Type: **string** + @@ -104,7 +111,8 @@ The physical street address. Reserve information such as "apartment #123" or "Su [billingAddressLine2]: #billingaddressline2 #### [billingAddressLine2] The second line in the address. Information such as suite number goes here. -Type: **string** +Type: **string** + @@ -114,7 +122,8 @@ The second line in the address. Information such as suite number goes here. [billingCity]: #billingcity #### [billingCity] The city in which a customer's account resides. -Type: **string** +Type: **string** + @@ -124,7 +133,8 @@ The city in which a customer's account resides. [billingCountryCode]: #billingcountrycode #### [billingCountryCode] The 2-character Country code for an account's address. (i.e. US) -Type: **string** +Type: **string** + @@ -134,7 +144,8 @@ The 2-character Country code for an account's address. (i.e. US) [billingEmail]: #billingemail #### [billingEmail] The email address associated with a customer account. -Type: **string** +Type: **string** + @@ -144,7 +155,8 @@ The email address associated with a customer account. [billingNameCompany]: #billingnamecompany #### [billingNameCompany] the company name for an account. -Type: **string** +Type: **string** + @@ -154,7 +166,8 @@ the company name for an account. [billingNameFirst]: #billingnamefirst #### [billingNameFirst] The first name of the customer account owner. -Type: **string** +Type: **string** + @@ -164,7 +177,8 @@ The first name of the customer account owner. [billingNameLast]: #billingnamelast #### [billingNameLast] The last name of the customer account owner. -Type: **string** +Type: **string** + @@ -174,7 +188,8 @@ The last name of the customer account owner. [billingPhoneFax]: #billingphonefax #### [billingPhoneFax] The fax number associated with a customer account. -Type: **string** +Type: **string** + @@ -184,7 +199,8 @@ The fax number associated with a customer account. [billingPhoneVoice]: #billingphonevoice #### [billingPhoneVoice] The phone number associated with a customer account. -Type: **string** +Type: **string** + @@ -194,7 +210,8 @@ The phone number associated with a customer account. [billingPostalCode]: #billingpostalcode #### [billingPostalCode] The Zip or Postal Code for the billing address on an account. -Type: **string** +Type: **string** + @@ -204,7 +221,8 @@ The Zip or Postal Code for the billing address on an account. [billingState]: #billingstate #### [billingState] The State for the account. -Type: **string** +Type: **string** + @@ -214,7 +232,8 @@ The State for the account. [cancelUrl]: #cancelurl #### [cancelUrl] The cancel URL is the page to which PayPal redirects if payment is not approved. -Type: **string** +Type: **string** + @@ -224,7 +243,8 @@ The cancel URL is the page to which PayPal redirects if payment is not approved. [cardAccountHash]: #cardaccounthash #### [cardAccountHash] A hash value of the credit card number. -Type: **string** +Type: **string** + @@ -234,7 +254,8 @@ A hash value of the credit card number. [cardAccountLast4]: #cardaccountlast4 #### [cardAccountLast4] The last 4 digits of a customer's credit card. -Type: **string** +Type: **string** + @@ -244,7 +265,8 @@ The last 4 digits of a customer's credit card. [cardAccountNumber]: #cardaccountnumber #### [cardAccountNumber] The card number submitted in the change request. -Type: **string** +Type: **string** + @@ -254,7 +276,8 @@ The card number submitted in the change request. [cardExpirationMonth]: #cardexpirationmonth #### [cardExpirationMonth] The month (MM) in which a customer's payment card will expire. -Type: **string** +Type: **string** + @@ -264,7 +287,8 @@ The month (MM) in which a customer's payment card will expire. [cardExpirationYear]: #cardexpirationyear #### [cardExpirationYear] The year (YYYY) in which a customer's payment card will expire. -Type: **string** +Type: **string** + @@ -274,7 +298,8 @@ The year (YYYY) in which a customer's payment card will expire. [cardType]: #cardtype #### [cardType] The method key of the type payment issued (Visa - 001, Mastercard - 002, American Express - 003, Discover - 004, PayPal - paypal). -Type: **string** +Type: **string** + @@ -284,7 +309,8 @@ The method key of the type payment issued (Visa - 001, Mastercard - 002, America [creditCardVerificationNumber]: #creditcardverificationnumber #### [creditCardVerificationNumber] The credit card verification number submitted in the change request. -Type: **string** +Type: **string** + @@ -294,7 +320,8 @@ The credit card verification number submitted in the change request. [currencyShortName]: #currencyshortname #### [currencyShortName] Describes the currency selected for payment -Type: **string** +Type: **string** + @@ -304,7 +331,8 @@ Describes the currency selected for payment [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Used internally and can safely be ignored. -Type: **string** +Type: **string** + @@ -314,7 +342,8 @@ Device Fingerprint Identifier - Used internally and can safely be ignored. [fromIpAddress]: #fromipaddress #### [fromIpAddress] The IP address from which the transaction originates. -Type: **string** +Type: **string** + @@ -324,7 +353,8 @@ The IP address from which the transaction originates. [id]: #id #### [id] The unique identifier for a single manual payment request. -Type: **integer** +Type: **integer** + @@ -334,7 +364,8 @@ The unique identifier for a single manual payment request. [notes]: #notes #### [notes] Notes generated as a result of the payment request. -Type: **string** +Type: **string** + @@ -346,7 +377,8 @@ Notes generated as a result of the payment request. The purpose of this property is to allow enablement of 3D Secure (3DS). This is the Reference ID that corresponds to the device data for Payer Authentication. In order to properly enable 3DS, this will require implementation of Cardinal Cruise Hybrid. Please refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under "DFReferenceId / ReferenceId" to populate this property accordingly. -Type: **string** +Type: **string** + @@ -358,7 +390,8 @@ Please refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/C "Continue with Consumer Authentication" decoded response JWT (JSON Web Token) after successful authentication. The response is part of the implementation of Cardinal Cruise Hybrid. Please refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under "Continue with Consumer Authentication" to populate this property accordingly based on the CCA response. -Type: **string** +Type: **string** + @@ -368,7 +401,8 @@ Please refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/C [paymentType]: #paymenttype #### [paymentType] The description of the type of payment sent in a change transaction. -Type: **string** +Type: **string** + @@ -378,7 +412,8 @@ The description of the type of payment sent in a change transaction. [returnUrl]: #returnurl #### [returnUrl] The return URL is the page to which PayPal redirects after payment is approved. -Type: **string** +Type: **string** + @@ -388,7 +423,8 @@ The return URL is the page to which PayPal redirects after payment is approved. [type]: #type #### [type] Describes the type of manual payment (PAYPAL or CREDIT_CARD). -Type: **string** +Type: **string** + @@ -404,7 +440,8 @@ Describes the type of manual payment (PAYPAL or CREDIT_CARD). [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -414,7 +451,8 @@ Describes the type of manual payment (PAYPAL or CREDIT_CARD). [authorizedCreditCardTransaction]: #authorizedcreditcardtransaction #### [authorizedCreditCardTransaction] This is the credit card transaction data tied to a credit card manual payment. -Type: **SoftLayer_Billing_Payment_Card_Transaction ** +Type: **SoftLayer_Billing_Payment_Card_Transaction ** + @@ -424,7 +462,8 @@ This is the credit card transaction data tied to a credit card manual payment. [authorizedPayPalTransaction]: #authorizedpaypaltransaction #### [authorizedPayPalTransaction] This is the PayPal transaction data tied to a PayPal manual payment. -Type: **SoftLayer_Billing_Payment_PayPal_Transaction ** +Type: **SoftLayer_Billing_Payment_PayPal_Transaction ** + @@ -434,7 +473,8 @@ This is the PayPal transaction data tied to a PayPal manual payment. [captureCreditCardTransaction]: #capturecreditcardtransaction #### [captureCreditCardTransaction] The SoftLayer_Billing_Payment_Card_Transaction tied to the capture performed as part of this manual payment. This will only exist if the manual payment was performed with a credit card. -Type: **SoftLayer_Billing_Payment_Card_Transaction ** +Type: **SoftLayer_Billing_Payment_Card_Transaction ** + @@ -444,7 +484,8 @@ The SoftLayer_Billing_Payment_Card_Transaction tied to the capture performed as [capturePayPalTransaction]: #capturepaypaltransaction #### [capturePayPalTransaction] The SoftLayer_Billing_Payment_PayPal_Transaction tied to the capture performed as part of this manual payment. This will only exist if the manual payment was performed via PayPal. -Type: **SoftLayer_Billing_Payment_PayPal_Transaction ** +Type: **SoftLayer_Billing_Payment_PayPal_Transaction ** + @@ -454,7 +495,8 @@ The SoftLayer_Billing_Payment_PayPal_Transaction tied to the capture performed a [ticketAttachmentReferences]: #ticketattachmentreferences #### [ticketAttachmentReferences] These are tickets tied to a credit card manual payment. -Type: **SoftLayer_Ticket_Attachment[] ** +Type: **SoftLayer_Ticket_Attachment[] ** + @@ -466,7 +508,8 @@ These are tickets tied to a credit card manual payment. [ticketAttachmentReferenceCount]: #ticketattachmentreferencecount #### [ticketAttachmentReferenceCount] A count of these are tickets tied to a credit card manual payment. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Payment_Card_Transaction/_index.md b/content/reference/datatypes/SoftLayer_Billing_Payment_Card_Transaction/_index.md index 023193ccfc..1dcdafe0d3 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Payment_Card_Transaction/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Payment_Card_Transaction/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Payment_Card_Transaction data type contains general information relating to attempted credit card transactions. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Payment_Card_Transaction data type contains general inform [accountId]: #accountid #### [accountId] The account ID to which the credit card and billing information is associated with. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The account ID to which the credit card and billing information is associated wi [amount]: #amount #### [amount] The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -65,7 +69,8 @@ The total amount of the attempted transaction, represented in decimal format as [billingAddressLine1]: #billingaddressline1 #### [billingAddressLine1] The physical street address. Reserve information such as "apartment #123" or "Suite 2" for line 1. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The physical street address. Reserve information such as "apartment #123" or "Su [billingAddressLine2]: #billingaddressline2 #### [billingAddressLine2] The second line in the address. Information such as suite number goes here. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The second line in the address. Information such as suite number goes here. [billingCity]: #billingcity #### [billingCity] The city in which a customer's account resides. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The city in which a customer's account resides. [billingCountryCode]: #billingcountrycode #### [billingCountryCode] The 2-character Country code for an account's address. (i.e. US) -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The 2-character Country code for an account's address. (i.e. US) [billingEmail]: #billingemail #### [billingEmail] The email address associated with a customer account. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The email address associated with a customer account. [billingNameCompany]: #billingnamecompany #### [billingNameCompany] the company name for an account. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ the company name for an account. [billingNameFirst]: #billingnamefirst #### [billingNameFirst] The first name of the customer account owner. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The first name of the customer account owner. [billingNameLast]: #billingnamelast #### [billingNameLast] The last name of the customer account owner. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The last name of the customer account owner. [billingPhoneFax]: #billingphonefax #### [billingPhoneFax] The fax number associated with a customer account. -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ The fax number associated with a customer account. [billingPhoneVoice]: #billingphonevoice #### [billingPhoneVoice] The phone number associated with a customer account. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ The phone number associated with a customer account. [billingPostalCode]: #billingpostalcode #### [billingPostalCode] The Zip or Postal Code for the billing address on an account. -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ The Zip or Postal Code for the billing address on an account. [billingState]: #billingstate #### [billingState] The State for the account. -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ The State for the account. [cardAccountLast4]: #cardaccountlast4 #### [cardAccountLast4] The last 4 digits of a customer's credit card. -Type: **integer** +Type: **integer** + @@ -195,7 +212,8 @@ The last 4 digits of a customer's credit card. [cardExpirationMonth]: #cardexpirationmonth #### [cardExpirationMonth] The month (MM) in which a customer's payment card will expire. -Type: **integer** +Type: **integer** + @@ -205,7 +223,8 @@ The month (MM) in which a customer's payment card will expire. [cardExpirationYear]: #cardexpirationyear #### [cardExpirationYear] The year (YYYY) in which a customer's payment card will expire. -Type: **integer** +Type: **integer** + @@ -215,7 +234,8 @@ The year (YYYY) in which a customer's payment card will expire. [cardType]: #cardtype #### [cardType] The type of payment issued (i.e. Visa, MasterCard, American Express). -Type: **string** +Type: **string** + @@ -225,7 +245,8 @@ The type of payment issued (i.e. Visa, MasterCard, American Express). [createDate]: #createdate #### [createDate] The date that the transaction was attempted. -Type: **dateTime** +Type: **dateTime** + @@ -235,7 +256,8 @@ The date that the transaction was attempted. [id]: #id #### [id] The unique identifier for a single credit card transaction request. -Type: **integer** +Type: **integer** + @@ -245,7 +267,8 @@ The unique identifier for a single credit card transaction request. [invoiceId]: #invoiceid #### [invoiceId] Unique identifier of the invoice to which funds will be applied. -Type: **integer** +Type: **integer** + @@ -255,7 +278,8 @@ Unique identifier of the invoice to which funds will be applied. [modifyDate]: #modifydate #### [modifyDate] The date that the transaction was modified. -Type: **dateTime** +Type: **dateTime** + @@ -265,7 +289,8 @@ The date that the transaction was modified. [orderFromIpAddress]: #orderfromipaddress #### [orderFromIpAddress] The IP address from which the transaction originates. -Type: **string** +Type: **string** + @@ -275,7 +300,8 @@ The IP address from which the transaction originates. [referenceCode]: #referencecode #### [referenceCode] A code used by the financial institution to refer to the requested transaction. -Type: **string** +Type: **string** + @@ -285,7 +311,8 @@ A code used by the financial institution to refer to the requested transaction. [requestId]: #requestid #### [requestId] The unique identifier of the request submitted to the financial institution. -Type: **string** +Type: **string** + @@ -295,7 +322,8 @@ The unique identifier of the request submitted to the financial institution. [returnStatus]: #returnstatus #### [returnStatus] The status code returned from the financial institution. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The status code returned from the financial institution. [serializedReply]: #serializedreply #### [serializedReply] A serialized, delimited string of the transaction request sent to the financial institution. -Type: **string** +Type: **string** + @@ -315,7 +344,8 @@ A serialized, delimited string of the transaction request sent to the financial [serializedRequest]: #serializedrequest #### [serializedRequest] A serialized, delimited string of the transaction request sent to the financial institution. -Type: **string** +Type: **string** + @@ -331,7 +361,8 @@ A serialized, delimited string of the transaction request sent to the financial [account]: #account #### [account] The account to which a transaction belongs. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -341,7 +372,8 @@ The account to which a transaction belongs. [order]: #order #### [order] -Type: **SoftLayer_Billing_Order ** +Type: **SoftLayer_Billing_Order ** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Payment_PayPal_Transaction/_index.md b/content/reference/datatypes/SoftLayer_Billing_Payment_PayPal_Transaction/_index.md index f7a176e8b9..4bcba869c0 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Payment_PayPal_Transaction/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Payment_PayPal_Transaction/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Payment_PayPal_Transaction data type contains general information relating to attempted PayPal transactions. @@ -45,7 +47,8 @@ The SoftLayer_Billing_Payment_PayPal_Transaction data type contains general info [accountId]: #accountid #### [accountId] The account ID to which the PayPal and billing information is associated with. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The account ID to which the PayPal and billing information is associated with. [addressCityName]: #addresscityname #### [addressCityName] City given in the address of the PayPal user. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ City given in the address of the PayPal user. [addressCountry]: #addresscountry #### [addressCountry] Country given in the named address of the PayPal user. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Country given in the named address of the PayPal user. [addressName]: #addressname #### [addressName] Name given to the address provided for the PayPal user. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ Name given to the address provided for the PayPal user. [addressPostalCode]: #addresspostalcode #### [addressPostalCode] Postal Code of the address of the PayPal user. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Postal Code of the address of the PayPal user. [addressStateProvence]: #addressstateprovence #### [addressStateProvence] State or Province in the address of the PayPal user. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ State or Province in the address of the PayPal user. [addressStatus]: #addressstatus #### [addressStatus] PayPal defined status of the address of the PayPal user. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ PayPal defined status of the address of the PayPal user. [addressStreet1]: #addressstreet1 #### [addressStreet1] First line of the street address of the PayPal user. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ First line of the street address of the PayPal user. [addressStreet2]: #addressstreet2 #### [addressStreet2] Second line of the street address of the PayPal user. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Second line of the street address of the PayPal user. [contactPhone]: #contactphone #### [contactPhone] Phone number provided for the PayPal user. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ Phone number provided for the PayPal user. [createDate]: #createdate #### [createDate] The date that the transaction was attempted. -Type: **dateTime** +Type: **dateTime** + @@ -155,7 +168,8 @@ The date that the transaction was attempted. [exchangeRate]: #exchangerate #### [exchangeRate] Exchange rate imposed on the payment amount. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ Exchange rate imposed on the payment amount. [feeAmount]: #feeamount #### [feeAmount] PayPal fee applied to the payment. -Type: **decimal** +Type: **decimal** + @@ -175,7 +190,8 @@ PayPal fee applied to the payment. [grossAmount]: #grossamount #### [grossAmount] The total amount of the payment executed by PayPal, represented in decimal format as US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The total amount of the payment executed by PayPal, represented in decimal forma [id]: #id #### [id] The unique identifier for a single PayPal transaction request. -Type: **integer** +Type: **integer** + @@ -195,7 +212,8 @@ The unique identifier for a single PayPal transaction request. [invoiceId]: #invoiceid #### [invoiceId] Unique identifier of the invoice to which funds will be applied. -Type: **integer** +Type: **integer** + @@ -205,7 +223,8 @@ Unique identifier of the invoice to which funds will be applied. [lastPaypalCommand]: #lastpaypalcommand #### [lastPaypalCommand] The name of the command issued to PayPal with regards to the attempted transaction. -Type: **string** +Type: **string** + @@ -215,7 +234,8 @@ The name of the command issued to PayPal with regards to the attempted transacti [modifyDate]: #modifydate #### [modifyDate] The date that the transaction was modified. -Type: **dateTime** +Type: **dateTime** + @@ -225,7 +245,8 @@ The date that the transaction was modified. [orderFromIpAddress]: #orderfromipaddress #### [orderFromIpAddress] The IP address from where the PayPal payment request originated. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ The IP address from where the PayPal payment request originated. [orderTotal]: #ordertotal #### [orderTotal] The amount of the payment submitted through the SoftLayer interface, represented in decimal format as US Dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -245,7 +267,8 @@ The amount of the payment submitted through the SoftLayer interface, represented [payer]: #payer #### [payer] The PayPal user account name (email address) associated with the customer account. -Type: **string** +Type: **string** + @@ -255,7 +278,8 @@ The PayPal user account name (email address) associated with the customer accoun [payerBusiness]: #payerbusiness #### [payerBusiness] The name of the business associated with the PayPal user. -Type: **string** +Type: **string** + @@ -265,7 +289,8 @@ The name of the business associated with the PayPal user. [payerCountry]: #payercountry #### [payerCountry] Country given in the address of the PayPal user. -Type: **string** +Type: **string** + @@ -275,7 +300,8 @@ Country given in the address of the PayPal user. [payerFirstName]: #payerfirstname #### [payerFirstName] First name of the PayPal user. -Type: **string** +Type: **string** + @@ -285,7 +311,8 @@ First name of the PayPal user. [payerId]: #payerid #### [payerId] Unique PayPal user account identifier. -Type: **string** +Type: **string** + @@ -295,7 +322,8 @@ Unique PayPal user account identifier. [payerLastName]: #payerlastname #### [payerLastName] Last name of the PayPal user. -Type: **string** +Type: **string** + @@ -305,7 +333,8 @@ Last name of the PayPal user. [payerStatus]: #payerstatus #### [payerStatus] Current PayPal status associated with the user account. -Type: **string** +Type: **string** + @@ -315,7 +344,8 @@ Current PayPal status associated with the user account. [paymentDate]: #paymentdate #### [paymentDate] Date that the payment was confirmed in PayPal by the user. -Type: **dateTime** +Type: **dateTime** + @@ -325,7 +355,8 @@ Date that the payment was confirmed in PayPal by the user. [paymentStatus]: #paymentstatus #### [paymentStatus] PayPal defined status of the attempted payment. -Type: **string** +Type: **string** + @@ -335,7 +366,8 @@ PayPal defined status of the attempted payment. [paymentType]: #paymenttype #### [paymentType] PayPal defined code used to identify the type of payment. Provided in a PayPal response. -Type: **string** +Type: **string** + @@ -345,7 +377,8 @@ PayPal defined code used to identify the type of payment. Provided in a PayPal [pendingReason]: #pendingreason #### [pendingReason] Reason provided by PayPal for a payment given a pending status. -Type: **string** +Type: **string** + @@ -355,7 +388,8 @@ Reason provided by PayPal for a payment given a pending status. [serializedReply]: #serializedreply #### [serializedReply] A serialized, delimited string of the reply received from PayPal. -Type: **string** +Type: **string** + @@ -365,7 +399,8 @@ A serialized, delimited string of the reply received from PayPal. [serializedRequest]: #serializedrequest #### [serializedRequest] A serialized, delimited string of the request submitted to PayPal. -Type: **string** +Type: **string** + @@ -375,7 +410,8 @@ A serialized, delimited string of the request submitted to PayPal. [settleAmount]: #settleamount #### [settleAmount] PayPal defined fee. -Type: **decimal** +Type: **decimal** + @@ -385,7 +421,8 @@ PayPal defined fee. [taxAmount]: #taxamount #### [taxAmount] Tax applied by PayPal to the payment amount. -Type: **decimal** +Type: **decimal** + @@ -395,7 +432,8 @@ Tax applied by PayPal to the payment amount. [token]: #token #### [token] Value issued by PayPal for referencing the attempted transaction. -Type: **string** +Type: **string** + @@ -405,7 +443,8 @@ Value issued by PayPal for referencing the attempted transaction. [transactionId]: #transactionid #### [transactionId] Unique transaction ID provided in a PayPal response. -Type: **string** +Type: **string** + @@ -415,7 +454,8 @@ Unique transaction ID provided in a PayPal response. [transactionType]: #transactiontype #### [transactionType] PayPal defined code used to identify the type of transaction. Provided in a PayPal response. -Type: **string** +Type: **string** + @@ -431,7 +471,8 @@ PayPal defined code used to identify the type of transaction. Provided in a Pay [account]: #account #### [account] The account to which a transaction belongs. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -441,7 +482,8 @@ The account to which a transaction belongs. [order]: #order #### [order] -Type: **SoftLayer_Billing_Order ** +Type: **SoftLayer_Billing_Order ** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Payment_Processor/_index.md b/content/reference/datatypes/SoftLayer_Billing_Payment_Processor/_index.md index adf17435b0..9ad9c7afbb 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Payment_Processor/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Payment_Processor/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
      @@ -71,7 +75,8 @@ classes: [brandAssignments]: #brandassignments #### [brandAssignments] -Type: **SoftLayer_Brand_Payment_Processor[] ** +Type: **SoftLayer_Brand_Payment_Processor[] ** + @@ -81,7 +86,8 @@ classes: [ownerAccount]: #owneraccount #### [ownerAccount] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -91,7 +97,8 @@ classes: [paymentMethods]: #paymentmethods #### [paymentMethods] -Type: **SoftLayer_Billing_Payment_Processor_Method[] ** +Type: **SoftLayer_Billing_Payment_Processor_Method[] ** + @@ -101,7 +108,8 @@ classes: [type]: #type #### [type] -Type: **SoftLayer_Billing_Payment_Processor_Type ** +Type: **SoftLayer_Billing_Payment_Processor_Type ** + @@ -113,7 +121,8 @@ classes: [brandAssignmentCount]: #brandassignmentcount #### [brandAssignmentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -123,7 +132,8 @@ A count of [paymentMethodCount]: #paymentmethodcount #### [paymentMethodCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Payment_Processor_Method/_index.md b/content/reference/datatypes/SoftLayer_Billing_Payment_Processor_Method/_index.md index e950edc819..6afc555915 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Payment_Processor_Method/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Payment_Processor_Method/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [methodKey]: #methodkey #### [methodKey] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [multipleCurrencyFlag]: #multiplecurrencyflag #### [multipleCurrencyFlag] -Type: **boolean** +Type: **boolean** +
      @@ -71,7 +75,8 @@ classes: [paymentProcessor]: #paymentprocessor #### [paymentProcessor] -Type: **SoftLayer_Billing_Payment_Processor ** +Type: **SoftLayer_Billing_Payment_Processor ** + @@ -81,7 +86,8 @@ classes: [paymentType]: #paymenttype #### [paymentType] -Type: **SoftLayer_Billing_Payment_Type ** +Type: **SoftLayer_Billing_Payment_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Payment_Processor_Type/_index.md b/content/reference/datatypes/SoftLayer_Billing_Payment_Processor_Type/_index.md index 8c1ab474b3..185fc00549 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Payment_Processor_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Payment_Processor_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ classes: [paymentProcessors]: #paymentprocessors #### [paymentProcessors] -Type: **SoftLayer_Billing_Payment_Processor[] ** +Type: **SoftLayer_Billing_Payment_Processor[] ** + @@ -93,7 +99,8 @@ classes: [paymentProcessorCount]: #paymentprocessorcount #### [paymentProcessorCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Billing_Payment_Transaction/_index.md b/content/reference/datatypes/SoftLayer_Billing_Payment_Transaction/_index.md index 674d220aeb..90f40f3214 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Payment_Transaction/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Payment_Transaction/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Implementation for payment transactions. diff --git a/content/reference/datatypes/SoftLayer_Billing_Payment_Type/_index.md b/content/reference/datatypes/SoftLayer_Billing_Payment_Type/_index.md index 6872b3360a..e7c0f0422c 100644 --- a/content/reference/datatypes/SoftLayer_Billing_Payment_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Billing_Payment_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Brand/_index.md b/content/reference/datatypes/SoftLayer_Brand/_index.md index 3ecae3ee4b..36eb20ebd9 100644 --- a/content/reference/datatypes/SoftLayer_Brand/_index.md +++ b/content/reference/datatypes/SoftLayer_Brand/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + 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. @@ -49,7 +51,8 @@ IBM Cloud Infrastructure customers are unable to change their brand information [catalogId]: #catalogid #### [catalogId] ID of the Catalog used by this Brand -Type: **integer** +Type: **integer** + @@ -59,7 +62,8 @@ ID of the Catalog used by this Brand [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -69,7 +73,8 @@ ID of the Catalog used by this Brand [keyName]: #keyname #### [keyName] The brand key name. -Type: **string** +Type: **string** + @@ -79,7 +84,8 @@ The brand key name. [longName]: #longname #### [longName] The brand long name. -Type: **string** +Type: **string** + @@ -89,7 +95,8 @@ The brand long name. [name]: #name #### [name] The brand name. -Type: **string** +Type: **string** + @@ -105,7 +112,8 @@ The brand name. [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -115,7 +123,8 @@ The brand name. [allOwnedAccounts]: #allownedaccounts #### [allOwnedAccounts] All accounts owned by the brand. -Type: **SoftLayer_Account[] ** +Type: **SoftLayer_Account[] ** + @@ -125,7 +134,8 @@ All accounts owned by the brand. [allowAccountCreationFlag]: #allowaccountcreationflag #### [allowAccountCreationFlag] This flag indicates if creation of accounts is allowed. -Type: **boolean** +Type: **boolean** + @@ -135,7 +145,8 @@ This flag indicates if creation of accounts is allowed. [businessPartner]: #businesspartner #### [businessPartner] Business Partner details for the brand. Country Enterprise Code, Channel, Segment, Reseller Level. -Type: **SoftLayer_Brand_Business_Partner ** +Type: **SoftLayer_Brand_Business_Partner ** + @@ -145,7 +156,8 @@ Business Partner details for the brand. Country Enterprise Code, Channel, Segmen [businessPartnerFlag]: #businesspartnerflag #### [businessPartnerFlag] Flag indicating if the brand is a business partner. -Type: **boolean** +Type: **boolean** + @@ -155,7 +167,8 @@ Flag indicating if the brand is a business partner. [catalog]: #catalog #### [catalog] The Product Catalog for the Brand -Type: **SoftLayer_Product_Catalog ** +Type: **SoftLayer_Product_Catalog ** + @@ -165,7 +178,8 @@ The Product Catalog for the Brand [contacts]: #contacts #### [contacts] The contacts for the brand. -Type: **SoftLayer_Brand_Contact[] ** +Type: **SoftLayer_Brand_Contact[] ** + @@ -175,7 +189,8 @@ The contacts for the brand. [customerCountryLocationRestrictions]: #customercountrylocationrestrictions #### [customerCountryLocationRestrictions] This references 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 this brand for customers that live in Great Britain. -Type: **SoftLayer_Brand_Restriction_Location_CustomerCountry[] ** +Type: **SoftLayer_Brand_Restriction_Location_CustomerCountry[] ** + @@ -185,7 +200,8 @@ This references relationship between brands, locations and countries associated [distributor]: #distributor #### [distributor] -Type: **SoftLayer_Brand ** +Type: **SoftLayer_Brand ** + @@ -195,7 +211,8 @@ This references relationship between brands, locations and countries associated [distributorChildFlag]: #distributorchildflag #### [distributorChildFlag] -Type: **boolean** +Type: **boolean** + @@ -205,7 +222,8 @@ This references relationship between brands, locations and countries associated [distributorFlag]: #distributorflag #### [distributorFlag] -Type: **string** +Type: **string** + @@ -215,7 +233,8 @@ This references relationship between brands, locations and countries associated [hardware]: #hardware #### [hardware] An account's associated hardware objects. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -225,7 +244,8 @@ An account's associated hardware objects. [hasAgentAdvancedSupportFlag]: #hasagentadvancedsupportflag #### [hasAgentAdvancedSupportFlag] -Type: **boolean** +Type: **boolean** + @@ -235,7 +255,8 @@ An account's associated hardware objects. [hasAgentSupportFlag]: #hasagentsupportflag #### [hasAgentSupportFlag] -Type: **boolean** +Type: **boolean** + @@ -245,7 +266,8 @@ An account's associated hardware objects. [openTickets]: #opentickets #### [openTickets] -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -255,7 +277,8 @@ An account's associated hardware objects. [ownedAccounts]: #ownedaccounts #### [ownedAccounts] Active accounts owned by the brand. -Type: **SoftLayer_Account[] ** +Type: **SoftLayer_Account[] ** + @@ -265,7 +288,8 @@ Active accounts owned by the brand. [securityLevel]: #securitylevel #### [securityLevel] -Type: **SoftLayer_Security_Level ** +Type: **SoftLayer_Security_Level ** + @@ -275,7 +299,8 @@ Active accounts owned by the brand. [ticketGroups]: #ticketgroups #### [ticketGroups] -Type: **SoftLayer_Ticket_Group[] ** +Type: **SoftLayer_Ticket_Group[] ** + @@ -285,7 +310,8 @@ Active accounts owned by the brand. [tickets]: #tickets #### [tickets] -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -295,7 +321,8 @@ Active accounts owned by the brand. [users]: #users #### [users] -Type: **SoftLayer_User_Customer[] ** +Type: **SoftLayer_User_Customer[] ** + @@ -305,7 +332,8 @@ Active accounts owned by the brand. [virtualGuests]: #virtualguests #### [virtualGuests] An account's associated virtual guest objects. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -317,7 +345,8 @@ An account's associated virtual guest objects. [allOwnedAccountCount]: #allownedaccountcount #### [allOwnedAccountCount] A count of all accounts owned by the brand. -Type: **unsigned long** +Type: **unsigned long** + @@ -327,7 +356,8 @@ A count of all accounts owned by the brand. [contactCount]: #contactcount #### [contactCount] A count of the contacts for the brand. -Type: **unsigned long** +Type: **unsigned long** + @@ -337,7 +367,8 @@ A count of the contacts for the brand. [customerCountryLocationRestrictionCount]: #customercountrylocationrestrictioncount #### [customerCountryLocationRestrictionCount] A count of this references 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 this brand for customers that live in Great Britain. -Type: **unsigned long** +Type: **unsigned long** + @@ -347,7 +378,8 @@ A count of this references relationship between brands, locations and countries [hardwareCount]: #hardwarecount #### [hardwareCount] A count of an account's associated hardware objects. -Type: **unsigned long** +Type: **unsigned long** + @@ -357,7 +389,8 @@ A count of an account's associated hardware objects. [openTicketCount]: #openticketcount #### [openTicketCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -367,7 +400,8 @@ A count of [ownedAccountCount]: #ownedaccountcount #### [ownedAccountCount] A count of active accounts owned by the brand. -Type: **unsigned long** +Type: **unsigned long** + @@ -377,7 +411,8 @@ A count of active accounts owned by the brand. [ticketCount]: #ticketcount #### [ticketCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -387,7 +422,8 @@ A count of [ticketGroupCount]: #ticketgroupcount #### [ticketGroupCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -397,7 +433,8 @@ A count of [userCount]: #usercount #### [userCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -407,7 +444,8 @@ A count of [virtualGuestCount]: #virtualguestcount #### [virtualGuestCount] A count of an account's associated virtual guest objects. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Brand_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Brand_Attribute/_index.md index 238a47c694..a0bc2247fa 100644 --- a/content/reference/datatypes/SoftLayer_Brand_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Brand_Attribute/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -51,7 +53,8 @@ classes: [brand]: #brand #### [brand] -Type: **SoftLayer_Brand ** +Type: **SoftLayer_Brand ** +
      diff --git a/content/reference/datatypes/SoftLayer_Brand_Business_Partner/_index.md b/content/reference/datatypes/SoftLayer_Brand_Business_Partner/_index.md index ad489d0726..d5d5c8fd00 100644 --- a/content/reference/datatypes/SoftLayer_Brand_Business_Partner/_index.md +++ b/content/reference/datatypes/SoftLayer_Brand_Business_Partner/_index.md @@ -18,6 +18,8 @@ classes:
      ## Description + + Contains business partner details associated with a brand. Country Enterprise Identifier (CEID), Channel ID, Segment ID and Reseller Level. @@ -45,7 +47,8 @@ Contains business partner details associated with a brand. Country Enterprise Id [channelId]: #channelid #### [channelId] Brand business partner channel identifier -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Brand business partner channel identifier [countryEnterpriseCode]: #countryenterprisecode #### [countryEnterpriseCode] Brand business partner country enterprise code -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Brand business partner country enterprise code [resellerLevel]: #resellerlevel #### [resellerLevel] Reseller level of a brand business partner -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ Reseller level of a brand business partner [segmentId]: #segmentid #### [segmentId] Brand business partner segment identifier -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ Brand business partner segment identifier [brand]: #brand #### [brand] Brand associated with the business partner data -Type: **SoftLayer_Brand ** +Type: **SoftLayer_Brand ** + @@ -101,7 +108,8 @@ Brand associated with the business partner data [channel]: #channel #### [channel] Channel indicator used to categorize business partner revenue. -Type: **SoftLayer_Business_Partner_Channel ** +Type: **SoftLayer_Business_Partner_Channel ** + @@ -111,7 +119,8 @@ Channel indicator used to categorize business partner revenue. [segment]: #segment #### [segment] Segment indicator used to categorize business partner revenue. -Type: **SoftLayer_Business_Partner_Segment ** +Type: **SoftLayer_Business_Partner_Segment ** + diff --git a/content/reference/datatypes/SoftLayer_Brand_Contact/_index.md b/content/reference/datatypes/SoftLayer_Brand_Contact/_index.md index be6ef86580..2795461a5e 100644 --- a/content/reference/datatypes/SoftLayer_Brand_Contact/_index.md +++ b/content/reference/datatypes/SoftLayer_Brand_Contact/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Brand_Contact contains the contact information for the brand such as Corporate or Support contact information @@ -45,7 +47,8 @@ SoftLayer_Brand_Contact contains the contact information for the brand such as C [address1]: #address1 #### [address1] The contact's address 1. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The contact's address 1. [address2]: #address2 #### [address2] The contact's address 2. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The contact's address 2. [alternatePhone]: #alternatephone #### [alternatePhone] The contact's alternate phone number. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The contact's alternate phone number. [brandContactTypeId]: #brandcontacttypeid #### [brandContactTypeId] The contact's type identifier. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The contact's type identifier. [city]: #city #### [city] The contact's city. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The contact's city. [country]: #country #### [country] The contact's country. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The contact's country. [email]: #email #### [email] The contact's email address. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The contact's email address. [faxPhone]: #faxphone #### [faxPhone] The contact's fax number. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The contact's fax number. [firstName]: #firstname #### [firstName] The contact's first name. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The contact's first name. [lastName]: #lastname #### [lastName] The contact's last name. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The contact's last name. [officePhone]: #officephone #### [officePhone] The contact's phone number. -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ The contact's phone number. [postalCode]: #postalcode #### [postalCode] The contact's postal code. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ The contact's postal code. [state]: #state #### [state] The contact's state. -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ The contact's state. [brand]: #brand #### [brand] -Type: **SoftLayer_Brand ** +Type: **SoftLayer_Brand ** + @@ -191,7 +207,8 @@ The contact's state. [brandContactType]: #brandcontacttype #### [brandContactType] -Type: **SoftLayer_Brand_Contact_Type ** +Type: **SoftLayer_Brand_Contact_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Brand_Contact_Type/_index.md b/content/reference/datatypes/SoftLayer_Brand_Contact_Type/_index.md index 992a688470..0d07c7d949 100644 --- a/content/reference/datatypes/SoftLayer_Brand_Contact_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Brand_Contact_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Brand_Contact_Type contains the contact type information for the brand contacts such as Corporate or Support contact type @@ -45,7 +47,8 @@ SoftLayer_Brand_Contact_Type contains the contact type information for the brand [description]: #description #### [description] Contact type description. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Contact type description. [keyName]: #keyname #### [keyName] Contact type key name. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Contact type key name. [name]: #name #### [name] Contact type name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Brand_Payment_Processor/_index.md b/content/reference/datatypes/SoftLayer_Brand_Payment_Processor/_index.md index 24e66f912c..646fbeac0d 100644 --- a/content/reference/datatypes/SoftLayer_Brand_Payment_Processor/_index.md +++ b/content/reference/datatypes/SoftLayer_Brand_Payment_Processor/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -51,7 +53,8 @@ classes: [brand]: #brand #### [brand] -Type: **SoftLayer_Brand ** +Type: **SoftLayer_Brand ** +
      @@ -61,7 +64,8 @@ classes: [paymentProcessor]: #paymentprocessor #### [paymentProcessor] -Type: **SoftLayer_Billing_Payment_Processor ** +Type: **SoftLayer_Billing_Payment_Processor ** +
      diff --git a/content/reference/datatypes/SoftLayer_Brand_Restriction_Location_CustomerCountry/_index.md b/content/reference/datatypes/SoftLayer_Brand_Restriction_Location_CustomerCountry/_index.md index 3cabd33550..144d8a315f 100644 --- a/content/reference/datatypes/SoftLayer_Brand_Restriction_Location_CustomerCountry/_index.md +++ b/content/reference/datatypes/SoftLayer_Brand_Restriction_Location_CustomerCountry/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The [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. @@ -45,7 +47,8 @@ The [SoftLayer_Brand_Restriction_Location_CustomerCountry]({{Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The brand associated with customer's account. [customerCountryCode]: #customercountrycode #### [customerCountryCode] country code associated with customer's account. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ country code associated with customer's account. [locationId]: #locationid #### [locationId] The id for datacenter location. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ The id for datacenter location. [brand]: #brand #### [brand] This references the brand that has a brand-location-country restriction setup. -Type: **SoftLayer_Brand ** +Type: **SoftLayer_Brand ** + @@ -91,7 +97,8 @@ This references the brand that has a brand-location-country restriction setup. [location]: #location #### [location] This references the datacenter that has a brand-location-country restriction setup. For example, if a datacenter is listed with a restriction for Canada, a Canadian customer may not be eligible to order services at that location. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + diff --git a/content/reference/datatypes/SoftLayer_Business_Partner_Channel/_index.md b/content/reference/datatypes/SoftLayer_Business_Partner_Channel/_index.md index 9f6c8d0eb1..3539e90cc3 100644 --- a/content/reference/datatypes/SoftLayer_Business_Partner_Channel/_index.md +++ b/content/reference/datatypes/SoftLayer_Business_Partner_Channel/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Contains business partner channel information @@ -45,7 +47,8 @@ Contains business partner channel information [description]: #description #### [description] Business partner channel description -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Business partner channel description [keyName]: #keyname #### [keyName] Business partner channel name -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Business_Partner_Segment/_index.md b/content/reference/datatypes/SoftLayer_Business_Partner_Segment/_index.md index d54985bec4..23d938fd26 100644 --- a/content/reference/datatypes/SoftLayer_Business_Partner_Segment/_index.md +++ b/content/reference/datatypes/SoftLayer_Business_Partner_Segment/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Contains business partner segment information @@ -45,7 +47,8 @@ Contains business partner segment information [description]: #description #### [description] Business partner segment description -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Business partner segment description [keyName]: #keyname #### [keyName] Business partner segment name -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Catalyst_Affiliate/_index.md b/content/reference/datatypes/SoftLayer_Catalyst_Affiliate/_index.md index 01b3c40ff8..e1d5866779 100644 --- a/content/reference/datatypes/SoftLayer_Catalyst_Affiliate/_index.md +++ b/content/reference/datatypes/SoftLayer_Catalyst_Affiliate/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [skipCreditCardVerificationFlag]: #skipcreditcardverificationflag #### [skipCreditCardVerificationFlag] -Type: **boolean** +Type: **boolean** + diff --git a/content/reference/datatypes/SoftLayer_Catalyst_Company_Type/_index.md b/content/reference/datatypes/SoftLayer_Catalyst_Company_Type/_index.md index aa4b41e941..4cf6b23758 100644 --- a/content/reference/datatypes/SoftLayer_Catalyst_Company_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Catalyst_Company_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      diff --git a/content/reference/datatypes/SoftLayer_Catalyst_Enrollment/_index.md b/content/reference/datatypes/SoftLayer_Catalyst_Enrollment/_index.md index a31b64184f..18ace0d1e6 100644 --- a/content/reference/datatypes/SoftLayer_Catalyst_Enrollment/_index.md +++ b/content/reference/datatypes/SoftLayer_Catalyst_Enrollment/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [affiliateId]: #affiliateid #### [affiliateId] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [agreementCompleteFlag]: #agreementcompleteflag #### [agreementCompleteFlag] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [companyDescription]: #companydescription #### [companyDescription] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [companyTypeId]: #companytypeid #### [companyTypeId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [enrollmentDate]: #enrollmentdate #### [enrollmentDate] -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ classes: [graduationDate]: #graduationdate #### [graduationDate] -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ classes: [monthlyCreditAmount]: #monthlycreditamount #### [monthlyCreditAmount] -Type: **decimal** +Type: **decimal** + @@ -125,7 +135,8 @@ classes: [representativeEmployeeId]: #representativeemployeeid #### [representativeEmployeeId] -Type: **integer** +Type: **integer** + @@ -141,7 +152,8 @@ classes: [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -151,7 +163,8 @@ classes: [affiliate]: #affiliate #### [affiliate] -Type: **SoftLayer_Catalyst_Affiliate ** +Type: **SoftLayer_Catalyst_Affiliate ** + @@ -161,7 +174,8 @@ classes: [companyType]: #companytype #### [companyType] -Type: **SoftLayer_Catalyst_Company_Type ** +Type: **SoftLayer_Catalyst_Company_Type ** + @@ -171,7 +185,8 @@ classes: [isActiveFlag]: #isactiveflag #### [isActiveFlag] -Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ classes: [representative]: #representative #### [representative] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + diff --git a/content/reference/datatypes/SoftLayer_Catalyst_Enrollment_Request/_index.md b/content/reference/datatypes/SoftLayer_Catalyst_Enrollment_Request/_index.md index bd0fc951ac..52e9993937 100644 --- a/content/reference/datatypes/SoftLayer_Catalyst_Enrollment_Request/_index.md +++ b/content/reference/datatypes/SoftLayer_Catalyst_Enrollment_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Contains user information for Catalyst self-enrollment. @@ -45,7 +47,8 @@ Contains user information for Catalyst self-enrollment. [address1]: #address1 #### [address1] Applicant's address -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Applicant's address [address2]: #address2 #### [address2] Additional field for extended address -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Additional field for extended address [affiliateId]: #affiliateid #### [affiliateId] Id of the affiliate who referred applicant's -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ Id of the affiliate who referred applicant's [agreementCompleteFlag]: #agreementcompleteflag #### [agreementCompleteFlag] -Type: **boolean** +Type: **boolean** + @@ -85,7 +91,8 @@ Id of the affiliate who referred applicant's [applyToGepFlag]: #applytogepflag #### [applyToGepFlag] Determines whether or not to also apply to the GEP program -Type: **boolean** +Type: **boolean** + @@ -95,7 +102,8 @@ Determines whether or not to also apply to the GEP program [cardAccountNumber]: #cardaccountnumber #### [cardAccountNumber] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ Determines whether or not to also apply to the GEP program [cardExpirationMonth]: #cardexpirationmonth #### [cardExpirationMonth] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ Determines whether or not to also apply to the GEP program [cardExpirationYear]: #cardexpirationyear #### [cardExpirationYear] -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ Determines whether or not to also apply to the GEP program [cardType]: #cardtype #### [cardType] -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Determines whether or not to also apply to the GEP program [cardVerificationNumber]: #cardverificationnumber #### [cardVerificationNumber] -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ Determines whether or not to also apply to the GEP program [city]: #city #### [city] Applicant's city -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ Applicant's city [companyDescription]: #companydescription #### [companyDescription] Brief description of Startup's product and key differentiators -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ Brief description of Startup's product and key differentiators [companyName]: #companyname #### [companyName] Name of the applicant's company -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ Name of the applicant's company [companyTypeId]: #companytypeid #### [companyTypeId] Id of the company type which best describes applicant's company -Type: **integer** +Type: **integer** + @@ -185,7 +201,8 @@ Id of the company type which best describes applicant's company [companyUrl]: #companyurl #### [companyUrl] URL to the Startup's site -Type: **string** +Type: **string** + @@ -195,7 +212,8 @@ URL to the Startup's site [country]: #country #### [country] Applicant's country code -Type: **string** +Type: **string** + @@ -205,7 +223,8 @@ Applicant's country code [currentUserChoice]: #currentuserchoice #### [currentUserChoice] Index of answer chosen for how many current users question -Type: **integer** +Type: **integer** + @@ -215,7 +234,8 @@ Index of answer chosen for how many current users question [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Id of the fingerprint -Type: **string** +Type: **string** + @@ -225,7 +245,8 @@ Id of the fingerprint [email]: #email #### [email] Applicant's email address -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Applicant's email address [firstName]: #firstname #### [firstName] Applicant's first name -Type: **string** +Type: **string** + @@ -245,7 +267,8 @@ Applicant's first name [futureUserChoice]: #futureuserchoice #### [futureUserChoice] Index of answer chosen for how many future users question -Type: **integer** +Type: **integer** + @@ -255,7 +278,8 @@ Index of answer chosen for how many future users question [ibmIdUsername]: #ibmidusername #### [ibmIdUsername] Master user's IBMId username -Type: **string** +Type: **string** + @@ -265,7 +289,8 @@ Master user's IBMId username [incubatorName]: #incubatorname #### [incubatorName] Name of accelerator or incubator startup belongs to, if any -Type: **string** +Type: **string** + @@ -275,7 +300,8 @@ Name of accelerator or incubator startup belongs to, if any [investorName]: #investorname #### [investorName] Name of the investor, if any -Type: **string** +Type: **string** + @@ -285,7 +311,8 @@ Name of the investor, if any [lastName]: #lastname #### [lastName] Applicant's last name -Type: **string** +Type: **string** + @@ -295,7 +322,8 @@ Applicant's last name [officePhone]: #officephone #### [officePhone] Applicant's primary phone number -Type: **string** +Type: **string** + @@ -305,7 +333,8 @@ Applicant's primary phone number [overFiveYearsOldFlag]: #overfiveyearsoldflag #### [overFiveYearsOldFlag] Whether or not the startup has been operating for more than five years -Type: **boolean** +Type: **boolean** + @@ -315,7 +344,8 @@ Whether or not the startup has been operating for more than five years [postalCode]: #postalcode #### [postalCode] Applicant's postal code -Type: **string** +Type: **string** + @@ -325,7 +355,8 @@ Applicant's postal code [referralCode]: #referralcode #### [referralCode] IBM referral code, if any -Type: **string** +Type: **string** + @@ -335,7 +366,8 @@ IBM referral code, if any [revenueOverOneMillionFlag]: #revenueoveronemillionflag #### [revenueOverOneMillionFlag] Whether or not the startup has over one million in annual revenue -Type: **boolean** +Type: **boolean** + @@ -345,7 +377,8 @@ Whether or not the startup has over one million in annual revenue [skipCatalystApplicationFlag]: #skipcatalystapplicationflag #### [skipCatalystApplicationFlag] Determines whether or not to apply to the Catalyst program -Type: **boolean** +Type: **boolean** + @@ -355,7 +388,8 @@ Determines whether or not to apply to the Catalyst program [state]: #state #### [state] Applicant's state/region code -Type: **string** +Type: **string** + @@ -365,7 +399,8 @@ Applicant's state/region code [vatId]: #vatid #### [vatId] Applicant's vatId, if one exists -Type: **string** +Type: **string** + @@ -381,7 +416,8 @@ Applicant's vatId, if one exists [affiliate]: #affiliate #### [affiliate] -Type: **SoftLayer_Catalyst_Affiliate ** +Type: **SoftLayer_Catalyst_Affiliate ** + @@ -391,7 +427,8 @@ Applicant's vatId, if one exists [companyType]: #companytype #### [companyType] -Type: **SoftLayer_Catalyst_Company_Type ** +Type: **SoftLayer_Catalyst_Company_Type ** + @@ -401,7 +438,8 @@ Applicant's vatId, if one exists [marketingConsent]: #marketingconsent #### [marketingConsent] -Type: **SoftLayer_Catalyst_Enrollment_Request_MarketingConsent ** +Type: **SoftLayer_Catalyst_Enrollment_Request_MarketingConsent ** + diff --git a/content/reference/datatypes/SoftLayer_Catalyst_Enrollment_Request_Container_AnswerOption/_index.md b/content/reference/datatypes/SoftLayer_Catalyst_Enrollment_Request_Container_AnswerOption/_index.md index fd3679b409..8401a27cac 100644 --- a/content/reference/datatypes/SoftLayer_Catalyst_Enrollment_Request_Container_AnswerOption/_index.md +++ b/content/reference/datatypes/SoftLayer_Catalyst_Enrollment_Request_Container_AnswerOption/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [answer]: #answer #### [answer] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [index]: #index #### [index] -Type: **integer** +Type: **integer** +
      diff --git a/content/reference/datatypes/SoftLayer_Catalyst_Enrollment_Request_MarketingConsent/_index.md b/content/reference/datatypes/SoftLayer_Catalyst_Enrollment_Request_MarketingConsent/_index.md index 43cfc039c4..11174bae9f 100644 --- a/content/reference/datatypes/SoftLayer_Catalyst_Enrollment_Request_MarketingConsent/_index.md +++ b/content/reference/datatypes/SoftLayer_Catalyst_Enrollment_Request_MarketingConsent/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Contains user marketing consent information for Catalyst self-enrollment. @@ -45,7 +47,8 @@ Contains user marketing consent information for Catalyst self-enrollment. [marketingByEmailFlag]: #marketingbyemailflag #### [marketingByEmailFlag] -Type: **boolean** +Type: **boolean** + @@ -55,7 +58,8 @@ Contains user marketing consent information for Catalyst self-enrollment. [marketingByPostalMailFlag]: #marketingbypostalmailflag #### [marketingByPostalMailFlag] -Type: **boolean** +Type: **boolean** + @@ -65,7 +69,8 @@ Contains user marketing consent information for Catalyst self-enrollment. [marketingByTelephoneFlag]: #marketingbytelephoneflag #### [marketingByTelephoneFlag] -Type: **boolean** +Type: **boolean** + @@ -81,7 +86,8 @@ Contains user marketing consent information for Catalyst self-enrollment. [request]: #request #### [request] -Type: **SoftLayer_Catalyst_Enrollment_Request ** +Type: **SoftLayer_Catalyst_Enrollment_Request ** + diff --git a/content/reference/datatypes/SoftLayer_Compliance_Report_Type/_index.md b/content/reference/datatypes/SoftLayer_Compliance_Report_Type/_index.md index 7c417edd17..9d798e35b9 100644 --- a/content/reference/datatypes/SoftLayer_Compliance_Report_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Compliance_Report_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Configuration_Storage_Filesystem_Type/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Storage_Filesystem_Type/_index.md index d2cff52505..5b8eecacc7 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Storage_Filesystem_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Storage_Filesystem_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
      diff --git a/content/reference/datatypes/SoftLayer_Configuration_Storage_Group/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Storage_Group/_index.md index 55ab58c925..f18c9a891b 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Storage_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Storage_Group/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class describes the base Storage Group for a Complex Drive Configuration @@ -45,7 +47,8 @@ This class describes the base Storage Group for a Complex Drive Configuration [description]: #description #### [description] Storage group description -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Storage group description [diskSpace]: #diskspace #### [diskSpace] Storage group disk space -Type: **decimal** +Type: **decimal** + @@ -65,7 +69,8 @@ Storage group disk space [id]: #id #### [id] Storage group type id -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ Storage group type id [lvmFlag]: #lvmflag #### [lvmFlag] Flag to indicate if the storage group is setup for lvm -Type: **boolean** +Type: **boolean** + @@ -85,7 +91,8 @@ Flag to indicate if the storage group is setup for lvm [name]: #name #### [name] Storage group name -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Storage group name [units]: #units #### [units] Storage group disk size units -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ Storage group disk size units [ancestorGroups]: #ancestorgroups #### [ancestorGroups] This class represents a storage groups ancestors -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + @@ -121,7 +130,8 @@ This class represents a storage groups ancestors [arrayType]: #arraytype #### [arrayType] This class represents a storage group disk array type -Type: **SoftLayer_Configuration_Storage_Group_Array_Type ** +Type: **SoftLayer_Configuration_Storage_Group_Array_Type ** + @@ -131,7 +141,8 @@ This class represents a storage group disk array type [captureEnabledFlag]: #captureenabledflag #### [captureEnabledFlag] Determine if the storage group is able to be image captured. If unable to image capture the reasons will be provided. -Type: **SoftLayer_Container_Hardware_CaptureEnabled ** +Type: **SoftLayer_Container_Hardware_CaptureEnabled ** + @@ -141,7 +152,8 @@ Determine if the storage group is able to be image captured. If unable to image [createEmployee]: #createemployee #### [createEmployee] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -151,7 +163,8 @@ Determine if the storage group is able to be image captured. If unable to image [descendantGroups]: #descendantgroups #### [descendantGroups] This class represents a storage groups descendants -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + @@ -161,7 +174,8 @@ This class represents a storage groups descendants [hardDrives]: #harddrives #### [hardDrives] The hard drives contained within this storage group. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -173,7 +187,8 @@ The hard drives contained within this storage group. [ancestorGroupCount]: #ancestorgroupcount #### [ancestorGroupCount] A count of this class represents a storage groups ancestors -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of this class represents a storage groups ancestors [descendantGroupCount]: #descendantgroupcount #### [descendantGroupCount] A count of this class represents a storage groups descendants -Type: **unsigned long** +Type: **unsigned long** + @@ -193,7 +209,8 @@ A count of this class represents a storage groups descendants [hardDriveCount]: #harddrivecount #### [hardDriveCount] A count of the hard drives contained within this storage group. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Configuration_Storage_Group_Array_Type/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Storage_Group_Array_Type/_index.md index b43e284ad7..6f7762e274 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Storage_Group_Array_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Storage_Group_Array_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Supported hardware raid modes @@ -45,7 +47,8 @@ Supported hardware raid modes [description]: #description #### [description] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Supported hardware raid modes [driveMultiplier]: #drivemultiplier #### [driveMultiplier] -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Supported hardware raid modes [hotspareAllow]: #hotspareallow #### [hotspareAllow] -Type: **boolean** +Type: **boolean** + @@ -75,7 +80,8 @@ Supported hardware raid modes [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Supported hardware raid modes [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Supported hardware raid modes [maximumDrives]: #maximumdrives #### [maximumDrives] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ Supported hardware raid modes [minimumDrives]: #minimumdrives #### [minimumDrives] -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ Supported hardware raid modes [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Supported hardware raid modes [hardwareComponentModels]: #hardwarecomponentmodels #### [hardwareComponentModels] -Type: **SoftLayer_Hardware_Component_Model[] ** +Type: **SoftLayer_Hardware_Component_Model[] ** + @@ -143,7 +154,8 @@ Supported hardware raid modes [hardwareComponentModelCount]: #hardwarecomponentmodelcount #### [hardwareComponentModelCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Configuration_Storage_Group_Order/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Storage_Group_Order/_index.md index d120cfe633..a5357312a6 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Storage_Group_Order/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Storage_Group_Order/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + 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. @@ -49,7 +51,8 @@ If a raid configuration is required this object will describe a single array tha [arrayNumber]: #arraynumber #### [arrayNumber] -Type: **integer** +Type: **integer** + @@ -59,7 +62,8 @@ If a raid configuration is required this object will describe a single array tha [arraySize]: #arraysize #### [arraySize] -Type: **decimal** +Type: **decimal** + @@ -69,7 +73,8 @@ If a raid configuration is required this object will describe a single array tha [arrayTypeId]: #arraytypeid #### [arrayTypeId] -Type: **integer** +Type: **integer** + @@ -79,7 +84,8 @@ If a raid configuration is required this object will describe a single array tha [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] -Type: **integer** +Type: **integer** + @@ -89,7 +95,8 @@ If a raid configuration is required this object will describe a single array tha [controller]: #controller #### [controller] -Type: **integer** +Type: **integer** + @@ -99,7 +106,8 @@ If a raid configuration is required this object will describe a single array tha [hardDrives]: #harddrives #### [hardDrives] -Type: **array of integers** +Type: **array of integers** + @@ -109,7 +117,8 @@ If a raid configuration is required this object will describe a single array tha [hotSpareDrives]: #hotsparedrives #### [hotSpareDrives] -Type: **array of integers** +Type: **array of integers** + @@ -119,7 +128,8 @@ If a raid configuration is required this object will describe a single array tha [lvmFlag]: #lvmflag #### [lvmFlag] -Type: **boolean** +Type: **boolean** + @@ -129,7 +139,8 @@ If a raid configuration is required this object will describe a single array tha [partitionData]: #partitiondata #### [partitionData] -Type: **string** +Type: **string** + @@ -145,7 +156,8 @@ If a raid configuration is required this object will describe a single array tha [arrayType]: #arraytype #### [arrayType] Raid mode for the storage group. -Type: **SoftLayer_Configuration_Storage_Group_Array_Type ** +Type: **SoftLayer_Configuration_Storage_Group_Array_Type ** + @@ -155,7 +167,8 @@ Raid mode for the storage group. [billingOrderItem]: #billingorderitem #### [billingOrderItem] The order item that relates to this storage group. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + diff --git a/content/reference/datatypes/SoftLayer_Configuration_Storage_Group_Template_Group/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Storage_Group_Template_Group/_index.md index 680f4e9816..5517a3bcb6 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Storage_Group_Template_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Storage_Group_Template_Group/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + 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. @@ -49,7 +51,8 @@ If a server configuration requires a raid configuration this object will describ [diskControllerIndex]: #diskcontrollerindex #### [diskControllerIndex] The disk controller for the array. -Type: **integer** +Type: **integer** + @@ -59,7 +62,8 @@ The disk controller for the array. [grow]: #grow #### [grow] Flag to use all available space. -Type: **boolean** +Type: **boolean** + @@ -69,7 +73,8 @@ Flag to use all available space. [hardDrivesString]: #harddrivesstring #### [hardDrivesString] Comma delimited integers of drive indexes for the array. This can also be the string 'all' to specify all drives in the server -Type: **string** +Type: **string** + @@ -79,7 +84,8 @@ Comma delimited integers of drive indexes for the array. This can also be the st [hotSpareDrivesString]: #hotsparedrivesstring #### [hotSpareDrivesString] Comma delimited integers of drive indexes for hot spares on the array. -Type: **string** +Type: **string** + @@ -89,7 +95,8 @@ Comma delimited integers of drive indexes for hot spares on the array. [orderIndex]: #orderindex #### [orderIndex] The order of the arrays in the template. -Type: **integer** +Type: **integer** + @@ -99,7 +106,8 @@ The order of the arrays in the template. [size]: #size #### [size] Size of array. Must be within limitations of the smallest drive and raid mode -Type: **decimal** +Type: **decimal** + @@ -115,7 +123,8 @@ Size of array. Must be within limitations of the smallest drive and raid mode [type]: #type #### [type] -Type: **SoftLayer_Configuration_Storage_Group_Array_Type ** +Type: **SoftLayer_Configuration_Storage_Group_Array_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Configuration_Template/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Template/_index.md index 0c159585ac..1425e0ba44 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Template/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Template/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Configuration_Template data type contains general information of an arbitrary resource. @@ -45,7 +47,8 @@ The SoftLayer_Configuration_Template data type contains general information of a [accountId]: #accountid #### [accountId] Internal identifier of a SoftLayer account that this configuration template belongs to -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Internal identifier of a SoftLayer account that this configuration template belo [createDate]: #createdate #### [createDate] Created date -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ Created date [description]: #description #### [description] Configuration template description -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Configuration template description [id]: #id #### [id] Internal identifier of a configuration template. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Internal identifier of a configuration template. [itemId]: #itemid #### [itemId] Internal identifier of a product item that this configuration template is associated with -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ Internal identifier of a product item that this configuration template is associ [modifyDate]: #modifydate #### [modifyDate] Last modified date -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ Last modified date [name]: #name #### [name] Configuration template name -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ Configuration template name [parentId]: #parentid #### [parentId] Internal identifier of the parent configuration template -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ Internal identifier of the parent configuration template [userRecordId]: #userrecordid #### [userRecordId] Internal identifier of a user that last modified this configuration template -Type: **integer** +Type: **integer** + @@ -141,7 +152,8 @@ Internal identifier of a user that last modified this configuration template [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -151,7 +163,8 @@ Internal identifier of a user that last modified this configuration template [configurationSections]: #configurationsections #### [configurationSections] -Type: **SoftLayer_Configuration_Template_Section[] ** +Type: **SoftLayer_Configuration_Template_Section[] ** + @@ -161,7 +174,8 @@ Internal identifier of a user that last modified this configuration template [defaultValues]: #defaultvalues #### [defaultValues] -Type: **SoftLayer_Configuration_Template_Section_Definition_Value[] ** +Type: **SoftLayer_Configuration_Template_Section_Definition_Value[] ** + @@ -171,7 +185,8 @@ Internal identifier of a user that last modified this configuration template [definitions]: #definitions #### [definitions] -Type: **SoftLayer_Configuration_Template_Section_Definition[] ** +Type: **SoftLayer_Configuration_Template_Section_Definition[] ** + @@ -181,7 +196,8 @@ Internal identifier of a user that last modified this configuration template [item]: #item #### [item] -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -191,7 +207,8 @@ Internal identifier of a user that last modified this configuration template [linkedSectionReferences]: #linkedsectionreferences #### [linkedSectionReferences] -Type: **SoftLayer_Configuration_Template_Section_Reference ** +Type: **SoftLayer_Configuration_Template_Section_Reference ** + @@ -201,7 +218,8 @@ Internal identifier of a user that last modified this configuration template [parent]: #parent #### [parent] -Type: **SoftLayer_Configuration_Template ** +Type: **SoftLayer_Configuration_Template ** + @@ -211,7 +229,8 @@ Internal identifier of a user that last modified this configuration template [user]: #user #### [user] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -223,7 +242,8 @@ Internal identifier of a user that last modified this configuration template [configurationSectionCount]: #configurationsectioncount #### [configurationSectionCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -233,7 +253,8 @@ A count of [defaultValueCount]: #defaultvaluecount #### [defaultValueCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -243,7 +264,8 @@ A count of [definitionCount]: #definitioncount #### [definitionCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Configuration_Template_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Template_Attribute/_index.md index 1f73de5057..ab1a695a0e 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Template_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Template_Attribute/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Configuration template attribute class contains supplementary information for a configuration template. @@ -45,7 +47,8 @@ Configuration template attribute class contains supplementary information for a [value]: #value #### [value] Value of a configuration template attribute -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ Value of a configuration template attribute [configurationTemplate]: #configurationtemplate #### [configurationTemplate] -Type: **SoftLayer_Configuration_Template ** +Type: **SoftLayer_Configuration_Template ** + diff --git a/content/reference/datatypes/SoftLayer_Configuration_Template_Section/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Template_Section/_index.md index f844184e40..a2972369c8 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Template_Section/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Template_Section/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + The SoftLayer_Configuration_Template_Section data type contains information of a configuration section. Configuration can contain sub-sections. @@ -49,7 +51,8 @@ Configuration can contain sub-sections. [createDate]: #createdate #### [createDate] Created date -Type: **dateTime** +Type: **dateTime** + @@ -59,7 +62,8 @@ Created date [description]: #description #### [description] Configuration section description -Type: **string** +Type: **string** + @@ -69,7 +73,8 @@ Configuration section description [id]: #id #### [id] Internal identifier of a configuration section. -Type: **integer** +Type: **integer** + @@ -79,7 +84,8 @@ Internal identifier of a configuration section. [linkedTemplateId]: #linkedtemplateid #### [linkedTemplateId] Internal identifier of a sub configuration template that this section points to. Use this property if you wish to create a reference to a sub configuration template when creating a linked section. -Type: **string** +Type: **string** + @@ -89,7 +95,8 @@ Internal identifier of a sub configuration template that this section points to. [modifyDate]: #modifydate #### [modifyDate] Last modified date -Type: **dateTime** +Type: **dateTime** + @@ -99,7 +106,8 @@ Last modified date [name]: #name #### [name] Configuration section name -Type: **string** +Type: **string** + @@ -109,7 +117,8 @@ Configuration section name [parentId]: #parentid #### [parentId] Internal identifier of the parent configuration section -Type: **integer** +Type: **integer** + @@ -119,7 +128,8 @@ Internal identifier of the parent configuration section [sort]: #sort #### [sort] Sort order -Type: **integer** +Type: **integer** + @@ -129,7 +139,8 @@ Sort order [templateId]: #templateid #### [templateId] Internal identifier of a configuration template that this section belongs to -Type: **string** +Type: **string** + @@ -139,7 +150,8 @@ Internal identifier of a configuration template that this section belongs to [typeId]: #typeid #### [typeId] Internal identifier of the configuration section type -Type: **integer** +Type: **integer** + @@ -155,7 +167,8 @@ Internal identifier of the configuration section type [definitions]: #definitions #### [definitions] -Type: **SoftLayer_Configuration_Template_Section_Definition[] ** +Type: **SoftLayer_Configuration_Template_Section_Definition[] ** + @@ -165,7 +178,8 @@ Internal identifier of the configuration section type [disallowedDeletionFlag]: #disalloweddeletionflag #### [disallowedDeletionFlag] -Type: **boolean** +Type: **boolean** + @@ -175,7 +189,8 @@ Internal identifier of the configuration section type [linkedTemplate]: #linkedtemplate #### [linkedTemplate] -Type: **SoftLayer_Configuration_Template ** +Type: **SoftLayer_Configuration_Template ** + @@ -185,7 +200,8 @@ Internal identifier of the configuration section type [linkedTemplateReference]: #linkedtemplatereference #### [linkedTemplateReference] -Type: **SoftLayer_Configuration_Template_Section_Reference ** +Type: **SoftLayer_Configuration_Template_Section_Reference ** + @@ -195,7 +211,8 @@ Internal identifier of the configuration section type [profiles]: #profiles #### [profiles] -Type: **SoftLayer_Configuration_Template_Section_Profile[] ** +Type: **SoftLayer_Configuration_Template_Section_Profile[] ** + @@ -205,7 +222,8 @@ Internal identifier of the configuration section type [sectionType]: #sectiontype #### [sectionType] -Type: **SoftLayer_Configuration_Template_Section_Type ** +Type: **SoftLayer_Configuration_Template_Section_Type ** + @@ -215,7 +233,8 @@ Internal identifier of the configuration section type [sectionTypeName]: #sectiontypename #### [sectionTypeName] -Type: **string** +Type: **string** + @@ -225,7 +244,8 @@ Internal identifier of the configuration section type [subSections]: #subsections #### [subSections] -Type: **SoftLayer_Configuration_Template_Section[] ** +Type: **SoftLayer_Configuration_Template_Section[] ** + @@ -235,7 +255,8 @@ Internal identifier of the configuration section type [template]: #template #### [template] -Type: **SoftLayer_Configuration_Template ** +Type: **SoftLayer_Configuration_Template ** + @@ -247,7 +268,8 @@ Internal identifier of the configuration section type [definitionCount]: #definitioncount #### [definitionCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -257,7 +279,8 @@ A count of [profileCount]: #profilecount #### [profileCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -267,7 +290,8 @@ A count of [subSectionCount]: #subsectioncount #### [subSectionCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Attribute/_index.md index ef86e04503..8d59506977 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Attribute/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Configuration section attribute class contains supplementary information for a configuration section. @@ -45,7 +47,8 @@ Configuration section attribute class contains supplementary information for a c [value]: #value #### [value] Value of a configuration section attribute -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ Value of a configuration section attribute [configurationSection]: #configurationsection #### [configurationSection] -Type: **SoftLayer_Configuration_Template_Section ** +Type: **SoftLayer_Configuration_Template_Section ** + diff --git a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition/_index.md index e95e5fd34e..0692e5a7b7 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ If value type is defined as "Resource Specific Values", you will have to make an [createDate]: #createdate #### [createDate] Created date -Type: **dateTime** +Type: **dateTime** + @@ -61,7 +64,8 @@ Created date [description]: #description #### [description] Description of a configuration definition. -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ Description of a configuration definition. [enumerationValues]: #enumerationvalues #### [enumerationValues] Enumeration values separated by comma. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ Enumeration values separated by comma. [groupId]: #groupid #### [groupId] Definition group id. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ Definition group id. [id]: #id #### [id] Internal identifier of a configuration definition. -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ Internal identifier of a configuration definition. [maximumValue]: #maximumvalue #### [maximumValue] Maximum value of a configuration definition. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ Maximum value of a configuration definition. [minimumValue]: #minimumvalue #### [minimumValue] Minimum value of a configuration definition. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ Minimum value of a configuration definition. [modifyDate]: #modifydate #### [modifyDate] Last modify date -Type: **dateTime** +Type: **dateTime** + @@ -131,7 +141,8 @@ Last modify date [name]: #name #### [name] Configuration definition name. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ Configuration definition name. [path]: #path #### [path] Definition path. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ Definition path. [requireValueFlag]: #requirevalueflag #### [requireValueFlag] Indicates if a configuration value is required for this definition. -Type: **integer** +Type: **integer** + @@ -161,7 +174,8 @@ Indicates if a configuration value is required for this definition. [sectionId]: #sectionid #### [sectionId] Internal identifier of a configuration section. -Type: **integer** +Type: **integer** + @@ -171,7 +185,8 @@ Internal identifier of a configuration section. [shortName]: #shortname #### [shortName] Shortened configuration definition name. -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ Shortened configuration definition name. [sort]: #sort #### [sort] Sort order -Type: **integer** +Type: **integer** + @@ -191,7 +207,8 @@ Sort order [typeId]: #typeid #### [typeId] Internal identifier of a configuration definition type. -Type: **integer** +Type: **integer** + @@ -207,7 +224,8 @@ Internal identifier of a configuration definition type. [attributes]: #attributes #### [attributes] -Type: **SoftLayer_Configuration_Template_Section_Definition_Attribute[] ** +Type: **SoftLayer_Configuration_Template_Section_Definition_Attribute[] ** + @@ -217,7 +235,8 @@ Internal identifier of a configuration definition type. [defaultValue]: #defaultvalue #### [defaultValue] -Type: **SoftLayer_Configuration_Template_Section_Definition_Value ** +Type: **SoftLayer_Configuration_Template_Section_Definition_Value ** + @@ -227,7 +246,8 @@ Internal identifier of a configuration definition type. [group]: #group #### [group] -Type: **SoftLayer_Configuration_Template_Section_Definition_Group ** +Type: **SoftLayer_Configuration_Template_Section_Definition_Group ** + @@ -237,7 +257,8 @@ Internal identifier of a configuration definition type. [monitoringDataFlag]: #monitoringdataflag #### [monitoringDataFlag] -Type: **boolean** +Type: **boolean** + @@ -247,7 +268,8 @@ Internal identifier of a configuration definition type. [section]: #section #### [section] -Type: **SoftLayer_Configuration_Template_Section ** +Type: **SoftLayer_Configuration_Template_Section ** + @@ -257,7 +279,8 @@ Internal identifier of a configuration definition type. [valueType]: #valuetype #### [valueType] -Type: **SoftLayer_Configuration_Template_Section_Definition_Type ** +Type: **SoftLayer_Configuration_Template_Section_Definition_Type ** + @@ -269,7 +292,8 @@ Internal identifier of a configuration definition type. [attributeCount]: #attributecount #### [attributeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Attribute/_index.md index ea36b10079..f4d3da9cf7 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Attribute/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Configuration definition attribute class contains supplementary information for a configuration definition. @@ -45,7 +47,8 @@ Configuration definition attribute class contains supplementary information for [value]: #value #### [value] Value of a configuration definition attribute -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ Value of a configuration definition attribute [attributeType]: #attributetype #### [attributeType] -Type: **SoftLayer_Configuration_Template_Section_Definition_Attribute_Type ** +Type: **SoftLayer_Configuration_Template_Section_Definition_Attribute_Type ** + @@ -71,7 +75,8 @@ Value of a configuration definition attribute [configurationDefinition]: #configurationdefinition #### [configurationDefinition] -Type: **SoftLayer_Configuration_Template_Section_Definition ** +Type: **SoftLayer_Configuration_Template_Section_Definition ** + diff --git a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Attribute_Type/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Attribute_Type/_index.md index 54f6e3b958..0d6b6f4705 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Attribute_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Attribute_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Configuration_Template_Attribute_Type models the type of attribute that can be assigned to a configuration definition. @@ -45,7 +47,8 @@ SoftLayer_Configuration_Template_Attribute_Type models the type of attribute tha [description]: #description #### [description] Description of a definition attribute type -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Description of a definition attribute type [name]: #name #### [name] Name of a definition attribute type -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Group/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Group/_index.md index c9ed6b35da..daa32570cd 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Group/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Configuration definition group gives you details of the definition and allows extra functionality. @@ -47,7 +49,8 @@ Configuration definition group gives you details of the definition and allows ex [createDate]: #createdate #### [createDate] Created date -Type: **dateTime** +Type: **dateTime** + @@ -57,7 +60,8 @@ Created date [description]: #description #### [description] Internal Description of a definition group. -Type: **string** +Type: **string** + @@ -67,7 +71,8 @@ Internal Description of a definition group. [id]: #id #### [id] Internal identifier of a definition group. -Type: **integer** +Type: **integer** + @@ -77,7 +82,8 @@ Internal identifier of a definition group. [name]: #name #### [name] Internal Definition group name. -Type: **string** +Type: **string** + @@ -87,7 +93,8 @@ Internal Definition group name. [sortOrder]: #sortorder #### [sortOrder] Sort order -Type: **integer** +Type: **integer** + @@ -103,7 +110,8 @@ Sort order [parent]: #parent #### [parent] -Type: **SoftLayer_Configuration_Template_Section_Definition_Group ** +Type: **SoftLayer_Configuration_Template_Section_Definition_Group ** + diff --git a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Type/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Type/_index.md index e5dc97ea48..0143cbb806 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Configuration_Template_Section_Definition_Type further defines the value of a configuration definition. @@ -45,7 +47,8 @@ SoftLayer_Configuration_Template_Section_Definition_Type further defines the val [description]: #description #### [description] Description of a configuration value type -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Description of a configuration value type [id]: #id #### [id] Internal identifier of a configuration value type -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Internal identifier of a configuration value type [name]: #name #### [name] Name of a configuration value type -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Value/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Value/_index.md index eff1fdd34c..ea999bbc38 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Value/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Definition_Value/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Configuration_Section_Value is used to set the value for a configuration definition @@ -45,7 +47,8 @@ SoftLayer_Configuration_Section_Value is used to set the value for a configurati [createDate]: #createdate #### [createDate] Created date -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ Created date [definitionId]: #definitionid #### [definitionId] Internal identifier of a configuration definition that this configuration value if defined by -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Internal identifier of a configuration definition that this configuration value [modifyDate]: #modifydate #### [modifyDate] Internal Last modified date -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ Internal Last modified date [templateId]: #templateid #### [templateId] Internal identifier of a configuration template that this configuration value belongs to -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Internal identifier of a configuration template that this configuration value be [value]: #value #### [value] Internal Configuration value -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ Internal Configuration value [definition]: #definition #### [definition] -Type: **SoftLayer_Configuration_Template_Section_Definition ** +Type: **SoftLayer_Configuration_Template_Section_Definition ** + @@ -111,7 +119,8 @@ Internal Configuration value [template]: #template #### [template] -Type: **SoftLayer_Configuration_Template ** +Type: **SoftLayer_Configuration_Template ** + diff --git a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Profile/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Profile/_index.md index 6d768e6c2f..080a0652a0 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Profile/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Profile/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + 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. @@ -49,7 +51,8 @@ For example, you can create multiple configuration profiles to monitor multiple [agentId]: #agentid #### [agentId] Internal identifier of a monitoring agent this profile belongs to. -Type: **integer** +Type: **integer** + @@ -59,7 +62,8 @@ Internal identifier of a monitoring agent this profile belongs to. [createDate]: #createdate #### [createDate] Created date -Type: **dateTime** +Type: **dateTime** + @@ -69,7 +73,8 @@ Created date [id]: #id #### [id] Internal identifier of a configuration profile. -Type: **integer** +Type: **integer** + @@ -79,7 +84,8 @@ Internal identifier of a configuration profile. [name]: #name #### [name] Name of a configuration profile -Type: **string** +Type: **string** + @@ -89,7 +95,8 @@ Name of a configuration profile [sectionId]: #sectionid #### [sectionId] Internal identifier of a configuration section that this profile belongs to. -Type: **integer** +Type: **integer** + @@ -105,7 +112,8 @@ Internal identifier of a configuration section that this profile belongs to. [configurationSection]: #configurationsection #### [configurationSection] -Type: **SoftLayer_Configuration_Template_Section ** +Type: **SoftLayer_Configuration_Template_Section ** + diff --git a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Reference/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Reference/_index.md index 0cd301dfa1..3af5f6d3f6 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Reference/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Reference/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Configuration_Template_Section_Reference data type contains information of a configuration section and its associated configuration template. @@ -45,7 +47,8 @@ The SoftLayer_Configuration_Template_Section_Reference data type contains inform [createDate]: #createdate #### [createDate] Created date -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ Created date [id]: #id #### [id] Internal identifier of a configuration section reference. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Internal identifier of a configuration section reference. [modifyDate]: #modifydate #### [modifyDate] Modified date -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ Modified date [sectionId]: #sectionid #### [sectionId] Internal identifier of a configuration section. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Internal identifier of a configuration section. [templateId]: #templateid #### [templateId] Internal identifier of a configuration template. -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ Internal identifier of a configuration template. [section]: #section #### [section] -Type: **SoftLayer_Configuration_Template_Section ** +Type: **SoftLayer_Configuration_Template_Section ** + @@ -111,7 +119,8 @@ Internal identifier of a configuration template. [template]: #template #### [template] -Type: **SoftLayer_Configuration_Template ** +Type: **SoftLayer_Configuration_Template ** + diff --git a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Type/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Type/_index.md index cdf87fe0ce..a508a2148e 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Template_Section_Type/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + The SoftLayer_Configuration_Template_Section_Type data type contains information of a configuration section type. Configuration can contain sub-sections. @@ -49,7 +51,8 @@ Configuration can contain sub-sections. [description]: #description #### [description] Configuration section type description -Type: **string** +Type: **string** + @@ -59,7 +62,8 @@ Configuration section type description [id]: #id #### [id] Internal identifier of a configuration section type -Type: **integer** +Type: **integer** + @@ -69,7 +73,8 @@ Internal identifier of a configuration section type [name]: #name #### [name] Configuration section type name -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Configuration_Template_Type/_index.md b/content/reference/datatypes/SoftLayer_Configuration_Template_Type/_index.md index 4f85b0f2b1..50b73afb9f 100644 --- a/content/reference/datatypes/SoftLayer_Configuration_Template_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Configuration_Template_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Configuration_Template_Type data type contains configuration template type information. @@ -45,7 +47,8 @@ The SoftLayer_Configuration_Template_Type data type contains configuration templ [createDate]: #createdate #### [createDate] Created date. This is deprecated now. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ Created date. This is deprecated now. [description]: #description #### [description] Description of a configuration template -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Description of a configuration template [id]: #id #### [id] Internal identifier of a configuration template type -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ Internal identifier of a configuration template type [name]: #name #### [name] Name of a configuration template type -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_Authentication_OpenIdConnect_UsernameLookupContainer/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_Authentication_OpenIdConnect_UsernameLookupContainer/_index.md index 38de78a79d..6f6b5b8591 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_Authentication_OpenIdConnect_UsernameLookupContainer/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_Authentication_OpenIdConnect_UsernameLookupContainer/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [active]: #active #### [active] -Type: **boolean** +Type: **boolean** +
      @@ -55,7 +58,8 @@ classes: [emailAddress]: #emailaddress #### [emailAddress] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [federated]: #federated #### [federated] -Type: **boolean** +Type: **boolean** + @@ -75,7 +80,8 @@ classes: [foundAs]: #foundas #### [foundAs] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [numberOfIbmIdsWithEmailAddress]: #numberofibmidswithemailaddress #### [numberOfIbmIdsWithEmailAddress] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [realm]: #realm #### [realm] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ classes: [uniqueId]: #uniqueid #### [uniqueId] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [username]: #username #### [username] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_Discount_Program/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_Discount_Program/_index.md index 969ad5a727..4b7a42bcd1 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_Discount_Program/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_Discount_Program/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Account_Discount_Program models a single outbound object for a graph of given data sets. @@ -50,7 +52,8 @@ SoftLayer_Container_Account_Discount_Program models a single outbound object for [appliedCredit]: #appliedcredit #### [appliedCredit] The credit allowance that has already been applied during the current billing cycle. If the lifetime limit has been or soon will be reached, this amount may included credit applied in previous billing cycles. -Type: **decimal** +Type: **decimal** + @@ -60,7 +63,8 @@ The credit allowance that has already been applied during the current billing cy [isParticipant]: #isparticipant #### [isParticipant] Flag to signify whether the account is a participant in the discount program. -Type: **boolean** +Type: **boolean** + @@ -70,7 +74,8 @@ Flag to signify whether the account is a participant in the discount program. [lifetimeAppliedCredit]: #lifetimeappliedcredit #### [lifetimeAppliedCredit] Credit allowance applied over the course of the entire program enrollment. For enrollments without a lifetime restriction, this property will not be populated as credit will be tracked on a purely monthly basis. -Type: **decimal** +Type: **decimal** + @@ -80,7 +85,8 @@ Credit allowance applied over the course of the entire program enrollment. For e [lifetimeCredit]: #lifetimecredit #### [lifetimeCredit] Credit allowance available over the course of the entire program enrollment. If null, enrollment credit is applied on a strictly monthly basis and there is no lifetime maximum. Enrollments with non-null lifetime credit will receive the lesser of the remaining monthly credit or the remaining lifetime credit. -Type: **decimal** +Type: **decimal** + @@ -90,7 +96,8 @@ Credit allowance available over the course of the entire program enrollment. If [lifetimeRemainingCredit]: #lifetimeremainingcredit #### [lifetimeRemainingCredit] Remaining credit allowance available over the remaining duration of the program enrollment. If null, enrollment credit is applied on a strictly monthly basis and there is no lifetime maximum. Enrollments with non-null remaining lifetime credit will receive the lesser of the remaining monthly credit or the remaining lifetime credit. -Type: **decimal** +Type: **decimal** + @@ -100,7 +107,8 @@ Remaining credit allowance available over the remaining duration of the program [maximumActiveOrders]: #maximumactiveorders #### [maximumActiveOrders] Maximum number of orders the enrolled account is allowed to have open at one time. If null, then the Flexible Credit Program does not impose an order limit. -Type: **decimal** +Type: **decimal** + @@ -110,7 +118,8 @@ Maximum number of orders the enrolled account is allowed to have open at one tim [monthlyCredit]: #monthlycredit #### [monthlyCredit] The monthly credit allowance that is available at the beginning of the billing cycle. -Type: **decimal** +Type: **decimal** + @@ -120,7 +129,8 @@ The monthly credit allowance that is available at the beginning of the billing c [postTaxRemainingCredit]: #posttaxremainingcredit #### [postTaxRemainingCredit] DEPRECATED: Taxes are calculated in real time and discount amounts are shown pre-tax in all cases. Tax values in the SoftLayer_Container_Account_Discount_Program container are now populated with the related pre-tax values. -Type: **decimal** +Type: **decimal** + @@ -130,7 +140,8 @@ DEPRECATED: Taxes are calculated in real time and discount amounts are shown pre [programEndDate]: #programenddate #### [programEndDate] The date at which the program expires in MM/DD/YYYY format. -Type: **dateTime** +Type: **dateTime** + @@ -140,7 +151,8 @@ The date at which the program expires in MM/DD/YYYY format. [programName]: #programname #### [programName] Name of the Flexible Credit Program the account is enrolled in. -Type: **string** +Type: **string** + @@ -150,7 +162,8 @@ Name of the Flexible Credit Program the account is enrolled in. [remainingCredit]: #remainingcredit #### [remainingCredit] The credit allowance that is available during the current billing cycle. If the lifetime limit has been or soon will be reached, this amount may be reduced by credit applied in previous billing cycles. -Type: **decimal** +Type: **decimal** + @@ -160,7 +173,8 @@ The credit allowance that is available during the current billing cycle. If the [remainingCreditTax]: #remainingcredittax #### [remainingCreditTax] DEPRECATED: Taxes are calculated in real time and discount amounts are shown pre-tax in all cases. Tax values in the SoftLayer_Container_Account_Discount_Program container are now populated with the related pre-tax values. -Type: **decimal** +Type: **decimal** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_Discount_Program_Collection/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_Discount_Program_Collection/_index.md index f8167456f9..0c658869a1 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_Discount_Program_Collection/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_Discount_Program_Collection/_index.md @@ -21,6 +21,8 @@ classes: + + ### associatedMethods * [SoftLayer_Account::getFlexibleCreditProgramsInfo](/reference/services/SoftLayer_Account/getFlexibleCreditProgramsInfo ) @@ -50,7 +52,8 @@ classes: [accountLevelAppliedCredit]: #accountlevelappliedcredit #### [accountLevelAppliedCredit] The amount of credit that has been used by all account level enrollments in the billing cycle. -Type: **decimal** +Type: **decimal** + @@ -60,7 +63,8 @@ The amount of credit that has been used by all account level enrollments in the [accountLevelLifetimeAppliedCredit]: #accountlevellifetimeappliedcredit #### [accountLevelLifetimeAppliedCredit] Account level credit allowance applied over the course of entire active program enrollments. For enrollments without a lifetime restriction, this property will not be populated as credit will be tracked on a purely monthly basis. -Type: **decimal** +Type: **decimal** + @@ -70,7 +74,8 @@ Account level credit allowance applied over the course of entire active program [accountLevelLifetimeCredit]: #accountlevellifetimecredit #### [accountLevelLifetimeCredit] The total account level credit over the course of an entire program enrollment. This value may be null, in which case the enrollment credit is applied on a monthly basis and there is no lifetime maximum. -Type: **decimal** +Type: **decimal** + @@ -80,7 +85,8 @@ The total account level credit over the course of an entire program enrollment. [accountLevelLifetimeRemainingCredit]: #accountlevellifetimeremainingcredit #### [accountLevelLifetimeRemainingCredit] Remaining account level credit allowance available over the remaining duration of the program enrollments. If null, enrollment credit is applied on a strictly monthly basis and there is no lifetime maximum. Enrollments with non-null remaining lifetime credit will receive the lesser of the remaining monthly credit or the remaining lifetime credit. -Type: **decimal** +Type: **decimal** + @@ -90,7 +96,8 @@ Remaining account level credit allowance available over the remaining duration o [accountLevelMonthlyCredit]: #accountlevelmonthlycredit #### [accountLevelMonthlyCredit] The total account level monthly credit allowance available at the beginning of a billing cycle. -Type: **decimal** +Type: **decimal** + @@ -100,7 +107,8 @@ The total account level monthly credit allowance available at the beginning of a [accountLevelRemainingCredit]: #accountlevelremainingcredit #### [accountLevelRemainingCredit] The total account level credit allowance still available during the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -110,7 +118,8 @@ The total account level credit allowance still available during the current bill [enrollments]: #enrollments #### [enrollments] The active enrollments for this account. -Type: **SoftLayer_FlexibleCredit_Enrollment[] ** +Type: **SoftLayer_FlexibleCredit_Enrollment[] ** + @@ -120,7 +129,8 @@ The active enrollments for this account. [isAccountLevelParticipantFlag]: #isaccountlevelparticipantflag #### [isAccountLevelParticipantFlag] Indicates whether or not the account is participating in any account level Flexible Credit programs. -Type: **boolean** +Type: **boolean** + @@ -130,7 +140,8 @@ Indicates whether or not the account is participating in any account level Flexi [isParticipantFlag]: #isparticipantflag #### [isParticipantFlag] Indicates whether or not the account is participating in any Flexible Credit programs. -Type: **boolean** +Type: **boolean** + @@ -140,7 +151,8 @@ Indicates whether or not the account is participating in any Flexible Credit pro [isProductSpecificParticipantFlag]: #isproductspecificparticipantflag #### [isProductSpecificParticipantFlag] Indicates whether or not the account is participating in any product specific level Flexible Credit programs. -Type: **boolean** +Type: **boolean** + @@ -150,7 +162,8 @@ Indicates whether or not the account is participating in any product specific le [productSpecificAppliedCredit]: #productspecificappliedcredit #### [productSpecificAppliedCredit] The amount of credit that has been used by all product specific enrollments in the billing cycle. -Type: **decimal** +Type: **decimal** + @@ -160,7 +173,8 @@ The amount of credit that has been used by all product specific enrollments in t [productSpecificLifetimeAppliedCredit]: #productspecificlifetimeappliedcredit #### [productSpecificLifetimeAppliedCredit] Product specific credit allowance applied over the course of entire active program enrollments. For enrollments without a lifetime restriction, this property will not be populated as credit will be tracked on a purely monthly basis. -Type: **decimal** +Type: **decimal** + @@ -170,7 +184,8 @@ Product specific credit allowance applied over the course of entire active progr [productSpecificLifetimeCredit]: #productspecificlifetimecredit #### [productSpecificLifetimeCredit] The total product specific credit over the course of an entire program enrollment. This value may be null, in which case the enrollment credit is applied on a monthly basis and there is no lifetime maximum. -Type: **decimal** +Type: **decimal** + @@ -180,7 +195,8 @@ The total product specific credit over the course of an entire program enrollmen [productSpecificLifetimeRemainingCredit]: #productspecificlifetimeremainingcredit #### [productSpecificLifetimeRemainingCredit] Remaining product specific level credit allowance available over the remaining duration of the program enrollments. If null, enrollment credit is applied on a strictly monthly basis and there is no lifetime maximum. Enrollments with non-null remaining lifetime credit will receive the lesser of the remaining monthly credit or the remaining lifetime credit. -Type: **decimal** +Type: **decimal** + @@ -190,7 +206,8 @@ Remaining product specific level credit allowance available over the remaining d [productSpecificMonthlyCredit]: #productspecificmonthlycredit #### [productSpecificMonthlyCredit] The total product specific monthly credit allowance available at the beginning of a billing cycle. -Type: **decimal** +Type: **decimal** + @@ -200,7 +217,8 @@ The total product specific monthly credit allowance available at the beginning o [productSpecificRemainingCredit]: #productspecificremainingcredit #### [productSpecificRemainingCredit] The total product specific credit allowance still available during the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -210,7 +228,8 @@ The total product specific credit allowance still available during the current b [totalAppliedCredit]: #totalappliedcredit #### [totalAppliedCredit] The credit allowance that has already been applied during the current billing cycle from all enrollments. If the lifetime limit has been or soon will be reached, this amount may included credit applied in previous billing cycles. -Type: **decimal** +Type: **decimal** + @@ -220,7 +239,8 @@ The credit allowance that has already been applied during the current billing cy [totalRemainingCredit]: #totalremainingcredit #### [totalRemainingCredit] The credit allowance that is available during the current billing cycle from all enrollments. If the lifetime limit has been or soon will be reached, this amount may be reduced by credit applied in previous billing cycles. -Type: **decimal** +Type: **decimal** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_External_Setup_ProvisioningHoldLifted/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_External_Setup_ProvisioningHoldLifted/_index.md index a10d0cbe4b..16c28602ba 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_External_Setup_ProvisioningHoldLifted/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_External_Setup_ProvisioningHoldLifted/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [additionalAttributes]: #additionalattributes #### [additionalAttributes] -Type: **SoftLayer_Container_Account_External_Setup_ProvisioningHoldLifted_Attributes ** +Type: **SoftLayer_Container_Account_External_Setup_ProvisioningHoldLifted_Attributes ** +
      @@ -55,7 +58,8 @@ classes: [code]: #code #### [code] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [error]: #error #### [error] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [state]: #state #### [state] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_External_Setup_ProvisioningHoldLifted_Attributes/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_External_Setup_ProvisioningHoldLifted_Attributes/_index.md index 2d2a740cbe..ee94a39a6c 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_External_Setup_ProvisioningHoldLifted_Attributes/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_External_Setup_ProvisioningHoldLifted_Attributes/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [brandKeyName]: #brandkeyname #### [brandKeyName] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [softLayerBrandMoveDate]: #softlayerbrandmovedate #### [softLayerBrandMoveDate] -Type: **dateTime** +Type: **dateTime** +
      diff --git a/content/reference/datatypes/SoftLayer_Container_Account_Graph_Outputs/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_Graph_Outputs/_index.md index 4b81682cca..0487fcda5f 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_Graph_Outputs/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_Graph_Outputs/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Models a single outbound object for a graph of given data sets. @@ -45,7 +47,8 @@ Models a single outbound object for a graph of given data sets. [closedTickets]: #closedtickets #### [closedTickets] The count of closed tickets included in this graph. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The count of closed tickets included in this graph. [completedBackupCount]: #completedbackupcount #### [completedBackupCount] The count of completed backups included in this graph. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The count of completed backups included in this graph. [conflictBackupCount]: #conflictbackupcount #### [conflictBackupCount] The count of conflicted backups included in this graph. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The count of conflicted backups included in this graph. [endDate]: #enddate #### [endDate] The maximum date included in this graph. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The maximum date included in this graph. [failedBackupCount]: #failedbackupcount #### [failedBackupCount] The count of failed backups included in this graph. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The count of failed backups included in this graph. [graphError]: #grapherror #### [graphError] Error message encountered during graphing -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ Error message encountered during graphing [graphImage]: #graphimage #### [graphImage] The raw PNG binary data to be displayed once the graph is drawn. -Type: **binary data** +Type: **binary data** + @@ -115,7 +124,8 @@ The raw PNG binary data to be displayed once the graph is drawn. [hardwareUptime]: #hardwareuptime #### [hardwareUptime] The average of hardware uptime included in this graph. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The average of hardware uptime included in this graph. [inboundUsage]: #inboundusage #### [inboundUsage] The inbound bandwidth usage shown in this graph. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The inbound bandwidth usage shown in this graph. [openTickets]: #opentickets #### [openTickets] The count of open tickets included in this graph. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The count of open tickets included in this graph. [outboundUsage]: #outboundusage #### [outboundUsage] The outbound bandwidth usage shown in this graph. -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ The outbound bandwidth usage shown in this graph. [pendingCustomerResponseTicketCount]: #pendingcustomerresponseticketcount #### [pendingCustomerResponseTicketCount] The count of tickets included in this graph. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ The count of tickets included in this graph. [startDate]: #startdate #### [startDate] The minimum date included in this graph. -Type: **dateTime** +Type: **dateTime** + @@ -175,7 +190,8 @@ The minimum date included in this graph. [urlUptime]: #urluptime #### [urlUptime] The average of url uptime included in this graph. -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ The average of url uptime included in this graph. [waitingEmployeeResponseTicketCount]: #waitingemployeeresponseticketcount #### [waitingEmployeeResponseTicketCount] The count of tickets included in this graph. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_Historical_Summary/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_Historical_Summary/_index.md index 2ca06cfe91..cba5ccdb68 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_Historical_Summary/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_Historical_Summary/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Historical Summary Container for account resource details @@ -45,7 +47,8 @@ Historical Summary Container for account resource details [details]: #details #### [details] Array of server uptime detail containers -Type: **SoftLayer_Container_Account_Historical_Summary_Detail[] ** +Type: **SoftLayer_Container_Account_Historical_Summary_Detail[] ** + @@ -55,7 +58,8 @@ Array of server uptime detail containers [endDate]: #enddate #### [endDate] The maximum date included in the summary. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The maximum date included in the summary. [startDate]: #startdate #### [startDate] The minimum date included in the summary. -Type: **dateTime** +Type: **dateTime** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Detail/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Detail/_index.md index a6799700e7..934cc7a5ce 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Detail/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Detail/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Historical Summary Details Container for a resource's data @@ -45,7 +47,8 @@ Historical Summary Details Container for a resource's data [endDate]: #enddate #### [endDate] The maximum date included in the detail. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The maximum date included in the detail. [startDate]: #startdate #### [startDate] The minimum date included in the detail. -Type: **dateTime** +Type: **dateTime** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Detail_Uptime/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Detail_Uptime/_index.md index 57998d06c5..c6e21607b6 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Detail_Uptime/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Detail_Uptime/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Historical Summary Details Container for a host resource uptime @@ -45,7 +47,8 @@ Historical Summary Details Container for a host resource uptime [cloudComputingInstance]: #cloudcomputinginstance #### [cloudComputingInstance] The hardware for uptime details. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -55,7 +58,8 @@ The hardware for uptime details. [data]: #data #### [data] The data associated with a host uptime details. -Type: **SoftLayer_Metric_Tracking_Object_Data[] ** +Type: **SoftLayer_Metric_Tracking_Object_Data[] ** + @@ -65,7 +69,8 @@ The data associated with a host uptime details. [endDate]: #enddate #### [endDate] The maximum date included in the detail. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The maximum date included in the detail. [hardware]: #hardware #### [hardware] The hardware for uptime details. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -85,7 +91,8 @@ The hardware for uptime details. [startDate]: #startdate #### [startDate] The minimum date included in the detail. -Type: **dateTime** +Type: **dateTime** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Uptime/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Uptime/_index.md index e78aa61f54..8019cfbe73 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Uptime/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Uptime/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Historical Summary Container for account host's resource uptime details @@ -45,7 +47,8 @@ Historical Summary Container for account host's resource uptime details [details]: #details #### [details] Array of server uptime detail containers -Type: **SoftLayer_Container_Account_Historical_Summary_Detail[] ** +Type: **SoftLayer_Container_Account_Historical_Summary_Detail[] ** + @@ -55,7 +58,8 @@ Array of server uptime detail containers [endDate]: #enddate #### [endDate] The maximum date included in the summary. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The maximum date included in the summary. [startDate]: #startdate #### [startDate] The minimum date included in the summary. -Type: **dateTime** +Type: **dateTime** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_Internal_Ibm_Request/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_Internal_Ibm_Request/_index.md index f3d8a1ca92..63af8346d9 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_Internal_Ibm_Request/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_Internal_Ibm_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ Contains data required to both request a new IaaS account for active IBM employe [accountType]: #accounttype #### [accountType] Purpose of the internal IBM account chosen from the list of available -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ Purpose of the internal IBM account chosen from the list of available [address1]: #address1 #### [address1] If not provided, will attempt to retrieve from BluePages -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ If not provided, will attempt to retrieve from BluePages [address2]: #address2 #### [address2] If no address provided, will attempt to retrieve from BluePages -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ If no address provided, will attempt to retrieve from BluePages [city]: #city #### [city] If not provided, will attempt to retrieve from BluePages -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ If not provided, will attempt to retrieve from BluePages [companyName]: #companyname #### [companyName] Name of the company displayed on the IaaS account -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ Name of the company displayed on the IaaS account [country]: #country #### [country] If not provided, will attempt to retrieve from BluePages -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ If not provided, will attempt to retrieve from BluePages [deniedFlag]: #deniedflag #### [deniedFlag] True if the request has been denied by either the IaaS team or the -Type: **boolean** +Type: **boolean** + @@ -121,7 +130,8 @@ True if the request has been denied by either the IaaS team or the [departmentCode]: #departmentcode #### [departmentCode] Department within the division which will be changed during cost recovery. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Department within the division which will be changed during cost recovery. [departmentCountry]: #departmentcountry #### [departmentCountry] Country assigned to the department for cost recovery. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ Country assigned to the department for cost recovery. [divisionCode]: #divisioncode #### [divisionCode] Division code used for cost recovery. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ Division code used for cost recovery. [emailAddress]: #emailaddress #### [emailAddress] Account owner's IBM email address. Must be a discoverable email -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ Account owner's IBM email address. Must be a discoverable email [firstName]: #firstname #### [firstName] Applicant's first name, as provided by IBM BluePages API. -Type: **string** +Type: **string** + @@ -171,7 +185,8 @@ Applicant's first name, as provided by IBM BluePages API. [lastName]: #lastname #### [lastName] Applicant's last name, as provided by IBM BluePages API. -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ Applicant's last name, as provided by IBM BluePages API. [managerApprovalStatus]: #managerapprovalstatus #### [managerApprovalStatus] APPROVED if the request has been approved by the first-line manager, -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ APPROVED if the request has been approved by the first-line manager, [multiTenantFlag]: #multitenantflag #### [multiTenantFlag] True for accounts intended to be multi-tenant and false otherwise -Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ True for accounts intended to be multi-tenant and false otherwise [officePhone]: #officephone #### [officePhone] Account owner's primary phone number. If no phone number is available -Type: **string** +Type: **string** + @@ -211,7 +229,8 @@ Account owner's primary phone number. If no phone number is available [paasAccountId]: #paasaccountid #### [paasAccountId] Bluemix PaaS 32 digit hexadecimal account id being automatically linked -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ Bluemix PaaS 32 digit hexadecimal account id being automatically linked [postalCode]: #postalcode #### [postalCode] If not provided, will attempt to retrieve from BluePages -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ If not provided, will attempt to retrieve from BluePages [purpose]: #purpose #### [purpose] Stated purpose of the new account this request would create -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ Stated purpose of the new account this request would create [securitySubjectMatterExpertEmail]: #securitysubjectmatterexpertemail #### [securitySubjectMatterExpertEmail] Division's security SME's email address, if available -Type: **string** +Type: **string** + @@ -251,7 +273,8 @@ Division's security SME's email address, if available [securitySubjectMatterExpertName]: #securitysubjectmatterexpertname #### [securitySubjectMatterExpertName] Division's security SME's name, if available -Type: **string** +Type: **string** + @@ -261,7 +284,8 @@ Division's security SME's name, if available [securitySubjectMatterExpertPhone]: #securitysubjectmatterexpertphone #### [securitySubjectMatterExpertPhone] Division's security SME's phone, if available -Type: **string** +Type: **string** + @@ -271,7 +295,8 @@ Division's security SME's phone, if available [state]: #state #### [state] If required for chosen country and not provided, will attempt -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_Payment_Method_CreditCard/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_Payment_Method_CreditCard/_index.md index 8900bed78e..8bef173ceb 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_Payment_Method_CreditCard/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_Payment_Method_CreditCard/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [address1]: #address1 #### [address1] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [address2]: #address2 #### [address2] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [city]: #city #### [city] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [country]: #country #### [country] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [currencyShortName]: #currencyshortname #### [currencyShortName] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [cybersourceAssignedCardType]: #cybersourceassignedcardtype #### [cybersourceAssignedCardType] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ classes: [expireMonth]: #expiremonth #### [expireMonth] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [expireYear]: #expireyear #### [expireYear] -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ classes: [firstName]: #firstname #### [firstName] -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ classes: [lastFourDigits]: #lastfourdigits #### [lastFourDigits] -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ classes: [lastName]: #lastname #### [lastName] -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ classes: [nickname]: #nickname #### [nickname] -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ classes: [paymentMethodRoleName]: #paymentmethodrolename #### [paymentMethodRoleName] -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ classes: [paymentTypeId]: #paymenttypeid #### [paymentTypeId] -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ classes: [paymentTypeName]: #paymenttypename #### [paymentTypeName] -Type: **string** +Type: **string** + @@ -195,7 +212,8 @@ classes: [postalCode]: #postalcode #### [postalCode] -Type: **string** +Type: **string** + @@ -205,7 +223,8 @@ classes: [state]: #state #### [state] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_PersonalInformation/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_PersonalInformation/_index.md index f4cc35448e..b97196330e 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_PersonalInformation/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_PersonalInformation/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [address1]: #address1 #### [address1] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [address2]: #address2 #### [address2] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [alternatePhone]: #alternatephone #### [alternatePhone] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [city]: #city #### [city] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [country]: #country #### [country] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ classes: [email]: #email #### [email] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [firstName]: #firstname #### [firstName] -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ classes: [lastName]: #lastname #### [lastName] -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ classes: [officePhone]: #officephone #### [officePhone] -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ classes: [postalCode]: #postalcode #### [postalCode] -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ classes: [requestDate]: #requestdate #### [requestDate] -Type: **dateTime** +Type: **dateTime** + @@ -165,7 +179,8 @@ classes: [requestId]: #requestid #### [requestId] -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ classes: [state]: #state #### [state] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Contact_Customer/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Contact_Customer/_index.md index 5cacff1568..8c103c95d0 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Contact_Customer/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Contact_Customer/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The customer and prospective owner of a proof of concept account established by an IBMer. @@ -50,7 +52,8 @@ The customer and prospective owner of a proof of concept account established by [address1]: #address1 #### [address1] Customer's address -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ Customer's address [address2]: #address2 #### [address2] Customer's address -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ Customer's address [city]: #city #### [city] Customer's city -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ Customer's city [country]: #country #### [country] Customer's ISO country code -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ Customer's ISO country code [email]: #email #### [email] Customer's email address -Type: **string** +Type: **string** + @@ -100,7 +107,8 @@ Customer's email address [firstName]: #firstname #### [firstName] Customer's first name -Type: **string** +Type: **string** + @@ -110,7 +118,8 @@ Customer's first name [lastName]: #lastname #### [lastName] Customer's last name -Type: **string** +Type: **string** + @@ -120,7 +129,8 @@ Customer's last name [phone]: #phone #### [phone] Customer's primary phone number -Type: **string** +Type: **string** + @@ -130,7 +140,8 @@ Customer's primary phone number [postalCode]: #postalcode #### [postalCode] Customer's postal code -Type: **string** +Type: **string** + @@ -140,7 +151,8 @@ Customer's postal code [state]: #state #### [state] Customer's state -Type: **string** +Type: **string** + @@ -150,7 +162,8 @@ Customer's state [vatId]: #vatid #### [vatId] Customer's VAT ID -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Requester/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Requester/_index.md index 7f7373db42..6b3b236c22 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Requester/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Requester/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + IBMer who is submitting a proof of concept request on behalf of a prospective customer. @@ -50,7 +52,8 @@ IBMer who is submitting a proof of concept request on behalf of a prospective cu [address1]: #address1 #### [address1] Customer's address -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ Customer's address [address2]: #address2 #### [address2] Customer's address -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ Customer's address [businessUnit]: #businessunit #### [businessUnit] -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ Customer's address [city]: #city #### [city] Customer's city -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ Customer's city [country]: #country #### [country] Customer's ISO country code -Type: **string** +Type: **string** + @@ -100,7 +107,8 @@ Customer's ISO country code [email]: #email #### [email] Customer's email address -Type: **string** +Type: **string** + @@ -110,7 +118,8 @@ Customer's email address [firstName]: #firstname #### [firstName] Customer's first name -Type: **string** +Type: **string** + @@ -120,7 +129,8 @@ Customer's first name [lastName]: #lastname #### [lastName] Customer's last name -Type: **string** +Type: **string** + @@ -130,7 +140,8 @@ Customer's last name [organizationCountry]: #organizationcountry #### [organizationCountry] -Type: **string** +Type: **string** + @@ -140,7 +151,8 @@ Customer's last name [paasAccountId]: #paasaccountid #### [paasAccountId] -Type: **string** +Type: **string** + @@ -150,7 +162,8 @@ Customer's last name [phone]: #phone #### [phone] Customer's primary phone number -Type: **string** +Type: **string** + @@ -160,7 +173,8 @@ Customer's primary phone number [postalCode]: #postalcode #### [postalCode] Customer's postal code -Type: **string** +Type: **string** + @@ -170,7 +184,8 @@ Customer's postal code [state]: #state #### [state] Customer's state -Type: **string** +Type: **string** + @@ -180,7 +195,8 @@ Customer's state [subOrganization]: #suborganization #### [subOrganization] -Type: **string** +Type: **string** + @@ -190,7 +206,8 @@ Customer's state [uid]: #uid #### [uid] -Type: **string** +Type: **string** + @@ -200,7 +217,8 @@ Customer's state [vatId]: #vatid #### [vatId] Customer's VAT ID -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Technical/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Technical/_index.md index 844ae8d047..f1ee49c839 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Technical/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Technical/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + IBMer who will assist the requester with technical aspects of configuring the proof of concept account. @@ -50,7 +52,8 @@ IBMer who will assist the requester with technical aspects of configuring the pr [address1]: #address1 #### [address1] Customer's address -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ Customer's address [address2]: #address2 #### [address2] Customer's address -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ Customer's address [city]: #city #### [city] Customer's city -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ Customer's city [country]: #country #### [country] Customer's ISO country code -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ Customer's ISO country code [email]: #email #### [email] Customer's email address -Type: **string** +Type: **string** + @@ -100,7 +107,8 @@ Customer's email address [firstName]: #firstname #### [firstName] Customer's first name -Type: **string** +Type: **string** + @@ -110,7 +118,8 @@ Customer's first name [lastName]: #lastname #### [lastName] Customer's last name -Type: **string** +Type: **string** + @@ -120,7 +129,8 @@ Customer's last name [phone]: #phone #### [phone] Customer's primary phone number -Type: **string** +Type: **string** + @@ -130,7 +140,8 @@ Customer's primary phone number [postalCode]: #postalcode #### [postalCode] Customer's postal code -Type: **string** +Type: **string** + @@ -140,7 +151,8 @@ Customer's postal code [state]: #state #### [state] Customer's state -Type: **string** +Type: **string** + @@ -150,7 +162,8 @@ Customer's state [uid]: #uid #### [uid] -Type: **string** +Type: **string** + @@ -160,7 +173,8 @@ Customer's state [vatId]: #vatid #### [vatId] Customer's VAT ID -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Request_AccountFunded/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Request_AccountFunded/_index.md index 4fa940d261..6236b8c228 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Request_AccountFunded/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Request_AccountFunded/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Proof of concept request using the account team funding model. Note that proof of concept account request are available only to internal IBM employees. @@ -50,7 +52,8 @@ Proof of concept request using the account team funding model. Note that proof o [amount]: #amount #### [amount] Dollar amount of funding requested for the proof of concept period -Type: **float** +Type: **float** + @@ -60,7 +63,8 @@ Dollar amount of funding requested for the proof of concept period [costRecoveryRequest]: #costrecoveryrequest #### [costRecoveryRequest] Billing codes for the department paying for the proof of concept account -Type: **SoftLayer_Container_Account_ProofOfConcept_Request_CostRecovery ** +Type: **SoftLayer_Container_Account_ProofOfConcept_Request_CostRecovery ** + @@ -70,7 +74,8 @@ Billing codes for the department paying for the proof of concept account [customer]: #customer #### [customer] Customer intended to take over ownership and and billing of the account -Type: **SoftLayer_Container_Account_ProofOfConcept_Contact_Customer ** +Type: **SoftLayer_Container_Account_ProofOfConcept_Contact_Customer ** + @@ -80,7 +85,8 @@ Customer intended to take over ownership and and billing of the account [description]: #description #### [description] Explanation of the purpose of the proof of concept request -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ Explanation of the purpose of the proof of concept request [endDate]: #enddate #### [endDate] End date for the proof of concept period -Type: **dateTime** +Type: **dateTime** + @@ -100,7 +107,8 @@ End date for the proof of concept period [opportunity]: #opportunity #### [opportunity] Internal opportunity system details -Type: **SoftLayer_Container_Account_ProofOfConcept_Request_Opportunity ** +Type: **SoftLayer_Container_Account_ProofOfConcept_Request_Opportunity ** + @@ -110,7 +118,8 @@ Internal opportunity system details [projectName]: #projectname #### [projectName] Name of the project or company and will become the account companyName -Type: **string** +Type: **string** + @@ -120,7 +129,8 @@ Name of the project or company and will become the account companyName [regionKeyName]: #regionkeyname #### [regionKeyName] IBM region responsible for overseeing the proof of concept account -Type: **string** +Type: **string** + @@ -130,7 +140,8 @@ IBM region responsible for overseeing the proof of concept account [requester]: #requester #### [requester] IBMer requesting the proof of concept account -Type: **SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Requester ** +Type: **SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Requester ** + @@ -140,7 +151,8 @@ IBMer requesting the proof of concept account [startDate]: #startdate #### [startDate] Start date for the proof of concept period -Type: **dateTime** +Type: **dateTime** + @@ -150,7 +162,8 @@ Start date for the proof of concept period [technicalContact]: #technicalcontact #### [technicalContact] IBMer assisting with technical aspects of account configuration -Type: **SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Technical ** +Type: **SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Technical ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Request_CostRecovery/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Request_CostRecovery/_index.md index 1cdd6f60e1..e2394b823d 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Request_CostRecovery/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Request_CostRecovery/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Funding codes for the department paying for the proof of concept account. @@ -50,7 +52,8 @@ Funding codes for the department paying for the proof of concept account. [countryCode]: #countrycode #### [countryCode] Internal billing system country code -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ Internal billing system country code [departmentCode]: #departmentcode #### [departmentCode] Customer's Internal billing system department code -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ Customer's Internal billing system department code [divisionCode]: #divisioncode #### [divisionCode] Internal billing system division code -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Request_GlobalFunded/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Request_GlobalFunded/_index.md index 9c6aaa55df..28d13e82b1 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Request_GlobalFunded/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Request_GlobalFunded/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Proof of concept request using the global funding model. Note that proof of concept account request are available only to internal IBM employees. @@ -50,7 +52,8 @@ Proof of concept request using the global funding model. Note that proof of conc [amount]: #amount #### [amount] Dollar amount of funding requested for the proof of concept period -Type: **float** +Type: **float** + @@ -60,7 +63,8 @@ Dollar amount of funding requested for the proof of concept period [customer]: #customer #### [customer] Customer intended to take over ownership and and billing of the account -Type: **SoftLayer_Container_Account_ProofOfConcept_Contact_Customer ** +Type: **SoftLayer_Container_Account_ProofOfConcept_Contact_Customer ** + @@ -70,7 +74,8 @@ Customer intended to take over ownership and and billing of the account [description]: #description #### [description] Explanation of the purpose of the proof of concept request -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ Explanation of the purpose of the proof of concept request [endDate]: #enddate #### [endDate] End date for the proof of concept period -Type: **dateTime** +Type: **dateTime** + @@ -90,7 +96,8 @@ End date for the proof of concept period [opportunity]: #opportunity #### [opportunity] Internal opportunity system details -Type: **SoftLayer_Container_Account_ProofOfConcept_Request_Opportunity ** +Type: **SoftLayer_Container_Account_ProofOfConcept_Request_Opportunity ** + @@ -100,7 +107,8 @@ Internal opportunity system details [projectName]: #projectname #### [projectName] Name of the project or company and will become the account companyName -Type: **string** +Type: **string** + @@ -110,7 +118,8 @@ Name of the project or company and will become the account companyName [regionKeyName]: #regionkeyname #### [regionKeyName] IBM region responsible for overseeing the proof of concept account -Type: **string** +Type: **string** + @@ -120,7 +129,8 @@ IBM region responsible for overseeing the proof of concept account [requester]: #requester #### [requester] IBMer requesting the proof of concept account -Type: **SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Requester ** +Type: **SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Requester ** + @@ -130,7 +140,8 @@ IBMer requesting the proof of concept account [startDate]: #startdate #### [startDate] Start date for the proof of concept period -Type: **dateTime** +Type: **dateTime** + @@ -140,7 +151,8 @@ Start date for the proof of concept period [technicalContact]: #technicalcontact #### [technicalContact] IBMer assisting with technical aspects of account configuration -Type: **SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Technical ** +Type: **SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Technical ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Request_Opportunity/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Request_Opportunity/_index.md index 7c03f64a33..44f5ddc24a 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Request_Opportunity/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Request_Opportunity/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Internal IBM opportunity codes required when applying for a Proof of Concept account. @@ -51,7 +53,8 @@ Internal IBM opportunity codes required when applying for a Proof of Concept acc [campaignCode]: #campaigncode #### [campaignCode] The campaign or promotion code for this request, provided by Sales. -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ The campaign or promotion code for this request, provided by Sales. [monthlyRecurringRevenue]: #monthlyrecurringrevenue #### [monthlyRecurringRevenue] Expected monthly revenue. -Type: **decimal** +Type: **decimal** + @@ -71,7 +75,8 @@ Expected monthly revenue. [opportunityNumber]: #opportunitynumber #### [opportunityNumber] Internal system identifier. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ Internal system identifier. [totalContractValue]: #totalcontractvalue #### [totalContractValue] Expected overall contract value. -Type: **decimal** +Type: **decimal** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Review/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Review/_index.md index 8801085c0b..52c5234b82 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Review/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Review/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ Full details presented to reviewers when determining whether or not to accept a [accountType]: #accounttype #### [accountType] Type of brand the account will use -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ Type of brand the account will use [costRecoveryCodes]: #costrecoverycodes #### [costRecoveryCodes] Internal billing codes -Type: **SoftLayer_Container_Account_ProofOfConcept_Request_CostRecovery ** +Type: **SoftLayer_Container_Account_ProofOfConcept_Request_CostRecovery ** + @@ -70,7 +74,8 @@ Internal billing codes [customer]: #customer #### [customer] Customer intended to take over billing after the proof of concept period -Type: **SoftLayer_Container_Account_ProofOfConcept_Contact_Customer ** +Type: **SoftLayer_Container_Account_ProofOfConcept_Contact_Customer ** + @@ -80,7 +85,8 @@ Customer intended to take over billing after the proof of concept period [description]: #description #### [description] Describes the purpose and rationale of the request -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ Describes the purpose and rationale of the request [endDate]: #enddate #### [endDate] Expected end date of the proof of concept period -Type: **dateTime** +Type: **dateTime** + @@ -100,7 +107,8 @@ Expected end date of the proof of concept period [fundingAmount]: #fundingamount #### [fundingAmount] Dollar amount of funding requested -Type: **float** +Type: **float** + @@ -110,7 +118,8 @@ Dollar amount of funding requested [fundingType]: #fundingtype #### [fundingType] Funding option chosen for the request -Type: **string** +Type: **string** + @@ -120,7 +129,8 @@ Funding option chosen for the request [id]: #id #### [id] System id of the request -Type: **integer** +Type: **integer** + @@ -130,7 +140,8 @@ System id of the request [iotLeadName]: #iotleadname #### [iotLeadName] Name of the integrated offering team lead reviewing the request -Type: **string** +Type: **string** + @@ -140,7 +151,8 @@ Name of the integrated offering team lead reviewing the request [iotRegionName]: #iotregionname #### [iotRegionName] Name of the integrated offering team region -Type: **string** +Type: **string** + @@ -150,7 +162,8 @@ Name of the integrated offering team region [managerName]: #managername #### [managerName] Name of requesting IBMer's manager -Type: **string** +Type: **string** + @@ -160,7 +173,8 @@ Name of requesting IBMer's manager [opportunity]: #opportunity #### [opportunity] Internal opportunity tracking information -Type: **SoftLayer_Container_Account_ProofOfConcept_Request_Opportunity ** +Type: **SoftLayer_Container_Account_ProofOfConcept_Request_Opportunity ** + @@ -170,7 +184,8 @@ Internal opportunity tracking information [projectName]: #projectname #### [projectName] Project name chosen by the requesting IBMer -Type: **string** +Type: **string** + @@ -180,7 +195,8 @@ Project name chosen by the requesting IBMer [requester]: #requester #### [requester] IBMer requesting the account on behalf of a customer -Type: **SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Requester ** +Type: **SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Requester ** + @@ -190,7 +206,8 @@ IBMer requesting the account on behalf of a customer [reviewHistory]: #reviewhistory #### [reviewHistory] Summary of request's review activity -Type: **SoftLayer_Container_Account_ProofOfConcept_Review_History ** +Type: **SoftLayer_Container_Account_ProofOfConcept_Review_History ** + @@ -200,7 +217,8 @@ Summary of request's review activity [reviewUrl]: #reviewurl #### [reviewUrl] URL for the individual review -Type: **string** +Type: **string** + @@ -210,7 +228,8 @@ URL for the individual review [startDate]: #startdate #### [startDate] Expected start date of the proof of concept period -Type: **dateTime** +Type: **dateTime** + @@ -220,7 +239,8 @@ Expected start date of the proof of concept period [technicalContact]: #technicalcontact #### [technicalContact] Additional IBMer responsible for configuring the cloud capabilities -Type: **SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Technical ** +Type: **SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Technical ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Review_Event/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Review_Event/_index.md index fd9c948796..0f9ff514e1 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Review_Event/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Review_Event/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Review event within proof of concept request review period. @@ -45,7 +47,8 @@ Review event within proof of concept request review period. [description]: #description #### [description] Explanation of the event. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Explanation of the event. [reviewerEmail]: #revieweremail #### [reviewerEmail] Reviewer's email address. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Reviewer's email address. [reviewerUid]: #revieweruid #### [reviewerUid] Reviewer's BluePages UID. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Review_History/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Review_History/_index.md index 1afc9daa8c..3591106684 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Review_History/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Review_History/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Summary of review activity for a proof of concept request. @@ -45,7 +47,8 @@ Summary of review activity for a proof of concept request. [accountCreatedFlag]: #accountcreatedflag #### [accountCreatedFlag] True for approved requests associated with a new account and false otherwise. -Type: **boolean** +Type: **boolean** + @@ -55,7 +58,8 @@ True for approved requests associated with a new account and false otherwise. [deniedFlag]: #deniedflag #### [deniedFlag] True for denied requests and false otherwise. -Type: **boolean** +Type: **boolean** + @@ -65,7 +69,8 @@ True for denied requests and false otherwise. [events]: #events #### [events] List of events occurring during the review. -Type: **SoftLayer_Container_Account_ProofOfConcept_Review_Event[] ** +Type: **SoftLayer_Container_Account_ProofOfConcept_Review_Event[] ** + @@ -75,7 +80,8 @@ List of events occurring during the review. [reviewCompleteFlag]: #reviewcompleteflag #### [reviewCompleteFlag] True for fully reviewed requests and false otherwise. -Type: **boolean** +Type: **boolean** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Review_Summary/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Review_Summary/_index.md index 3e054f84f0..771f8c0074 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Review_Summary/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Review_Summary/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ Summary presented to reviewers when determining whether or not to accept a proof [accountName]: #accountname #### [accountName] Account's companyName -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ Account's companyName [accountOwnerName]: #accountownername #### [accountOwnerName] Current account owner -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ Current account owner [amount]: #amount #### [amount] Dollar amount requested -Type: **float** +Type: **float** + @@ -80,7 +85,8 @@ Dollar amount requested [createDate]: #createdate #### [createDate] Date the request was submitted -Type: **dateTime** +Type: **dateTime** + @@ -90,7 +96,8 @@ Date the request was submitted [customerEmail]: #customeremail #### [customerEmail] Email of the customer receiving the proof of concept account -Type: **string** +Type: **string** + @@ -100,7 +107,8 @@ Email of the customer receiving the proof of concept account [customerName]: #customername #### [customerName] Name of the customer receiving the proof of concept account -Type: **string** +Type: **string** + @@ -110,7 +118,8 @@ Name of the customer receiving the proof of concept account [id]: #id #### [id] Request record's id -Type: **integer** +Type: **integer** + @@ -120,7 +129,8 @@ Request record's id [lastUpdate]: #lastupdate #### [lastUpdate] Date of the last state change on the request -Type: **dateTime** +Type: **dateTime** + @@ -130,7 +140,8 @@ Date of the last state change on the request [nextApproverEmail]: #nextapproveremail #### [nextApproverEmail] Email address of the reviewer, if any, currently reviewing the request -Type: **string** +Type: **string** + @@ -140,7 +151,8 @@ Email address of the reviewer, if any, currently reviewing the request [requesterEmail]: #requesteremail #### [requesterEmail] Email address of the requester -Type: **string** +Type: **string** + @@ -150,7 +162,8 @@ Email address of the requester [requesterName]: #requestername #### [requesterName] Requesting IBMer's full name -Type: **string** +Type: **string** + @@ -160,7 +173,8 @@ Requesting IBMer's full name [reviewUrl]: #reviewurl #### [reviewUrl] URL for the individual review -Type: **string** +Type: **string** + @@ -170,7 +184,8 @@ URL for the individual review [status]: #status #### [status] Request's current status (Pending, Denied, or Approved) -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Account_Update_Response/_index.md b/content/reference/datatypes/SoftLayer_Container_Account_Update_Response/_index.md index 276dbd27d1..574a15bcf6 100644 --- a/content/reference/datatypes/SoftLayer_Container_Account_Update_Response/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Account_Update_Response/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Contains data related to an account after editing its information. @@ -50,7 +52,8 @@ Contains data related to an account after editing its information. [acceptedFlag]: #acceptedflag #### [acceptedFlag] Whether or not the update was accepted and applied. -Type: **boolean** +Type: **boolean** + @@ -60,7 +63,8 @@ Whether or not the update was accepted and applied. [account]: #account #### [account] The updated SoftLayer_Account. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -70,7 +74,8 @@ The updated SoftLayer_Account. [ticket]: #ticket #### [ticket] If a manual review is required, this will be populated with the SoftLayer_Ticket for that review. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Common/_index.md b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Common/_index.md index 460ae7cf8c..f28f073b8a 100644 --- a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Common/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Common/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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). @@ -45,7 +47,8 @@ The SoftLayer_Container_Authentication_Request_Common data type contains common [securityQuestionAnswer]: #securityquestionanswer #### [securityQuestionAnswer] The answer to your security question. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The answer to your security question. [securityQuestionId]: #securityquestionid #### [securityQuestionId] A security question you wish to answer when authenticating to the SoftLayer customer portal. This parameter isn't required if no security questions are set on your portal account or if your account is configured to not require answering a security account upon login. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Contract/_index.md b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Contract/_index.md index c00a1b0960..8a2e5b6792 100644 --- a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Contract/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Contract/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Authentication_Request_Contract provides a common set of operations for implementing classes. diff --git a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Native/_index.md b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Native/_index.md index 5be8b790cc..012c8bdd95 100644 --- a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Native/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Native/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Container_Authentication_Request_Native data type contains informa [auxiliaryClaimsMiniToken]: #auxiliaryclaimsminitoken #### [auxiliaryClaimsMiniToken] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The SoftLayer_Container_Authentication_Request_Native data type contains informa [password]: #password #### [password] Your SoftLayer customer portal user's portal password. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Your SoftLayer customer portal user's portal password. [securityQuestionAnswer]: #securityquestionanswer #### [securityQuestionAnswer] The answer to your security question. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The answer to your security question. [securityQuestionId]: #securityquestionid #### [securityQuestionId] A security question you wish to answer when authenticating to the SoftLayer customer portal. This parameter isn't required if no security questions are set on your portal account or if your account is configured to not require answering a security account upon login. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ A security question you wish to answer when authenticating to the SoftLayer cust [username]: #username #### [username] The username you wish to authenticate to the SoftLayer customer portal with. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Native_External/_index.md b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Native_External/_index.md index e7b44aa8b1..0a26f944d1 100644 --- a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Native_External/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Native_External/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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). @@ -45,7 +47,8 @@ The SoftLayer_Container_Authentication_Request_Native_External data type contain [auxiliaryClaimsMiniToken]: #auxiliaryclaimsminitoken #### [auxiliaryClaimsMiniToken] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The SoftLayer_Container_Authentication_Request_Native_External data type contain [password]: #password #### [password] Your SoftLayer customer portal user's portal password. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Your SoftLayer customer portal user's portal password. [securityQuestionAnswer]: #securityquestionanswer #### [securityQuestionAnswer] The answer to your security question. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The answer to your security question. [securityQuestionId]: #securityquestionid #### [securityQuestionId] A security question you wish to answer when authenticating to the SoftLayer customer portal. This parameter isn't required if no security questions are set on your portal account or if your account is configured to not require answering a security account upon login. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ A security question you wish to answer when authenticating to the SoftLayer cust [username]: #username #### [username] The username you wish to authenticate to the SoftLayer customer portal with. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Native_External_Totp/_index.md b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Native_External_Totp/_index.md index 14c83cc615..141e301278 100644 --- a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Native_External_Totp/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Native_External_Totp/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Container_Authentication_Request_Native_External_Totp data type co [auxiliaryClaimsMiniToken]: #auxiliaryclaimsminitoken #### [auxiliaryClaimsMiniToken] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The SoftLayer_Container_Authentication_Request_Native_External_Totp data type co [password]: #password #### [password] Your SoftLayer customer portal user's portal password. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Your SoftLayer customer portal user's portal password. [secondSecurityCode]: #secondsecuritycode #### [secondSecurityCode] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Your SoftLayer customer portal user's portal password. [securityCode]: #securitycode #### [securityCode] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ Your SoftLayer customer portal user's portal password. [securityQuestionAnswer]: #securityquestionanswer #### [securityQuestionAnswer] The answer to your security question. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The answer to your security question. [securityQuestionId]: #securityquestionid #### [securityQuestionId] A security question you wish to answer when authenticating to the SoftLayer customer portal. This parameter isn't required if no security questions are set on your portal account or if your account is configured to not require answering a security account upon login. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ A security question you wish to answer when authenticating to the SoftLayer cust [username]: #username #### [username] The username you wish to authenticate to the SoftLayer customer portal with. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The username you wish to authenticate to the SoftLayer customer portal with. [vendor]: #vendor #### [vendor] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Native_External_Verisign/_index.md b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Native_External_Verisign/_index.md index 4d76537eef..d1a9713840 100644 --- a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Native_External_Verisign/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_Native_External_Verisign/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Container_Authentication_Request_Native_External_Verisign data typ [auxiliaryClaimsMiniToken]: #auxiliaryclaimsminitoken #### [auxiliaryClaimsMiniToken] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The SoftLayer_Container_Authentication_Request_Native_External_Verisign data typ [password]: #password #### [password] Your SoftLayer customer portal user's portal password. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Your SoftLayer customer portal user's portal password. [secondSecurityCode]: #secondsecuritycode #### [secondSecurityCode] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Your SoftLayer customer portal user's portal password. [securityCode]: #securitycode #### [securityCode] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ Your SoftLayer customer portal user's portal password. [securityQuestionAnswer]: #securityquestionanswer #### [securityQuestionAnswer] The answer to your security question. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The answer to your security question. [securityQuestionId]: #securityquestionid #### [securityQuestionId] A security question you wish to answer when authenticating to the SoftLayer customer portal. This parameter isn't required if no security questions are set on your portal account or if your account is configured to not require answering a security account upon login. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ A security question you wish to answer when authenticating to the SoftLayer cust [username]: #username #### [username] The username you wish to authenticate to the SoftLayer customer portal with. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The username you wish to authenticate to the SoftLayer customer portal with. [vendor]: #vendor #### [vendor] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_OpenIdConnect/_index.md b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_OpenIdConnect/_index.md index 056c8caea7..bb187e038c 100644 --- a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_OpenIdConnect/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_OpenIdConnect/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect data type contains [openIdConnectAccessToken]: #openidconnectaccesstoken #### [openIdConnectAccessToken] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect data type contains [openIdConnectAccountId]: #openidconnectaccountid #### [openIdConnectAccountId] -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect data type contains [openIdConnectProvider]: #openidconnectprovider #### [openIdConnectProvider] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect data type contains [securityQuestionAnswer]: #securityquestionanswer #### [securityQuestionAnswer] The answer to your security question. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The answer to your security question. [securityQuestionId]: #securityquestionid #### [securityQuestionId] A security question you wish to answer when authenticating to the SoftLayer customer portal. This parameter isn't required if no security questions are set on your portal account or if your account is configured to not require answering a security account upon login. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_OpenIdConnect_External/_index.md b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_OpenIdConnect_External/_index.md index dc2fe7bf97..c7b907a4a5 100644 --- a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_OpenIdConnect_External/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_OpenIdConnect_External/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect_External data type [openIdConnectAccessToken]: #openidconnectaccesstoken #### [openIdConnectAccessToken] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect_External data type [openIdConnectAccountId]: #openidconnectaccountid #### [openIdConnectAccountId] -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect_External data type [openIdConnectProvider]: #openidconnectprovider #### [openIdConnectProvider] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect_External data type [securityQuestionAnswer]: #securityquestionanswer #### [securityQuestionAnswer] The answer to your security question. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The answer to your security question. [securityQuestionId]: #securityquestionid #### [securityQuestionId] A security question you wish to answer when authenticating to the SoftLayer customer portal. This parameter isn't required if no security questions are set on your portal account or if your account is configured to not require answering a security account upon login. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Totp/_index.md b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Totp/_index.md index fd2b859fc9..c3a90f2ac7 100644 --- a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Totp/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Totp/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Totp data [openIdConnectAccessToken]: #openidconnectaccesstoken #### [openIdConnectAccessToken] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Totp data [openIdConnectAccountId]: #openidconnectaccountid #### [openIdConnectAccountId] -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Totp data [openIdConnectProvider]: #openidconnectprovider #### [openIdConnectProvider] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Totp data [secondSecurityCode]: #secondsecuritycode #### [secondSecurityCode] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Totp data [securityCode]: #securitycode #### [securityCode] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Totp data [securityQuestionAnswer]: #securityquestionanswer #### [securityQuestionAnswer] The answer to your security question. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The answer to your security question. [securityQuestionId]: #securityquestionid #### [securityQuestionId] A security question you wish to answer when authenticating to the SoftLayer customer portal. This parameter isn't required if no security questions are set on your portal account or if your account is configured to not require answering a security account upon login. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A security question you wish to answer when authenticating to the SoftLayer cust [vendor]: #vendor #### [vendor] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Verisign/_index.md b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Verisign/_index.md index f0e6906c01..7cc4c2440b 100644 --- a/content/reference/datatypes/SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Verisign/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Verisign/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Verisign d [openIdConnectAccessToken]: #openidconnectaccesstoken #### [openIdConnectAccessToken] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Verisign d [openIdConnectAccountId]: #openidconnectaccountid #### [openIdConnectAccountId] -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Verisign d [openIdConnectProvider]: #openidconnectprovider #### [openIdConnectProvider] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Verisign d [secondSecurityCode]: #secondsecuritycode #### [secondSecurityCode] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Verisign d [securityCode]: #securitycode #### [securityCode] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Verisign d [securityQuestionAnswer]: #securityquestionanswer #### [securityQuestionAnswer] The answer to your security question. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The answer to your security question. [securityQuestionId]: #securityquestionid #### [securityQuestionId] A security question you wish to answer when authenticating to the SoftLayer customer portal. This parameter isn't required if no security questions are set on your portal account or if your account is configured to not require answering a security account upon login. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A security question you wish to answer when authenticating to the SoftLayer cust [vendor]: #vendor #### [vendor] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Authentication_Response_2FactorAuthenticationNeeded/_index.md b/content/reference/datatypes/SoftLayer_Container_Authentication_Response_2FactorAuthenticationNeeded/_index.md index c35aba5fda..16689a3356 100644 --- a/content/reference/datatypes/SoftLayer_Container_Authentication_Response_2FactorAuthenticationNeeded/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Authentication_Response_2FactorAuthenticationNeeded/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Container_Authentication_Response_2FactorAuthenticationNeeded data [accounts]: #accounts #### [accounts] The list of linked accounts for the authenticated SoftLayer customer portal user. -Type: **SoftLayer_Container_Authentication_Response_Account[] ** +Type: **SoftLayer_Container_Authentication_Response_Account[] ** + @@ -55,7 +58,8 @@ The list of linked accounts for the authenticated SoftLayer customer portal user [additionalData]: #additionaldata #### [additionalData] -Type: **SoftLayer_Container_Authentication_Response_Common ** +Type: **SoftLayer_Container_Authentication_Response_Common ** + @@ -65,7 +69,8 @@ The list of linked accounts for the authenticated SoftLayer customer portal user [statusKeyName]: #statuskeyname #### [statusKeyName] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Authentication_Response_Account/_index.md b/content/reference/datatypes/SoftLayer_Container_Authentication_Response_Account/_index.md index baa0dd0d84..014ff27347 100644 --- a/content/reference/datatypes/SoftLayer_Container_Authentication_Response_Account/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Authentication_Response_Account/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Authentication_Response_Account data type contains account information for responses from the getPortalLogin API. @@ -45,7 +47,8 @@ The SoftLayer_Container_Authentication_Response_Account data type contains accou [accountCompanyName]: #accountcompanyname #### [accountCompanyName] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The SoftLayer_Container_Authentication_Response_Account data type contains accou [accountCountry]: #accountcountry #### [accountCountry] -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The SoftLayer_Container_Authentication_Response_Account data type contains accou [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The SoftLayer_Container_Authentication_Response_Account data type contains accou [accountStatusName]: #accountstatusname #### [accountStatusName] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The SoftLayer_Container_Authentication_Response_Account data type contains accou [bluemixAccountId]: #bluemixaccountid #### [bluemixAccountId] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The SoftLayer_Container_Authentication_Response_Account data type contains accou [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ The SoftLayer_Container_Authentication_Response_Account data type contains accou [defaultAccount]: #defaultaccount #### [defaultAccount] -Type: **boolean** +Type: **boolean** + @@ -115,7 +124,8 @@ The SoftLayer_Container_Authentication_Response_Account data type contains accou [ipAddressCheckRequired]: #ipaddresscheckrequired #### [ipAddressCheckRequired] -Type: **boolean** +Type: **boolean** + @@ -125,7 +135,8 @@ The SoftLayer_Container_Authentication_Response_Account data type contains accou [isMasterUserFlag]: #ismasteruserflag #### [isMasterUserFlag] -Type: **boolean** +Type: **boolean** + @@ -135,7 +146,8 @@ The SoftLayer_Container_Authentication_Response_Account data type contains accou [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -145,7 +157,8 @@ The SoftLayer_Container_Authentication_Response_Account data type contains accou [phoneFactorExternalAuthenticationRequired]: #phonefactorexternalauthenticationrequired #### [phoneFactorExternalAuthenticationRequired] -Type: **boolean** +Type: **boolean** + @@ -155,7 +168,8 @@ The SoftLayer_Container_Authentication_Response_Account data type contains accou [securityQuestionRequired]: #securityquestionrequired #### [securityQuestionRequired] -Type: **boolean** +Type: **boolean** + @@ -165,7 +179,8 @@ The SoftLayer_Container_Authentication_Response_Account data type contains accou [totpExternalAuthenticationRequired]: #totpexternalauthenticationrequired #### [totpExternalAuthenticationRequired] -Type: **boolean** +Type: **boolean** + @@ -175,7 +190,8 @@ The SoftLayer_Container_Authentication_Response_Account data type contains accou [userId]: #userid #### [userId] -Type: **integer** +Type: **integer** + @@ -185,7 +201,8 @@ The SoftLayer_Container_Authentication_Response_Account data type contains accou [verisignExternalAuthenticationRequired]: #verisignexternalauthenticationrequired #### [verisignExternalAuthenticationRequired] -Type: **boolean** +Type: **boolean** + diff --git a/content/reference/datatypes/SoftLayer_Container_Authentication_Response_AccountIdMissing/_index.md b/content/reference/datatypes/SoftLayer_Container_Authentication_Response_AccountIdMissing/_index.md index 97cd4c1b2b..86e71cd6ec 100644 --- a/content/reference/datatypes/SoftLayer_Container_Authentication_Response_AccountIdMissing/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Authentication_Response_AccountIdMissing/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Container_Authentication_Response_AccountIdMissing data type conta [accounts]: #accounts #### [accounts] The list of linked accounts for the authenticated SoftLayer customer portal user. -Type: **SoftLayer_Container_Authentication_Response_Account[] ** +Type: **SoftLayer_Container_Authentication_Response_Account[] ** + @@ -55,7 +58,8 @@ The list of linked accounts for the authenticated SoftLayer customer portal user [statusKeyName]: #statuskeyname #### [statusKeyName] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Authentication_Response_Common/_index.md b/content/reference/datatypes/SoftLayer_Container_Authentication_Response_Common/_index.md index 93e97835f9..07a77773fa 100644 --- a/content/reference/datatypes/SoftLayer_Container_Authentication_Response_Common/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Authentication_Response_Common/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Container_Authentication_Response_Common data type contains common [accounts]: #accounts #### [accounts] The list of linked accounts for the authenticated SoftLayer customer portal user. -Type: **SoftLayer_Container_Authentication_Response_Account[] ** +Type: **SoftLayer_Container_Authentication_Response_Account[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Authentication_Response_IpAddressRestrictionCheckNeeded/_index.md b/content/reference/datatypes/SoftLayer_Container_Authentication_Response_IpAddressRestrictionCheckNeeded/_index.md index e83b04c8d4..d6615876d4 100644 --- a/content/reference/datatypes/SoftLayer_Container_Authentication_Response_IpAddressRestrictionCheckNeeded/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Authentication_Response_IpAddressRestrictionCheckNeeded/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Container_Authentication_Response_IpAddressRestrictionCheckNeeded [accounts]: #accounts #### [accounts] The list of linked accounts for the authenticated SoftLayer customer portal user. -Type: **SoftLayer_Container_Authentication_Response_Account[] ** +Type: **SoftLayer_Container_Authentication_Response_Account[] ** + @@ -55,7 +58,8 @@ The list of linked accounts for the authenticated SoftLayer customer portal user [statusKeyName]: #statuskeyname #### [statusKeyName] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Authentication_Response_LoginFailed/_index.md b/content/reference/datatypes/SoftLayer_Container_Authentication_Response_LoginFailed/_index.md index fd95b1e1a6..7f83b4b643 100644 --- a/content/reference/datatypes/SoftLayer_Container_Authentication_Response_LoginFailed/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Authentication_Response_LoginFailed/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Container_Authentication_Response_LOGIN_FAILED data type contains [accounts]: #accounts #### [accounts] The list of linked accounts for the authenticated SoftLayer customer portal user. -Type: **SoftLayer_Container_Authentication_Response_Account[] ** +Type: **SoftLayer_Container_Authentication_Response_Account[] ** + @@ -55,7 +58,8 @@ The list of linked accounts for the authenticated SoftLayer customer portal user [errorMessage]: #errormessage #### [errorMessage] -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The list of linked accounts for the authenticated SoftLayer customer portal user [statusKeyName]: #statuskeyname #### [statusKeyName] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Authentication_Response_Success/_index.md b/content/reference/datatypes/SoftLayer_Container_Authentication_Response_Success/_index.md index d8bbe777dd..50c2775c4c 100644 --- a/content/reference/datatypes/SoftLayer_Container_Authentication_Response_Success/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Authentication_Response_Success/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Container_Authentication_Response_SUCCESS data type contains infor [accounts]: #accounts #### [accounts] The list of linked accounts for the authenticated SoftLayer customer portal user. -Type: **SoftLayer_Container_Authentication_Response_Account[] ** +Type: **SoftLayer_Container_Authentication_Response_Account[] ** + @@ -55,7 +58,8 @@ The list of linked accounts for the authenticated SoftLayer customer portal user [statusKeyName]: #statuskeyname #### [statusKeyName] -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The list of linked accounts for the authenticated SoftLayer customer portal user [token]: #token #### [token] The token for interacting with the SoftLayer customer portal. -Type: **SoftLayer_Container_User_Authentication_Token ** +Type: **SoftLayer_Container_User_Authentication_Token ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Auxiliary_Network_Status_Reading/_index.md b/content/reference/datatypes/SoftLayer_Container_Auxiliary_Network_Status_Reading/_index.md index 56a5e5b5a3..f86ceed5d4 100644 --- a/content/reference/datatypes/SoftLayer_Container_Auxiliary_Network_Status_Reading/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Auxiliary_Network_Status_Reading/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Auxiliary_Network_Status_Reading data type contains information relating to an object being monitored from outside the SoftLayer network. It is primarily used to check the status of our edge routers from multiple locations around the world. @@ -50,7 +52,8 @@ The SoftLayer_Container_Auxiliary_Network_Status_Reading data type contains info [averagePing]: #averageping #### [averagePing] Average packet round-trip time. -Type: **float** +Type: **float** + @@ -60,7 +63,8 @@ Average packet round-trip time. [fails]: #fails #### [fails] Number of failures since the target was last detected to be working properly. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ Number of failures since the target was last detected to be working properly. [frequency]: #frequency #### [frequency] Monitoring frequency in minutes. -Type: **integer** +Type: **integer** + @@ -80,7 +85,8 @@ Monitoring frequency in minutes. [label]: #label #### [label] The target babel. -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ The target babel. [lastCheckDate]: #lastcheckdate #### [lastCheckDate] Last check date and time. -Type: **dateTime** +Type: **dateTime** + @@ -100,7 +107,8 @@ Last check date and time. [lastDownDate]: #lastdowndate #### [lastDownDate] Date and time of the last problem detected. -Type: **dateTime** +Type: **dateTime** + @@ -110,7 +118,8 @@ Date and time of the last problem detected. [latency]: #latency #### [latency] The total response time in seconds calculated during the last check. -Type: **float** +Type: **float** + @@ -120,7 +129,8 @@ The total response time in seconds calculated during the last check. [location]: #location #### [location] The monitoring location name. -Type: **string** +Type: **string** + @@ -130,7 +140,8 @@ The monitoring location name. [maximumPing]: #maximumping #### [maximumPing] Maximum packet round-trip time. -Type: **float** +Type: **float** + @@ -140,7 +151,8 @@ Maximum packet round-trip time. [minimumPing]: #minimumping #### [minimumPing] Minimum packet round-trip time. -Type: **float** +Type: **float** + @@ -150,7 +162,8 @@ Minimum packet round-trip time. [pingLoss]: #pingloss #### [pingLoss] Packet loss percentage. -Type: **float** +Type: **float** + @@ -160,7 +173,8 @@ Packet loss percentage. [startDate]: #startdate #### [startDate] The date monitoring first began -Type: **dateTime** +Type: **dateTime** + @@ -170,7 +184,8 @@ The date monitoring first began [statusCode]: #statuscode #### [statusCode] Status Code - one of UP, Down, Test pending. -Type: **string** +Type: **string** + @@ -180,7 +195,8 @@ Status Code - one of UP, Down, Test pending. [statusMessage]: #statusmessage #### [statusMessage] The status message from the last effective check. -Type: **string** +Type: **string** + @@ -190,7 +206,8 @@ The status message from the last effective check. [target]: #target #### [target] The target object. -Type: **string** +Type: **string** + @@ -200,7 +217,8 @@ The target object. [targetType]: #targettype #### [targetType] A letter indicating the target type. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Bandwidth_GraphInputs/_index.md b/content/reference/datatypes/SoftLayer_Container_Bandwidth_GraphInputs/_index.md index c7c80ee52d..1404121cfd 100644 --- a/content/reference/datatypes/SoftLayer_Container_Bandwidth_GraphInputs/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Bandwidth_GraphInputs/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Bandwidth_GraphInputs models a single inbound object for a given bandwidth graph. @@ -50,7 +52,8 @@ SoftLayer_Container_Bandwidth_GraphInputs models a single inbound object for a g [endDate]: #enddate #### [endDate] This is a unix timestamp that represents the stop date/time for a graph. -Type: **dateTime** +Type: **dateTime** + @@ -60,7 +63,8 @@ This is a unix timestamp that represents the stop date/time for a graph. [networkInterfaceId]: #networkinterfaceid #### [networkInterfaceId] The front-end or back-end network uplink interface associated with this server. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ The front-end or back-end network uplink interface associated with this server. [pod]: #pod #### [pod] * -Type: **integer** +Type: **integer** + @@ -80,7 +85,8 @@ The front-end or back-end network uplink interface associated with this server. [serverName]: #servername #### [serverName] This is a human readable name for the server or rack being graphed. -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ This is a human readable name for the server or rack being graphed. [startDate]: #startdate #### [startDate] This is a unix timestamp that represents the begin date/time for a graph. -Type: **dateTime** +Type: **dateTime** + diff --git a/content/reference/datatypes/SoftLayer_Container_Bandwidth_GraphOutputs/_index.md b/content/reference/datatypes/SoftLayer_Container_Bandwidth_GraphOutputs/_index.md index ba8e9374dc..380f573be1 100644 --- a/content/reference/datatypes/SoftLayer_Container_Bandwidth_GraphOutputs/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Bandwidth_GraphOutputs/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Bandwidth_GraphOutputs models a single outbound object for a given bandwidth graph. @@ -50,7 +52,8 @@ SoftLayer_Container_Bandwidth_GraphOutputs models a single outbound object for a [graphImage]: #graphimage #### [graphImage] The raw PNG binary data to be displayed once the graph is drawn. -Type: **binary data** +Type: **binary data** + @@ -60,7 +63,8 @@ The raw PNG binary data to be displayed once the graph is drawn. [graphTitle]: #graphtitle #### [graphTitle] The title that ended up being displayed as part of the graph image. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ The title that ended up being displayed as part of the graph image. [maxEndDate]: #maxenddate #### [maxEndDate] The maximum date included in this graph. -Type: **dateTime** +Type: **dateTime** + @@ -80,7 +85,8 @@ The maximum date included in this graph. [minStartDate]: #minstartdate #### [minStartDate] The minimum date included in this graph. -Type: **dateTime** +Type: **dateTime** + diff --git a/content/reference/datatypes/SoftLayer_Container_Bandwidth_GraphOutputsExtended/_index.md b/content/reference/datatypes/SoftLayer_Container_Bandwidth_GraphOutputsExtended/_index.md index a57eb1cbf5..221bd5a50a 100644 --- a/content/reference/datatypes/SoftLayer_Container_Bandwidth_GraphOutputsExtended/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Bandwidth_GraphOutputsExtended/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Bandwidth_GraphOutputs models an individual bandwidth graph image and certain details about that graph image. @@ -55,7 +57,8 @@ SoftLayer_Container_Bandwidth_GraphOutputs models an individual bandwidth graph [graphImage]: #graphimage #### [graphImage] The raw PNG binary data of a bandwidth graph image. -Type: **binary data** +Type: **binary data** + @@ -65,7 +68,8 @@ The raw PNG binary data of a bandwidth graph image. [graphTitle]: #graphtitle #### [graphTitle] A bandwidth graph's title. -Type: **string** +Type: **string** + @@ -75,7 +79,8 @@ A bandwidth graph's title. [inBoundTotalBytes]: #inboundtotalbytes #### [inBoundTotalBytes] The amount of inbound traffic reported on a bandwidth graph image. -Type: **unsigned long** +Type: **unsigned long** + @@ -85,7 +90,8 @@ The amount of inbound traffic reported on a bandwidth graph image. [maxEndDate]: #maxenddate #### [maxEndDate] The ending date of the data represented in a bandwidth graph. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +101,8 @@ The ending date of the data represented in a bandwidth graph. [minStartDate]: #minstartdate #### [minStartDate] The beginning date of the data represented in a bandwidth graph. -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +112,8 @@ The beginning date of the data represented in a bandwidth graph. [outBoundTotalBytes]: #outboundtotalbytes #### [outBoundTotalBytes] The amount of outbound traffic reported on a bandwidth graph image. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Container_Bandwidth_Projection/_index.md b/content/reference/datatypes/SoftLayer_Container_Bandwidth_Projection/_index.md index a28446b53e..f1edc3a530 100644 --- a/content/reference/datatypes/SoftLayer_Container_Bandwidth_Projection/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Bandwidth_Projection/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Bandwidth_Projection models projected bandwidth use over a time range. @@ -50,7 +52,8 @@ SoftLayer_Container_Bandwidth_Projection models projected bandwidth use over a t [allowedUsage]: #allowedusage #### [allowedUsage] Bandwidth limit for this hardware. -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ Bandwidth limit for this hardware. [estimatedUsage]: #estimatedusage #### [estimatedUsage] Estimated bandwidth usage so far this billing cycle. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ Estimated bandwidth usage so far this billing cycle. [hardwareId]: #hardwareid #### [hardwareId] Hardware ID of server to monitor. -Type: **integer** +Type: **integer** + @@ -80,7 +85,8 @@ Hardware ID of server to monitor. [projectedUsage]: #projectedusage #### [projectedUsage] Projected usage for this hardware based on previous usage this billing cycle. -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ Projected usage for this hardware based on previous usage this billing cycle. [serverName]: #servername #### [serverName] the text name of the server being monitored. -Type: **string** +Type: **string** + @@ -100,7 +107,8 @@ the text name of the server being monitored. [startDate]: #startdate #### [startDate] The minimum date included in this list. -Type: **dateTime** +Type: **dateTime** + diff --git a/content/reference/datatypes/SoftLayer_Container_Bandwidth_Usage/_index.md b/content/reference/datatypes/SoftLayer_Container_Bandwidth_Usage/_index.md index d5c076bda3..7fa7badbf5 100644 --- a/content/reference/datatypes/SoftLayer_Container_Bandwidth_Usage/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Bandwidth_Usage/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + When a customer uses SoftLayer_Account::getBandwidthUsage, this container is used to return their usage information in bytes @@ -45,7 +47,8 @@ When a customer uses SoftLayer_Account::getBandwidthUsage, this container is use [endDate]: #enddate #### [endDate] -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ When a customer uses SoftLayer_Account::getBandwidthUsage, this container is use [hardwareId]: #hardwareid #### [hardwareId] -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ When a customer uses SoftLayer_Account::getBandwidthUsage, this container is use [privateInUsage]: #privateinusage #### [privateInUsage] -Type: **float** +Type: **float** + @@ -75,7 +80,8 @@ When a customer uses SoftLayer_Account::getBandwidthUsage, this container is use [privateOutUsage]: #privateoutusage #### [privateOutUsage] -Type: **float** +Type: **float** + @@ -85,7 +91,8 @@ When a customer uses SoftLayer_Account::getBandwidthUsage, this container is use [publicInUsage]: #publicinusage #### [publicInUsage] -Type: **float** +Type: **float** + @@ -95,7 +102,8 @@ When a customer uses SoftLayer_Account::getBandwidthUsage, this container is use [publicOutUsage]: #publicoutusage #### [publicOutUsage] -Type: **float** +Type: **float** + @@ -105,7 +113,8 @@ When a customer uses SoftLayer_Account::getBandwidthUsage, this container is use [startDate]: #startdate #### [startDate] -Type: **dateTime** +Type: **dateTime** + diff --git a/content/reference/datatypes/SoftLayer_Container_Billing_Currency_Country/_index.md b/content/reference/datatypes/SoftLayer_Container_Billing_Currency_Country/_index.md index bb8dd8c054..bfb245da71 100644 --- a/content/reference/datatypes/SoftLayer_Container_Billing_Currency_Country/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Billing_Currency_Country/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [availableCurrencies]: #availablecurrencies #### [availableCurrencies] -Type: **SoftLayer_Billing_Currency[] ** +Type: **SoftLayer_Billing_Currency[] ** +
      @@ -55,7 +58,8 @@ classes: [country]: #country #### [country] -Type: **SoftLayer_Locale_Country ** +Type: **SoftLayer_Locale_Country ** +
      @@ -65,7 +69,8 @@ classes: [currencyCountryLocales]: #currencycountrylocales #### [currencyCountryLocales] -Type: **SoftLayer_Billing_Currency_Country[] ** +Type: **SoftLayer_Billing_Currency_Country[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Billing_Currency_Format/_index.md b/content/reference/datatypes/SoftLayer_Container_Billing_Currency_Format/_index.md index 580448a733..5653ce8002 100644 --- a/content/reference/datatypes/SoftLayer_Container_Billing_Currency_Format/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Billing_Currency_Format/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [currency]: #currency #### [currency] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [display]: #display #### [display] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [format]: #format #### [format] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [locale]: #locale #### [locale] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [position]: #position #### [position] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [precision]: #precision #### [precision] -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ classes: [script]: #script #### [script] -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ classes: [service]: #service #### [service] -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ classes: [symbol]: #symbol #### [symbol] -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ classes: [tag]: #tag #### [tag] -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ classes: [value]: #value #### [value] -Type: **float** +Type: **float** + diff --git a/content/reference/datatypes/SoftLayer_Container_Billing_Info_Ach/_index.md b/content/reference/datatypes/SoftLayer_Container_Billing_Info_Ach/_index.md index c7528332f2..442602c65a 100644 --- a/content/reference/datatypes/SoftLayer_Container_Billing_Info_Ach/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Billing_Info_Ach/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountNumber]: #accountnumber #### [accountNumber] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [accountType]: #accounttype #### [accountType] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [bankTransitNumber]: #banktransitnumber #### [bankTransitNumber] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [city]: #city #### [city] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [country]: #country #### [country] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [federalTaxId]: #federaltaxid #### [federalTaxId] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ classes: [firstName]: #firstname #### [firstName] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [lastName]: #lastname #### [lastName] -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ classes: [phoneNumber]: #phonenumber #### [phoneNumber] -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ classes: [postalCode]: #postalcode #### [postalCode] -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ classes: [state]: #state #### [state] -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ classes: [street1]: #street1 #### [street1] -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ classes: [street2]: #street2 #### [street2] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Billing_Invoice_Email/_index.md b/content/reference/datatypes/SoftLayer_Container_Billing_Invoice_Email/_index.md index e803aaf5f0..be4ca730ca 100644 --- a/content/reference/datatypes/SoftLayer_Container_Billing_Invoice_Email/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Billing_Invoice_Email/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This container is used to provide all the options for [SoftLayer_Billing_Invoice::emailInvoices]({{}}) in order to have the necessary invoices generated and links sent to the user's email. @@ -45,7 +47,8 @@ This container is used to provide all the options for [SoftLayer_Billing_Invoice [excelInvoiceIds]: #excelinvoiceids #### [excelInvoiceIds] Excel Invoices to email -Type: **array of integers** +Type: **array of integers** + @@ -55,7 +58,8 @@ Excel Invoices to email [pdfDetailedInvoiceIds]: #pdfdetailedinvoiceids #### [pdfDetailedInvoiceIds] PDF Invoice Details to email -Type: **array of integers** +Type: **array of integers** + @@ -65,7 +69,8 @@ PDF Invoice Details to email [pdfInvoiceIds]: #pdfinvoiceids #### [pdfInvoiceIds] PDF Invoices to email -Type: **array of integers** +Type: **array of integers** + @@ -75,7 +80,8 @@ PDF Invoices to email [type]: #type #### [type] The type of Invoices to be emailed [current|next]. If next is selected, the account id will be used. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Billing_Order_Status/_index.md b/content/reference/datatypes/SoftLayer_Container_Billing_Order_Status/_index.md index 5dea05ce0f..41365fe9bf 100644 --- a/content/reference/datatypes/SoftLayer_Container_Billing_Order_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Billing_Order_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Billing_Order_Status models an order status. @@ -50,7 +52,8 @@ SoftLayer_Container_Billing_Order_Status models an order status. [description]: #description #### [description] The description of the status. -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ The description of the status. [status]: #status #### [status] The keyname of the status. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Catalyst_ManualEnrollmentRequest/_index.md b/content/reference/datatypes/SoftLayer_Container_Catalyst_ManualEnrollmentRequest/_index.md index 9f45c3810c..75c8d49ffa 100644 --- a/content/reference/datatypes/SoftLayer_Container_Catalyst_ManualEnrollmentRequest/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Catalyst_ManualEnrollmentRequest/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Contains user information used to request a manual Catalyst enrollment. @@ -45,7 +47,8 @@ Contains user information used to request a manual Catalyst enrollment. [customerEmail]: #customeremail #### [customerEmail] Applicant's email address -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Applicant's email address [customerName]: #customername #### [customerName] Applicant's first and last name -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Applicant's first and last name [startupName]: #startupname #### [startupName] Name of applicant's startup company -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Name of applicant's startup company [ventureAffiliationFlag]: #ventureaffiliationflag #### [ventureAffiliationFlag] Flag indicating whether (true) or not (false) and applicant is -Type: **boolean** +Type: **boolean** + @@ -85,7 +91,8 @@ Flag indicating whether (true) or not (false) and applicant is [ventureFundName]: #venturefundname #### [ventureFundName] Name of the venture capital fund, if any, applicant is affiliated with -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Collection_Locale_CountryCode/_index.md b/content/reference/datatypes/SoftLayer_Container_Collection_Locale_CountryCode/_index.md index 830975a058..6e7584680a 100644 --- a/content/reference/datatypes/SoftLayer_Container_Collection_Locale_CountryCode/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Collection_Locale_CountryCode/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This container is used to hold country locale information. @@ -45,7 +47,8 @@ This container is used to hold country locale information. [longName]: #longname #### [longName] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ This container is used to hold country locale information. [shortName]: #shortname #### [shortName] -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This container is used to hold country locale information. [stateCodes]: #statecodes #### [stateCodes] -Type: **SoftLayer_Container_Collection_Locale_StateCode[] ** +Type: **SoftLayer_Container_Collection_Locale_StateCode[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Collection_Locale_StateCode/_index.md b/content/reference/datatypes/SoftLayer_Container_Collection_Locale_StateCode/_index.md index 98f3bd49b8..458640ddd1 100644 --- a/content/reference/datatypes/SoftLayer_Container_Collection_Locale_StateCode/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Collection_Locale_StateCode/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This container is used to hold information regarding a state or province. @@ -45,7 +47,8 @@ This container is used to hold information regarding a state or province. [longName]: #longname #### [longName] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ This container is used to hold information regarding a state or province. [shortName]: #shortname #### [shortName] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Collection_Locale_VatCountryCodeAndFormat/_index.md b/content/reference/datatypes/SoftLayer_Container_Collection_Locale_VatCountryCodeAndFormat/_index.md index 8498980ba4..621cd9c4b5 100644 --- a/content/reference/datatypes/SoftLayer_Container_Collection_Locale_VatCountryCodeAndFormat/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Collection_Locale_VatCountryCodeAndFormat/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This container is used to hold VAT information. @@ -45,7 +47,8 @@ This container is used to hold VAT information. [countryCode]: #countrycode #### [countryCode] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ This container is used to hold VAT information. [regex]: #regex #### [regex] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Disk_Image_Capture_Template/_index.md b/content/reference/datatypes/SoftLayer_Container_Disk_Image_Capture_Template/_index.md index 0aa094a95c..b79e6d8473 100644 --- a/content/reference/datatypes/SoftLayer_Container_Disk_Image_Capture_Template/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Disk_Image_Capture_Template/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [summary]: #summary #### [summary] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [volumes]: #volumes #### [volumes] -Type: **SoftLayer_Container_Disk_Image_Capture_Template_Volume[] ** +Type: **SoftLayer_Container_Disk_Image_Capture_Template_Volume[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Disk_Image_Capture_Template_Volume/_index.md b/content/reference/datatypes/SoftLayer_Container_Disk_Image_Capture_Template_Volume/_index.md index a7b8034af6..abdbf471a1 100644 --- a/content/reference/datatypes/SoftLayer_Container_Disk_Image_Capture_Template_Volume/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Disk_Image_Capture_Template_Volume/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [bootVolumeFlag]: #bootvolumeflag #### [bootVolumeFlag] A customer provided flag to indicate that the current volume is the boot drive -Type: **boolean** +Type: **boolean** +
      @@ -55,7 +58,8 @@ A customer provided flag to indicate that the current volume is the boot drive [name]: #name #### [name] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ A customer provided flag to indicate that the current volume is the boot drive [partitions]: #partitions #### [partitions] -Type: **SoftLayer_Container_Disk_Image_Capture_Template_Volume_Partition[] ** +Type: **SoftLayer_Container_Disk_Image_Capture_Template_Volume_Partition[] ** + @@ -75,7 +80,8 @@ A customer provided flag to indicate that the current volume is the boot drive [storageGroupId]: #storagegroupid #### [storageGroupId] The storage group to capture -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Disk_Image_Capture_Template_Volume_Partition/_index.md b/content/reference/datatypes/SoftLayer_Container_Disk_Image_Capture_Template_Volume_Partition/_index.md index fe1f6e5989..94e2b1e73a 100644 --- a/content/reference/datatypes/SoftLayer_Container_Disk_Image_Capture_Template_Volume_Partition/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Disk_Image_Capture_Template_Volume_Partition/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
      diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Contact/_index.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Contact/_index.md index 8017a73c0b..ee443d923a 100644 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Contact/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Contact/_index.md @@ -18,6 +18,8 @@ classes:
      ## Description + + Contact information container for domain registration @@ -45,7 +47,8 @@ Contact information container for domain registration [address1]: #address1 #### [address1] The street address of the contact. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The street address of the contact. [address2]: #address2 #### [address2] The second line in the address of the contact. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The second line in the address of the contact. [address3]: #address3 #### [address3] The third line in the address of the contact. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The third line in the address of the contact. [city]: #city #### [city] The city of the contact. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The city of the contact. [country]: #country #### [country] The 2-character Country code. (i.e. US) -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The 2-character Country code. (i.e. US) [email]: #email #### [email] The email address of the contact. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The email address of the contact. [fax]: #fax #### [fax] The fax number of the contact. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The fax number of the contact. [firstName]: #firstname #### [firstName] The first name of the contact. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The first name of the contact. [lastName]: #lastname #### [lastName] The last name of the contact. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The last name of the contact. [organizationName]: #organizationname #### [organizationName] The organization name of the contact. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The organization name of the contact. [phone]: #phone #### [phone] The phone number of the contact. -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ The phone number of the contact. [postalCode]: #postalcode #### [postalCode] The postal code of the contact. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ The postal code of the contact. [state]: #state #### [state] The state of the contact. -Type: **string** +Type: **string** + @@ -179,7 +194,8 @@ The type of contact. The following are the valid types of contacts: * owner * billing * tech -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute/_index.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute/_index.md index 3050f627aa..d0b570cd13 100644 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This container data type contains extended attributes information for a domain of country code TLD. @@ -50,7 +52,8 @@ This container data type contains extended attributes information for a domain o [childFlag]: #childflag #### [childFlag] Indicates if this is a child of another extended attribute. -Type: **boolean** +Type: **boolean** + @@ -60,7 +63,8 @@ Indicates if this is a child of another extended attribute. [description]: #description #### [description] The description of an extended attribute. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ The description of an extended attribute. [name]: #name #### [name] The name of an extended attribute. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ The name of an extended attribute. [options]: #options #### [options] The collection of options for an extended attribute. -Type: **SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option[] ** +Type: **SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option[] ** + @@ -90,7 +96,8 @@ The collection of options for an extended attribute. [requiredFlag]: #requiredflag #### [requiredFlag] Indicates if extended attribute is required. -Type: **integer** +Type: **integer** + @@ -100,7 +107,8 @@ Indicates if extended attribute is required. [userDefinedFlag]: #userdefinedflag #### [userDefinedFlag] User defined indicates that the value is required from outside sources. -Type: **boolean** +Type: **boolean** + diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration/_index.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration/_index.md index ba4435c192..fe18bed821 100644 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This is the data type that may need to be populated to complete registraton for domains that are country code TLD's. @@ -55,7 +57,8 @@ This is the data type that may need to be populated to complete registraton for [name]: #name #### [name] The extended attribute name. -Type: **string** +Type: **string** + @@ -65,7 +68,8 @@ The extended attribute name. [value]: #value #### [value] The extended attribute option value. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option/_index.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option/_index.md index 6c4e11db8e..d0ec2262a2 100644 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This container data type contains extended attribute options information for a domain of country code TLD. @@ -50,7 +52,8 @@ This container data type contains extended attribute options information for a d [description]: #description #### [description] The description of an option. -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ The description of an option. [requireExtendedAttributes]: #requireextendedattributes #### [requireExtendedAttributes] Extended Attribute that is required for an option. -Type: **SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require[] ** +Type: **SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require[] ** + @@ -70,7 +74,8 @@ Extended Attribute that is required for an option. [title]: #title #### [title] The title of an option. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ The title of an option. [value]: #value #### [value] The value of an option. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require/_index.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require/_index.md index 77e9d357d8..ee45722877 100644 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This container data type contains the extended attribute name that is required by an extended attribute option. @@ -50,7 +52,8 @@ This container data type contains the extended attribute name that is required b [name]: #name #### [name] The name of an extended attribute that is required by an extended attribute option. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Information/_index.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Information/_index.md index 0b509d014d..7868398bde 100644 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Information/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Information/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Information container for domain registration @@ -45,7 +47,8 @@ Information container for domain registration [contacts]: #contacts #### [contacts] The information of the registered domain. -Type: **SoftLayer_Container_Dns_Domain_Registration_Contact[] ** +Type: **SoftLayer_Container_Dns_Domain_Registration_Contact[] ** + @@ -55,7 +58,8 @@ The information of the registered domain. [expireDate]: #expiredate #### [expireDate] The date that a domain is set to expire. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The date that a domain is set to expire. [nameservers]: #nameservers #### [nameservers] The list of nameservers for the domain. -Type: **SoftLayer_Container_Dns_Domain_Registration_Nameserver[] ** +Type: **SoftLayer_Container_Dns_Domain_Registration_Nameserver[] ** + @@ -75,7 +80,8 @@ The list of nameservers for the domain. [registryCreateDate]: #registrycreatedate #### [registryCreateDate] -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The list of nameservers for the domain. [registryExpireDate]: #registryexpiredate #### [registryExpireDate] -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The list of nameservers for the domain. [registryUpdateDate]: #registryupdatedate #### [registryUpdateDate] -Type: **dateTime** +Type: **dateTime** + diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_List/_index.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_List/_index.md index 9776d1b4a5..b693d4be2b 100644 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_List/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_List/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [domainName]: #domainname #### [domainName] The domain name. -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ The domain name. [encodingType]: #encodingtype #### [encodingType] Three-character language tag for the IDN domain that you're trying to register. This is only required for IDN domains. -Type: **string** +Type: **string** +
      @@ -67,7 +71,8 @@ Three-character language tag for the IDN domain that you're trying to register. Data required by the Registry for some country code top level domains (i.e. example.us). In order to determine if a domain requires extended attributes, use [SoftLayer_Dns_Domain_Registration::getExtendedAttributes]({{}}) service. -Type: **SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration[] ** +Type: **SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration[] ** + @@ -77,7 +82,8 @@ In order to determine if a domain requires extended attributes, use [SoftLayer_D [registrationPeriod]: #registrationperiod #### [registrationPeriod] The length of the registration period in years. Valid values are 1 – 10. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup/_index.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup/_index.md index 2ce432a8a4..29338891ee 100644 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Lookup domain container for domain registration @@ -45,7 +47,8 @@ Lookup domain container for domain registration [items]: #items #### [items] The list of available and taken domain names. -Type: **SoftLayer_Container_Dns_Domain_Registration_Lookup_Items[] ** +Type: **SoftLayer_Container_Dns_Domain_Registration_Lookup_Items[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup_Items/_index.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup_Items/_index.md index e79bcdde34..e1f05ab8eb 100644 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup_Items/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup_Items/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Lookup items container for domain registration @@ -45,7 +47,8 @@ Lookup items container for domain registration [domainName]: #domainname #### [domainName] The domain name. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The domain name. [status]: #status #### [status] The status of the domain name if available and can be registered. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver/_index.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver/_index.md index 3f2b687e4d..eb455db22a 100644 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Nameserver container for domain registration @@ -45,7 +47,8 @@ Nameserver container for domain registration [nameservers]: #nameservers #### [nameservers] The list of fully qualified names of the nameserver. -Type: **SoftLayer_Container_Dns_Domain_Registration_Nameserver_List[] ** +Type: **SoftLayer_Container_Dns_Domain_Registration_Nameserver_List[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver_List/_index.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver_List/_index.md index ba44a396ed..323ba6a9f4 100644 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver_List/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver_List/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Nameservers list container for domain registration @@ -45,7 +47,8 @@ Nameservers list container for domain registration [ipv4Address]: #ipv4address #### [ipv4Address] The IPv4 address of the nameserver. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The IPv4 address of the nameserver. [ipv6Address]: #ipv6address #### [ipv6Address] The IPv6 address of the nameserver. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The IPv6 address of the nameserver. [name]: #name #### [name] The fully qualified name of the nameserver -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The fully qualified name of the nameserver [sortOrder]: #sortorder #### [sortOrder] The sort order of the nameserver -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail/_index.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail/_index.md index 26e8b5f5c6..b5d9b5fe07 100644 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [status]: #status #### [status] The current status of the verification. -Type: **SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status ** +Type: **SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status ** +
      @@ -55,7 +58,8 @@ The current status of the verification. [verificationDeadlineDate]: #verificationdeadlinedate #### [verificationDeadlineDate] The adate when the domain will be suspended. -Type: **dateTime** +Type: **dateTime** +
      diff --git a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Transfer_Information/_index.md b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Transfer_Information/_index.md index 8ec1df35ad..d57ced0fb6 100644 --- a/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Transfer_Information/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Transfer_Information/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Transfer Information container for domain registration @@ -45,7 +47,8 @@ Transfer Information container for domain registration [reason]: #reason #### [reason] The reason why a domain is not transferable. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The reason why a domain is not transferable. [registrantEmail]: #registrantemail #### [registrantEmail] The registrant email. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The registrant email. [status]: #status #### [status] The status of the latest transfer on the domain. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The status of the latest transfer on the domain. [timeStamp]: #timestamp #### [timeStamp] The date and time of the most recent update to the state of the transfer. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The date and time of the most recent update to the state of the transfer. [transferrable]: #transferrable #### [transferrable] Indicates if the domain can be transferred. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Exception/_index.md b/content/reference/datatypes/SoftLayer_Container_Exception/_index.md index 497d7c6701..efe098d6c9 100644 --- a/content/reference/datatypes/SoftLayer_Container_Exception/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Exception/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Exception data type represents a SoftLayer_Exception. @@ -45,7 +47,8 @@ The SoftLayer_Container_Exception data type represents a SoftLayer_Exception. [exceptionClass]: #exceptionclass #### [exceptionClass] The SoftLayer_Exception class that the error is. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The SoftLayer_Exception class that the error is. [exceptionMessage]: #exceptionmessage #### [exceptionMessage] The exception message. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Graph/_index.md b/content/reference/datatypes/SoftLayer_Container_Graph/_index.md index bc93ffba15..003cf26a87 100644 --- a/content/reference/datatypes/SoftLayer_Container_Graph/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Graph/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [baseUnit]: #baseunit #### [baseUnit] base units associated with the graph. -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ base units associated with the graph. [endDatetime]: #enddatetime #### [endDatetime] Graph range end datetime. -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ Graph range end datetime. [height]: #height #### [height] The height of the graph image. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The height of the graph image. [image]: #image #### [image] The graph image. -Type: **binary data** +Type: **binary data** + @@ -85,7 +91,8 @@ The graph image. [interval]: #interval #### [interval] The graph interval in seconds. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The graph interval in seconds. [metrics]: #metrics #### [metrics] Metric types associated with the graph. -Type: **SoftLayer_Container_Metric_Data_Type[] ** +Type: **SoftLayer_Container_Metric_Data_Type[] ** + @@ -105,7 +113,8 @@ Metric types associated with the graph. [normalizeFlag]: #normalizeflag #### [normalizeFlag] Indicator to control whether the graph data is normalized. -Type: **binary data** +Type: **binary data** + @@ -115,7 +124,8 @@ Indicator to control whether the graph data is normalized. [options]: #options #### [options] The options used to control the graph appearance. -Type: **SoftLayer_Container_Graph_Option[] ** +Type: **SoftLayer_Container_Graph_Option[] ** + @@ -125,7 +135,8 @@ The options used to control the graph appearance. [plots]: #plots #### [plots] A collection of graph plots. -Type: **SoftLayer_Container_Graph_Plot[] ** +Type: **SoftLayer_Container_Graph_Plot[] ** + @@ -135,7 +146,8 @@ A collection of graph plots. [returnImage]: #returnimage #### [returnImage] option to not return the image. -Type: **boolean** +Type: **boolean** + @@ -145,7 +157,8 @@ option to not return the image. [startDatetime]: #startdatetime #### [startDatetime] Graph range start datetime. -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ Graph range start datetime. [template]: #template #### [template] The name of the template to use; may be null. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ The name of the template to use; may be null. [title]: #title #### [title] The title of the graph image. -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ The title of the graph image. [width]: #width #### [width] The width of the graph image. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Graph_Option/_index.md b/content/reference/datatypes/SoftLayer_Container_Graph_Option/_index.md index f5817bda9b..41bd97f8ec 100644 --- a/content/reference/datatypes/SoftLayer_Container_Graph_Option/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Graph_Option/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [value]: #value #### [value] -Type: **string** +Type: **string** +
      diff --git a/content/reference/datatypes/SoftLayer_Container_Graph_Plot/_index.md b/content/reference/datatypes/SoftLayer_Container_Graph_Plot/_index.md index a56eaf5875..9a22c887f8 100644 --- a/content/reference/datatypes/SoftLayer_Container_Graph_Plot/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Graph_Plot/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [data]: #data #### [data] -Type: **SoftLayer_Container_Graph_Plot_Coordinate[] ** +Type: **SoftLayer_Container_Graph_Plot_Coordinate[] ** +
      @@ -55,7 +58,8 @@ classes: [metric]: #metric #### [metric] -Type: **SoftLayer_Container_Metric_Data_Type ** +Type: **SoftLayer_Container_Metric_Data_Type ** +
      @@ -65,7 +69,8 @@ classes: [unit]: #unit #### [unit] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Graph_Plot_Coordinate/_index.md b/content/reference/datatypes/SoftLayer_Container_Graph_Plot_Coordinate/_index.md index baf7b9ad48..e38f59c60f 100644 --- a/content/reference/datatypes/SoftLayer_Container_Graph_Plot_Coordinate/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Graph_Plot_Coordinate/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [xValue]: #xvalue #### [xValue] -Type: **float** +Type: **float** +
      @@ -55,7 +58,8 @@ classes: [yValue]: #yvalue #### [yValue] -Type: **float** +Type: **float** +
      @@ -65,7 +69,8 @@ classes: [zValue]: #zvalue #### [zValue] -Type: **float** +Type: **float** + diff --git a/content/reference/datatypes/SoftLayer_Container_Hardware_CaptureEnabled/_index.md b/content/reference/datatypes/SoftLayer_Container_Hardware_CaptureEnabled/_index.md index 79d8532625..1a1684a16b 100644 --- a/content/reference/datatypes/SoftLayer_Container_Hardware_CaptureEnabled/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Hardware_CaptureEnabled/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [enabled]: #enabled #### [enabled] -Type: **boolean** +Type: **boolean** +
      @@ -55,7 +58,8 @@ classes: [reasons]: #reasons #### [reasons] -Type: **array of strings** +Type: **array of strings** +
      diff --git a/content/reference/datatypes/SoftLayer_Container_Hardware_Configuration/_index.md b/content/reference/datatypes/SoftLayer_Container_Hardware_Configuration/_index.md index 862e181ca1..53bb822be8 100644 --- a/content/reference/datatypes/SoftLayer_Container_Hardware_Configuration/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Hardware_Configuration/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + The hardware configuration container is used to provide configuration options for servers. Each configuration option will include both an itemPrice and a template. @@ -68,7 +70,8 @@ Available datacenter options. The datacenter.name value in the template represents which datacenter the server will be provisioned in. -Type: **SoftLayer_Container_Hardware_Configuration_Option[] ** +Type: **SoftLayer_Container_Hardware_Configuration_Option[] ** + @@ -87,7 +90,8 @@ The fixedConfigurationPreset.keyName value in the template is an id When providing a fixedConfigurationPreset.keyName while ordering a server the processors and hardDrives configuration options cannot be used. -Type: **SoftLayer_Container_Hardware_Configuration_Option[] ** +Type: **SoftLayer_Container_Hardware_Configuration_Option[] ** + @@ -106,7 +110,8 @@ A server will have at least one hard drive. The hardDrives.capacity value in the template represents the size, in gigabytes, of the disk. -Type: **SoftLayer_Container_Hardware_Configuration_Option[] ** +Type: **SoftLayer_Container_Hardware_Configuration_Option[] ** + @@ -122,7 +127,8 @@ Available network component options. The networkComponent.maxSpeed value in the template represents the link speed, in megabits per second, of the network connections for a server. -Type: **SoftLayer_Container_Hardware_Configuration_Option[] ** +Type: **SoftLayer_Container_Hardware_Configuration_Option[] ** + @@ -150,7 +156,8 @@ Providing the value of 'LATEST' for a version will select the latest release of For Windows based operating systems the version will represent both the release version (2008, 2012, etc) and the edition (Standard, Enterprise, etc). For all other operating systems the version will represent the major version (Centos 6, Ubuntu 12, etc) of that operating system, minor versions are represented in few reference codes where they are significant. -Type: **SoftLayer_Container_Hardware_Configuration_Option[] ** +Type: **SoftLayer_Container_Hardware_Configuration_Option[] ** + @@ -167,7 +174,8 @@ Available processor options. The processorCoreAmount value in the template represents the number of cores allocated to the server. The memoryCapacity value in the template represents the amount of memory, in gigabytes, allocated to the server. -Type: **SoftLayer_Container_Hardware_Configuration_Option[] ** +Type: **SoftLayer_Container_Hardware_Configuration_Option[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Hardware_Configuration_Option/_index.md b/content/reference/datatypes/SoftLayer_Container_Hardware_Configuration_Option/_index.md index 0d3620e1da..5d1e9b2a54 100644 --- a/content/reference/datatypes/SoftLayer_Container_Hardware_Configuration_Option/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Hardware_Configuration_Option/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + An option found within a [SoftLayer_Container_Hardware_Configuration]({{}}) structure. @@ -46,7 +48,8 @@ An option found within a [SoftLayer_Container_Hardware_Configuration]({{Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -57,7 +60,8 @@ Provides hourly and monthly costs (if either are applicable), and a description #### [preset] Provides a description of a fixed configuration preset with monthly and hourly costs. -Type: **SoftLayer_Product_Package_Preset ** +Type: **SoftLayer_Product_Package_Preset ** + @@ -68,7 +72,8 @@ Provides a description of a fixed configuration preset with monthly and hourly c #### [template] Provides a fragment of the request with the properties and values that must be sent when creating a server with the option. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Hardware_DiskImageMap/_index.md b/content/reference/datatypes/SoftLayer_Container_Hardware_DiskImageMap/_index.md index c4e39fa9d2..7d1ae9adba 100644 --- a/content/reference/datatypes/SoftLayer_Container_Hardware_DiskImageMap/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Hardware_DiskImageMap/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [bootFlag]: #bootflag #### [bootFlag] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [diskImageUUID]: #diskimageuuid #### [diskImageUUID] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [diskSerialNumber]: #diskserialnumber #### [diskSerialNumber] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Hardware_MassUpdate/_index.md b/content/reference/datatypes/SoftLayer_Container_Hardware_MassUpdate/_index.md index 8aa8904033..a33181b347 100644 --- a/content/reference/datatypes/SoftLayer_Container_Hardware_MassUpdate/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Hardware_MassUpdate/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [hardwareId]: #hardwareid #### [hardwareId] The hardwares updated by the mass update tool -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The hardwares updated by the mass update tool [message]: #message #### [message] Errors encountered while mass updating hardwares -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ Errors encountered while mass updating hardwares [successFlag]: #successflag #### [successFlag] The hardwares that failed to update -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Hardware_Pool_Details/_index.md b/content/reference/datatypes/SoftLayer_Container_Hardware_Pool_Details/_index.md index 7be82d26d0..ef224e8815 100644 --- a/content/reference/datatypes/SoftLayer_Container_Hardware_Pool_Details/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Hardware_Pool_Details/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [pendingOrders]: #pendingorders #### [pendingOrders] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [pendingTransactions]: #pendingtransactions #### [pendingTransactions] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [poolDescription]: #pooldescription #### [poolDescription] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [poolKeyName]: #poolkeyname #### [poolKeyName] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [poolName]: #poolname #### [poolName] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [routers]: #routers #### [routers] -Type: **SoftLayer_Container_Hardware_Pool_Details_Router[] ** +Type: **SoftLayer_Container_Hardware_Pool_Details_Router[] ** + @@ -105,7 +113,8 @@ classes: [totalHardware]: #totalhardware #### [totalHardware] -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ classes: [totalInventoryHardware]: #totalinventoryhardware #### [totalInventoryHardware] -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ classes: [totalProvisionedHardware]: #totalprovisionedhardware #### [totalProvisionedHardware] -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ classes: [totalTestedHardware]: #totaltestedhardware #### [totalTestedHardware] -Type: **integer** +Type: **integer** + @@ -145,7 +157,8 @@ classes: [totalTestingHardware]: #totaltestinghardware #### [totalTestingHardware] -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Hardware_Pool_Details_Router/_index.md b/content/reference/datatypes/SoftLayer_Container_Hardware_Pool_Details_Router/_index.md index 93bcbceed9..feb8c0c75c 100644 --- a/content/reference/datatypes/SoftLayer_Container_Hardware_Pool_Details_Router/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Hardware_Pool_Details_Router/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [poolThreshold]: #poolthreshold #### [poolThreshold] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [routerId]: #routerid #### [routerId] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [routerName]: #routername #### [routerName] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [totalHardware]: #totalhardware #### [totalHardware] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [totalInventoryHardware]: #totalinventoryhardware #### [totalInventoryHardware] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [totalProvisionedHardware]: #totalprovisionedhardware #### [totalProvisionedHardware] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [totalTestedHardware]: #totaltestedhardware #### [totalTestedHardware] -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ classes: [totalTestingHardware]: #totaltestinghardware #### [totalTestingHardware] -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Hardware_Server_Configuration/_index.md b/content/reference/datatypes/SoftLayer_Container_Hardware_Server_Configuration/_index.md index 946b6f24b1..4d5e4a728d 100644 --- a/content/reference/datatypes/SoftLayer_Container_Hardware_Server_Configuration/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Hardware_Server_Configuration/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Hardware_Server_Configuration data type contains information relating to a server's item price information, and hard drive partition information. @@ -50,7 +52,8 @@ The SoftLayer_Container_Hardware_Server_Configuration data type contains informa [addToSparePoolAfterOsReload]: #addtosparepoolafterosreload #### [addToSparePoolAfterOsReload] A flag indicating that the server will be moved into the spare pool after an Operating system reload. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ A flag indicating that the server will be moved into the spare pool after an Ope [customProvisionScriptUri]: #customprovisionscripturi #### [customProvisionScriptUri] The customer provision uri will be used to download and execute a customer defined script on the host at the end of provisioning. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ The customer provision uri will be used to download and execute a customer defin [driveRetentionFlag]: #driveretentionflag #### [driveRetentionFlag] A flag indicating that the primary drive will be converted to a portable storage volume during an Operating System reload. -Type: **boolean** +Type: **boolean** + @@ -80,7 +85,8 @@ A flag indicating that the primary drive will be converted to a portable storage [eraseHardDrives]: #eraseharddrives #### [eraseHardDrives] A flag indicating that all data will be erased from drives during an Operating System reload. -Type: **integer** +Type: **integer** + @@ -90,7 +96,8 @@ A flag indicating that all data will be erased from drives during an Operating S [hardDrives]: #harddrives #### [hardDrives] The hard drive partitions that a server can be partitioned with. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -100,7 +107,8 @@ The hard drive partitions that a server can be partitioned with. [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An Image Template ID [SoftLayer_Virtual_Guest_Block_Device_Template_Group]({{}}) that will be deployed to the host. If provided no item prices are required. -Type: **integer** +Type: **integer** + @@ -110,7 +118,8 @@ An Image Template ID [SoftLayer_Virtual_Guest_Block_Device_Template_Group]({{Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -120,7 +129,8 @@ The item prices that a server can be configured with. [lvmFlag]: #lvmflag #### [lvmFlag] A flag indicating that the provision should use LVM for all logical drives. -Type: **integer** +Type: **integer** + @@ -130,7 +140,8 @@ A flag indicating that the provision should use LVM for all logical drives. [resetIpmiPassword]: #resetipmipassword #### [resetIpmiPassword] A flag indicating that the remote management cards password will be reset. -Type: **integer** +Type: **integer** + @@ -140,7 +151,8 @@ A flag indicating that the remote management cards password will be reset. [serviceToken]: #servicetoken #### [serviceToken] The token of the requesting service. Do not set. -Type: **string** +Type: **string** + @@ -150,7 +162,8 @@ The token of the requesting service. Do not set. [sshKeyIds]: #sshkeyids #### [sshKeyIds] IDs to SoftLayer_Security_Ssh_Key objects on the current account which will be added to the server for authentication. SSH Keys will not be added to servers with Microsoft Windows. -Type: **array of integers** +Type: **array of integers** + @@ -160,7 +173,8 @@ IDs to SoftLayer_Security_Ssh_Key objects on the current account which will be a [upgradeBios]: #upgradebios #### [upgradeBios] A flag indicating that the BIOS will be updated when installing the operating system. -Type: **integer** +Type: **integer** + @@ -170,7 +184,8 @@ A flag indicating that the BIOS will be updated when installing the operating sy [upgradeHardDriveFirmware]: #upgradeharddrivefirmware #### [upgradeHardDriveFirmware] A flag indicating that the firmware on all hard drives will be updated when installing the operating system. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Hardware_Server_Details/_index.md b/content/reference/datatypes/SoftLayer_Container_Hardware_Server_Details/_index.md index c3853efa37..da1a6d0bf3 100644 --- a/content/reference/datatypes/SoftLayer_Container_Hardware_Server_Details/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Hardware_Server_Details/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Hardware_Server_Details data type contains information relating to a server's component information, network information, and software information. @@ -50,7 +52,8 @@ The SoftLayer_Container_Hardware_Server_Details data type contains information r [components]: #components #### [components] The components that belong to a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -60,7 +63,8 @@ The components that belong to a piece of hardware. [networkComponents]: #networkcomponents #### [networkComponents] The network components that belong to a piece of hardware. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -70,7 +74,8 @@ The network components that belong to a piece of hardware. [software]: #software #### [software] The software that belong to a piece of hardware. -Type: **SoftLayer_Software_Component[] ** +Type: **SoftLayer_Software_Component[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Hardware_Server_Request/_index.md b/content/reference/datatypes/SoftLayer_Container_Hardware_Server_Request/_index.md index f77ec45bbc..6a3925c9ff 100644 --- a/content/reference/datatypes/SoftLayer_Container_Hardware_Server_Request/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Hardware_Server_Request/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [hardwareId]: #hardwareid #### [hardwareId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [message]: #message #### [message] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [successFlag]: #successflag #### [successFlag] -Type: **boolean** +Type: **boolean** + diff --git a/content/reference/datatypes/SoftLayer_Container_Image_StorageGroupDetails/_index.md b/content/reference/datatypes/SoftLayer_Container_Image_StorageGroupDetails/_index.md index 210e084753..ce4c79c431 100644 --- a/content/reference/datatypes/SoftLayer_Container_Image_StorageGroupDetails/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Image_StorageGroupDetails/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [drives]: #drives #### [drives] -Type: **SoftLayer_Container_Image_StorageGroupDetails_Drives[] ** +Type: **SoftLayer_Container_Image_StorageGroupDetails_Drives[] ** +
      @@ -55,7 +58,8 @@ classes: [storageGroupName]: #storagegroupname #### [storageGroupName] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [storageGroupType]: #storagegrouptype #### [storageGroupType] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Image_StorageGroupDetails_Drives/_index.md b/content/reference/datatypes/SoftLayer_Container_Image_StorageGroupDetails_Drives/_index.md index 3320924402..89ab17f933 100644 --- a/content/reference/datatypes/SoftLayer_Container_Image_StorageGroupDetails_Drives/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Image_StorageGroupDetails_Drives/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [diskSpace]: #diskspace #### [diskSpace] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [units]: #units #### [units] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_KnowledgeLayer_QuestionAnswer/_index.md b/content/reference/datatypes/SoftLayer_Container_KnowledgeLayer_QuestionAnswer/_index.md index b948f8a81d..308ca7bb62 100644 --- a/content/reference/datatypes/SoftLayer_Container_KnowledgeLayer_QuestionAnswer/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_KnowledgeLayer_QuestionAnswer/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -56,7 +58,8 @@ SoftLayer_Container_KnowledgeLayer_QuestionAnswer models a single question and a [answer]: #answer #### [answer] The answer to a question asked on the SoftLayer KnowledgeLayer. -Type: **string** +Type: **string** + @@ -66,7 +69,8 @@ The answer to a question asked on the SoftLayer KnowledgeLayer. [link]: #link #### [link] The link to a question asked on the SoftLayer KnowledgeLayer. -Type: **string** +Type: **string** + @@ -76,7 +80,8 @@ The link to a question asked on the SoftLayer KnowledgeLayer. [question]: #question #### [question] A question asked on the SoftLayer KnowledgeLayer. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Message/_index.md b/content/reference/datatypes/SoftLayer_Container_Message/_index.md index ff313703c0..d55f5c22a8 100644 --- a/content/reference/datatypes/SoftLayer_Container_Message/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Message/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [message]: #message #### [message] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [type]: #type #### [type] -Type: **string** +Type: **string** +
      diff --git a/content/reference/datatypes/SoftLayer_Container_Metric_Data_Type/_index.md b/content/reference/datatypes/SoftLayer_Container_Metric_Data_Type/_index.md index f8255265f8..664ed0a319 100644 --- a/content/reference/datatypes/SoftLayer_Container_Metric_Data_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Metric_Data_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [summaryType]: #summarytype #### [summaryType] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [unit]: #unit #### [unit] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Metric_Tracking_Object_Details/_index.md b/content/reference/datatypes/SoftLayer_Container_Metric_Tracking_Object_Details/_index.md index 3c7f32f531..09c51b6954 100644 --- a/content/reference/datatypes/SoftLayer_Container_Metric_Tracking_Object_Details/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Metric_Tracking_Object_Details/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Metric_Tracking_Object_Details This container is a parent class for detailing diverse metrics. @@ -56,7 +58,8 @@ SoftLayer_Container_Metric_Tracking_Object_Details This container is a parent cl [metricName]: #metricname #### [metricName] The name that best describes the metric being collected. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Metric_Tracking_Object_Summary/_index.md b/content/reference/datatypes/SoftLayer_Container_Metric_Tracking_Object_Summary/_index.md index 755262a23a..47d873099b 100644 --- a/content/reference/datatypes/SoftLayer_Container_Metric_Tracking_Object_Summary/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Metric_Tracking_Object_Summary/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Metric_Tracking_Object_Summary This container is a parent class for summarizing diverse metrics. @@ -56,7 +58,8 @@ SoftLayer_Container_Metric_Tracking_Object_Summary This container is a parent cl [metricName]: #metricname #### [metricName] The name that best describes the metric being collected. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Metric_Tracking_Object_Virtual_Host_Details/_index.md b/content/reference/datatypes/SoftLayer_Container_Metric_Tracking_Object_Virtual_Host_Details/_index.md index 03c51b10f2..d289e62910 100644 --- a/content/reference/datatypes/SoftLayer_Container_Metric_Tracking_Object_Virtual_Host_Details/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Metric_Tracking_Object_Virtual_Host_Details/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Metric_Tracking_Object_Virtual_Host_Details This container details a virtual host's metric data. @@ -50,7 +52,8 @@ SoftLayer_Container_Metric_Tracking_Object_Virtual_Host_Details This container d [day]: #day #### [day] The day this metric was collected. -Type: **dateTime** +Type: **dateTime** + @@ -60,7 +63,8 @@ The day this metric was collected. [maxInstances]: #maxinstances #### [maxInstances] The maximum number of guests hosted by this platform for the given day. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ The maximum number of guests hosted by this platform for the given day. [maxMemoryUsage]: #maxmemoryusage #### [maxMemoryUsage] The maximum amount of memory utilized by this platform for the given day. -Type: **integer** +Type: **integer** + @@ -80,7 +85,8 @@ The maximum amount of memory utilized by this platform for the given day. [meanInstances]: #meaninstances #### [meanInstances] The mean number of guests hosted by this platform for the given day. -Type: **float** +Type: **float** + @@ -90,7 +96,8 @@ The mean number of guests hosted by this platform for the given day. [meanMemoryUsage]: #meanmemoryusage #### [meanMemoryUsage] The mean amount of memory utilized by this platform for the given day. -Type: **float** +Type: **float** + @@ -100,7 +107,8 @@ The mean amount of memory utilized by this platform for the given day. [metricName]: #metricname #### [metricName] The name that best describes the metric being collected. -Type: **string** +Type: **string** + @@ -110,7 +118,8 @@ The name that best describes the metric being collected. [minInstances]: #mininstances #### [minInstances] The minimum number of guests hosted by this platform for the given day. -Type: **integer** +Type: **integer** + @@ -120,7 +129,8 @@ The minimum number of guests hosted by this platform for the given day. [minMemoryUsage]: #minmemoryusage #### [minMemoryUsage] The minimum amount of memory utilized by this platform for the given day. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Metric_Tracking_Object_Virtual_Host_Summary/_index.md b/content/reference/datatypes/SoftLayer_Container_Metric_Tracking_Object_Virtual_Host_Summary/_index.md index 673fdb890b..7b3e4c287f 100644 --- a/content/reference/datatypes/SoftLayer_Container_Metric_Tracking_Object_Virtual_Host_Summary/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Metric_Tracking_Object_Virtual_Host_Summary/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Metric_Tracking_Object_Virtual_Host_Summary This container summarizes a virtual host's metric data. @@ -50,7 +52,8 @@ SoftLayer_Container_Metric_Tracking_Object_Virtual_Host_Summary This container s [avgMemoryUsageInBillingCycle]: #avgmemoryusageinbillingcycle #### [avgMemoryUsageInBillingCycle] The average amount of memory usage thus far in this billing cycle. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ The average amount of memory usage thus far in this billing cycle. [currentBillCycleEnd]: #currentbillcycleend #### [currentBillCycleEnd] Current bill cycle end date. -Type: **dateTime** +Type: **dateTime** + @@ -70,7 +74,8 @@ Current bill cycle end date. [currentBillCycleStart]: #currentbillcyclestart #### [currentBillCycleStart] Current bill cycle start date. -Type: **dateTime** +Type: **dateTime** + @@ -80,7 +85,8 @@ Current bill cycle start date. [lastInstanceCount]: #lastinstancecount #### [lastInstanceCount] The last count of instances this platform was hosting. -Type: **integer** +Type: **integer** + @@ -90,7 +96,8 @@ The last count of instances this platform was hosting. [lastMemoryUsageAmount]: #lastmemoryusageamount #### [lastMemoryUsageAmount] The last amount of memory this platform was using. -Type: **integer** +Type: **integer** + @@ -100,7 +107,8 @@ The last amount of memory this platform was using. [lastPollTime]: #lastpolltime #### [lastPollTime] The last time this virtual host was polled for metrics. -Type: **dateTime** +Type: **dateTime** + @@ -110,7 +118,8 @@ The last time this virtual host was polled for metrics. [maxInstanceInBillingCycle]: #maxinstanceinbillingcycle #### [maxInstanceInBillingCycle] The max number of instances hosted thus far in this billing cycle. -Type: **integer** +Type: **integer** + @@ -120,7 +129,8 @@ The max number of instances hosted thus far in this billing cycle. [metricName]: #metricname #### [metricName] The name that best describes the metric being collected. -Type: **string** +Type: **string** + @@ -130,7 +140,8 @@ The name that best describes the metric being collected. [previousBillCycleEnd]: #previousbillcycleend #### [previousBillCycleEnd] Previous bill cycle end date. -Type: **dateTime** +Type: **dateTime** + @@ -140,7 +151,8 @@ Previous bill cycle end date. [previousBillCycleStart]: #previousbillcyclestart #### [previousBillCycleStart] Previous bill cycle start date. -Type: **dateTime** +Type: **dateTime** + @@ -150,7 +162,8 @@ Previous bill cycle start date. [virtualPlatformName]: #virtualplatformname #### [virtualPlatformName] This virtual hosting platform name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Monitoring_Alarm_History/_index.md b/content/reference/datatypes/SoftLayer_Container_Monitoring_Alarm_History/_index.md index 277b38829b..233401a7f2 100644 --- a/content/reference/datatypes/SoftLayer_Container_Monitoring_Alarm_History/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Monitoring_Alarm_History/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Monitoring_Alarm_History data type contains information relating to SoftLayer monitoring alarm history. @@ -51,7 +53,8 @@ The SoftLayer_Container_Monitoring_Alarm_History data type contains information [accountId]: #accountid #### [accountId] Account ID that this alarm belongs to -Type: **integer** +Type: **integer** + @@ -61,7 +64,8 @@ Account ID that this alarm belongs to [agentId]: #agentid #### [agentId] DEPRECATED. ID of the monitoring agent that triggered this alarm -Type: **integer** +Type: **integer** + @@ -71,7 +75,8 @@ DEPRECATED. ID of the monitoring agent that triggered this alarm [alarmId]: #alarmid #### [alarmId] Alarm ID -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ Alarm ID [closedDate]: #closeddate #### [closedDate] Time that an alarm was closed. -Type: **dateTime** +Type: **dateTime** + @@ -91,7 +97,8 @@ Time that an alarm was closed. [createDate]: #createdate #### [createDate] Time that an alarm was triggered -Type: **dateTime** +Type: **dateTime** + @@ -101,7 +108,8 @@ Time that an alarm was triggered [message]: #message #### [message] Alarm message -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ Alarm message [robotId]: #robotid #### [robotId] DEPRECATED. Robot ID -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ DEPRECATED. Robot ID [severity]: #severity #### [severity] Severity of an alarm -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Authentication_Data/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Authentication_Data/_index.md index a65b93a034..02637e548e 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Authentication_Data/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Authentication_Data/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object holds authentication data to a server. @@ -50,7 +52,8 @@ This object holds authentication data to a server. [host]: #host #### [host] The name of a host -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ The name of a host [password]: #password #### [password] The authentication password -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ The authentication password [port]: #port #### [port] The port number -Type: **integer** +Type: **integer** + @@ -80,7 +85,8 @@ The port number [type]: #type #### [type] The type of network protocol. This can be ftp, ssh and so on. -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ The type of network protocol. This can be ftp, ssh and so on. [username]: #username #### [username] The authentication username -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Bandwidth_Data_Summary/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Bandwidth_Data_Summary/_index.md index c717ca853e..981b7da3c7 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Bandwidth_Data_Summary/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Bandwidth_Data_Summary/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Network_Bandwidth_Data_Summary models an interface's overall bandwidth usage during it's current billing cycle. @@ -51,7 +53,8 @@ SoftLayer_Container_Network_Bandwidth_Data_Summary models an interface's overall [allowedUsage]: #allowedusage #### [allowedUsage] The amount of bandwidth a server has allocated to it in it's current billing period. -Type: **float** +Type: **float** + @@ -61,7 +64,8 @@ The amount of bandwidth a server has allocated to it in it's current billing per [estimatedUsage]: #estimatedusage #### [estimatedUsage] The amount of bandwidth that a server has used within it's current billing period. -Type: **float** +Type: **float** + @@ -71,7 +75,8 @@ The amount of bandwidth that a server has used within it's current billing perio [projectedUsage]: #projectedusage #### [projectedUsage] The amount of bandwidth a server is projected to use within its billing period, based on it's current usage. -Type: **float** +Type: **float** + @@ -81,7 +86,8 @@ The amount of bandwidth a server is projected to use within its billing period, [usageUnits]: #usageunits #### [usageUnits] The unit of measurement used in a bandwidth data summary. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Bandwidth_Version1_Usage/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Bandwidth_Version1_Usage/_index.md index f1b420497e..cc3dafc8ac 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Bandwidth_Version1_Usage/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Bandwidth_Version1_Usage/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Network_Bandwidth_Version1_Usage models an hourly bandwidth record. @@ -55,7 +57,8 @@ SoftLayer_Container_Network_Bandwidth_Version1_Usage models an hourly bandwidth [incomingAmount]: #incomingamount #### [incomingAmount] The amount of incoming bandwidth that a server has used within the hour of the recordedDate. -Type: **float** +Type: **float** + @@ -65,7 +68,8 @@ The amount of incoming bandwidth that a server has used within the hour of the r [outgoingAmount]: #outgoingamount #### [outgoingAmount] The amount of outgoing bandwidth that a server has used within the hour of the recordedDate. -Type: **float** +Type: **float** + @@ -75,7 +79,8 @@ The amount of outgoing bandwidth that a server has used within the hour of the r [recordedDate]: #recordeddate #### [recordedDate] The date and time that the bandwidth was used by a piece of hardware -Type: **dateTime** +Type: **dateTime** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/_index.md index 128df156ac..f4af5e340a 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader data type contains information for specific responses from the modify response header API. @@ -45,7 +47,8 @@ The SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResp [delimiter]: #delimiter #### [delimiter] Specifies the delimiter to be used when indicating multiple values for a header. Valid delimiter is, a , , (comma), ; (semicolon), , (comma and space), or ; (semicolon and space). -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Specifies the delimiter to be used when indicating multiple values for a header. [description]: #description #### [description] The description of modify response header. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The description of modify response header. [headers]: #headers #### [headers] A collection of key value pairs that specify the headers and associated values to be modified. The header name and header value must be separated by colon (:). Example: ['header1:value1','header2:Value2'] -Type: **array of strings** +Type: **array of strings** + @@ -75,7 +80,8 @@ A collection of key value pairs that specify the headers and associated values t [modResHeaderUniqueId]: #modresheaderuniqueid #### [modResHeaderUniqueId] The uniqueId of the modify response header to which the existing behavior belongs. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The uniqueId of the modify response header to which the existing behavior belong [path]: #path #### [path] The path, relative to the domain that is accessed via modify response header. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The path, relative to the domain that is accessed via modify response header. [type]: #type #### [type] The type of the modify response header, could be append/modify/delete. Set this to append to add a given header value to a header name set in the headerList. Set this to delete to remove a given header value from a header name set in the headerList. Set this to overwrite to match on a specified header name and replace its existing header value with a new one you specify. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The type of the modify response header, could be append/modify/delete. Set this [uniqueId]: #uniqueid #### [uniqueId] The uniqueId of the mapping to which the existing behavior belongs. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/_index.md index 930ddde982..412c093e0e 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth data type contains information for specific responses from the Token Authentication API. @@ -45,7 +47,8 @@ The SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth [aclDelimiter]: #acldelimiter #### [aclDelimiter] Specifies a single character to separate access control list (ACL) fields. The default value is '!'. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Specifies a single character to separate access control list (ACL) fields. The d [escapeTokenInputs]: #escapetokeninputs #### [escapeTokenInputs] Possible values '0' and '1'. If set to '1', input values are escaped before adding them to the token. Default value is '1'. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Possible values '0' and '1'. If set to '1', input values are escaped before addi [hmacAlgorithm]: #hmacalgorithm #### [hmacAlgorithm] Specifies the algorithm to use for the token's hash-based message authentication code (HMAC) field. Valid entries are 'SHA256', 'SHA1', or 'MD5'. The default value is 'SHA256'. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Specifies the algorithm to use for the token's hash-based message authentication [ignoreQueryString]: #ignorequerystring #### [ignoreQueryString] Possible values '0' and '1'. If set to '1', query strings are removed from a URL when computing the token's HMAC algorithm. Default value is '0'. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ Possible values '0' and '1'. If set to '1', query strings are removed from a URL [name]: #name #### [name] The token name. If this value is empty, then it is set to the default value '__token__'. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The token name. If this value is empty, then it is set to the default value '__t [path]: #path #### [path] The path, relative to the domain that is accessed via token authentication. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The path, relative to the domain that is accessed via token authentication. [tokenDelimiter]: #tokendelimiter #### [tokenDelimiter] Specifies a single character to separate the individual token fields. The default value is '~'. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ Specifies a single character to separate the individual token fields. The defaul [tokenKey]: #tokenkey #### [tokenKey] The token encryption key, which specifies an even number of hex digits for the token key. An entry can be up to 64 characters in length. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The token encryption key, which specifies an even number of hex digits for the t [transitionKey]: #transitionkey #### [transitionKey] The token transition key, which specifies an even number of hex digits for the token transition key. An entry can be up to 64 characters in length. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The token transition key, which specifies an even number of hex digits for the t [uniqueId]: #uniqueid #### [uniqueId] The uniqueId of the mapping to which the existing behavior belongs. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge/_index.md index badc3e00e0..fcc9561cfd 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [date]: #date #### [date] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [path]: #path #### [path] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [saved]: #saved #### [saved] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [status]: #status #### [status] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/_index.md index 020b1cf90b..b912b0d3ca 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -45,7 +47,8 @@ The SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup da [createDate]: #createdate #### [createDate] Date in which record is created -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ Date in which record is created [groupUniqueId]: #groupuniqueid #### [groupUniqueId] A identifier that is unique to purge group. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ A identifier that is unique to purge group. [lastPurgeDate]: #lastpurgedate #### [lastPurgeDate] The Unix timestamp of the last purge. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The Unix timestamp of the last purge. [name]: #name #### [name] Purge Group name. The favorite group name must be unique, but non-favorite groups do not have this limitation -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ Purge Group name. The favorite group name must be unique, but non-favorite group [option]: #option #### [option] The following options are available to create a Purge Group: option 1: only purge the paths in the group, but don't save as favorite. option 2: only save the purge group as favorite, but don't purge paths. option 3: save the purge group as favorite and also purge paths. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The following options are available to create a Purge Group: option 1: only purg [pathCount]: #pathcount #### [pathCount] Total number of purge paths. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ Total number of purge paths. [paths]: #paths #### [paths] A collection of purge paths. -Type: **array of strings** +Type: **array of strings** + @@ -115,7 +124,8 @@ A collection of purge paths. [purgeStatus]: #purgestatus #### [purgeStatus] The purge's status when the input option field is 1 or 3. Status can be SUCCESS, FAILED, or IN_PROGRESS. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The purge's status when the input option field is 1 or 3. Status can be SUCCESS, [saved]: #saved #### [saved] Type of the Purge Group, currently SAVED or UNSAVED. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Type of the Purge Group, currently SAVED or UNSAVED. [uniqueId]: #uniqueid #### [uniqueId] A identifier that is unique to domain mapping. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory/_index.md index 8076057df6..4d8e06ce8f 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory data type contains information for specific responses from the Purge Group API and Purge History API. @@ -45,7 +47,8 @@ The SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHis [createDate]: #createdate #### [createDate] Date in which record is created -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ Date in which record is created [groupName]: #groupname #### [groupName] Purge Group name. The favorite group name must be unique, but un-favorite groups do not have this limitation -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Purge Group name. The favorite group name must be unique, but un-favorite groups [groupUniqueId]: #groupuniqueid #### [groupUniqueId] Purge group unique ID -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Purge group unique ID [status]: #status #### [status] The purge's status. Status can be SUCCESS, FAILED, or IN_PROGRESS. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The purge's status. Status can be SUCCESS, FAILED, or IN_PROGRESS. [uniqueId]: #uniqueid #### [uniqueId] Domain mapping unique ID. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input/_index.md index dd6fd72372..648e892c86 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [bucketName]: #bucketname #### [bucketName] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [cacheKeyQueryRule]: #cachekeyqueryrule #### [cacheKeyQueryRule] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [certificateType]: #certificatetype #### [certificateType] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [cname]: #cname #### [cname] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [domain]: #domain #### [domain] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [dynamicContentAcceleration]: #dynamiccontentacceleration #### [dynamicContentAcceleration] -Type: **SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration ** +Type: **SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration ** + @@ -105,7 +113,8 @@ classes: [fileExtension]: #fileextension #### [fileExtension] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [geoblockingRule]: #geoblockingrule #### [geoblockingRule] -Type: **SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking ** +Type: **SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking ** + @@ -125,7 +135,8 @@ classes: [header]: #header #### [header] -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ classes: [hotlinkProtection]: #hotlinkprotection #### [hotlinkProtection] -Type: **SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection ** +Type: **SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection ** + @@ -145,7 +157,8 @@ classes: [httpPort]: #httpport #### [httpPort] -Type: **integer** +Type: **integer** + @@ -155,7 +168,8 @@ classes: [httpsPort]: #httpsport #### [httpsPort] -Type: **integer** +Type: **integer** + @@ -165,7 +179,8 @@ classes: [oldPath]: #oldpath #### [oldPath] Used by the following method: updateOriginPath(). This property will store the path of the path record to be saved. The $path attribute stores the new path. -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ Used by the following method: updateOriginPath(). This property will store the p [origin]: #origin #### [origin] -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ Used by the following method: updateOriginPath(). This property will store the p [originType]: #origintype #### [originType] -Type: **string** +Type: **string** + @@ -195,7 +212,8 @@ Used by the following method: updateOriginPath(). This property will store the p [path]: #path #### [path] -Type: **string** +Type: **string** + @@ -205,7 +223,8 @@ Used by the following method: updateOriginPath(). This property will store the p [performanceConfiguration]: #performanceconfiguration #### [performanceConfiguration] -Type: **string** +Type: **string** + @@ -215,7 +234,8 @@ Used by the following method: updateOriginPath(). This property will store the p [protocol]: #protocol #### [protocol] -Type: **string** +Type: **string** + @@ -225,7 +245,8 @@ Used by the following method: updateOriginPath(). This property will store the p [respectHeaders]: #respectheaders #### [respectHeaders] -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ Used by the following method: updateOriginPath(). This property will store the p [serveStale]: #servestale #### [serveStale] -Type: **string** +Type: **string** + @@ -245,7 +267,8 @@ Used by the following method: updateOriginPath(). This property will store the p [status]: #status #### [status] -Type: **string** +Type: **string** + @@ -255,7 +278,8 @@ Used by the following method: updateOriginPath(). This property will store the p [uniqueId]: #uniqueid #### [uniqueId] -Type: **string** +Type: **string** + @@ -265,7 +289,8 @@ Used by the following method: updateOriginPath(). This property will store the p [vendorName]: #vendorname #### [vendorName] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping/_index.md index 1649f15abd..589e5c9c09 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [akamaiCname]: #akamaicname #### [akamaiCname] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [bucketName]: #bucketname #### [bucketName] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [cacheKeyQueryRule]: #cachekeyqueryrule #### [cacheKeyQueryRule] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [certificateType]: #certificatetype #### [certificateType] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [cname]: #cname #### [cname] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ classes: [domain]: #domain #### [domain] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [dynamicContentAcceleration]: #dynamiccontentacceleration #### [dynamicContentAcceleration] -Type: **SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration ** +Type: **SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration ** + @@ -125,7 +135,8 @@ classes: [fileExtension]: #fileextension #### [fileExtension] -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ classes: [header]: #header #### [header] -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ classes: [httpPort]: #httpport #### [httpPort] -Type: **integer** +Type: **integer** + @@ -155,7 +168,8 @@ classes: [httpsChallengeRedirectUrl]: #httpschallengeredirecturl #### [httpsChallengeRedirectUrl] -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ classes: [httpsChallengeResponse]: #httpschallengeresponse #### [httpsChallengeResponse] -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ classes: [httpsChallengeUrl]: #httpschallengeurl #### [httpsChallengeUrl] -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ classes: [httpsPort]: #httpsport #### [httpsPort] -Type: **integer** +Type: **integer** + @@ -195,7 +212,8 @@ classes: [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -205,7 +223,8 @@ classes: [originHost]: #originhost #### [originHost] -Type: **string** +Type: **string** + @@ -215,7 +234,8 @@ classes: [originType]: #origintype #### [originType] -Type: **string** +Type: **string** + @@ -225,7 +245,8 @@ classes: [path]: #path #### [path] -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ classes: [performanceConfiguration]: #performanceconfiguration #### [performanceConfiguration] -Type: **string** +Type: **string** + @@ -245,7 +267,8 @@ classes: [protocol]: #protocol #### [protocol] -Type: **string** +Type: **string** + @@ -255,7 +278,8 @@ classes: [respectHeaders]: #respectheaders #### [respectHeaders] -Type: **boolean** +Type: **boolean** + @@ -265,7 +289,8 @@ classes: [serveStale]: #servestale #### [serveStale] -Type: **boolean** +Type: **boolean** + @@ -275,7 +300,8 @@ classes: [status]: #status #### [status] -Type: **string** +Type: **string** + @@ -285,7 +311,8 @@ classes: [uniqueId]: #uniqueid #### [uniqueId] -Type: **string** +Type: **string** + @@ -295,7 +322,8 @@ classes: [vendorName]: #vendorname #### [vendorName] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path/_index.md index 41e0a7e278..3496ec6eaf 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [bucketName]: #bucketname #### [bucketName] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [cacheKeyQueryRule]: #cachekeyqueryrule #### [cacheKeyQueryRule] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [dynamicContentAcceleration]: #dynamiccontentacceleration #### [dynamicContentAcceleration] -Type: **SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration ** +Type: **SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration ** + @@ -75,7 +80,8 @@ classes: [fileExtension]: #fileextension #### [fileExtension] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [header]: #header #### [header] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [httpPort]: #httpport #### [httpPort] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [httpsPort]: #httpsport #### [httpsPort] -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ classes: [mappingUniqueId]: #mappinguniqueid #### [mappingUniqueId] -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ classes: [origin]: #origin #### [origin] -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ classes: [originType]: #origintype #### [originType] -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ classes: [path]: #path #### [path] -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ classes: [performanceConfiguration]: #performanceconfiguration #### [performanceConfiguration] -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ classes: [status]: #status #### [status] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration/_index.md index 8b9eaad318..475d267a8d 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [detectionPath]: #detectionpath #### [detectionPath] The detectionPath is used by CDN edge servers to find the best optimized route from edge to the origin server. The Akamai edge servers fetch the test object from the origin to know the network condition to your origin server, and then calculate the best optimized route with the network condition. The best path to origin must be known at the time a user’s request arrives at an edge server, since any in-line analysis or probing would defeat the purpose of speeding things up. -Type: **string** +Type: **string** +
      @@ -57,7 +60,8 @@ The detectionPath is used by CDN edge servers to find the best optimized route f Serving compressed images reduces the amount of content required to load a page. This feature helps offset less robust connections, such as those formed with mobile devices. Basically, if your site visitors have slow network speeds, MobileImageCompression technology can automatically increase compression of JPEG images to speed up loading. On the other hand, this feature results in lossy compression or irreversible compression, and may affect the quality of the images on your site. JPG supported file extensions: .jpg, .jpeg, .jpe, .jig, .jgig, .jgi The default is enabled. -Type: **boolean** +Type: **boolean** +
      @@ -71,7 +75,8 @@ Inspects HTML responses and prefetches embedded objects in HTML files. Prefetchi aif, aiff, au, avi, bin, bmp, cab, carb, cct, cdf, class, css, doc, dcr, dtd, exe, flv, gcf, gff, gif, grv, hdml, hqx, ico, ini, jpeg, jpg, js, mov, mp3, nc, pct, pdf, png, ppc, pws, swa, swf, txt, vbs, w32, wav, wbmp, wml, wmlc, wmls, wmlsc, xsd, and zip. The default is enabled. -Type: **boolean** +Type: **boolean** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Metrics/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Metrics/_index.md index e57d42edb2..1300d67068 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Metrics/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Metrics/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [descriptions]: #descriptions #### [descriptions] -Type: **array of strings** +Type: **array of strings** +
      @@ -55,7 +58,8 @@ classes: [names]: #names #### [names] -Type: **array of strings** +Type: **array of strings** +
      @@ -65,7 +69,8 @@ classes: [percentage]: #percentage #### [percentage] -Type: **array of strings** +Type: **array of strings** + @@ -75,7 +80,8 @@ classes: [time]: #time #### [time] -Type: **array of integers** +Type: **array of integers** + @@ -85,7 +91,8 @@ classes: [totals]: #totals #### [totals] -Type: **array of strings** +Type: **array of strings** + @@ -95,7 +102,8 @@ classes: [type]: #type #### [type] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ classes: [xaxis]: #xaxis #### [xaxis] -Type: **array of strings** +Type: **array of strings** + @@ -115,7 +124,8 @@ classes: [yaxis1]: #yaxis1 #### [yaxis1] -Type: **array of strings** +Type: **array of strings** + @@ -125,7 +135,8 @@ classes: [yaxis10]: #yaxis10 #### [yaxis10] -Type: **array of strings** +Type: **array of strings** + @@ -135,7 +146,8 @@ classes: [yaxis11]: #yaxis11 #### [yaxis11] -Type: **array of strings** +Type: **array of strings** + @@ -145,7 +157,8 @@ classes: [yaxis12]: #yaxis12 #### [yaxis12] -Type: **array of strings** +Type: **array of strings** + @@ -155,7 +168,8 @@ classes: [yaxis13]: #yaxis13 #### [yaxis13] -Type: **array of strings** +Type: **array of strings** + @@ -165,7 +179,8 @@ classes: [yaxis14]: #yaxis14 #### [yaxis14] -Type: **array of strings** +Type: **array of strings** + @@ -175,7 +190,8 @@ classes: [yaxis15]: #yaxis15 #### [yaxis15] -Type: **array of strings** +Type: **array of strings** + @@ -185,7 +201,8 @@ classes: [yaxis16]: #yaxis16 #### [yaxis16] -Type: **array of strings** +Type: **array of strings** + @@ -195,7 +212,8 @@ classes: [yaxis17]: #yaxis17 #### [yaxis17] -Type: **array of strings** +Type: **array of strings** + @@ -205,7 +223,8 @@ classes: [yaxis18]: #yaxis18 #### [yaxis18] -Type: **array of strings** +Type: **array of strings** + @@ -215,7 +234,8 @@ classes: [yaxis19]: #yaxis19 #### [yaxis19] -Type: **array of strings** +Type: **array of strings** + @@ -225,7 +245,8 @@ classes: [yaxis2]: #yaxis2 #### [yaxis2] -Type: **array of strings** +Type: **array of strings** + @@ -235,7 +256,8 @@ classes: [yaxis20]: #yaxis20 #### [yaxis20] -Type: **array of strings** +Type: **array of strings** + @@ -245,7 +267,8 @@ classes: [yaxis3]: #yaxis3 #### [yaxis3] -Type: **array of strings** +Type: **array of strings** + @@ -255,7 +278,8 @@ classes: [yaxis4]: #yaxis4 #### [yaxis4] -Type: **array of strings** +Type: **array of strings** + @@ -265,7 +289,8 @@ classes: [yaxis5]: #yaxis5 #### [yaxis5] -Type: **array of strings** +Type: **array of strings** + @@ -275,7 +300,8 @@ classes: [yaxis6]: #yaxis6 #### [yaxis6] -Type: **array of strings** +Type: **array of strings** + @@ -285,7 +311,8 @@ classes: [yaxis7]: #yaxis7 #### [yaxis7] -Type: **array of strings** +Type: **array of strings** + @@ -295,7 +322,8 @@ classes: [yaxis8]: #yaxis8 #### [yaxis8] -Type: **array of strings** +Type: **array of strings** + @@ -305,7 +333,8 @@ classes: [yaxis9]: #yaxis9 #### [yaxis9] -Type: **array of strings** +Type: **array of strings** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Vendor/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Vendor/_index.md index ed28ffc995..3edcc9914f 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Vendor/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Vendor/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [featureSummary]: #featuresummary #### [featureSummary] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [features]: #features #### [features] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [status]: #status #### [status] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [vendorName]: #vendorname #### [vendorName] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Directory_Listing/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Directory_Listing/_index.md index e599b08fec..349e79508a 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Directory_Listing/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Directory_Listing/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ SoftLayer_Container_Network_Directory_Listing represents a single entry in a lis [fileCount]: #filecount #### [fileCount] If the file in a directory listing is a directory itself then fileCount is the number of files within the directory. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ If the file in a directory listing is a directory itself then fileCount is the n [name]: #name #### [name] The name of a directory or a file within a directory listing. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ The name of a directory or a file within a directory listing. [type]: #type #### [type] The type of file in a directory listing. If a directory listing entry is a directory itself then type is set to "directory". Otherwise, type is a blank string. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_LoadBalancer_StatusEntry/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_LoadBalancer_StatusEntry/_index.md index 8a9f8cde11..49a445e7a2 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_LoadBalancer_StatusEntry/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_LoadBalancer_StatusEntry/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -49,7 +51,8 @@ It is returned exclusively by the getStatus method on the [SoftLayer_Network_Loa [content]: #content #### [content] The value of the entry. -Type: **string** +Type: **string** + @@ -59,7 +62,8 @@ The value of the entry. [label]: #label #### [label] Text description of the status entry -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Media_Information/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Media_Information/_index.md index 785f490e11..be21ed6c27 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Media_Information/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Media_Information/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This container class holds information on a media file such as file name, codec, frame rate and so on @@ -55,7 +57,8 @@ This container class holds information on a media file such as file name, codec, [audioBitRate]: #audiobitrate #### [audioBitRate] The audio bit rate -Type: **integer** +Type: **integer** + @@ -65,7 +68,8 @@ The audio bit rate [audioChannelMode]: #audiochannelmode #### [audioChannelMode] The audio channel mode -Type: **string** +Type: **string** + @@ -75,7 +79,8 @@ The audio channel mode [audioChannels]: #audiochannels #### [audioChannels] The number of audio channels -Type: **integer** +Type: **integer** + @@ -85,7 +90,8 @@ The number of audio channels [audioCodec]: #audiocodec #### [audioCodec] The audio codec name -Type: **string** +Type: **string** + @@ -95,7 +101,8 @@ The audio codec name [audioSampleRate]: #audiosamplerate #### [audioSampleRate] The audio sample rate -Type: **integer** +Type: **integer** + @@ -105,7 +112,8 @@ The audio sample rate [duration]: #duration #### [duration] The duration of a media -Type: **float** +Type: **float** + @@ -115,7 +123,8 @@ The duration of a media [errorMessage]: #errormessage #### [errorMessage] The error message if any. -Type: **string** +Type: **string** + @@ -125,7 +134,8 @@ The error message if any. [file]: #file #### [file] The name of a media file -Type: **string** +Type: **string** + @@ -135,7 +145,8 @@ The name of a media file [fileFormat]: #fileformat #### [fileFormat] The file format -Type: **string** +Type: **string** + @@ -145,7 +156,8 @@ The file format [fileSize]: #filesize #### [fileSize] The size of a media file in byte -Type: **unsigned long** +Type: **unsigned long** + @@ -155,7 +167,8 @@ The size of a media file in byte [frameRate]: #framerate #### [frameRate] The frame rate -Type: **float** +Type: **float** + @@ -165,7 +178,8 @@ The frame rate [sizeX]: #sizex #### [sizeX] The width of a media in pixel -Type: **integer** +Type: **integer** + @@ -175,7 +189,8 @@ The width of a media in pixel [sizeY]: #sizey #### [sizeY] The height of a media in pixel -Type: **integer** +Type: **integer** + @@ -185,7 +200,8 @@ The height of a media in pixel [totalFrames]: #totalframes #### [totalFrames] The total of frames -Type: **unsigned long** +Type: **unsigned long** + @@ -195,7 +211,8 @@ The total of frames [videoAspectX]: #videoaspectx #### [videoAspectX] The width in a video's width to height aspect ratio -Type: **float** +Type: **float** + @@ -205,7 +222,8 @@ The width in a video's width to height aspect ratio [videoAspectY]: #videoaspecty #### [videoAspectY] The height in a video's width to height aspect ratio -Type: **integer** +Type: **integer** + @@ -215,7 +233,8 @@ The height in a video's width to height aspect ratio [videoCodec]: #videocodec #### [videoCodec] The video codec name -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Job_Watermark/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Job_Watermark/_index.md index 6a4b2c74e7..f564f30d27 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Job_Watermark/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Job_Watermark/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [endTime]: #endtime #### [endTime] Time to stop showing watermark in milliseconds -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ Time to stop showing watermark in milliseconds [fileName]: #filename #### [fileName] Filename of image to use as watermark in transcoding job -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ Filename of image to use as watermark in transcoding job [position]: #position #### [position] Position to place watermark at -Type: **SoftLayer_Container_Network_Media_Transcode_Job_Watermark_Position ** +Type: **SoftLayer_Container_Network_Media_Transcode_Job_Watermark_Position ** + @@ -75,7 +80,8 @@ Position to place watermark at [startTime]: #starttime #### [startTime] Time to start showing watermark in milliseconds -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Time to start showing watermark in milliseconds [text]: #text #### [text] Text to Place in Watermark -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Text to Place in Watermark [transparencyPercentage]: #transparencypercentage #### [transparencyPercentage] Percentage Transparent watermark should be -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Job_Watermark_Position/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Job_Watermark_Position/_index.md index 194814d7ee..37289f19db 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Job_Watermark_Position/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Job_Watermark_Position/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [x]: #x #### [x] X Coordinate of Watermark -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ X Coordinate of Watermark [y]: #y #### [y] vertical Coordinate of Watermark -Type: **integer** +Type: **integer** +
      diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset/_index.md index ef02a12c24..ed6e82a6bd 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Transcode preset is a set of configuration parameters that defines a Transcode output format. SoftLayer_Container_Network_Media_Transcode_Preset contains a preset information defined on a Transcode server @@ -58,7 +60,8 @@ Transcode preset is a set of configuration parameters that defines a Transcode o [GUID]: #guid #### [GUID] The unique id that is used by a Transcode server -Type: **string** +Type: **string** + @@ -68,7 +71,8 @@ The unique id that is used by a Transcode server [category]: #category #### [category] The category that a preset belongs to -Type: **string** +Type: **string** + @@ -78,7 +82,8 @@ The category that a preset belongs to [description]: #description #### [description] The description of the preset -Type: **string** +Type: **string** + @@ -88,7 +93,8 @@ The description of the preset [name]: #name #### [name] The friendly name of a preset -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset_Element/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset_Element/_index.md index 0e0e48cc81..67d9fbdd8d 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset_Element/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset_Element/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Transcode preset element @@ -58,7 +60,8 @@ Transcode preset element [additionalElements]: #additionalelements #### [additionalElements] The additional elements for DROPDOWNLIST element -Type: **SoftLayer_Container_Network_Media_Transcode_Preset_Element_Option[] ** +Type: **SoftLayer_Container_Network_Media_Transcode_Preset_Element_Option[] ** + @@ -68,7 +71,8 @@ The additional elements for DROPDOWNLIST element [defaultValue]: #defaultvalue #### [defaultValue] The default value of an element. -Type: **string** +Type: **string** + @@ -78,7 +82,8 @@ The default value of an element. [description]: #description #### [description] The description of a preset element -Type: **string** +Type: **string** + @@ -88,7 +93,8 @@ The description of a preset element [enabled]: #enabled #### [enabled] The flag that indicates whether an element is enabled or not -Type: **boolean** +Type: **boolean** + @@ -98,7 +104,8 @@ The flag that indicates whether an element is enabled or not [extendedDescription]: #extendeddescription #### [extendedDescription] The extended description of a preset element -Type: **string** +Type: **string** + @@ -108,7 +115,8 @@ The extended description of a preset element [hidden]: #hidden #### [hidden] The flag that indicates whether an element is hidden or not -Type: **boolean** +Type: **boolean** + @@ -118,7 +126,8 @@ The flag that indicates whether an element is hidden or not [maximumValue]: #maximumvalue #### [maximumValue] The maximum value of an element -Type: **integer** +Type: **integer** + @@ -128,7 +137,8 @@ The maximum value of an element [minimumValue]: #minimumvalue #### [minimumValue] The minimum value of an element -Type: **integer** +Type: **integer** + @@ -138,7 +148,8 @@ The minimum value of an element [name]: #name #### [name] The name of an preset element -Type: **string** +Type: **string** + @@ -148,7 +159,8 @@ The name of an preset element [parentName]: #parentname #### [parentName] The name of a parent element -Type: **string** +Type: **string** + @@ -158,7 +170,8 @@ The name of a parent element [type]: #type #### [type] The type of an preset element. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset_Element_Option/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset_Element_Option/_index.md index 9af63993d0..9ce701de55 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset_Element_Option/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset_Element_Option/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Transcode preset element @@ -58,7 +60,8 @@ Transcode preset element [name]: #name #### [name] The name of a additional preset element -Type: **string** +Type: **string** + @@ -68,7 +71,8 @@ The name of a additional preset element [value]: #value #### [value] The value of a additional preset element -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email/_index.md index fbdcd6c2d9..8943bdfb87 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This datatype is deprecated and will be removed in API version 3.2. @@ -45,7 +47,8 @@ This datatype is deprecated and will be removed in API version 3.2. [body]: #body #### [body] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ This datatype is deprecated and will be removed in API version 3.2. [containsHtml]: #containshtml #### [containsHtml] -Type: **boolean** +Type: **boolean** + @@ -65,7 +69,8 @@ This datatype is deprecated and will be removed in API version 3.2. [from]: #from #### [from] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ This datatype is deprecated and will be removed in API version 3.2. [subject]: #subject #### [subject] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ This datatype is deprecated and will be removed in API version 3.2. [to]: #to #### [to] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Account_Overview/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Account_Overview/_index.md index 360875e384..b3a992f11b 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Account_Overview/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Account_Overview/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [creditsAllowed]: #creditsallowed #### [creditsAllowed] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [creditsOverage]: #creditsoverage #### [creditsOverage] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [creditsRemain]: #creditsremain #### [creditsRemain] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [creditsUsed]: #creditsused #### [creditsUsed] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [package]: #package #### [package] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [reputation]: #reputation #### [reputation] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [requests]: #requests #### [requests] -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Customer_Profile/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Customer_Profile/_index.md index fbcdff0821..292f5397fc 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Customer_Profile/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Customer_Profile/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [address]: #address #### [address] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [city]: #city #### [city] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [country]: #country #### [country] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [email]: #email #### [email] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [firstName]: #firstname #### [firstName] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [lastName]: #lastname #### [lastName] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ classes: [phone]: #phone #### [phone] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [state]: #state #### [state] -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ classes: [website]: #website #### [website] -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ classes: [zip]: #zip #### [zip] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_List_Entry/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_List_Entry/_index.md index 43b9187c4d..1713472d1e 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_List_Entry/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_List_Entry/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [created]: #created #### [created] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [email]: #email #### [email] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [reason]: #reason #### [reason] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [status]: #status #### [status] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics/_index.md index bcfc23cb3f..96f9a66d2a 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [blocks]: #blocks #### [blocks] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [bounces]: #bounces #### [bounces] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [clicks]: #clicks #### [clicks] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [date]: #date #### [date] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [delivered]: #delivered #### [delivered] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [invalidEmail]: #invalidemail #### [invalidEmail] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [opens]: #opens #### [opens] -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ classes: [repeatBounces]: #repeatbounces #### [repeatBounces] -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ classes: [repeatSpamReports]: #repeatspamreports #### [repeatSpamReports] -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ classes: [repeatUnsubscribes]: #repeatunsubscribes #### [repeatUnsubscribes] -Type: **integer** +Type: **integer** + @@ -145,7 +157,8 @@ classes: [requests]: #requests #### [requests] -Type: **integer** +Type: **integer** + @@ -155,7 +168,8 @@ classes: [spamReports]: #spamreports #### [spamReports] -Type: **integer** +Type: **integer** + @@ -165,7 +179,8 @@ classes: [uniqueClicks]: #uniqueclicks #### [uniqueClicks] -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ classes: [uniqueOpens]: #uniqueopens #### [uniqueOpens] -Type: **integer** +Type: **integer** + @@ -185,7 +201,8 @@ classes: [unsubscribes]: #unsubscribes #### [unsubscribes] -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Graph/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Graph/_index.md index 7a32bdc7c0..df4a2ff542 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Graph/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Graph/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [graphError]: #grapherror #### [graphError] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [graphImage]: #graphimage #### [graphImage] -Type: **binary data** +Type: **binary data** +
      @@ -65,7 +69,8 @@ classes: [graphTitle]: #graphtitle #### [graphTitle] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Options/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Options/_index.md index 5430cefb29..d8a083da5f 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Options/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Options/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [aggregatesOnly]: #aggregatesonly #### [aggregatesOnly] -Type: **boolean** +Type: **boolean** +
      @@ -55,7 +58,8 @@ classes: [category]: #category #### [category] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [days]: #days #### [days] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [endDate]: #enddate #### [endDate] -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ classes: [selectedStatistics]: #selectedstatistics #### [selectedStatistics] -Type: **array of strings** +Type: **array of strings** + @@ -95,7 +102,8 @@ classes: [startDate]: #startdate #### [startDate] -Type: **dateTime** +Type: **dateTime** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Port_Statistic/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Port_Statistic/_index.md index 24bc6ae491..6a6b9a6a60 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Port_Statistic/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Port_Statistic/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [administrativeStatus]: #administrativestatus #### [administrativeStatus] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [inDiscardPackets]: #indiscardpackets #### [inDiscardPackets] -Type: **unsigned long** +Type: **unsigned long** +
      @@ -65,7 +69,8 @@ classes: [inErrorPackets]: #inerrorpackets #### [inErrorPackets] -Type: **unsigned long** +Type: **unsigned long** + @@ -75,7 +80,8 @@ classes: [inOctets]: #inoctets #### [inOctets] -Type: **unsigned long** +Type: **unsigned long** + @@ -85,7 +91,8 @@ classes: [inUnicastPackets]: #inunicastpackets #### [inUnicastPackets] -Type: **unsigned long** +Type: **unsigned long** + @@ -95,7 +102,8 @@ classes: [maximumTransmissionUnit]: #maximumtransmissionunit #### [maximumTransmissionUnit] -Type: **unsigned long** +Type: **unsigned long** + @@ -105,7 +113,8 @@ classes: [operationalStatus]: #operationalstatus #### [operationalStatus] -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ classes: [outDiscardPackets]: #outdiscardpackets #### [outDiscardPackets] -Type: **unsigned long** +Type: **unsigned long** + @@ -125,7 +135,8 @@ classes: [outErrorPackets]: #outerrorpackets #### [outErrorPackets] -Type: **unsigned long** +Type: **unsigned long** + @@ -135,7 +146,8 @@ classes: [outOctets]: #outoctets #### [outOctets] -Type: **unsigned long** +Type: **unsigned long** + @@ -145,7 +157,8 @@ classes: [outUnicastPackets]: #outunicastpackets #### [outUnicastPackets] -Type: **unsigned long** +Type: **unsigned long** + @@ -155,7 +168,8 @@ classes: [portDuplex]: #portduplex #### [portDuplex] -Type: **unsigned long** +Type: **unsigned long** + @@ -165,7 +179,8 @@ classes: [speed]: #speed #### [speed] -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_SecurityGroup_Limit/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_SecurityGroup_Limit/_index.md index 30e52c2702..311c91e0f5 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_SecurityGroup_Limit/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_SecurityGroup_Limit/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [typeKey]: #typekey #### [typeKey] A key value describing what type of limit. -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ A key value describing what type of limit. [value]: #value #### [value] The value of the security group limit. -Type: **integer** +Type: **integer** +
      diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Service_Resource_ObjectStorage_ConnectionInformation/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Service_Resource_ObjectStorage_ConnectionInformation/_index.md index 8fb01fbc45..1ce454f7b5 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Service_Resource_ObjectStorage_ConnectionInformation/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Service_Resource_ObjectStorage_ConnectionInformation/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [datacenter]: #datacenter #### [datacenter] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [datacenterShortName]: #datacentershortname #### [datacenterShortName] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [privateEndpoint]: #privateendpoint #### [privateEndpoint] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [publicEndpoint]: #publicendpoint #### [publicEndpoint] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Backup_Evault_WebCc_Authentication_Details/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Backup_Evault_WebCc_Authentication_Details/_index.md index 36cb046af5..37da6b56bc 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Backup_Evault_WebCc_Authentication_Details/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Backup_Evault_WebCc_Authentication_Details/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [eventValidation]: #eventvalidation #### [eventValidation] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [viewState]: #viewstate #### [viewState] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [webCcFormName]: #webccformname #### [webCcFormName] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [webCcUrl]: #webccurl #### [webCcUrl] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [webCcUserId]: #webccuserid #### [webCcUserId] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [webCcUserPassword]: #webccuserpassword #### [webCcUserPassword] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Storage_DataCenterLimits_VolumeCountLimitContainer/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Storage_DataCenterLimits_VolumeCountLimitContainer/_index.md index 5a3af96786..9204e123f5 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Storage_DataCenterLimits_VolumeCountLimitContainer/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Storage_DataCenterLimits_VolumeCountLimitContainer/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [datacenterName]: #datacentername #### [datacenterName] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [maximumAvailableCount]: #maximumavailablecount #### [maximumAvailableCount] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [provisionedCount]: #provisionedcount #### [provisionedCount] -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Evault_Vault_Task/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Evault_Vault_Task/_index.md index c655259609..e333f5552a 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Evault_Vault_Task/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Evault_Vault_Task/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + 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. @@ -63,7 +65,8 @@ When a job is created using the Webcc Console, the job created is identified as [id]: #id #### [id] Unique identifier for the task. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -73,7 +76,8 @@ Unique identifier for the task. [name]: #name #### [name] The hostname provided at time of agent registration. -Type: **string** +Type: **string** + @@ -83,7 +87,8 @@ The hostname provided at time of agent registration. [usedPoolsize]: #usedpoolsize #### [usedPoolsize] Total compressed bytes used for the task. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Evault_WebCc_AgentStatus/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Evault_WebCc_AgentStatus/_index.md index 2468f2e7e9..d2b27a8854 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Evault_WebCc_AgentStatus/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Evault_WebCc_AgentStatus/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -52,7 +54,8 @@ The SoftLayer_Container_Network_Storage_Evault_WebCc_AgentStatus will contain th [lastBackup]: #lastbackup #### [lastBackup] Timestamp of last backup performed by the EVault backup agent -Type: **dateTime** +Type: **dateTime** + @@ -62,7 +65,8 @@ Timestamp of last backup performed by the EVault backup agent [status]: #status #### [status] Status indicating the accumulative status result of all jobs performed by the evault agent. For example, if one job out three jobs failed agent status will by "Failed Backup(s)". -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Evault_WebCc_BackupResults/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Evault_WebCc_BackupResults/_index.md index cea9d9c18f..0ab7ec7cd9 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Evault_WebCc_BackupResults/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Evault_WebCc_BackupResults/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Network_Storage_Evault_WebCc_BackupResults will contain the timeframe of backups and the results will also be returned. @@ -50,7 +52,8 @@ The SoftLayer_Container_Network_Storage_Evault_WebCc_BackupResults will contain [beginTime]: #begintime #### [beginTime] Timestamp of begin time -Type: **dateTime** +Type: **dateTime** + @@ -60,7 +63,8 @@ Timestamp of begin time [conflict]: #conflict #### [conflict] Count of backups with conflicts. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ Count of backups with conflicts. [endTime]: #endtime #### [endTime] Timestamp of end time -Type: **dateTime** +Type: **dateTime** + @@ -80,7 +85,8 @@ Timestamp of end time [failed]: #failed #### [failed] Count of failed backups. -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ Count of failed backups. [success]: #success #### [success] Count of successfull backups. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails/_index.md index 8d70d8d628..c97d6031ac 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ The SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails will contain bas [bytesUsed]: #bytesused #### [bytesUsed] The number of bytes currently used by the backup job. (provided only for backup jobs) -Type: **unsigned long** +Type: **unsigned long** + @@ -61,7 +64,8 @@ The number of bytes currently used by the backup job. (provided only for backup [description]: #description #### [description] Description of the backup/restore job -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ Description of the backup/restore job [hardwareId]: #hardwareid #### [hardwareId] hardware id -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ hardware id [lastRunDate]: #lastrundate #### [lastRunDate] Date of the last jobrun. -Type: **dateTime** +Type: **dateTime** + @@ -91,7 +97,8 @@ Date of the last jobrun. [name]: #name #### [name] Name of the backup/restore job -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ Name of the backup/restore job [originalSize]: #originalsize #### [originalSize] Size of backup job when it was first run. (provided only for backup jobs) -Type: **unsigned long** +Type: **unsigned long** + @@ -111,7 +119,8 @@ Size of backup job when it was first run. (provided only for backup jobs) [percentageOfTotalUsage]: #percentageoftotalusage #### [percentageOfTotalUsage] Percentage of overall used space allocated by the job. (provided only for backup jobs) -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ Percentage of overall used space allocated by the job. (provided only for backup [result]: #result #### [result] Result of the latest jobrun. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Result of the latest jobrun. [virtualGuestId]: #virtualguestid #### [virtualGuestId] virtual guest id -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Host/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Host/_index.md index aa6ef70df3..1ba37f840e 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Host/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Host/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ The SoftLayer_Container_Network_Storage_Host will contain the reference id field [id]: #id #### [id] Reference id field for object associated with host. -Type: **integer** +Type: **integer** + @@ -61,7 +64,8 @@ Reference id field for object associated with host. [objectType]: #objecttype #### [objectType] Type for the object associated with host -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Bucket/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Bucket/_index.md index 639ba27e7e..c1869d180c 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Bucket/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Bucket/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Bucket provides description of a bucket @@ -45,7 +47,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Bucket provides descriptio [bytesUsed]: #bytesused #### [bytesUsed] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Bucket provides descriptio [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Bucket provides descriptio [objectCount]: #objectcount #### [objectCount] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Bucket provides descriptio [storageLocation]: #storagelocation #### [storageLocation] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl/_index.md index ceb847492c..8bea4b888c 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl provides specific details is a container which contains the cdn urls associated with an object storage account @@ -55,7 +57,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl provide [datacenter]: #datacenter #### [datacenter] -Type: **string** +Type: **string** + @@ -65,7 +68,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl provide [flashUrl]: #flashurl #### [flashUrl] -Type: **string** +Type: **string** + @@ -75,7 +79,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl provide [httpUrl]: #httpurl #### [httpUrl] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Endpoint/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Endpoint/_index.md index dd122696d7..29fa778d39 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Endpoint/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Endpoint/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Endpoint provides specific details on available endpoint URLs and locations. @@ -45,7 +47,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Endpoint provides specific [legacy]: #legacy #### [legacy] -Type: **boolean** +Type: **boolean** + @@ -55,7 +58,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Endpoint provides specific [location]: #location #### [location] -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Endpoint provides specific [region]: #region #### [region] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Endpoint provides specific [type]: #type #### [type] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Endpoint provides specific [url]: #url #### [url] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_File/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_File/_index.md index b62d245713..a8d9390d75 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_File/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_File/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Network_Storage_Hub_ObjectStorage_File provides specific details that only apply to files that are sent or received from CloudLayer storage resources. @@ -56,7 +58,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_File provides specific det [content]: #content #### [content] A file entity's raw content. -Type: **binary data** +Type: **binary data** + @@ -66,7 +69,8 @@ A file entity's raw content. [contentType]: #contenttype #### [contentType] A file entity's MIME content type. -Type: **string** +Type: **string** + @@ -76,7 +80,8 @@ A file entity's MIME content type. [createDate]: #createdate #### [createDate] The date a file entity was created. -Type: **dateTime** +Type: **dateTime** + @@ -86,7 +91,8 @@ The date a file entity was created. [deleteDate]: #deletedate #### [deleteDate] The date a CloudLayer storage file entity was moved into the recycle bin. This field applies to files that are pending deletion in the recycle bin. -Type: **dateTime** +Type: **dateTime** + @@ -96,7 +102,8 @@ The date a CloudLayer storage file entity was moved into the recycle bin. This f [folder]: #folder #### [folder] -Type: **string** +Type: **string** + @@ -106,7 +113,8 @@ The date a CloudLayer storage file entity was moved into the recycle bin. This f [hash]: #hash #### [hash] -Type: **string** +Type: **string** + @@ -116,7 +124,8 @@ The date a CloudLayer storage file entity was moved into the recycle bin. This f [id]: #id #### [id] Unique identifier for the file. This can be either a number or guid. -Type: **string** +Type: **string** + @@ -126,7 +135,8 @@ Unique identifier for the file. This can be either a number or guid. [isShared]: #isshared #### [isShared] Whether a CloudLayer storage file entity is shared with another CloudLayer user. -Type: **integer** +Type: **integer** + @@ -136,7 +146,8 @@ Whether a CloudLayer storage file entity is shared with another CloudLayer user. [modifyDate]: #modifydate #### [modifyDate] The date a file entity was last changed. -Type: **dateTime** +Type: **dateTime** + @@ -146,7 +157,8 @@ The date a file entity was last changed. [name]: #name #### [name] A file entity's name. -Type: **string** +Type: **string** + @@ -156,7 +168,8 @@ A file entity's name. [owner]: #owner #### [owner] The owner is usually the account who first upload or created the file on the resource or the account who is responsible for the file at the moment. -Type: **string** +Type: **string** + @@ -166,7 +179,8 @@ The owner is usually the account who first upload or created the file on the res [size]: #size #### [size] The size of a file entity in bytes. -Type: **unsigned long** +Type: **unsigned long** + @@ -176,7 +190,8 @@ The size of a file entity in bytes. [type]: #type #### [type] A CloudLayer storage file entity's type. Types can include "file", "folder", "dir", and "project". -Type: **string** +Type: **string** + @@ -186,7 +201,8 @@ A CloudLayer storage file entity's type. Types can include "file", "folder", "di [version]: #version #### [version] The latest revision of a file on a CloudLayer storage volume. This number increments each time a new revision of the file is uploaded. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Folder/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Folder/_index.md index 048b058925..228ac21854 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Folder/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Folder/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Network_Storage_Hub_Container provides details about containers which store collections of files. @@ -56,7 +58,8 @@ SoftLayer_Container_Network_Storage_Hub_Container provides details about contain [bytes]: #bytes #### [bytes] -Type: **unsigned long** +Type: **unsigned long** + @@ -66,7 +69,8 @@ SoftLayer_Container_Network_Storage_Hub_Container provides details about contain [count]: #count #### [count] -Type: **unsigned long** +Type: **unsigned long** + @@ -76,7 +80,8 @@ SoftLayer_Container_Network_Storage_Hub_Container provides details about contain [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Node/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Node/_index.md index a8f3962274..24c42eca09 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Node/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Node/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Node provides detailed information for a particular object storage node @@ -56,7 +58,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Node provides detailed inf [deviceName]: #devicename #### [deviceName] -Type: **string** +Type: **string** + @@ -66,7 +69,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Node provides detailed inf [resourceName]: #resourcename #### [resourceName] -Type: **string** +Type: **string** + @@ -76,7 +80,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Node provides detailed inf [userAuthUrl]: #userauthurl #### [userAuthUrl] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Policy/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Policy/_index.md index 78c47f6364..b86b5fb6e1 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Policy/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Policy/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Policy provides specific details on available storage policies. @@ -45,7 +47,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Policy provides specific d [policyCode]: #policycode #### [policyCode] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Provision/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Provision/_index.md index cf91e5b0a9..72e89f0db4 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Provision/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Provision/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Provision provides description of a provision @@ -45,7 +47,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Provision provides descrip [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Provision provides descrip [provision]: #provision #### [provision] -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Provision provides descrip [provisionCreateDate]: #provisioncreatedate #### [provisionCreateDate] -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Provision provides descrip [provisionModifyDate]: #provisionmodifydate #### [provisionModifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Provision provides descrip [provisionTime]: #provisiontime #### [provisionTime] -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Storage_MassDataMigration_Request_Address/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Storage_MassDataMigration_Request_Address/_index.md index a48e92a403..c3de434143 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Storage_MassDataMigration_Request_Address/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Storage_MassDataMigration_Request_Address/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [address1]: #address1 #### [address1] Line 1 of the address - typically the number and street address the MDMS device will be delivered to -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ Line 1 of the address - typically the number and street address the MDMS device [address2]: #address2 #### [address2] Line 2 of the address -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ Line 2 of the address [addressAttention]: #addressattention #### [addressAttention] First and last name of the customer on the shipping address -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ First and last name of the customer on the shipping address [addressNickname]: #addressnickname #### [addressNickname] The datacenter name where the MDMS device will be shipped to -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The datacenter name where the MDMS device will be shipped to [city]: #city #### [city] The shipping address city -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The shipping address city [companyName]: #companyname #### [companyName] Name of the company device is being shipped to -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ Name of the company device is being shipped to [country]: #country #### [country] The shipping address country -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The shipping address country [postalCode]: #postalcode #### [postalCode] The shipping address postal code -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The shipping address postal code [state]: #state #### [state] The shipping address state -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Storage_NetworkConnectionInformation/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Storage_NetworkConnectionInformation/_index.md index 95f340dfea..0bad40453d 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Storage_NetworkConnectionInformation/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Storage_NetworkConnectionInformation/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [ipAddress]: #ipaddress #### [ipAddress] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [storageType]: #storagetype #### [storageType] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Storage_VolumeDuplicateParameters/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Storage_VolumeDuplicateParameters/_index.md index b76d0049c6..3fc5ad9084 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Storage_VolumeDuplicateParameters/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Storage_VolumeDuplicateParameters/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Container for Volume Duplicate Information @@ -45,7 +47,8 @@ Container for Volume Duplicate Information [iopsPerGb]: #iopspergb #### [iopsPerGb] The iopsPerGB of the volume -Type: **float** +Type: **float** + @@ -55,7 +58,8 @@ The iopsPerGB of the volume [isDuplicatable]: #isduplicatable #### [isDuplicatable] Returns true if volume can be duplicated; false otherwise -Type: **boolean** +Type: **boolean** + @@ -65,7 +69,8 @@ Returns true if volume can be duplicated; false otherwise [locationId]: #locationid #### [locationId] This represents the location id -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ This represents the location id [locationName]: #locationname #### [locationName] This represents the location name -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ This represents the location name [maximumIopsPerGb]: #maximumiopspergb #### [maximumIopsPerGb] The maximumIopsPerGb allowed for a duplicated volume -Type: **float** +Type: **float** + @@ -95,7 +102,8 @@ The maximumIopsPerGb allowed for a duplicated volume [maximumIopsTier]: #maximumiopstier #### [maximumIopsTier] The maximumIopsTier allowed for a duplicated volume -Type: **float** +Type: **float** + @@ -105,7 +113,8 @@ The maximumIopsTier allowed for a duplicated volume [maximumVolumeSize]: #maximumvolumesize #### [maximumVolumeSize] The maximumVolumeSize allowed for a duplicated volume -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ The maximumVolumeSize allowed for a duplicated volume [minimumIopsPerGb]: #minimumiopspergb #### [minimumIopsPerGb] The minimumIopsPerGb allowed for a duplicated volume -Type: **float** +Type: **float** + @@ -125,7 +135,8 @@ The minimumIopsPerGb allowed for a duplicated volume [minimumIopsTier]: #minimumiopstier #### [minimumIopsTier] The minimumIopsTier allowed for a duplicated volume -Type: **float** +Type: **float** + @@ -135,7 +146,8 @@ The minimumIopsTier allowed for a duplicated volume [minimumVolumeSize]: #minimumvolumesize #### [minimumVolumeSize] The minimumVolumeSize allowed for a duplicated volume -Type: **integer** +Type: **integer** + @@ -145,7 +157,8 @@ The minimumVolumeSize allowed for a duplicated volume [status]: #status #### [status] The volume duplicate status description -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ The volume duplicate status description [volumeUsername]: #volumeusername #### [volumeUsername] This represents the volume username -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Subnet_IpAddress/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Subnet_IpAddress/_index.md index 61cf342a65..89ee17c44d 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Subnet_IpAddress/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Subnet_IpAddress/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -70,7 +72,8 @@ SoftLayer_Container_Subnet_IPAddress models an IP v4 address as it exists as a m [hardware]: #hardware #### [hardware] The hardware that an IP address is associated with. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -80,7 +83,8 @@ The hardware that an IP address is associated with. [ipAddress]: #ipaddress #### [ipAddress] An IP address expressed in dotted-quad notation. -Type: **string** +Type: **string** + @@ -90,7 +94,8 @@ An IP address expressed in dotted-quad notation. [isBroadcastAddress]: #isbroadcastaddress #### [isBroadcastAddress] Whether an IP address is its subnet's broadcast address. -Type: **boolean** +Type: **boolean** + @@ -100,7 +105,8 @@ Whether an IP address is its subnet's broadcast address. [isGatewayAddress]: #isgatewayaddress #### [isGatewayAddress] Whether an IP address is its subnet's gateway address. Gateway addresses exist on SoftLayer's routers and many not be assigned to servers. -Type: **boolean** +Type: **boolean** + @@ -110,7 +116,8 @@ Whether an IP address is its subnet's gateway address. Gateway addresses exist o [isNetworkAddress]: #isnetworkaddress #### [isNetworkAddress] Whether an IP address is its subnet's network identifier address. -Type: **boolean** +Type: **boolean** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Subnet_Registration_SubnetReference/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Subnet_Registration_SubnetReference/_index.md index 98bfab9ace..c3688beb59 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Subnet_Registration_SubnetReference/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Subnet_Registration_SubnetReference/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Network_Subnet_Registration_SubnetReference is provided to reference [SoftLayer_Network_Subnet_Registration]({{}}) object and the [SoftLayer_Network_Subnet]({{}}) it references, in CIDR form. @@ -45,7 +47,8 @@ SoftLayer_Container_Network_Subnet_Registration_SubnetReference is provided to r [registrationId]: #registrationid #### [registrationId] The ID of the [SoftLayer_Network_Subnet_Registration]({{}}) object. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The ID of the [SoftLayer_Network_Subnet_Registration]({{Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Network_Subnet_Registration_TransactionDetails/_index.md b/content/reference/datatypes/SoftLayer_Container_Network_Subnet_Registration_TransactionDetails/_index.md index bbf4fedb14..6a20f40141 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_Subnet_Registration_TransactionDetails/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_Subnet_Registration_TransactionDetails/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Subnet_Registration_TransactionDetails is provided to return details of a newly created Subnet Registration Transaction. @@ -45,7 +47,8 @@ SoftLayer_Container_Subnet_Registration_TransactionDetails is provided to return [subnetReferences]: #subnetreferences #### [subnetReferences] The IDs and Subnets of the [SoftLayer_Network_Subnet_Registration]({{}}) object. -Type: **SoftLayer_Container_Network_Subnet_Registration_SubnetReference[] ** +Type: **SoftLayer_Container_Network_Subnet_Registration_SubnetReference[] ** + @@ -55,7 +58,8 @@ The IDs and Subnets of the [SoftLayer_Network_Subnet_Registration]({{Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Notification_Mass_Filter_TemplateKey/_index.md b/content/reference/datatypes/SoftLayer_Container_Notification_Mass_Filter_TemplateKey/_index.md index 632b430522..d6310c9314 100644 --- a/content/reference/datatypes/SoftLayer_Container_Notification_Mass_Filter_TemplateKey/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Notification_Mass_Filter_TemplateKey/_index.md @@ -24,6 +24,8 @@ classes: + +
      diff --git a/content/reference/datatypes/SoftLayer_Container_Notification_Mass_Filter_TemplateValue/_index.md b/content/reference/datatypes/SoftLayer_Container_Notification_Mass_Filter_TemplateValue/_index.md index d04afb9155..f6bfa58589 100644 --- a/content/reference/datatypes/SoftLayer_Container_Notification_Mass_Filter_TemplateValue/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Notification_Mass_Filter_TemplateValue/_index.md @@ -24,6 +24,8 @@ classes: + +
      diff --git a/content/reference/datatypes/SoftLayer_Container_Policy_Acceptance/_index.md b/content/reference/datatypes/SoftLayer_Container_Policy_Acceptance/_index.md index 6c5808e3ae..b0fec7d2dc 100644 --- a/content/reference/datatypes/SoftLayer_Container_Policy_Acceptance/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Policy_Acceptance/_index.md @@ -18,6 +18,8 @@ classes:
      ## Description + + Represents the acceptance status of a Policy. @@ -45,7 +47,8 @@ Represents the acceptance status of a Policy. [acceptedFlag]: #acceptedflag #### [acceptedFlag] Flag to indicate if a policy has been previously accepted. -Type: **boolean** +Type: **boolean** +
      @@ -55,7 +58,8 @@ Flag to indicate if a policy has been previously accepted. [policyName]: #policyname #### [policyName] Name of the policy for which we are representing it's acceptance status. -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ Name of the policy for which we are representing it's acceptance status. [productPolicyAssignmentId]: #productpolicyassignmentid #### [productPolicyAssignmentId] ID of the [SoftLayer_Product_Item_Policy_Assignment]({{}}). -Type: **integer** +Type: **integer** +
      diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Item_Category/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Item_Category/_index.md index e574ac579b..8c2ef1cb1c 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Item_Category/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Item_Category/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Product_Item_Category data type represents a single product item category. @@ -45,7 +47,8 @@ The SoftLayer_Container_Product_Item_Category data type represents a single prod [id]: #id #### [id] identifier for category. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Item_Category_Question_Answer/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Item_Category_Question_Answer/_index.md index c34ef34a44..a99203cc7f 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Item_Category_Question_Answer/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Item_Category_Question_Answer/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Container_Product_Item_Category_Question_Answer data type represen [answer]: #answer #### [answer] The answer to the question. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The answer to the question. [categoryCode]: #categorycode #### [categoryCode] The product item category code. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The product item category code. [categoryId]: #categoryid #### [categoryId] The product item category id. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The product item category id. [questionId]: #questionid #### [questionId] The product item category question id. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Item_Category_ZeroFee_Count/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Item_Category_ZeroFee_Count/_index.md index b46d760c9d..7fd1b327d3 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Item_Category_ZeroFee_Count/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Item_Category_ZeroFee_Count/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Product_Item_Category_ZeroFee_Count data type represents a count of zero fee billing/invoice items. @@ -45,7 +47,8 @@ The SoftLayer_Container_Product_Item_Category_ZeroFee_Count data type represents [categoryCode]: #categorycode #### [categoryCode] The product item category code. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The product item category code. [categoryId]: #categoryid #### [categoryId] The product item category id. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The product item category id. [categoryName]: #categoryname #### [categoryName] The product item category name. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The product item category name. [count]: #count #### [count] The count of zero fee items for this category. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Item_Discount_Program/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Item_Discount_Program/_index.md index 63296046af..741539f152 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Item_Discount_Program/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Item_Discount_Program/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Product_Item_Discount_Program data type represents the information about a discount that is related to a specific product item. @@ -45,7 +47,8 @@ The SoftLayer_Container_Product_Item_Discount_Program data type represents the i [applicableQuantity]: #applicablequantity #### [applicableQuantity] The number of times the item discount(s) may be applied for that order container. At a minimum the number will be 1 and at most, it will match the quantity of the order container. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The number of times the item discount(s) may be applied for that order container [item]: #item #### [item] The product item that the discount applies to. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -65,7 +69,8 @@ The product item that the discount applies to. [oneTimeAmount]: #onetimeamount #### [oneTimeAmount] The sum of the one time fees (one time, setup and labor) of the prices of this container multiplied by the applicable quantity of this container. -Type: **decimal** +Type: **decimal** + @@ -75,7 +80,8 @@ The sum of the one time fees (one time, setup and labor) of the prices of this c [oneTimeTax]: #onetimetax #### [oneTimeTax] The tax amount on the one time fees (one time, setup and labor) of the prices of this container mulitiplied by the applicable quantity of this container. -Type: **decimal** +Type: **decimal** + @@ -85,7 +91,8 @@ The tax amount on the one time fees (one time, setup and labor) of the prices of [prices]: #prices #### [prices] The item prices that contain the amount of the discount in the recurringFee field. There may be one or more prices. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -95,7 +102,8 @@ The item prices that contain the amount of the discount in the recurringFee fiel [proratedOneTimeAmount]: #proratedonetimeamount #### [proratedOneTimeAmount] The sum of the one time fees (one time, setup and labor) of the prices of this container multiplied by the applicable quantity of this container with the proration factor applied. -Type: **decimal** +Type: **decimal** + @@ -105,7 +113,8 @@ The sum of the one time fees (one time, setup and labor) of the prices of this c [proratedOneTimeTax]: #proratedonetimetax #### [proratedOneTimeTax] The tax amount on the one time fees (one time, setup and labor) of the prices of this container mulitiplied by the applicable quantity of this container with the proration factor applied. -Type: **decimal** +Type: **decimal** + @@ -115,7 +124,8 @@ The tax amount on the one time fees (one time, setup and labor) of the prices of [proratedRecurringAmount]: #proratedrecurringamount #### [proratedRecurringAmount] The sum of the recurring fees of the prices of this container multiplied by the applicable quantity of this container with the proration factor applied. -Type: **decimal** +Type: **decimal** + @@ -125,7 +135,8 @@ The sum of the recurring fees of the prices of this container multiplied by the [proratedRecurringTax]: #proratedrecurringtax #### [proratedRecurringTax] The tax amount on the recurring fees of the prices of this container mulitiplied by the applicable quantity of this container with the proration factor applied. -Type: **decimal** +Type: **decimal** + @@ -135,7 +146,8 @@ The tax amount on the recurring fees of the prices of this container mulitiplied [recurringAmount]: #recurringamount #### [recurringAmount] The sum of the recurring fees of the prices of this container multiplied by the applicable quantity of this container. -Type: **decimal** +Type: **decimal** + @@ -145,7 +157,8 @@ The sum of the recurring fees of the prices of this container multiplied by the [recurringTax]: #recurringtax #### [recurringTax] The tax amount on the recurring fees of the prices of this container mulitiplied by the applicable quantity of this container. -Type: **decimal** +Type: **decimal** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order/_index.md index bb0de186d9..977419b5a3 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -547,7 +598,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -587,7 +642,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -627,7 +686,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -643,7 +703,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -653,7 +714,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -663,7 +725,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -673,7 +736,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -683,7 +747,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -693,7 +758,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -713,7 +780,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Account_Media_Data_Transfer_Request/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Account_Media_Data_Transfer_Request/_index.md index cbc4f4f13b..4266b478d3 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Account_Media_Data_Transfer_Request/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Account_Media_Data_Transfer_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This datatype is to be used for data transfer requests. @@ -51,7 +53,8 @@ This datatype is to be used for data transfer requests. [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [request]: #request #### [request] An instance of [SoftLayer_Account_Media_Data_Transfer_Request]({{}}) -Type: **SoftLayer_Account_Media_Data_Transfer_Request ** +Type: **SoftLayer_Account_Media_Data_Transfer_Request ** + @@ -547,7 +598,8 @@ An instance of [SoftLayer_Account_Media_Data_Transfer_Request]({{Type: **integer** +Type: **integer** + @@ -557,7 +609,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -567,7 +620,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -577,7 +631,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -597,7 +653,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -607,7 +664,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -617,7 +675,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -637,7 +697,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -653,7 +714,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -663,7 +725,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -673,7 +736,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -683,7 +747,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -693,7 +758,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -713,7 +780,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -723,7 +791,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -733,7 +802,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Attribute_Address/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Attribute_Address/_index.md index b077bb5939..cdd21ed65e 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Attribute_Address/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Attribute_Address/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [addressLine1]: #addressline1 #### [addressLine1] The physical street address. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The physical street address. [addressLine2]: #addressline2 #### [addressLine2] The second line in the address. Information such as suite number goes here. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The second line in the address. Information such as suite number goes here. [city]: #city #### [city] The city name -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The city name [countryCode]: #countrycode #### [countryCode] The 2-character Country code. (i.e. US) -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The 2-character Country code. (i.e. US) [nonUsState]: #nonusstate #### [nonUsState] State, Region or Province not part of the U.S. or Canada. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ State, Region or Province not part of the U.S. or Canada. [postalCode]: #postalcode #### [postalCode] The Zip or Postal Code. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The Zip or Postal Code. [state]: #state #### [state] U.S. State, Region or Canadian Province. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Attribute_Contact/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Attribute_Contact/_index.md index 4cf632b659..2b064ea47d 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Attribute_Contact/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Attribute_Contact/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [address]: #address #### [address] The address information of the contact. -Type: **SoftLayer_Container_Product_Order_Attribute_Address ** +Type: **SoftLayer_Container_Product_Order_Attribute_Address ** + @@ -55,7 +58,8 @@ The address information of the contact. [emailAddress]: #emailaddress #### [emailAddress] The email address of the contact. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The email address of the contact. [faxNumber]: #faxnumber #### [faxNumber] The fax number associated with a contact. This is an optional value. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The fax number associated with a contact. This is an optional value. [firstName]: #firstname #### [firstName] The first name of the contact. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The first name of the contact. [lastName]: #lastname #### [lastName] The last name of the contact. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The last name of the contact. [organizationName]: #organizationname #### [organizationName] The organization name of the contact. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The organization name of the contact. [phoneNumber]: #phonenumber #### [phoneNumber] The phone number associated with a contact. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The phone number associated with a contact. [title]: #title #### [title] The title of the contact. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Attribute_Organization/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Attribute_Organization/_index.md index f3962f52f2..ee76246793 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Attribute_Organization/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Attribute_Organization/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [address]: #address #### [address] The address information of the contact. -Type: **SoftLayer_Container_Product_Order_Attribute_Address ** +Type: **SoftLayer_Container_Product_Order_Attribute_Address ** + @@ -55,7 +58,8 @@ The address information of the contact. [faxNumber]: #faxnumber #### [faxNumber] The fax number associated with an organization. This is an optional value. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The fax number associated with an organization. This is an optional value. [organizationName]: #organizationname #### [organizationName] The name of an organization. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The name of an organization. [phoneNumber]: #phonenumber #### [phoneNumber] The phone number associated with an organization. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Billing_Information/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Billing_Information/_index.md index c058318907..cc01006313 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Billing_Information/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Billing_Information/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [billingAddressLine1]: #billingaddressline1 #### [billingAddressLine1] The physical street address. Reserve information such as "apartment #123" or "Suite 2" for line 1. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The physical street address. Reserve information such as "apartment #123" or "Su [billingAddressLine2]: #billingaddressline2 #### [billingAddressLine2] The second line in the address. Information such as suite number goes here. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The second line in the address. Information such as suite number goes here. [billingCity]: #billingcity #### [billingCity] The city in which a customer's account resides. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The city in which a customer's account resides. [billingCountryCode]: #billingcountrycode #### [billingCountryCode] The 2-character Country code for an account's address. (i.e. US) -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The 2-character Country code for an account's address. (i.e. US) [billingEmail]: #billingemail #### [billingEmail] The email address associated with a customer account. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The email address associated with a customer account. [billingNameCompany]: #billingnamecompany #### [billingNameCompany] the company name for an account. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ the company name for an account. [billingNameFirst]: #billingnamefirst #### [billingNameFirst] The first name of the customer account owner. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The first name of the customer account owner. [billingNameLast]: #billingnamelast #### [billingNameLast] The last name of the customer account owner -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The last name of the customer account owner [billingPhoneFax]: #billingphonefax #### [billingPhoneFax] The fax number associated with a customer account. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The fax number associated with a customer account. [billingPhoneVoice]: #billingphonevoice #### [billingPhoneVoice] The phone number associated with a customer account. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The phone number associated with a customer account. [billingPostalCode]: #billingpostalcode #### [billingPostalCode] The Zip or Postal Code for the billing address on an account. -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ The Zip or Postal Code for the billing address on an account. [billingState]: #billingstate #### [billingState] The State for the account. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ The State for the account. [cardAccountNumber]: #cardaccountnumber #### [cardAccountNumber] The credit card number to use. -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ The credit card number to use. [cardExpirationMonth]: #cardexpirationmonth #### [cardExpirationMonth] The payment card expiration month -Type: **integer** +Type: **integer** + @@ -185,7 +201,8 @@ The payment card expiration month [cardExpirationYear]: #cardexpirationyear #### [cardExpirationYear] The payment card expiration year -Type: **integer** +Type: **integer** + @@ -195,7 +212,8 @@ The payment card expiration year [creditCardVerificationNumber]: #creditcardverificationnumber #### [creditCardVerificationNumber] The Card Verification Value Code (CVV) number -Type: **string** +Type: **string** + @@ -205,7 +223,8 @@ The Card Verification Value Code (CVV) number [euSupported]: #eusupported #### [euSupported] 1 = opted in, 0 = not opted in. Select the EU Supported option if you use IBM Bluemix Infrastructure services to process EU citizens' personal data. This option limits Level 1 and Level 2 support to the EU. However, IBM Bluemix and SoftLayer teams outside the EU perform processing activities when they are not resolved at Level 1 or 2. These activities are always at your instruction and do not impact the security or privacy of your data. As with our standard services, you must review the impact these cross-border processing activities have on your services and take any necessary measures, including review of IBM's US-EU Privacy Shield registration and Data Processing Addendum. If you select products, services, or locations outside the EU, all processing activities will be performed outside of the EU. If you select other IBM services in addition to Bluemix IaaS (IBM or a third party), determine the service location in order to meet any additional data protection or processing requirements that permit cross-border transfers. -Type: **boolean** +Type: **boolean** + @@ -215,7 +234,8 @@ The Card Verification Value Code (CVV) number [isBusinessFlag]: #isbusinessflag #### [isBusinessFlag] If true, order is being placed by a business. -Type: **boolean** +Type: **boolean** + @@ -227,7 +247,8 @@ If true, order is being placed by a business. The purpose of this property is to allow enablement of 3D Secure (3DS). This is the Reference ID that corresponds to the device data for Payer Authentication. In order to properly enable 3DS, this will require implementation of Cardinal Cruise Hybrid. Please refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under "DFReferenceId / ReferenceId" to populate this property accordingly. -Type: **string** +Type: **string** + @@ -239,7 +260,8 @@ Please refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/C "Continue with Consumer Authentication" decoded response JWT (JSON Web Token) after successful authentication. The response is part of the implementation of Cardinal Cruise Hybrid. Please refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under "Continue with Consumer Authentication" to populate this property accordingly based on the CCA response. -Type: **string** +Type: **string** + @@ -249,7 +271,8 @@ Please refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/C [taxExempt]: #taxexempt #### [taxExempt] Tax exempt status. 1 = exempt (not taxable), 0 = not exempt (taxable) -Type: **integer** +Type: **integer** + @@ -259,7 +282,8 @@ Tax exempt status. 1 = exempt (not taxable), 0 = not exempt (taxable) [vatId]: #vatid #### [vatId] The VAT ID entered at checkout -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Registration/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Registration/_index.md index c600090b2f..9ba7c19eb1 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Registration/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Registration/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. The SoftLayer_Container_Product_Order_Dns_Domain_Registration datatype contains everything required to place a domain registration order with SoftLayer. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [administrativeContact]: #administrativecontact #### [administrativeContact] Administrative contact information associated with an registraton or transfer. This is required if registration type is 'new' or 'transfer'. -Type: **SoftLayer_Container_Dns_Domain_Registration_Contact ** +Type: **SoftLayer_Container_Dns_Domain_Registration_Contact ** + @@ -61,7 +64,8 @@ Administrative contact information associated with an registraton or transfer. T [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -71,7 +75,8 @@ Flag for identifying an order for Big Data Deployment. [billingContact]: #billingcontact #### [billingContact] Billing contact information associated with an registraton or transfer. This is required if registration type is 'new' or 'transfer'. -Type: **SoftLayer_Container_Dns_Domain_Registration_Contact ** +Type: **SoftLayer_Container_Dns_Domain_Registration_Contact ** + @@ -81,7 +86,8 @@ Billing contact information associated with an registraton or transfer. This is [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -91,7 +97,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ This has been deprecated. It is the identifier used to track configurations in l [domainRegistrationList]: #domainregistrationlist #### [domainRegistrationList] The list of domains to be registered. This is required if registration type is 'new', 'renew', or 'transfer'. -Type: **SoftLayer_Container_Dns_Domain_Registration_List[] ** +Type: **SoftLayer_Container_Dns_Domain_Registration_List[] ** + @@ -171,7 +185,8 @@ The list of domains to be registered. This is required if registration type is ' [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ The list of domains to be registered. This is required if registration type is ' [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -191,7 +207,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -211,7 +229,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -231,7 +251,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -241,7 +262,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -251,7 +273,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -261,7 +284,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -271,7 +295,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -283,7 +308,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -293,7 +319,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -303,7 +330,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -313,7 +341,8 @@ Collection of exceptions resulting from the verification of the order. This valu [ownerContact]: #ownercontact #### [ownerContact] Owner contact information associated with an registraton or transfer. This is required if registration type is 'new' or 'transfer'. -Type: **SoftLayer_Container_Dns_Domain_Registration_Contact ** +Type: **SoftLayer_Container_Dns_Domain_Registration_Contact ** + @@ -323,7 +352,8 @@ Owner contact information associated with an registraton or transfer. This is re [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -333,7 +363,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -343,7 +374,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -423,7 +462,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -433,7 +473,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -443,7 +484,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -453,7 +495,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -463,7 +506,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -473,7 +517,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -483,7 +528,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -493,7 +539,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -503,7 +550,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -513,7 +561,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -523,7 +572,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -533,7 +583,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -543,7 +594,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -553,7 +605,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -567,7 +620,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [registrationType]: #registrationtype #### [registrationType] The type of a domain registration order. The registration type is Required. Allowed values are new, transfer, and renew -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ The type of a domain registration order. The registration type is Required. Allo [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -627,7 +686,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -637,7 +697,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -647,7 +708,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -657,7 +719,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -667,7 +730,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -677,7 +741,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -693,7 +758,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -703,7 +769,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -713,7 +780,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -733,7 +802,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [technicalContact]: #technicalcontact #### [technicalContact] Technical contact information associated with an registraton or transfer. This is required if registration type is 'new' or 'transfer'. -Type: **SoftLayer_Container_Dns_Domain_Registration_Contact ** +Type: **SoftLayer_Container_Dns_Domain_Registration_Contact ** + @@ -743,7 +813,8 @@ Technical contact information associated with an registraton or transfer. This i [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -753,7 +824,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -763,7 +835,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -773,7 +846,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -783,7 +857,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Reseller/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Reseller/_index.md index 7675717af9..571c4c4319 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Reseller/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Reseller/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. The SoftLayer_Container_Product_Order_Dns_Domain_Reseller datatype contains everything required to place a domain reseller credit order with SoftLayer. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [creditAmount]: #creditamount #### [creditAmount] Amount to be credited to the domain reseller account. -Type: **decimal** +Type: **decimal** + @@ -121,7 +130,8 @@ Amount to be credited to the domain reseller account. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -161,7 +174,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -171,7 +185,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -191,7 +207,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -221,7 +240,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -231,7 +251,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -251,7 +273,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -263,7 +286,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -273,7 +297,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -283,7 +308,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -293,7 +319,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -303,7 +330,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -313,7 +341,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -403,7 +440,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -413,7 +451,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -423,7 +462,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -433,7 +473,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -443,7 +484,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -453,7 +495,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -473,7 +517,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -483,7 +528,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -503,7 +550,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -513,7 +561,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -523,7 +572,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -547,7 +598,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -557,7 +609,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -567,7 +620,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -577,7 +631,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -597,7 +653,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -607,7 +664,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -617,7 +675,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -637,7 +697,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -653,7 +714,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -663,7 +725,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -673,7 +736,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -683,7 +747,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -693,7 +758,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -713,7 +780,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -723,7 +791,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -733,7 +802,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Gateway_Appliance_Cluster/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Gateway_Appliance_Cluster/_index.md index 1618b2c7d1..cc53eb18d3 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Gateway_Appliance_Cluster/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Gateway_Appliance_Cluster/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [clusterIdentifier]: #clusteridentifier #### [clusterIdentifier] Used to identify which items on an order belong in the same cluster. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ Used to identify which items on an order belong in the same cluster. [clusterOrderType]: #clusterordertype #### [clusterOrderType] Indicates what type of cluster order is being placed (HA, Provision). -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ Indicates what type of cluster order is being placed (HA, Provision). [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -181,7 +196,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -191,7 +207,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -201,7 +218,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -211,7 +229,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -221,7 +240,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -231,7 +251,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -241,7 +262,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -251,7 +273,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -261,7 +284,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -273,7 +297,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -283,7 +308,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -293,7 +319,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -303,7 +330,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -313,7 +341,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -323,7 +352,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -413,7 +451,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -433,7 +473,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -443,7 +484,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -453,7 +495,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -463,7 +506,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -473,7 +517,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -483,7 +528,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -493,7 +539,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -503,7 +550,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -513,7 +561,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -523,7 +572,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -533,7 +583,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -547,7 +598,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -587,7 +642,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -597,7 +653,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -607,7 +664,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -627,7 +686,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -637,7 +697,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -647,7 +708,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -663,7 +725,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -673,7 +736,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -683,7 +747,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -693,7 +758,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -703,7 +769,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -713,7 +780,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -723,7 +791,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -733,7 +802,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -743,7 +813,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Gateway_Appliance_Upgrade/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Gateway_Appliance_Upgrade/_index.md index 8174dc723c..de3b92e4af 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Gateway_Appliance_Upgrade/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Gateway_Appliance_Upgrade/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}). @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{}}) being upgraded. -Type: **integer** +Type: **integer** + @@ -171,7 +185,8 @@ Identifier for the [SoftLayer_Network_Gateway]({{Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -191,7 +207,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -221,7 +240,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -231,7 +251,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -251,7 +273,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -263,7 +286,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -273,7 +297,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -283,7 +308,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -293,7 +319,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -303,7 +330,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -313,7 +341,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -403,7 +440,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -413,7 +451,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -423,7 +462,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -433,7 +473,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -443,7 +484,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -453,7 +495,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -473,7 +517,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -483,7 +528,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -503,7 +550,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -513,7 +561,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -523,7 +572,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -547,7 +598,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -557,7 +609,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -567,7 +620,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -577,7 +631,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -597,7 +653,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -607,7 +664,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -617,7 +675,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -637,7 +697,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -653,7 +714,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -663,7 +725,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -673,7 +736,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -683,7 +747,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -693,7 +758,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -713,7 +780,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -723,7 +791,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -733,7 +802,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Security_Module/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Security_Module/_index.md index a19246bbd7..48e8c47422 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Security_Module/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Security_Module/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ Used to identify which category should be used for the boot disk. [cancelUrl]: #cancelurl #### [cancelUrl] The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [clusterIdentifier]: #clusteridentifier #### [clusterIdentifier] Used to identify which items on an order belong in the same cluster. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ Used to identify which items on an order belong in the same cluster. [clusterOrderType]: #clusterordertype #### [clusterOrderType] Indicates what type of cluster order is being placed (HA, Provision). -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ Indicates what type of cluster order is being placed (HA, Provision). [clusterResourceId]: #clusterresourceid #### [clusterResourceId] Used to identify which gateway is being upgraded to HA. -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ Used to identify which gateway is being upgraded to HA. [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -171,7 +185,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ This has been deprecated. It is the identifier used to track configurations in l [driveDestructionDisks]: #drivedestructiondisks #### [driveDestructionDisks] Array of disk drive slot categories to destroy on reclaim. For example: ['disk0', 'disk1', 'disk2']. One drive_destruction price must be included for each slot provided. Note that once the initial order or upgrade order are approved, the destruction property is not removable and the drives will be destroyed at the end of the server's lifecycle. Not all drive slots are required, but all can be provided. -Type: **array of strings** +Type: **array of strings** + @@ -191,7 +207,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -211,7 +229,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -221,7 +240,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -231,7 +251,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -251,7 +273,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -261,7 +284,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -271,7 +295,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -281,7 +306,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -291,7 +317,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -301,7 +328,8 @@ A generic message about the order. Does not need to be sent in with any orders. [monitoringAgentConfigurationTemplateGroupId]: #monitoringagentconfigurationtemplategroupid #### [monitoringAgentConfigurationTemplateGroupId] Id used with the monitoring package. (Deprecated) -Type: **integer** +Type: **integer** + @@ -313,7 +341,8 @@ Id used with the monitoring package. (Deprecated) Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -323,7 +352,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -333,7 +363,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -343,7 +374,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -353,7 +385,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -363,7 +396,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -423,7 +462,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -433,7 +473,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -443,7 +484,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -453,7 +495,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -463,7 +506,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -473,7 +517,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -483,7 +528,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -493,7 +539,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -503,7 +550,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -513,7 +561,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [privateCloudServerRole]: #privatecloudserverrole #### [privateCloudServerRole] When ordering Virtual Server (Private Node), this variable specifies the role of the server configuration. (Deprecated) -Type: **string** +Type: **string** + @@ -523,7 +572,8 @@ When ordering Virtual Server (Private Node), this variable specifies the role of [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -533,7 +583,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -543,7 +594,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -553,7 +605,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -563,7 +616,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -573,7 +627,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -583,7 +638,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -597,7 +653,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [requiredUpstreamDeviceId]: #requiredupstreamdeviceid #### [requiredUpstreamDeviceId] Used to identify which device the new server should be attached to. -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ Used to identify which device the new server should be attached to. [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -637,7 +697,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -647,7 +708,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -657,7 +719,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -667,7 +730,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -677,7 +741,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -687,7 +752,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -697,7 +763,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -707,7 +774,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -723,7 +791,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -733,7 +802,8 @@ The first storage group in this array will be considered the primary storage gro [tags]: #tags #### [tags] tags (used in MongoDB deployments). (Deprecated) -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -743,7 +813,8 @@ tags (used in MongoDB deployments). (Deprecated) [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -753,7 +824,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -763,7 +835,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -773,7 +846,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -783,7 +857,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -793,7 +868,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -803,7 +879,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -813,7 +890,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server/_index.md index 7e59d21b06..f9f5c0419b 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ Used to identify which category should be used for the boot disk. [cancelUrl]: #cancelurl #### [cancelUrl] The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [clusterIdentifier]: #clusteridentifier #### [clusterIdentifier] Used to identify which items on an order belong in the same cluster. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ Used to identify which items on an order belong in the same cluster. [clusterOrderType]: #clusterordertype #### [clusterOrderType] Indicates what type of cluster order is being placed (HA, Provision). -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ Indicates what type of cluster order is being placed (HA, Provision). [clusterResourceId]: #clusterresourceid #### [clusterResourceId] Used to identify which gateway is being upgraded to HA. -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ Used to identify which gateway is being upgraded to HA. [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -171,7 +185,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ This has been deprecated. It is the identifier used to track configurations in l [driveDestructionDisks]: #drivedestructiondisks #### [driveDestructionDisks] Array of disk drive slot categories to destroy on reclaim. For example: ['disk0', 'disk1', 'disk2']. One drive_destruction price must be included for each slot provided. Note that once the initial order or upgrade order are approved, the destruction property is not removable and the drives will be destroyed at the end of the server's lifecycle. Not all drive slots are required, but all can be provided. -Type: **array of strings** +Type: **array of strings** + @@ -191,7 +207,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -211,7 +229,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -221,7 +240,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -231,7 +251,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -251,7 +273,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -261,7 +284,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -271,7 +295,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -281,7 +306,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -291,7 +317,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -301,7 +328,8 @@ A generic message about the order. Does not need to be sent in with any orders. [monitoringAgentConfigurationTemplateGroupId]: #monitoringagentconfigurationtemplategroupid #### [monitoringAgentConfigurationTemplateGroupId] Id used with the monitoring package. (Deprecated) -Type: **integer** +Type: **integer** + @@ -313,7 +341,8 @@ Id used with the monitoring package. (Deprecated) Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -323,7 +352,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -333,7 +363,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -343,7 +374,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -353,7 +385,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -363,7 +396,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -423,7 +462,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -433,7 +473,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -443,7 +484,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -453,7 +495,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -463,7 +506,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -473,7 +517,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -483,7 +528,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -493,7 +539,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -503,7 +550,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -513,7 +561,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [privateCloudServerRole]: #privatecloudserverrole #### [privateCloudServerRole] When ordering Virtual Server (Private Node), this variable specifies the role of the server configuration. (Deprecated) -Type: **string** +Type: **string** + @@ -523,7 +572,8 @@ When ordering Virtual Server (Private Node), this variable specifies the role of [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -533,7 +583,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -543,7 +594,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -553,7 +605,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -563,7 +616,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -573,7 +627,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -583,7 +638,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -597,7 +653,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [requiredUpstreamDeviceId]: #requiredupstreamdeviceid #### [requiredUpstreamDeviceId] Used to identify which device the new server should be attached to. -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ Used to identify which device the new server should be attached to. [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -637,7 +697,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -647,7 +708,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -657,7 +719,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -667,7 +730,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -677,7 +741,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -687,7 +752,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -697,7 +763,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -707,7 +774,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -723,7 +791,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -733,7 +802,8 @@ The first storage group in this array will be considered the primary storage gro [tags]: #tags #### [tags] tags (used in MongoDB deployments). (Deprecated) -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -743,7 +813,8 @@ tags (used in MongoDB deployments). (Deprecated) [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -753,7 +824,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -763,7 +835,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -773,7 +846,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -783,7 +857,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -793,7 +868,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -803,7 +879,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -813,7 +890,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Colocation/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Colocation/_index.md index b3e27ed86d..01e8086685 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Colocation/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Colocation/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ Used to identify which category should be used for the boot disk. [cancelUrl]: #cancelurl #### [cancelUrl] The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [clusterIdentifier]: #clusteridentifier #### [clusterIdentifier] Used to identify which items on an order belong in the same cluster. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ Used to identify which items on an order belong in the same cluster. [clusterOrderType]: #clusterordertype #### [clusterOrderType] Indicates what type of cluster order is being placed (HA, Provision). -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ Indicates what type of cluster order is being placed (HA, Provision). [clusterResourceId]: #clusterresourceid #### [clusterResourceId] Used to identify which gateway is being upgraded to HA. -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ Used to identify which gateway is being upgraded to HA. [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -171,7 +185,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ This has been deprecated. It is the identifier used to track configurations in l [driveDestructionDisks]: #drivedestructiondisks #### [driveDestructionDisks] Array of disk drive slot categories to destroy on reclaim. For example: ['disk0', 'disk1', 'disk2']. One drive_destruction price must be included for each slot provided. Note that once the initial order or upgrade order are approved, the destruction property is not removable and the drives will be destroyed at the end of the server's lifecycle. Not all drive slots are required, but all can be provided. -Type: **array of strings** +Type: **array of strings** + @@ -191,7 +207,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -211,7 +229,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -221,7 +240,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -231,7 +251,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -251,7 +273,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -261,7 +284,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -271,7 +295,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -281,7 +306,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -291,7 +317,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -301,7 +328,8 @@ A generic message about the order. Does not need to be sent in with any orders. [monitoringAgentConfigurationTemplateGroupId]: #monitoringagentconfigurationtemplategroupid #### [monitoringAgentConfigurationTemplateGroupId] Id used with the monitoring package. (Deprecated) -Type: **integer** +Type: **integer** + @@ -313,7 +341,8 @@ Id used with the monitoring package. (Deprecated) Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -323,7 +352,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -333,7 +363,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -343,7 +374,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -353,7 +385,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -363,7 +396,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -423,7 +462,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -433,7 +473,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -443,7 +484,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -453,7 +495,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -463,7 +506,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -473,7 +517,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -483,7 +528,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -493,7 +539,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -503,7 +550,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -513,7 +561,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [privateCloudServerRole]: #privatecloudserverrole #### [privateCloudServerRole] When ordering Virtual Server (Private Node), this variable specifies the role of the server configuration. (Deprecated) -Type: **string** +Type: **string** + @@ -523,7 +572,8 @@ When ordering Virtual Server (Private Node), this variable specifies the role of [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -533,7 +583,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -543,7 +594,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -553,7 +605,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -563,7 +616,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -573,7 +627,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -583,7 +638,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -597,7 +653,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [requiredUpstreamDeviceId]: #requiredupstreamdeviceid #### [requiredUpstreamDeviceId] Used to identify which device the new server should be attached to. -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ Used to identify which device the new server should be attached to. [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -637,7 +697,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -647,7 +708,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -657,7 +719,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -667,7 +730,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -677,7 +741,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -687,7 +752,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -697,7 +763,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -707,7 +774,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -723,7 +791,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -733,7 +802,8 @@ The first storage group in this array will be considered the primary storage gro [tags]: #tags #### [tags] tags (used in MongoDB deployments). (Deprecated) -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -743,7 +813,8 @@ tags (used in MongoDB deployments). (Deprecated) [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -753,7 +824,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -763,7 +835,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -773,7 +846,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -783,7 +857,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -793,7 +868,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -803,7 +879,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -813,7 +890,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Gateway_Appliance/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Gateway_Appliance/_index.md index 2804242402..59e41f864d 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Gateway_Appliance/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Gateway_Appliance/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ Used to identify which category should be used for the boot disk. [cancelUrl]: #cancelurl #### [cancelUrl] The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [clusterIdentifier]: #clusteridentifier #### [clusterIdentifier] Used to identify which items on an order belong in the same cluster. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ Used to identify which items on an order belong in the same cluster. [clusterOrderType]: #clusterordertype #### [clusterOrderType] Indicates what type of cluster order is being placed (HA, Provision). -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ Indicates what type of cluster order is being placed (HA, Provision). [clusterResourceId]: #clusterresourceid #### [clusterResourceId] Used to identify which gateway is being upgraded to HA. -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ Used to identify which gateway is being upgraded to HA. [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -171,7 +185,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ This has been deprecated. It is the identifier used to track configurations in l [driveDestructionDisks]: #drivedestructiondisks #### [driveDestructionDisks] Array of disk drive slot categories to destroy on reclaim. For example: ['disk0', 'disk1', 'disk2']. One drive_destruction price must be included for each slot provided. Note that once the initial order or upgrade order are approved, the destruction property is not removable and the drives will be destroyed at the end of the server's lifecycle. Not all drive slots are required, but all can be provided. -Type: **array of strings** +Type: **array of strings** + @@ -191,7 +207,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -211,7 +229,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -221,7 +240,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -231,7 +251,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -251,7 +273,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -261,7 +284,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -271,7 +295,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -281,7 +306,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -291,7 +317,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -301,7 +328,8 @@ A generic message about the order. Does not need to be sent in with any orders. [monitoringAgentConfigurationTemplateGroupId]: #monitoringagentconfigurationtemplategroupid #### [monitoringAgentConfigurationTemplateGroupId] Id used with the monitoring package. (Deprecated) -Type: **integer** +Type: **integer** + @@ -313,7 +341,8 @@ Id used with the monitoring package. (Deprecated) Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -323,7 +352,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -333,7 +363,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -343,7 +374,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -353,7 +385,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -363,7 +396,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -423,7 +462,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -433,7 +473,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -443,7 +484,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -453,7 +495,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -463,7 +506,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -473,7 +517,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -483,7 +528,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -493,7 +539,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -503,7 +550,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -513,7 +561,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [privateCloudServerRole]: #privatecloudserverrole #### [privateCloudServerRole] When ordering Virtual Server (Private Node), this variable specifies the role of the server configuration. (Deprecated) -Type: **string** +Type: **string** + @@ -523,7 +572,8 @@ When ordering Virtual Server (Private Node), this variable specifies the role of [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -533,7 +583,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -543,7 +594,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -553,7 +605,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -563,7 +616,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -573,7 +627,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -583,7 +638,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -597,7 +653,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [requiredUpstreamDeviceId]: #requiredupstreamdeviceid #### [requiredUpstreamDeviceId] Used to identify which device the new server should be attached to. -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ Used to identify which device the new server should be attached to. [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -637,7 +697,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -647,7 +708,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -657,7 +719,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -667,7 +730,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -677,7 +741,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -687,7 +752,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -697,7 +763,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -707,7 +774,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -723,7 +791,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -733,7 +802,8 @@ The first storage group in this array will be considered the primary storage gro [tags]: #tags #### [tags] tags (used in MongoDB deployments). (Deprecated) -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -743,7 +813,8 @@ tags (used in MongoDB deployments). (Deprecated) [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -753,7 +824,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -763,7 +835,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -773,7 +846,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -783,7 +857,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -793,7 +868,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -803,7 +879,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -813,7 +890,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Upgrade/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Upgrade/_index.md index c9096c706a..6a3bb56356 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Upgrade/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Upgrade/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ Used to identify which category should be used for the boot disk. [cancelUrl]: #cancelurl #### [cancelUrl] The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [clusterIdentifier]: #clusteridentifier #### [clusterIdentifier] Used to identify which items on an order belong in the same cluster. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ Used to identify which items on an order belong in the same cluster. [clusterOrderType]: #clusterordertype #### [clusterOrderType] Indicates what type of cluster order is being placed (HA, Provision). -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ Indicates what type of cluster order is being placed (HA, Provision). [clusterResourceId]: #clusterresourceid #### [clusterResourceId] Used to identify which gateway is being upgraded to HA. -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ Used to identify which gateway is being upgraded to HA. [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -171,7 +185,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ This has been deprecated. It is the identifier used to track configurations in l [driveDestructionDisks]: #drivedestructiondisks #### [driveDestructionDisks] Array of disk drive slot categories to destroy on reclaim. For example: ['disk0', 'disk1', 'disk2']. One drive_destruction price must be included for each slot provided. Note that once the initial order or upgrade order are approved, the destruction property is not removable and the drives will be destroyed at the end of the server's lifecycle. Not all drive slots are required, but all can be provided. -Type: **array of strings** +Type: **array of strings** + @@ -191,7 +207,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -211,7 +229,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -221,7 +240,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -231,7 +251,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -251,7 +273,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -261,7 +284,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -271,7 +295,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -281,7 +306,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -291,7 +317,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -301,7 +328,8 @@ A generic message about the order. Does not need to be sent in with any orders. [monitoringAgentConfigurationTemplateGroupId]: #monitoringagentconfigurationtemplategroupid #### [monitoringAgentConfigurationTemplateGroupId] Id used with the monitoring package. (Deprecated) -Type: **integer** +Type: **integer** + @@ -313,7 +341,8 @@ Id used with the monitoring package. (Deprecated) Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -323,7 +352,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -333,7 +363,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -343,7 +374,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -353,7 +385,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -363,7 +396,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -423,7 +462,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -433,7 +473,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -443,7 +484,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -453,7 +495,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -463,7 +506,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -473,7 +517,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -483,7 +528,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -493,7 +539,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -503,7 +550,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -513,7 +561,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [privateCloudServerRole]: #privatecloudserverrole #### [privateCloudServerRole] When ordering Virtual Server (Private Node), this variable specifies the role of the server configuration. (Deprecated) -Type: **string** +Type: **string** + @@ -523,7 +572,8 @@ When ordering Virtual Server (Private Node), this variable specifies the role of [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -533,7 +583,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -543,7 +594,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -553,7 +605,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -563,7 +616,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -573,7 +627,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -583,7 +638,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -597,7 +653,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [requiredUpstreamDeviceId]: #requiredupstreamdeviceid #### [requiredUpstreamDeviceId] Used to identify which device the new server should be attached to. -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ Used to identify which device the new server should be attached to. [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -637,7 +697,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -647,7 +708,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -657,7 +719,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -667,7 +730,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -677,7 +741,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -687,7 +752,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -697,7 +763,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -707,7 +774,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -723,7 +791,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -733,7 +802,8 @@ The first storage group in this array will be considered the primary storage gro [tags]: #tags #### [tags] tags (used in MongoDB deployments). (Deprecated) -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -743,7 +813,8 @@ tags (used in MongoDB deployments). (Deprecated) [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -753,7 +824,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -763,7 +835,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -773,7 +846,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -783,7 +857,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -793,7 +868,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -803,7 +879,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -813,7 +890,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Upgrade_MigrateToReserved/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Upgrade_MigrateToReserved/_index.md index 88c8d3e27e..77ddf632fd 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Upgrade_MigrateToReserved/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Upgrade_MigrateToReserved/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -53,7 +55,8 @@ Use this datatype to upgrade your existing monthly-billed server to term based p [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -63,7 +66,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -73,7 +77,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -83,7 +88,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -93,7 +99,8 @@ Used to identify which category should be used for the boot disk. [cancelUrl]: #cancelurl #### [cancelUrl] The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment. -Type: **string** +Type: **string** + @@ -103,7 +110,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [clusterIdentifier]: #clusteridentifier #### [clusterIdentifier] Used to identify which items on an order belong in the same cluster. -Type: **string** +Type: **string** + @@ -113,7 +121,8 @@ Used to identify which items on an order belong in the same cluster. [clusterOrderType]: #clusterordertype #### [clusterOrderType] Indicates what type of cluster order is being placed (HA, Provision). -Type: **string** +Type: **string** + @@ -123,7 +132,8 @@ Indicates what type of cluster order is being placed (HA, Provision). [clusterResourceId]: #clusterresourceid #### [clusterResourceId] Used to identify which gateway is being upgraded to HA. -Type: **integer** +Type: **integer** + @@ -133,7 +143,8 @@ Used to identify which gateway is being upgraded to HA. [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -143,7 +154,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -153,7 +165,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -163,7 +176,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -173,7 +187,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -183,7 +198,8 @@ This has been deprecated. It is the identifier used to track configurations in l [driveDestructionDisks]: #drivedestructiondisks #### [driveDestructionDisks] Array of disk drive slot categories to destroy on reclaim. For example: ['disk0', 'disk1', 'disk2']. One drive_destruction price must be included for each slot provided. Note that once the initial order or upgrade order are approved, the destruction property is not removable and the drives will be destroyed at the end of the server's lifecycle. Not all drive slots are required, but all can be provided. -Type: **array of strings** +Type: **array of strings** + @@ -193,7 +209,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -203,7 +220,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -213,7 +231,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -223,7 +242,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -233,7 +253,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -243,7 +264,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -253,7 +275,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -263,7 +286,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -273,7 +297,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -283,7 +308,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -293,7 +319,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ A generic message about the order. Does not need to be sent in with any orders. [monitoringAgentConfigurationTemplateGroupId]: #monitoringagentconfigurationtemplategroupid #### [monitoringAgentConfigurationTemplateGroupId] Id used with the monitoring package. (Deprecated) -Type: **integer** +Type: **integer** + @@ -315,7 +343,8 @@ Id used with the monitoring package. (Deprecated) Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -325,7 +354,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -335,7 +365,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -345,7 +376,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -355,7 +387,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -365,7 +398,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -375,7 +409,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -385,7 +420,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -395,7 +431,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -405,7 +442,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -415,7 +453,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -425,7 +464,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -435,7 +475,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -445,7 +486,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -455,7 +497,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -465,7 +508,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -475,7 +519,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -485,7 +530,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -495,7 +541,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -505,7 +552,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -515,7 +563,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [privateCloudServerRole]: #privatecloudserverrole #### [privateCloudServerRole] When ordering Virtual Server (Private Node), this variable specifies the role of the server configuration. (Deprecated) -Type: **string** +Type: **string** + @@ -525,7 +574,8 @@ When ordering Virtual Server (Private Node), this variable specifies the role of [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -535,7 +585,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -545,7 +596,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -555,7 +607,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -565,7 +618,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -575,7 +629,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -585,7 +640,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -599,7 +655,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -609,7 +666,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [requiredUpstreamDeviceId]: #requiredupstreamdeviceid #### [requiredUpstreamDeviceId] Used to identify which device the new server should be attached to. -Type: **integer** +Type: **integer** + @@ -619,7 +677,8 @@ Used to identify which device the new server should be attached to. [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -629,7 +688,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -639,7 +699,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -649,7 +710,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -659,7 +721,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -669,7 +732,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -679,7 +743,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -689,7 +754,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -699,7 +765,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -709,7 +776,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -725,7 +793,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -735,7 +804,8 @@ The first storage group in this array will be considered the primary storage gro [tags]: #tags #### [tags] tags (used in MongoDB deployments). (Deprecated) -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -745,7 +815,8 @@ tags (used in MongoDB deployments). (Deprecated) [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -755,7 +826,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -765,7 +837,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -775,7 +848,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [termLength]: #termlength #### [termLength] -Type: **integer** +Type: **integer** + @@ -785,7 +859,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [termStartDate]: #termstartdate #### [termStartDate] -Type: **dateTime** +Type: **dateTime** + @@ -795,7 +870,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -805,7 +881,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -815,7 +892,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -825,7 +903,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -835,7 +914,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Vpc/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Vpc/_index.md index fb6032548c..9119d32e60 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Vpc/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server_Vpc/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** +
      @@ -55,7 +58,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** +
      @@ -65,7 +69,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ Used to identify which category should be used for the boot disk. [cancelUrl]: #cancelurl #### [cancelUrl] The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [clusterIdentifier]: #clusteridentifier #### [clusterIdentifier] Used to identify which items on an order belong in the same cluster. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ Used to identify which items on an order belong in the same cluster. [clusterOrderType]: #clusterordertype #### [clusterOrderType] Indicates what type of cluster order is being placed (HA, Provision). -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ Indicates what type of cluster order is being placed (HA, Provision). [clusterResourceId]: #clusterresourceid #### [clusterResourceId] Used to identify which gateway is being upgraded to HA. -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ Used to identify which gateway is being upgraded to HA. [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ This hash is internally-generated and is used to for tracking order containers. [crn]: #crn #### [crn] -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ This has been deprecated. It is the identifier used to track configurations in l [driveDestructionDisks]: #drivedestructiondisks #### [driveDestructionDisks] Array of disk drive slot categories to destroy on reclaim. For example: ['disk0', 'disk1', 'disk2']. One drive_destruction price must be included for each slot provided. Note that once the initial order or upgrade order are approved, the destruction property is not removable and the drives will be destroyed at the end of the server's lifecycle. Not all drive slots are required, but all can be provided. -Type: **array of strings** +Type: **array of strings** + @@ -195,7 +212,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -205,7 +223,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -215,7 +234,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -225,7 +245,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -235,7 +256,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -245,7 +267,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -255,7 +278,8 @@ An optional virtual disk image template identifier to be used as an installation [instanceProfile]: #instanceprofile #### [instanceProfile] -Type: **string** +Type: **string** + @@ -265,7 +289,8 @@ An optional virtual disk image template identifier to be used as an installation [ipAllocations]: #ipallocations #### [ipAllocations] -Type: **SoftLayer_Container_Product_Order_Vpc_IpAllocation[] ** +Type: **SoftLayer_Container_Product_Order_Vpc_IpAllocation[] ** + @@ -275,7 +300,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -285,7 +311,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -295,7 +322,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -305,7 +333,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -315,7 +344,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -325,7 +355,8 @@ A generic message about the order. Does not need to be sent in with any orders. [monitoringAgentConfigurationTemplateGroupId]: #monitoringagentconfigurationtemplategroupid #### [monitoringAgentConfigurationTemplateGroupId] Id used with the monitoring package. (Deprecated) -Type: **integer** +Type: **integer** + @@ -337,7 +368,8 @@ Id used with the monitoring package. (Deprecated) Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -347,7 +379,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -357,7 +390,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -367,7 +401,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -377,7 +412,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -387,7 +423,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -397,7 +434,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -407,7 +445,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -417,7 +456,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -427,7 +467,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -437,7 +478,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -447,7 +489,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -457,7 +500,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -467,7 +511,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -477,7 +522,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -487,7 +533,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -497,7 +544,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -507,7 +555,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -517,7 +566,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -527,7 +577,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -537,7 +588,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [privateCloudServerRole]: #privatecloudserverrole #### [privateCloudServerRole] When ordering Virtual Server (Private Node), this variable specifies the role of the server configuration. (Deprecated) -Type: **string** +Type: **string** + @@ -547,7 +599,8 @@ When ordering Virtual Server (Private Node), this variable specifies the role of [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -557,7 +610,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -567,7 +621,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -577,7 +632,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -587,7 +643,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -597,7 +654,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -607,7 +665,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -621,7 +680,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -631,7 +691,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [requiredUpstreamDeviceId]: #requiredupstreamdeviceid #### [requiredUpstreamDeviceId] Used to identify which device the new server should be attached to. -Type: **integer** +Type: **integer** + @@ -641,7 +702,8 @@ Used to identify which device the new server should be attached to. [resourceGroup]: #resourcegroup #### [resourceGroup] -Type: **string** +Type: **string** + @@ -651,7 +713,8 @@ Used to identify which device the new server should be attached to. [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -661,7 +724,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -671,7 +735,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -681,7 +746,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -691,7 +757,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -701,7 +768,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -711,7 +779,8 @@ The number of cores for the server being ordered. This value is set internally. [serverId]: #serverid #### [serverId] -Type: **string** +Type: **string** + @@ -721,7 +790,8 @@ The number of cores for the server being ordered. This value is set internally. [servicePortInterfaceId]: #serviceportinterfaceid #### [servicePortInterfaceId] -Type: **string** +Type: **string** + @@ -731,7 +801,8 @@ The number of cores for the server being ordered. This value is set internally. [servicePortIpAllocationId]: #serviceportipallocationid #### [servicePortIpAllocationId] -Type: **string** +Type: **string** + @@ -741,7 +812,8 @@ The number of cores for the server being ordered. This value is set internally. [servicePortVpcId]: #serviceportvpcid #### [servicePortVpcId] -Type: **string** +Type: **string** + @@ -751,7 +823,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -761,7 +834,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -771,7 +845,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -781,7 +856,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -797,7 +873,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -807,7 +884,8 @@ The first storage group in this array will be considered the primary storage gro [subnets]: #subnets #### [subnets] -Type: **SoftLayer_Container_Product_Order_Vpc_Subnet[] ** +Type: **SoftLayer_Container_Product_Order_Vpc_Subnet[] ** + @@ -817,7 +895,8 @@ The first storage group in this array will be considered the primary storage gro [tags]: #tags #### [tags] tags (used in MongoDB deployments). (Deprecated) -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -827,7 +906,8 @@ tags (used in MongoDB deployments). (Deprecated) [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -837,7 +917,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -847,7 +928,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -857,7 +939,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -867,7 +950,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -877,7 +961,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -887,7 +972,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -897,7 +983,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -907,7 +994,8 @@ For virtual guest (virtual server) orders, this property is required if you did [zone]: #zone #### [zone] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Monitoring_Package/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Monitoring_Package/_index.md index 739192690b..c96a1dbcfb 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Monitoring_Package/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Monitoring_Package/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -547,7 +598,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -587,7 +642,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The number of cores for the server being ordered. This value is set internally. [serverType]: #servertype #### [serverType] -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -617,7 +675,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -637,7 +697,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -653,7 +714,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -663,7 +725,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -673,7 +736,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -683,7 +747,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -693,7 +758,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -713,7 +780,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -723,7 +791,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -733,7 +802,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_MultiConfiguration/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_MultiConfiguration/_index.md index b415147a94..87630356d2 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_MultiConfiguration/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_MultiConfiguration/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ This is a datatype used with multi-configuration deployments. Multi-configuratio [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -55,7 +58,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -65,7 +69,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -145,7 +157,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -155,7 +168,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -165,7 +179,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -175,7 +190,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -195,7 +212,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -205,7 +223,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -215,7 +234,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -225,7 +245,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -235,7 +256,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -247,7 +269,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -257,7 +280,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -267,7 +291,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -277,7 +302,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -287,7 +313,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -297,7 +324,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -307,7 +335,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -317,7 +346,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -327,7 +357,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -337,7 +368,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -347,7 +379,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -357,7 +390,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -367,7 +401,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -377,7 +412,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -387,7 +423,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -397,7 +434,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -407,7 +445,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -417,7 +456,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -427,7 +467,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -437,7 +478,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -447,7 +489,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -457,7 +500,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -467,7 +511,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -477,7 +522,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -487,7 +533,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -497,7 +544,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -507,7 +555,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -521,7 +570,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -531,7 +581,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -541,7 +592,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -551,7 +603,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -561,7 +614,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -571,7 +625,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -581,7 +636,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -591,7 +647,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -601,7 +658,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -611,7 +669,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -621,7 +680,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -637,7 +697,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -647,7 +708,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -657,7 +719,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -667,7 +730,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -677,7 +741,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -687,7 +752,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -697,7 +763,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -707,7 +774,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -717,7 +785,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_MultiConfiguration_Tornado/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_MultiConfiguration_Tornado/_index.md index 0032d8edbe..1a7b8a4034 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_MultiConfiguration_Tornado/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_MultiConfiguration_Tornado/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** +
      @@ -55,7 +58,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** +
      @@ -65,7 +69,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -145,7 +157,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -155,7 +168,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -165,7 +179,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -175,7 +190,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -195,7 +212,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -205,7 +223,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -215,7 +234,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -225,7 +245,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -235,7 +256,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -247,7 +269,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -257,7 +280,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -267,7 +291,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -277,7 +302,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -287,7 +313,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -297,7 +324,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -307,7 +335,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -317,7 +346,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -327,7 +357,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -337,7 +368,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -347,7 +379,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -357,7 +390,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -367,7 +401,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -377,7 +412,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -387,7 +423,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -397,7 +434,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -407,7 +445,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -417,7 +456,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -427,7 +467,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -437,7 +478,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -447,7 +489,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -457,7 +500,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -467,7 +511,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -477,7 +522,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -487,7 +533,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -497,7 +544,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -507,7 +555,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -521,7 +570,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -531,7 +581,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -541,7 +592,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -551,7 +603,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -561,7 +614,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -571,7 +625,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -581,7 +636,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -591,7 +647,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -601,7 +658,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -611,7 +669,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -621,7 +680,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -637,7 +697,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -647,7 +708,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -657,7 +719,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -667,7 +730,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -677,7 +741,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -687,7 +752,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -697,7 +763,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -707,7 +774,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -717,7 +785,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network/_index.md index 5c44686f27..ea677de93e 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + (DEPRECATED) This type contains the structure of network-related objects that may be specified when ordering services. @@ -45,7 +47,8 @@ classes: [network]: #network #### [network] The [SoftLayer_Network]({{}}) object. -Type: **SoftLayer_Network ** +Type: **SoftLayer_Network ** + @@ -55,7 +58,8 @@ The [SoftLayer_Network]({{}}) objec [publicVlans]: #publicvlans #### [publicVlans] The list of public [SoftLayer_Container_Product_Order_Network_Vlan]({{}}) available for ordering. Each VLAN will have list of public subnets that are accessible to the VLAN. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -65,7 +69,8 @@ The list of public [SoftLayer_Container_Product_Order_Network_Vlan]({{}}) available for ordering with a description of their available IP space. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Application_Delivery_Controller/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Application_Delivery_Controller/_index.md index 38d0ef360d..7286e021af 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Application_Delivery_Controller/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Application_Delivery_Controller/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [applicationDeliveryControllerId]: #applicationdeliverycontrollerid #### [applicationDeliveryControllerId] An optional [SoftLayer_Network_Application_Delivery_Controller]({{}}) identifier that is used for upgrading an existing application delivery controller. -Type: **integer** +Type: **integer** + @@ -61,7 +64,8 @@ An optional [SoftLayer_Network_Application_Delivery_Controller]({{Type: **boolean** +Type: **boolean** + @@ -71,7 +75,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -81,7 +86,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -161,7 +174,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -171,7 +185,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -191,7 +207,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -221,7 +240,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -231,7 +251,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -251,7 +273,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -263,7 +286,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -273,7 +297,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -283,7 +308,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -293,7 +319,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -303,7 +330,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -313,7 +341,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -403,7 +440,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -413,7 +451,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -423,7 +462,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -433,7 +473,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -443,7 +484,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -453,7 +495,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -473,7 +517,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -483,7 +528,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -503,7 +550,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -513,7 +561,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -523,7 +572,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -547,7 +598,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -557,7 +609,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -567,7 +620,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -577,7 +631,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -597,7 +653,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -607,7 +664,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -617,7 +675,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -637,7 +697,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -653,7 +714,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -663,7 +725,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -673,7 +736,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -683,7 +747,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -693,7 +758,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -713,7 +780,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -723,7 +791,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -733,7 +802,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Interconnect/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Interconnect/_index.md index a4bcc8e862..68eb13be90 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Interconnect/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Interconnect/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder when purchasing a Network Interconnect. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bgpAsn]: #bgpasn #### [bgpAsn] The BGP ASN. -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ The BGP ASN. [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -71,7 +75,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -81,7 +86,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -161,7 +174,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -171,7 +185,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -191,7 +207,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ An optional virtual disk image template identifier to be used as an installation [interconnectId]: #interconnectid #### [interconnectId] The [SoftLayer_Network_Interconnect]({{}}) for this order, ID must be provided. -Type: **integer** +Type: **integer** + @@ -221,7 +240,8 @@ The [SoftLayer_Network_Interconnect]({{}}) for this order, ID must be provided. -Type: **SoftLayer_Network_DirectLink_Location ** +Type: **SoftLayer_Network_DirectLink_Location ** + @@ -231,7 +251,8 @@ The [SoftLayer_Network_DirectLink_Location]({{}}) being ordered. Only the ID is required. If this ID is specified, then properties such as networkIdentifier, ipAddressRange, and interconnectId do not need to be specified. -Type: **SoftLayer_Network_Interconnect_Tenant ** +Type: **SoftLayer_Network_Interconnect_Tenant ** + @@ -241,7 +262,8 @@ The [SoftLayer_Network_Interconnect_Tenant]({{Type: **string** +Type: **string** + @@ -251,7 +273,8 @@ Optional IP address for this link. [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -261,7 +284,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -271,7 +295,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -281,7 +306,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -291,7 +317,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -301,7 +328,8 @@ A generic message about the order. Does not need to be sent in with any orders. [name]: #name #### [name] A name to identify this Direct Link resource. -Type: **string** +Type: **string** + @@ -311,7 +339,8 @@ A name to identify this Direct Link resource. [networkIdentifier]: #networkidentifier #### [networkIdentifier] Optional network identifier for this link. -Type: **string** +Type: **string** + @@ -323,7 +352,8 @@ Optional network identifier for this link. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -333,7 +363,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -343,7 +374,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -353,7 +385,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -363,7 +396,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -373,7 +407,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -423,7 +462,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -433,7 +473,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -443,7 +484,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -453,7 +495,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -463,7 +506,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -473,7 +517,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -483,7 +528,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -493,7 +539,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -513,7 +561,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -523,7 +572,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -533,7 +583,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -543,7 +594,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -553,7 +605,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -563,7 +616,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -573,7 +627,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -583,7 +638,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -597,7 +653,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -627,7 +686,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -637,7 +697,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -647,7 +708,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -657,7 +719,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -667,7 +730,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -677,7 +741,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -687,7 +752,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -697,7 +763,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -713,7 +780,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -723,7 +791,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -733,7 +802,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -743,7 +813,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -753,7 +824,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -763,7 +835,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -773,7 +846,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -783,7 +857,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -793,7 +868,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Interconnect_Upgrade/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Interconnect_Upgrade/_index.md index 189b8c3af3..8ac9313b51 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Interconnect_Upgrade/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Interconnect_Upgrade/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bgpAsn]: #bgpasn #### [bgpAsn] The BGP ASN. -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ The BGP ASN. [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -71,7 +75,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -81,7 +86,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -161,7 +174,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -171,7 +185,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -191,7 +207,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ An optional virtual disk image template identifier to be used as an installation [interconnectId]: #interconnectid #### [interconnectId] The [SoftLayer_Network_Interconnect]({{}}) for this order, ID must be provided. -Type: **integer** +Type: **integer** + @@ -221,7 +240,8 @@ The [SoftLayer_Network_Interconnect]({{}}) for this order, ID must be provided. -Type: **SoftLayer_Network_DirectLink_Location ** +Type: **SoftLayer_Network_DirectLink_Location ** + @@ -231,7 +251,8 @@ The [SoftLayer_Network_DirectLink_Location]({{}}) being modified. Only the ID is required. -Type: **SoftLayer_Network_Interconnect_Tenant ** +Type: **SoftLayer_Network_Interconnect_Tenant ** + @@ -241,7 +262,8 @@ The [SoftLayer_Network_Interconnect_Tenant]({{Type: **string** +Type: **string** + @@ -251,7 +273,8 @@ Optional IP address for this link. [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -261,7 +284,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -271,7 +295,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -281,7 +306,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -291,7 +317,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -301,7 +328,8 @@ A generic message about the order. Does not need to be sent in with any orders. [name]: #name #### [name] A name to identify this Direct Link resource. -Type: **string** +Type: **string** + @@ -311,7 +339,8 @@ A name to identify this Direct Link resource. [networkIdentifier]: #networkidentifier #### [networkIdentifier] Optional network identifier for this link. -Type: **string** +Type: **string** + @@ -323,7 +352,8 @@ Optional network identifier for this link. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -333,7 +363,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -343,7 +374,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -353,7 +385,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -363,7 +396,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -373,7 +407,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -423,7 +462,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -433,7 +473,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -443,7 +484,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -453,7 +495,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -463,7 +506,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -473,7 +517,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -483,7 +528,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -493,7 +539,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -513,7 +561,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -523,7 +572,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -533,7 +583,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -543,7 +594,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -553,7 +605,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -563,7 +616,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -573,7 +627,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -583,7 +638,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -597,7 +653,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -627,7 +686,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -637,7 +697,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -647,7 +708,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -657,7 +719,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -667,7 +730,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -677,7 +741,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -687,7 +752,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -697,7 +763,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -713,7 +780,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -723,7 +791,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -733,7 +802,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -743,7 +813,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -753,7 +824,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -763,7 +835,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -773,7 +846,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -783,7 +857,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -793,7 +868,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer/_index.md index 193597cbbe..a0dd422c3b 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This is the default container type for network load balancer orders. @@ -45,7 +47,8 @@ This is the default container type for network load balancer orders. [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -55,7 +58,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -65,7 +69,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -145,7 +157,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -155,7 +168,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -165,7 +179,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -175,7 +190,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -195,7 +212,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -205,7 +223,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -215,7 +234,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -225,7 +245,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -235,7 +256,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -247,7 +269,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -257,7 +280,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -267,7 +291,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -277,7 +302,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -287,7 +313,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -297,7 +324,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -307,7 +335,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -317,7 +346,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -327,7 +357,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -337,7 +368,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -347,7 +379,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -357,7 +390,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -367,7 +401,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -377,7 +412,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -387,7 +423,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -397,7 +434,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -407,7 +445,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -417,7 +456,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -427,7 +467,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -437,7 +478,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -447,7 +489,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -457,7 +500,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -467,7 +511,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -477,7 +522,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -487,7 +533,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -497,7 +544,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -507,7 +555,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -521,7 +570,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -531,7 +581,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -541,7 +592,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -551,7 +603,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -561,7 +614,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -571,7 +625,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -581,7 +636,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -591,7 +647,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -601,7 +658,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -611,7 +669,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -621,7 +680,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -637,7 +697,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -647,7 +708,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -657,7 +719,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -667,7 +730,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -677,7 +741,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -687,7 +752,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -697,7 +763,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -707,7 +774,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -717,7 +785,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer_AsAService/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer_AsAService/_index.md index 7afd5e66ba..83e569fc05 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer_AsAService/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer_AsAService/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [description]: #description #### [description] A description of this Load Balancer. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ A description of this Load Balancer. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -161,7 +174,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -171,7 +185,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -191,7 +207,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [healthMonitorConfigurations]: #healthmonitorconfigurations #### [healthMonitorConfigurations] The [SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration]({{}})s for this Load Balancer. -Type: **SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration[] ** +Type: **SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration[] ** + @@ -201,7 +218,8 @@ The [SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration]({{Type: **string** +Type: **string** + @@ -211,7 +229,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -221,7 +240,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -231,7 +251,8 @@ Flag to identify a "managed" order. This value is set internally. [isPublic]: #ispublic #### [isPublic] Specify whether this load balancer is a public or internal facing load balancer. If this value is omitted, the value will default to true. -Type: **boolean** +Type: **boolean** + @@ -241,7 +262,8 @@ Specify whether this load balancer is a public or internal facing load balancer. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -251,7 +273,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -261,7 +284,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -271,7 +295,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -281,7 +306,8 @@ A generic message about the order. Does not need to be sent in with any orders. [name]: #name #### [name] A name to identify this Load Balancer. -Type: **string** +Type: **string** + @@ -293,7 +319,8 @@ A name to identify this Load Balancer. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -303,7 +330,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -313,7 +341,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -323,7 +352,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -333,7 +363,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -343,7 +374,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -423,7 +462,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -433,7 +473,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -443,7 +484,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -453,7 +495,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -463,7 +506,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -473,7 +517,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -483,7 +528,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -493,7 +539,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -503,7 +550,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -513,7 +561,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -523,7 +572,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -533,7 +583,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [protocolConfigurations]: #protocolconfigurations #### [protocolConfigurations] The [SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration]({{}})s for this Load Balancer. -Type: **SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration[] ** +Type: **SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration[] ** + @@ -543,7 +594,8 @@ The [SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration]({{Type: **array of strings** +Type: **array of strings** + @@ -553,7 +605,8 @@ The URLs for scripts to execute on their respective servers after they have been [publicSubnets]: #publicsubnets #### [publicSubnets] Specify the public subnet where this load balancer will be provisioned when useSystemPublicIpPool is false. This is valid only for public(1) load balancer. The public subnet should match the private subnet. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -563,7 +616,8 @@ Specify the public subnet where this load balancer will be provisioned when useS [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -573,7 +627,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -597,7 +653,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -607,7 +664,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -617,7 +675,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -637,7 +697,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -647,7 +708,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -657,7 +719,8 @@ The number of cores for the server being ordered. This value is set internally. [serverInstancesInformation]: #serverinstancesinformation #### [serverInstancesInformation] The [SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo]({{}})s for this Load Balancer. -Type: **SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo[] ** +Type: **SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo[] ** + @@ -667,7 +730,8 @@ The [SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo]({{Type: **string** +Type: **string** + @@ -677,7 +741,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -687,7 +752,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -697,7 +763,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -713,7 +780,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -723,7 +791,8 @@ The first storage group in this array will be considered the primary storage gro [subnets]: #subnets #### [subnets] The [SoftLayer_Network_Subnet]({{}})s where this Load Balancer will be provisioned. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -733,7 +802,8 @@ The [SoftLayer_Network_Subnet]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -743,7 +813,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -753,7 +824,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -763,7 +835,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -773,7 +846,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -783,7 +857,8 @@ The tax amount of the setup fees. [type]: #type #### [type] Specify the type of this load balancer. If isPublic is omitted, it specifies the load balacner as private(0), public(1) or public to public(2). If isPublic is set as True, only public(1) or public to public(2) is valid. If isPublic is set as False, this value is ignored. If this value is omitted, the value will be set according to isPublic value. -Type: **integer** +Type: **integer** + @@ -793,7 +868,8 @@ Specify the type of this load balancer. If isPublic is omitted, it specifies the [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -803,7 +879,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -813,7 +890,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [useSystemPublicIpPool]: #usesystempublicippool #### [useSystemPublicIpPool] Specify if this load balancer uses system IP pool (true, default) or customer's (null|false) public subnet to allocate IP addresses. -Type: **boolean** +Type: **boolean** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer_Global/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer_Global/_index.md index 603f44a035..148912635f 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer_Global/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer_Global/_index.md @@ -20,6 +20,9 @@ classes: ## Description + +
      Deprecated
      + The global load balancer service has been deprecated and is no longer available. This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a global load balancer order with SoftLayer. @@ -55,7 +58,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -65,7 +69,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -75,7 +80,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ This has been deprecated. It is the identifier used to track configurations in l [domain]: #domain #### [domain] The domain name that will be load balanced. -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ The domain name that will be load balanced. [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -165,7 +179,8 @@ The domain name that will be load balanced. [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -175,7 +190,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -185,7 +201,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -195,7 +212,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [hostname]: #hostname #### [hostname] The hostname that will be load balanced. -Type: **string** +Type: **string** + @@ -205,7 +223,8 @@ The hostname that will be load balanced. [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -215,7 +234,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -225,7 +245,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -235,7 +256,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -245,7 +267,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -255,7 +278,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -265,7 +289,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -277,7 +302,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -287,7 +313,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -297,7 +324,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -307,7 +335,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -317,7 +346,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -327,7 +357,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -337,7 +368,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -347,7 +379,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -357,7 +390,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -367,7 +401,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -377,7 +412,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -387,7 +423,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -397,7 +434,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -407,7 +445,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -417,7 +456,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -427,7 +467,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -437,7 +478,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -447,7 +489,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -457,7 +500,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -467,7 +511,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -477,7 +522,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -487,7 +533,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -497,7 +544,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -507,7 +555,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -517,7 +566,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -527,7 +577,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -537,7 +588,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -551,7 +603,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -561,7 +614,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -571,7 +625,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -581,7 +636,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -591,7 +647,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -601,7 +658,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -611,7 +669,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -621,7 +680,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -631,7 +691,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -641,7 +702,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -651,7 +713,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -667,7 +730,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -677,7 +741,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -687,7 +752,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -697,7 +763,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -707,7 +774,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -717,7 +785,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -727,7 +796,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -737,7 +807,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -747,7 +818,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Message_Delivery/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Message_Delivery/_index.md index ad45bf10bf..74aa300b1e 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Message_Delivery/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Message_Delivery/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [accountPassword]: #accountpassword #### [accountPassword] The account password for SendGrid enrollment. -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ The account password for SendGrid enrollment. [accountUsername]: #accountusername #### [accountUsername] The username for SendGrid enrollment. -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ The username for SendGrid enrollment. [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -81,7 +86,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -91,7 +97,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ This has been deprecated. It is the identifier used to track configurations in l [emailAddress]: #emailaddress #### [emailAddress] The email address for SendGrid enrollment. -Type: **string** +Type: **string** + @@ -171,7 +185,8 @@ The email address for SendGrid enrollment. [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ The email address for SendGrid enrollment. [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -191,7 +207,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -211,7 +229,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -231,7 +251,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -241,7 +262,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -251,7 +273,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -261,7 +284,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -271,7 +295,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -283,7 +308,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -293,7 +319,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -303,7 +330,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -313,7 +341,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -323,7 +352,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -333,7 +363,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -423,7 +462,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -433,7 +473,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -443,7 +484,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -453,7 +495,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -463,7 +506,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -473,7 +517,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -483,7 +528,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -493,7 +539,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -503,7 +550,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -513,7 +561,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -523,7 +572,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -533,7 +583,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -543,7 +594,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -567,7 +620,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -577,7 +631,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -617,7 +675,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -637,7 +697,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -647,7 +708,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -657,7 +719,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -673,7 +736,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -683,7 +747,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -693,7 +758,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -703,7 +769,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -713,7 +780,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -723,7 +791,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -733,7 +802,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -743,7 +813,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -753,7 +824,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_PerformanceStorage/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_PerformanceStorage/_index.md index 7b493a5bf4..abe841bb41 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_PerformanceStorage/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_PerformanceStorage/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) for File and [SoftLayer_Container_Product_Order_Network_PerformanceStorage_Iscsi]({{}}) for Block storage. @@ -45,7 +47,8 @@ This is the base data type for Performance storage order containers. If you wish [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -55,7 +58,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -65,7 +69,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -145,7 +157,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -155,7 +168,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -165,7 +179,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -175,7 +190,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -195,7 +212,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -205,7 +223,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -215,7 +234,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -225,7 +245,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -235,7 +256,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -247,7 +269,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -257,7 +280,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -267,7 +291,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -277,7 +302,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -287,7 +313,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -297,7 +324,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -307,7 +335,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -317,7 +346,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -327,7 +357,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -337,7 +368,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -347,7 +379,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -357,7 +390,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -367,7 +401,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -377,7 +412,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -387,7 +423,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -397,7 +434,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -407,7 +445,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -417,7 +456,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -427,7 +467,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -437,7 +478,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -447,7 +489,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -457,7 +500,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -467,7 +511,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -477,7 +522,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -487,7 +533,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -497,7 +544,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -507,7 +555,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -521,7 +570,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -531,7 +581,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -541,7 +592,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -551,7 +603,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -561,7 +614,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -571,7 +625,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -581,7 +636,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -591,7 +647,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -601,7 +658,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -611,7 +669,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -621,7 +680,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -637,7 +697,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -647,7 +708,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -657,7 +719,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -667,7 +730,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -677,7 +741,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -687,7 +752,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -697,7 +763,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -707,7 +774,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -717,7 +785,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_PerformanceStorage_Iscsi/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_PerformanceStorage_Iscsi/_index.md index 979a31b276..43d2e741cc 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_PerformanceStorage_Iscsi/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_PerformanceStorage_Iscsi/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [osFormatType]: #osformattype #### [osFormatType] OS Type to be used when formatting the storage space, this should match the OS type that will be connecting to the LUN. The only required property its the keyName of the OS type. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -293,7 +319,8 @@ OS Type to be used when formatting the storage space, this should match the OS t [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -303,7 +330,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -313,7 +341,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -403,7 +440,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -413,7 +451,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -423,7 +462,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -433,7 +473,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -443,7 +484,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -453,7 +495,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -473,7 +517,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -483,7 +528,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -503,7 +550,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -513,7 +561,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -523,7 +572,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -547,7 +598,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -557,7 +609,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -567,7 +620,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -577,7 +631,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -597,7 +653,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -607,7 +664,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -617,7 +675,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -637,7 +697,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -653,7 +714,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -663,7 +725,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -673,7 +736,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -683,7 +747,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -693,7 +758,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -713,7 +780,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -723,7 +791,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -733,7 +802,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_PerformanceStorage_Nfs/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_PerformanceStorage_Nfs/_index.md index 65a65d4628..27cf0f6037 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_PerformanceStorage_Nfs/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_PerformanceStorage_Nfs/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -547,7 +598,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -587,7 +642,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -627,7 +686,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -643,7 +703,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -653,7 +714,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -663,7 +725,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -673,7 +736,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -683,7 +747,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -693,7 +758,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -713,7 +780,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Protection_Firewall/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Protection_Firewall/_index.md index b34bcf9200..cd0b3c85a5 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Protection_Firewall/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Protection_Firewall/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -547,7 +598,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -587,7 +642,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -627,7 +686,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -643,7 +703,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -653,7 +714,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -663,7 +725,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -673,7 +736,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -683,7 +747,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -693,7 +758,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -713,7 +780,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Protection_Firewall_Dedicated/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Protection_Firewall_Dedicated/_index.md index 4f7b300763..9cec685070 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Protection_Firewall_Dedicated/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Protection_Firewall_Dedicated/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -251,7 +273,8 @@ A generic message about the order. Does not need to be sent in with any orders. [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -263,7 +286,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -273,7 +297,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -283,7 +308,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -293,7 +319,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -303,7 +330,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -313,7 +341,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -403,7 +440,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -413,7 +451,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -423,7 +462,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -433,7 +473,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -443,7 +484,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -453,7 +495,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -473,7 +517,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -483,7 +528,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -503,7 +550,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -513,7 +561,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -523,7 +572,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -547,7 +598,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -557,7 +609,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -567,7 +620,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -577,7 +631,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ The URL to which PayPal redirects browser after a payment is completed. [routerId]: #routerid #### [routerId] -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -607,7 +664,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -627,7 +686,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -637,7 +697,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -647,7 +708,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -663,7 +725,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -673,7 +736,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -683,7 +747,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -693,7 +758,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -703,7 +769,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -713,7 +780,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -723,7 +791,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -733,7 +802,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -743,7 +813,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -753,7 +824,8 @@ For virtual guest (virtual server) orders, this property is required if you did [vlan]: #vlan #### [vlan] generic properties. -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + @@ -763,7 +835,8 @@ generic properties. [vlanId]: #vlanid #### [vlanId] generic properties. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Protection_Firewall_Dedicated_Upgrade/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Protection_Firewall_Dedicated_Upgrade/_index.md index b346155d97..868f2ddec3 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Protection_Firewall_Dedicated_Upgrade/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Protection_Firewall_Dedicated_Upgrade/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [firewallId]: #firewallid #### [firewallId] -Type: **integer** +Type: **integer** + @@ -161,7 +174,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -171,7 +185,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -191,7 +207,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -221,7 +240,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -231,7 +251,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -251,7 +273,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -261,7 +284,8 @@ A generic message about the order. Does not need to be sent in with any orders. [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -273,7 +297,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -283,7 +308,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -293,7 +319,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -303,7 +330,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -313,7 +341,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -323,7 +352,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -413,7 +451,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -433,7 +473,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -443,7 +484,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -453,7 +495,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -463,7 +506,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -473,7 +517,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -483,7 +528,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -493,7 +539,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -503,7 +550,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -513,7 +561,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -523,7 +572,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -533,7 +583,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -547,7 +598,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -587,7 +642,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -597,7 +653,8 @@ The URL to which PayPal redirects browser after a payment is completed. [routerId]: #routerid #### [routerId] -Type: **integer** +Type: **integer** + @@ -607,7 +664,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -617,7 +675,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -637,7 +697,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -647,7 +708,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -657,7 +719,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -673,7 +736,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -683,7 +747,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -693,7 +758,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -703,7 +769,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -713,7 +780,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -723,7 +791,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -733,7 +802,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -743,7 +813,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -753,7 +824,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -763,7 +835,8 @@ For virtual guest (virtual server) orders, this property is required if you did [vlan]: #vlan #### [vlan] generic properties. -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + @@ -773,7 +846,8 @@ generic properties. [vlanId]: #vlanid #### [vlanId] generic properties. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_AsAService/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_AsAService/_index.md index 2969d8aa87..f939830f74 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_AsAService/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_AsAService/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [dedicatedCluster]: #dedicatedcluster #### [dedicatedCluster] Optional property to specify provisioning to a dedicated cluster at order time. The `id` property of the [SoftLayer_Network_Storage_DedicatedCluster]({{}}) should be provided to dictate where to provision storage to. Note your account must be enabled to order into the desired location(s) prior to placing the order. -Type: **SoftLayer_Network_Storage_DedicatedCluster ** +Type: **SoftLayer_Network_Storage_DedicatedCluster ** + @@ -131,7 +141,8 @@ Optional property to specify provisioning to a dedicated cluster at order time. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [duplicateOriginSnapshotId]: #duplicateoriginsnapshotid #### [duplicateOriginSnapshotId] This must be populated only for duplicating a specific snapshot for volume duplicating. It represents the identifier of the origin [SoftLayer_Network_Storage_Snapshot]({{}}) -Type: **integer** +Type: **integer** + @@ -161,7 +174,8 @@ This must be populated only for duplicating a specific snapshot for volume dupli [duplicateOriginVolumeId]: #duplicateoriginvolumeid #### [duplicateOriginVolumeId] This must be populated only for duplicate volume ordering. It represents the identifier of the origin [SoftLayer_Network_Storage]({{}}). -Type: **integer** +Type: **integer** + @@ -171,7 +185,8 @@ This must be populated only for duplicate volume ordering. It represents the ide [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ This must be populated only for duplicate volume ordering. It represents the ide [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -191,7 +207,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -211,7 +229,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -231,7 +251,8 @@ An optional virtual disk image template identifier to be used as an installation [iops]: #iops #### [iops] When ordering performance by IOPS, populate this property with how many. -Type: **integer** +Type: **integer** + @@ -241,7 +262,8 @@ When ordering performance by IOPS, populate this property with how many. [isDependentDuplicateFlag]: #isdependentduplicateflag #### [isDependentDuplicateFlag] This can be optionally populated only for duplicate volume ordering. When set, this flag denotes that the duplicate volume being ordered can refresh its data using snapshots from the specified origin volume. -Type: **boolean** +Type: **boolean** + @@ -251,7 +273,8 @@ This can be optionally populated only for duplicate volume ordering. When set, t [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -261,7 +284,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -271,7 +295,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -281,7 +306,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -291,7 +317,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -313,7 +341,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -323,7 +352,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -333,7 +363,8 @@ Collection of exceptions resulting from the verification of the order. This valu [originVolumeId]: #originvolumeid #### [originVolumeId] This must be populated only for replicant volume ordering. It represents the identifier of the origin [SoftLayer_Network_Storage]({{}}). -Type: **integer** +Type: **integer** + @@ -343,7 +374,8 @@ This must be populated only for replicant volume ordering. It represents the ide [originVolumeScheduleId]: #originvolumescheduleid #### [originVolumeScheduleId] This must be populated only for replicant volume ordering. It represents the [SoftLayer_Network_Storage_Schedule]({{}}) that will be be used to replicate the origin [SoftLayer_Network_Storage]({{}}) volume. -Type: **integer** +Type: **integer** + @@ -353,7 +385,8 @@ This must be populated only for replicant volume ordering. It represents the [So [osFormatType]: #osformattype #### [osFormatType] This must be populated for block storage orders. This should match the OS type of the host(s) that will connect to the volume. The only required property is the keyName of the OS type. This property is ignored for file storage orders. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -363,7 +396,8 @@ This must be populated for block storage orders. This should match the OS type o [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -373,7 +407,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -383,7 +418,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -423,7 +462,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -433,7 +473,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -443,7 +484,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -453,7 +495,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -463,7 +506,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -473,7 +517,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -483,7 +528,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -493,7 +539,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -503,7 +550,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -513,7 +561,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -523,7 +572,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -533,7 +583,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -543,7 +594,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -553,7 +605,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -563,7 +616,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -573,7 +627,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -583,7 +638,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -593,7 +649,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -617,7 +675,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -637,7 +697,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -647,7 +708,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -657,7 +719,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -667,7 +730,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -677,7 +741,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -687,7 +752,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -697,7 +763,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -707,7 +774,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -723,7 +791,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -733,7 +802,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -743,7 +813,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -753,7 +824,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -763,7 +835,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -773,7 +846,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -783,7 +857,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -793,7 +868,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -803,7 +879,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -813,7 +890,8 @@ For virtual guest (virtual server) orders, this property is required if you did [volumeSize]: #volumesize #### [volumeSize] Volume size in GB's. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_AsAService_Upgrade/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_AsAService_Upgrade/_index.md index 4ce8c07889..8a0bb90961 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_AsAService_Upgrade/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_AsAService_Upgrade/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [dedicatedCluster]: #dedicatedcluster #### [dedicatedCluster] Optional property to specify provisioning to a dedicated cluster at order time. The `id` property of the [SoftLayer_Network_Storage_DedicatedCluster]({{}}) should be provided to dictate where to provision storage to. Note your account must be enabled to order into the desired location(s) prior to placing the order. -Type: **SoftLayer_Network_Storage_DedicatedCluster ** +Type: **SoftLayer_Network_Storage_DedicatedCluster ** + @@ -131,7 +141,8 @@ Optional property to specify provisioning to a dedicated cluster at order time. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [duplicateOriginSnapshotId]: #duplicateoriginsnapshotid #### [duplicateOriginSnapshotId] This must be populated only for duplicating a specific snapshot for volume duplicating. It represents the identifier of the origin [SoftLayer_Network_Storage_Snapshot]({{}}) -Type: **integer** +Type: **integer** + @@ -161,7 +174,8 @@ This must be populated only for duplicating a specific snapshot for volume dupli [duplicateOriginVolumeId]: #duplicateoriginvolumeid #### [duplicateOriginVolumeId] This must be populated only for duplicate volume ordering. It represents the identifier of the origin [SoftLayer_Network_Storage]({{}}). -Type: **integer** +Type: **integer** + @@ -171,7 +185,8 @@ This must be populated only for duplicate volume ordering. It represents the ide [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ This must be populated only for duplicate volume ordering. It represents the ide [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -191,7 +207,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -211,7 +229,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -231,7 +251,8 @@ An optional virtual disk image template identifier to be used as an installation [iops]: #iops #### [iops] When upgrading performance by IOPS, populate this property with how many. -Type: **integer** +Type: **integer** + @@ -241,7 +262,8 @@ When upgrading performance by IOPS, populate this property with how many. [isDependentDuplicateFlag]: #isdependentduplicateflag #### [isDependentDuplicateFlag] This can be optionally populated only for duplicate volume ordering. When set, this flag denotes that the duplicate volume being ordered can refresh its data using snapshots from the specified origin volume. -Type: **boolean** +Type: **boolean** + @@ -251,7 +273,8 @@ This can be optionally populated only for duplicate volume ordering. When set, t [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -261,7 +284,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -271,7 +295,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -281,7 +306,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -291,7 +317,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -313,7 +341,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -323,7 +352,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -333,7 +363,8 @@ Collection of exceptions resulting from the verification of the order. This valu [originVolumeId]: #originvolumeid #### [originVolumeId] This must be populated only for replicant volume ordering. It represents the identifier of the origin [SoftLayer_Network_Storage]({{}}). -Type: **integer** +Type: **integer** + @@ -343,7 +374,8 @@ This must be populated only for replicant volume ordering. It represents the ide [originVolumeScheduleId]: #originvolumescheduleid #### [originVolumeScheduleId] This must be populated only for replicant volume ordering. It represents the [SoftLayer_Network_Storage_Schedule]({{}}) that will be be used to replicate the origin [SoftLayer_Network_Storage]({{}}) volume. -Type: **integer** +Type: **integer** + @@ -353,7 +385,8 @@ This must be populated only for replicant volume ordering. It represents the [So [osFormatType]: #osformattype #### [osFormatType] This must be populated for block storage orders. This should match the OS type of the host(s) that will connect to the volume. The only required property is the keyName of the OS type. This property is ignored for file storage orders. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -363,7 +396,8 @@ This must be populated for block storage orders. This should match the OS type o [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -373,7 +407,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -383,7 +418,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -423,7 +462,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -433,7 +473,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -443,7 +484,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -453,7 +495,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -463,7 +506,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -473,7 +517,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -483,7 +528,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -493,7 +539,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -503,7 +550,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -513,7 +561,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -523,7 +572,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -533,7 +583,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -543,7 +594,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -553,7 +605,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -563,7 +616,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -573,7 +627,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -583,7 +638,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -593,7 +649,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -617,7 +675,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -637,7 +697,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -647,7 +708,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -657,7 +719,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -667,7 +730,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -677,7 +741,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -687,7 +752,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -697,7 +763,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -707,7 +774,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -723,7 +791,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -733,7 +802,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -743,7 +813,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -753,7 +824,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -763,7 +835,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -773,7 +846,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -783,7 +857,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -793,7 +868,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -803,7 +879,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -813,7 +890,8 @@ For virtual guest (virtual server) orders, this property is required if you did [volume]: #volume #### [volume] The [SoftLayer_Network_Storage]({{}}) being upgraded. Only it's ID is required. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -823,7 +901,8 @@ The [SoftLayer_Network_Storage]({{Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Plugin/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Plugin/_index.md index 4d8cdada87..d12f0365ad 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Plugin/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Plugin/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -547,7 +598,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -587,7 +642,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -627,7 +686,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -643,7 +703,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -653,7 +714,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -663,7 +725,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -673,7 +736,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -683,7 +747,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -693,7 +758,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -713,7 +780,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Vault/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Vault/_index.md index 35eae4cf0e..07bb8eb913 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Vault/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Vault/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -547,7 +598,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -587,7 +642,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -627,7 +686,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -643,7 +703,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -653,7 +714,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -663,7 +725,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -673,7 +736,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -683,7 +747,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -693,7 +758,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -713,7 +780,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Enterprise/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Enterprise/_index.md index 1ae7dbf789..0e769953ed 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Enterprise/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Enterprise/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [originVolumeId]: #originvolumeid #### [originVolumeId] This must be populated only for replicant volume ordering. It represents the identifier of the origin [SoftLayer_Network_Storage]({{}}). -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ This must be populated only for replicant volume ordering. It represents the ide [originVolumeScheduleId]: #originvolumescheduleid #### [originVolumeScheduleId] This must be populated only for replicant volume ordering. It represents the [SoftLayer_Network_Storage_Schedule]({{}}) that will be be used to replicate the origin [SoftLayer_Network_Storage]({{}}) volume. -Type: **integer** +Type: **integer** + @@ -303,7 +330,8 @@ This must be populated only for replicant volume ordering. It represents the [So [osFormatType]: #osformattype #### [osFormatType] This must be populated for block storage orders. This should match the OS type of the host(s) that will connect to the volume. The only required property is the keyName of the OS type. This property is ignored for file storage orders. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -313,7 +341,8 @@ This must be populated for block storage orders. This should match the OS type o [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -323,7 +352,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -333,7 +363,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -423,7 +462,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -433,7 +473,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -443,7 +484,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -453,7 +495,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -463,7 +506,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -473,7 +517,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -483,7 +528,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -493,7 +539,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -503,7 +550,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -513,7 +561,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -523,7 +572,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -533,7 +583,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -543,7 +594,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -567,7 +620,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -577,7 +631,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -617,7 +675,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -637,7 +697,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -647,7 +708,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -657,7 +719,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -673,7 +736,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -683,7 +747,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -693,7 +758,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -703,7 +769,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -713,7 +780,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -723,7 +791,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -733,7 +802,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -743,7 +813,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -753,7 +824,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Enterprise_SnapshotSpace/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Enterprise_SnapshotSpace/_index.md index cfa78e1d68..2f20bbcf49 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Enterprise_SnapshotSpace/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Enterprise_SnapshotSpace/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -547,7 +598,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -587,7 +642,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -627,7 +686,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -643,7 +703,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -653,7 +714,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -663,7 +725,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -673,7 +736,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -683,7 +747,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -693,7 +758,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -713,7 +780,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -733,7 +802,8 @@ For virtual guest (virtual server) orders, this property is required if you did [volumeId]: #volumeid #### [volumeId] The [SoftLayer_Network_Storage]({{}}) id for which snapshot space is being ordered for. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Enterprise_SnapshotSpace_Upgrade/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Enterprise_SnapshotSpace_Upgrade/_index.md index 5e4fd41b01..fc963240dc 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Enterprise_SnapshotSpace_Upgrade/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Enterprise_SnapshotSpace_Upgrade/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -547,7 +598,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -587,7 +642,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -627,7 +686,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -643,7 +703,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -653,7 +714,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -663,7 +725,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -673,7 +736,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -683,7 +747,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -693,7 +758,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -713,7 +780,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -733,7 +802,8 @@ For virtual guest (virtual server) orders, this property is required if you did [volumeId]: #volumeid #### [volumeId] The [SoftLayer_Network_Storage]({{}}) id for which snapshot space is being ordered for. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Hub/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Hub/_index.md index 6a3b51a3d1..0f36eb6e34 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Hub/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Hub/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This datatype is to be used for object storage orders. @@ -45,7 +47,8 @@ This datatype is to be used for object storage orders. [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -55,7 +58,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -65,7 +69,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -145,7 +157,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -155,7 +168,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -165,7 +179,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -175,7 +190,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -195,7 +212,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -205,7 +223,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -215,7 +234,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -225,7 +245,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -235,7 +256,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -247,7 +269,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -257,7 +280,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -267,7 +291,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -277,7 +302,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -287,7 +313,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -297,7 +324,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -307,7 +335,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -317,7 +346,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -327,7 +357,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -337,7 +368,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -347,7 +379,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -357,7 +390,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -367,7 +401,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -377,7 +412,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -387,7 +423,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -397,7 +434,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -407,7 +445,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -417,7 +456,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -427,7 +467,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -437,7 +478,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -447,7 +489,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -457,7 +500,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -467,7 +511,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -477,7 +522,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -487,7 +533,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -497,7 +544,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -507,7 +555,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -521,7 +570,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -531,7 +581,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -541,7 +592,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -551,7 +603,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -561,7 +614,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -571,7 +625,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -581,7 +636,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -591,7 +647,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -601,7 +658,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -611,7 +669,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -621,7 +680,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -637,7 +697,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -647,7 +708,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -657,7 +719,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -667,7 +730,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -677,7 +741,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -687,7 +752,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -697,7 +763,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -707,7 +774,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -717,7 +785,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Hub_Datacenter/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Hub_Datacenter/_index.md index 0666c59ff7..041bfd5349 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Hub_Datacenter/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Hub_Datacenter/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class is used to contain a datacenter location and its associated active usage rate prices for object storage ordering. @@ -45,7 +47,8 @@ This class is used to contain a datacenter location and its associated active us [location]: #location #### [location] The datacenter location where object storage is available. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -55,7 +58,8 @@ The datacenter location where object storage is available. [usageRatePrices]: #usagerateprices #### [usageRatePrices] The collection of active usage rate item prices. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Iscsi/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Iscsi/_index.md index c4c28fcb60..fad800ec23 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Iscsi/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Iscsi/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -547,7 +598,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -587,7 +642,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -627,7 +686,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -643,7 +703,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -653,7 +714,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -663,7 +725,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -673,7 +736,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -683,7 +747,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -693,7 +758,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -713,7 +780,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Iscsi_Replication/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Iscsi_Replication/_index.md index 5b6f1aa73d..cfcd5fae34 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Iscsi_Replication/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Iscsi_Replication/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 Replication order with SoftLayer. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -547,7 +598,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -587,7 +642,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -627,7 +686,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -643,7 +703,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -653,7 +714,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -663,7 +725,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -673,7 +736,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -683,7 +747,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -693,7 +758,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -713,7 +780,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -733,7 +802,8 @@ For virtual guest (virtual server) orders, this property is required if you did [volumeId]: #volumeid #### [volumeId] the [SoftLayer_Network_Storage_Iscsi_EqualLogic_Version3]({{}}) Id. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Iscsi_SnapshotSpace/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Iscsi_SnapshotSpace/_index.md index a0a6b0d2f2..e1d042e4d2 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Iscsi_SnapshotSpace/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Iscsi_SnapshotSpace/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 Snapshot Space order with SoftLayer. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -547,7 +598,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -587,7 +642,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -627,7 +686,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -643,7 +703,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -653,7 +714,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -663,7 +725,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -673,7 +736,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -683,7 +747,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -693,7 +758,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -713,7 +780,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -733,7 +802,8 @@ For virtual guest (virtual server) orders, this property is required if you did [volumeId]: #volumeid #### [volumeId] the [SoftLayer_Network_Storage_Iscsi_EqualLogic_Version3]({{}}) Id. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_MassDataMigration_Request/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_MassDataMigration_Request/_index.md index 43542c2843..5de926ce52 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_MassDataMigration_Request/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_MassDataMigration_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This datatype is to be used for mass data migration requests. @@ -51,7 +53,8 @@ This datatype is to be used for mass data migration requests. [address1]: #address1 #### [address1] Line 1 of the address - typically the number and street address the MDMS device will be delivered to -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ Line 1 of the address - typically the number and street address the MDMS device [address2]: #address2 #### [address2] Line 2 of the address -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ Line 2 of the address [addressAttention]: #addressattention #### [addressAttention] First and last name of the customer on the shipping address -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ First and last name of the customer on the shipping address [addressNickname]: #addressnickname #### [addressNickname] The datacenter name where the MDMS device will be shipped to -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The datacenter name where the MDMS device will be shipped to [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -101,7 +108,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -111,7 +119,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [city]: #city #### [city] The shipping address city -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ The shipping address city [companyName]: #companyname #### [companyName] Name of the company device is being shipped to -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ Name of the company device is being shipped to [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -171,7 +185,8 @@ This hash is internally-generated and is used to for tracking order containers. [cosAccountId]: #cosaccountid #### [cosAccountId] Cloud Object Storage Account ID for the data offload destination -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ Cloud Object Storage Account ID for the data offload destination [cosBucketName]: #cosbucketname #### [cosBucketName] Cloud Object Storage Bucket for the data offload destination -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ Cloud Object Storage Bucket for the data offload destination [country]: #country #### [country] The shipping address country -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ The shipping address country [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -211,7 +229,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ This has been deprecated. It is the identifier used to track configurations in l [eth1DefaultGateway]: #eth1defaultgateway #### [eth1DefaultGateway] Default Gateway used for preconfiguring the Eth1 port on the MDMS device to access the user interface -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ Default Gateway used for preconfiguring the Eth1 port on the MDMS device to acce [eth1Netmask]: #eth1netmask #### [eth1Netmask] Netmask used for preconfiguring the Eth1 port on the MDMS device to access the user interface -Type: **string** +Type: **string** + @@ -251,7 +273,8 @@ Netmask used for preconfiguring the Eth1 port on the MDMS device to access the u [eth1StaticIp]: #eth1staticip #### [eth1StaticIp] Static IP Address used for preconfiguring the Eth1 port on the MDMS device to access the user interface -Type: **string** +Type: **string** + @@ -261,7 +284,8 @@ Static IP Address used for preconfiguring the Eth1 port on the MDMS device to ac [eth3Netmask]: #eth3netmask #### [eth3Netmask] Netmask used for preconfiguring the Eth3 port on the MDMS device to enable data transfer -Type: **string** +Type: **string** + @@ -271,7 +295,8 @@ Netmask used for preconfiguring the Eth3 port on the MDMS device to enable data [eth3StaticIp]: #eth3staticip #### [eth3StaticIp] Static IP Address used for preconfiguring the Eth3 port on the MDMS device to enable data transfer -Type: **string** +Type: **string** + @@ -281,7 +306,8 @@ Static IP Address used for preconfiguring the Eth3 port on the MDMS device to en [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -291,7 +317,8 @@ Static IP Address used for preconfiguring the Eth3 port on the MDMS device to en [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -301,7 +328,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -311,7 +339,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -321,7 +350,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -331,7 +361,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -341,7 +372,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -351,7 +383,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -361,7 +394,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [keyContactEmails]: #keycontactemails #### [keyContactEmails] The e-mails of the MDMS key contacts -Type: **array of strings** +Type: **array of strings** + @@ -371,7 +405,8 @@ The e-mails of the MDMS key contacts [keyContactNames]: #keycontactnames #### [keyContactNames] The names of the MDMS key contacts -Type: **array of strings** +Type: **array of strings** + @@ -381,7 +416,8 @@ The names of the MDMS key contacts [keyContactPhoneNumbers]: #keycontactphonenumbers #### [keyContactPhoneNumbers] The phone numbers of the MDMS key contacts -Type: **array of strings** +Type: **array of strings** + @@ -391,7 +427,8 @@ The phone numbers of the MDMS key contacts [keyContactRoles]: #keycontactroles #### [keyContactRoles] The roles of the MDMS key contacts -Type: **array of strings** +Type: **array of strings** + @@ -401,7 +438,8 @@ The roles of the MDMS key contacts [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -411,7 +449,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -421,7 +460,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -433,7 +473,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -443,7 +484,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -453,7 +495,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -463,7 +506,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -473,7 +517,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -483,7 +528,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -503,7 +550,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -513,7 +561,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -523,7 +572,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [postalCode]: #postalcode #### [postalCode] The shipping address postal code -Type: **string** +Type: **string** + @@ -533,7 +583,8 @@ The shipping address postal code [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -543,7 +594,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -553,7 +605,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -563,7 +616,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -573,7 +627,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -583,7 +638,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -593,7 +649,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -603,7 +660,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -613,7 +671,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -623,7 +682,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -633,7 +693,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -643,7 +704,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -653,7 +715,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -663,7 +726,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -673,7 +737,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -683,7 +748,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -693,7 +759,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -703,7 +770,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -717,7 +785,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -727,7 +796,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [requestName]: #requestname #### [requestName] Name of the Mass Data Migration Service job request -Type: **string** +Type: **string** + @@ -737,7 +807,8 @@ Name of the Mass Data Migration Service job request [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -747,7 +818,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -757,7 +829,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -767,7 +840,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -777,7 +851,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -787,7 +862,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -797,7 +873,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -807,7 +884,8 @@ The token of a requesting service. Do not set. [shippingAddress]: #shippingaddress #### [shippingAddress] Shipping address and information where device will be shipped to -Type: **SoftLayer_Container_Network_Storage_MassDataMigration_Request_Address ** +Type: **SoftLayer_Container_Network_Storage_MassDataMigration_Request_Address ** + @@ -817,7 +895,8 @@ Shipping address and information where device will be shipped to [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -827,7 +906,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -837,7 +917,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [state]: #state #### [state] The shipping address state -Type: **string** +Type: **string** + @@ -847,7 +928,8 @@ The shipping address state [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -863,7 +945,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -873,7 +956,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -883,7 +967,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -893,7 +978,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -903,7 +989,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -913,7 +1000,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -923,7 +1011,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -933,7 +1022,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -943,7 +1033,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Modification/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Modification/_index.md index 710e066cff..781da23c35 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Modification/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Modification/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) 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]({{}}) service to retrieve a list of CloudLayer items. @@ -55,7 +57,8 @@ NOTE: When upgrading CloudLayer storage service from a metered plan (pay as you [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -65,7 +68,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -75,7 +79,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -85,7 +90,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -95,7 +101,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -105,7 +112,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -115,7 +123,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -125,7 +134,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -135,7 +145,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -145,7 +156,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -155,7 +167,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -165,7 +178,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -175,7 +189,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -185,7 +200,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -195,7 +211,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -205,7 +222,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -215,7 +233,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -225,7 +244,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -235,7 +255,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -245,7 +266,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -257,7 +279,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -267,7 +290,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -277,7 +301,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -287,7 +312,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -297,7 +323,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -307,7 +334,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -317,7 +345,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -327,7 +356,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -337,7 +367,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -347,7 +378,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -357,7 +389,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -367,7 +400,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -377,7 +411,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -387,7 +422,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -397,7 +433,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -407,7 +444,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -417,7 +455,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -427,7 +466,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -437,7 +477,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -447,7 +488,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -457,7 +499,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -467,7 +510,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -477,7 +521,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -487,7 +532,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -497,7 +543,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -507,7 +554,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -517,7 +565,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -531,7 +580,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -541,7 +591,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -551,7 +602,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -561,7 +613,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -571,7 +624,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -581,7 +635,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -591,7 +646,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -601,7 +657,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -611,7 +668,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -621,7 +679,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -631,7 +690,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -647,7 +707,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -657,7 +718,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -667,7 +729,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -677,7 +740,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -687,7 +751,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -697,7 +762,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -707,7 +773,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -717,7 +784,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -727,7 +795,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -737,7 +806,8 @@ For virtual guest (virtual server) orders, this property is required if you did [volumeId]: #volumeid #### [volumeId] The id of the StorageLayer account to modify. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Nas/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Nas/_index.md index 977104ac2b..9ed10cf126 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Nas/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Nas/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder when placing network attached storage orders. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -547,7 +598,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -587,7 +642,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -627,7 +686,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -643,7 +703,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -653,7 +714,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -663,7 +725,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -673,7 +736,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -683,7 +747,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -693,7 +758,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -713,7 +780,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Object/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Object/_index.md index defde1e9a0..9f7185db12 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Object/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Object/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This datatype is to be used for ordering object storage products using the object_storage [SoftLayer_Product_Item_Category]({{}}) order container. @@ -45,7 +47,8 @@ This datatype is to be used for ordering object storage products using the objec [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -55,7 +58,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -65,7 +69,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -145,7 +157,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -155,7 +168,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -165,7 +179,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -175,7 +190,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -195,7 +212,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -205,7 +223,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -215,7 +234,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -225,7 +245,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -235,7 +256,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -247,7 +269,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -257,7 +280,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -267,7 +291,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -277,7 +302,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -287,7 +313,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -297,7 +324,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -307,7 +335,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -317,7 +346,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -327,7 +357,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -337,7 +368,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -347,7 +379,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -357,7 +390,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -367,7 +401,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -377,7 +412,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -387,7 +423,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -397,7 +434,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -407,7 +445,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -417,7 +456,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -427,7 +467,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -437,7 +478,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -447,7 +489,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -457,7 +500,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -467,7 +511,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -477,7 +522,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -487,7 +533,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -497,7 +544,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -507,7 +555,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -521,7 +570,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -531,7 +581,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -541,7 +592,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -551,7 +603,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -561,7 +614,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -571,7 +625,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -581,7 +636,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -591,7 +647,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -601,7 +658,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -611,7 +669,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -621,7 +680,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -637,7 +697,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -647,7 +708,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -657,7 +719,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -667,7 +730,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -677,7 +741,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -687,7 +752,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -697,7 +763,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -707,7 +774,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -717,7 +785,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_ObjectStorage_LocationGroup/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_ObjectStorage_LocationGroup/_index.md index 2332a4ccad..0d6791ee95 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_ObjectStorage_LocationGroup/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_ObjectStorage_LocationGroup/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class is used to contain a location group and its associated active usage rate prices for object storage ordering. @@ -45,7 +47,8 @@ This class is used to contain a location group and its associated active usage r [clusterGeolocationType]: #clustergeolocationtype #### [clusterGeolocationType] The datacenter location where object storage is available. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The datacenter location where object storage is available. [locationGroup]: #locationgroup #### [locationGroup] The datacenter location where object storage is available. -Type: **SoftLayer_Location_Group ** +Type: **SoftLayer_Location_Group ** + @@ -65,7 +69,8 @@ The datacenter location where object storage is available. [usageRatePrices]: #usagerateprices #### [usageRatePrices] The collection of active usage rate item prices. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Subnet/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Subnet/_index.md index 2f8f821391..ff12e4d896 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Subnet/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Subnet/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [description]: #description #### [description] The description which includes the network identifier, Classless Inter-Domain Routing prefix and the available slot count. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The description which includes the network identifier, Classless Inter-Domain Ro [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [endPointIpAddressId]: #endpointipaddressid #### [endPointIpAddressId] The [SoftLayer_Network_Subnet_IpAddress]({{}}) id. -Type: **integer** +Type: **integer** + @@ -161,7 +174,8 @@ The [SoftLayer_Network_Subnet_IpAddress]({{}}) id. -Type: **integer** +Type: **integer** + @@ -171,7 +185,8 @@ The [SoftLayer_Network_Vlan]({{Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ The [SoftLayer_Network_Vlan]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -191,7 +207,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -211,7 +229,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [id]: #id #### [id] The [SoftLayer_Network_Subnet]({{}}) id. -Type: **integer** +Type: **integer** + @@ -221,7 +240,8 @@ The [SoftLayer_Network_Subnet]({{Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -241,7 +262,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -251,7 +273,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -261,7 +284,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -271,7 +295,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -281,7 +306,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -293,7 +319,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -303,7 +330,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -313,7 +341,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -323,7 +352,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -333,7 +363,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -343,7 +374,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -423,7 +462,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -433,7 +473,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -443,7 +484,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -453,7 +495,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -463,7 +506,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -473,7 +517,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -483,7 +528,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -493,7 +539,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -503,7 +550,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -513,7 +561,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -523,7 +572,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -533,7 +583,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -543,7 +594,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -553,7 +605,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -567,7 +620,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -587,7 +642,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -597,7 +653,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -607,7 +664,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -617,7 +675,8 @@ The URL to which PayPal redirects browser after a payment is completed. [routerHostname]: #routerhostname #### [routerHostname] This is the hostname for the router associated with the [SoftLayer_Network_Subnet]({{}}). This is a readonly property. -Type: **string** +Type: **string** + @@ -627,7 +686,8 @@ This is the hostname for the router associated with the [SoftLayer_Network_Subne [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -637,7 +697,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -647,7 +708,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -657,7 +719,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -667,7 +730,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -677,7 +741,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -693,7 +758,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -703,7 +769,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -713,7 +780,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -733,7 +802,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -743,7 +813,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -753,7 +824,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -763,7 +835,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -773,7 +846,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Tunnel_Ipsec/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Tunnel_Ipsec/_index.md index be700af431..9a7dc0e4ba 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Tunnel_Ipsec/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Tunnel_Ipsec/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -547,7 +598,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -587,7 +642,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -627,7 +686,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -643,7 +703,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -653,7 +714,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -663,7 +725,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -673,7 +736,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -683,7 +747,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -693,7 +758,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -713,7 +780,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Vlan/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Vlan/_index.md index 0e58867164..59a8b2a93c 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Vlan/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Vlan/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [description]: #description #### [description] The description which includes the primary router's hostname plus the vlan number. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The description which includes the primary router's hostname plus the vlan numbe [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -161,7 +174,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -171,7 +185,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -191,7 +207,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [hostnameDatacenter]: #hostnamedatacenter #### [hostnameDatacenter] The datacenter portion of the hostname. -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ The datacenter portion of the hostname. [hostnameRouter]: #hostnamerouter #### [hostnameRouter] The router portion of the hostname. -Type: **string** +Type: **string** + @@ -211,7 +229,8 @@ The router portion of the hostname. [id]: #id #### [id] The [SoftLayer_Network_Vlan]({{}}) id. -Type: **integer** +Type: **integer** + @@ -221,7 +240,8 @@ The [SoftLayer_Network_Vlan]({{Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -241,7 +262,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -251,7 +273,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -261,7 +284,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -271,7 +295,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -281,7 +306,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -291,7 +317,8 @@ A generic message about the order. Does not need to be sent in with any orders. [name]: #name #### [name] The optional name for this VLAN -Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The optional name for this VLAN Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -313,7 +341,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -323,7 +352,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -333,7 +363,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -343,7 +374,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -353,7 +385,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -423,7 +462,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -433,7 +473,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -443,7 +484,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -453,7 +495,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -463,7 +506,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -473,7 +517,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -483,7 +528,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -493,7 +539,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -503,7 +550,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -513,7 +561,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -523,7 +572,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -533,7 +583,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -543,7 +594,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -553,7 +605,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -563,7 +616,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -627,7 +686,8 @@ The URL to which PayPal redirects browser after a payment is completed. [router]: #router #### [router] The router object on which the new VLAN should be created. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -637,7 +697,8 @@ The router object on which the new VLAN should be created. [routerId]: #routerid #### [routerId] The ID of the [SoftLayer_Hardware_Router]({{}}) object on which the new VLAN should be created. -Type: **integer** +Type: **integer** + @@ -647,7 +708,8 @@ The ID of the [SoftLayer_Hardware_Router]({{Type: **boolean** +Type: **boolean** + @@ -657,7 +719,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -667,7 +730,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -677,7 +741,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -687,7 +752,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -697,7 +763,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -713,7 +780,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -723,7 +791,8 @@ The first storage group in this array will be considered the primary storage gro [subnets]: #subnets #### [subnets] The collection of subnets associated with this vlan. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -733,7 +802,8 @@ The collection of subnets associated with this vlan. [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -743,7 +813,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -753,7 +824,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -763,7 +835,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -773,7 +846,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -783,7 +857,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -793,7 +868,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -803,7 +879,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -813,7 +890,8 @@ For virtual guest (virtual server) orders, this property is required if you did [vlanNumber]: #vlannumber #### [vlanNumber] The vlan number. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Vlans/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Vlans/_index.md index 18b25d90d7..a60fa91c48 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Vlans/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Network_Vlans/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class contains the collections of public and private VLANs that are available during the ordering process. @@ -45,7 +47,8 @@ This class contains the collections of public and private VLANs that are availab [privateVlans]: #privatevlans #### [privateVlans] The collection of private vlans available during ordering. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -55,7 +58,8 @@ The collection of private vlans available during ordering. [publicVlans]: #publicvlans #### [publicVlans] The collection of public vlans available during ordering. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_NewCustomerSetup/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_NewCustomerSetup/_index.md index 27a1753126..f361520113 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_NewCustomerSetup/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_NewCustomerSetup/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [authorizationToken]: #authorizationtoken #### [authorizationToken] -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -71,7 +75,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -81,7 +86,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -161,7 +174,8 @@ This has been deprecated. It is the identifier used to track configurations in l [externalAccountId]: #externalaccountid #### [externalAccountId] -Type: **string** +Type: **string** + @@ -171,7 +185,8 @@ This has been deprecated. It is the identifier used to track configurations in l [externalServiceProviderKey]: #externalserviceproviderkey #### [externalServiceProviderKey] -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -191,7 +207,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -211,7 +229,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -231,7 +251,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -241,7 +262,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -251,7 +273,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -261,7 +284,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -271,7 +295,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -283,7 +308,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -293,7 +319,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -303,7 +330,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -313,7 +341,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -323,7 +352,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -333,7 +363,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -423,7 +462,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -433,7 +473,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -443,7 +484,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -453,7 +495,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -463,7 +506,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -473,7 +517,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -483,7 +528,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -493,7 +539,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -503,7 +550,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -513,7 +561,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -523,7 +572,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -533,7 +583,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -543,7 +594,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -567,7 +620,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -577,7 +631,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -617,7 +675,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -637,7 +697,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -647,7 +708,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -657,7 +719,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -673,7 +736,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -683,7 +747,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -693,7 +758,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -703,7 +769,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -713,7 +780,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -723,7 +791,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -733,7 +802,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -743,7 +813,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -753,7 +824,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Private_Cloud/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Private_Cloud/_index.md index 5a350ca4ae..55ed1ccf30 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Private_Cloud/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Private_Cloud/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -547,7 +598,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -587,7 +642,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -627,7 +686,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -643,7 +703,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -653,7 +714,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -663,7 +725,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -673,7 +736,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -683,7 +747,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -693,7 +758,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -713,7 +780,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Property/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Property/_index.md index 9b19733ac9..3fb3b7a4af 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Property/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Property/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This is used for storing various items about the order. Currently used for storing additional raid information when ordering servers. This is optional @@ -45,7 +47,8 @@ This is used for storing various items about the order. Currently used for stori [name]: #name #### [name] The property name -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The property name [value]: #value #### [value] The property value -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Receipt/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Receipt/_index.md index bd17a86c2c..0d49289cc8 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Receipt/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Receipt/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -53,7 +55,8 @@ This URL refers to the location where you will visit to complete the payment aut Once you visit this location, you will be presented with the options to confirm payment or deny payment. If you confirm payment, you will be redirected back to the receipt for your order. If you deny, you will be redirected back to the cancel order page where you do not need to take any additional action. Until you confirm payment with the external service, your products will not be provisioned or accessible for your consumption. Upon successfully confirming payment, our system will be notified and the order approval and provisioning systems will begin processing. After provisioning is complete, your services will be available. -Type: **string** +Type: **string** + @@ -63,7 +66,8 @@ Until you confirm payment with the external service, your products will not be p [externalPaymentToken]: #externalpaymenttoken #### [externalPaymentToken] This token refers to the identifier for the external payment authorization. This token is associated with the externalPaymentCheckoutUrl and is only populated when purchasing products with an external service like PayPal. -Type: **string** +Type: **string** + @@ -73,7 +77,8 @@ This token refers to the identifier for the external payment authorization. This [orderDate]: #orderdate #### [orderDate] The date when SoftLayer received the order. -Type: **dateTime** +Type: **dateTime** + @@ -83,7 +88,8 @@ The date when SoftLayer received the order. [orderDetails]: #orderdetails #### [orderDetails] This is a copy of the order container (SoftLayer_Container_Product_Order) which holds all the data related to an order. This will only return when an order is processed successfully. It will contain all the items in an order as well as the order totals. -Type: **SoftLayer_Container_Product_Order ** +Type: **SoftLayer_Container_Product_Order ** + @@ -93,7 +99,8 @@ This is a copy of the order container (SoftLayer_Container_Product_Order) which [orderId]: #orderid #### [orderId] SoftLayer's unique identifier for the order. -Type: **integer** +Type: **integer** + @@ -109,7 +116,8 @@ This URL refers to the location where you will visit to complete the payment aut Once you visit PayPal's site, you will be presented with the options to confirm payment or deny payment. If you confirm payment, you will be redirected back to the receipt for your order. If you deny, you will be redirected back to the cancel order page where you do not need to take any additional action. Until you confirm payment with PayPal, your products will not be provisioned or accessible for your consumption. Upon successfully confirming payment, our system will be notified and the order approval and provisioning systems will begin processing. After provisioning is complete, your services will be available. -Type: **string** +Type: **string** + @@ -121,7 +129,8 @@ Until you confirm payment with PayPal, your products will not be provisioned or Deprecation notice: use externalPaymentToken instead of this property. This token refers to the identifier provided when payment is processed via PayPal. This token is associated with the paypalCheckoutUrl. -Type: **string** +Type: **string** + @@ -131,7 +140,8 @@ This token refers to the identifier provided when payment is processed via PayPa [placedOrder]: #placedorder #### [placedOrder] This is a copy of the order that was successfully placed (SoftLayer_Billing_Order). This will only return when an order is processed successfully. -Type: **SoftLayer_Billing_Order ** +Type: **SoftLayer_Billing_Order ** + @@ -141,7 +151,8 @@ This is a copy of the order that was successfully placed (SoftLayer_Billing_Orde [quote]: #quote #### [quote] This is a copy of the quote container (SoftLayer_Billing_Order_Quote) which holds all the data related to a quote. This will only return when a quote is processed successfully. -Type: **SoftLayer_Billing_Order_Quote ** +Type: **SoftLayer_Billing_Order_Quote ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Security_Certificate/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Security_Certificate/_index.md index 02bfacb6b3..12500fedcd 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Security_Certificate/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Security_Certificate/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [administrativeContact]: #administrativecontact #### [administrativeContact] The administrator contact associated with a SSL certificate. If the contact is not provided the technical contact will be used. If the address is not provided the organization information address will be used. -Type: **SoftLayer_Container_Product_Order_Attribute_Contact ** +Type: **SoftLayer_Container_Product_Order_Attribute_Contact ** + @@ -61,7 +64,8 @@ The administrator contact associated with a SSL certificate. If the contact is n [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -71,7 +75,8 @@ Flag for identifying an order for Big Data Deployment. [billingContact]: #billingcontact #### [billingContact] The billing contact associated with a SSL certificate. If the contact is not provided the technical contact will be used. If the address is not provided the organization information address will be used. -Type: **SoftLayer_Container_Product_Order_Attribute_Contact ** +Type: **SoftLayer_Container_Product_Order_Attribute_Contact ** + @@ -81,7 +86,8 @@ The billing contact associated with a SSL certificate. If the contact is not pro [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -91,7 +97,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [certificateSigningRequest]: #certificatesigningrequest #### [certificateSigningRequest] The base64 encoded string that sent from an applicant to a certificate authority. The CSR contains information identifying the applicant and the public key chosen by the applicant. The corresponding private key should not be included. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The base64 encoded string that sent from an applicant to a certificate authority [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -171,7 +185,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -191,7 +207,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -211,7 +229,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -231,7 +251,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -241,7 +262,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -251,7 +273,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -261,7 +284,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -271,7 +295,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -281,7 +306,8 @@ A generic message about the order. Does not need to be sent in with any orders. [orderApproverEmailAddress]: #orderapproveremailaddress #### [orderApproverEmailAddress] The email address that can approve a secure certificate order. -Type: **string** +Type: **string** + @@ -293,7 +319,8 @@ The email address that can approve a secure certificate order. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -303,7 +330,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -313,7 +341,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -323,7 +352,8 @@ Collection of exceptions resulting from the verification of the order. This valu [organizationInformation]: #organizationinformation #### [organizationInformation] The organization information associated with a SSL certificate. -Type: **SoftLayer_Container_Product_Order_Attribute_Organization ** +Type: **SoftLayer_Container_Product_Order_Attribute_Organization ** + @@ -333,7 +363,8 @@ The organization information associated with a SSL certificate. [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -343,7 +374,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -353,7 +385,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -423,7 +462,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -433,7 +473,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -443,7 +484,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -453,7 +495,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -463,7 +506,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -473,7 +517,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -483,7 +528,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -493,7 +539,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -503,7 +550,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -513,7 +561,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -523,7 +572,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -533,7 +583,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -543,7 +594,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -553,7 +605,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -563,7 +616,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [renewalFlag]: #renewalflag #### [renewalFlag] Indicates if it is an renewal order of an existing SSL certificate. -Type: **boolean** +Type: **boolean** + @@ -597,7 +653,8 @@ Indicates if it is an renewal order of an existing SSL certificate. [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -607,7 +664,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -617,7 +675,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -637,7 +697,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -647,7 +708,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -657,7 +719,8 @@ The number of cores for the server being ordered. This value is set internally. [serverCount]: #servercount #### [serverCount] (DEPRECATED) Do not set this property, as it will always be set to 1. -Type: **integer** +Type: **integer** + @@ -667,7 +730,8 @@ The number of cores for the server being ordered. This value is set internally. [serverType]: #servertype #### [serverType] The server type. This is the name from a [SoftLayer_Security_Certificate_Request_ServerType]({{}}) object. -Type: **string** +Type: **string** + @@ -677,7 +741,8 @@ The server type. This is the name from a [SoftLayer_Security_Certificate_Request [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -687,7 +752,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -697,7 +763,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -707,7 +774,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -723,7 +791,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -733,7 +802,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -743,7 +813,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -753,7 +824,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -763,7 +835,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [technicalContact]: #technicalcontact #### [technicalContact] The technical contact associated with a SSL certificate. If the address is not provided the organization information address will be used. -Type: **SoftLayer_Container_Product_Order_Attribute_Contact ** +Type: **SoftLayer_Container_Product_Order_Attribute_Contact ** + @@ -773,7 +846,8 @@ The technical contact associated with a SSL certificate. If the address is not p [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -783,7 +857,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -793,7 +868,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -803,7 +879,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -813,7 +890,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [validityMonths]: #validitymonths #### [validityMonths] (DEPRECATED) The period that a SSL certificate is valid for. For example, 12, 24, 36. This property will be set automatically based on the certificate product ordered when verifying or placing orders. -Type: **integer** +Type: **integer** + @@ -823,7 +901,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Service/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Service/_index.md index 1f619d21f6..7ebd7c430c 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Service/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Service/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -547,7 +598,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -587,7 +642,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -627,7 +686,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -643,7 +703,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -653,7 +714,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -663,7 +725,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -673,7 +736,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -683,7 +747,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -693,7 +758,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -713,7 +780,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Service_External/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Service_External/_index.md index f228ed0bef..f0e2d5282f 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Service_External/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Service_External/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [externalResources]: #externalresources #### [externalResources] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Service_External_Resource[] ** +Type: **SoftLayer_Service_External_Resource[] ** + @@ -161,7 +174,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -171,7 +185,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -191,7 +207,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -221,7 +240,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -231,7 +251,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -251,7 +273,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -263,7 +286,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -273,7 +297,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -283,7 +308,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -293,7 +319,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -303,7 +330,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -313,7 +341,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -403,7 +440,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -413,7 +451,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -423,7 +462,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -433,7 +473,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -443,7 +484,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -453,7 +495,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -473,7 +517,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -483,7 +528,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -503,7 +550,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -513,7 +561,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -523,7 +572,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -547,7 +598,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -557,7 +609,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -567,7 +620,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -577,7 +631,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -597,7 +653,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -607,7 +664,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -617,7 +675,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -637,7 +697,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -653,7 +714,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -663,7 +725,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -673,7 +736,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -683,7 +747,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -693,7 +758,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -713,7 +780,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -723,7 +791,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -733,7 +802,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Software_Component_Virtual/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Software_Component_Virtual/_index.md index 581f77636f..08e4354d59 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Software_Component_Virtual/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Software_Component_Virtual/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [endPointIpAddressIds]: #endpointipaddressids #### [endPointIpAddressIds] array of ip address ids for which a license should be allocated for. -Type: **array of integers** +Type: **array of integers** + @@ -151,7 +163,8 @@ array of ip address ids for which a license should be allocated for. [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -161,7 +174,8 @@ array of ip address ids for which a license should be allocated for. [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -171,7 +185,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -191,7 +207,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -221,7 +240,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -231,7 +251,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -251,7 +273,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -263,7 +286,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -273,7 +297,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -283,7 +308,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -293,7 +319,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -303,7 +330,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -313,7 +341,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -403,7 +440,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -413,7 +451,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -423,7 +462,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -433,7 +473,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -443,7 +484,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -453,7 +495,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -473,7 +517,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -483,7 +528,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -503,7 +550,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -513,7 +561,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -523,7 +572,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -547,7 +598,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -557,7 +609,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -567,7 +620,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -577,7 +631,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -597,7 +653,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -607,7 +664,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -617,7 +675,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -637,7 +697,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -653,7 +714,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -663,7 +725,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -673,7 +736,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -683,7 +747,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -693,7 +758,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -713,7 +780,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -723,7 +791,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -733,7 +802,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Software_License/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Software_License/_index.md index dd267e1979..dd2a96e5d3 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Software_License/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Software_License/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -547,7 +598,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -587,7 +642,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -627,7 +686,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -643,7 +703,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -653,7 +714,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -663,7 +725,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -673,7 +736,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -683,7 +747,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -693,7 +758,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -713,7 +780,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_SshKeys/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_SshKeys/_index.md index 0ae422802c..9cbcea0447 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_SshKeys/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_SshKeys/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object holds all of the ssh key ids that will allow authentication to a single server. @@ -45,7 +47,8 @@ This object holds all of the ssh key ids that will allow authentication to a sin [sshKeyIds]: #sshkeyids #### [sshKeyIds] An array of SoftLayer_Security_Ssh_Key IDs to assign to a server. -Type: **array of integers** +Type: **array of integers** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Storage_Group/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Storage_Group/_index.md index 1e2a2d7fd5..c6d199540f 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Storage_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Storage_Group/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + 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. @@ -49,7 +51,8 @@ This object describes a single storage group that can be added to an order conta [arraySize]: #arraysize #### [arraySize] Size of the array in gigabytes. Must be within limitations of the smallest drive assigned to the storage group and the storage group type. -Type: **decimal** +Type: **decimal** + @@ -59,7 +62,8 @@ Size of the array in gigabytes. Must be within limitations of the smallest drive [arrayTypeId]: #arraytypeid #### [arrayTypeId] The array type id from a [SoftLayer_Configuration_Storage_Group_Array_Type]({{}}) object. -Type: **integer** +Type: **integer** + @@ -71,7 +75,8 @@ The array type id from a [SoftLayer_Configuration_Storage_Group_Array_Type]({{Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This must match a disk controller price on the order. The disk controller index [hardDrives]: #harddrives #### [hardDrives] Integer array of drive indexes to use in the storage group. -Type: **array of integers** +Type: **array of integers** + @@ -93,7 +99,8 @@ Integer array of drive indexes to use in the storage group. If an array should be protected by an hotspare, the drive index of the hotspares should be here. If a drive is a hotspare for all arrays then a separate storage group with array type GLOBAL_HOT_SPARE should be used -Type: **array of integers** +Type: **array of integers** + @@ -103,7 +110,8 @@ If a drive is a hotspare for all arrays then a separate storage group with array [lvmFlag]: #lvmflag #### [lvmFlag] << EOT -Type: **boolean** +Type: **boolean** + @@ -115,7 +123,8 @@ If a drive is a hotspare for all arrays then a separate storage group with array The id for a [SoftLayer_Hardware_Component_Partition_Template]({{}}) object, which will determine the partitions to add to the storage group. If this storage group is not a primary storage group, then this will not be used. -Type: **integer** +Type: **integer** + @@ -127,7 +136,8 @@ If this storage group is not a primary storage group, then this will not be used Defines the partitions for the storage group. If this storage group is not a secondary storage group, then this will not be used. -Type: **SoftLayer_Container_Product_Order_Storage_Group_Partition[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group_Partition[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Storage_Group_Partition/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Storage_Group_Partition/_index.md index e1b8f6434c..d89e6031a7 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Storage_Group_Partition/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Storage_Group_Partition/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + 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. @@ -49,7 +51,8 @@ This object describes the partitions for a single storage group that can be adde [isGrow]: #isgrow #### [isGrow] Is this a grow partition -Type: **boolean** +Type: **boolean** + @@ -59,7 +62,8 @@ Is this a grow partition [name]: #name #### [name] The name of this partition -Type: **string** +Type: **string** + @@ -69,7 +73,8 @@ The name of this partition [size]: #size #### [size] The size of this partition -Type: **decimal** +Type: **decimal** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Support/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Support/_index.md index 0a103ed17d..bf4cfba0e9 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Support/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Support/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + When ordering paid support this datatype needs to be populated and sent to SoftLayer_Product_Order::placeOrder. @@ -51,7 +53,8 @@ When ordering paid support this datatype needs to be populated and sent to SoftL [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -547,7 +598,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -587,7 +642,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -627,7 +686,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -643,7 +703,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -653,7 +714,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -663,7 +725,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -673,7 +736,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -683,7 +747,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -693,7 +758,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -713,7 +780,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_User_Customer_External_Binding/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_User_Customer_External_Binding/_index.md index b66fb12b7f..f9dce743a7 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_User_Customer_External_Binding/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_User_Customer_External_Binding/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This container type is used for placing orders for external authentication, such as phone-based authentication. @@ -51,7 +53,8 @@ This container type is used for placing orders for external authentication, such [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [externalId]: #externalid #### [externalId] The external id that access to external authentication is being purchased for. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ The external id that access to external authentication is being purchased for. [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -171,7 +185,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -191,7 +207,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -221,7 +240,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -231,7 +251,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -251,7 +273,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -263,7 +286,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -273,7 +297,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -283,7 +308,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -293,7 +319,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -303,7 +330,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -313,7 +341,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -403,7 +440,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -413,7 +451,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -423,7 +462,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -433,7 +473,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -443,7 +484,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -453,7 +495,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -473,7 +517,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -483,7 +528,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -503,7 +550,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -513,7 +561,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -523,7 +572,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -547,7 +598,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -557,7 +609,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -567,7 +620,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -577,7 +631,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -597,7 +653,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -607,7 +664,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -617,7 +675,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -637,7 +697,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -653,7 +714,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -663,7 +725,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -673,7 +736,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -683,7 +747,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -693,7 +758,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -713,7 +780,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -723,7 +791,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -733,7 +802,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [userId]: #userid #### [userId] The SoftLayer [SoftLayer_User_Customer]({{}}) identifier that an external binding is being purchased for. -Type: **integer** +Type: **integer** + @@ -743,7 +813,8 @@ The SoftLayer [SoftLayer_User_Customer]({{}}) identifier for the external binding being purchased. -Type: **integer** +Type: **integer** + @@ -753,7 +824,8 @@ The [SoftLayer_User_Customer_External_Binding_Vendor]({{hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_DedicatedHost/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_DedicatedHost/_index.md index 46288feb07..c7f7eabe00 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_DedicatedHost/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_DedicatedHost/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This is the default container type for Dedicated Virtual Host orders. @@ -51,7 +53,8 @@ This is the default container type for Dedicated Virtual Host orders. [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -161,7 +174,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -181,7 +196,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -221,7 +240,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -241,7 +262,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -253,7 +275,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -263,7 +286,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -273,7 +297,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -283,7 +308,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -293,7 +319,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -313,7 +341,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -393,7 +429,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -403,7 +440,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -413,7 +451,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -433,7 +473,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -443,7 +484,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -453,7 +495,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -473,7 +517,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -483,7 +528,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -503,7 +550,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -527,7 +576,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -547,7 +598,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -587,7 +642,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -597,7 +653,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -607,7 +664,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -627,7 +686,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -643,7 +703,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -653,7 +714,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -663,7 +725,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -673,7 +736,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -683,7 +747,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -693,7 +758,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -713,7 +780,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -723,7 +791,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Disk_Image/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Disk_Image/_index.md index b1c61dcf0c..926512a069 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Disk_Image/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Disk_Image/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Device Fingerprint Identifier - Optional. [diskDescription]: #diskdescription #### [diskDescription] Label for the portable storage volume. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ Label for the portable storage volume. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -161,7 +174,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -171,7 +185,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -191,7 +207,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -221,7 +240,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -231,7 +251,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -251,7 +273,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -263,7 +286,8 @@ A generic message about the order. Does not need to be sent in with any orders. Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -273,7 +297,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -283,7 +308,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -293,7 +319,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -303,7 +330,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -313,7 +341,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -323,7 +352,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -403,7 +440,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -413,7 +451,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -423,7 +462,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -433,7 +473,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -443,7 +484,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -453,7 +495,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -463,7 +506,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -473,7 +517,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -483,7 +528,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -493,7 +539,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -503,7 +550,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -513,7 +561,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -523,7 +572,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -537,7 +587,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -547,7 +598,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -557,7 +609,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -567,7 +620,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -577,7 +631,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -597,7 +653,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -607,7 +664,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -617,7 +675,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -627,7 +686,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -637,7 +697,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -653,7 +714,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -663,7 +725,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -673,7 +736,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -683,7 +747,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -693,7 +758,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -703,7 +769,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -713,7 +780,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -723,7 +791,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -733,7 +802,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest/_index.md index dfe80ad085..2ec59f73b9 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ Used to identify which category should be used for the boot disk. [bootMode]: #bootmode #### [bootMode] The mode used to boot the [SoftLayer_Virtual_Guest]({{}}). Supported values are 'PV' and 'HVM'. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The mode used to boot the [SoftLayer_Virtual_Guest]({{}}) to boot from. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ Identifier of the [SoftLayer_Virtual_Disk_Image]({{Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [clusterIdentifier]: #clusteridentifier #### [clusterIdentifier] Used to identify which items on an order belong in the same cluster. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Used to identify which items on an order belong in the same cluster. [clusterOrderType]: #clusterordertype #### [clusterOrderType] Indicates what type of cluster order is being placed (HA, Provision). -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ Indicates what type of cluster order is being placed (HA, Provision). [clusterResourceId]: #clusterresourceid #### [clusterResourceId] Used to identify which gateway is being upgraded to HA. -Type: **integer** +Type: **integer** + @@ -151,7 +163,8 @@ Used to identify which gateway is being upgraded to HA. [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -171,7 +185,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ This has been deprecated. It is the identifier used to track configurations in l [driveDestructionDisks]: #drivedestructiondisks #### [driveDestructionDisks] Array of disk drive slot categories to destroy on reclaim. For example: ['disk0', 'disk1', 'disk2']. One drive_destruction price must be included for each slot provided. Note that once the initial order or upgrade order are approved, the destruction property is not removable and the drives will be destroyed at the end of the server's lifecycle. Not all drive slots are required, but all can be provided. -Type: **array of strings** +Type: **array of strings** + @@ -211,7 +229,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -221,7 +240,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -231,7 +251,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -241,7 +262,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -251,7 +273,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [hostId]: #hostid #### [hostId] Identifier of [SoftLayer_Virtual_DedicatedHost]({{}}) to order -Type: **integer** +Type: **integer** + @@ -261,7 +284,8 @@ Identifier of [SoftLayer_Virtual_DedicatedHost]({{Type: **string** +Type: **string** + @@ -271,7 +295,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -281,7 +306,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -291,7 +317,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -301,7 +328,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -311,7 +339,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -321,7 +350,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -331,7 +361,8 @@ A generic message about the order. Does not need to be sent in with any orders. [monitoringAgentConfigurationTemplateGroupId]: #monitoringagentconfigurationtemplategroupid #### [monitoringAgentConfigurationTemplateGroupId] Id used with the monitoring package. (Deprecated) -Type: **integer** +Type: **integer** + @@ -343,7 +374,8 @@ Id used with the monitoring package. (Deprecated) Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -353,7 +385,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -363,7 +396,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -373,7 +407,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -383,7 +418,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -393,7 +429,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -423,7 +462,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -433,7 +473,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -443,7 +484,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -453,7 +495,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -463,7 +506,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -473,7 +517,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -483,7 +528,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -493,7 +539,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -503,7 +550,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -523,7 +572,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -533,7 +583,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -543,7 +594,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [privateCloudServerRole]: #privatecloudserverrole #### [privateCloudServerRole] When ordering Virtual Server (Private Node), this variable specifies the role of the server configuration. (Deprecated) -Type: **string** +Type: **string** + @@ -553,7 +605,8 @@ When ordering Virtual Server (Private Node), this variable specifies the role of [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -563,7 +616,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -573,7 +627,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -583,7 +638,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -593,7 +649,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -603,7 +660,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -613,7 +671,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -627,7 +686,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -637,7 +697,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [requiredUpstreamDeviceId]: #requiredupstreamdeviceid #### [requiredUpstreamDeviceId] Used to identify which device the new server should be attached to. -Type: **integer** +Type: **integer** + @@ -647,7 +708,8 @@ Used to identify which device the new server should be attached to. [reservedCapacityId]: #reservedcapacityid #### [reservedCapacityId] Identifier of [SoftLayer_Virtual_ReservedCapacityGroup]({{}}) to order -Type: **integer** +Type: **integer** + @@ -657,7 +719,8 @@ Identifier of [SoftLayer_Virtual_ReservedCapacityGroup]({{Type: **integer** +Type: **integer** + @@ -667,7 +730,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -677,7 +741,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -687,7 +752,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -697,7 +763,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -707,7 +774,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -717,7 +785,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -727,7 +796,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -737,7 +807,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -747,7 +818,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -763,7 +835,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -773,7 +846,8 @@ The first storage group in this array will be considered the primary storage gro [tags]: #tags #### [tags] tags (used in MongoDB deployments). (Deprecated) -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -783,7 +857,8 @@ tags (used in MongoDB deployments). (Deprecated) [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -793,7 +868,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -803,7 +879,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -813,7 +890,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -823,7 +901,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -833,7 +912,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -843,7 +923,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -853,7 +934,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Upgrade/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Upgrade/_index.md index 9292802785..59921ffe1a 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Upgrade/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Upgrade/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Product_Or [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -71,7 +75,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ Used to identify which category should be used for the boot disk. [bootMode]: #bootmode #### [bootMode] The mode used to boot the [SoftLayer_Virtual_Guest]({{}}). Supported values are 'PV' and 'HVM'. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The mode used to boot the [SoftLayer_Virtual_Guest]({{}}) to boot from. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ Identifier of the [SoftLayer_Virtual_Disk_Image]({{Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [clusterIdentifier]: #clusteridentifier #### [clusterIdentifier] Used to identify which items on an order belong in the same cluster. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ Used to identify which items on an order belong in the same cluster. [clusterOrderType]: #clusterordertype #### [clusterOrderType] Indicates what type of cluster order is being placed (HA, Provision). -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ Indicates what type of cluster order is being placed (HA, Provision). [clusterResourceId]: #clusterresourceid #### [clusterResourceId] Used to identify which gateway is being upgraded to HA. -Type: **integer** +Type: **integer** + @@ -151,7 +163,8 @@ Used to identify which gateway is being upgraded to HA. [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -171,7 +185,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ This has been deprecated. It is the identifier used to track configurations in l [driveDestructionDisks]: #drivedestructiondisks #### [driveDestructionDisks] Array of disk drive slot categories to destroy on reclaim. For example: ['disk0', 'disk1', 'disk2']. One drive_destruction price must be included for each slot provided. Note that once the initial order or upgrade order are approved, the destruction property is not removable and the drives will be destroyed at the end of the server's lifecycle. Not all drive slots are required, but all can be provided. -Type: **array of strings** +Type: **array of strings** + @@ -211,7 +229,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -221,7 +240,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -231,7 +251,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -241,7 +262,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -251,7 +273,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [hostId]: #hostid #### [hostId] Identifier of [SoftLayer_Virtual_DedicatedHost]({{}}) to order -Type: **integer** +Type: **integer** + @@ -261,7 +284,8 @@ Identifier of [SoftLayer_Virtual_DedicatedHost]({{Type: **string** +Type: **string** + @@ -271,7 +295,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -281,7 +306,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -291,7 +317,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -301,7 +328,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -311,7 +339,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -321,7 +350,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -331,7 +361,8 @@ A generic message about the order. Does not need to be sent in with any orders. [monitoringAgentConfigurationTemplateGroupId]: #monitoringagentconfigurationtemplategroupid #### [monitoringAgentConfigurationTemplateGroupId] Id used with the monitoring package. (Deprecated) -Type: **integer** +Type: **integer** + @@ -343,7 +374,8 @@ Id used with the monitoring package. (Deprecated) Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -353,7 +385,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -363,7 +396,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -373,7 +407,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -383,7 +418,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -393,7 +429,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -413,7 +451,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -423,7 +462,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -433,7 +473,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -443,7 +484,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -453,7 +495,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -463,7 +506,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -473,7 +517,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -483,7 +528,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -493,7 +539,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -503,7 +550,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -513,7 +561,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -523,7 +572,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -533,7 +583,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -543,7 +594,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [privateCloudServerRole]: #privatecloudserverrole #### [privateCloudServerRole] When ordering Virtual Server (Private Node), this variable specifies the role of the server configuration. (Deprecated) -Type: **string** +Type: **string** + @@ -553,7 +605,8 @@ When ordering Virtual Server (Private Node), this variable specifies the role of [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -563,7 +616,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -573,7 +627,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -583,7 +638,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -593,7 +649,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -603,7 +660,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -613,7 +671,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -627,7 +686,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -637,7 +697,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [requiredUpstreamDeviceId]: #requiredupstreamdeviceid #### [requiredUpstreamDeviceId] Used to identify which device the new server should be attached to. -Type: **integer** +Type: **integer** + @@ -647,7 +708,8 @@ Used to identify which device the new server should be attached to. [reservedCapacityId]: #reservedcapacityid #### [reservedCapacityId] Identifier of [SoftLayer_Virtual_ReservedCapacityGroup]({{}}) to order -Type: **integer** +Type: **integer** + @@ -657,7 +719,8 @@ Identifier of [SoftLayer_Virtual_ReservedCapacityGroup]({{Type: **integer** +Type: **integer** + @@ -667,7 +730,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -677,7 +741,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -687,7 +752,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -697,7 +763,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -707,7 +774,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -717,7 +785,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -727,7 +796,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -737,7 +807,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -747,7 +818,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -763,7 +835,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -773,7 +846,8 @@ The first storage group in this array will be considered the primary storage gro [tags]: #tags #### [tags] tags (used in MongoDB deployments). (Deprecated) -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -783,7 +857,8 @@ tags (used in MongoDB deployments). (Deprecated) [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -793,7 +868,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -803,7 +879,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -813,7 +890,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -823,7 +901,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -833,7 +912,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -843,7 +923,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -853,7 +934,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Vpc/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Vpc/_index.md index 5d962b9720..5a868e77f3 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Vpc/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Vpc/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [additionalNetworkInterfaces]: #additionalnetworkinterfaces #### [additionalNetworkInterfaces] -Type: **SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_NetworkInterface[] ** +Type: **SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_NetworkInterface[] ** +
      @@ -55,7 +58,8 @@ classes: [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** +
      @@ -65,7 +69,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -75,7 +80,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Used to identify which category should be used for the boot disk. [bootMode]: #bootmode #### [bootMode] The mode used to boot the [SoftLayer_Virtual_Guest]({{}}). Supported values are 'PV' and 'HVM'. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The mode used to boot the [SoftLayer_Virtual_Guest]({{}}) to boot from. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ Identifier of the [SoftLayer_Virtual_Disk_Image]({{Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [clusterIdentifier]: #clusteridentifier #### [clusterIdentifier] Used to identify which items on an order belong in the same cluster. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Used to identify which items on an order belong in the same cluster. [clusterOrderType]: #clusterordertype #### [clusterOrderType] Indicates what type of cluster order is being placed (HA, Provision). -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ Indicates what type of cluster order is being placed (HA, Provision). [clusterResourceId]: #clusterresourceid #### [clusterResourceId] Used to identify which gateway is being upgraded to HA. -Type: **integer** +Type: **integer** + @@ -155,7 +168,8 @@ Used to identify which gateway is being upgraded to HA. [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ This hash is internally-generated and is used to for tracking order containers. [crn]: #crn #### [crn] -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -195,7 +212,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -205,7 +223,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -215,7 +234,8 @@ This has been deprecated. It is the identifier used to track configurations in l [driveDestructionDisks]: #drivedestructiondisks #### [driveDestructionDisks] Array of disk drive slot categories to destroy on reclaim. For example: ['disk0', 'disk1', 'disk2']. One drive_destruction price must be included for each slot provided. Note that once the initial order or upgrade order are approved, the destruction property is not removable and the drives will be destroyed at the end of the server's lifecycle. Not all drive slots are required, but all can be provided. -Type: **array of strings** +Type: **array of strings** + @@ -225,7 +245,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -235,7 +256,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -245,7 +267,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -255,7 +278,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -265,7 +289,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [hostId]: #hostid #### [hostId] Identifier of [SoftLayer_Virtual_DedicatedHost]({{}}) to order -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ Identifier of [SoftLayer_Virtual_DedicatedHost]({{Type: **string** +Type: **string** + @@ -285,7 +311,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -295,7 +322,8 @@ An optional virtual disk image template identifier to be used as an installation [instanceProfile]: #instanceprofile #### [instanceProfile] -Type: **string** +Type: **string** + @@ -305,7 +333,8 @@ An optional virtual disk image template identifier to be used as an installation [ipAllocations]: #ipallocations #### [ipAllocations] -Type: **SoftLayer_Container_Product_Order_Vpc_IpAllocation[] ** +Type: **SoftLayer_Container_Product_Order_Vpc_IpAllocation[] ** + @@ -315,7 +344,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -325,7 +355,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -335,7 +366,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -345,7 +377,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -355,7 +388,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -365,7 +399,8 @@ A generic message about the order. Does not need to be sent in with any orders. [monitoringAgentConfigurationTemplateGroupId]: #monitoringagentconfigurationtemplategroupid #### [monitoringAgentConfigurationTemplateGroupId] Id used with the monitoring package. (Deprecated) -Type: **integer** +Type: **integer** + @@ -377,7 +412,8 @@ Id used with the monitoring package. (Deprecated) Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -387,7 +423,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -397,7 +434,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -407,7 +445,8 @@ Collection of exceptions resulting from the verification of the order. This valu [overlayNetworkFlag]: #overlaynetworkflag #### [overlayNetworkFlag] -Type: **boolean** +Type: **boolean** + @@ -417,7 +456,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -427,7 +467,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -437,7 +478,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -447,7 +489,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -457,7 +500,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -467,7 +511,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -477,7 +522,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -487,7 +533,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -497,7 +544,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -507,7 +555,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -517,7 +566,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -527,7 +577,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -537,7 +588,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -547,7 +599,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -557,7 +610,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -567,7 +621,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -577,7 +632,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -587,7 +643,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [privateCloudServerRole]: #privatecloudserverrole #### [privateCloudServerRole] When ordering Virtual Server (Private Node), this variable specifies the role of the server configuration. (Deprecated) -Type: **string** +Type: **string** + @@ -597,7 +654,8 @@ When ordering Virtual Server (Private Node), this variable specifies the role of [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -607,7 +665,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -617,7 +676,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -627,7 +687,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -637,7 +698,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -647,7 +709,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -657,7 +720,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -671,7 +735,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -681,7 +746,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [requiredUpstreamDeviceId]: #requiredupstreamdeviceid #### [requiredUpstreamDeviceId] Used to identify which device the new server should be attached to. -Type: **integer** +Type: **integer** + @@ -691,7 +757,8 @@ Used to identify which device the new server should be attached to. [reservedCapacityId]: #reservedcapacityid #### [reservedCapacityId] Identifier of [SoftLayer_Virtual_ReservedCapacityGroup]({{}}) to order -Type: **integer** +Type: **integer** + @@ -701,7 +768,8 @@ Identifier of [SoftLayer_Virtual_ReservedCapacityGroup]({{Type: **string** +Type: **string** + @@ -711,7 +779,8 @@ Identifier of [SoftLayer_Virtual_ReservedCapacityGroup]({{Type: **integer** +Type: **integer** + @@ -721,7 +790,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -731,7 +801,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -741,7 +812,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -751,7 +823,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -761,7 +834,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -771,7 +845,8 @@ The number of cores for the server being ordered. This value is set internally. [serverId]: #serverid #### [serverId] -Type: **string** +Type: **string** + @@ -781,7 +856,8 @@ The number of cores for the server being ordered. This value is set internally. [servicePortCidr]: #serviceportcidr #### [servicePortCidr] -Type: **string** +Type: **string** + @@ -791,7 +867,8 @@ The number of cores for the server being ordered. This value is set internally. [servicePortDns]: #serviceportdns #### [servicePortDns] -Type: **array of strings** +Type: **array of strings** + @@ -801,7 +878,8 @@ The number of cores for the server being ordered. This value is set internally. [servicePortGateway]: #serviceportgateway #### [servicePortGateway] -Type: **string** +Type: **string** + @@ -811,7 +889,8 @@ The number of cores for the server being ordered. This value is set internally. [servicePortInterfaceId]: #serviceportinterfaceid #### [servicePortInterfaceId] -Type: **string** +Type: **string** + @@ -821,7 +900,8 @@ The number of cores for the server being ordered. This value is set internally. [servicePortIpAddress]: #serviceportipaddress #### [servicePortIpAddress] -Type: **string** +Type: **string** + @@ -831,7 +911,8 @@ The number of cores for the server being ordered. This value is set internally. [servicePortIpAllocationId]: #serviceportipallocationid #### [servicePortIpAllocationId] -Type: **string** +Type: **string** + @@ -841,7 +922,8 @@ The number of cores for the server being ordered. This value is set internally. [servicePortVpcId]: #serviceportvpcid #### [servicePortVpcId] -Type: **string** +Type: **string** + @@ -851,7 +933,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -861,7 +944,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -871,7 +955,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -881,7 +966,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -897,7 +983,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -907,7 +994,8 @@ The first storage group in this array will be considered the primary storage gro [storageVolumes]: #storagevolumes #### [storageVolumes] -Type: **SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_StorageVolume[] ** +Type: **SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_StorageVolume[] ** + @@ -917,7 +1005,8 @@ The first storage group in this array will be considered the primary storage gro [subnets]: #subnets #### [subnets] -Type: **SoftLayer_Container_Product_Order_Vpc_Subnet[] ** +Type: **SoftLayer_Container_Product_Order_Vpc_Subnet[] ** + @@ -927,7 +1016,8 @@ The first storage group in this array will be considered the primary storage gro [tags]: #tags #### [tags] tags (used in MongoDB deployments). (Deprecated) -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -937,7 +1027,8 @@ tags (used in MongoDB deployments). (Deprecated) [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -947,7 +1038,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -957,7 +1049,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -967,7 +1060,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -977,7 +1071,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -987,7 +1082,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -997,7 +1093,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -1007,7 +1104,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -1017,7 +1115,8 @@ For virtual guest (virtual server) orders, this property is required if you did [zone]: #zone #### [zone] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_NetworkInterface/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_NetworkInterface/_index.md index 544c9b3cd2..7851ab903e 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_NetworkInterface/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_NetworkInterface/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [cidr]: #cidr #### [cidr] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [dns]: #dns #### [dns] -Type: **array of strings** +Type: **array of strings** +
      @@ -65,7 +69,8 @@ classes: [gateway]: #gateway #### [gateway] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [interfaceId]: #interfaceid #### [interfaceId] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [ipAddress]: #ipaddress #### [ipAddress] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [ipAllocationId]: #ipallocationid #### [ipAllocationId] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ classes: [securityGroupIds]: #securitygroupids #### [securityGroupIds] -Type: **array of integers** +Type: **array of integers** + @@ -115,7 +124,8 @@ classes: [subnetId]: #subnetid #### [subnetId] -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ classes: [vpcId]: #vpcid #### [vpcId] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_StorageVolume/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_StorageVolume/_index.md index 13507beed8..63a1f3a74a 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_StorageVolume/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_StorageVolume/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [attachmentName]: #attachmentname #### [attachmentName] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [capacity]: #capacity #### [capacity] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [deleteOnReclaim]: #deleteonreclaim #### [deleteOnReclaim] -Type: **boolean** +Type: **boolean** + @@ -75,7 +80,8 @@ classes: [id]: #id #### [id] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [index]: #index #### [index] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [iops]: #iops #### [iops] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [profile]: #profile #### [profile] -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ classes: [resourceGroup]: #resourcegroup #### [resourceGroup] -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ classes: [rootKeyCrn]: #rootkeycrn #### [rootKeyCrn] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_Upgrade/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_Upgrade/_index.md index a099e641af..8c95ec42a2 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_Upgrade/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_Upgrade/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [additionalNetworkInterfaces]: #additionalnetworkinterfaces #### [additionalNetworkInterfaces] -Type: **SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_NetworkInterface[] ** +Type: **SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_NetworkInterface[] ** +
      @@ -55,7 +58,8 @@ classes: [bigDataOrderFlag]: #bigdataorderflag #### [bigDataOrderFlag] Flag for identifying an order for Big Data Deployment. -Type: **boolean** +Type: **boolean** +
      @@ -65,7 +69,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -75,7 +80,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Used to identify which category should be used for the boot disk. [bootMode]: #bootmode #### [bootMode] The mode used to boot the [SoftLayer_Virtual_Guest]({{}}). Supported values are 'PV' and 'HVM'. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The mode used to boot the [SoftLayer_Virtual_Guest]({{}}) to boot from. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ Identifier of the [SoftLayer_Virtual_Disk_Image]({{Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [clusterIdentifier]: #clusteridentifier #### [clusterIdentifier] Used to identify which items on an order belong in the same cluster. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Used to identify which items on an order belong in the same cluster. [clusterOrderType]: #clusterordertype #### [clusterOrderType] Indicates what type of cluster order is being placed (HA, Provision). -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ Indicates what type of cluster order is being placed (HA, Provision). [clusterResourceId]: #clusterresourceid #### [clusterResourceId] Used to identify which gateway is being upgraded to HA. -Type: **integer** +Type: **integer** + @@ -155,7 +168,8 @@ Used to identify which gateway is being upgraded to HA. [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ This hash is internally-generated and is used to for tracking order containers. [crn]: #crn #### [crn] -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -195,7 +212,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -205,7 +223,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -215,7 +234,8 @@ This has been deprecated. It is the identifier used to track configurations in l [driveDestructionDisks]: #drivedestructiondisks #### [driveDestructionDisks] Array of disk drive slot categories to destroy on reclaim. For example: ['disk0', 'disk1', 'disk2']. One drive_destruction price must be included for each slot provided. Note that once the initial order or upgrade order are approved, the destruction property is not removable and the drives will be destroyed at the end of the server's lifecycle. Not all drive slots are required, but all can be provided. -Type: **array of strings** +Type: **array of strings** + @@ -225,7 +245,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -235,7 +256,8 @@ Array of disk drive slot categories to destroy on reclaim. For example: ['disk0' [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -245,7 +267,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -255,7 +278,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -265,7 +289,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [hostId]: #hostid #### [hostId] Identifier of [SoftLayer_Virtual_DedicatedHost]({{}}) to order -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ Identifier of [SoftLayer_Virtual_DedicatedHost]({{Type: **string** +Type: **string** + @@ -285,7 +311,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -295,7 +322,8 @@ An optional virtual disk image template identifier to be used as an installation [instanceProfile]: #instanceprofile #### [instanceProfile] -Type: **string** +Type: **string** + @@ -305,7 +333,8 @@ An optional virtual disk image template identifier to be used as an installation [ipAllocations]: #ipallocations #### [ipAllocations] -Type: **SoftLayer_Container_Product_Order_Vpc_IpAllocation[] ** +Type: **SoftLayer_Container_Product_Order_Vpc_IpAllocation[] ** + @@ -315,7 +344,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -325,7 +355,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -335,7 +366,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -345,7 +377,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -355,7 +388,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -365,7 +399,8 @@ A generic message about the order. Does not need to be sent in with any orders. [monitoringAgentConfigurationTemplateGroupId]: #monitoringagentconfigurationtemplategroupid #### [monitoringAgentConfigurationTemplateGroupId] Id used with the monitoring package. (Deprecated) -Type: **integer** +Type: **integer** + @@ -377,7 +412,8 @@ Id used with the monitoring package. (Deprecated) Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -387,7 +423,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -397,7 +434,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -407,7 +445,8 @@ Collection of exceptions resulting from the verification of the order. This valu [overlayNetworkFlag]: #overlaynetworkflag #### [overlayNetworkFlag] -Type: **boolean** +Type: **boolean** + @@ -417,7 +456,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -427,7 +467,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -437,7 +478,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -447,7 +489,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -457,7 +500,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -467,7 +511,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -477,7 +522,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -487,7 +533,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -497,7 +544,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -507,7 +555,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -517,7 +566,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -527,7 +577,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -537,7 +588,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -547,7 +599,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -557,7 +610,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -567,7 +621,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -577,7 +632,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -587,7 +643,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [privateCloudServerRole]: #privatecloudserverrole #### [privateCloudServerRole] When ordering Virtual Server (Private Node), this variable specifies the role of the server configuration. (Deprecated) -Type: **string** +Type: **string** + @@ -597,7 +654,8 @@ When ordering Virtual Server (Private Node), this variable specifies the role of [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -607,7 +665,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -617,7 +676,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -627,7 +687,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -637,7 +698,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -647,7 +709,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -657,7 +720,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -671,7 +735,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -681,7 +746,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [requiredUpstreamDeviceId]: #requiredupstreamdeviceid #### [requiredUpstreamDeviceId] Used to identify which device the new server should be attached to. -Type: **integer** +Type: **integer** + @@ -691,7 +757,8 @@ Used to identify which device the new server should be attached to. [reservedCapacityId]: #reservedcapacityid #### [reservedCapacityId] Identifier of [SoftLayer_Virtual_ReservedCapacityGroup]({{}}) to order -Type: **integer** +Type: **integer** + @@ -701,7 +768,8 @@ Identifier of [SoftLayer_Virtual_ReservedCapacityGroup]({{Type: **string** +Type: **string** + @@ -711,7 +779,8 @@ Identifier of [SoftLayer_Virtual_ReservedCapacityGroup]({{Type: **integer** +Type: **integer** + @@ -721,7 +790,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -731,7 +801,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -741,7 +812,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -751,7 +823,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -761,7 +834,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -771,7 +845,8 @@ The number of cores for the server being ordered. This value is set internally. [serverId]: #serverid #### [serverId] -Type: **string** +Type: **string** + @@ -781,7 +856,8 @@ The number of cores for the server being ordered. This value is set internally. [servicePortCidr]: #serviceportcidr #### [servicePortCidr] -Type: **string** +Type: **string** + @@ -791,7 +867,8 @@ The number of cores for the server being ordered. This value is set internally. [servicePortDns]: #serviceportdns #### [servicePortDns] -Type: **array of strings** +Type: **array of strings** + @@ -801,7 +878,8 @@ The number of cores for the server being ordered. This value is set internally. [servicePortGateway]: #serviceportgateway #### [servicePortGateway] -Type: **string** +Type: **string** + @@ -811,7 +889,8 @@ The number of cores for the server being ordered. This value is set internally. [servicePortInterfaceId]: #serviceportinterfaceid #### [servicePortInterfaceId] -Type: **string** +Type: **string** + @@ -821,7 +900,8 @@ The number of cores for the server being ordered. This value is set internally. [servicePortIpAddress]: #serviceportipaddress #### [servicePortIpAddress] -Type: **string** +Type: **string** + @@ -831,7 +911,8 @@ The number of cores for the server being ordered. This value is set internally. [servicePortIpAllocationId]: #serviceportipallocationid #### [servicePortIpAllocationId] -Type: **string** +Type: **string** + @@ -841,7 +922,8 @@ The number of cores for the server being ordered. This value is set internally. [servicePortVpcId]: #serviceportvpcid #### [servicePortVpcId] -Type: **string** +Type: **string** + @@ -851,7 +933,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -861,7 +944,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -871,7 +955,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -881,7 +966,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -897,7 +983,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -907,7 +994,8 @@ The first storage group in this array will be considered the primary storage gro [storageVolumes]: #storagevolumes #### [storageVolumes] -Type: **SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_StorageVolume[] ** +Type: **SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_StorageVolume[] ** + @@ -917,7 +1005,8 @@ The first storage group in this array will be considered the primary storage gro [subnets]: #subnets #### [subnets] -Type: **SoftLayer_Container_Product_Order_Vpc_Subnet[] ** +Type: **SoftLayer_Container_Product_Order_Vpc_Subnet[] ** + @@ -927,7 +1016,8 @@ The first storage group in this array will be considered the primary storage gro [tags]: #tags #### [tags] tags (used in MongoDB deployments). (Deprecated) -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -937,7 +1027,8 @@ tags (used in MongoDB deployments). (Deprecated) [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -947,7 +1038,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -957,7 +1049,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -967,7 +1060,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -977,7 +1071,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -987,7 +1082,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -997,7 +1093,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -1007,7 +1104,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -1017,7 +1115,8 @@ For virtual guest (virtual server) orders, this property is required if you did [zone]: #zone #### [zone] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_ReservedCapacity/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_ReservedCapacity/_index.md index e46b24d107..d47f2171e7 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_ReservedCapacity/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_ReservedCapacity/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This is the default container type for Reserved Capacity orders. @@ -51,7 +53,8 @@ This is the default container type for Reserved Capacity orders. [backendRouterId]: #backendrouterid #### [backendRouterId] Identifier of [SoftLayer_Hardware_Router]({{}}) on which the capacity will be -Type: **integer** +Type: **integer** + @@ -61,7 +64,8 @@ Identifier of [SoftLayer_Hardware_Router]({{Type: **boolean** +Type: **boolean** + @@ -71,7 +75,8 @@ Flag for identifying an order for Big Data Deployment. [billingInformation]: #billinginformation #### [billingInformation] Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. -Type: **SoftLayer_Container_Product_Order_Billing_Information ** +Type: **SoftLayer_Container_Product_Order_Billing_Information ** + @@ -81,7 +86,8 @@ Billing Information associated with an order. For existing customers this inform [billingOrderItemId]: #billingorderitemid #### [billingOrderItemId] This is the ID of the [SoftLayer_Billing_Order_Item]({{}}) of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ This is the ID of the [SoftLayer_Billing_Order_Item]({{Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The URL to which PayPal redirects browser after checkout has been canceled befor [containerIdentifier]: #containeridentifier #### [containerIdentifier] User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ User-specified description to identify a particular order container. This is use [containerSplHash]: #containersplhash #### [containerSplHash] This hash is internally-generated and is used to for tracking order containers. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ This hash is internally-generated and is used to for tracking order containers. [currencyShortName]: #currencyshortname #### [currencyShortName] The currency type chosen at checkout. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The currency type chosen at checkout. [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Device Fingerprint Identifier - Optional. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ Device Fingerprint Identifier - Optional. [displayLayerSessionId]: #displaylayersessionid #### [displayLayerSessionId] This has been deprecated. It is the identifier used to track configurations in legacy order forms. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This has been deprecated. It is the identifier used to track configurations in l [extendedHardwareTesting]: #extendedhardwaretesting #### [extendedHardwareTesting] -Type: **boolean** +Type: **boolean** + @@ -161,7 +174,8 @@ This has been deprecated. It is the identifier used to track configurations in l [flexibleCreditProgramPrice]: #flexiblecreditprogramprice #### [flexibleCreditProgramPrice] The [SoftLayer_Product_Item_Price]({{}}) for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -171,7 +185,8 @@ The [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ This flag indicates that the customer consented to the GDPR terms for the quote. [hardware]: #hardware #### [hardware] For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [SoftLayer_Hardware]({{}}) objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([SoftLayer_Container_Product_Order_Virtual_Guest]({{}})) orders may populate this field instead of the virtualGuests property. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -191,7 +207,8 @@ For orders that contain servers (bare metal, virtual server, big data, etc.), th [imageTemplateGlobalIdentifier]: #imagetemplateglobalidentifier #### [imageTemplateGlobalIdentifier] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ An optional virtual disk image template identifier to be used as an installation [imageTemplateId]: #imagetemplateid #### [imageTemplateId] An optional virtual disk image template identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -211,7 +229,8 @@ An optional virtual disk image template identifier to be used as an installation [isManagedOrder]: #ismanagedorder #### [isManagedOrder] Flag to identify a "managed" order. This value is set internally. -Type: **integer** +Type: **integer** + @@ -221,7 +240,8 @@ Flag to identify a "managed" order. This value is set internally. [itemCategoryQuestionAnswers]: #itemcategoryquestionanswers #### [itemCategoryQuestionAnswers] The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{}}) for any product category that has additional questions requiring user input. -Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** +Type: **SoftLayer_Container_Product_Item_Category_Question_Answer[] ** + @@ -231,7 +251,8 @@ The collection of [SoftLayer_Container_Product_Item_Category_Question_Answer]({{ [location]: #location #### [location] The [SoftLayer_Location_Region]({{}}) keyname or specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ The [SoftLayer_Location_Region]({{}}) object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -251,7 +273,8 @@ This [SoftLayer_Location]({{}}) ob [message]: #message #### [message] A generic message about the order. Does not need to be sent in with any orders. -Type: **string** +Type: **string** + @@ -261,7 +284,8 @@ A generic message about the order. Does not need to be sent in with any orders. [name]: #name #### [name] Name for the [SoftLayer_Virtual_ReservedCapacityGroup]({{}}) being ordered. -Type: **string** +Type: **string** + @@ -273,7 +297,8 @@ Name for the [SoftLayer_Virtual_ReservedCapacityGroup]({{orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. -Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -283,7 +308,8 @@ If orderContainers is populated on the base order container, most o [orderHostnames]: #orderhostnames #### [orderHostnames] This is deprecated and does not do anything. -Type: **array of strings** +Type: **array of strings** + @@ -293,7 +319,8 @@ This is deprecated and does not do anything. [orderVerificationExceptions]: #orderverificationexceptions #### [orderVerificationExceptions] Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. -Type: **SoftLayer_Container_Exception[] ** +Type: **SoftLayer_Container_Exception[] ** + @@ -303,7 +330,8 @@ Collection of exceptions resulting from the verification of the order. This valu [packageId]: #packageid #### [packageId] The [SoftLayer_Product_Package]({{}}) id for an order container. This is required to place an order. -Type: **integer** +Type: **integer** + @@ -313,7 +341,8 @@ The [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -323,7 +352,8 @@ The Payment Type is Optional. If nothing is sent in, then the normal method of p [postTaxRecurring]: #posttaxrecurring #### [postTaxRecurring] The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -333,7 +363,8 @@ The post-tax recurring charge for the order. This is the sum of preTaxRecurring [postTaxRecurringHourly]: #posttaxrecurringhourly #### [postTaxRecurringHourly] The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. -Type: **decimal** +Type: **decimal** + @@ -343,7 +374,8 @@ The post-tax recurring hourly charge for the order. Since taxes are not calculat [postTaxRecurringMonthly]: #posttaxrecurringmonthly #### [postTaxRecurringMonthly] The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. -Type: **decimal** +Type: **decimal** + @@ -353,7 +385,8 @@ The post-tax recurring monthly charge for the order. This is the sum of preTaxRe [postTaxSetup]: #posttaxsetup #### [postTaxSetup] The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; -Type: **decimal** +Type: **decimal** + @@ -363,7 +396,8 @@ The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetu [preTaxRecurring]: #pretaxrecurring #### [preTaxRecurring] The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. -Type: **decimal** +Type: **decimal** + @@ -373,7 +407,8 @@ The pre-tax recurring total of the order. If there are mixed monthly and hourly [preTaxRecurringHourly]: #pretaxrecurringhourly #### [preTaxRecurringHourly] The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -383,7 +418,8 @@ The pre-tax hourly recurring total of the order. If there are only monthly price [preTaxRecurringMonthly]: #pretaxrecurringmonthly #### [preTaxRecurringMonthly] The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. -Type: **decimal** +Type: **decimal** + @@ -393,7 +429,8 @@ The pre-tax monthly recurring total of the order. If there are only hourly price [preTaxSetup]: #pretaxsetup #### [preTaxSetup] The pre-tax setup fee total of the order. -Type: **decimal** +Type: **decimal** + @@ -403,7 +440,8 @@ The pre-tax setup fee total of the order. [presaleEvent]: #presaleevent #### [presaleEvent] If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [SoftLayer_Sales_Presale_Event]({{}}) for more info. -Type: **SoftLayer_Sales_Presale_Event ** +Type: **SoftLayer_Sales_Presale_Event ** + @@ -413,7 +451,8 @@ If there are any presale events available for an order, this value will be popul [presetId]: #presetid #### [presetId] A preset configuration id for the package. Is required if not submitting any prices. -Type: **integer** +Type: **integer** + @@ -423,7 +462,8 @@ A preset configuration id for the package. Is required if not submitting any pri [prices]: #prices #### [prices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [SoftLayer_Product_Package]({{}}) associated with the order allows for preset prices, this property is required to place an order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -433,7 +473,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{}}). This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) service, getPartitionTemplates will return those available for the particular operating system. -Type: **integer** +Type: **integer** + @@ -443,7 +484,8 @@ The id of a [SoftLayer_Hardware_Component_Partition_Template]({{Type: **array of strings** +Type: **array of strings** + @@ -453,7 +495,8 @@ Priorities to set on replication set servers. [privateCloudOrderFlag]: #privatecloudorderflag #### [privateCloudOrderFlag] Flag for identifying a container as Virtual Server (Private Node). -Type: **boolean** +Type: **boolean** + @@ -463,7 +506,8 @@ Flag for identifying a container as Virtual Server (Private Node). [privateCloudOrderType]: #privatecloudordertype #### [privateCloudOrderType] Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE -Type: **string** +Type: **string** + @@ -473,7 +517,8 @@ Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, [promotionCode]: #promotioncode #### [promotionCode] Optional promotion code for an order. -Type: **string** +Type: **string** + @@ -483,7 +528,8 @@ Optional promotion code for an order. [properties]: #properties #### [properties] Generic properties. -Type: **SoftLayer_Container_Product_Order_Property[] ** +Type: **SoftLayer_Container_Product_Order_Property[] ** + @@ -493,7 +539,8 @@ Generic properties. [proratedInitialCharge]: #proratedinitialcharge #### [proratedInitialCharge] The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. -Type: **decimal** +Type: **decimal** + @@ -503,7 +550,8 @@ The Prorated Initial Charge plus the balance on the account. Only the recurring [proratedOrderTotal]: #proratedordertotal #### [proratedOrderTotal] This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. -Type: **decimal** +Type: **decimal** + @@ -513,7 +561,8 @@ This is the same as the proratedInitialCharge, except the balance on the account [provisionScripts]: #provisionscripts #### [provisionScripts] The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. -Type: **array of strings** +Type: **array of strings** + @@ -523,7 +572,8 @@ The URLs for scripts to execute on their respective servers after they have been [quantity]: #quantity #### [quantity] The quantity of the item being ordered -Type: **integer** +Type: **integer** + @@ -533,7 +583,8 @@ The quantity of the item being ordered [quoteName]: #quotename #### [quoteName] A custom name to be assigned to the quote. -Type: **string** +Type: **string** + @@ -547,7 +598,8 @@ Specifying a regional group name allows you to not worry about placing your serv location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed. If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. -Type: **string** +Type: **string** + @@ -557,7 +609,8 @@ If a regional group is provided and VLANs are specified (within the hardwa [resourceGroupId]: #resourcegroupid #### [resourceGroupId] An optional resource group identifier specifying the resource group to attach the order to -Type: **integer** +Type: **integer** + @@ -567,7 +620,8 @@ An optional resource group identifier specifying the resource group to attach th [resourceGroupName]: #resourcegroupname #### [resourceGroupName] This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. -Type: **string** +Type: **string** + @@ -577,7 +631,8 @@ This variable specifies the name of the resource group the server configuration [resourceGroupTemplateId]: #resourcegrouptemplateid #### [resourceGroupTemplateId] An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. -Type: **integer** +Type: **integer** + @@ -587,7 +642,8 @@ An optional resource group template identifier to be used as a deployment base f [returnUrl]: #returnurl #### [returnUrl] The URL to which PayPal redirects browser after a payment is completed. -Type: **string** +Type: **string** + @@ -597,7 +653,8 @@ The URL to which PayPal redirects browser after a payment is completed. [sendQuoteEmailFlag]: #sendquoteemailflag #### [sendQuoteEmailFlag] This flag indicates that the quote should be sent to the email address associated with the account or order. -Type: **boolean** +Type: **boolean** + @@ -607,7 +664,8 @@ This flag indicates that the quote should be sent to the email address associate [serverCoreCount]: #servercorecount #### [serverCoreCount] The number of cores for the server being ordered. This value is set internally. -Type: **integer** +Type: **integer** + @@ -617,7 +675,8 @@ The number of cores for the server being ordered. This value is set internally. [serviceToken]: #servicetoken #### [serviceToken] The token of a requesting service. Do not set. -Type: **string** +Type: **string** + @@ -627,7 +686,8 @@ The token of a requesting service. Do not set. [sourceVirtualGuestId]: #sourcevirtualguestid #### [sourceVirtualGuestId] An optional computing instance identifier to be used as an installation base for a computing instance order -Type: **integer** +Type: **integer** + @@ -637,7 +697,8 @@ An optional computing instance identifier to be used as an installation base for [sshKeys]: #sshkeys #### [sshKeys] The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. -Type: **SoftLayer_Container_Product_Order_SshKeys[] ** +Type: **SoftLayer_Container_Product_Order_SshKeys[] ** + @@ -647,7 +708,8 @@ The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respect [stepId]: #stepid #### [stepId] An optional parameter for step-based order processing. -Type: **integer** +Type: **integer** + @@ -663,7 +725,8 @@ For orders that want to add storage groups such as RAID across multiple disks, s The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage. -Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** +Type: **SoftLayer_Container_Product_Order_Storage_Group[] ** + @@ -673,7 +736,8 @@ The first storage group in this array will be considered the primary storage gro [taxCacheHash]: #taxcachehash #### [taxCacheHash] The order container may not contain the final tax rates when it is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. -Type: **string** +Type: **string** + @@ -683,7 +747,8 @@ The order container may not contain the final tax rates when it is returned from [taxCompletedFlag]: #taxcompletedflag #### [taxCompletedFlag] Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [SoftLayer_Product_Order::verifyOrder]({{}}). -Type: **boolean** +Type: **boolean** + @@ -693,7 +758,8 @@ Flag to indicate if the order container has the final tax rates for the order. S [techIncubatorItemPrice]: #techincubatoritemprice #### [techIncubatorItemPrice] The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -703,7 +769,8 @@ The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFe [totalRecurringTax]: #totalrecurringtax #### [totalRecurringTax] The total tax portion of the recurring fees. -Type: **decimal** +Type: **decimal** + @@ -713,7 +780,8 @@ The total tax portion of the recurring fees. [totalSetupTax]: #totalsetuptax #### [totalSetupTax] The tax amount of the setup fees. -Type: **decimal** +Type: **decimal** + @@ -723,7 +791,8 @@ The tax amount of the setup fees. [usagePrices]: #usageprices #### [usagePrices] This is a collection of [SoftLayer_Product_Item_Price]({{}}) objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -733,7 +802,8 @@ This is a collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -743,7 +813,8 @@ An optional flag to use hourly pricing instead of standard monthly pricing. [virtualGuests]: #virtualguests #### [virtualGuests] For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [SoftLayer_Virtual_Guest]({{}}) objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Vpc_IpAllocation/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Vpc_IpAllocation/_index.md index 926445537c..6a1f04029d 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Vpc_IpAllocation/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Vpc_IpAllocation/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [ip]: #ip #### [ip] -Type: **string** +Type: **string** +
      diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Order_Vpc_Subnet/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Order_Vpc_Subnet/_index.md index 34293ef078..e7649ccbfc 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Order_Vpc_Subnet/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Order_Vpc_Subnet/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [cidr]: #cidr #### [cidr] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [dns]: #dns #### [dns] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [gateway]: #gateway #### [gateway] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [id]: #id #### [id] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [vlan]: #vlan #### [vlan] -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Promotion/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Promotion/_index.md index a2df76bdc1..786285461a 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Promotion/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Promotion/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Product_Promotion data type contains information about a promotion and its requirements. @@ -45,7 +47,8 @@ The SoftLayer_Container_Product_Promotion data type contains information about a [code]: #code #### [code] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The SoftLayer_Container_Product_Promotion data type contains information about a [expirationDate]: #expirationdate #### [expirationDate] -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The SoftLayer_Container_Product_Promotion data type contains information about a [locations]: #locations #### [locations] -Type: **SoftLayer_Location[] ** +Type: **SoftLayer_Location[] ** + @@ -75,7 +80,8 @@ The SoftLayer_Container_Product_Promotion data type contains information about a [requirementGroups]: #requirementgroups #### [requirementGroups] -Type: **SoftLayer_Container_Product_Promotion_RequirementGroup[] ** +Type: **SoftLayer_Container_Product_Promotion_RequirementGroup[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Product_Promotion_RequirementGroup/_index.md b/content/reference/datatypes/SoftLayer_Container_Product_Promotion_RequirementGroup/_index.md index 581869b45f..dc23b226f8 100644 --- a/content/reference/datatypes/SoftLayer_Container_Product_Promotion_RequirementGroup/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Product_Promotion_RequirementGroup/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Container_Product_Promotion_RequirementGroup data type contains th [categories]: #categories #### [categories] The category options to choose from for this requirement group -Type: **SoftLayer_Product_Item_Category[] ** +Type: **SoftLayer_Product_Item_Category[] ** + @@ -55,7 +58,8 @@ The category options to choose from for this requirement group [presets]: #presets #### [presets] The preset options to choose from for this requirement group -Type: **SoftLayer_Product_Package_Preset[] ** +Type: **SoftLayer_Product_Package_Preset[] ** + @@ -65,7 +69,8 @@ The preset options to choose from for this requirement group [prices]: #prices #### [prices] The price options to choose from for this requirement group -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Provisioning_Maintenance_Window/_index.md b/content/reference/datatypes/SoftLayer_Container_Provisioning_Maintenance_Window/_index.md index 59e5294cc0..ee63b59c92 100644 --- a/content/reference/datatypes/SoftLayer_Container_Provisioning_Maintenance_Window/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Provisioning_Maintenance_Window/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Provisioni [classificationIds]: #classificationids #### [classificationIds] Maintenance classifications. -Type: **SoftLayer_Provisioning_Maintenance_Classification[] ** +Type: **SoftLayer_Provisioning_Maintenance_Classification[] ** + @@ -55,7 +58,8 @@ Maintenance classifications. [itemCategoryIds]: #itemcategoryids #### [itemCategoryIds] Maintenance classifications. -Type: **SoftLayer_Product_Item_Category[] ** +Type: **SoftLayer_Product_Item_Category[] ** + @@ -65,7 +69,8 @@ Maintenance classifications. [maintenanceWindowId]: #maintenancewindowid #### [maintenanceWindowId] The maintenance window id -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The maintenance window id [ticketId]: #ticketid #### [ticketId] Maintenance window ticket id -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Maintenance window ticket id [windowMaintenanceDate]: #windowmaintenancedate #### [windowMaintenanceDate] Maintenance window date -Type: **dateTime** +Type: **dateTime** + diff --git a/content/reference/datatypes/SoftLayer_Container_Referral_Partner_Commission/_index.md b/content/reference/datatypes/SoftLayer_Container_Referral_Partner_Commission/_index.md index 23369ff62e..3683be0cf4 100644 --- a/content/reference/datatypes/SoftLayer_Container_Referral_Partner_Commission/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Referral_Partner_Commission/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [commissionAmount]: #commissionamount #### [commissionAmount] -Type: **decimal** +Type: **decimal** +
      @@ -55,7 +58,8 @@ classes: [commissionRate]: #commissionrate #### [commissionRate] -Type: **decimal** +Type: **decimal** +
      @@ -65,7 +69,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ classes: [referralAccountId]: #referralaccountid #### [referralAccountId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [referralCompanyName]: #referralcompanyname #### [referralCompanyName] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [referralPartnerAccountId]: #referralpartneraccountid #### [referralPartnerAccountId] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [referralRevenue]: #referralrevenue #### [referralRevenue] -Type: **decimal** +Type: **decimal** + diff --git a/content/reference/datatypes/SoftLayer_Container_Referral_Partner_Payment_Option/_index.md b/content/reference/datatypes/SoftLayer_Container_Referral_Partner_Payment_Option/_index.md index 3bbcfe4a7e..e1c119f209 100644 --- a/content/reference/datatypes/SoftLayer_Container_Referral_Partner_Payment_Option/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Referral_Partner_Payment_Option/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountNumber]: #accountnumber #### [accountNumber] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [accountType]: #accounttype #### [accountType] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [address1]: #address1 #### [address1] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [address2]: #address2 #### [address2] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [bankTransitNumber]: #banktransitnumber #### [bankTransitNumber] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [city]: #city #### [city] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ classes: [companyName]: #companyname #### [companyName] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [country]: #country #### [country] -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ classes: [federalTaxId]: #federaltaxid #### [federalTaxId] -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ classes: [firstName]: #firstname #### [firstName] -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ classes: [lastName]: #lastname #### [lastName] -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ classes: [paymentType]: #paymenttype #### [paymentType] -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ classes: [paypalEmail]: #paypalemail #### [paypalEmail] -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ classes: [phoneNumber]: #phonenumber #### [phoneNumber] -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ classes: [postalCode]: #postalcode #### [postalCode] -Type: **string** +Type: **string** + @@ -195,7 +212,8 @@ classes: [state]: #state #### [state] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Referral_Partner_Prospect/_index.md b/content/reference/datatypes/SoftLayer_Container_Referral_Partner_Prospect/_index.md index 50e59d8917..7c83b56b22 100644 --- a/content/reference/datatypes/SoftLayer_Container_Referral_Partner_Prospect/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Referral_Partner_Prospect/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [address1]: #address1 #### [address1] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [address2]: #address2 #### [address2] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [city]: #city #### [city] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [companyName]: #companyname #### [companyName] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [country]: #country #### [country] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [email]: #email #### [email] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ classes: [firstName]: #firstname #### [firstName] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [lastName]: #lastname #### [lastName] -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ classes: [officePhone]: #officephone #### [officePhone] -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ classes: [postalCode]: #postalcode #### [postalCode] -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ classes: [questions]: #questions #### [questions] -Type: **array of strings** +Type: **array of strings** + @@ -155,7 +168,8 @@ classes: [responses]: #responses #### [responses] -Type: **SoftLayer_Survey_Response[] ** +Type: **SoftLayer_Survey_Response[] ** + @@ -165,7 +179,8 @@ classes: [state]: #state #### [state] -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ classes: [surveyId]: #surveyid #### [surveyId] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_RemoteManagement_Graphs_SensorSpeed/_index.md b/content/reference/datatypes/SoftLayer_Container_RemoteManagement_Graphs_SensorSpeed/_index.md index fb67f9c403..60e2f42f87 100644 --- a/content/reference/datatypes/SoftLayer_Container_RemoteManagement_Graphs_SensorSpeed/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_RemoteManagement_Graphs_SensorSpeed/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Container_RemoteManagement_Graphs_SensorSpeed contains graphs to [graph]: #graph #### [graph] The graph to display the server's fan speed. -Type: **binary data** +Type: **binary data** + @@ -55,7 +58,8 @@ The graph to display the server's fan speed. [title]: #title #### [title] A title that may be used to display for the graph. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_RemoteManagement_Graphs_SensorTemperature/_index.md b/content/reference/datatypes/SoftLayer_Container_RemoteManagement_Graphs_SensorTemperature/_index.md index 78ce2f498d..efe3a3598a 100644 --- a/content/reference/datatypes/SoftLayer_Container_RemoteManagement_Graphs_SensorTemperature/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_RemoteManagement_Graphs_SensorTemperature/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_RemoteManagement_Graphs_SensorTemperature contains graphs to display the cpu(s) and system temperatures retrieved from the management card using thermometer graphs. @@ -45,7 +47,8 @@ The SoftLayer_Container_RemoteManagement_Graphs_SensorTemperature contains graph [graph]: #graph #### [graph] The graph to display the server's cpu(s) and system temperatures. -Type: **binary data** +Type: **binary data** + @@ -55,7 +58,8 @@ The graph to display the server's cpu(s) and system temperatures. [title]: #title #### [title] A title that may be used to display for the graph. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_RemoteManagement_PmInfo/_index.md b/content/reference/datatypes/SoftLayer_Container_RemoteManagement_PmInfo/_index.md index 3a45aec54e..7278d1a142 100644 --- a/content/reference/datatypes/SoftLayer_Container_RemoteManagement_PmInfo/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_RemoteManagement_PmInfo/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_RemoteManagement_PmInfo contains pminfo information retrieved from a server's remote management card. @@ -45,7 +47,8 @@ The SoftLayer_Container_RemoteManagement_PmInfo contains pminfo information retr [pmInfoId]: #pminfoid #### [pmInfoId] PmInfo ID -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ PmInfo ID [pmInfoReading]: #pminforeading #### [pmInfoReading] PmInfo Reading -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_RemoteManagement_SensorReading/_index.md b/content/reference/datatypes/SoftLayer_Container_RemoteManagement_SensorReading/_index.md index 7e8a354c5f..5898b9c0f8 100644 --- a/content/reference/datatypes/SoftLayer_Container_RemoteManagement_SensorReading/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_RemoteManagement_SensorReading/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_RemoteManagement_SensorReadings contains sensor information retrieved from a server's remote management card. @@ -45,7 +47,8 @@ The SoftLayer_Container_RemoteManagement_SensorReadings contains sensor informat [lowerCritical]: #lowercritical #### [lowerCritical] Lower Non-Recoverable threshold -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Lower Non-Recoverable threshold [lowerNonCritical]: #lowernoncritical #### [lowerNonCritical] Lower Non-Critical threshold -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Lower Non-Critical threshold [lowerNonRecoverable]: #lowernonrecoverable #### [lowerNonRecoverable] Lower Non-Recoverable threshold -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Lower Non-Recoverable threshold [sensorId]: #sensorid #### [sensorId] Sensor ID -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ Sensor ID [sensorReading]: #sensorreading #### [sensorReading] Sensor Reading -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Sensor Reading [sensorUnits]: #sensorunits #### [sensorUnits] Sensor Units -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ Sensor Units [status]: #status #### [status] Sensor Status -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ Sensor Status [upperCritical]: #uppercritical #### [upperCritical] Upper Critical threshold -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ Upper Critical threshold [upperNonCritical]: #uppernoncritical #### [upperNonCritical] Upper Non-Critical threshold -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Upper Non-Critical threshold [upperNonRecoverable]: #uppernonrecoverable #### [upperNonRecoverable] Upper Non-Recoverable threshold -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_RemoteManagement_SensorReadingsWithGraphs/_index.md b/content/reference/datatypes/SoftLayer_Container_RemoteManagement_SensorReadingsWithGraphs/_index.md index 5a94918933..95000565bd 100644 --- a/content/reference/datatypes/SoftLayer_Container_RemoteManagement_SensorReadingsWithGraphs/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_RemoteManagement_SensorReadingsWithGraphs/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Container_RemoteManagement_SensorReadingsWithGraphs contains the r [rawData]: #rawdata #### [rawData] The raw data returned from the server's remote management card. -Type: **SoftLayer_Container_RemoteManagement_SensorReading[] ** +Type: **SoftLayer_Container_RemoteManagement_SensorReading[] ** + @@ -55,7 +58,8 @@ The raw data returned from the server's remote management card. [speedGraphs]: #speedgraphs #### [speedGraphs] The graph(s) to display the server's fan speeds. -Type: **SoftLayer_Container_RemoteManagement_Graphs_SensorSpeed[] ** +Type: **SoftLayer_Container_RemoteManagement_Graphs_SensorSpeed[] ** + @@ -65,7 +69,8 @@ The graph(s) to display the server's fan speeds. [temperatureGraphs]: #temperaturegraphs #### [temperatureGraphs] The graph(s) to display the server's cpu(s) and system temperatures. -Type: **SoftLayer_Container_RemoteManagement_Graphs_SensorTemperature[] ** +Type: **SoftLayer_Container_RemoteManagement_Graphs_SensorTemperature[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Resource_Metadata_ServiceResource/_index.md b/content/reference/datatypes/SoftLayer_Container_Resource_Metadata_ServiceResource/_index.md index 983e9b6818..fadc3196d5 100644 --- a/content/reference/datatypes/SoftLayer_Container_Resource_Metadata_ServiceResource/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Resource_Metadata_ServiceResource/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The metadata service resource container is used to store information about a single service resource. @@ -45,7 +47,8 @@ The metadata service resource container is used to store information about a sin [backendIpAddress]: #backendipaddress #### [backendIpAddress] The backend IP address for this resource -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The backend IP address for this resource [type]: #type #### [type] The type for this resource -Type: **SoftLayer_Network_Service_Resource_Type ** +Type: **SoftLayer_Network_Service_Resource_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Search_ObjectType/_index.md b/content/reference/datatypes/SoftLayer_Container_Search_ObjectType/_index.md index a5fdc29c50..3435ce72c9 100644 --- a/content/reference/datatypes/SoftLayer_Container_Search_ObjectType/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Search_ObjectType/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 [SoftLayer_Container_Search_ObjectType_Property]({{}}) method for information on using object types in search strings. @@ -57,7 +59,8 @@ This data type is a container that stores information about a single indexed obj [name]: #name #### [name] Name of object type. -Type: **string** +Type: **string** + @@ -67,7 +70,8 @@ Name of object type. [properties]: #properties #### [properties] A collection of [SoftLayer_Container_Search_ObjectType_Property]({{}}). -Type: **SoftLayer_Container_Search_ObjectType_Property[] ** +Type: **SoftLayer_Container_Search_ObjectType_Property[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Search_ObjectType_Property/_index.md b/content/reference/datatypes/SoftLayer_Container_Search_ObjectType_Property/_index.md index 376f2775f3..d58f7d6ad7 100644 --- a/content/reference/datatypes/SoftLayer_Container_Search_ObjectType_Property/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Search_ObjectType_Property/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This data type is a container that stores information about a single property of a searchable object type. Each [SoftLayer_Container_Search_ObjectType]({{}}) method. Refer to the advancedSearch() method for information on using properties in search strings. @@ -56,7 +58,8 @@ This data type is a container that stores information about a single property of [name]: #name #### [name] Name of property. -Type: **string** +Type: **string** + @@ -66,7 +69,8 @@ Name of property. [sortableFlag]: #sortableflag #### [sortableFlag] Indicates if this property can be sorted. -Type: **boolean** +Type: **boolean** + @@ -76,7 +80,8 @@ Indicates if this property can be sorted. [type]: #type #### [type] Property data type. Valid values include 'boolean', 'integer', 'date', 'string' or 'text'. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Search_Result/_index.md b/content/reference/datatypes/SoftLayer_Container_Search_Result/_index.md index dd4426b61f..4eb122f8f4 100644 --- a/content/reference/datatypes/SoftLayer_Container_Search_Result/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Search_Result/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Search_Result data type represents a result row from an execution of Search service. @@ -45,7 +47,8 @@ The SoftLayer_Container_Search_Result data type represents a result row from an [matchedTerms]: #matchedterms #### [matchedTerms] An array of terms that were matched in the resource object. -Type: **array of strings** +Type: **array of strings** + @@ -55,7 +58,8 @@ An array of terms that were matched in the resource object. [relevanceScore]: #relevancescore #### [relevanceScore] The score ratio of the result for relevance to the search criteria. -Type: **decimal** +Type: **decimal** + @@ -65,7 +69,8 @@ The score ratio of the result for relevance to the search criteria. [resource]: #resource #### [resource] A search results resource object that matched search criteria. -Type: **SoftLayer_Entity ** +Type: **SoftLayer_Entity ** + @@ -75,7 +80,8 @@ A search results resource object that matched search criteria. [resourceType]: #resourcetype #### [resourceType] The type of the resource object that matched search criteria. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Software_Component_HostIps_Policy/_index.md b/content/reference/datatypes/SoftLayer_Container_Software_Component_HostIps_Policy/_index.md index 8c0a0a8b2a..d8ea2b841f 100644 --- a/content/reference/datatypes/SoftLayer_Container_Software_Component_HostIps_Policy/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Software_Component_HostIps_Policy/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Software_Component_HostIps_Policy container holds the title and value of a current host ips policy. @@ -45,7 +47,8 @@ The SoftLayer_Container_Software_Component_HostIps_Policy container holds the ti [policy]: #policy #### [policy] The value of a host ips category. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The value of a host ips category. [policyTitle]: #policytitle #### [policyTitle] The category title of a host ips policy. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Tax_Cache/_index.md b/content/reference/datatypes/SoftLayer_Container_Tax_Cache/_index.md index 170b63d3d0..732a209957 100644 --- a/content/reference/datatypes/SoftLayer_Container_Tax_Cache/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Tax_Cache/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ These are the results of a tax calculation. The tax calculation was kicked off b [effectiveTaxRate]: #effectivetaxrate #### [effectiveTaxRate] The percentage of the final total that should be tax. -Type: **decimal** +Type: **decimal** + @@ -55,7 +58,8 @@ The percentage of the final total that should be tax. [failureMessage]: #failuremessage #### [failureMessage] -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The percentage of the final total that should be tax. [items]: #items #### [items] The container that holds the four actual tax rates, one for each fee type. -Type: **SoftLayer_Container_Tax_Cache_Item[] ** +Type: **SoftLayer_Container_Tax_Cache_Item[] ** + @@ -75,7 +80,8 @@ The container that holds the four actual tax rates, one for each fee type. [status]: #status #### [status] The status of the tax request. This should be PENDING, FAILED, or COMPLETED. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The status of the tax request. This should be PENDING, FAILED, or COMPLETED. [totalTaxAmount]: #totaltaxamount #### [totalTaxAmount] The final amount of tax for the order. -Type: **decimal** +Type: **decimal** + diff --git a/content/reference/datatypes/SoftLayer_Container_Tax_Cache_Item/_index.md b/content/reference/datatypes/SoftLayer_Container_Tax_Cache_Item/_index.md index b4866d88ba..c2bb7b7e30 100644 --- a/content/reference/datatypes/SoftLayer_Container_Tax_Cache_Item/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Tax_Cache_Item/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This represents one order item in a tax calculation. @@ -45,7 +47,8 @@ This represents one order item in a tax calculation. [categoryCode]: #categorycode #### [categoryCode] The category code for the referenced product. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The category code for the referenced product. [containerHash]: #containerhash #### [containerHash] This hash will match to the hash on an order container. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This hash will match to the hash on an order container. [itemPriceId]: #itempriceid #### [itemPriceId] The reference to the price for this order item. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The reference to the price for this order item. [taxRates]: #taxrates #### [taxRates] This is the container containing the individual tax rates. -Type: **SoftLayer_Container_Tax_Rates ** +Type: **SoftLayer_Container_Tax_Rates ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Tax_Rates/_index.md b/content/reference/datatypes/SoftLayer_Container_Tax_Rates/_index.md index 76293214f1..9dda9f4111 100644 --- a/content/reference/datatypes/SoftLayer_Container_Tax_Rates/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Tax_Rates/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This contains the four tax rates, one for each fee type. @@ -45,7 +47,8 @@ This contains the four tax rates, one for each fee type. [laborTaxRate]: #labortaxrate #### [laborTaxRate] The tax rate associated with the labor fee. -Type: **decimal** +Type: **decimal** + @@ -55,7 +58,8 @@ The tax rate associated with the labor fee. [locationId]: #locationid #### [locationId] A reference to a location. -Type: **decimal** +Type: **decimal** + @@ -65,7 +69,8 @@ A reference to a location. [oneTimeTaxRate]: #onetimetaxrate #### [oneTimeTaxRate] The tax rate associated with the one-time fee. -Type: **decimal** +Type: **decimal** + @@ -75,7 +80,8 @@ The tax rate associated with the one-time fee. [recurringTaxRate]: #recurringtaxrate #### [recurringTaxRate] The tax rate associated with the recurring fee. -Type: **decimal** +Type: **decimal** + @@ -85,7 +91,8 @@ The tax rate associated with the recurring fee. [setupTaxRate]: #setuptaxrate #### [setupTaxRate] The tax rate associated with the setup fee. -Type: **decimal** +Type: **decimal** + diff --git a/content/reference/datatypes/SoftLayer_Container_Ticket_GraphInputs/_index.md b/content/reference/datatypes/SoftLayer_Container_Ticket_GraphInputs/_index.md index b349848c4c..6f1714c1a9 100644 --- a/content/reference/datatypes/SoftLayer_Container_Ticket_GraphInputs/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Ticket_GraphInputs/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Ticket_GraphInputs models a single inbound object for a given ticket graph. @@ -56,7 +58,8 @@ SoftLayer_Container_Ticket_GraphInputs models a single inbound object for a give [endDate]: #enddate #### [endDate] This is a unix timestamp that represents the stop date/time for a graph. -Type: **dateTime** +Type: **dateTime** + @@ -66,7 +69,8 @@ This is a unix timestamp that represents the stop date/time for a graph. [networkInterfaceId]: #networkinterfaceid #### [networkInterfaceId] The front-end or back-end network uplink interface associated with this server. -Type: **integer** +Type: **integer** + @@ -76,7 +80,8 @@ The front-end or back-end network uplink interface associated with this server. [pod]: #pod #### [pod] * -Type: **integer** +Type: **integer** + @@ -86,7 +91,8 @@ The front-end or back-end network uplink interface associated with this server. [serverName]: #servername #### [serverName] This is a human readable name for the server or rack being graphed. -Type: **string** +Type: **string** + @@ -96,7 +102,8 @@ This is a human readable name for the server or rack being graphed. [startDate]: #startdate #### [startDate] This is a unix timestamp that represents the begin date/time for a graph. -Type: **dateTime** +Type: **dateTime** + diff --git a/content/reference/datatypes/SoftLayer_Container_Ticket_GraphOutputs/_index.md b/content/reference/datatypes/SoftLayer_Container_Ticket_GraphOutputs/_index.md index 0edd1c7288..0e9dee166a 100644 --- a/content/reference/datatypes/SoftLayer_Container_Ticket_GraphOutputs/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Ticket_GraphOutputs/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Container_Ticket_GraphOutputs models a single outbound object for a given bandwidth graph. @@ -56,7 +58,8 @@ SoftLayer_Container_Ticket_GraphOutputs models a single outbound object for a gi [graphImage]: #graphimage #### [graphImage] The raw PNG binary data to be displayed once the graph is drawn. -Type: **binary data** +Type: **binary data** + @@ -66,7 +69,8 @@ The raw PNG binary data to be displayed once the graph is drawn. [graphTitle]: #graphtitle #### [graphTitle] The title that ended up being displayed as part of the graph image. -Type: **string** +Type: **string** + @@ -76,7 +80,8 @@ The title that ended up being displayed as part of the graph image. [maxEndDate]: #maxenddate #### [maxEndDate] The maximum date included in this graph. -Type: **dateTime** +Type: **dateTime** + @@ -86,7 +91,8 @@ The maximum date included in this graph. [minStartDate]: #minstartdate #### [minStartDate] The minimum date included in this graph. -Type: **dateTime** +Type: **dateTime** + diff --git a/content/reference/datatypes/SoftLayer_Container_Ticket_Priority/_index.md b/content/reference/datatypes/SoftLayer_Container_Ticket_Priority/_index.md index 8fdc1cc323..3e59ab273e 100644 --- a/content/reference/datatypes/SoftLayer_Container_Ticket_Priority/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Ticket_Priority/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [value]: #value #### [value] -Type: **integer** +Type: **integer** +
      diff --git a/content/reference/datatypes/SoftLayer_Container_Ticket_Survey_Preference/_index.md b/content/reference/datatypes/SoftLayer_Container_Ticket_Survey_Preference/_index.md index 2718bdfaa6..6beeea7c93 100644 --- a/content/reference/datatypes/SoftLayer_Container_Ticket_Survey_Preference/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Ticket_Survey_Preference/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [applicable]: #applicable #### [applicable] -Type: **boolean** +Type: **boolean** +
      @@ -55,7 +58,8 @@ classes: [optedOut]: #optedout #### [optedOut] -Type: **boolean** +Type: **boolean** +
      @@ -65,7 +69,8 @@ classes: [optedOutDate]: #optedoutdate #### [optedOutDate] -Type: **dateTime** +Type: **dateTime** + diff --git a/content/reference/datatypes/SoftLayer_Container_User_Authentication_Token/_index.md b/content/reference/datatypes/SoftLayer_Container_User_Authentication_Token/_index.md index 74fae9d1e0..0af1e797ef 100644 --- a/content/reference/datatypes/SoftLayer_Container_User_Authentication_Token/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_User_Authentication_Token/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Container class used to hold user authentication token @@ -45,7 +47,8 @@ Container class used to hold user authentication token [hash]: #hash #### [hash] hash that gets populated for user authentication -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ hash that gets populated for user authentication [user]: #user #### [user] the user authenticated object -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -65,7 +69,8 @@ the user authenticated object [userId]: #userid #### [userId] the id of the user to authenticate -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding/_index.md b/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding/_index.md index 4b16d94e97..1399637de2 100644 --- a/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Container classed used to hold external authentication information @@ -45,7 +47,8 @@ Container classed used to hold external authentication information [authenticationToken]: #authenticationtoken #### [authenticationToken] The unique token that is created by an external authentication request. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The unique token that is created by an external authentication request. [openIdConnectAccessToken]: #openidconnectaccesstoken #### [openIdConnectAccessToken] The OpenID Connect access token which provides access to a resource by the OpenID Connect provider. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The OpenID Connect access token which provides access to a resource by the OpenI [openIdConnectAccountId]: #openidconnectaccountid #### [openIdConnectAccountId] The account to login to, if not provided a default will be used. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The account to login to, if not provided a default will be used. [openIdConnectProvider]: #openidconnectprovider #### [openIdConnectProvider] The OpenID Connect provider type, as a string. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The OpenID Connect provider type, as a string. [password]: #password #### [password] Your SoftLayer customer portal user's portal password. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Your SoftLayer customer portal user's portal password. [securityQuestionAnswer]: #securityquestionanswer #### [securityQuestionAnswer] The answer to your security question. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The answer to your security question. [securityQuestionId]: #securityquestionid #### [securityQuestionId] A security question you wish to answer when authenticating to the SoftLayer customer portal. This parameter isn't required if no security questions are set on your portal account or if your account is configured to not require answering a security account upon login. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A security question you wish to answer when authenticating to the SoftLayer cust [username]: #username #### [username] The username you wish to authenticate to the SoftLayer customer portal with. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The username you wish to authenticate to the SoftLayer customer portal with. [vendor]: #vendor #### [vendor] The name of the vendor that will be used for external authentication -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Phone/_index.md b/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Phone/_index.md index b2229a2d60..e532bc12d2 100644 --- a/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Phone/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Phone/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Container classed used to hold portal token @@ -45,7 +47,8 @@ Container classed used to hold portal token [authenticationToken]: #authenticationtoken #### [authenticationToken] The unique token that is created by an external authentication request. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The unique token that is created by an external authentication request. [openIdConnectAccessToken]: #openidconnectaccesstoken #### [openIdConnectAccessToken] The OpenID Connect access token which provides access to a resource by the OpenID Connect provider. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The OpenID Connect access token which provides access to a resource by the OpenI [openIdConnectAccountId]: #openidconnectaccountid #### [openIdConnectAccountId] The account to login to, if not provided a default will be used. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The account to login to, if not provided a default will be used. [openIdConnectProvider]: #openidconnectprovider #### [openIdConnectProvider] The OpenID Connect provider type, as a string. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The OpenID Connect provider type, as a string. [password]: #password #### [password] Your SoftLayer customer portal user's portal password. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Your SoftLayer customer portal user's portal password. [securityQuestionAnswer]: #securityquestionanswer #### [securityQuestionAnswer] The answer to your security question. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The answer to your security question. [securityQuestionId]: #securityquestionid #### [securityQuestionId] A security question you wish to answer when authenticating to the SoftLayer customer portal. This parameter isn't required if no security questions are set on your portal account or if your account is configured to not require answering a security account upon login. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A security question you wish to answer when authenticating to the SoftLayer cust [username]: #username #### [username] The username you wish to authenticate to the SoftLayer customer portal with. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The username you wish to authenticate to the SoftLayer customer portal with. [vendor]: #vendor #### [vendor] The name of the vendor that will be used for external authentication -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Phone_Mode/_index.md b/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Phone_Mode/_index.md index 34c9267f6a..8247258d49 100644 --- a/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Phone_Mode/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Phone_Mode/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This container can be used to configure the phone authentication mode. By default, "VOICE_CALL" in "STANDARD" mode with no Pin number will be used. With the default mode, you will have to answer a phone call from a trusted 2 form factor vendor during authentication process. You have to answer the call and follow the instruction in order to complete the authentication. You can also use SMS text message or PhoneFactor mobile app modes (in case you're using PhoneFactor). Additionally, you can set up a Pin number. By requiring you to verify your secret PIN, you can ensure that you have possession of your phone. @@ -73,7 +75,8 @@ This mode is applicable for PhoneFactor. Phone App mode results in a notificatio **STANDARD: (default) The first authentication is when the user signs on using a username and password. The second authentication is when the user receives a notification in the PhoneFactor phone app. In Standard Mode, users will prompted to authenticate, deny, or deny and report fraud. **PIN: This mode enhances the security of the authentication by requiring the user to enter their PIN in the phone app. -Type: **string** +Type: **string** + @@ -83,7 +86,8 @@ The second authentication is when the user receives a notification in the PhoneF [pin]: #pin #### [pin] Optional authentication pin. -Type: **string** +Type: **string** + @@ -93,7 +97,8 @@ Optional authentication pin. [pinMode]: #pinmode #### [pinMode] Available Pin modes are: PIN, VOICE_PRINT, STANDARD Default: STANDARD (Pin is not used) -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Totp/_index.md b/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Totp/_index.md index bff74b72a1..2f41eb8f8c 100644 --- a/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Totp/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Totp/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Container classed used to hold portal token @@ -45,7 +47,8 @@ Container classed used to hold portal token [authenticationToken]: #authenticationtoken #### [authenticationToken] The unique token that is created by an external authentication request. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The unique token that is created by an external authentication request. [openIdConnectAccessToken]: #openidconnectaccesstoken #### [openIdConnectAccessToken] The OpenID Connect access token which provides access to a resource by the OpenID Connect provider. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The OpenID Connect access token which provides access to a resource by the OpenI [openIdConnectAccountId]: #openidconnectaccountid #### [openIdConnectAccountId] The account to login to, if not provided a default will be used. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The account to login to, if not provided a default will be used. [openIdConnectProvider]: #openidconnectprovider #### [openIdConnectProvider] The OpenID Connect provider type, as a string. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The OpenID Connect provider type, as a string. [password]: #password #### [password] Your SoftLayer customer portal user's portal password. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Your SoftLayer customer portal user's portal password. [securityCode]: #securitycode #### [securityCode] The security code used to validate a Totp credential. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The security code used to validate a Totp credential. [securityQuestionAnswer]: #securityquestionanswer #### [securityQuestionAnswer] The answer to your security question. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The answer to your security question. [securityQuestionId]: #securityquestionid #### [securityQuestionId] A security question you wish to answer when authenticating to the SoftLayer customer portal. This parameter isn't required if no security questions are set on your portal account or if your account is configured to not require answering a security account upon login. -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ A security question you wish to answer when authenticating to the SoftLayer cust [username]: #username #### [username] The username you wish to authenticate to the SoftLayer customer portal with. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The username you wish to authenticate to the SoftLayer customer portal with. [vendor]: #vendor #### [vendor] The name of the vendor that will be used for external authentication -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Vendor/_index.md b/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Vendor/_index.md index c138309b66..923614ab51 100644 --- a/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Vendor/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Vendor/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Container classed used to hold details about an external authentication vendor. @@ -45,7 +47,8 @@ Container classed used to hold details about an external authentication vendor. [keyName]: #keyname #### [keyName] The keyname used to identify an external authentication vendor. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The keyname used to identify an external authentication vendor. [name]: #name #### [name] The name of an external authentication vendor. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Verisign/_index.md b/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Verisign/_index.md index 9257d1320d..8f90d6c2dc 100644 --- a/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Verisign/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_User_Customer_External_Binding_Verisign/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Container classed used to hold portal token @@ -45,7 +47,8 @@ Container classed used to hold portal token [authenticationToken]: #authenticationtoken #### [authenticationToken] The unique token that is created by an external authentication request. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The unique token that is created by an external authentication request. [openIdConnectAccessToken]: #openidconnectaccesstoken #### [openIdConnectAccessToken] The OpenID Connect access token which provides access to a resource by the OpenID Connect provider. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The OpenID Connect access token which provides access to a resource by the OpenI [openIdConnectAccountId]: #openidconnectaccountid #### [openIdConnectAccountId] The account to login to, if not provided a default will be used. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The account to login to, if not provided a default will be used. [openIdConnectProvider]: #openidconnectprovider #### [openIdConnectProvider] The OpenID Connect provider type, as a string. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The OpenID Connect provider type, as a string. [password]: #password #### [password] Your SoftLayer customer portal user's portal password. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Your SoftLayer customer portal user's portal password. [secondSecurityCode]: #secondsecuritycode #### [secondSecurityCode] A second security code that is only required if your credential has become unsynchronized. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ A second security code that is only required if your credential has become unsyn [securityCode]: #securitycode #### [securityCode] The security code used to validate a VeriSign credential. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The security code used to validate a VeriSign credential. [securityQuestionAnswer]: #securityquestionanswer #### [securityQuestionAnswer] The answer to your security question. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The answer to your security question. [securityQuestionId]: #securityquestionid #### [securityQuestionId] A security question you wish to answer when authenticating to the SoftLayer customer portal. This parameter isn't required if no security questions are set on your portal account or if your account is configured to not require answering a security account upon login. -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ A security question you wish to answer when authenticating to the SoftLayer cust [username]: #username #### [username] The username you wish to authenticate to the SoftLayer customer portal with. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The username you wish to authenticate to the SoftLayer customer portal with. [vendor]: #vendor #### [vendor] The name of the vendor that will be used for external authentication -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_User_Customer_OpenIdConnect_LoginAccountInfo/_index.md b/content/reference/datatypes/SoftLayer_Container_User_Customer_OpenIdConnect_LoginAccountInfo/_index.md index dea7c1d69b..cd6b15adf0 100644 --- a/content/reference/datatypes/SoftLayer_Container_User_Customer_OpenIdConnect_LoginAccountInfo/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_User_Customer_OpenIdConnect_LoginAccountInfo/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] The customer account's internal identifier. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The customer account's internal identifier. [name]: #name #### [name] The company name associated with an account. -Type: **string** +Type: **string** +
      diff --git a/content/reference/datatypes/SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState/_index.md b/content/reference/datatypes/SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState/_index.md index 4b855999af..fada97690a 100644 --- a/content/reference/datatypes/SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [daysToGracePeriodEnd]: #daystograceperiodend #### [daysToGracePeriodEnd] The number of days remaining in the grace period for this user's account to -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The number of days remaining in the grace period for this user's account to [emailAlreadyUsedForInvitationToAccount]: #emailalreadyusedforinvitationtoaccount #### [emailAlreadyUsedForInvitationToAccount] Flag for whether the email address inside this SoftLayer_User_Customer object -Type: **boolean** +Type: **boolean** +
      @@ -65,7 +69,8 @@ Flag for whether the email address inside this SoftLayer_User_Customer object [emailAlreadyUsedForLinkToAccount]: #emailalreadyusedforlinktoaccount #### [emailAlreadyUsedForLinkToAccount] Flag for whether the email address inside this SoftLayer_User_Customer object -Type: **boolean** +Type: **boolean** + @@ -75,7 +80,8 @@ Flag for whether the email address inside this SoftLayer_User_Customer object [existingInvitationOpenIdConnectName]: #existinginvitationopenidconnectname #### [existingInvitationOpenIdConnectName] The IBMid email address where an invitation was sent. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The IBMid email address where an invitation was sent. [isAccountOpenIdConnectAuthenticated]: #isaccountopenidconnectauthenticated #### [isAccountOpenIdConnectAuthenticated] Flag for whether the account is OpenIdConnect authenticated or not. -Type: **boolean** +Type: **boolean** + diff --git a/content/reference/datatypes/SoftLayer_Container_User_Customer_PasswordSet/_index.md b/content/reference/datatypes/SoftLayer_Container_User_Customer_PasswordSet/_index.md index 3ceb04447f..1027661d45 100644 --- a/content/reference/datatypes/SoftLayer_Container_User_Customer_PasswordSet/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_User_Customer_PasswordSet/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Container for holding information necessary for the setting and resetting of customer passwords @@ -45,7 +47,8 @@ Container for holding information necessary for the setting and resetting of cus [answeredSecurityQuestionId]: #answeredsecurityquestionid #### [answeredSecurityQuestionId] Id of SoftLayer_User_Security_Question. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Id of SoftLayer_User_Security_Question. [authenticationMethods]: #authenticationmethods #### [authenticationMethods] The authentication methods required. -Type: **array of integers** +Type: **array of integers** + @@ -65,7 +69,8 @@ The authentication methods required. [digitCountRequirement]: #digitcountrequirement #### [digitCountRequirement] The number of digits required. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The number of digits required. [key]: #key #### [key] The password key provided to user in the password set url link sent via email. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The password key provided to user in the password set url link sent via email. [lowercaseCountRequirement]: #lowercasecountrequirement #### [lowercaseCountRequirement] The number of lowercase letters required. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The number of lowercase letters required. [maximumPasswordLengthRequirement]: #maximumpasswordlengthrequirement #### [maximumPasswordLengthRequirement] The maximum password length requirement. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The maximum password length requirement. [minimumPasswordLengthRequirement]: #minimumpasswordlengthrequirement #### [minimumPasswordLengthRequirement] The minimum password length requirement. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ The minimum password length requirement. [password]: #password #### [password] The user's new password. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The user's new password. [securityAnswer]: #securityanswer #### [securityAnswer] Answer to security question provided by the user. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Answer to security question provided by the user. [securityQuestions]: #securityquestions #### [securityQuestions] Array of SoftLayer_User_Security_Question. -Type: **SoftLayer_User_Security_Question[] ** +Type: **SoftLayer_User_Security_Question[] ** + @@ -145,7 +157,8 @@ Array of SoftLayer_User_Security_Question. [specialCharacterCountRequirement]: #specialcharactercountrequirement #### [specialCharacterCountRequirement] The number of special characters required. -Type: **integer** +Type: **integer** + @@ -155,7 +168,8 @@ The number of special characters required. [specialCharactersAllowed]: #specialcharactersallowed #### [specialCharactersAllowed] List of the allowed special characters. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ List of the allowed special characters. [uppercaseCountRequirement]: #uppercasecountrequirement #### [uppercaseCountRequirement] The number of uppercase letters required. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The number of uppercase letters required. [userId]: #userid #### [userId] The id of the user to authenticate. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_User_Customer_Portal_MobileToken/_index.md b/content/reference/datatypes/SoftLayer_Container_User_Customer_Portal_MobileToken/_index.md index 242033ffe8..5747f9f3e5 100644 --- a/content/reference/datatypes/SoftLayer_Container_User_Customer_Portal_MobileToken/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_User_Customer_Portal_MobileToken/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Container classed used to hold mobile portal token @@ -45,7 +47,8 @@ Container classed used to hold mobile portal token [hasExternalBinding]: #hasexternalbinding #### [hasExternalBinding] True if this user login required an external binding. -Type: **boolean** +Type: **boolean** + @@ -55,7 +58,8 @@ True if this user login required an external binding. [hash]: #hash #### [hash] hash of logged in user session id -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ hash of logged in user session id [user]: #user #### [user] the logged in user data -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -75,7 +80,8 @@ the logged in user data [userId]: #userid #### [userId] the id of the logged in user -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_User_Customer_Portal_Token/_index.md b/content/reference/datatypes/SoftLayer_Container_User_Customer_Portal_Token/_index.md index 9d75c9ffc7..02fa17d6dd 100644 --- a/content/reference/datatypes/SoftLayer_Container_User_Customer_Portal_Token/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_User_Customer_Portal_Token/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Container classed used to hold portal token @@ -45,7 +47,8 @@ Container classed used to hold portal token [hash]: #hash #### [hash] hash of logged in user session id -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ hash of logged in user session id [user]: #user #### [user] the logged in user data -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -65,7 +69,8 @@ the logged in user data [userId]: #userid #### [userId] the id of the logged in user -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange/_index.md b/content/reference/datatypes/SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange/_index.md index 80f7c45a59..3dce4e8408 100644 --- a/content/reference/datatypes/SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [account_id]: #account_id #### [account_id] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [context]: #context #### [context] -Type: **SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_Context ** +Type: **SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_Context ** +
      @@ -65,7 +69,8 @@ classes: [event_id]: #event_id #### [event_id] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [event_properties]: #event_properties #### [event_properties] -Type: **SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_EventProperties ** +Type: **SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_EventProperties ** + @@ -85,7 +91,8 @@ classes: [event_type]: #event_type #### [event_type] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [publisher]: #publisher #### [publisher] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ classes: [timestamp]: #timestamp #### [timestamp] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [version]: #version #### [version] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_Context/_index.md b/content/reference/datatypes/SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_Context/_index.md index 18b492994f..c8527c802f 100644 --- a/content/reference/datatypes/SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_Context/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_Context/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [previous_values]: #previous_values #### [previous_values] -Type: **SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_EventProperties ** +Type: **SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_EventProperties ** +
      diff --git a/content/reference/datatypes/SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_EventProperties/_index.md b/content/reference/datatypes/SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_EventProperties/_index.md index 326c721074..6ec70c909d 100644 --- a/content/reference/datatypes/SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_EventProperties/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_EventProperties/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [allowed_ip_addresses]: #allowed_ip_addresses #### [allowed_ip_addresses] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [altphonenumber]: #altphonenumber #### [altphonenumber] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [email]: #email #### [email] -Type: **string** +Type: **string** +
      @@ -75,7 +80,8 @@ classes: [firstname]: #firstname #### [firstname] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [iam_id]: #iam_id #### [iam_id] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [language]: #language #### [language] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ classes: [lastname]: #lastname #### [lastname] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [notification_language]: #notification_language #### [notification_language] -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ classes: [origin]: #origin #### [origin] -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ classes: [phonenumber]: #phonenumber #### [phonenumber] -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ classes: [photo]: #photo #### [photo] -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ classes: [realm]: #realm #### [realm] -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ classes: [self_manage]: #self_manage #### [self_manage] -Type: **boolean** +Type: **boolean** + @@ -175,7 +190,8 @@ classes: [state]: #state #### [state] -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ classes: [substate]: #substate #### [substate] -Type: **string** +Type: **string** + @@ -195,7 +212,8 @@ classes: [user_id]: #user_id #### [user_id] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_User_Data_Phone/_index.md b/content/reference/datatypes/SoftLayer_Container_User_Data_Phone/_index.md index 3bc3c4d22f..8e6ab10431 100644 --- a/content/reference/datatypes/SoftLayer_Container_User_Data_Phone/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_User_Data_Phone/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This container holds user's phone information. @@ -45,7 +47,8 @@ This container holds user's phone information. [countryCode]: #countrycode #### [countryCode] Country code number for the phone number Default: 1 (United States & Canada +1) -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Country code number for the phone number Default: 1 (United States & Canada +1) [extension]: #extension #### [extension] Phone extension code. It can be digits, commas, *, and # are allowed. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Phone extension code. It can be digits, commas, *, and # are allowed. [phone]: #phone #### [phone] Phone number can be a mobile phone number, desk phone number, or some other option. The phone number format must match the format selected in the country code. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Phone number can be a mobile phone number, desk phone number, or some other opti [phoneType]: #phonetype #### [phoneType] Type of phone number such as "primary", "office" or "home" -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_User_Employee_External_Binding_Verisign/_index.md b/content/reference/datatypes/SoftLayer_Container_User_Employee_External_Binding_Verisign/_index.md index 43a3f68424..074ed761e1 100644 --- a/content/reference/datatypes/SoftLayer_Container_User_Employee_External_Binding_Verisign/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_User_Employee_External_Binding_Verisign/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Container classed used to hold portal token diff --git a/content/reference/datatypes/SoftLayer_Container_Utility_File_Attachment/_index.md b/content/reference/datatypes/SoftLayer_Container_Utility_File_Attachment/_index.md index 36f6afd029..0e7dcc12de 100644 --- a/content/reference/datatypes/SoftLayer_Container_Utility_File_Attachment/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Utility_File_Attachment/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ At times,such as when attaching files to tickets, it is necessary to send files [data]: #data #### [data] The contents of a file that is uploaded to the SoftLayer API. -Type: **binary data** +Type: **binary data** + @@ -60,7 +63,8 @@ The contents of a file that is uploaded to the SoftLayer API. [filename]: #filename #### [filename] The name of a file that is uploaded to the SoftLayer API. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Utility_File_Entity/_index.md b/content/reference/datatypes/SoftLayer_Container_Utility_File_Entity/_index.md index e984915f16..31ea874ca6 100644 --- a/content/reference/datatypes/SoftLayer_Container_Utility_File_Entity/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Utility_File_Entity/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -62,7 +64,8 @@ SoftLayer_Container_Utility_File_Entity data type models a single entity on a st [content]: #content #### [content] A file entity's raw content. -Type: **binary data** +Type: **binary data** + @@ -72,7 +75,8 @@ A file entity's raw content. [contentType]: #contenttype #### [contentType] A file entity's MIME content type. -Type: **string** +Type: **string** + @@ -82,7 +86,8 @@ A file entity's MIME content type. [createDate]: #createdate #### [createDate] The date a file entity was created. -Type: **dateTime** +Type: **dateTime** + @@ -92,7 +97,8 @@ The date a file entity was created. [deleteDate]: #deletedate #### [deleteDate] The date a CloudLayer storage file entity was moved into the recycle bin. This field applies to files that are pending deletion in the recycle bin. -Type: **dateTime** +Type: **dateTime** + @@ -102,7 +108,8 @@ The date a CloudLayer storage file entity was moved into the recycle bin. This f [id]: #id #### [id] Unique identifier for the file. This can be either a number or guid. -Type: **string** +Type: **string** + @@ -112,7 +119,8 @@ Unique identifier for the file. This can be either a number or guid. [isShared]: #isshared #### [isShared] Whether a CloudLayer storage file entity is shared with another CloudLayer user. -Type: **integer** +Type: **integer** + @@ -122,7 +130,8 @@ Whether a CloudLayer storage file entity is shared with another CloudLayer user. [modifyDate]: #modifydate #### [modifyDate] The date a file entity was last changed. -Type: **dateTime** +Type: **dateTime** + @@ -132,7 +141,8 @@ The date a file entity was last changed. [name]: #name #### [name] A file entity's name. -Type: **string** +Type: **string** + @@ -142,7 +152,8 @@ A file entity's name. [owner]: #owner #### [owner] The owner is usually the account who first upload or created the file on the resource or the account who is responsible for the file at the moment. -Type: **string** +Type: **string** + @@ -152,7 +163,8 @@ The owner is usually the account who first upload or created the file on the res [size]: #size #### [size] The size of a file entity in bytes. -Type: **unsigned long** +Type: **unsigned long** + @@ -162,7 +174,8 @@ The size of a file entity in bytes. [type]: #type #### [type] A CloudLayer storage file entity's type. Types can include "file", "folder", "dir", and "project". -Type: **string** +Type: **string** + @@ -172,7 +185,8 @@ A CloudLayer storage file entity's type. Types can include "file", "folder", "di [version]: #version #### [version] The latest revision of a file on a CloudLayer storage volume. This number increments each time a new revision of the file is uploaded. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Utility_Message/_index.md b/content/reference/datatypes/SoftLayer_Container_Utility_Message/_index.md index b47706df9d..ed9c914221 100644 --- a/content/reference/datatypes/SoftLayer_Container_Utility_Message/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Utility_Message/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
      @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [message]: #message #### [message] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ classes: [summary]: #summary #### [summary] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_Status/_index.md b/content/reference/datatypes/SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_Status/_index.md index 0472b8e3e3..f05b8ff0a6 100644 --- a/content/reference/datatypes/SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -61,7 +63,8 @@ SoftLayer customer servers that are purchased with the Microsoft Windows operati [lastRebootDate]: #lastrebootdate #### [lastRebootDate] The last time a server rebooted due to a Windows Update. -Type: **dateTime** +Type: **dateTime** + @@ -71,7 +74,8 @@ The last time a server rebooted due to a Windows Update. [lastStatusDate]: #laststatusdate #### [lastStatusDate] The last time that SoftLayer's local WSUS server received a status update from a customer server. -Type: **dateTime** +Type: **dateTime** + @@ -81,7 +85,8 @@ The last time that SoftLayer's local WSUS server received a status update from a [lastSyncDate]: #lastsyncdate #### [lastSyncDate] The last time a server synchronized with SoftLayer's local WSUS server. -Type: **dateTime** +Type: **dateTime** + @@ -91,7 +96,8 @@ The last time a server synchronized with SoftLayer's local WSUS server. [privateIPAddress]: #privateipaddress #### [privateIPAddress] This is the private IP address for this server. -Type: **string** +Type: **string** + @@ -101,7 +107,8 @@ This is the private IP address for this server. [syncStatus]: #syncstatus #### [syncStatus] The status message returned from a server's last synchronization with SoftLayer's local WSUS server. -Type: **string** +Type: **string** + @@ -111,7 +118,8 @@ The status message returned from a server's last synchronization with SoftLayer' [updateStatus]: #updatestatus #### [updateStatus] A server's update status, as retrieved form SoftLayer's local WSUS server. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem/_index.md b/content/reference/datatypes/SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem/_index.md index e94a375fa5..94f500dd20 100644 --- a/content/reference/datatypes/SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -65,7 +67,8 @@ SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem models a [description]: #description #### [description] A short description of a Microsoft Windows Update. -Type: **string** +Type: **string** + @@ -75,7 +78,8 @@ A short description of a Microsoft Windows Update. [failed]: #failed #### [failed] Flag indicating that this patch failed to properly install -Type: **boolean** +Type: **boolean** + @@ -85,7 +89,8 @@ Flag indicating that this patch failed to properly install [kbArticleNumber]: #kbarticlenumber #### [kbArticleNumber] A Windows Update's knowledge base article number. Every Windows Update can be referenced on the Microsoft Help and Support site at the URL http://support.microsoft.com/kb/
      . -Type: **integer** +Type: **integer** + @@ -95,7 +100,8 @@ A Windows Update's knowledge base article number. Every Windows Update can be re [optional]: #optional #### [optional] Flag indicating that the update is entirely optionals -Type: **boolean** +Type: **boolean** + @@ -105,7 +111,8 @@ Flag indicating that the update is entirely optionals [requiresReboot]: #requiresreboot #### [requiresReboot] Flag indicating that a reboot is needed for this update to be fully applied -Type: **boolean** +Type: **boolean** + diff --git a/content/reference/datatypes/SoftLayer_Container_Utility_Network_Firewall_Rule_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Container_Utility_Network_Firewall_Rule_Attribute/_index.md index ede1f91938..655c53c25f 100644 --- a/content/reference/datatypes/SoftLayer_Container_Utility_Network_Firewall_Rule_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Utility_Network_Firewall_Rule_Attribute/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Utility_Network_Firewall_Rule_Attribute data type contains information relating to a single firewall rule. @@ -45,7 +47,8 @@ The SoftLayer_Container_Utility_Network_Firewall_Rule_Attribute data type contai [actions]: #actions #### [actions] The valid actions for use with rules. -Type: **array of strings** +Type: **array of strings** + @@ -55,7 +58,8 @@ The valid actions for use with rules. [maximumRuleCount]: #maximumrulecount #### [maximumRuleCount] Maximum allowed number of rules. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Maximum allowed number of rules. [protocols]: #protocols #### [protocols] The valid protocols for use with rules. -Type: **array of strings** +Type: **array of strings** + @@ -75,7 +80,8 @@ The valid protocols for use with rules. [sourceIpSubnetMasks]: #sourceipsubnetmasks #### [sourceIpSubnetMasks] The valid source ip subnet masks for use with rules. -Type: **SoftLayer_Container_Utility_Network_Subnet_Mask_Generic_Detail[] ** +Type: **SoftLayer_Container_Utility_Network_Subnet_Mask_Generic_Detail[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Utility_Network_Subnet_Mask_Generic_Detail/_index.md b/content/reference/datatypes/SoftLayer_Container_Utility_Network_Subnet_Mask_Generic_Detail/_index.md index 48ef6b5408..cd776c2114 100644 --- a/content/reference/datatypes/SoftLayer_Container_Utility_Network_Subnet_Mask_Generic_Detail/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Utility_Network_Subnet_Mask_Generic_Detail/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Utility_Network_Subnet_Mask_Generic_Detail data type contains information relating to a subnet mask and details associated with that object. @@ -45,7 +47,8 @@ The SoftLayer_Container_Utility_Network_Subnet_Mask_Generic_Detail data type con [cidr]: #cidr #### [cidr] The subnet cidr prefix. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The subnet cidr prefix. [description]: #description #### [description] The subnet mask description. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The subnet mask description. [mask]: #mask #### [mask] The subnet mask. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Virtual_ConsoleData/_index.md b/content/reference/datatypes/SoftLayer_Container_Virtual_ConsoleData/_index.md index b508dd50c9..2ca9b83107 100644 --- a/content/reference/datatypes/SoftLayer_Container_Virtual_ConsoleData/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Virtual_ConsoleData/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Virtual_ConsoleData data type contains information used to access a VSIs console @@ -45,7 +47,8 @@ The SoftLayer_Container_Virtual_ConsoleData data type contains information used [websocketHost]: #websockethost #### [websocketHost] The websocket host address used to access the console -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The websocket host address used to access the console [websocketPath]: #websocketpath #### [websocketPath] The path to the websocket -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The path to the websocket [websocketPort]: #websocketport #### [websocketPort] The websocket port used to access the console -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The websocket port used to access the console [websocketToken]: #websockettoken #### [websocketToken] The token used to authenticate with the console websocket -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Virtual_DedicatedHost_AllocationStatus/_index.md b/content/reference/datatypes/SoftLayer_Container_Virtual_DedicatedHost_AllocationStatus/_index.md index 9fa38b3f5d..4d8c7de6e6 100644 --- a/content/reference/datatypes/SoftLayer_Container_Virtual_DedicatedHost_AllocationStatus/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Virtual_DedicatedHost_AllocationStatus/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This data type represents the structure to hold the allocation properties of a [SoftLayer_Virtual_DedicatedHost]({{}}). @@ -45,7 +47,8 @@ This data type represents the structure to hold the allocation properties of a [ [cpuAllocated]: #cpuallocated #### [cpuAllocated] Number of allocated CPU cores on the specified dedicated host. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Number of allocated CPU cores on the specified dedicated host. [cpuAvailable]: #cpuavailable #### [cpuAvailable] Number of available CPU cores on the specified dedicated host. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Number of available CPU cores on the specified dedicated host. [cpuCount]: #cpucount #### [cpuCount] Total number of CPU cores on the dedicated host. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ Total number of CPU cores on the dedicated host. [diskAllocated]: #diskallocated #### [diskAllocated] Amount of allocated disk space on the specified dedicated host. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Amount of allocated disk space on the specified dedicated host. [diskAvailable]: #diskavailable #### [diskAvailable] Amount of available disk space on the specified dedicated host. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ Amount of available disk space on the specified dedicated host. [diskCapacity]: #diskcapacity #### [diskCapacity] Total amount of disk capacity on the dedicated host. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ Total amount of disk capacity on the dedicated host. [guestCount]: #guestcount #### [guestCount] Number of allocated guests on the specified dedicated host. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ Number of allocated guests on the specified dedicated host. [memoryAllocated]: #memoryallocated #### [memoryAllocated] Amount of allocated memory on the specified dedicated host. -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ Amount of allocated memory on the specified dedicated host. [memoryAvailable]: #memoryavailable #### [memoryAvailable] Amount of available memory on the specified dedicated host. -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ Amount of available memory on the specified dedicated host. [memoryCapacity]: #memorycapacity #### [memoryCapacity] Total amount of memory capacity on the dedicated host. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Virtual_DedicatedHost_Pci_Device_AllocationStatus/_index.md b/content/reference/datatypes/SoftLayer_Container_Virtual_DedicatedHost_Pci_Device_AllocationStatus/_index.md index 3dec532ab7..91c758f818 100644 --- a/content/reference/datatypes/SoftLayer_Container_Virtual_DedicatedHost_Pci_Device_AllocationStatus/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Virtual_DedicatedHost_Pci_Device_AllocationStatus/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This data type represents PCI device allocation properties of a [SoftLayer_Virtual_DedicatedHost]({{}}). @@ -45,7 +47,8 @@ This data type represents PCI device allocation properties of a [SoftLayer_Virtu [deviceCount]: #devicecount #### [deviceCount] The number of PCI devices on the host. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The number of PCI devices on the host. [deviceName]: #devicename #### [deviceName] The name of the PCI devices on the host. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The name of the PCI devices on the host. [devicesAllocated]: #devicesallocated #### [devicesAllocated] The number of PCI devices currently allocated to guests. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The number of PCI devices currently allocated to guests. [devicesAvailable]: #devicesavailable #### [devicesAvailable] The number of PCI devices available for allocation. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The number of PCI devices available for allocation. [hardwareComponentModelGenericId]: #hardwarecomponentmodelgenericid #### [hardwareComponentModelGenericId] The generic component model ID of the PCI device. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The generic component model ID of the PCI device. [hostId]: #hostid #### [hostId] The ID of the host that the dedicated host is on. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_Block_Device_Template_Configuration/_index.md b/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_Block_Device_Template_Configuration/_index.md index 14f0b0ced3..159d9c2070 100644 --- a/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_Block_Device_Template_Configuration/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_Block_Device_Template_Configuration/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Virtual_Guest_Block_Device_Template_Configuration data type contains information relating to a template's external location for importing and exporting @@ -51,7 +53,8 @@ The SoftLayer_Container_Virtual_Guest_Block_Device_Template_Configuration data t #### [bootMode] Optional virtualization boot mode parameter, if set, can mark a template to boot specifically into PV or HVM. -Type: **string** +Type: **string** + @@ -62,7 +65,8 @@ Optional virtualization boot mode parameter, if set, can mark a template to boot #### [byol] Specifies if image is using a customer's software license. -Type: **boolean** +Type: **boolean** + @@ -73,7 +77,8 @@ Specifies if image is using a customer's software license. #### [cloudInit] Specifies if image requires cloud-init. -Type: **boolean** +Type: **boolean** + @@ -84,7 +89,8 @@ Specifies if image requires cloud-init. #### [crkCrn] CRN to customer root key -Type: **string** +Type: **string** + @@ -95,7 +101,8 @@ CRN to customer root key #### [environmentType] For future use; not currently defined. -Type: **array of strings** +Type: **array of strings** + @@ -106,7 +113,8 @@ For future use; not currently defined. #### [ibmAccessKey] IBM Cloud HMAC Access Key -Type: **string** +Type: **string** + @@ -117,7 +125,8 @@ IBM Cloud HMAC Access Key #### [ibmApiKey] IBM Cloud (Bluemix) API Key -Type: **string** +Type: **string** + @@ -128,7 +137,8 @@ IBM Cloud (Bluemix) API Key #### [ibmSecretKey] IBM HMAC Secret Key -Type: **string** +Type: **string** + @@ -139,7 +149,8 @@ IBM HMAC Secret Key #### [isEncrypted] Specifies if image is encrypted or not. -Type: **boolean** +Type: **boolean** + @@ -149,7 +160,8 @@ Specifies if image is encrypted or not. [name]: #name #### [name] The group name to be applied to the imported template -Type: **string** +Type: **string** + @@ -159,7 +171,8 @@ The group name to be applied to the imported template [note]: #note #### [note] The note to be applied to the imported template -Type: **string** +Type: **string** + @@ -170,7 +183,8 @@ The note to be applied to the imported template #### [operatingSystemReferenceCode] The referenceCode of the operating system software description for the imported VHD -Type: **string** +Type: **string** + @@ -181,7 +195,8 @@ The referenceCode of the operating system software description for the imported #### [rootKeyId] Name of the IBM Key Protect Key Name. Required if using an encrypted image. -Type: **string** +Type: **string** + @@ -192,7 +207,8 @@ Name of the IBM Key Protect Key Name. Required if using an encrypted image. #### [supportedBootModes] Optional Collection of modes that this template supports booting into. -Type: **array of strings** +Type: **array of strings** + @@ -204,7 +220,8 @@ Optional Collection of modes that this template supports booting into. The URI for an object storage object (.vhd/.iso file) swift://@// -Type: **string** +Type: **string** + @@ -215,7 +232,8 @@ The URI for an object storage object (.vhd/.iso file) #### [wrappedDek] Wrapped Decryption Key provided by IBM Key Protect -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_Block_Device_Template_Group_RiasAccount/_index.md b/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_Block_Device_Template_Group_RiasAccount/_index.md index b36662d73f..bbb10e25d3 100644 --- a/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_Block_Device_Template_Group_RiasAccount/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_Block_Device_Template_Group_RiasAccount/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [masterUserId]: #masteruserid #### [masterUserId] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [token]: #token #### [token] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_Configuration/_index.md b/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_Configuration/_index.md index f62f7da599..dece143c12 100644 --- a/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_Configuration/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_Configuration/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + The guest configuration container is used to provide configuration options for creating computing instances. Each configuration option will include both an itemPrice and a template. @@ -76,7 +78,8 @@ The localDiskFlag value in the template represents whether the opti Note: The block device number '1' is reserved for the SWAP disk attached to the computing instance. -Type: **SoftLayer_Container_Virtual_Guest_Configuration_Option[] ** +Type: **SoftLayer_Container_Virtual_Guest_Configuration_Option[] ** + @@ -92,7 +95,8 @@ Available datacenter options. The datacenter.name value in the template represents which datacenter the computing instance will be provisioned in. -Type: **SoftLayer_Container_Virtual_Guest_Configuration_Option[] ** +Type: **SoftLayer_Container_Virtual_Guest_Configuration_Option[] ** + @@ -113,7 +117,8 @@ The supplementalCreateObjectOptions.flavorKeyName value in the temp When providing a supplementalCreateObjectOptions.flavorKeyName option the core, ram, and primary disk options are not needed. If those options are provided they are validated against the flavor. -Type: **SoftLayer_Container_Virtual_Guest_Configuration_Option[] ** +Type: **SoftLayer_Container_Virtual_Guest_Configuration_Option[] ** + @@ -129,7 +134,8 @@ Available memory options. The maxMemory value in the template represents the amount of memory, in megabytes, allocated to the computing instance. -Type: **SoftLayer_Container_Virtual_Guest_Configuration_Option[] ** +Type: **SoftLayer_Container_Virtual_Guest_Configuration_Option[] ** + @@ -145,7 +151,8 @@ Available network component options. The networkComponent.maxSpeed value in the template represents the link speed, in megabits per second, of the network connections for a computing instance. -Type: **SoftLayer_Container_Virtual_Guest_Configuration_Option[] ** +Type: **SoftLayer_Container_Virtual_Guest_Configuration_Option[] ** + @@ -176,7 +183,8 @@ For Windows based operating systems the version will represent both the release Notice - Some operating systems are charged based on the value specified in startCpus. The price which is used can be determined by calling [SoftLayer_Virtual_Guest::generateOrderTemplate]({{}}) with your desired device specifications. -Type: **SoftLayer_Container_Virtual_Guest_Configuration_Option[] ** +Type: **SoftLayer_Container_Virtual_Guest_Configuration_Option[] ** + @@ -193,7 +201,8 @@ Available processor options. The startCpus value in the template represents the number of cores allocated to the computing instance. The dedicatedAccountHostOnlyFlag value in the template represents whether the instance will run on hosts with instances belonging to other accounts. -Type: **SoftLayer_Container_Virtual_Guest_Configuration_Option[] ** +Type: **SoftLayer_Container_Virtual_Guest_Configuration_Option[] ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_Configuration_Option/_index.md b/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_Configuration_Option/_index.md index 7c9c222ba8..de8c0b7909 100644 --- a/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_Configuration_Option/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_Configuration_Option/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + An option found within a [SoftLayer_Container_Virtual_Guest_Configuration]({{}}) structure. @@ -46,7 +48,8 @@ An option found within a [SoftLayer_Container_Virtual_Guest_Configuration]({{Type: **SoftLayer_Product_Package_Preset ** +Type: **SoftLayer_Product_Package_Preset ** + @@ -57,7 +60,8 @@ Provides a description of a pre-defined configuration with monthly and hourly co #### [itemPrice] Provides hourly and monthly costs (if either are applicable), and a description of the option. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -68,7 +72,8 @@ Provides hourly and monthly costs (if either are applicable), and a description #### [template] Provides a fragment of the request with the properties and values that must be sent when creating a computing instance with the option. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + diff --git a/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_PendingMaintenanceAction/_index.md b/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_PendingMaintenanceAction/_index.md index 038cfc5660..acf74206d8 100644 --- a/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_PendingMaintenanceAction/_index.md +++ b/content/reference/datatypes/SoftLayer_Container_Virtual_Guest_PendingMaintenanceAction/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Container_Virtual_Guest_PendingMaintenanceAction data type contains information relating to a SoftLayer_Virtual_Guest's pending maintenance actions. @@ -45,7 +47,8 @@ The SoftLayer_Container_Virtual_Guest_PendingMaintenanceAction data type contain [actionId]: #actionid #### [actionId] The ID of the associated action. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The ID of the associated action. [dueDate]: #duedate #### [dueDate] The datetime at which this action will be initiated regardless of customer action (if it has not already been completed). -Type: **dateTime** +Type: **dateTime** + @@ -67,7 +71,8 @@ The datetime at which this action will be initiated regardless of customer actio User-friendly status. The Completed status means that it is done, no further action is required. The Scheduled status means that the action is pending and will start on the dueDate if no customer action is taken before such time. The In Progress status means the action is currently being executed. -Type: **string** +Type: **string** + @@ -77,7 +82,8 @@ The Completed status means that it is done, no further action is re [ticket]: #ticket #### [ticket] The ticket associated with this maintenance action. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -87,7 +93,8 @@ The ticket associated with this maintenance action. [title]: #title #### [title] The Title for the associated action. -Type: **string** +Type: **string** + @@ -97,7 +104,8 @@ The Title for the associated action. [triggerExplanation]: #triggerexplanation #### [triggerExplanation] The Trigger Explanation for the associated action. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain/_index.md index e138e9ac91..4bad548e37 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) records. @@ -60,7 +62,8 @@ The SoftLayer_Dns_Domain data type represents a single DNS domain record hosted [id]: #id #### [id] A domain record's internal identifier. -Type: **integer** +Type: **integer** + @@ -70,7 +73,8 @@ A domain record's internal identifier. [name]: #name #### [name] A domain's name including top-level domain, for example "example.com". -Type: **string** +Type: **string** + @@ -80,7 +84,8 @@ A domain's name including top-level domain, for example "example.com". [serial]: #serial #### [serial] A unique number denoting the latest revision of a domain. Whenever a domain is changed its corresponding serial number is also changed. Serial numbers typically follow the format yyyymmdd## where yyyy is the current year, mm is the current month, dd is the current day of the month, and ## is the number of the revision for that day. A domain's serial number is automatically updated when edited via the API. -Type: **integer** +Type: **integer** + @@ -90,7 +95,8 @@ A unique number denoting the latest revision of a domain. Whenever a domain is c [updateDate]: #updatedate #### [updateDate] The date that this domain record was last updated. -Type: **dateTime** +Type: **dateTime** + @@ -106,7 +112,8 @@ The date that this domain record was last updated. [account]: #account #### [account] The SoftLayer customer account that owns a domain. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -116,7 +123,8 @@ The SoftLayer customer account that owns a domain. [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the dns domain record is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -126,7 +134,8 @@ A flag indicating that the dns domain record is a managed resource. [resourceRecords]: #resourcerecords #### [resourceRecords] The individual records contained within a domain record. These include but are not limited to A, AAAA, MX, CTYPE, SPF and TXT records. -Type: **SoftLayer_Dns_Domain_ResourceRecord[] ** +Type: **SoftLayer_Dns_Domain_ResourceRecord[] ** + @@ -136,7 +145,8 @@ The individual records contained within a domain record. These include but are n [secondary]: #secondary #### [secondary] The secondary DNS record that defines this domain as being managed through zone transfers. -Type: **SoftLayer_Dns_Secondary ** +Type: **SoftLayer_Dns_Secondary ** + @@ -146,7 +156,8 @@ The secondary DNS record that defines this domain as being managed through zone [soaResourceRecord]: #soaresourcerecord #### [soaResourceRecord] The start of authority (SOA) record contains authoritative and propagation details for a DNS zone. This property is not considered in requests to createObject and editObject. -Type: **SoftLayer_Dns_Domain_ResourceRecord_SoaType ** +Type: **SoftLayer_Dns_Domain_ResourceRecord_SoaType ** + @@ -158,7 +169,8 @@ The start of authority (SOA) record contains authoritative and propagation detai [resourceRecordCount]: #resourcerecordcount #### [resourceRecordCount] A count of the individual records contained within a domain record. These include but are not limited to A, AAAA, MX, CTYPE, SPF and TXT records. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_Forward/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain_Forward/_index.md index 7a159a6882..3f6f66eef1 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_Forward/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain_Forward/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) records. @@ -51,7 +53,8 @@ The SoftLayer_Dns_Domain_Forward data type represents a single DNS domain record [id]: #id #### [id] A domain record's internal identifier. -Type: **integer** +Type: **integer** + @@ -61,7 +64,8 @@ A domain record's internal identifier. [name]: #name #### [name] A domain's name including top-level domain, for example "example.com". -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ A domain's name including top-level domain, for example "example.com". [serial]: #serial #### [serial] A unique number denoting the latest revision of a domain. Whenever a domain is changed its corresponding serial number is also changed. Serial numbers typically follow the format yyyymmdd## where yyyy is the current year, mm is the current month, dd is the current day of the month, and ## is the number of the revision for that day. A domain's serial number is automatically updated when edited via the API. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ A unique number denoting the latest revision of a domain. Whenever a domain is c [updateDate]: #updatedate #### [updateDate] The date that this domain record was last updated. -Type: **dateTime** +Type: **dateTime** + @@ -97,7 +103,8 @@ The date that this domain record was last updated. [account]: #account #### [account] A domain's associated customer account. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -107,7 +114,8 @@ A domain's associated customer account. [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the dns domain record is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -117,7 +125,8 @@ A flag indicating that the dns domain record is a managed resource. [resourceRecords]: #resourcerecords #### [resourceRecords] The individual records contained within a domain record. These include but are not limited to A, AAAA, MX, CTYPE, SPF and TXT records. -Type: **SoftLayer_Dns_Domain_ResourceRecord[] ** +Type: **SoftLayer_Dns_Domain_ResourceRecord[] ** + @@ -127,7 +136,8 @@ The individual records contained within a domain record. These include but are n [secondary]: #secondary #### [secondary] The secondary DNS record that defines this domain as being managed through zone transfers. -Type: **SoftLayer_Dns_Secondary ** +Type: **SoftLayer_Dns_Secondary ** + @@ -137,7 +147,8 @@ The secondary DNS record that defines this domain as being managed through zone [soaResourceRecord]: #soaresourcerecord #### [soaResourceRecord] The start of authority (SOA) record contains authoritative and propagation details for a DNS zone. This property is not considered in requests to createObject and editObject. -Type: **SoftLayer_Dns_Domain_ResourceRecord_SoaType ** +Type: **SoftLayer_Dns_Domain_ResourceRecord_SoaType ** + @@ -149,7 +160,8 @@ The start of authority (SOA) record contains authoritative and propagation detai [resourceRecordCount]: #resourcerecordcount #### [resourceRecordCount] A count of the individual records contained within a domain record. These include but are not limited to A, AAAA, MX, CTYPE, SPF and TXT records. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_Registration/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain_Registration/_index.md index f51ca845f4..0a81f5a777 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_Registration/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain_Registration/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Dns_Domain_Registration data type represents a domain registration record. ### External Links @@ -56,7 +58,8 @@ The SoftLayer_Dns_Domain_Registration data type represents a domain registration [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -66,7 +69,8 @@ The SoftLayer_Dns_Domain_Registration data type represents a domain registration [domainRegistrationStatusId]: #domainregistrationstatusid #### [domainRegistrationStatusId] -Type: **integer** +Type: **integer** + @@ -76,7 +80,8 @@ The SoftLayer_Dns_Domain_Registration data type represents a domain registration [expireDate]: #expiredate #### [expireDate] The date that the domain registration will expire. -Type: **dateTime** +Type: **dateTime** + @@ -86,7 +91,8 @@ The date that the domain registration will expire. [id]: #id #### [id] A domain record's internal identifier. -Type: **integer** +Type: **integer** + @@ -96,7 +102,8 @@ A domain record's internal identifier. [lockedFlag]: #lockedflag #### [lockedFlag] Indicates whether a domain is locked or unlocked. -Type: **integer** +Type: **integer** + @@ -106,7 +113,8 @@ Indicates whether a domain is locked or unlocked. [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -116,7 +124,8 @@ Indicates whether a domain is locked or unlocked. [name]: #name #### [name] A domain's name, for example "example.com". -Type: **string** +Type: **string** + @@ -126,7 +135,8 @@ A domain's name, for example "example.com". [registrantVerificationStatusId]: #registrantverificationstatusid #### [registrantVerificationStatusId] -Type: **integer** +Type: **integer** + @@ -136,7 +146,8 @@ A domain's name, for example "example.com". [serviceProviderId]: #serviceproviderid #### [serviceProviderId] -Type: **integer** +Type: **integer** + @@ -152,7 +163,8 @@ A domain's name, for example "example.com". [account]: #account #### [account] The SoftLayer customer account that the domain is registered to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -162,7 +174,8 @@ The SoftLayer customer account that the domain is registered to. [domainRegistrationStatus]: #domainregistrationstatus #### [domainRegistrationStatus] The domain registration status. -Type: **SoftLayer_Dns_Domain_Registration_Status ** +Type: **SoftLayer_Dns_Domain_Registration_Status ** + @@ -172,7 +185,8 @@ The domain registration status. [registrantVerificationStatus]: #registrantverificationstatus #### [registrantVerificationStatus] The registrant verification status. -Type: **SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status ** +Type: **SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status ** + @@ -182,7 +196,8 @@ The registrant verification status. [serviceProvider]: #serviceprovider #### [serviceProvider] -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/_index.md index d45d77d46d..87d32f0919 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status models the state of the registrant. Here are the following status codes: @@ -60,7 +62,8 @@ SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status models the stat [description]: #description #### [description] The description of the registrant verification status. -Type: **string** +Type: **string** + @@ -70,7 +73,8 @@ The description of the registrant verification status. [id]: #id #### [id] The unique identifier of the registrant verification status -Type: **integer** +Type: **integer** + @@ -80,7 +84,8 @@ The unique identifier of the registrant verification status [keyName]: #keyname #### [keyName] The unique keyname of the registrant verification status. -Type: **string** +Type: **string** + @@ -90,7 +95,8 @@ The unique keyname of the registrant verification status. [name]: #name #### [name] The name of the registrant verification status. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_Registration_Status/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain_Registration_Status/_index.md index 4251eefbf2..54b6b1fcf4 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_Registration_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain_Registration_Status/_index.md @@ -21,6 +21,8 @@ classes: ## Description + + SoftLayer_Dns_Domain_Registration_Status models the state of domain name. Here are the following status codes: @@ -62,7 +64,8 @@ SoftLayer_Dns_Domain_Registration_Status models the state of domain name. Here a [description]: #description #### [description] The description of the domain registration status names. -Type: **string** +Type: **string** + @@ -72,7 +75,8 @@ The description of the domain registration status names. [id]: #id #### [id] The unique identifier of the domain registration status -Type: **integer** +Type: **integer** + @@ -82,7 +86,8 @@ The unique identifier of the domain registration status [keyName]: #keyname #### [keyName] The unique keyname of the domain registration status. -Type: **string** +Type: **string** + @@ -92,7 +97,8 @@ The unique keyname of the domain registration status. [name]: #name #### [name] The name of the domain registration status. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord/_index.md index ccddf3ae1a..59bb171400 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) records * '''"aaaa"''' for [SoftLayer_Dns_Domain_ResourceRecord_AaaaType]({{}}) records @@ -115,7 +117,8 @@ As ''SoftLayer_Dns_Domain_ResourceRecord'' objects are created and loaded, the A [data]: #data #### [data] The value of a domain's resource record. This can be an IP address or a hostname. Fully qualified host and domain name data must end with the "." character. -Type: **string** +Type: **string** + @@ -125,7 +128,8 @@ The value of a domain's resource record. This can be an IP address or a hostname [domainId]: #domainid #### [domainId] An identifier belonging to the domain that a resource record is associated with. -Type: **integer** +Type: **integer** + @@ -135,7 +139,8 @@ An identifier belonging to the domain that a resource record is associated with. [expire]: #expire #### [expire] The amount of time in seconds that a secondary name server (or servers) will hold a zone before it is no longer considered authoritative. -Type: **integer** +Type: **integer** + @@ -145,7 +150,8 @@ The amount of time in seconds that a secondary name server (or servers) will hol [host]: #host #### [host] The host defined by a resource record. A value of "@" denotes a wildcard. -Type: **string** +Type: **string** + @@ -155,7 +161,8 @@ The host defined by a resource record. A value of "@" denotes a wildcard. [id]: #id #### [id] A domain resource record's internal identifier. -Type: **integer** +Type: **integer** + @@ -165,7 +172,8 @@ A domain resource record's internal identifier. [minimum]: #minimum #### [minimum] The amount of time in seconds that a domain's resource records are valid. This is also known as a minimum TTL, and can be overridden by an individual resource record's TTL. -Type: **integer** +Type: **integer** + @@ -175,7 +183,8 @@ The amount of time in seconds that a domain's resource records are valid. This i [mxPriority]: #mxpriority #### [mxPriority] Useful in cases where a domain has more than one mail exchanger, the priority property is the priority of the MTA that delivers mail for a domain. A lower number denotes a higher priority, and mail will attempt to deliver through that MTA before moving to lower priority mail servers. Priority is defaulted to 10 upon resource record creation. -Type: **integer** +Type: **integer** + @@ -185,7 +194,8 @@ Useful in cases where a domain has more than one mail exchanger, the priority pr [refresh]: #refresh #### [refresh] The amount of time in seconds that a secondary name server should wait to check for a new copy of a DNS zone from the domain's primary name server. If a zone file has changed then the secondary DNS server will update it's copy of the zone to match the primary DNS server's zone. -Type: **integer** +Type: **integer** + @@ -195,7 +205,8 @@ The amount of time in seconds that a secondary name server should wait to check [responsiblePerson]: #responsibleperson #### [responsiblePerson] The email address of the person responsible for a domain, with the "@" replaced with a ".". For instance, if root@example.org is responsible for example.org, then example.org's SOA responsibility is "root.example.org.". -Type: **string** +Type: **string** + @@ -205,7 +216,8 @@ The email address of the person responsible for a domain, with the "@" replaced [retry]: #retry #### [retry] The amount of time in seconds that a domain's primary name server (or servers) should wait if an attempt to refresh by a secondary name server failed before attempting to refresh a domain's zone with that secondary name server again. -Type: **integer** +Type: **integer** + @@ -215,7 +227,8 @@ The amount of time in seconds that a domain's primary name server (or servers) s [ttl]: #ttl #### [ttl] The Time To Live value of a resource record, measured in seconds. TTL is used by a name server to determine how long to cache a resource record. An SOA record's TTL value defines the domain's overall TTL. -Type: **integer** +Type: **integer** + @@ -225,7 +238,8 @@ The Time To Live value of a resource record, measured in seconds. TTL is used by [type]: #type #### [type] A domain resource record's type. A value of "a" denotes an A (address) record, "aaaa" denotes an AAAA (IPv6 address) record, "cname" denotes a CNAME (canonical name) record, "mx" denotes an MX (mail exchanger) record, "ns" denotes an NS (nameserver) record, "ptr" denotes a PTR (pointer/reverse) record, "soa" denotes the SOA (start of authority) record, "spf" denotes a SPF (sender policy framework) record, and "txt" denotes a TXT (text) record. A domain record's type also denotes which class in the SoftLayer API is a best match for extending a resource record. -Type: **string** +Type: **string** + @@ -241,7 +255,8 @@ A domain resource record's type. A value of "a" denotes an A (address) record, " [domain]: #domain #### [domain] The domain that a resource record belongs to. -Type: **SoftLayer_Dns_Domain ** +Type: **SoftLayer_Dns_Domain ** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_AType/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_AType/_index.md index c04568aa67..d36320ba16 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_AType/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_AType/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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". ### External Links @@ -67,7 +69,8 @@ SoftLayer_Dns_Domain_ResourceRecord_AType is a SoftLayer_Dns_Domain_ResourceReco [data]: #data #### [data] The value of a domain's resource record. This can be an IP address or a hostname. Fully qualified host and domain name data must end with the "." character. -Type: **string** +Type: **string** + @@ -77,7 +80,8 @@ The value of a domain's resource record. This can be an IP address or a hostname [domainId]: #domainid #### [domainId] An identifier belonging to the domain that a resource record is associated with. -Type: **integer** +Type: **integer** + @@ -87,7 +91,8 @@ An identifier belonging to the domain that a resource record is associated with. [expire]: #expire #### [expire] The amount of time in seconds that a secondary name server (or servers) will hold a zone before it is no longer considered authoritative. -Type: **integer** +Type: **integer** + @@ -97,7 +102,8 @@ The amount of time in seconds that a secondary name server (or servers) will hol [host]: #host #### [host] The host defined by a resource record. A value of "@" denotes a wildcard. -Type: **string** +Type: **string** + @@ -107,7 +113,8 @@ The host defined by a resource record. A value of "@" denotes a wildcard. [id]: #id #### [id] A domain resource record's internal identifier. -Type: **integer** +Type: **integer** + @@ -117,7 +124,8 @@ A domain resource record's internal identifier. [minimum]: #minimum #### [minimum] The amount of time in seconds that a domain's resource records are valid. This is also known as a minimum TTL, and can be overridden by an individual resource record's TTL. -Type: **integer** +Type: **integer** + @@ -127,7 +135,8 @@ The amount of time in seconds that a domain's resource records are valid. This i [mxPriority]: #mxpriority #### [mxPriority] Useful in cases where a domain has more than one mail exchanger, the priority property is the priority of the MTA that delivers mail for a domain. A lower number denotes a higher priority, and mail will attempt to deliver through that MTA before moving to lower priority mail servers. Priority is defaulted to 10 upon resource record creation. -Type: **integer** +Type: **integer** + @@ -137,7 +146,8 @@ Useful in cases where a domain has more than one mail exchanger, the priority pr [refresh]: #refresh #### [refresh] The amount of time in seconds that a secondary name server should wait to check for a new copy of a DNS zone from the domain's primary name server. If a zone file has changed then the secondary DNS server will update it's copy of the zone to match the primary DNS server's zone. -Type: **integer** +Type: **integer** + @@ -147,7 +157,8 @@ The amount of time in seconds that a secondary name server should wait to check [responsiblePerson]: #responsibleperson #### [responsiblePerson] The email address of the person responsible for a domain, with the "@" replaced with a ".". For instance, if root@example.org is responsible for example.org, then example.org's SOA responsibility is "root.example.org.". -Type: **string** +Type: **string** + @@ -157,7 +168,8 @@ The email address of the person responsible for a domain, with the "@" replaced [retry]: #retry #### [retry] The amount of time in seconds that a domain's primary name server (or servers) should wait if an attempt to refresh by a secondary name server failed before attempting to refresh a domain's zone with that secondary name server again. -Type: **integer** +Type: **integer** + @@ -167,7 +179,8 @@ The amount of time in seconds that a domain's primary name server (or servers) s [ttl]: #ttl #### [ttl] The Time To Live value of a resource record, measured in seconds. TTL is used by a name server to determine how long to cache a resource record. An SOA record's TTL value defines the domain's overall TTL. -Type: **integer** +Type: **integer** + @@ -177,7 +190,8 @@ The Time To Live value of a resource record, measured in seconds. TTL is used by [type]: #type #### [type] The string "a" which defines a resource record as an A record. -Type: **string** +Type: **string** + @@ -193,7 +207,8 @@ The string "a" which defines a resource record as an A record. [domain]: #domain #### [domain] The domain that a resource record belongs to. -Type: **SoftLayer_Dns_Domain ** +Type: **SoftLayer_Dns_Domain ** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_AaaaType/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_AaaaType/_index.md index d53d59d0ee..f6e6925775 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_AaaaType/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_AaaaType/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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". ### External Links @@ -67,7 +69,8 @@ SoftLayer_Dns_Domain_ResourceRecord_AaaaType is a SoftLayer_Dns_Domain_ResourceR [data]: #data #### [data] The value of a domain's resource record. This can be an IP address or a hostname. Fully qualified host and domain name data must end with the "." character. -Type: **string** +Type: **string** + @@ -77,7 +80,8 @@ The value of a domain's resource record. This can be an IP address or a hostname [domainId]: #domainid #### [domainId] An identifier belonging to the domain that a resource record is associated with. -Type: **integer** +Type: **integer** + @@ -87,7 +91,8 @@ An identifier belonging to the domain that a resource record is associated with. [expire]: #expire #### [expire] The amount of time in seconds that a secondary name server (or servers) will hold a zone before it is no longer considered authoritative. -Type: **integer** +Type: **integer** + @@ -97,7 +102,8 @@ The amount of time in seconds that a secondary name server (or servers) will hol [host]: #host #### [host] The host defined by a resource record. A value of "@" denotes a wildcard. -Type: **string** +Type: **string** + @@ -107,7 +113,8 @@ The host defined by a resource record. A value of "@" denotes a wildcard. [id]: #id #### [id] A domain resource record's internal identifier. -Type: **integer** +Type: **integer** + @@ -117,7 +124,8 @@ A domain resource record's internal identifier. [minimum]: #minimum #### [minimum] The amount of time in seconds that a domain's resource records are valid. This is also known as a minimum TTL, and can be overridden by an individual resource record's TTL. -Type: **integer** +Type: **integer** + @@ -127,7 +135,8 @@ The amount of time in seconds that a domain's resource records are valid. This i [mxPriority]: #mxpriority #### [mxPriority] Useful in cases where a domain has more than one mail exchanger, the priority property is the priority of the MTA that delivers mail for a domain. A lower number denotes a higher priority, and mail will attempt to deliver through that MTA before moving to lower priority mail servers. Priority is defaulted to 10 upon resource record creation. -Type: **integer** +Type: **integer** + @@ -137,7 +146,8 @@ Useful in cases where a domain has more than one mail exchanger, the priority pr [refresh]: #refresh #### [refresh] The amount of time in seconds that a secondary name server should wait to check for a new copy of a DNS zone from the domain's primary name server. If a zone file has changed then the secondary DNS server will update it's copy of the zone to match the primary DNS server's zone. -Type: **integer** +Type: **integer** + @@ -147,7 +157,8 @@ The amount of time in seconds that a secondary name server should wait to check [responsiblePerson]: #responsibleperson #### [responsiblePerson] The email address of the person responsible for a domain, with the "@" replaced with a ".". For instance, if root@example.org is responsible for example.org, then example.org's SOA responsibility is "root.example.org.". -Type: **string** +Type: **string** + @@ -157,7 +168,8 @@ The email address of the person responsible for a domain, with the "@" replaced [retry]: #retry #### [retry] The amount of time in seconds that a domain's primary name server (or servers) should wait if an attempt to refresh by a secondary name server failed before attempting to refresh a domain's zone with that secondary name server again. -Type: **integer** +Type: **integer** + @@ -167,7 +179,8 @@ The amount of time in seconds that a domain's primary name server (or servers) s [ttl]: #ttl #### [ttl] The Time To Live value of a resource record, measured in seconds. TTL is used by a name server to determine how long to cache a resource record. An SOA record's TTL value defines the domain's overall TTL. -Type: **integer** +Type: **integer** + @@ -177,7 +190,8 @@ The Time To Live value of a resource record, measured in seconds. TTL is used by [type]: #type #### [type] The string "aaaa" which defines a resource record as an IPv6 AAAA record. -Type: **string** +Type: **string** + @@ -193,7 +207,8 @@ The string "aaaa" which defines a resource record as an IPv6 AAAA record. [domain]: #domain #### [domain] The domain that a resource record belongs to. -Type: **SoftLayer_Dns_Domain ** +Type: **SoftLayer_Dns_Domain ** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_CnameType/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_CnameType/_index.md index 7d06bb2696..9ab7525a1d 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_CnameType/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_CnameType/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -66,7 +68,8 @@ DNS entries defined by CNAME should not be used as the data field for an MX reco [data]: #data #### [data] The value of a domain's resource record. This can be an IP address or a hostname. Fully qualified host and domain name data must end with the "." character. -Type: **string** +Type: **string** + @@ -76,7 +79,8 @@ The value of a domain's resource record. This can be an IP address or a hostname [domainId]: #domainid #### [domainId] An identifier belonging to the domain that a resource record is associated with. -Type: **integer** +Type: **integer** + @@ -86,7 +90,8 @@ An identifier belonging to the domain that a resource record is associated with. [expire]: #expire #### [expire] The amount of time in seconds that a secondary name server (or servers) will hold a zone before it is no longer considered authoritative. -Type: **integer** +Type: **integer** + @@ -96,7 +101,8 @@ The amount of time in seconds that a secondary name server (or servers) will hol [host]: #host #### [host] The host defined by a resource record. A value of "@" denotes a wildcard. -Type: **string** +Type: **string** + @@ -106,7 +112,8 @@ The host defined by a resource record. A value of "@" denotes a wildcard. [id]: #id #### [id] A domain resource record's internal identifier. -Type: **integer** +Type: **integer** + @@ -116,7 +123,8 @@ A domain resource record's internal identifier. [minimum]: #minimum #### [minimum] The amount of time in seconds that a domain's resource records are valid. This is also known as a minimum TTL, and can be overridden by an individual resource record's TTL. -Type: **integer** +Type: **integer** + @@ -126,7 +134,8 @@ The amount of time in seconds that a domain's resource records are valid. This i [mxPriority]: #mxpriority #### [mxPriority] Useful in cases where a domain has more than one mail exchanger, the priority property is the priority of the MTA that delivers mail for a domain. A lower number denotes a higher priority, and mail will attempt to deliver through that MTA before moving to lower priority mail servers. Priority is defaulted to 10 upon resource record creation. -Type: **integer** +Type: **integer** + @@ -136,7 +145,8 @@ Useful in cases where a domain has more than one mail exchanger, the priority pr [refresh]: #refresh #### [refresh] The amount of time in seconds that a secondary name server should wait to check for a new copy of a DNS zone from the domain's primary name server. If a zone file has changed then the secondary DNS server will update it's copy of the zone to match the primary DNS server's zone. -Type: **integer** +Type: **integer** + @@ -146,7 +156,8 @@ The amount of time in seconds that a secondary name server should wait to check [responsiblePerson]: #responsibleperson #### [responsiblePerson] The email address of the person responsible for a domain, with the "@" replaced with a ".". For instance, if root@example.org is responsible for example.org, then example.org's SOA responsibility is "root.example.org.". -Type: **string** +Type: **string** + @@ -156,7 +167,8 @@ The email address of the person responsible for a domain, with the "@" replaced [retry]: #retry #### [retry] The amount of time in seconds that a domain's primary name server (or servers) should wait if an attempt to refresh by a secondary name server failed before attempting to refresh a domain's zone with that secondary name server again. -Type: **integer** +Type: **integer** + @@ -166,7 +178,8 @@ The amount of time in seconds that a domain's primary name server (or servers) s [ttl]: #ttl #### [ttl] The Time To Live value of a resource record, measured in seconds. TTL is used by a name server to determine how long to cache a resource record. An SOA record's TTL value defines the domain's overall TTL. -Type: **integer** +Type: **integer** + @@ -176,7 +189,8 @@ The Time To Live value of a resource record, measured in seconds. TTL is used by [type]: #type #### [type] The string "cname" which defines a resource record as an CNAME record. -Type: **string** +Type: **string** + @@ -192,7 +206,8 @@ The string "cname" which defines a resource record as an CNAME record. [domain]: #domain #### [domain] The domain that a resource record belongs to. -Type: **SoftLayer_Dns_Domain ** +Type: **SoftLayer_Dns_Domain ** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_MxType/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_MxType/_index.md index 306925ee81..b1fa03d180 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_MxType/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_MxType/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -69,7 +71,8 @@ MX records must be defined for hosts with accompanying A or AAAA resource record [data]: #data #### [data] The value of a domain's resource record. This can be an IP address or a hostname. Fully qualified host and domain name data must end with the "." character. -Type: **string** +Type: **string** + @@ -79,7 +82,8 @@ The value of a domain's resource record. This can be an IP address or a hostname [domainId]: #domainid #### [domainId] An identifier belonging to the domain that a resource record is associated with. -Type: **integer** +Type: **integer** + @@ -89,7 +93,8 @@ An identifier belonging to the domain that a resource record is associated with. [expire]: #expire #### [expire] The amount of time in seconds that a secondary name server (or servers) will hold a zone before it is no longer considered authoritative. -Type: **integer** +Type: **integer** + @@ -99,7 +104,8 @@ The amount of time in seconds that a secondary name server (or servers) will hol [host]: #host #### [host] The host defined by a resource record. A value of "@" denotes a wildcard. -Type: **string** +Type: **string** + @@ -109,7 +115,8 @@ The host defined by a resource record. A value of "@" denotes a wildcard. [id]: #id #### [id] A domain resource record's internal identifier. -Type: **integer** +Type: **integer** + @@ -119,7 +126,8 @@ A domain resource record's internal identifier. [minimum]: #minimum #### [minimum] The amount of time in seconds that a domain's resource records are valid. This is also known as a minimum TTL, and can be overridden by an individual resource record's TTL. -Type: **integer** +Type: **integer** + @@ -129,7 +137,8 @@ The amount of time in seconds that a domain's resource records are valid. This i [mxPriority]: #mxpriority #### [mxPriority] Useful in cases where a domain has more than one mail exchanger, the priority property is the priority of the MTA that delivers mail for a domain. A lower number denotes a higher priority, and mail will attempt to deliver through that MTA before moving to lower priority mail servers. Priority is defaulted to 10 upon resource record creation. -Type: **integer** +Type: **integer** + @@ -139,7 +148,8 @@ Useful in cases where a domain has more than one mail exchanger, the priority pr [refresh]: #refresh #### [refresh] The amount of time in seconds that a secondary name server should wait to check for a new copy of a DNS zone from the domain's primary name server. If a zone file has changed then the secondary DNS server will update it's copy of the zone to match the primary DNS server's zone. -Type: **integer** +Type: **integer** + @@ -149,7 +159,8 @@ The amount of time in seconds that a secondary name server should wait to check [responsiblePerson]: #responsibleperson #### [responsiblePerson] The email address of the person responsible for a domain, with the "@" replaced with a ".". For instance, if root@example.org is responsible for example.org, then example.org's SOA responsibility is "root.example.org.". -Type: **string** +Type: **string** + @@ -159,7 +170,8 @@ The email address of the person responsible for a domain, with the "@" replaced [retry]: #retry #### [retry] The amount of time in seconds that a domain's primary name server (or servers) should wait if an attempt to refresh by a secondary name server failed before attempting to refresh a domain's zone with that secondary name server again. -Type: **integer** +Type: **integer** + @@ -169,7 +181,8 @@ The amount of time in seconds that a domain's primary name server (or servers) s [ttl]: #ttl #### [ttl] The Time To Live value of a resource record, measured in seconds. TTL is used by a name server to determine how long to cache a resource record. An SOA record's TTL value defines the domain's overall TTL. -Type: **integer** +Type: **integer** + @@ -179,7 +192,8 @@ The Time To Live value of a resource record, measured in seconds. TTL is used by [type]: #type #### [type] The string "mx" which defines a resource record as an MX record. -Type: **string** +Type: **string** + @@ -195,7 +209,8 @@ The string "mx" which defines a resource record as an MX record. [domain]: #domain #### [domain] The domain that a resource record belongs to. -Type: **SoftLayer_Dns_Domain ** +Type: **SoftLayer_Dns_Domain ** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_NsType/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_NsType/_index.md index 1649b19a02..d1137db704 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_NsType/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_NsType/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -66,7 +68,8 @@ NS resource records pointing to ns1.softlayer.com or ns2.softlayer.com many not [data]: #data #### [data] The value of a domain's resource record. This can be an IP address or a hostname. Fully qualified host and domain name data must end with the "." character. -Type: **string** +Type: **string** + @@ -76,7 +79,8 @@ The value of a domain's resource record. This can be an IP address or a hostname [domainId]: #domainid #### [domainId] An identifier belonging to the domain that a resource record is associated with. -Type: **integer** +Type: **integer** + @@ -86,7 +90,8 @@ An identifier belonging to the domain that a resource record is associated with. [expire]: #expire #### [expire] The amount of time in seconds that a secondary name server (or servers) will hold a zone before it is no longer considered authoritative. -Type: **integer** +Type: **integer** + @@ -96,7 +101,8 @@ The amount of time in seconds that a secondary name server (or servers) will hol [host]: #host #### [host] The host defined by a resource record. A value of "@" denotes a wildcard. -Type: **string** +Type: **string** + @@ -106,7 +112,8 @@ The host defined by a resource record. A value of "@" denotes a wildcard. [id]: #id #### [id] A domain resource record's internal identifier. -Type: **integer** +Type: **integer** + @@ -116,7 +123,8 @@ A domain resource record's internal identifier. [minimum]: #minimum #### [minimum] The amount of time in seconds that a domain's resource records are valid. This is also known as a minimum TTL, and can be overridden by an individual resource record's TTL. -Type: **integer** +Type: **integer** + @@ -126,7 +134,8 @@ The amount of time in seconds that a domain's resource records are valid. This i [mxPriority]: #mxpriority #### [mxPriority] Useful in cases where a domain has more than one mail exchanger, the priority property is the priority of the MTA that delivers mail for a domain. A lower number denotes a higher priority, and mail will attempt to deliver through that MTA before moving to lower priority mail servers. Priority is defaulted to 10 upon resource record creation. -Type: **integer** +Type: **integer** + @@ -136,7 +145,8 @@ Useful in cases where a domain has more than one mail exchanger, the priority pr [refresh]: #refresh #### [refresh] The amount of time in seconds that a secondary name server should wait to check for a new copy of a DNS zone from the domain's primary name server. If a zone file has changed then the secondary DNS server will update it's copy of the zone to match the primary DNS server's zone. -Type: **integer** +Type: **integer** + @@ -146,7 +156,8 @@ The amount of time in seconds that a secondary name server should wait to check [responsiblePerson]: #responsibleperson #### [responsiblePerson] The email address of the person responsible for a domain, with the "@" replaced with a ".". For instance, if root@example.org is responsible for example.org, then example.org's SOA responsibility is "root.example.org.". -Type: **string** +Type: **string** + @@ -156,7 +167,8 @@ The email address of the person responsible for a domain, with the "@" replaced [retry]: #retry #### [retry] The amount of time in seconds that a domain's primary name server (or servers) should wait if an attempt to refresh by a secondary name server failed before attempting to refresh a domain's zone with that secondary name server again. -Type: **integer** +Type: **integer** + @@ -166,7 +178,8 @@ The amount of time in seconds that a domain's primary name server (or servers) s [ttl]: #ttl #### [ttl] The Time To Live value of a resource record, measured in seconds. TTL is used by a name server to determine how long to cache a resource record. An SOA record's TTL value defines the domain's overall TTL. -Type: **integer** +Type: **integer** + @@ -176,7 +189,8 @@ The Time To Live value of a resource record, measured in seconds. TTL is used by [type]: #type #### [type] The string "ns" which defines a resource record as an NS record. -Type: **string** +Type: **string** + @@ -192,7 +206,8 @@ The string "ns" which defines a resource record as an NS record. [domain]: #domain #### [domain] The domain that a resource record belongs to. -Type: **SoftLayer_Dns_Domain ** +Type: **SoftLayer_Dns_Domain ** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_PtrType/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_PtrType/_index.md index 3240a626cd..df5b702c16 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_PtrType/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_PtrType/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -77,7 +79,8 @@ PTR record host names may not be changed by [SoftLayer_Dns_Domain_ResourceRecord [data]: #data #### [data] The value of a domain's resource record. This can be an IP address or a hostname. Fully qualified host and domain name data must end with the "." character. -Type: **string** +Type: **string** + @@ -87,7 +90,8 @@ The value of a domain's resource record. This can be an IP address or a hostname [domainId]: #domainid #### [domainId] An identifier belonging to the domain that a resource record is associated with. -Type: **integer** +Type: **integer** + @@ -97,7 +101,8 @@ An identifier belonging to the domain that a resource record is associated with. [expire]: #expire #### [expire] The amount of time in seconds that a secondary name server (or servers) will hold a zone before it is no longer considered authoritative. -Type: **integer** +Type: **integer** + @@ -107,7 +112,8 @@ The amount of time in seconds that a secondary name server (or servers) will hol [host]: #host #### [host] The host defined by a resource record. A value of "@" denotes a wildcard. -Type: **string** +Type: **string** + @@ -117,7 +123,8 @@ The host defined by a resource record. A value of "@" denotes a wildcard. [id]: #id #### [id] A domain resource record's internal identifier. -Type: **integer** +Type: **integer** + @@ -127,7 +134,8 @@ A domain resource record's internal identifier. [isGatewayAddress]: #isgatewayaddress #### [isGatewayAddress] Whether the address associated with a PTR record is the gateway address of a subnet. -Type: **boolean** +Type: **boolean** + @@ -137,7 +145,8 @@ Whether the address associated with a PTR record is the gateway address of a sub [minimum]: #minimum #### [minimum] The amount of time in seconds that a domain's resource records are valid. This is also known as a minimum TTL, and can be overridden by an individual resource record's TTL. -Type: **integer** +Type: **integer** + @@ -147,7 +156,8 @@ The amount of time in seconds that a domain's resource records are valid. This i [mxPriority]: #mxpriority #### [mxPriority] Useful in cases where a domain has more than one mail exchanger, the priority property is the priority of the MTA that delivers mail for a domain. A lower number denotes a higher priority, and mail will attempt to deliver through that MTA before moving to lower priority mail servers. Priority is defaulted to 10 upon resource record creation. -Type: **integer** +Type: **integer** + @@ -157,7 +167,8 @@ Useful in cases where a domain has more than one mail exchanger, the priority pr [refresh]: #refresh #### [refresh] The amount of time in seconds that a secondary name server should wait to check for a new copy of a DNS zone from the domain's primary name server. If a zone file has changed then the secondary DNS server will update it's copy of the zone to match the primary DNS server's zone. -Type: **integer** +Type: **integer** + @@ -167,7 +178,8 @@ The amount of time in seconds that a secondary name server should wait to check [responsiblePerson]: #responsibleperson #### [responsiblePerson] The email address of the person responsible for a domain, with the "@" replaced with a ".". For instance, if root@example.org is responsible for example.org, then example.org's SOA responsibility is "root.example.org.". -Type: **string** +Type: **string** + @@ -177,7 +189,8 @@ The email address of the person responsible for a domain, with the "@" replaced [retry]: #retry #### [retry] The amount of time in seconds that a domain's primary name server (or servers) should wait if an attempt to refresh by a secondary name server failed before attempting to refresh a domain's zone with that secondary name server again. -Type: **integer** +Type: **integer** + @@ -187,7 +200,8 @@ The amount of time in seconds that a domain's primary name server (or servers) s [ttl]: #ttl #### [ttl] The Time To Live value of a resource record, measured in seconds. TTL is used by a name server to determine how long to cache a resource record. An SOA record's TTL value defines the domain's overall TTL. -Type: **integer** +Type: **integer** + @@ -197,7 +211,8 @@ The Time To Live value of a resource record, measured in seconds. TTL is used by [type]: #type #### [type] The string "ptr" which defines a resource record as a PTR record. -Type: **string** +Type: **string** + @@ -213,7 +228,8 @@ The string "ptr" which defines a resource record as a PTR record. [domain]: #domain #### [domain] The domain that a resource record belongs to. -Type: **SoftLayer_Dns_Domain ** +Type: **SoftLayer_Dns_Domain ** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_SoaType/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_SoaType/_index.md index 2307c2c95a..1173fbab5e 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_SoaType/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_SoaType/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -55,7 +57,8 @@ SOA records typically contain a domain's serial number, but the SoftLayer API as [domainId]: #domainid #### [domainId] An identifier belonging to the domain that a resource record is associated with. -Type: **integer** +Type: **integer** + @@ -65,7 +68,8 @@ An identifier belonging to the domain that a resource record is associated with. [expire]: #expire #### [expire] The amount of time in seconds that a secondary name server (or servers) will hold a zone before it is no longer considered authoritative. -Type: **integer** +Type: **integer** + @@ -75,7 +79,8 @@ The amount of time in seconds that a secondary name server (or servers) will hol [id]: #id #### [id] A domain resource record's internal identifier. -Type: **integer** +Type: **integer** + @@ -85,7 +90,8 @@ A domain resource record's internal identifier. [minimum]: #minimum #### [minimum] The amount of time in seconds that a domain's resource records are valid. This is also known as a minimum TTL, and can be overridden by an individual resource record's TTL. -Type: **integer** +Type: **integer** + @@ -95,7 +101,8 @@ The amount of time in seconds that a domain's resource records are valid. This i [mxPriority]: #mxpriority #### [mxPriority] Useful in cases where a domain has more than one mail exchanger, the priority property is the priority of the MTA that delivers mail for a domain. A lower number denotes a higher priority, and mail will attempt to deliver through that MTA before moving to lower priority mail servers. Priority is defaulted to 10 upon resource record creation. -Type: **integer** +Type: **integer** + @@ -105,7 +112,8 @@ Useful in cases where a domain has more than one mail exchanger, the priority pr [refresh]: #refresh #### [refresh] The amount of time in seconds that a secondary name server should wait to check for a new copy of a DNS zone from the domain's primary name server. If a zone file has changed then the secondary DNS server will update it's copy of the zone to match the primary DNS server's zone. -Type: **integer** +Type: **integer** + @@ -115,7 +123,8 @@ The amount of time in seconds that a secondary name server should wait to check [responsiblePerson]: #responsibleperson #### [responsiblePerson] The email address of the person responsible for a domain, with the "@" replaced with a ".". For instance, if root@example.org is responsible for example.org, then example.org's SOA responsibility is "root.example.org.". -Type: **string** +Type: **string** + @@ -125,7 +134,8 @@ The email address of the person responsible for a domain, with the "@" replaced [retry]: #retry #### [retry] The amount of time in seconds that a domain's primary name server (or servers) should wait if an attempt to refresh by a secondary name server failed before attempting to refresh a domain's zone with that secondary name server again. -Type: **integer** +Type: **integer** + @@ -135,7 +145,8 @@ The amount of time in seconds that a domain's primary name server (or servers) s [ttl]: #ttl #### [ttl] The Time To Live value of a resource record, measured in seconds. TTL is used by a name server to determine how long to cache a resource record. An SOA record's TTL value defines the domain's overall TTL. -Type: **integer** +Type: **integer** + @@ -145,7 +156,8 @@ The Time To Live value of a resource record, measured in seconds. TTL is used by [type]: #type #### [type] The string "soa" which defines a resource record as an SOA record. -Type: **string** +Type: **string** + @@ -161,7 +173,8 @@ The string "soa" which defines a resource record as an SOA record. [domain]: #domain #### [domain] The domain that a resource record belongs to. -Type: **SoftLayer_Dns_Domain ** +Type: **SoftLayer_Dns_Domain ** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_SpfType/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_SpfType/_index.md index e3c562075e..747fffa2ca 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_SpfType/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_SpfType/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -69,7 +71,8 @@ SPF records are commonly used in email verification methods such as Sender Polic [data]: #data #### [data] The value of a domain's resource record. This can be an IP address or a hostname. Fully qualified host and domain name data must end with the "." character. -Type: **string** +Type: **string** + @@ -79,7 +82,8 @@ The value of a domain's resource record. This can be an IP address or a hostname [domainId]: #domainid #### [domainId] An identifier belonging to the domain that a resource record is associated with. -Type: **integer** +Type: **integer** + @@ -89,7 +93,8 @@ An identifier belonging to the domain that a resource record is associated with. [expire]: #expire #### [expire] The amount of time in seconds that a secondary name server (or servers) will hold a zone before it is no longer considered authoritative. -Type: **integer** +Type: **integer** + @@ -99,7 +104,8 @@ The amount of time in seconds that a secondary name server (or servers) will hol [host]: #host #### [host] The host defined by a resource record. A value of "@" denotes a wildcard. -Type: **string** +Type: **string** + @@ -109,7 +115,8 @@ The host defined by a resource record. A value of "@" denotes a wildcard. [id]: #id #### [id] A domain resource record's internal identifier. -Type: **integer** +Type: **integer** + @@ -119,7 +126,8 @@ A domain resource record's internal identifier. [minimum]: #minimum #### [minimum] The amount of time in seconds that a domain's resource records are valid. This is also known as a minimum TTL, and can be overridden by an individual resource record's TTL. -Type: **integer** +Type: **integer** + @@ -129,7 +137,8 @@ The amount of time in seconds that a domain's resource records are valid. This i [mxPriority]: #mxpriority #### [mxPriority] Useful in cases where a domain has more than one mail exchanger, the priority property is the priority of the MTA that delivers mail for a domain. A lower number denotes a higher priority, and mail will attempt to deliver through that MTA before moving to lower priority mail servers. Priority is defaulted to 10 upon resource record creation. -Type: **integer** +Type: **integer** + @@ -139,7 +148,8 @@ Useful in cases where a domain has more than one mail exchanger, the priority pr [refresh]: #refresh #### [refresh] The amount of time in seconds that a secondary name server should wait to check for a new copy of a DNS zone from the domain's primary name server. If a zone file has changed then the secondary DNS server will update it's copy of the zone to match the primary DNS server's zone. -Type: **integer** +Type: **integer** + @@ -149,7 +159,8 @@ The amount of time in seconds that a secondary name server should wait to check [responsiblePerson]: #responsibleperson #### [responsiblePerson] The email address of the person responsible for a domain, with the "@" replaced with a ".". For instance, if root@example.org is responsible for example.org, then example.org's SOA responsibility is "root.example.org.". -Type: **string** +Type: **string** + @@ -159,7 +170,8 @@ The email address of the person responsible for a domain, with the "@" replaced [retry]: #retry #### [retry] The amount of time in seconds that a domain's primary name server (or servers) should wait if an attempt to refresh by a secondary name server failed before attempting to refresh a domain's zone with that secondary name server again. -Type: **integer** +Type: **integer** + @@ -169,7 +181,8 @@ The amount of time in seconds that a domain's primary name server (or servers) s [ttl]: #ttl #### [ttl] The Time To Live value of a resource record, measured in seconds. TTL is used by a name server to determine how long to cache a resource record. An SOA record's TTL value defines the domain's overall TTL. -Type: **integer** +Type: **integer** + @@ -179,7 +192,8 @@ The Time To Live value of a resource record, measured in seconds. TTL is used by [type]: #type #### [type] The string "spf" which defines a resource record as an SPF record. -Type: **string** +Type: **string** + @@ -195,7 +209,8 @@ The string "spf" which defines a resource record as an SPF record. [domain]: #domain #### [domain] The domain that a resource record belongs to. -Type: **SoftLayer_Dns_Domain ** +Type: **SoftLayer_Dns_Domain ** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_SrvType/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_SrvType/_index.md index 3ab26d955e..83d90f9db0 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_SrvType/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_SrvType/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -64,7 +66,8 @@ SoftLayer_Dns_Domain_ResourceRecord_SrvType is a SoftLayer_Dns_Domain_ResourceRe [data]: #data #### [data] The value of a domain's resource record. This can be an IP address or a hostname. Fully qualified host and domain name data must end with the "." character. -Type: **string** +Type: **string** + @@ -74,7 +77,8 @@ The value of a domain's resource record. This can be an IP address or a hostname [domainId]: #domainid #### [domainId] An identifier belonging to the domain that a resource record is associated with. -Type: **integer** +Type: **integer** + @@ -84,7 +88,8 @@ An identifier belonging to the domain that a resource record is associated with. [expire]: #expire #### [expire] The amount of time in seconds that a secondary name server (or servers) will hold a zone before it is no longer considered authoritative. -Type: **integer** +Type: **integer** + @@ -94,7 +99,8 @@ The amount of time in seconds that a secondary name server (or servers) will hol [host]: #host #### [host] The host defined by a resource record. A value of "@" denotes a wildcard. -Type: **string** +Type: **string** + @@ -104,7 +110,8 @@ The host defined by a resource record. A value of "@" denotes a wildcard. [id]: #id #### [id] A domain resource record's internal identifier. -Type: **integer** +Type: **integer** + @@ -114,7 +121,8 @@ A domain resource record's internal identifier. [minimum]: #minimum #### [minimum] The amount of time in seconds that a domain's resource records are valid. This is also known as a minimum TTL, and can be overridden by an individual resource record's TTL. -Type: **integer** +Type: **integer** + @@ -124,7 +132,8 @@ The amount of time in seconds that a domain's resource records are valid. This i [mxPriority]: #mxpriority #### [mxPriority] Useful in cases where a domain has more than one mail exchanger, the priority property is the priority of the MTA that delivers mail for a domain. A lower number denotes a higher priority, and mail will attempt to deliver through that MTA before moving to lower priority mail servers. Priority is defaulted to 10 upon resource record creation. -Type: **integer** +Type: **integer** + @@ -134,7 +143,8 @@ Useful in cases where a domain has more than one mail exchanger, the priority pr [port]: #port #### [port] The TCP or UDP port on which the service is to be found. -Type: **integer** +Type: **integer** + @@ -144,7 +154,8 @@ The TCP or UDP port on which the service is to be found. [priority]: #priority #### [priority] The priority of the target host, lower value means more preferred. -Type: **integer** +Type: **integer** + @@ -154,7 +165,8 @@ The priority of the target host, lower value means more preferred. [protocol]: #protocol #### [protocol] The protocol of the desired service; this is usually either TCP or UDP. -Type: **string** +Type: **string** + @@ -164,7 +176,8 @@ The protocol of the desired service; this is usually either TCP or UDP. [refresh]: #refresh #### [refresh] The amount of time in seconds that a secondary name server should wait to check for a new copy of a DNS zone from the domain's primary name server. If a zone file has changed then the secondary DNS server will update it's copy of the zone to match the primary DNS server's zone. -Type: **integer** +Type: **integer** + @@ -174,7 +187,8 @@ The amount of time in seconds that a secondary name server should wait to check [responsiblePerson]: #responsibleperson #### [responsiblePerson] The email address of the person responsible for a domain, with the "@" replaced with a ".". For instance, if root@example.org is responsible for example.org, then example.org's SOA responsibility is "root.example.org.". -Type: **string** +Type: **string** + @@ -184,7 +198,8 @@ The email address of the person responsible for a domain, with the "@" replaced [retry]: #retry #### [retry] The amount of time in seconds that a domain's primary name server (or servers) should wait if an attempt to refresh by a secondary name server failed before attempting to refresh a domain's zone with that secondary name server again. -Type: **integer** +Type: **integer** + @@ -194,7 +209,8 @@ The amount of time in seconds that a domain's primary name server (or servers) s [service]: #service #### [service] The symbolic name of the desired service -Type: **string** +Type: **string** + @@ -204,7 +220,8 @@ The symbolic name of the desired service [ttl]: #ttl #### [ttl] The Time To Live value of a resource record, measured in seconds. TTL is used by a name server to determine how long to cache a resource record. An SOA record's TTL value defines the domain's overall TTL. -Type: **integer** +Type: **integer** + @@ -214,7 +231,8 @@ The Time To Live value of a resource record, measured in seconds. TTL is used by [type]: #type #### [type] The string "srv" which defines a resource record as an SRV record. -Type: **string** +Type: **string** + @@ -224,7 +242,8 @@ The string "srv" which defines a resource record as an SRV record. [weight]: #weight #### [weight] A relative weight for records with the same priority. -Type: **integer** +Type: **integer** + @@ -240,7 +259,8 @@ A relative weight for records with the same priority. [domain]: #domain #### [domain] The domain that a resource record belongs to. -Type: **SoftLayer_Dns_Domain ** +Type: **SoftLayer_Dns_Domain ** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_TxtType/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_TxtType/_index.md index 2987cd51cb..775cf2458a 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_TxtType/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_TxtType/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -69,7 +71,8 @@ TXT records are commonly used in email verification methods such as Sender Polic [data]: #data #### [data] The value of a domain's resource record. This can be an IP address or a hostname. Fully qualified host and domain name data must end with the "." character. -Type: **string** +Type: **string** + @@ -79,7 +82,8 @@ The value of a domain's resource record. This can be an IP address or a hostname [domainId]: #domainid #### [domainId] An identifier belonging to the domain that a resource record is associated with. -Type: **integer** +Type: **integer** + @@ -89,7 +93,8 @@ An identifier belonging to the domain that a resource record is associated with. [expire]: #expire #### [expire] The amount of time in seconds that a secondary name server (or servers) will hold a zone before it is no longer considered authoritative. -Type: **integer** +Type: **integer** + @@ -99,7 +104,8 @@ The amount of time in seconds that a secondary name server (or servers) will hol [host]: #host #### [host] The host defined by a resource record. A value of "@" denotes a wildcard. -Type: **string** +Type: **string** + @@ -109,7 +115,8 @@ The host defined by a resource record. A value of "@" denotes a wildcard. [id]: #id #### [id] A domain resource record's internal identifier. -Type: **integer** +Type: **integer** + @@ -119,7 +126,8 @@ A domain resource record's internal identifier. [minimum]: #minimum #### [minimum] The amount of time in seconds that a domain's resource records are valid. This is also known as a minimum TTL, and can be overridden by an individual resource record's TTL. -Type: **integer** +Type: **integer** + @@ -129,7 +137,8 @@ The amount of time in seconds that a domain's resource records are valid. This i [mxPriority]: #mxpriority #### [mxPriority] Useful in cases where a domain has more than one mail exchanger, the priority property is the priority of the MTA that delivers mail for a domain. A lower number denotes a higher priority, and mail will attempt to deliver through that MTA before moving to lower priority mail servers. Priority is defaulted to 10 upon resource record creation. -Type: **integer** +Type: **integer** + @@ -139,7 +148,8 @@ Useful in cases where a domain has more than one mail exchanger, the priority pr [refresh]: #refresh #### [refresh] The amount of time in seconds that a secondary name server should wait to check for a new copy of a DNS zone from the domain's primary name server. If a zone file has changed then the secondary DNS server will update it's copy of the zone to match the primary DNS server's zone. -Type: **integer** +Type: **integer** + @@ -149,7 +159,8 @@ The amount of time in seconds that a secondary name server should wait to check [responsiblePerson]: #responsibleperson #### [responsiblePerson] The email address of the person responsible for a domain, with the "@" replaced with a ".". For instance, if root@example.org is responsible for example.org, then example.org's SOA responsibility is "root.example.org.". -Type: **string** +Type: **string** + @@ -159,7 +170,8 @@ The email address of the person responsible for a domain, with the "@" replaced [retry]: #retry #### [retry] The amount of time in seconds that a domain's primary name server (or servers) should wait if an attempt to refresh by a secondary name server failed before attempting to refresh a domain's zone with that secondary name server again. -Type: **integer** +Type: **integer** + @@ -169,7 +181,8 @@ The amount of time in seconds that a domain's primary name server (or servers) s [ttl]: #ttl #### [ttl] The Time To Live value of a resource record, measured in seconds. TTL is used by a name server to determine how long to cache a resource record. An SOA record's TTL value defines the domain's overall TTL. -Type: **integer** +Type: **integer** + @@ -179,7 +192,8 @@ The Time To Live value of a resource record, measured in seconds. TTL is used by [type]: #type #### [type] The string "txt" which defines a resource record as a TXT record. -Type: **string** +Type: **string** + @@ -195,7 +209,8 @@ The string "txt" which defines a resource record as a TXT record. [domain]: #domain #### [domain] The domain that a resource record belongs to. -Type: **SoftLayer_Dns_Domain ** +Type: **SoftLayer_Dns_Domain ** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_Reverse/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain_Reverse/_index.md index 73063ebe6f..d916ca878c 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_Reverse/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain_Reverse/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Dns_Domain_Reverse data type represents a reverse IP address record. ### External Links @@ -69,7 +71,8 @@ The SoftLayer_Dns_Domain_Reverse data type represents a reverse IP address recor [id]: #id #### [id] A domain record's internal identifier. -Type: **integer** +Type: **integer** + @@ -79,7 +82,8 @@ A domain record's internal identifier. [name]: #name #### [name] A domain's name including top-level domain, for example "example.com". -Type: **string** +Type: **string** + @@ -89,7 +93,8 @@ A domain's name including top-level domain, for example "example.com". [networkAddress]: #networkaddress #### [networkAddress] Network address the domain is associated with. -Type: **string** +Type: **string** + @@ -99,7 +104,8 @@ Network address the domain is associated with. [serial]: #serial #### [serial] A unique number denoting the latest revision of a domain. Whenever a domain is changed its corresponding serial number is also changed. Serial numbers typically follow the format yyyymmdd## where yyyy is the current year, mm is the current month, dd is the current day of the month, and ## is the number of the revision for that day. A domain's serial number is automatically updated when edited via the API. -Type: **integer** +Type: **integer** + @@ -109,7 +115,8 @@ A unique number denoting the latest revision of a domain. Whenever a domain is c [updateDate]: #updatedate #### [updateDate] The date that this domain record was last updated. -Type: **dateTime** +Type: **dateTime** + @@ -125,7 +132,8 @@ The date that this domain record was last updated. [account]: #account #### [account] The SoftLayer customer account that owns a domain. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -135,7 +143,8 @@ The SoftLayer customer account that owns a domain. [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the dns domain record is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -145,7 +154,8 @@ A flag indicating that the dns domain record is a managed resource. [resourceRecords]: #resourcerecords #### [resourceRecords] The pointer type records for a reverse domain. -Type: **SoftLayer_Dns_Domain_ResourceRecord[] ** +Type: **SoftLayer_Dns_Domain_ResourceRecord[] ** + @@ -155,7 +165,8 @@ The pointer type records for a reverse domain. [secondary]: #secondary #### [secondary] The secondary DNS record that defines this domain as being managed through zone transfers. -Type: **SoftLayer_Dns_Secondary ** +Type: **SoftLayer_Dns_Secondary ** + @@ -165,7 +176,8 @@ The secondary DNS record that defines this domain as being managed through zone [soaResourceRecord]: #soaresourcerecord #### [soaResourceRecord] The start of authority (SOA) record contains authoritative and propagation details for a DNS zone. This property is not considered in requests to createObject and editObject. -Type: **SoftLayer_Dns_Domain_ResourceRecord_SoaType ** +Type: **SoftLayer_Dns_Domain_ResourceRecord_SoaType ** + @@ -177,7 +189,8 @@ The start of authority (SOA) record contains authoritative and propagation detai [resourceRecordCount]: #resourcerecordcount #### [resourceRecordCount] A count of the pointer type records for a reverse domain. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_Reverse_Version4/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain_Reverse_Version4/_index.md index 30189995cb..bc896a5020 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_Reverse_Version4/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain_Reverse_Version4/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Dns_Domain_Reverse_Version4 data type represents a reverse IPv4 address record. ### External Links @@ -69,7 +71,8 @@ The SoftLayer_Dns_Domain_Reverse_Version4 data type represents a reverse IPv4 ad [id]: #id #### [id] A domain record's internal identifier. -Type: **integer** +Type: **integer** + @@ -79,7 +82,8 @@ A domain record's internal identifier. [name]: #name #### [name] A domain's name including top-level domain, for example "example.com". -Type: **string** +Type: **string** + @@ -89,7 +93,8 @@ A domain's name including top-level domain, for example "example.com". [networkAddress]: #networkaddress #### [networkAddress] Network address the domain is associated with. -Type: **string** +Type: **string** + @@ -99,7 +104,8 @@ Network address the domain is associated with. [serial]: #serial #### [serial] A unique number denoting the latest revision of a domain. Whenever a domain is changed its corresponding serial number is also changed. Serial numbers typically follow the format yyyymmdd## where yyyy is the current year, mm is the current month, dd is the current day of the month, and ## is the number of the revision for that day. A domain's serial number is automatically updated when edited via the API. -Type: **integer** +Type: **integer** + @@ -109,7 +115,8 @@ A unique number denoting the latest revision of a domain. Whenever a domain is c [updateDate]: #updatedate #### [updateDate] The date that this domain record was last updated. -Type: **dateTime** +Type: **dateTime** + @@ -125,7 +132,8 @@ The date that this domain record was last updated. [account]: #account #### [account] The SoftLayer customer account that owns a domain. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -135,7 +143,8 @@ The SoftLayer customer account that owns a domain. [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the dns domain record is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -145,7 +154,8 @@ A flag indicating that the dns domain record is a managed resource. [resourceRecords]: #resourcerecords #### [resourceRecords] The pointer type records for a reverse domain. -Type: **SoftLayer_Dns_Domain_ResourceRecord[] ** +Type: **SoftLayer_Dns_Domain_ResourceRecord[] ** + @@ -155,7 +165,8 @@ The pointer type records for a reverse domain. [secondary]: #secondary #### [secondary] The secondary DNS record that defines this domain as being managed through zone transfers. -Type: **SoftLayer_Dns_Secondary ** +Type: **SoftLayer_Dns_Secondary ** + @@ -165,7 +176,8 @@ The secondary DNS record that defines this domain as being managed through zone [soaResourceRecord]: #soaresourcerecord #### [soaResourceRecord] The start of authority (SOA) record contains authoritative and propagation details for a DNS zone. This property is not considered in requests to createObject and editObject. -Type: **SoftLayer_Dns_Domain_ResourceRecord_SoaType ** +Type: **SoftLayer_Dns_Domain_ResourceRecord_SoaType ** + @@ -177,7 +189,8 @@ The start of authority (SOA) record contains authoritative and propagation detai [resourceRecordCount]: #resourcerecordcount #### [resourceRecordCount] A count of the pointer type records for a reverse domain. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Domain_Reverse_Version6/_index.md b/content/reference/datatypes/SoftLayer_Dns_Domain_Reverse_Version6/_index.md index e55958bd4f..9422f96af0 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Domain_Reverse_Version6/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Domain_Reverse_Version6/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Dns_Domain_Reverse_Version6 data type represents a reverse IPv6 address record. ### External Links @@ -69,7 +71,8 @@ The SoftLayer_Dns_Domain_Reverse_Version6 data type represents a reverse IPv6 ad [id]: #id #### [id] A domain record's internal identifier. -Type: **integer** +Type: **integer** + @@ -79,7 +82,8 @@ A domain record's internal identifier. [name]: #name #### [name] A domain's name including top-level domain, for example "example.com". -Type: **string** +Type: **string** + @@ -89,7 +93,8 @@ A domain's name including top-level domain, for example "example.com". [networkAddress]: #networkaddress #### [networkAddress] Network address the domain is associated with. -Type: **string** +Type: **string** + @@ -99,7 +104,8 @@ Network address the domain is associated with. [serial]: #serial #### [serial] A unique number denoting the latest revision of a domain. Whenever a domain is changed its corresponding serial number is also changed. Serial numbers typically follow the format yyyymmdd## where yyyy is the current year, mm is the current month, dd is the current day of the month, and ## is the number of the revision for that day. A domain's serial number is automatically updated when edited via the API. -Type: **integer** +Type: **integer** + @@ -109,7 +115,8 @@ A unique number denoting the latest revision of a domain. Whenever a domain is c [updateDate]: #updatedate #### [updateDate] The date that this domain record was last updated. -Type: **dateTime** +Type: **dateTime** + @@ -125,7 +132,8 @@ The date that this domain record was last updated. [account]: #account #### [account] The SoftLayer customer account that owns a domain. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -135,7 +143,8 @@ The SoftLayer customer account that owns a domain. [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the dns domain record is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -145,7 +154,8 @@ A flag indicating that the dns domain record is a managed resource. [secondary]: #secondary #### [secondary] The secondary DNS record that defines this domain as being managed through zone transfers. -Type: **SoftLayer_Dns_Secondary ** +Type: **SoftLayer_Dns_Secondary ** + @@ -155,7 +165,8 @@ The secondary DNS record that defines this domain as being managed through zone [soaResourceRecord]: #soaresourcerecord #### [soaResourceRecord] The start of authority (SOA) record contains authoritative and propagation details for a DNS zone. This property is not considered in requests to createObject and editObject. -Type: **SoftLayer_Dns_Domain_ResourceRecord_SoaType ** +Type: **SoftLayer_Dns_Domain_ResourceRecord_SoaType ** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Message/_index.md b/content/reference/datatypes/SoftLayer_Dns_Message/_index.md index fbfd5e8a4e..66360d7203 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Message/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Message/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -55,7 +57,8 @@ The SoftLayer_Dns_Message data type contains information for a single message ge [createDate]: #createdate #### [createDate] The date the message was created. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +68,8 @@ The date the message was created. [id]: #id #### [id] The internal identifier for a DNS message. -Type: **integer** +Type: **integer** + @@ -75,7 +79,8 @@ The internal identifier for a DNS message. [message]: #message #### [message] The message text. -Type: **string** +Type: **string** + @@ -85,7 +90,8 @@ The message text. [priority]: #priority #### [priority] The priority level for a DNS message. The possible levels are 'notice' and 'error'. -Type: **string** +Type: **string** + @@ -101,7 +107,8 @@ The priority level for a DNS message. The possible levels are 'notice' and 'err [domain]: #domain #### [domain] The domain that is associated with a message. -Type: **SoftLayer_Dns_Domain ** +Type: **SoftLayer_Dns_Domain ** + @@ -111,7 +118,8 @@ The domain that is associated with a message. [resourceRecord]: #resourcerecord #### [resourceRecord] The resource record that is associated with a message. -Type: **SoftLayer_Dns_Domain_ResourceRecord ** +Type: **SoftLayer_Dns_Domain_ResourceRecord ** + @@ -121,7 +129,8 @@ The resource record that is associated with a message. [secondary]: #secondary #### [secondary] The secondary DNS record that a message belongs to. -Type: **SoftLayer_Dns_Secondary ** +Type: **SoftLayer_Dns_Secondary ** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Secondary/_index.md b/content/reference/datatypes/SoftLayer_Dns_Secondary/_index.md index 928c747b8e..e5618916b4 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Secondary/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Secondary/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -66,7 +68,8 @@ The SoftLayer_Dns_Secondary data type contains information on a single secondary [createDate]: #createdate #### [createDate] The date a secondary DNS record was created. -Type: **dateTime** +Type: **dateTime** + @@ -76,7 +79,8 @@ The date a secondary DNS record was created. [id]: #id #### [id] The internal identifier for a secondary DNS record. -Type: **integer** +Type: **integer** + @@ -86,7 +90,8 @@ The internal identifier for a secondary DNS record. [lastUpdate]: #lastupdate #### [lastUpdate] The date when the most recent secondary DNS zone transfer took place. -Type: **dateTime** +Type: **dateTime** + @@ -96,7 +101,8 @@ The date when the most recent secondary DNS zone transfer took place. [masterIpAddress]: #masteripaddress #### [masterIpAddress] The IP address of the master name server where a secondary DNS zone is transferred from. -Type: **string** +Type: **string** + @@ -110,7 +116,8 @@ The current status of a secondary DNS record. The status may be one of the foll :*'''1''': Active :*'''2''': Transfer Now :*'''3''': An error occurred that prevented the zone transfer from being completed. -Type: **integer** +Type: **integer** + @@ -120,7 +127,8 @@ The current status of a secondary DNS record. The status may be one of the foll [statusText]: #statustext #### [statusText] The textual representation of a secondary DNS zone's status. -Type: **string** +Type: **string** + @@ -130,7 +138,8 @@ The textual representation of a secondary DNS zone's status. [transferFrequency]: #transferfrequency #### [transferFrequency] How often a secondary DNS zone should be transferred in minutes. -Type: **integer** +Type: **integer** + @@ -140,7 +149,8 @@ How often a secondary DNS zone should be transferred in minutes. [zoneName]: #zonename #### [zoneName] The name of the zone that is transferred. -Type: **string** +Type: **string** + @@ -156,7 +166,8 @@ The name of the zone that is transferred. [account]: #account #### [account] The SoftLayer account that owns a secondary DNS record. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -166,7 +177,8 @@ The SoftLayer account that owns a secondary DNS record. [domain]: #domain #### [domain] The domain record created by zone transfer from a secondary DNS record. -Type: **SoftLayer_Dns_Domain ** +Type: **SoftLayer_Dns_Domain ** + @@ -176,7 +188,8 @@ The domain record created by zone transfer from a secondary DNS record. [errorMessages]: #errormessages #### [errorMessages] The error messages created during secondary DNS record transfer. -Type: **SoftLayer_Dns_Message[] ** +Type: **SoftLayer_Dns_Message[] ** + @@ -186,7 +199,8 @@ The error messages created during secondary DNS record transfer. [status]: #status #### [status] The current status of the secondary DNS zone. -Type: **SoftLayer_Dns_Status ** +Type: **SoftLayer_Dns_Status ** + @@ -198,7 +212,8 @@ The current status of the secondary DNS zone. [errorMessageCount]: #errormessagecount #### [errorMessageCount] A count of the error messages created during secondary DNS record transfer. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Dns_Status/_index.md b/content/reference/datatypes/SoftLayer_Dns_Status/_index.md index f5a25cd407..2fdb673f4f 100644 --- a/content/reference/datatypes/SoftLayer_Dns_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Dns_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Dns_Status data type contains information for a DNS status @@ -45,7 +47,8 @@ The SoftLayer_Dns_Status data type contains information for a DNS status [id]: #id #### [id] Internal identifier of a DNS status -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Internal identifier of a DNS status [name]: #name #### [name] Monitoring DNS status name -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Email_Subscription/_index.md b/content/reference/datatypes/SoftLayer_Email_Subscription/_index.md index 88328c9c21..764d1cc876 100644 --- a/content/reference/datatypes/SoftLayer_Email_Subscription/_index.md +++ b/content/reference/datatypes/SoftLayer_Email_Subscription/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] Brief description of the purpose of the email. -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ Brief description of the purpose of the email. [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ Brief description of the purpose of the email. [name]: #name #### [name] Email template name. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ Email template name. [enabled]: #enabled #### [enabled] -Type: **boolean** +Type: **boolean** + diff --git a/content/reference/datatypes/SoftLayer_Email_Subscription_Group/_index.md b/content/reference/datatypes/SoftLayer_Email_Subscription_Group/_index.md index 1052c2d539..7385001cec 100644 --- a/content/reference/datatypes/SoftLayer_Email_Subscription_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Email_Subscription_Group/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [name]: #name #### [name] Email subscription group name. -Type: **string** +Type: **string** +
      @@ -71,7 +75,8 @@ Email subscription group name. [subscriptions]: #subscriptions #### [subscriptions] All email subscriptions associated with this group. -Type: **SoftLayer_Email_Subscription[] ** +Type: **SoftLayer_Email_Subscription[] ** + @@ -83,7 +88,8 @@ All email subscriptions associated with this group. [subscriptionCount]: #subscriptioncount #### [subscriptionCount] A count of all email subscriptions associated with this group. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Email_Subscription_Suppression_User/_index.md b/content/reference/datatypes/SoftLayer_Email_Subscription_Suppression_User/_index.md index 400e18ae26..f488acb1f6 100644 --- a/content/reference/datatypes/SoftLayer_Email_Subscription_Suppression_User/_index.md +++ b/content/reference/datatypes/SoftLayer_Email_Subscription_Suppression_User/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -51,7 +53,8 @@ classes: [subscription]: #subscription #### [subscription] -Type: **SoftLayer_Email_Subscription ** +Type: **SoftLayer_Email_Subscription ** +
      diff --git a/content/reference/datatypes/SoftLayer_Entity/_index.md b/content/reference/datatypes/SoftLayer_Entity/_index.md index a018df5512..26e9d1a2c2 100644 --- a/content/reference/datatypes/SoftLayer_Entity/_index.md +++ b/content/reference/datatypes/SoftLayer_Entity/_index.md @@ -24,6 +24,8 @@ classes: + +
      diff --git a/content/reference/datatypes/SoftLayer_Event_Log/_index.md b/content/reference/datatypes/SoftLayer_Event_Log/_index.md index fdffb7b0ad..c0661a8879 100644 --- a/content/reference/datatypes/SoftLayer_Event_Log/_index.md +++ b/content/reference/datatypes/SoftLayer_Event_Log/_index.md @@ -18,6 +18,8 @@ classes:
      ## Description + + The SoftLayer_Event_Log data type contains an event detail occurred upon various SoftLayer resources. @@ -45,7 +47,8 @@ The SoftLayer_Event_Log data type contains an event detail occurred upon various [accountId]: #accountid #### [accountId] Account id with which the event is associated -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ Account id with which the event is associated [eventCreateDate]: #eventcreatedate #### [eventCreateDate] Event creation date in millisecond precision -Type: **dateTime** +Type: **dateTime** +
      @@ -65,7 +69,8 @@ Event creation date in millisecond precision [eventName]: #eventname #### [eventName] Event name such as "reboot", "cancel", "update host" and so on. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Event name such as "reboot", "cancel", "update host" and so on. [ipAddress]: #ipaddress #### [ipAddress] The remote IP Address that made the request -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The remote IP Address that made the request [label]: #label #### [label] Label or description of the event object -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Label or description of the event object [metaData]: #metadata #### [metaData] Meta data for an event in JSON string -Type: **JSON string** +Type: **JSON string** + @@ -105,7 +113,8 @@ Meta data for an event in JSON string [objectId]: #objectid #### [objectId] Event object id -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ Event object id [objectName]: #objectname #### [objectName] Event object name such as "server", "dns" and so on. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ Event object name such as "server", "dns" and so on. [openIdConnectUserName]: #openidconnectusername #### [openIdConnectUserName] OpenIdConnectUserName of the customer who initiated the event -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ OpenIdConnectUserName of the customer who initiated the event [resource]: #resource #### [resource] A resource object that is associated with the event -Type: **SoftLayer_Entity ** +Type: **SoftLayer_Entity ** + @@ -145,7 +157,8 @@ A resource object that is associated with the event [traceId]: #traceid #### [traceId] A unique trace id. Multiple event can be grouped by a trace id. -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ A unique trace id. Multiple event can be grouped by a trace id. [userId]: #userid #### [userId] Id of customer who initiated the event -Type: **integer** +Type: **integer** + @@ -165,7 +179,8 @@ Id of customer who initiated the event [userType]: #usertype #### [userType] Type of user that triggered the event. User type can be CUSTOMER, EMPLOYEE or SYSTEM. -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ Type of user that triggered the event. User type can be CUSTOMER, EMPLOYEE or SY [username]: #username #### [username] Customer username who initiated the event -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ Customer username who initiated the event [user]: #user #### [user] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + diff --git a/content/reference/datatypes/SoftLayer_Exception_Brand_Creation/_index.md b/content/reference/datatypes/SoftLayer_Exception_Brand_Creation/_index.md index 0ddc8f4517..81d08f8ce2 100644 --- a/content/reference/datatypes/SoftLayer_Exception_Brand_Creation/_index.md +++ b/content/reference/datatypes/SoftLayer_Exception_Brand_Creation/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ Throw this exception if there are validation errors. The types are specified in [message]: #message #### [message] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Throw this exception if there are validation errors. The types are specified in [type]: #type #### [type] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Exception_Hardware_Component_Locator_ComponentLocatorException/_index.md b/content/reference/datatypes/SoftLayer_Exception_Hardware_Component_Locator_ComponentLocatorException/_index.md index 6707d4ea2a..4c0583d3b8 100644 --- a/content/reference/datatypes/SoftLayer_Exception_Hardware_Component_Locator_ComponentLocatorException/_index.md +++ b/content/reference/datatypes/SoftLayer_Exception_Hardware_Component_Locator_ComponentLocatorException/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This exception is thrown if the component locator client cannot find or communicate with the component locator service. diff --git a/content/reference/datatypes/SoftLayer_Exception_Hardware_Component_Locator_InvalidGenericComponentArgument/_index.md b/content/reference/datatypes/SoftLayer_Exception_Hardware_Component_Locator_InvalidGenericComponentArgument/_index.md index 1125e340d5..043f03b9d1 100644 --- a/content/reference/datatypes/SoftLayer_Exception_Hardware_Component_Locator_InvalidGenericComponentArgument/_index.md +++ b/content/reference/datatypes/SoftLayer_Exception_Hardware_Component_Locator_InvalidGenericComponentArgument/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This exception is thrown if the argument is of incorrect type. diff --git a/content/reference/datatypes/SoftLayer_FlexibleCredit_Affiliate/_index.md b/content/reference/datatypes/SoftLayer_FlexibleCredit_Affiliate/_index.md index 524318046a..1e0f9394f1 100644 --- a/content/reference/datatypes/SoftLayer_FlexibleCredit_Affiliate/_index.md +++ b/content/reference/datatypes/SoftLayer_FlexibleCredit_Affiliate/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] Primary ID for the affiliate -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ Primary ID for the affiliate [name]: #name #### [name] Name of this affiliate -Type: **string** +Type: **string** +
      @@ -71,7 +75,8 @@ Name of this affiliate [flexibleCreditProgram]: #flexiblecreditprogram #### [flexibleCreditProgram] Flexible Credit Program the affiliate belongs to. -Type: **SoftLayer_FlexibleCredit_Program ** +Type: **SoftLayer_FlexibleCredit_Program ** + diff --git a/content/reference/datatypes/SoftLayer_FlexibleCredit_Company_Type/_index.md b/content/reference/datatypes/SoftLayer_FlexibleCredit_Company_Type/_index.md index cd7338fe2f..fb9d5ff9d5 100644 --- a/content/reference/datatypes/SoftLayer_FlexibleCredit_Company_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_FlexibleCredit_Company_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] Description of the company type -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ Description of the company type [id]: #id #### [id] Primary ID for the company type -Type: **integer** +Type: **integer** +
      diff --git a/content/reference/datatypes/SoftLayer_FlexibleCredit_Enrollment/_index.md b/content/reference/datatypes/SoftLayer_FlexibleCredit_Enrollment/_index.md index b7dd557a77..1219ef6f0d 100644 --- a/content/reference/datatypes/SoftLayer_FlexibleCredit_Enrollment/_index.md +++ b/content/reference/datatypes/SoftLayer_FlexibleCredit_Enrollment/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] Account ID associated with this enrollment -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ Account ID associated with this enrollment [affiliateId]: #affiliateid #### [affiliateId] ID of the corresponding Flexible Credit Program Affiliate -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ ID of the corresponding Flexible Credit Program Affiliate [agreementCompleteFlag]: #agreementcompleteflag #### [agreementCompleteFlag] Indicates signing of Flexible Credit agreement (independent from MSA) -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ Indicates signing of Flexible Credit agreement (independent from MSA) [companyDescription]: #companydescription #### [companyDescription] Brief description of the company -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ Brief description of the company [companyTypeId]: #companytypeid #### [companyTypeId] ID of the Flexible Credit Program Company classification for this enrollment -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ ID of the Flexible Credit Program Company classification for this enrollment [enrollmentDate]: #enrollmentdate #### [enrollmentDate] Date when participation in the Flexible Credit program began -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ Date when participation in the Flexible Credit program began [graduationDate]: #graduationdate #### [graduationDate] Date Flexible Credit Program benefits end. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ Date Flexible Credit Program benefits end. [monthlyCreditAmount]: #monthlycreditamount #### [monthlyCreditAmount] Amount of monthly credit (USD) given to the account -Type: **decimal** +Type: **decimal** + @@ -125,7 +135,8 @@ Amount of monthly credit (USD) given to the account [representativeEmployeeId]: #representativeemployeeid #### [representativeEmployeeId] ID of the employee representing this account. -Type: **integer** +Type: **integer** + @@ -141,7 +152,8 @@ ID of the employee representing this account. [account]: #account #### [account] Account the enrollment belongs to -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -151,7 +163,8 @@ Account the enrollment belongs to [affiliate]: #affiliate #### [affiliate] Affiliate associated with the account enrollment -Type: **SoftLayer_FlexibleCredit_Affiliate ** +Type: **SoftLayer_FlexibleCredit_Affiliate ** + @@ -161,7 +174,8 @@ Affiliate associated with the account enrollment [companyType]: #companytype #### [companyType] Category which best describes the company -Type: **SoftLayer_FlexibleCredit_Company_Type ** +Type: **SoftLayer_FlexibleCredit_Company_Type ** + @@ -171,7 +185,8 @@ Category which best describes the company [flexibleCreditProgram]: #flexiblecreditprogram #### [flexibleCreditProgram] Discount program the enrollment belongs to -Type: **SoftLayer_FlexibleCredit_Program ** +Type: **SoftLayer_FlexibleCredit_Program ** + @@ -181,7 +196,8 @@ Discount program the enrollment belongs to [isActiveFlag]: #isactiveflag #### [isActiveFlag] Flag indicating whether an enrollment is active (true) or inactive (false) -Type: **boolean** +Type: **boolean** + @@ -191,7 +207,8 @@ Flag indicating whether an enrollment is active (true) or inactive (false) [representative]: #representative #### [representative] Employee overseeing the enrollment -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + diff --git a/content/reference/datatypes/SoftLayer_FlexibleCredit_Program/_index.md b/content/reference/datatypes/SoftLayer_FlexibleCredit_Program/_index.md index d8ad0e084e..fdf2a19266 100644 --- a/content/reference/datatypes/SoftLayer_FlexibleCredit_Program/_index.md +++ b/content/reference/datatypes/SoftLayer_FlexibleCredit_Program/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] Primary ID of the Flexible Credit Program -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ Primary ID of the Flexible Credit Program [keyName]: #keyname #### [keyName] Unique name for the Flexible Credit Program -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ Unique name for the Flexible Credit Program [name]: #name #### [name] Name of the Flexible Credit Program. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Hardware/_index.md b/content/reference/datatypes/SoftLayer_Hardware/_index.md index 38344b25f0..9ec9cade94 100644 --- a/content/reference/datatypes/SoftLayer_Hardware/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware data type contains general information relating to a single SoftLayer hardware. @@ -80,7 +82,8 @@ The SoftLayer_Hardware data type contains general information relating to a sing [accountId]: #accountid #### [accountId] A hardware's associated [SoftLayer_Account]({{}}) id. -Type: **integer** +Type: **integer** + @@ -90,7 +93,8 @@ A hardware's associated [SoftLayer_Account]({{Type: **integer** +Type: **integer** + @@ -100,7 +104,8 @@ When true, this flag specifies that a hardware is Bare Metal Server. Bare Metal [domain]: #domain #### [domain] A piece of hardware's local network domain name. -Type: **string** +Type: **string** + @@ -110,7 +115,8 @@ A piece of hardware's local network domain name. [fullyQualifiedDomainName]: #fullyqualifieddomainname #### [fullyQualifiedDomainName] A name reflecting the hostname and domain of the hardware. This is created from the combined values of the hardware's hostname and domain name automatically, and thus should not be edited directly. -Type: **string** +Type: **string** + @@ -120,7 +126,8 @@ A name reflecting the hostname and domain of the hardware. This is created from [hardwareStatusId]: #hardwarestatusid #### [hardwareStatusId] A number reflecting the state of a hardware -Type: **integer** +Type: **integer** + @@ -130,7 +137,8 @@ A number reflecting the state of a hardware [hostname]: #hostname #### [hostname] A hardware's hostname -Type: **string** +Type: **string** + @@ -140,7 +148,8 @@ A hardware's hostname [id]: #id #### [id] A hardware's internal identification number -Type: **integer** +Type: **integer** + @@ -150,7 +159,8 @@ A hardware's internal identification number [manufacturerSerialNumber]: #manufacturerserialnumber #### [manufacturerSerialNumber] A hardware's serial number that is supplied by the manufacturer. -Type: **string** +Type: **string** + @@ -160,7 +170,8 @@ A hardware's serial number that is supplied by the manufacturer. [notes]: #notes #### [notes] A small note about a piece of hardware to use at your discretion. -Type: **string** +Type: **string** + @@ -170,7 +181,8 @@ A small note about a piece of hardware to use at your discretion. [postInstallScriptUri]: #postinstallscripturi #### [postInstallScriptUri] URI of the script to be downloaded and executed after installation is complete. -Type: **string** +Type: **string** + @@ -180,7 +192,8 @@ URI of the script to be downloaded and executed after installation is complete. [provisionDate]: #provisiondate #### [provisionDate] -Type: **dateTime** +Type: **dateTime** + @@ -190,7 +203,8 @@ URI of the script to be downloaded and executed after installation is complete. [serialNumber]: #serialnumber #### [serialNumber] A hardware's serial number that is supplied by SoftLayer. -Type: **string** +Type: **string** + @@ -200,7 +214,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] -Type: **integer** +Type: **integer** + @@ -210,7 +225,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderResourceId]: #serviceproviderresourceid #### [serviceProviderResourceId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -226,7 +242,8 @@ A hardware's internal identification number at its service provider [account]: #account #### [account] The account associated with a piece of hardware. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -236,7 +253,8 @@ The account associated with a piece of hardware. [activeComponents]: #activecomponents #### [activeComponents] A piece of hardware's active physical components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -246,7 +264,8 @@ A piece of hardware's active physical components. [activeNetworkMonitorIncident]: #activenetworkmonitorincident #### [activeNetworkMonitorIncident] A piece of hardware's active network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -256,7 +275,8 @@ A piece of hardware's active network monitoring incidents. [allPowerComponents]: #allpowercomponents #### [allPowerComponents] -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -266,7 +286,8 @@ A piece of hardware's active network monitoring incidents. [allowedHost]: #allowedhost #### [allowedHost] The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. -Type: **SoftLayer_Network_Storage_Allowed_Host ** +Type: **SoftLayer_Network_Storage_Allowed_Host ** + @@ -276,7 +297,8 @@ The SoftLayer_Network_Storage_Allowed_Host information to connect this server to [allowedNetworkStorage]: #allowednetworkstorage #### [allowedNetworkStorage] The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -286,7 +308,8 @@ The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to [allowedNetworkStorageReplicas]: #allowednetworkstoragereplicas #### [allowedNetworkStorageReplicas] The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -296,7 +319,8 @@ The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware [antivirusSpywareSoftwareComponent]: #antivirusspywaresoftwarecomponent #### [antivirusSpywareSoftwareComponent] Information regarding an antivirus/spyware software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -306,7 +330,8 @@ Information regarding an antivirus/spyware software component object. [attributes]: #attributes #### [attributes] Information regarding a piece of hardware's specific attributes. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -316,7 +341,8 @@ Information regarding a piece of hardware's specific attributes. [averageDailyPublicBandwidthUsage]: #averagedailypublicbandwidthusage #### [averageDailyPublicBandwidthUsage] The average daily public bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -326,7 +352,8 @@ The average daily public bandwidth usage for the current billing cycle. [backendNetworkComponents]: #backendnetworkcomponents #### [backendNetworkComponents] A piece of hardware's back-end or private network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -336,7 +363,8 @@ A piece of hardware's back-end or private network components. [backendRouters]: #backendrouters #### [backendRouters] A hardware's backend or private router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -346,7 +374,8 @@ A hardware's backend or private router. [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] A hardware's allotted bandwidth (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -356,7 +385,8 @@ A hardware's allotted bandwidth (measured in GB). [bandwidthAllotmentDetail]: #bandwidthallotmentdetail #### [bandwidthAllotmentDetail] A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** + @@ -366,7 +396,8 @@ A hardware's allotted detail record. Allotment details link bandwidth allocation [benchmarkCertifications]: #benchmarkcertifications #### [benchmarkCertifications] Information regarding a piece of hardware's benchmark certifications. -Type: **SoftLayer_Hardware_Benchmark_Certification[] ** +Type: **SoftLayer_Hardware_Benchmark_Certification[] ** + @@ -376,7 +407,8 @@ Information regarding a piece of hardware's benchmark certifications. [billingItem]: #billingitem #### [billingItem] Information regarding the billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -386,7 +418,8 @@ Information regarding the billing item for a server. [billingItemFlag]: #billingitemflag #### [billingItemFlag] A flag indicating that a billing item exists. -Type: **boolean** +Type: **boolean** + @@ -396,7 +429,8 @@ A flag indicating that a billing item exists. [blockCancelBecauseDisconnectedFlag]: #blockcancelbecausedisconnectedflag #### [blockCancelBecauseDisconnectedFlag] Determines whether the hardware is ineligible for cancellation because it is disconnected. -Type: **boolean** +Type: **boolean** + @@ -406,7 +440,8 @@ Determines whether the hardware is ineligible for cancellation because it is dis [businessContinuanceInsuranceFlag]: #businesscontinuanceinsuranceflag #### [businessContinuanceInsuranceFlag] Status indicating whether or not a piece of hardware has business continuance insurance. -Type: **boolean** +Type: **boolean** + @@ -416,7 +451,8 @@ Status indicating whether or not a piece of hardware has business continuance in [childrenHardware]: #childrenhardware #### [childrenHardware] Child hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -426,7 +462,8 @@ Child hardware. [components]: #components #### [components] A piece of hardware's components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -436,7 +473,8 @@ A piece of hardware's components. [continuousDataProtectionSoftwareComponent]: #continuousdataprotectionsoftwarecomponent #### [continuousDataProtectionSoftwareComponent] A continuous data protection/server backup software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -446,7 +484,8 @@ A continuous data protection/server backup software component object. [currentBillableBandwidthUsage]: #currentbillablebandwidthusage #### [currentBillableBandwidthUsage] The current billable public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -456,7 +495,8 @@ The current billable public outbound bandwidth for this hardware for the current [datacenter]: #datacenter #### [datacenter] Information regarding the datacenter in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -466,7 +506,8 @@ Information regarding the datacenter in which a piece of hardware resides. [datacenterName]: #datacentername #### [datacenterName] The name of the datacenter in which a piece of hardware resides. -Type: **string** +Type: **string** + @@ -476,7 +517,8 @@ The name of the datacenter in which a piece of hardware resides. [daysInSparePool]: #daysinsparepool #### [daysInSparePool] Number of day(s) a server have been in spare pool. -Type: **integer** +Type: **integer** + @@ -486,7 +528,8 @@ Number of day(s) a server have been in spare pool. [downlinkHardware]: #downlinkhardware #### [downlinkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -496,7 +539,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkNetworkHardware]: #downlinknetworkhardware #### [downlinkNetworkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -506,7 +550,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkServers]: #downlinkservers #### [downlinkServers] Information regarding all servers attached to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -516,7 +561,8 @@ Information regarding all servers attached to a piece of network hardware. [downlinkVirtualGuests]: #downlinkvirtualguests #### [downlinkVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -526,7 +572,8 @@ Information regarding all virtual guests attached to a piece of network hardware [downstreamHardwareBindings]: #downstreamhardwarebindings #### [downstreamHardwareBindings] All hardware downstream from a network device. -Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** +Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** + @@ -536,7 +583,8 @@ All hardware downstream from a network device. [downstreamNetworkHardware]: #downstreamnetworkhardware #### [downstreamNetworkHardware] All network hardware downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -546,7 +594,8 @@ All network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidents]: #downstreamnetworkhardwarewithincidents #### [downstreamNetworkHardwareWithIncidents] All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -556,7 +605,8 @@ All network hardware with monitoring warnings or errors that are downstream from [downstreamServers]: #downstreamservers #### [downstreamServers] Information regarding all servers attached downstream to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -566,7 +616,8 @@ Information regarding all servers attached downstream to a piece of network hard [downstreamVirtualGuests]: #downstreamvirtualguests #### [downstreamVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -576,7 +627,8 @@ Information regarding all virtual guests attached to a piece of network hardware [driveControllers]: #drivecontrollers #### [driveControllers] The drive controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -586,7 +638,8 @@ The drive controllers contained within a piece of hardware. [evaultNetworkStorage]: #evaultnetworkstorage #### [evaultNetworkStorage] Information regarding a piece of hardware's associated EVault network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -596,7 +649,8 @@ Information regarding a piece of hardware's associated EVault network storage se [firewallServiceComponent]: #firewallservicecomponent #### [firewallServiceComponent] Information regarding a piece of hardware's firewall services. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -606,7 +660,8 @@ Information regarding a piece of hardware's firewall services. [fixedConfigurationPreset]: #fixedconfigurationpreset #### [fixedConfigurationPreset] Defines the fixed components in a fixed configuration bare metal server. -Type: **SoftLayer_Product_Package_Preset ** +Type: **SoftLayer_Product_Package_Preset ** + @@ -616,7 +671,8 @@ Defines the fixed components in a fixed configuration bare metal server. [frontendNetworkComponents]: #frontendnetworkcomponents #### [frontendNetworkComponents] A piece of hardware's front-end or public network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -626,7 +682,8 @@ A piece of hardware's front-end or public network components. [frontendRouters]: #frontendrouters #### [frontendRouters] A hardware's frontend or public router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -636,7 +693,8 @@ A hardware's frontend or public router. [futureBillingItem]: #futurebillingitem #### [futureBillingItem] Information regarding the future billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -646,7 +704,8 @@ Information regarding the future billing item for a server. [globalIdentifier]: #globalidentifier #### [globalIdentifier] A hardware's universally unique identifier. -Type: **string** +Type: **string** + @@ -656,7 +715,8 @@ A hardware's universally unique identifier. [hardDrives]: #harddrives #### [hardDrives] The hard drives contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -666,7 +726,8 @@ The hard drives contained within a piece of hardware. [hardwareChassis]: #hardwarechassis #### [hardwareChassis] The chassis that a piece of hardware is housed in. -Type: **SoftLayer_Hardware_Chassis ** +Type: **SoftLayer_Hardware_Chassis ** + @@ -676,7 +737,8 @@ The chassis that a piece of hardware is housed in. [hardwareFunction]: #hardwarefunction #### [hardwareFunction] A hardware's function. -Type: **SoftLayer_Hardware_Function ** +Type: **SoftLayer_Hardware_Function ** + @@ -686,7 +748,8 @@ A hardware's function. [hardwareFunctionDescription]: #hardwarefunctiondescription #### [hardwareFunctionDescription] A hardware's function. -Type: **string** +Type: **string** + @@ -696,7 +759,8 @@ A hardware's function. [hardwareStatus]: #hardwarestatus #### [hardwareStatus] A hardware's status. -Type: **SoftLayer_Hardware_Status ** +Type: **SoftLayer_Hardware_Status ** + @@ -706,7 +770,8 @@ A hardware's status. [hasTrustedPlatformModuleBillingItemFlag]: #hastrustedplatformmodulebillingitemflag #### [hasTrustedPlatformModuleBillingItemFlag] Determine in hardware object has TPM enabled. -Type: **boolean** +Type: **boolean** + @@ -716,7 +781,8 @@ Determine in hardware object has TPM enabled. [hostIpsSoftwareComponent]: #hostipssoftwarecomponent #### [hostIpsSoftwareComponent] Information regarding a host IPS software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -726,7 +792,8 @@ Information regarding a host IPS software component object. [hourlyBillingFlag]: #hourlybillingflag #### [hourlyBillingFlag] A server's hourly billing status. -Type: **boolean** +Type: **boolean** + @@ -736,7 +803,8 @@ A server's hourly billing status. [inboundBandwidthUsage]: #inboundbandwidthusage #### [inboundBandwidthUsage] The sum of all the inbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -746,7 +814,8 @@ The sum of all the inbound network traffic data for the last 30 days. [inboundPublicBandwidthUsage]: #inboundpublicbandwidthusage #### [inboundPublicBandwidthUsage] The total public inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -756,7 +825,8 @@ The total public inbound bandwidth for this hardware for the current billing cyc [isBillingTermChangeAvailableFlag]: #isbillingtermchangeavailableflag #### [isBillingTermChangeAvailableFlag] Whether or not this hardware object is eligible to change to term billing. -Type: **boolean** +Type: **boolean** + @@ -766,7 +836,8 @@ Whether or not this hardware object is eligible to change to term billing. [lastTransaction]: #lasttransaction #### [lastTransaction] Information regarding the last transaction a server performed. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -776,7 +847,8 @@ Information regarding the last transaction a server performed. [latestNetworkMonitorIncident]: #latestnetworkmonitorincident #### [latestNetworkMonitorIncident] A piece of hardware's latest network monitoring incident. -Type: **SoftLayer_Network_Monitor_Version1_Incident ** +Type: **SoftLayer_Network_Monitor_Version1_Incident ** + @@ -786,7 +858,8 @@ A piece of hardware's latest network monitoring incident. [location]: #location #### [location] Where a piece of hardware is located within SoftLayer's location hierarchy. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -796,7 +869,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [locationPathString]: #locationpathstring #### [locationPathString] -Type: **string** +Type: **string** + @@ -806,7 +880,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [lockboxNetworkStorage]: #lockboxnetworkstorage #### [lockboxNetworkStorage] Information regarding a lockbox account associated with a server. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -816,7 +891,8 @@ Information regarding a lockbox account associated with a server. [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the hardware is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -826,7 +902,8 @@ A flag indicating that the hardware is a managed resource. [memory]: #memory #### [memory] Information regarding a piece of hardware's memory. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -836,7 +913,8 @@ Information regarding a piece of hardware's memory. [memoryCapacity]: #memorycapacity #### [memoryCapacity] The amount of memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -846,7 +924,8 @@ The amount of memory a piece of hardware has, measured in gigabytes. [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A piece of hardware's metric tracking object. -Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** +Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** + @@ -856,7 +935,8 @@ A piece of hardware's metric tracking object. [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -866,7 +946,8 @@ A piece of hardware's metric tracking object. [monitoringRobot]: #monitoringrobot #### [monitoringRobot] -Type: **SoftLayer_Monitoring_Robot ** +Type: **SoftLayer_Monitoring_Robot ** + @@ -876,7 +957,8 @@ A piece of hardware's metric tracking object. [monitoringServiceComponent]: #monitoringservicecomponent #### [monitoringServiceComponent] Information regarding a piece of hardware's network monitoring services. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** + @@ -886,7 +968,8 @@ Information regarding a piece of hardware's network monitoring services. [monitoringServiceEligibilityFlag]: #monitoringserviceeligibilityflag #### [monitoringServiceEligibilityFlag] -Type: **boolean** +Type: **boolean** + @@ -896,7 +979,8 @@ Information regarding a piece of hardware's network monitoring services. [motherboard]: #motherboard #### [motherboard] Information regarding a piece of hardware's motherboard. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -906,7 +990,8 @@ Information regarding a piece of hardware's motherboard. [networkCards]: #networkcards #### [networkCards] Information regarding a piece of hardware's network cards. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -916,7 +1001,8 @@ Information regarding a piece of hardware's network cards. [networkComponents]: #networkcomponents #### [networkComponents] Returns a hardware's network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -926,7 +1012,8 @@ Returns a hardware's network components. [networkGatewayMember]: #networkgatewaymember #### [networkGatewayMember] The gateway member if this device is part of a network gateway. -Type: **SoftLayer_Network_Gateway_Member ** +Type: **SoftLayer_Network_Gateway_Member ** + @@ -936,7 +1023,8 @@ The gateway member if this device is part of a network gateway. [networkGatewayMemberFlag]: #networkgatewaymemberflag #### [networkGatewayMemberFlag] Whether or not this device is part of a network gateway. -Type: **boolean** +Type: **boolean** + @@ -946,7 +1034,8 @@ Whether or not this device is part of a network gateway. [networkManagementIpAddress]: #networkmanagementipaddress #### [networkManagementIpAddress] A piece of hardware's network management IP address. -Type: **string** +Type: **string** + @@ -956,7 +1045,8 @@ A piece of hardware's network management IP address. [networkMonitorAttachedDownHardware]: #networkmonitorattacheddownhardware #### [networkMonitorAttachedDownHardware] All servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -966,7 +1056,8 @@ All servers with failed monitoring that are attached downstream to a piece of ha [networkMonitorAttachedDownVirtualGuests]: #networkmonitorattacheddownvirtualguests #### [networkMonitorAttachedDownVirtualGuests] Virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -976,7 +1067,8 @@ Virtual guests that are attached downstream to a hardware that have failed monit [networkMonitorIncidents]: #networkmonitorincidents #### [networkMonitorIncidents] The status of all of a piece of hardware's network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -986,7 +1078,8 @@ The status of all of a piece of hardware's network monitoring incidents. [networkMonitors]: #networkmonitors #### [networkMonitors] Information regarding a piece of hardware's network monitors. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** + @@ -996,7 +1089,8 @@ Information regarding a piece of hardware's network monitors. [networkStatus]: #networkstatus #### [networkStatus] The value of a hardware's network status attribute. -Type: **string** +Type: **string** + @@ -1006,7 +1100,8 @@ The value of a hardware's network status attribute. [networkStatusAttribute]: #networkstatusattribute #### [networkStatusAttribute] The hardware's related network status attribute. -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -1016,7 +1111,8 @@ The hardware's related network status attribute. [networkStorage]: #networkstorage #### [networkStorage] Information regarding a piece of hardware's associated network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -1026,7 +1122,8 @@ Information regarding a piece of hardware's associated network storage service a [networkVlans]: #networkvlans #### [networkVlans] The network virtual LANs (VLANs) associated with a piece of hardware's network components. -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -1036,7 +1133,8 @@ The network virtual LANs (VLANs) associated with a piece of hardware's network c [nextBillingCycleBandwidthAllocation]: #nextbillingcyclebandwidthallocation #### [nextBillingCycleBandwidthAllocation] A hardware's allotted bandwidth for the next billing cycle (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -1046,7 +1144,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [notesHistory]: #noteshistory #### [notesHistory] -Type: **SoftLayer_Hardware_Note[] ** +Type: **SoftLayer_Hardware_Note[] ** + @@ -1056,7 +1155,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [nvRamCapacity]: #nvramcapacity #### [nvRamCapacity] The amount of non-volatile memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1066,7 +1166,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [nvRamComponentModels]: #nvramcomponentmodels #### [nvRamComponentModels] -Type: **SoftLayer_Hardware_Component_Model[] ** +Type: **SoftLayer_Hardware_Component_Model[] ** + @@ -1076,7 +1177,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [operatingSystem]: #operatingsystem #### [operatingSystem] Information regarding a piece of hardware's operating system. -Type: **SoftLayer_Software_Component_OperatingSystem ** +Type: **SoftLayer_Software_Component_OperatingSystem ** + @@ -1086,7 +1188,8 @@ Information regarding a piece of hardware's operating system. [operatingSystemReferenceCode]: #operatingsystemreferencecode #### [operatingSystemReferenceCode] A hardware's operating system software description. -Type: **string** +Type: **string** + @@ -1096,7 +1199,8 @@ A hardware's operating system software description. [outboundBandwidthUsage]: #outboundbandwidthusage #### [outboundBandwidthUsage] The sum of all the outbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -1106,7 +1210,8 @@ The sum of all the outbound network traffic data for the last 30 days. [outboundPublicBandwidthUsage]: #outboundpublicbandwidthusage #### [outboundPublicBandwidthUsage] The total public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -1116,7 +1221,8 @@ The total public outbound bandwidth for this hardware for the current billing cy [parentBay]: #parentbay #### [parentBay] Blade Bay -Type: **SoftLayer_Hardware_Blade ** +Type: **SoftLayer_Hardware_Blade ** + @@ -1126,7 +1232,8 @@ Blade Bay [parentHardware]: #parenthardware #### [parentHardware] Parent Hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1136,7 +1243,8 @@ Parent Hardware. [pointOfPresenceLocation]: #pointofpresencelocation #### [pointOfPresenceLocation] Information regarding the Point of Presence (PoP) location in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1146,7 +1254,8 @@ Information regarding the Point of Presence (PoP) location in which a piece of h [powerComponents]: #powercomponents #### [powerComponents] The power components for a hardware object. -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -1156,7 +1265,8 @@ The power components for a hardware object. [powerSupply]: #powersupply #### [powerSupply] Information regarding a piece of hardware's power supply. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1166,7 +1276,8 @@ Information regarding a piece of hardware's power supply. [primaryBackendIpAddress]: #primarybackendipaddress #### [primaryBackendIpAddress] The hardware's primary private IP address. -Type: **string** +Type: **string** + @@ -1176,7 +1287,8 @@ The hardware's primary private IP address. [primaryBackendNetworkComponent]: #primarybackendnetworkcomponent #### [primaryBackendNetworkComponent] Information regarding the hardware's primary back-end network component. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1186,7 +1298,8 @@ Information regarding the hardware's primary back-end network component. [primaryIpAddress]: #primaryipaddress #### [primaryIpAddress] The hardware's primary public IP address. -Type: **string** +Type: **string** + @@ -1196,7 +1309,8 @@ The hardware's primary public IP address. [primaryNetworkComponent]: #primarynetworkcomponent #### [primaryNetworkComponent] Information regarding the hardware's primary public network component. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1206,7 +1320,8 @@ Information regarding the hardware's primary public network component. [privateNetworkOnlyFlag]: #privatenetworkonlyflag #### [privateNetworkOnlyFlag] Whether the hardware only has access to the private network. -Type: **boolean** +Type: **boolean** + @@ -1216,7 +1331,8 @@ Whether the hardware only has access to the private network. [processorCoreAmount]: #processorcoreamount #### [processorCoreAmount] The total number of processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1226,7 +1342,8 @@ The total number of processor cores, summed from all processors that are attache [processorPhysicalCoreAmount]: #processorphysicalcoreamount #### [processorPhysicalCoreAmount] The total number of physical processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1236,7 +1353,8 @@ The total number of physical processor cores, summed from all processors that ar [processors]: #processors #### [processors] Information regarding a piece of hardware's processors. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1246,7 +1364,8 @@ Information regarding a piece of hardware's processors. [rack]: #rack #### [rack] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1256,7 +1375,8 @@ Information regarding a piece of hardware's processors. [raidControllers]: #raidcontrollers #### [raidControllers] The RAID controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1266,7 +1386,8 @@ The RAID controllers contained within a piece of hardware. [recentEvents]: #recentevents #### [recentEvents] Recent events that impact this hardware. -Type: **SoftLayer_Notification_Occurrence_Event[] ** +Type: **SoftLayer_Notification_Occurrence_Event[] ** + @@ -1276,7 +1397,8 @@ Recent events that impact this hardware. [remoteManagementAccounts]: #remotemanagementaccounts #### [remoteManagementAccounts] User credentials to issue commands and/or interact with the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** + @@ -1286,7 +1408,8 @@ User credentials to issue commands and/or interact with the server's remote mana [remoteManagementComponent]: #remotemanagementcomponent #### [remoteManagementComponent] A hardware's associated remote management component. This is normally IPMI. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1296,7 +1419,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceConfigurations]: #resourceconfigurations #### [resourceConfigurations] -Type: **SoftLayer_Hardware_Resource_Configuration[] ** +Type: **SoftLayer_Hardware_Resource_Configuration[] ** + @@ -1306,7 +1430,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroupMemberReferences]: #resourcegroupmemberreferences #### [resourceGroupMemberReferences] -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -1316,7 +1441,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroupRoles]: #resourcegrouproles #### [resourceGroupRoles] -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -1326,7 +1452,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroups]: #resourcegroups #### [resourceGroups] The resource groups in which this hardware is a member. -Type: **SoftLayer_Resource_Group[] ** +Type: **SoftLayer_Resource_Group[] ** + @@ -1336,7 +1463,8 @@ The resource groups in which this hardware is a member. [routers]: #routers #### [routers] A hardware's routers. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1346,7 +1474,8 @@ A hardware's routers. [scaleAssets]: #scaleassets #### [scaleAssets] Collection of scale assets this hardware corresponds to. -Type: **SoftLayer_Scale_Asset[] ** +Type: **SoftLayer_Scale_Asset[] ** + @@ -1356,7 +1485,8 @@ Collection of scale assets this hardware corresponds to. [securityScanRequests]: #securityscanrequests #### [securityScanRequests] Information regarding a piece of hardware's vulnerability scan requests. -Type: **SoftLayer_Network_Security_Scanner_Request[] ** +Type: **SoftLayer_Network_Security_Scanner_Request[] ** + @@ -1366,7 +1496,8 @@ Information regarding a piece of hardware's vulnerability scan requests. [serverRoom]: #serverroom #### [serverRoom] Information regarding the server room in which the hardware is located. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1376,7 +1507,8 @@ Information regarding the server room in which the hardware is located. [serviceProvider]: #serviceprovider #### [serviceProvider] Information regarding the piece of hardware's service provider. -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -1386,7 +1518,8 @@ Information regarding the piece of hardware's service provider. [softwareComponents]: #softwarecomponents #### [softwareComponents] Information regarding a piece of hardware's installed software. -Type: **SoftLayer_Software_Component[] ** +Type: **SoftLayer_Software_Component[] ** + @@ -1396,7 +1529,8 @@ Information regarding a piece of hardware's installed software. [sparePoolBillingItem]: #sparepoolbillingitem #### [sparePoolBillingItem] Information regarding the billing item for a spare pool server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -1406,7 +1540,8 @@ Information regarding the billing item for a spare pool server. [sshKeys]: #sshkeys #### [sshKeys] SSH keys to be installed on the server during provisioning or an OS reload. -Type: **SoftLayer_Security_Ssh_Key[] ** +Type: **SoftLayer_Security_Ssh_Key[] ** + @@ -1416,17 +1551,20 @@ SSH keys to be installed on the server during provisioning or an OS reload. [storageGroups]: #storagegroups #### [storageGroups] -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + -
      +
      ----- [storageNetworkComponents]: #storagenetworkcomponents #### [storageNetworkComponents] A piece of hardware's private storage network components. [Deprecated] -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + +Deprecated
      @@ -1436,7 +1574,8 @@ A piece of hardware's private storage network components. [Deprecated] [tagReferences]: #tagreferences #### [tagReferences] -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** +
      @@ -1446,7 +1585,8 @@ A piece of hardware's private storage network components. [Deprecated] [topLevelLocation]: #toplevellocation #### [topLevelLocation] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1456,7 +1596,8 @@ A piece of hardware's private storage network components. [Deprecated] [upgradeRequest]: #upgraderequest #### [upgradeRequest] An account's associated upgrade request object, if any. -Type: **SoftLayer_Product_Upgrade_Request ** +Type: **SoftLayer_Product_Upgrade_Request ** + @@ -1466,7 +1607,8 @@ An account's associated upgrade request object, if any. [uplinkHardware]: #uplinkhardware #### [uplinkHardware] The network device connected to a piece of hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1476,7 +1618,8 @@ The network device connected to a piece of hardware. [uplinkNetworkComponents]: #uplinknetworkcomponents #### [uplinkNetworkComponents] Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -1486,7 +1629,8 @@ Information regarding the network component that is one level higher than a piec [userData]: #userdata #### [userData] An array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -1496,7 +1640,8 @@ An array containing a single string of custom user data for a hardware order. Ma [virtualChassis]: #virtualchassis #### [virtualChassis] Information regarding the virtual chassis for a piece of hardware. -Type: **SoftLayer_Hardware_Group ** +Type: **SoftLayer_Hardware_Group ** + @@ -1506,7 +1651,8 @@ Information regarding the virtual chassis for a piece of hardware. [virtualChassisSiblings]: #virtualchassissiblings #### [virtualChassisSiblings] Information regarding the virtual chassis siblings for a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1516,7 +1662,8 @@ Information regarding the virtual chassis siblings for a piece of hardware. [virtualHost]: #virtualhost #### [virtualHost] A piece of hardware's virtual host record. -Type: **SoftLayer_Virtual_Host ** +Type: **SoftLayer_Virtual_Host ** + @@ -1526,7 +1673,8 @@ A piece of hardware's virtual host record. [virtualLicenses]: #virtuallicenses #### [virtualLicenses] Information regarding a piece of hardware's virtual software licenses. -Type: **SoftLayer_Software_VirtualLicense[] ** +Type: **SoftLayer_Software_VirtualLicense[] ** + @@ -1536,7 +1684,8 @@ Information regarding a piece of hardware's virtual software licenses. [virtualRack]: #virtualrack #### [virtualRack] Information regarding the bandwidth allotment to which a piece of hardware belongs. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** + @@ -1546,7 +1695,8 @@ Information regarding the bandwidth allotment to which a piece of hardware belon [virtualRackId]: #virtualrackid #### [virtualRackId] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **integer** +Type: **integer** + @@ -1556,7 +1706,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualRackName]: #virtualrackname #### [virtualRackName] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **string** +Type: **string** + @@ -1566,7 +1717,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualizationPlatform]: #virtualizationplatform #### [virtualizationPlatform] A piece of hardware's virtualization platform software. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -1578,7 +1730,8 @@ A piece of hardware's virtualization platform software. [activeComponentCount]: #activecomponentcount #### [activeComponentCount] A count of a piece of hardware's active physical components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1588,7 +1741,8 @@ A count of a piece of hardware's active physical components. [activeNetworkMonitorIncidentCount]: #activenetworkmonitorincidentcount #### [activeNetworkMonitorIncidentCount] A count of a piece of hardware's active network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -1598,7 +1752,8 @@ A count of a piece of hardware's active network monitoring incidents. [allPowerComponentCount]: #allpowercomponentcount #### [allPowerComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1608,7 +1763,8 @@ A count of [allowedNetworkStorageCount]: #allowednetworkstoragecount #### [allowedNetworkStorageCount] A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1618,7 +1774,8 @@ A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware ha [allowedNetworkStorageReplicaCount]: #allowednetworkstoragereplicacount #### [allowedNetworkStorageReplicaCount] A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1628,7 +1785,8 @@ A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLay [attributeCount]: #attributecount #### [attributeCount] A count of information regarding a piece of hardware's specific attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -1638,7 +1796,8 @@ A count of information regarding a piece of hardware's specific attributes. [backendNetworkComponentCount]: #backendnetworkcomponentcount #### [backendNetworkComponentCount] A count of a piece of hardware's back-end or private network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1648,7 +1807,8 @@ A count of a piece of hardware's back-end or private network components. [backendRouterCount]: #backendroutercount #### [backendRouterCount] A count of a hardware's backend or private router. -Type: **unsigned long** +Type: **unsigned long** + @@ -1658,7 +1818,8 @@ A count of a hardware's backend or private router. [benchmarkCertificationCount]: #benchmarkcertificationcount #### [benchmarkCertificationCount] A count of information regarding a piece of hardware's benchmark certifications. -Type: **unsigned long** +Type: **unsigned long** + @@ -1668,7 +1829,8 @@ A count of information regarding a piece of hardware's benchmark certifications. [childrenHardwareCount]: #childrenhardwarecount #### [childrenHardwareCount] A count of child hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1678,7 +1840,8 @@ A count of child hardware. [componentCount]: #componentcount #### [componentCount] A count of a piece of hardware's components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1688,7 +1851,8 @@ A count of a piece of hardware's components. [downlinkHardwareCount]: #downlinkhardwarecount #### [downlinkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1698,7 +1862,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkNetworkHardwareCount]: #downlinknetworkhardwarecount #### [downlinkNetworkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1708,7 +1873,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkServerCount]: #downlinkservercount #### [downlinkServerCount] A count of information regarding all servers attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1718,7 +1884,8 @@ A count of information regarding all servers attached to a piece of network hard [downlinkVirtualGuestCount]: #downlinkvirtualguestcount #### [downlinkVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1728,7 +1895,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [downstreamHardwareBindingCount]: #downstreamhardwarebindingcount #### [downstreamHardwareBindingCount] A count of all hardware downstream from a network device. -Type: **unsigned long** +Type: **unsigned long** + @@ -1738,7 +1906,8 @@ A count of all hardware downstream from a network device. [downstreamNetworkHardwareCount]: #downstreamnetworkhardwarecount #### [downstreamNetworkHardwareCount] A count of all network hardware downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1748,7 +1917,8 @@ A count of all network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidentCount]: #downstreamnetworkhardwarewithincidentcount #### [downstreamNetworkHardwareWithIncidentCount] A count of all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1758,7 +1928,8 @@ A count of all network hardware with monitoring warnings or errors that are down [downstreamServerCount]: #downstreamservercount #### [downstreamServerCount] A count of information regarding all servers attached downstream to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1768,7 +1939,8 @@ A count of information regarding all servers attached downstream to a piece of n [downstreamVirtualGuestCount]: #downstreamvirtualguestcount #### [downstreamVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1778,7 +1950,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [driveControllerCount]: #drivecontrollercount #### [driveControllerCount] A count of the drive controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1788,7 +1961,8 @@ A count of the drive controllers contained within a piece of hardware. [evaultNetworkStorageCount]: #evaultnetworkstoragecount #### [evaultNetworkStorageCount] A count of information regarding a piece of hardware's associated EVault network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -1798,7 +1972,8 @@ A count of information regarding a piece of hardware's associated EVault network [frontendNetworkComponentCount]: #frontendnetworkcomponentcount #### [frontendNetworkComponentCount] A count of a piece of hardware's front-end or public network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1808,7 +1983,8 @@ A count of a piece of hardware's front-end or public network components. [frontendRouterCount]: #frontendroutercount #### [frontendRouterCount] A count of a hardware's frontend or public router. -Type: **unsigned long** +Type: **unsigned long** + @@ -1818,7 +1994,8 @@ A count of a hardware's frontend or public router. [hardDriveCount]: #harddrivecount #### [hardDriveCount] A count of the hard drives contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1828,7 +2005,8 @@ A count of the hard drives contained within a piece of hardware. [memoryCount]: #memorycount #### [memoryCount] A count of information regarding a piece of hardware's memory. -Type: **unsigned long** +Type: **unsigned long** + @@ -1838,7 +2016,8 @@ A count of information regarding a piece of hardware's memory. [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1848,7 +2027,8 @@ A count of [networkCardCount]: #networkcardcount #### [networkCardCount] A count of information regarding a piece of hardware's network cards. -Type: **unsigned long** +Type: **unsigned long** + @@ -1858,7 +2038,8 @@ A count of information regarding a piece of hardware's network cards. [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of returns a hardware's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1868,7 +2049,8 @@ A count of returns a hardware's network components. [networkMonitorAttachedDownHardwareCount]: #networkmonitorattacheddownhardwarecount #### [networkMonitorAttachedDownHardwareCount] A count of all servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1878,7 +2060,8 @@ A count of all servers with failed monitoring that are attached downstream to a [networkMonitorAttachedDownVirtualGuestCount]: #networkmonitorattacheddownvirtualguestcount #### [networkMonitorAttachedDownVirtualGuestCount] A count of virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **unsigned long** +Type: **unsigned long** + @@ -1888,7 +2071,8 @@ A count of virtual guests that are attached downstream to a hardware that have f [networkMonitorCount]: #networkmonitorcount #### [networkMonitorCount] A count of information regarding a piece of hardware's network monitors. -Type: **unsigned long** +Type: **unsigned long** + @@ -1898,7 +2082,8 @@ A count of information regarding a piece of hardware's network monitors. [networkMonitorIncidentCount]: #networkmonitorincidentcount #### [networkMonitorIncidentCount] A count of the status of all of a piece of hardware's network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -1908,7 +2093,8 @@ A count of the status of all of a piece of hardware's network monitoring inciden [networkStorageCount]: #networkstoragecount #### [networkStorageCount] A count of information regarding a piece of hardware's associated network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -1918,7 +2104,8 @@ A count of information regarding a piece of hardware's associated network storag [networkVlanCount]: #networkvlancount #### [networkVlanCount] A count of the network virtual LANs (VLANs) associated with a piece of hardware's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1928,7 +2115,8 @@ A count of the network virtual LANs (VLANs) associated with a piece of hardware' [notesHistoryCount]: #noteshistorycount #### [notesHistoryCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1938,7 +2126,8 @@ A count of [nvRamComponentModelCount]: #nvramcomponentmodelcount #### [nvRamComponentModelCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1948,7 +2137,8 @@ A count of [powerComponentCount]: #powercomponentcount #### [powerComponentCount] A count of the power components for a hardware object. -Type: **unsigned long** +Type: **unsigned long** + @@ -1958,7 +2148,8 @@ A count of the power components for a hardware object. [powerSupplyCount]: #powersupplycount #### [powerSupplyCount] A count of information regarding a piece of hardware's power supply. -Type: **unsigned long** +Type: **unsigned long** + @@ -1968,7 +2159,8 @@ A count of information regarding a piece of hardware's power supply. [processorCount]: #processorcount #### [processorCount] A count of information regarding a piece of hardware's processors. -Type: **unsigned long** +Type: **unsigned long** + @@ -1978,7 +2170,8 @@ A count of information regarding a piece of hardware's processors. [raidControllerCount]: #raidcontrollercount #### [raidControllerCount] A count of the RAID controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1988,7 +2181,8 @@ A count of the RAID controllers contained within a piece of hardware. [recentEventCount]: #recenteventcount #### [recentEventCount] A count of recent events that impact this hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1998,7 +2192,8 @@ A count of recent events that impact this hardware. [remoteManagementAccountCount]: #remotemanagementaccountcount #### [remoteManagementAccountCount] A count of user credentials to issue commands and/or interact with the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -2008,7 +2203,8 @@ A count of user credentials to issue commands and/or interact with the server's [resourceConfigurationCount]: #resourceconfigurationcount #### [resourceConfigurationCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2018,7 +2214,8 @@ A count of [resourceGroupCount]: #resourcegroupcount #### [resourceGroupCount] A count of the resource groups in which this hardware is a member. -Type: **unsigned long** +Type: **unsigned long** + @@ -2028,7 +2225,8 @@ A count of the resource groups in which this hardware is a member. [resourceGroupMemberReferenceCount]: #resourcegroupmemberreferencecount #### [resourceGroupMemberReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2038,7 +2236,8 @@ A count of [resourceGroupRoleCount]: #resourcegrouprolecount #### [resourceGroupRoleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2048,7 +2247,8 @@ A count of [routerCount]: #routercount #### [routerCount] A count of a hardware's routers. -Type: **unsigned long** +Type: **unsigned long** + @@ -2058,7 +2258,8 @@ A count of a hardware's routers. [scaleAssetCount]: #scaleassetcount #### [scaleAssetCount] A count of collection of scale assets this hardware corresponds to. -Type: **unsigned long** +Type: **unsigned long** + @@ -2068,7 +2269,8 @@ A count of collection of scale assets this hardware corresponds to. [securityScanRequestCount]: #securityscanrequestcount #### [securityScanRequestCount] A count of information regarding a piece of hardware's vulnerability scan requests. -Type: **unsigned long** +Type: **unsigned long** + @@ -2078,7 +2280,8 @@ A count of information regarding a piece of hardware's vulnerability scan reques [softwareComponentCount]: #softwarecomponentcount #### [softwareComponentCount] A count of information regarding a piece of hardware's installed software. -Type: **unsigned long** +Type: **unsigned long** + @@ -2088,7 +2291,8 @@ A count of information regarding a piece of hardware's installed software. [sshKeyCount]: #sshkeycount #### [sshKeyCount] A count of sSH keys to be installed on the server during provisioning or an OS reload. -Type: **unsigned long** +Type: **unsigned long** + @@ -2098,7 +2302,8 @@ A count of sSH keys to be installed on the server during provisioning or an OS r [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2108,7 +2313,8 @@ A count of [storageNetworkComponentCount]: #storagenetworkcomponentcount #### [storageNetworkComponentCount] A count of a piece of hardware's private storage network components. [Deprecated] -Type: **unsigned long** +Type: **unsigned long** + @@ -2118,7 +2324,8 @@ A count of a piece of hardware's private storage network components. [Deprecated [tagReferenceCount]: #tagreferencecount #### [tagReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2128,7 +2335,8 @@ A count of [uplinkNetworkComponentCount]: #uplinknetworkcomponentcount #### [uplinkNetworkComponentCount] A count of information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **unsigned long** +Type: **unsigned long** + @@ -2138,7 +2346,8 @@ A count of information regarding the network component that is one level higher [userDataCount]: #userdatacount #### [userDataCount] A count of an array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **unsigned long** +Type: **unsigned long** + @@ -2148,7 +2357,8 @@ A count of an array containing a single string of custom user data for a hardwar [virtualChassisSiblingCount]: #virtualchassissiblingcount #### [virtualChassisSiblingCount] A count of information regarding the virtual chassis siblings for a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2158,7 +2368,8 @@ A count of information regarding the virtual chassis siblings for a piece of har [virtualLicenseCount]: #virtuallicensecount #### [virtualLicenseCount] A count of information regarding a piece of hardware's virtual software licenses. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Attribute/_index.md index d932ce8623..66a4973e37 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Attribute/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Attribute type contains general information for a hardwar [hardwareAttributeTypeId]: #hardwareattributetypeid #### [hardwareAttributeTypeId] The unique identifier of a hardware attribute's type. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The unique identifier of a hardware attribute's type. [id]: #id #### [id] A hardware attribute's unique identifier. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A hardware attribute's unique identifier. [value]: #value #### [value] A hardware attribute's value. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A hardware attribute's value. [hardwareAttributeType]: #hardwareattributetype #### [hardwareAttributeType] The type of hardware attribute that this represents. -Type: **SoftLayer_Hardware_Attribute_Type ** +Type: **SoftLayer_Hardware_Attribute_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Attribute_Type/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Attribute_Type/_index.md index 87adcb034d..7bbb52a397 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Attribute_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Attribute_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Retrieve attributes associated with a hardware object. @@ -45,7 +47,8 @@ Retrieve attributes associated with a hardware object. [keyname]: #keyname #### [keyname] The attribute type key name or code. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The attribute type key name or code. [name]: #name #### [name] The attribute type name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Attribute_UserData/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Attribute_UserData/_index.md index 522dc337fb..9ee08986d0 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Attribute_UserData/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Attribute_UserData/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -51,7 +53,8 @@ classes: [hardwareAttributeType]: #hardwareattributetype #### [hardwareAttributeType] The type of hardware attribute that this represents. -Type: **SoftLayer_Hardware_Attribute_Type ** +Type: **SoftLayer_Hardware_Attribute_Type ** +
      diff --git a/content/reference/datatypes/SoftLayer_Hardware_Benchmark_Certification/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Benchmark_Certification/_index.md index 9f9abc27e4..575626388f 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Benchmark_Certification/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Benchmark_Certification/_index.md @@ -18,6 +18,8 @@ classes:
      ## Description + + The SoftLayer_Hardware_Benchmark_Certification data type contains general information relating to a single SoftLayer hardware benchmark certification document. @@ -50,7 +52,8 @@ The SoftLayer_Hardware_Benchmark_Certification data type contains general inform [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account associated with a benchmark certification result. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ The internal identifier of the SoftLayer customer account associated with a benc [createDate]: #createdate #### [createDate] The date that a benchmark certification result was generated. -Type: **dateTime** +Type: **dateTime** + @@ -70,7 +74,8 @@ The date that a benchmark certification result was generated. [hardwareId]: #hardwareid #### [hardwareId] A benchmark certification results's associated hardware's internal identification number. -Type: **integer** +Type: **integer** + @@ -86,7 +91,8 @@ A benchmark certification results's associated hardware's internal identificatio [account]: #account #### [account] Information regarding a benchmark certification result's associated SoftLayer customer account. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -96,7 +102,8 @@ Information regarding a benchmark certification result's associated SoftLayer cu [hardware]: #hardware #### [hardware] Information regarding the piece of hardware on which a benchmark certification test was performed. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Blade/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Blade/_index.md index 9ec0ecc5c7..76ef7a9393 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Blade/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Blade/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
      @@ -55,7 +58,8 @@ classes: [disabled]: #disabled #### [disabled] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [hardwareChildId]: #hardwarechildid #### [hardwareChildId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [hardwareParentId]: #hardwareparentid #### [hardwareParentId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ classes: [name]: #name #### [name] The name of this blade as referenced by the operating system. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The name of this blade as referenced by the operating system. [hardwareChild]: #hardwarechild #### [hardwareChild] -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -131,7 +141,8 @@ The name of this blade as referenced by the operating system. [hardwareParent]: #hardwareparent #### [hardwareParent] -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Chassis/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Chassis/_index.md index 938a83f541..86febe5f36 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Chassis/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Chassis/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -58,7 +60,8 @@ Every piece of hardware in SoftLayer's datacenters, including customer servers, [formFactorId]: #formfactorid #### [formFactorId] A hardware form factor internal identifier. -Type: **integer** +Type: **integer** + @@ -68,7 +71,8 @@ A hardware form factor internal identifier. [id]: #id #### [id] A hardware chassis' internal identifier. -Type: **integer** +Type: **integer** + @@ -78,7 +82,8 @@ A hardware chassis' internal identifier. [manufacturer]: #manufacturer #### [manufacturer] A hardware chassis' manufacturer. -Type: **string** +Type: **string** + @@ -88,7 +93,8 @@ A hardware chassis' manufacturer. [name]: #name #### [name] A hardware chassis' name. -Type: **string** +Type: **string** + @@ -98,7 +104,8 @@ A hardware chassis' name. [unitSize]: #unitsize #### [unitSize] The physical size of a hardware chassis. Currently this relates to the 'U' size of a chassis buy default. -Type: **integer** +Type: **integer** + @@ -108,7 +115,8 @@ The physical size of a hardware chassis. Currently this relates to the 'U' size [version]: #version #### [version] A hardware chassis' revision number. -Type: **string** +Type: **string** + @@ -124,7 +132,8 @@ A hardware chassis' revision number. [backplaneCapacity]: #backplanecapacity #### [backplaneCapacity] -Type: **string** +Type: **string** + @@ -134,7 +143,8 @@ A hardware chassis' revision number. [bayCapacity]: #baycapacity #### [bayCapacity] -Type: **string** +Type: **string** + @@ -144,7 +154,8 @@ A hardware chassis' revision number. [driveCapacity]: #drivecapacity #### [driveCapacity] -Type: **string** +Type: **string** + @@ -154,7 +165,8 @@ A hardware chassis' revision number. [driveControllerCapacity]: #drivecontrollercapacity #### [driveControllerCapacity] -Type: **string** +Type: **string** + @@ -164,7 +176,8 @@ A hardware chassis' revision number. [gpuCapacity]: #gpucapacity #### [gpuCapacity] -Type: **string** +Type: **string** + @@ -174,7 +187,8 @@ A hardware chassis' revision number. [hardwareFunction]: #hardwarefunction #### [hardwareFunction] A hardware's function. -Type: **SoftLayer_Hardware_Function ** +Type: **SoftLayer_Hardware_Function ** + @@ -184,7 +198,8 @@ A hardware's function. [moduleCapacity]: #modulecapacity #### [moduleCapacity] -Type: **string** +Type: **string** + @@ -194,7 +209,8 @@ A hardware's function. [powerCapacity]: #powercapacity #### [powerCapacity] -Type: **string** +Type: **string** + @@ -204,7 +220,8 @@ A hardware's function. [u2Capacity]: #u2capacity #### [u2Capacity] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component/_index.md index fed84cd981..1bc0a54218 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component data type abstracts information related to a hardware component. @@ -62,7 +64,8 @@ The SoftLayer_Hardware_Component data type abstracts information related to a ha [hardwareComponentModelId]: #hardwarecomponentmodelid #### [hardwareComponentModelId] The internal identifier of a hardware component's component model. -Type: **integer** +Type: **integer** + @@ -72,7 +75,8 @@ The internal identifier of a hardware component's component model. [hardwareId]: #hardwareid #### [hardwareId] The internal identifier of the hardware that a hardware component resides inside. -Type: **integer** +Type: **integer** + @@ -82,7 +86,8 @@ The internal identifier of the hardware that a hardware component resides inside [id]: #id #### [id] A hardware component's internal identifier. -Type: **integer** +Type: **integer** + @@ -92,7 +97,8 @@ A hardware component's internal identifier. [modifyDate]: #modifydate #### [modifyDate] The date that a hardware component was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -102,7 +108,8 @@ The date that a hardware component was last modified. [name]: #name #### [name] The name of this component as referenced by the operating system. -Type: **string** +Type: **string** + @@ -112,7 +119,8 @@ The name of this component as referenced by the operating system. [serialNumber]: #serialnumber #### [serialNumber] The component serial number. -Type: **string** +Type: **string** + @@ -122,7 +130,8 @@ The component serial number. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -138,7 +147,8 @@ A hardware's internal identification number at its service provider [capacity]: #capacity #### [capacity] A component's capacity. -Type: **decimal** +Type: **decimal** + @@ -148,7 +158,8 @@ A component's capacity. [children]: #children #### [children] A components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -158,7 +169,8 @@ A components sub components. Devices that are usually integrated or in some way [componentRevision]: #componentrevision #### [componentRevision] A component's Revision. -Type: **string** +Type: **string** + @@ -168,7 +180,8 @@ A component's Revision. [downlinkHardwareComponents]: #downlinkhardwarecomponents #### [downlinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -178,7 +191,8 @@ A component's Revision. [hardware]: #hardware #### [hardware] The hardware object that this component belongs to. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -188,7 +202,8 @@ The hardware object that this component belongs to. [hardwareComponentModel]: #hardwarecomponentmodel #### [hardwareComponentModel] The general group of component models. -Type: **SoftLayer_Hardware_Component_Model ** +Type: **SoftLayer_Hardware_Component_Model ** + @@ -198,7 +213,8 @@ The general group of component models. [hardwareComponentType]: #hardwarecomponenttype #### [hardwareComponentType] A components type. -Type: **SoftLayer_Hardware_Component_Type ** +Type: **SoftLayer_Hardware_Component_Type ** + @@ -208,7 +224,8 @@ A components type. [isChildModule]: #ischildmodule #### [isChildModule] -Type: **boolean** +Type: **boolean** + @@ -218,7 +235,8 @@ A components type. [logicalVolumeStorageGroups]: #logicalvolumestoragegroups #### [logicalVolumeStorageGroups] Returns the associated logic volume storage groups for the hardware component. -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + @@ -228,7 +246,8 @@ Returns the associated logic volume storage groups for the hardware component. [m2SataSlotCapacity]: #m2sataslotcapacity #### [m2SataSlotCapacity] A component's M.2 SATA capacity. -Type: **string** +Type: **string** + @@ -238,7 +257,8 @@ A component's M.2 SATA capacity. [moduleComponents]: #modulecomponents #### [moduleComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -248,7 +268,8 @@ The module's hardware components [moduleHardwareComponents]: #modulehardwarecomponents #### [moduleHardwareComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -258,7 +279,8 @@ The module's hardware components [moduleNetworkComponents]: #modulenetworkcomponents #### [moduleNetworkComponents] The module's network components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -268,7 +290,8 @@ The module's network components [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -278,7 +301,8 @@ The module's network components [networkComponents]: #networkcomponents #### [networkComponents] The components local ethernet and remote management interfaces -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -288,7 +312,8 @@ The components local ethernet and remote management interfaces [owner]: #owner #### [owner] The account this component belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -298,7 +323,8 @@ The account this component belongs to. [parent]: #parent #### [parent] A components parent. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -308,7 +334,8 @@ A components parent. Devices that are usually integrated or in some way attached [parentModule]: #parentmodule #### [parentModule] -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -318,7 +345,8 @@ A components parent. Devices that are usually integrated or in some way attached [prefixAttribute]: #prefixattribute #### [prefixAttribute] -Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** +Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** + @@ -328,7 +356,8 @@ A components parent. Devices that are usually integrated or in some way attached [raidMode]: #raidmode #### [raidMode] A RAID controllers RAID mode. -Type: **string** +Type: **string** + @@ -338,7 +367,8 @@ A RAID controllers RAID mode. [revision]: #revision #### [revision] The component revision designation. -Type: **SoftLayer_Hardware_Component_Revision ** +Type: **SoftLayer_Hardware_Component_Revision ** + @@ -348,7 +378,8 @@ The component revision designation. [serviceProvider]: #serviceprovider #### [serviceProvider] -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -358,7 +389,8 @@ The component revision designation. [uplinkHardwareComponents]: #uplinkhardwarecomponents #### [uplinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -370,7 +402,8 @@ The component revision designation. [childrenCount]: #childrencount #### [childrenCount] A count of a components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **unsigned long** +Type: **unsigned long** + @@ -380,7 +413,8 @@ A count of a components sub components. Devices that are usually integrated or i [downlinkHardwareComponentCount]: #downlinkhardwarecomponentcount #### [downlinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -390,7 +424,8 @@ A count of [logicalVolumeStorageGroupCount]: #logicalvolumestoragegroupcount #### [logicalVolumeStorageGroupCount] A count of returns the associated logic volume storage groups for the hardware component. -Type: **unsigned long** +Type: **unsigned long** + @@ -400,7 +435,8 @@ A count of returns the associated logic volume storage groups for the hardware c [moduleComponentCount]: #modulecomponentcount #### [moduleComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -410,7 +446,8 @@ A count of the module's hardware components [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -420,7 +457,8 @@ A count of [moduleHardwareComponentCount]: #modulehardwarecomponentcount #### [moduleHardwareComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -430,7 +468,8 @@ A count of the module's hardware components [moduleNetworkComponentCount]: #modulenetworkcomponentcount #### [moduleNetworkComponentCount] A count of the module's network components -Type: **unsigned long** +Type: **unsigned long** + @@ -440,7 +479,8 @@ A count of the module's network components [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of the components local ethernet and remote management interfaces -Type: **unsigned long** +Type: **unsigned long** + @@ -450,7 +490,8 @@ A count of the components local ethernet and remote management interfaces [uplinkHardwareComponentCount]: #uplinkhardwarecomponentcount #### [uplinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Attribute/_index.md index e64a929eaa..0d6c819b92 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Attribute/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_Attribute data type contains general informatio [hardwareComponentAttributeTypeId]: #hardwarecomponentattributetypeid #### [hardwareComponentAttributeTypeId] A hardware component attribute's associated [SoftLayer_Hardware_Component_Attribute_Type]({{}}) Id. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ A hardware component attribute's associated [SoftLayer_Hardware_Component_Attrib [hardwareComponentId]: #hardwarecomponentid #### [hardwareComponentId] A hardware component attribute's associated [SoftLayer_Hardware_Component]({{}}) Id. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A hardware component attribute's associated [SoftLayer_Hardware_Component]({{}}). -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A hardware component attribute's value. A value can have many different values [hardwareComponent]: #hardwarecomponent #### [hardwareComponent] A hardware component attribute's associated [SoftLayer_Hardware_Component]({{}}). -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -91,7 +97,8 @@ A hardware component attribute's associated [SoftLayer_Hardware_Component]({{}}). -Type: **SoftLayer_Hardware_Component_Attribute_Type ** +Type: **SoftLayer_Hardware_Component_Attribute_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Attribute_Type/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Attribute_Type/_index.md index 726b7b468b..9bee425183 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Attribute_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Attribute_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component_Attribute_Type data type contains general information for the type of an attribute for a hardware component. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_Attribute_Type data type contains general infor [description]: #description #### [description] The description for the date that a hardware component attribute type's [SoftLayer_Hardware_Component_Attribute]({{}}) contains. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The description for the date that a hardware component attribute type's [SoftLay [id]: #id #### [id] A hardware component attribute type's Id. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A hardware component attribute type's Id. [keyName]: #keyname #### [keyName] A hardware component attribute type's unique name. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A hardware component attribute type's unique name. [name]: #name #### [name] A hardware component attribute type's name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_DriveController/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_DriveController/_index.md index 9ced499844..7c16ee8a59 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_DriveController/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_DriveController/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component_DriveController data type abstracts information related to a drive controller. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_DriveController data type abstracts information [hardwareComponentModelId]: #hardwarecomponentmodelid #### [hardwareComponentModelId] The internal identifier of a hardware component's component model. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of a hardware component's component model. [hardwareId]: #hardwareid #### [hardwareId] The internal identifier of the hardware that a hardware component resides inside. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The internal identifier of the hardware that a hardware component resides inside [id]: #id #### [id] A hardware component's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A hardware component's internal identifier. [modifyDate]: #modifydate #### [modifyDate] The date that a hardware component was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The date that a hardware component was last modified. [name]: #name #### [name] The name of this component as referenced by the operating system. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The name of this component as referenced by the operating system. [serialNumber]: #serialnumber #### [serialNumber] The component serial number. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The component serial number. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ A hardware's internal identification number at its service provider [capacity]: #capacity #### [capacity] A component's capacity. -Type: **decimal** +Type: **decimal** + @@ -131,7 +141,8 @@ A component's capacity. [children]: #children #### [children] A components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -141,7 +152,8 @@ A components sub components. Devices that are usually integrated or in some way [componentRevision]: #componentrevision #### [componentRevision] A component's Revision. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ A component's Revision. [downlinkHardwareComponents]: #downlinkhardwarecomponents #### [downlinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -161,7 +174,8 @@ A component's Revision. [hardware]: #hardware #### [hardware] The hardware object that this component belongs to. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -171,7 +185,8 @@ The hardware object that this component belongs to. [hardwareComponentModel]: #hardwarecomponentmodel #### [hardwareComponentModel] The general group of component models. -Type: **SoftLayer_Hardware_Component_Model ** +Type: **SoftLayer_Hardware_Component_Model ** + @@ -181,7 +196,8 @@ The general group of component models. [hardwareComponentType]: #hardwarecomponenttype #### [hardwareComponentType] A components type. -Type: **SoftLayer_Hardware_Component_Type ** +Type: **SoftLayer_Hardware_Component_Type ** + @@ -191,7 +207,8 @@ A components type. [isChildModule]: #ischildmodule #### [isChildModule] -Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ A components type. [logicalVolumeStorageGroups]: #logicalvolumestoragegroups #### [logicalVolumeStorageGroups] Returns the associated logic volume storage groups for the hardware component. -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + @@ -211,7 +229,8 @@ Returns the associated logic volume storage groups for the hardware component. [m2SataSlotCapacity]: #m2sataslotcapacity #### [m2SataSlotCapacity] A component's M.2 SATA capacity. -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ A component's M.2 SATA capacity. [moduleComponents]: #modulecomponents #### [moduleComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -231,7 +251,8 @@ The module's hardware components [moduleHardwareComponents]: #modulehardwarecomponents #### [moduleHardwareComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -241,7 +262,8 @@ The module's hardware components [moduleNetworkComponents]: #modulenetworkcomponents #### [moduleNetworkComponents] The module's network components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -251,7 +273,8 @@ The module's network components [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -261,7 +284,8 @@ The module's network components [networkComponents]: #networkcomponents #### [networkComponents] The components local ethernet and remote management interfaces -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -271,7 +295,8 @@ The components local ethernet and remote management interfaces [owner]: #owner #### [owner] The account this component belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -281,7 +306,8 @@ The account this component belongs to. [parent]: #parent #### [parent] A components parent. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -291,7 +317,8 @@ A components parent. Devices that are usually integrated or in some way attached [parentModule]: #parentmodule #### [parentModule] -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -301,7 +328,8 @@ A components parent. Devices that are usually integrated or in some way attached [prefixAttribute]: #prefixattribute #### [prefixAttribute] -Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** +Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** + @@ -311,7 +339,8 @@ A components parent. Devices that are usually integrated or in some way attached [raidMode]: #raidmode #### [raidMode] A RAID controllers RAID mode. -Type: **string** +Type: **string** + @@ -321,7 +350,8 @@ A RAID controllers RAID mode. [revision]: #revision #### [revision] The component revision designation. -Type: **SoftLayer_Hardware_Component_Revision ** +Type: **SoftLayer_Hardware_Component_Revision ** + @@ -331,7 +361,8 @@ The component revision designation. [serviceProvider]: #serviceprovider #### [serviceProvider] -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -341,7 +372,8 @@ The component revision designation. [uplinkHardwareComponents]: #uplinkhardwarecomponents #### [uplinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -353,7 +385,8 @@ The component revision designation. [childrenCount]: #childrencount #### [childrenCount] A count of a components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **unsigned long** +Type: **unsigned long** + @@ -363,7 +396,8 @@ A count of a components sub components. Devices that are usually integrated or i [downlinkHardwareComponentCount]: #downlinkhardwarecomponentcount #### [downlinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -373,7 +407,8 @@ A count of [logicalVolumeStorageGroupCount]: #logicalvolumestoragegroupcount #### [logicalVolumeStorageGroupCount] A count of returns the associated logic volume storage groups for the hardware component. -Type: **unsigned long** +Type: **unsigned long** + @@ -383,7 +418,8 @@ A count of returns the associated logic volume storage groups for the hardware c [moduleComponentCount]: #modulecomponentcount #### [moduleComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -393,7 +429,8 @@ A count of the module's hardware components [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -403,7 +440,8 @@ A count of [moduleHardwareComponentCount]: #modulehardwarecomponentcount #### [moduleHardwareComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -413,7 +451,8 @@ A count of the module's hardware components [moduleNetworkComponentCount]: #modulenetworkcomponentcount #### [moduleNetworkComponentCount] A count of the module's network components -Type: **unsigned long** +Type: **unsigned long** + @@ -423,7 +462,8 @@ A count of the module's network components [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of the components local ethernet and remote management interfaces -Type: **unsigned long** +Type: **unsigned long** + @@ -433,7 +473,8 @@ A count of the components local ethernet and remote management interfaces [uplinkHardwareComponentCount]: #uplinkhardwarecomponentcount #### [uplinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Firmware/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Firmware/_index.md index f546df1138..a27cf42017 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Firmware/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Firmware/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [buildDate]: #builddate #### [buildDate] -Type: **dateTime** +Type: **dateTime** +
      @@ -55,7 +58,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
      @@ -65,7 +69,8 @@ classes: [hardwareComponentModelId]: #hardwarecomponentmodelid #### [hardwareComponentModelId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [isQualified]: #isqualified #### [isQualified] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [releaseNotes]: #releasenotes #### [releaseNotes] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ classes: [severity]: #severity #### [severity] -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ classes: [version]: #version #### [version] -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ classes: [attributes]: #attributes #### [attributes] -Type: **SoftLayer_Hardware_Component_Firmware_Attribute[] ** +Type: **SoftLayer_Hardware_Component_Firmware_Attribute[] ** + @@ -141,7 +152,8 @@ classes: [hardwareComponentModel]: #hardwarecomponentmodel #### [hardwareComponentModel] The Hardware Component Model this Firmware applies to. -Type: **SoftLayer_Hardware_Component_Model ** +Type: **SoftLayer_Hardware_Component_Model ** + @@ -151,7 +163,8 @@ The Hardware Component Model this Firmware applies to. [qualificationType]: #qualificationtype #### [qualificationType] -Type: **SoftLayer_Hardware_Component_Firmware_QualificationTypes ** +Type: **SoftLayer_Hardware_Component_Firmware_QualificationTypes ** + @@ -161,7 +174,8 @@ The Hardware Component Model this Firmware applies to. [revisions]: #revisions #### [revisions] All revisions of this firmware. -Type: **SoftLayer_Hardware_Component_Revision[] ** +Type: **SoftLayer_Hardware_Component_Revision[] ** + @@ -173,7 +187,8 @@ All revisions of this firmware. [attributeCount]: #attributecount #### [attributeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of [revisionCount]: #revisioncount #### [revisionCount] A count of all revisions of this firmware. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Firmware_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Firmware_Attribute/_index.md index cc17c8259d..c7906433d4 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Firmware_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Firmware_Attribute/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component_Firmware_Attribute data type contains general information for a hardware model's firmware. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_Firmware_Attribute data type contains general i [firmwareId]: #firmwareid #### [firmwareId] A hardware component firmware attribute's firmware Id. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ A hardware component firmware attribute's firmware Id. [id]: #id #### [id] A hardware component firmware attribute's Id. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A hardware component firmware attribute's Id. [typeId]: #typeid #### [typeId] A hardware component firmware attribute's type Id. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A hardware component firmware attribute's type Id. [value]: #value #### [value] A hardware component firmware attribute's value. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A hardware component firmware attribute's value. [firmware]: #firmware #### [firmware] A hardware component firmware attribute's associated [SoftLayer_Hardware_Component_Firmware]({{}}). -Type: **SoftLayer_Hardware_Component_Firmware ** +Type: **SoftLayer_Hardware_Component_Firmware ** + @@ -101,7 +108,8 @@ A hardware component firmware attribute's associated [SoftLayer_Hardware_Compone [type]: #type #### [type] A hardware component firmware attribute's associated [SoftLayer_Hardware_Component_Firmware_Attribute_Type]({{}}). -Type: **SoftLayer_Hardware_Component_Firmware_Attribute_Type ** +Type: **SoftLayer_Hardware_Component_Firmware_Attribute_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Firmware_Attribute_Type/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Firmware_Attribute_Type/_index.md index db51fea2c2..746542c553 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Firmware_Attribute_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Firmware_Attribute_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component_Firmware_Attribute_Type data type defines attribute types for a hardware component model's firmware. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_Firmware_Attribute_Type data type defines attri [description]: #description #### [description] The description for the date that a hardware component attribute type's [SoftLayer_Hardware_Component_Attribute]({{}}) contains. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The description for the date that a hardware component attribute type's [SoftLay [id]: #id #### [id] A hardware component firmware attribute type's Id. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A hardware component firmware attribute type's Id. [keyName]: #keyname #### [keyName] A hardware component firmware attribute type's unique name. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A hardware component firmware attribute type's unique name. [name]: #name #### [name] A hardware component firmware attribute type's name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Firmware_QualificationTypes/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Firmware_QualificationTypes/_index.md index a655a81ff6..99b8eb4289 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Firmware_QualificationTypes/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Firmware_QualificationTypes/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component_Firmware_QualificationTypes data type describes the current qualification status for a particular firmware. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_Firmware_QualificationTypes data type describes [description]: #description #### [description] A description about the qualificationType. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ A description about the qualificationType. [id]: #id #### [id] The Id of the qualificationType. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The Id of the qualificationType. [keyName]: #keyname #### [keyName] KeyName representation for the qualificationType. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ KeyName representation for the qualificationType. [name]: #name #### [name] The qualificationType name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_HardDrive/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_HardDrive/_index.md index 52fba399df..08359be0b4 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_HardDrive/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_HardDrive/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component_HardDrive data type abstracts information related to a hard drive. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_HardDrive data type abstracts information relat [hardwareComponentModelId]: #hardwarecomponentmodelid #### [hardwareComponentModelId] The internal identifier of a hardware component's component model. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of a hardware component's component model. [hardwareId]: #hardwareid #### [hardwareId] The internal identifier of the hardware that a hardware component resides inside. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The internal identifier of the hardware that a hardware component resides inside [id]: #id #### [id] A hardware component's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A hardware component's internal identifier. [modifyDate]: #modifydate #### [modifyDate] The date that a hardware component was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The date that a hardware component was last modified. [name]: #name #### [name] The name of this component as referenced by the operating system. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The name of this component as referenced by the operating system. [serialNumber]: #serialnumber #### [serialNumber] The component serial number. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The component serial number. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ A hardware's internal identification number at its service provider [capacity]: #capacity #### [capacity] A component's capacity. -Type: **decimal** +Type: **decimal** + @@ -131,7 +141,8 @@ A component's capacity. [children]: #children #### [children] A components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -141,7 +152,8 @@ A components sub components. Devices that are usually integrated or in some way [componentRevision]: #componentrevision #### [componentRevision] A component's Revision. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ A component's Revision. [downlinkHardwareComponents]: #downlinkhardwarecomponents #### [downlinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -161,7 +174,8 @@ A component's Revision. [hardware]: #hardware #### [hardware] The hardware object that this component belongs to. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -171,7 +185,8 @@ The hardware object that this component belongs to. [hardwareComponentModel]: #hardwarecomponentmodel #### [hardwareComponentModel] The general group of component models. -Type: **SoftLayer_Hardware_Component_Model ** +Type: **SoftLayer_Hardware_Component_Model ** + @@ -181,7 +196,8 @@ The general group of component models. [hardwareComponentType]: #hardwarecomponenttype #### [hardwareComponentType] A components type. -Type: **SoftLayer_Hardware_Component_Type ** +Type: **SoftLayer_Hardware_Component_Type ** + @@ -191,7 +207,8 @@ A components type. [isChildModule]: #ischildmodule #### [isChildModule] -Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ A components type. [logicalVolumeStorageGroups]: #logicalvolumestoragegroups #### [logicalVolumeStorageGroups] Returns the associated logic volume storage groups for the hardware component. -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + @@ -211,7 +229,8 @@ Returns the associated logic volume storage groups for the hardware component. [m2SataSlotCapacity]: #m2sataslotcapacity #### [m2SataSlotCapacity] A component's M.2 SATA capacity. -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ A component's M.2 SATA capacity. [moduleComponents]: #modulecomponents #### [moduleComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -231,7 +251,8 @@ The module's hardware components [moduleHardwareComponents]: #modulehardwarecomponents #### [moduleHardwareComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -241,7 +262,8 @@ The module's hardware components [moduleNetworkComponents]: #modulenetworkcomponents #### [moduleNetworkComponents] The module's network components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -251,7 +273,8 @@ The module's network components [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -261,7 +284,8 @@ The module's network components [networkComponents]: #networkcomponents #### [networkComponents] The components local ethernet and remote management interfaces -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -271,7 +295,8 @@ The components local ethernet and remote management interfaces [owner]: #owner #### [owner] The account this component belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -281,7 +306,8 @@ The account this component belongs to. [parent]: #parent #### [parent] A components parent. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -291,7 +317,8 @@ A components parent. Devices that are usually integrated or in some way attached [parentModule]: #parentmodule #### [parentModule] -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -301,7 +328,8 @@ A components parent. Devices that are usually integrated or in some way attached [partitions]: #partitions #### [partitions] The attached component partitions. -Type: **SoftLayer_Hardware_Component_Partition[] ** +Type: **SoftLayer_Hardware_Component_Partition[] ** + @@ -311,7 +339,8 @@ The attached component partitions. [prefixAttribute]: #prefixattribute #### [prefixAttribute] -Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** +Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** + @@ -321,7 +350,8 @@ The attached component partitions. [psid]: #psid #### [psid] A hard drives physical security ID. -Type: **string** +Type: **string** + @@ -331,7 +361,8 @@ A hard drives physical security ID. [raidMode]: #raidmode #### [raidMode] A RAID controllers RAID mode. -Type: **string** +Type: **string** + @@ -341,7 +372,8 @@ A RAID controllers RAID mode. [revision]: #revision #### [revision] The component revision designation. -Type: **SoftLayer_Hardware_Component_Revision ** +Type: **SoftLayer_Hardware_Component_Revision ** + @@ -351,7 +383,8 @@ The component revision designation. [serviceProvider]: #serviceprovider #### [serviceProvider] -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -361,7 +394,8 @@ The component revision designation. [uplinkHardwareComponents]: #uplinkhardwarecomponents #### [uplinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -373,7 +407,8 @@ The component revision designation. [childrenCount]: #childrencount #### [childrenCount] A count of a components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **unsigned long** +Type: **unsigned long** + @@ -383,7 +418,8 @@ A count of a components sub components. Devices that are usually integrated or i [downlinkHardwareComponentCount]: #downlinkhardwarecomponentcount #### [downlinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -393,7 +429,8 @@ A count of [logicalVolumeStorageGroupCount]: #logicalvolumestoragegroupcount #### [logicalVolumeStorageGroupCount] A count of returns the associated logic volume storage groups for the hardware component. -Type: **unsigned long** +Type: **unsigned long** + @@ -403,7 +440,8 @@ A count of returns the associated logic volume storage groups for the hardware c [moduleComponentCount]: #modulecomponentcount #### [moduleComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -413,7 +451,8 @@ A count of the module's hardware components [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -423,7 +462,8 @@ A count of [moduleHardwareComponentCount]: #modulehardwarecomponentcount #### [moduleHardwareComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -433,7 +473,8 @@ A count of the module's hardware components [moduleNetworkComponentCount]: #modulenetworkcomponentcount #### [moduleNetworkComponentCount] A count of the module's network components -Type: **unsigned long** +Type: **unsigned long** + @@ -443,7 +484,8 @@ A count of the module's network components [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of the components local ethernet and remote management interfaces -Type: **unsigned long** +Type: **unsigned long** + @@ -453,7 +495,8 @@ A count of the components local ethernet and remote management interfaces [partitionCount]: #partitioncount #### [partitionCount] A count of the attached component partitions. -Type: **unsigned long** +Type: **unsigned long** + @@ -463,7 +506,8 @@ A count of the attached component partitions. [uplinkHardwareComponentCount]: #uplinkhardwarecomponentcount #### [uplinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Locator/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Locator/_index.md index 1d0c819943..799e8d3e4d 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Locator/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Locator/_index.md @@ -22,6 +22,8 @@ classes: + + ### seeAlso * [SoftLayer_Hardware_Component_Model_Generic](/reference/datatypes/SoftLayer_Hardware_Component_Model_Generic ) diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Locator_Result/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Locator_Result/_index.md index 9d9527814f..744dedcbb8 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Locator_Result/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Locator_Result/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object holds a generic component model id and the list of datacenter names where it is available. @@ -45,7 +47,8 @@ This object holds a generic component model id and the list of datacenter names [datacenters]: #datacenters #### [datacenters] array of datacenter names where generic component model is available -Type: **array of strings** +Type: **array of strings** + @@ -55,7 +58,8 @@ array of datacenter names where generic component model is available [genericComponentModelId]: #genericcomponentmodelid #### [genericComponentModelId] generic component model id -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ generic component model id [serverPackageId]: #serverpackageid #### [serverPackageId] Id of SoftLayer_Product_Package_Server -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Model/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Model/_index.md index 36f79715cb..c2bca78d50 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Model/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Model/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_Model data type contains general information re [architectureTypeId]: #architecturetypeid #### [architectureTypeId] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The SoftLayer_Hardware_Component_Model data type contains general information re [capacity]: #capacity #### [capacity] A component model's capacity. The capacity of a component model depends on the model itself. For Example: Hard drives have a capacity that reflects the amount of data that hard drive can store. -Type: **decimal** +Type: **decimal** + @@ -65,7 +69,8 @@ A component model's capacity. The capacity of a component model depends on the m [description]: #description #### [description] A colon delimited list of hardware component model attributes. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A colon delimited list of hardware component model attributes. [hardwareGenericComponentModelId]: #hardwaregenericcomponentmodelid #### [hardwareGenericComponentModelId] The internal identifier of the generic component model for a component model. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The internal identifier of the generic component model for a component model. [id]: #id #### [id] A hardware component model's internal identifier number. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ A hardware component model's internal identifier number. [longDescription]: #longdescription #### [longDescription] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ A hardware component model's internal identifier number. [manufacturer]: #manufacturer #### [manufacturer] A hardware component model's manufacturer. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ A hardware component model's manufacturer. [name]: #name #### [name] The model name of a hardware component model. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The model name of a hardware component model. [version]: #version #### [version] The model number or model description of a hardware component model. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ The model number or model description of a hardware component model. [architectureType]: #architecturetype #### [architectureType] -Type: **SoftLayer_Hardware_Component_Model_Architecture_Type ** +Type: **SoftLayer_Hardware_Component_Model_Architecture_Type ** + @@ -151,7 +163,8 @@ The model number or model description of a hardware component model. [attributes]: #attributes #### [attributes] -Type: **SoftLayer_Hardware_Component_Model_Attribute[] ** +Type: **SoftLayer_Hardware_Component_Model_Attribute[] ** + @@ -161,7 +174,8 @@ The model number or model description of a hardware component model. [compatibleArrayTypes]: #compatiblearraytypes #### [compatibleArrayTypes] -Type: **SoftLayer_Configuration_Storage_Group_Array_Type[] ** +Type: **SoftLayer_Configuration_Storage_Group_Array_Type[] ** + @@ -171,7 +185,8 @@ The model number or model description of a hardware component model. [compatibleChildComponentModels]: #compatiblechildcomponentmodels #### [compatibleChildComponentModels] All the component models that are compatible with a hardware component model. -Type: **SoftLayer_Hardware_Component_Model[] ** +Type: **SoftLayer_Hardware_Component_Model[] ** + @@ -181,7 +196,8 @@ All the component models that are compatible with a hardware component model. [compatibleParentComponentModels]: #compatibleparentcomponentmodels #### [compatibleParentComponentModels] All the component models that a hardware component model is compatible with. -Type: **SoftLayer_Hardware_Component_Model[] ** +Type: **SoftLayer_Hardware_Component_Model[] ** + @@ -191,7 +207,8 @@ All the component models that a hardware component model is compatible with. [firmwareQuantity]: #firmwarequantity #### [firmwareQuantity] -Type: **unsigned integer** +Type: **unsigned integer** + @@ -201,7 +218,8 @@ All the component models that a hardware component model is compatible with. [firmwares]: #firmwares #### [firmwares] -Type: **SoftLayer_Hardware_Component_Firmware[] ** +Type: **SoftLayer_Hardware_Component_Firmware[] ** + @@ -211,7 +229,8 @@ All the component models that a hardware component model is compatible with. [hardwareComponents]: #hardwarecomponents #### [hardwareComponents] A hardware component model's physical components in inventory. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -221,7 +240,8 @@ A hardware component model's physical components in inventory. [hardwareGenericComponentModel]: #hardwaregenericcomponentmodel #### [hardwareGenericComponentModel] The non-vendor specific generic component model for a hardware component model. -Type: **SoftLayer_Hardware_Component_Model_Generic ** +Type: **SoftLayer_Hardware_Component_Model_Generic ** + @@ -231,7 +251,8 @@ The non-vendor specific generic component model for a hardware component model. [infinibandCompatibleAttribute]: #infinibandcompatibleattribute #### [infinibandCompatibleAttribute] -Type: **SoftLayer_Hardware_Component_Model_Attribute ** +Type: **SoftLayer_Hardware_Component_Model_Attribute ** + @@ -241,7 +262,8 @@ The non-vendor specific generic component model for a hardware component model. [isFlexSkuCompatible]: #isflexskucompatible #### [isFlexSkuCompatible] -Type: **boolean** +Type: **boolean** + @@ -251,7 +273,8 @@ The non-vendor specific generic component model for a hardware component model. [isInfinibandCompatible]: #isinfinibandcompatible #### [isInfinibandCompatible] -Type: **boolean** +Type: **boolean** + @@ -261,7 +284,8 @@ The non-vendor specific generic component model for a hardware component model. [rebootTime]: #reboottime #### [rebootTime] A motherboard's average reboot time. -Type: **SoftLayer_Hardware_Component_Motherboard_Reboot_Time ** +Type: **SoftLayer_Hardware_Component_Motherboard_Reboot_Time ** + @@ -271,7 +295,8 @@ A motherboard's average reboot time. [type]: #type #### [type] A hardware component model's type. -Type: **string** +Type: **string** + @@ -281,7 +306,8 @@ A hardware component model's type. [validAttributeTypes]: #validattributetypes #### [validAttributeTypes] The types of attributes that are allowed for a given hardware component model. -Type: **SoftLayer_Hardware_Component_Model_Attribute_Type[] ** +Type: **SoftLayer_Hardware_Component_Model_Attribute_Type[] ** + @@ -293,7 +319,8 @@ The types of attributes that are allowed for a given hardware component model. [attributeCount]: #attributecount #### [attributeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -303,7 +330,8 @@ A count of [compatibleArrayTypeCount]: #compatiblearraytypecount #### [compatibleArrayTypeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -313,7 +341,8 @@ A count of [compatibleChildComponentModelCount]: #compatiblechildcomponentmodelcount #### [compatibleChildComponentModelCount] A count of all the component models that are compatible with a hardware component model. -Type: **unsigned long** +Type: **unsigned long** + @@ -323,7 +352,8 @@ A count of all the component models that are compatible with a hardware componen [compatibleParentComponentModelCount]: #compatibleparentcomponentmodelcount #### [compatibleParentComponentModelCount] A count of all the component models that a hardware component model is compatible with. -Type: **unsigned long** +Type: **unsigned long** + @@ -333,7 +363,8 @@ A count of all the component models that a hardware component model is compatibl [firmwareCount]: #firmwarecount #### [firmwareCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -343,7 +374,8 @@ A count of [validAttributeTypeCount]: #validattributetypecount #### [validAttributeTypeCount] A count of the types of attributes that are allowed for a given hardware component model. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Architecture_Type/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Architecture_Type/_index.md index c8d82f259a..63ef3ae821 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Architecture_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Architecture_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [parentId]: #parentid #### [parentId] -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ classes: [children]: #children #### [children] -Type: **SoftLayer_Hardware_Component_Model_Architecture_Type[] ** +Type: **SoftLayer_Hardware_Component_Model_Architecture_Type[] ** + @@ -101,7 +108,8 @@ classes: [parent]: #parent #### [parent] -Type: **SoftLayer_Hardware_Component_Model_Architecture_Type ** +Type: **SoftLayer_Hardware_Component_Model_Architecture_Type ** + @@ -113,7 +121,8 @@ classes: [childrenCount]: #childrencount #### [childrenCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Attribute/_index.md index 487524f174..ea644301f7 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Attribute/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component__Model_Attribute data type contains general information relating to a single hardware setting or attribute for a component model. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component__Model_Attribute data type contains general inf [attributeTypeId]: #attributetypeid #### [attributeTypeId] A hardware component model attribute's associated [SoftLayer_Hardware_Component_Model_Attribute_Type]({{}}) Id. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ A hardware component model attribute's associated [SoftLayer_Hardware_Component_ [hardwareComponentModelId]: #hardwarecomponentmodelid #### [hardwareComponentModelId] A hardware component model attribute's associated [SoftLayer_Hardware_Component_Model]({{}}) Id. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A hardware component model attribute's associated [SoftLayer_Hardware_Component_ [value]: #value #### [value] A hardware component model attribute's value. A value can have many different values depending on the attributes [SoftLayer_Hardware_Component_Model_Attribute_Type]({{}}). -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A hardware component model attribute's value. A value can have many different v [hardwareComponent]: #hardwarecomponent #### [hardwareComponent] -Type: **SoftLayer_Hardware_Component_Model ** +Type: **SoftLayer_Hardware_Component_Model ** + @@ -91,7 +97,8 @@ A hardware component model attribute's value. A value can have many different v [hardwareComponentAttributeType]: #hardwarecomponentattributetype #### [hardwareComponentAttributeType] -Type: **SoftLayer_Hardware_Component_Model_Attribute_Type ** +Type: **SoftLayer_Hardware_Component_Model_Attribute_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Attribute_Type/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Attribute_Type/_index.md index 63c18e47de..6fe90797cf 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Attribute_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Attribute_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component_Model_Attribute_Type data type contains general information for the type of an attribute for a hardware component model. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_Model_Attribute_Type data type contains general [description]: #description #### [description] The description for the data that a hardware component model type's [SoftLayer_Hardware_Component_Model_Attribute]({{}}) contains. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The description for the data that a hardware component model type's [SoftLayer_H [id]: #id #### [id] A hardware component model attribute type's Id. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A hardware component model attribute type's Id. [keyName]: #keyname #### [keyName] A hardware component model attribute type's unique name. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A hardware component model attribute type's unique name. [name]: #name #### [name] A hardware component model attribute type's name. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A hardware component model attribute type's name. [validComponentTypes]: #validcomponenttypes #### [validComponentTypes] -Type: **SoftLayer_Hardware_Component_Type[] ** +Type: **SoftLayer_Hardware_Component_Type[] ** + @@ -103,7 +110,8 @@ A hardware component model attribute type's name. [validComponentTypeCount]: #validcomponenttypecount #### [validComponentTypeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Generic/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Generic/_index.md index f542006edd..26f0d44424 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Generic/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Generic/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_Model_Generic data type contains general inform [capacity]: #capacity #### [capacity] A generic component model's capacity. The capacity of a generic component model depends on the model itself. For Example: Hard drives have a capacity that reflects the amount of data that hard drive can store. -Type: **decimal** +Type: **decimal** + @@ -55,7 +58,8 @@ A generic component model's capacity. The capacity of a generic component model [description]: #description #### [description] A brief description for a generic component model that typically defines it's function. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ A brief description for a generic component model that typically defines it's fu [hardwareComponentTypeId]: #hardwarecomponenttypeid #### [hardwareComponentTypeId] The internal identifier of the component type for a generic component model. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The internal identifier of the component type for a generic component model. [id]: #id #### [id] A generic component model's internal identification number. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ A generic component model's internal identification number. [units]: #units #### [units] The unit of measurement for the capacity of a generic component model. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The unit of measurement for the capacity of a generic component model. [upgradePriority]: #upgradepriority #### [upgradePriority] A generic component model's upgrade priority. The upgrade priority indicates the order a generic component model should be considered over other generic component models. A higher number indicates that a generic component model receives a higher upgrade preference in comparison to a generic component model with a lower priority number. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ A generic component model's upgrade priority. The upgrade priority indicates the [hardwareComponentModels]: #hardwarecomponentmodels #### [hardwareComponentModels] A generic component model's hardware component model. -Type: **SoftLayer_Hardware_Component_Model[] ** +Type: **SoftLayer_Hardware_Component_Model[] ** + @@ -121,7 +130,8 @@ A generic component model's hardware component model. [hardwareComponentType]: #hardwarecomponenttype #### [hardwareComponentType] A generic component model's type. -Type: **SoftLayer_Hardware_Component_Type ** +Type: **SoftLayer_Hardware_Component_Type ** + @@ -131,7 +141,8 @@ A generic component model's type. [marketingFeatures]: #marketingfeatures #### [marketingFeatures] A list of features that a generic component model can provide. -Type: **SoftLayer_Hardware_Component_Model_Generic_MarketingFeature ** +Type: **SoftLayer_Hardware_Component_Model_Generic_MarketingFeature ** + @@ -143,7 +154,8 @@ A list of features that a generic component model can provide. [hardwareComponentModelCount]: #hardwarecomponentmodelcount #### [hardwareComponentModelCount] A count of a generic component model's hardware component model. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Generic_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Generic_Attribute/_index.md index e5422e82d1..511445cfbc 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Generic_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Generic_Attribute/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_Model_Generic_Attribute data type contains info [value]: #value #### [value] A generic component model attribute's value. -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ A generic component model attribute's value. [hardwareGenericComponentModel]: #hardwaregenericcomponentmodel #### [hardwareGenericComponentModel] An attributes generic component model. -Type: **SoftLayer_Hardware_Component_Model_Generic ** +Type: **SoftLayer_Hardware_Component_Model_Generic ** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Generic_MarketingFeature/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Generic_MarketingFeature/_index.md index e83d99fa54..c1f492b21f 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Generic_MarketingFeature/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Model_Generic_MarketingFeature/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_Model_Generic_MarketingFeature data type contai [features]: #features #### [features] An html formatted list of all features. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ An html formatted list of all features. [price]: #price #### [price] A hardware component's upgrade price. -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ A hardware component's upgrade price. [hardwareGenericComponentModel]: #hardwaregenericcomponentmodel #### [hardwareGenericComponentModel] The generic component model for a list of advertising or marketing features -Type: **SoftLayer_Hardware_Component_Model_Generic ** +Type: **SoftLayer_Hardware_Component_Model_Generic ** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Motherboard/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Motherboard/_index.md index 2cdf827ca3..365c19b46c 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Motherboard/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Motherboard/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component_DriveController data type abstracts information related to a motherboard. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_DriveController data type abstracts information [hardwareComponentModelId]: #hardwarecomponentmodelid #### [hardwareComponentModelId] The internal identifier of a hardware component's component model. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of a hardware component's component model. [hardwareId]: #hardwareid #### [hardwareId] The internal identifier of the hardware that a hardware component resides inside. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The internal identifier of the hardware that a hardware component resides inside [id]: #id #### [id] A hardware component's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A hardware component's internal identifier. [modifyDate]: #modifydate #### [modifyDate] The date that a hardware component was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The date that a hardware component was last modified. [name]: #name #### [name] The name of this component as referenced by the operating system. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The name of this component as referenced by the operating system. [serialNumber]: #serialnumber #### [serialNumber] The component serial number. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The component serial number. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ A hardware's internal identification number at its service provider [capacity]: #capacity #### [capacity] A component's capacity. -Type: **decimal** +Type: **decimal** + @@ -131,7 +141,8 @@ A component's capacity. [children]: #children #### [children] A components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -141,7 +152,8 @@ A components sub components. Devices that are usually integrated or in some way [componentRevision]: #componentrevision #### [componentRevision] A component's Revision. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ A component's Revision. [downlinkHardwareComponents]: #downlinkhardwarecomponents #### [downlinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -161,7 +174,8 @@ A component's Revision. [hardware]: #hardware #### [hardware] The hardware object that this component belongs to. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -171,7 +185,8 @@ The hardware object that this component belongs to. [hardwareComponentModel]: #hardwarecomponentmodel #### [hardwareComponentModel] The general group of component models. -Type: **SoftLayer_Hardware_Component_Model ** +Type: **SoftLayer_Hardware_Component_Model ** + @@ -181,7 +196,8 @@ The general group of component models. [hardwareComponentType]: #hardwarecomponenttype #### [hardwareComponentType] A components type. -Type: **SoftLayer_Hardware_Component_Type ** +Type: **SoftLayer_Hardware_Component_Type ** + @@ -191,7 +207,8 @@ A components type. [isChildModule]: #ischildmodule #### [isChildModule] -Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ A components type. [logicalVolumeStorageGroups]: #logicalvolumestoragegroups #### [logicalVolumeStorageGroups] Returns the associated logic volume storage groups for the hardware component. -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + @@ -211,7 +229,8 @@ Returns the associated logic volume storage groups for the hardware component. [m2SataSlotCapacity]: #m2sataslotcapacity #### [m2SataSlotCapacity] A component's M.2 SATA capacity. -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ A component's M.2 SATA capacity. [moduleComponents]: #modulecomponents #### [moduleComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -231,7 +251,8 @@ The module's hardware components [moduleHardwareComponents]: #modulehardwarecomponents #### [moduleHardwareComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -241,7 +262,8 @@ The module's hardware components [moduleNetworkComponents]: #modulenetworkcomponents #### [moduleNetworkComponents] The module's network components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -251,7 +273,8 @@ The module's network components [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -261,7 +284,8 @@ The module's network components [networkComponents]: #networkcomponents #### [networkComponents] The components local ethernet and remote management interfaces -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -271,7 +295,8 @@ The components local ethernet and remote management interfaces [owner]: #owner #### [owner] The account this component belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -281,7 +306,8 @@ The account this component belongs to. [parent]: #parent #### [parent] A components parent. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -291,7 +317,8 @@ A components parent. Devices that are usually integrated or in some way attached [parentModule]: #parentmodule #### [parentModule] -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -301,7 +328,8 @@ A components parent. Devices that are usually integrated or in some way attached [prefixAttribute]: #prefixattribute #### [prefixAttribute] -Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** +Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** + @@ -311,7 +339,8 @@ A components parent. Devices that are usually integrated or in some way attached [raidMode]: #raidmode #### [raidMode] A RAID controllers RAID mode. -Type: **string** +Type: **string** + @@ -321,7 +350,8 @@ A RAID controllers RAID mode. [revision]: #revision #### [revision] The component revision designation. -Type: **SoftLayer_Hardware_Component_Revision ** +Type: **SoftLayer_Hardware_Component_Revision ** + @@ -331,7 +361,8 @@ The component revision designation. [serviceProvider]: #serviceprovider #### [serviceProvider] -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -341,7 +372,8 @@ The component revision designation. [uplinkHardwareComponents]: #uplinkhardwarecomponents #### [uplinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -353,7 +385,8 @@ The component revision designation. [childrenCount]: #childrencount #### [childrenCount] A count of a components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **unsigned long** +Type: **unsigned long** + @@ -363,7 +396,8 @@ A count of a components sub components. Devices that are usually integrated or i [downlinkHardwareComponentCount]: #downlinkhardwarecomponentcount #### [downlinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -373,7 +407,8 @@ A count of [logicalVolumeStorageGroupCount]: #logicalvolumestoragegroupcount #### [logicalVolumeStorageGroupCount] A count of returns the associated logic volume storage groups for the hardware component. -Type: **unsigned long** +Type: **unsigned long** + @@ -383,7 +418,8 @@ A count of returns the associated logic volume storage groups for the hardware c [moduleComponentCount]: #modulecomponentcount #### [moduleComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -393,7 +429,8 @@ A count of the module's hardware components [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -403,7 +440,8 @@ A count of [moduleHardwareComponentCount]: #modulehardwarecomponentcount #### [moduleHardwareComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -413,7 +451,8 @@ A count of the module's hardware components [moduleNetworkComponentCount]: #modulenetworkcomponentcount #### [moduleNetworkComponentCount] A count of the module's network components -Type: **unsigned long** +Type: **unsigned long** + @@ -423,7 +462,8 @@ A count of the module's network components [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of the components local ethernet and remote management interfaces -Type: **unsigned long** +Type: **unsigned long** + @@ -433,7 +473,8 @@ A count of the components local ethernet and remote management interfaces [uplinkHardwareComponentCount]: #uplinkhardwarecomponentcount #### [uplinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Motherboard_Reboot_Time/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Motherboard_Reboot_Time/_index.md index d1ed6aca1b..de7ac9008f 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Motherboard_Reboot_Time/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Motherboard_Reboot_Time/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_Motherboard_Reboot_Time contains the average re [withRaid]: #withraid #### [withRaid] Average reboot time in seconds for the motherboard when raid is installed. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Average reboot time in seconds for the motherboard when raid is installed. [withoutRaid]: #withoutraid #### [withoutRaid] Average reboot time in seconds for the motherboard when NO raid is installed. -Type: **integer** +Type: **integer** + @@ -71,7 +75,8 @@ Average reboot time in seconds for the motherboard when NO raid is installed. [hardwareComponentModel]: #hardwarecomponentmodel #### [hardwareComponentModel] Motherboard's specifications (manufacturer, version, etc....) -Type: **SoftLayer_Hardware_Component_Model ** +Type: **SoftLayer_Hardware_Component_Model ** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_NetworkCard/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_NetworkCard/_index.md index c3ae529c39..1edca95fdd 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_NetworkCard/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_NetworkCard/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component_NetworkCard data type abstracts information related to a network card. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_NetworkCard data type abstracts information rel [hardwareComponentModelId]: #hardwarecomponentmodelid #### [hardwareComponentModelId] The internal identifier of a hardware component's component model. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of a hardware component's component model. [hardwareId]: #hardwareid #### [hardwareId] The internal identifier of the hardware that a hardware component resides inside. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The internal identifier of the hardware that a hardware component resides inside [id]: #id #### [id] A hardware component's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A hardware component's internal identifier. [modifyDate]: #modifydate #### [modifyDate] The date that a hardware component was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The date that a hardware component was last modified. [name]: #name #### [name] The name of this component as referenced by the operating system. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The name of this component as referenced by the operating system. [serialNumber]: #serialnumber #### [serialNumber] The component serial number. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The component serial number. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ A hardware's internal identification number at its service provider [capacity]: #capacity #### [capacity] A component's capacity. -Type: **decimal** +Type: **decimal** + @@ -131,7 +141,8 @@ A component's capacity. [children]: #children #### [children] A components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -141,7 +152,8 @@ A components sub components. Devices that are usually integrated or in some way [componentRevision]: #componentrevision #### [componentRevision] A component's Revision. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ A component's Revision. [downlinkHardwareComponents]: #downlinkhardwarecomponents #### [downlinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -161,7 +174,8 @@ A component's Revision. [hardware]: #hardware #### [hardware] The hardware object that this component belongs to. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -171,7 +185,8 @@ The hardware object that this component belongs to. [hardwareComponentModel]: #hardwarecomponentmodel #### [hardwareComponentModel] The general group of component models. -Type: **SoftLayer_Hardware_Component_Model ** +Type: **SoftLayer_Hardware_Component_Model ** + @@ -181,7 +196,8 @@ The general group of component models. [hardwareComponentType]: #hardwarecomponenttype #### [hardwareComponentType] A components type. -Type: **SoftLayer_Hardware_Component_Type ** +Type: **SoftLayer_Hardware_Component_Type ** + @@ -191,7 +207,8 @@ A components type. [isChildModule]: #ischildmodule #### [isChildModule] -Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ A components type. [logicalVolumeStorageGroups]: #logicalvolumestoragegroups #### [logicalVolumeStorageGroups] Returns the associated logic volume storage groups for the hardware component. -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + @@ -211,7 +229,8 @@ Returns the associated logic volume storage groups for the hardware component. [m2SataSlotCapacity]: #m2sataslotcapacity #### [m2SataSlotCapacity] A component's M.2 SATA capacity. -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ A component's M.2 SATA capacity. [moduleComponents]: #modulecomponents #### [moduleComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -231,7 +251,8 @@ The module's hardware components [moduleHardwareComponents]: #modulehardwarecomponents #### [moduleHardwareComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -241,7 +262,8 @@ The module's hardware components [moduleNetworkComponents]: #modulenetworkcomponents #### [moduleNetworkComponents] The module's network components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -251,7 +273,8 @@ The module's network components [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -261,7 +284,8 @@ The module's network components [networkComponents]: #networkcomponents #### [networkComponents] The components local ethernet and remote management interfaces -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -271,7 +295,8 @@ The components local ethernet and remote management interfaces [owner]: #owner #### [owner] The account this component belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -281,7 +306,8 @@ The account this component belongs to. [parent]: #parent #### [parent] A components parent. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -291,7 +317,8 @@ A components parent. Devices that are usually integrated or in some way attached [parentModule]: #parentmodule #### [parentModule] -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -301,7 +328,8 @@ A components parent. Devices that are usually integrated or in some way attached [prefixAttribute]: #prefixattribute #### [prefixAttribute] -Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** +Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** + @@ -311,7 +339,8 @@ A components parent. Devices that are usually integrated or in some way attached [raidMode]: #raidmode #### [raidMode] A RAID controllers RAID mode. -Type: **string** +Type: **string** + @@ -321,7 +350,8 @@ A RAID controllers RAID mode. [revision]: #revision #### [revision] The component revision designation. -Type: **SoftLayer_Hardware_Component_Revision ** +Type: **SoftLayer_Hardware_Component_Revision ** + @@ -331,7 +361,8 @@ The component revision designation. [serviceProvider]: #serviceprovider #### [serviceProvider] -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -341,7 +372,8 @@ The component revision designation. [uplinkHardwareComponents]: #uplinkhardwarecomponents #### [uplinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -353,7 +385,8 @@ The component revision designation. [childrenCount]: #childrencount #### [childrenCount] A count of a components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **unsigned long** +Type: **unsigned long** + @@ -363,7 +396,8 @@ A count of a components sub components. Devices that are usually integrated or i [downlinkHardwareComponentCount]: #downlinkhardwarecomponentcount #### [downlinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -373,7 +407,8 @@ A count of [logicalVolumeStorageGroupCount]: #logicalvolumestoragegroupcount #### [logicalVolumeStorageGroupCount] A count of returns the associated logic volume storage groups for the hardware component. -Type: **unsigned long** +Type: **unsigned long** + @@ -383,7 +418,8 @@ A count of returns the associated logic volume storage groups for the hardware c [moduleComponentCount]: #modulecomponentcount #### [moduleComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -393,7 +429,8 @@ A count of the module's hardware components [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -403,7 +440,8 @@ A count of [moduleHardwareComponentCount]: #modulehardwarecomponentcount #### [moduleHardwareComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -413,7 +451,8 @@ A count of the module's hardware components [moduleNetworkComponentCount]: #modulenetworkcomponentcount #### [moduleNetworkComponentCount] A count of the module's network components -Type: **unsigned long** +Type: **unsigned long** + @@ -423,7 +462,8 @@ A count of the module's network components [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of the components local ethernet and remote management interfaces -Type: **unsigned long** +Type: **unsigned long** + @@ -433,7 +473,8 @@ A count of the components local ethernet and remote management interfaces [uplinkHardwareComponentCount]: #uplinkhardwarecomponentcount #### [uplinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_PSID_Xref/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_PSID_Xref/_index.md index 93b8d1246a..bada21763c 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_PSID_Xref/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_PSID_Xref/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component_PSID_Xref data type holds physical security ID information for hard drives @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_PSID_Xref data type holds physical security ID [componentId]: #componentid #### [componentId] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The SoftLayer_Hardware_Component_PSID_Xref data type holds physical security ID [psid]: #psid #### [psid] -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ The SoftLayer_Hardware_Component_PSID_Xref data type holds physical security ID [component]: #component #### [component] The hardware component the PSID belongs to. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Partition/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Partition/_index.md index 4b771e9c75..8fb4608e1e 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Partition/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Partition/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component_Partition data type contains general information relating to a single hard drive partition. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_Partition data type contains general informatio [diskNumber]: #disknumber #### [diskNumber] A hardware component partition's order in the [SoftLayer_Hardware_Server]({{}}). -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ A hardware component partition's order in the [SoftLayer_Hardware_Server]({{Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A flag indicating if a partition is the grow partition. The grow partition will [hardwareComponentId]: #hardwarecomponentid #### [hardwareComponentId] A hardware component partition's associated [SoftLayer_Hardware_Component]({{}}) Id. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A hardware component partition's associated [SoftLayer_Hardware_Component]({{Type: **decimal** +Type: **decimal** + @@ -85,7 +91,8 @@ A hardware component partition's minimum size(GB). [name]: #name #### [name] A hardware component partition's name. On a server with windows this may be 'C' and on Linux this may be '/var' -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ A hardware component partition's name. On a server with windows this may be 'C' [hardwareComponent]: #hardwarecomponent #### [hardwareComponent] A hardware component partitions's associated [SoftLayer_Hardware_Component]({{}}) -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Partition_OperatingSystem/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Partition_OperatingSystem/_index.md index 00855dfb36..369da5efd2 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Partition_OperatingSystem/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Partition_OperatingSystem/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component_Partition_OperatingSystem data type contains general information relating to a single SoftLayer Operating System Partition Template. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_Partition_OperatingSystem data type contains ge [description]: #description #### [description] A partition template operating system's description. Typically the title of the Operating System. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ A partition template operating system's description. Typically the title of the [id]: #id #### [id] A partition template operating system's id. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A partition template operating system's id. [notes]: #notes #### [notes] Information about the kinds of partition templates assigned to this operating system. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ Information about the kinds of partition templates assigned to this operating sy [partitionTemplates]: #partitiontemplates #### [partitionTemplates] Information regarding an operating system's [SoftLayer_Hardware_Component_Partition_Template]({{}}). -Type: **SoftLayer_Hardware_Component_Partition_Template[] ** +Type: **SoftLayer_Hardware_Component_Partition_Template[] ** + @@ -93,7 +99,8 @@ Information regarding an operating system's [SoftLayer_Hardware_Component_Partit [partitionTemplateCount]: #partitiontemplatecount #### [partitionTemplateCount] A count of information regarding an operating system's [SoftLayer_Hardware_Component_Partition_Template]({{}}). -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Partition_Template/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Partition_Template/_index.md index 28d2fb8c8c..cba47f21b0 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Partition_Template/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Partition_Template/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ The SoftLayer_Hardware_Component_Partition_Template data type contains general i [accountId]: #accountid #### [accountId] A partition template's owner. The [SoftLayer_Account]({{}}) that a template was created by. -Type: **integer** +Type: **integer** + @@ -61,7 +64,8 @@ A partition template's owner. The [SoftLayer_Account]({{Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ A partition template's description. [id]: #id #### [id] A partition template's id. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ A partition template's id. [partitionOperatingSystemId]: #partitionoperatingsystemid #### [partitionOperatingSystemId] A partition template's associated [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}) Id. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ A partition template's associated [SoftLayer_Hardware_Component_Partition_Operat [statusCode]: #statuscode #### [statusCode] A partition template's status code. ACTIVE ,INACTIVE. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ A partition template's status code. ACTIVE ,INACTIVE. [templateType]: #templatetype #### [templateType] A partition template's Type. SYSTEM - template generated by softlayer. CUSTOM - templates generated by SoftLayer customers. -Type: **string** +Type: **string** + @@ -117,7 +125,8 @@ A partition template's Type. SYSTEM - template generated by softlayer. CUSTOM - [account]: #account #### [account] A partition template's associated [SoftLayer_Account]({{}}). -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -127,7 +136,8 @@ A partition template's associated [SoftLayer_Account]({{Type: **SoftLayer_Hardware_Component_Partition_Template_Partition[] ** +Type: **SoftLayer_Hardware_Component_Partition_Template_Partition[] ** + @@ -137,7 +147,8 @@ An individual partition for a partition template. This is identical to 'partitio [expireDate]: #expiredate #### [expireDate] -Type: **string** +Type: **string** + @@ -147,7 +158,8 @@ An individual partition for a partition template. This is identical to 'partitio [partitionOperatingSystem]: #partitionoperatingsystem #### [partitionOperatingSystem] A partition template's associated [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}). -Type: **SoftLayer_Hardware_Component_Partition_OperatingSystem ** +Type: **SoftLayer_Hardware_Component_Partition_OperatingSystem ** + @@ -157,7 +169,8 @@ A partition template's associated [SoftLayer_Hardware_Component_Partition_Operat [partitionTemplatePartition]: #partitiontemplatepartition #### [partitionTemplatePartition] An individual partition for a partition template. -Type: **SoftLayer_Hardware_Component_Partition_Template_Partition[] ** +Type: **SoftLayer_Hardware_Component_Partition_Template_Partition[] ** + @@ -169,7 +182,8 @@ An individual partition for a partition template. [dataCount]: #datacount #### [dataCount] A count of an individual partition for a partition template. This is identical to 'partitionTemplatePartition' except this will sort unix partitions. -Type: **unsigned long** +Type: **unsigned long** + @@ -179,7 +193,8 @@ A count of an individual partition for a partition template. This is identical t [partitionTemplatePartitionCount]: #partitiontemplatepartitioncount #### [partitionTemplatePartitionCount] A count of an individual partition for a partition template. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Partition_Template_Partition/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Partition_Template_Partition/_index.md index e6c9a7574f..d6a410fa95 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Partition_Template_Partition/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Partition_Template_Partition/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component_Partition_Template_Partition data type contains general information relating to a single SoftLayer Template Partition. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_Partition_Template_Partition data type contains [id]: #id #### [id] A partition's id. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ A partition's id. [isGrow]: #isgrow #### [isGrow] A flag indication if a partition will be the grow partition. The grow partition will have its size adjusted to fill all available space on a hard drive. -Type: **boolean** +Type: **boolean** + @@ -65,7 +69,8 @@ A flag indication if a partition will be the grow partition. The grow partition [partitionName]: #partitionname #### [partitionName] A partition's default name. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A partition's default name. [partitionSize]: #partitionsize #### [partitionSize] A partition's default size. -Type: **decimal** +Type: **decimal** + @@ -85,7 +91,8 @@ A partition's default size. [partitionTemplateId]: #partitiontemplateid #### [partitionTemplateId] A partition's associated [SoftLayer_Hardware_Component_Partition_Template]({{}}) Id. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ A partition's associated [SoftLayer_Hardware_Component_Partition_Template]({{Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The volume the partition will be put on [filesystemType]: #filesystemtype #### [filesystemType] The filesystem type of a partition -Type: **SoftLayer_Configuration_Storage_Filesystem_Type ** +Type: **SoftLayer_Configuration_Storage_Filesystem_Type ** + @@ -121,7 +130,8 @@ The filesystem type of a partition [partitionTemplate]: #partitiontemplate #### [partitionTemplate] A partition's [SoftLayer_Hardware_Component_Partition_Template]({{}}). -Type: **SoftLayer_Hardware_Component_Partition_Template ** +Type: **SoftLayer_Hardware_Component_Partition_Template ** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Processor/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Processor/_index.md index 47440e1a4a..812ebf0d1b 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Processor/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Processor/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component_Processor data type abstracts information related to a processor. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_Processor data type abstracts information relat [hardwareComponentModelId]: #hardwarecomponentmodelid #### [hardwareComponentModelId] The internal identifier of a hardware component's component model. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of a hardware component's component model. [hardwareId]: #hardwareid #### [hardwareId] The internal identifier of the hardware that a hardware component resides inside. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The internal identifier of the hardware that a hardware component resides inside [id]: #id #### [id] A hardware component's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A hardware component's internal identifier. [modifyDate]: #modifydate #### [modifyDate] The date that a hardware component was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The date that a hardware component was last modified. [name]: #name #### [name] The name of this component as referenced by the operating system. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The name of this component as referenced by the operating system. [serialNumber]: #serialnumber #### [serialNumber] The component serial number. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The component serial number. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ A hardware's internal identification number at its service provider [capacity]: #capacity #### [capacity] A component's capacity. -Type: **decimal** +Type: **decimal** + @@ -131,7 +141,8 @@ A component's capacity. [children]: #children #### [children] A components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -141,7 +152,8 @@ A components sub components. Devices that are usually integrated or in some way [componentRevision]: #componentrevision #### [componentRevision] A component's Revision. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ A component's Revision. [downlinkHardwareComponents]: #downlinkhardwarecomponents #### [downlinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -161,7 +174,8 @@ A component's Revision. [hardware]: #hardware #### [hardware] The hardware object that this component belongs to. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -171,7 +185,8 @@ The hardware object that this component belongs to. [hardwareComponentModel]: #hardwarecomponentmodel #### [hardwareComponentModel] The general group of component models. -Type: **SoftLayer_Hardware_Component_Model ** +Type: **SoftLayer_Hardware_Component_Model ** + @@ -181,7 +196,8 @@ The general group of component models. [hardwareComponentType]: #hardwarecomponenttype #### [hardwareComponentType] A components type. -Type: **SoftLayer_Hardware_Component_Type ** +Type: **SoftLayer_Hardware_Component_Type ** + @@ -191,7 +207,8 @@ A components type. [isChildModule]: #ischildmodule #### [isChildModule] -Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ A components type. [logicalVolumeStorageGroups]: #logicalvolumestoragegroups #### [logicalVolumeStorageGroups] Returns the associated logic volume storage groups for the hardware component. -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + @@ -211,7 +229,8 @@ Returns the associated logic volume storage groups for the hardware component. [m2SataSlotCapacity]: #m2sataslotcapacity #### [m2SataSlotCapacity] A component's M.2 SATA capacity. -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ A component's M.2 SATA capacity. [moduleComponents]: #modulecomponents #### [moduleComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -231,7 +251,8 @@ The module's hardware components [moduleHardwareComponents]: #modulehardwarecomponents #### [moduleHardwareComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -241,7 +262,8 @@ The module's hardware components [moduleNetworkComponents]: #modulenetworkcomponents #### [moduleNetworkComponents] The module's network components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -251,7 +273,8 @@ The module's network components [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -261,7 +284,8 @@ The module's network components [networkComponents]: #networkcomponents #### [networkComponents] The components local ethernet and remote management interfaces -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -271,7 +295,8 @@ The components local ethernet and remote management interfaces [owner]: #owner #### [owner] The account this component belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -281,7 +306,8 @@ The account this component belongs to. [parent]: #parent #### [parent] A components parent. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -291,7 +317,8 @@ A components parent. Devices that are usually integrated or in some way attached [parentModule]: #parentmodule #### [parentModule] -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -301,7 +328,8 @@ A components parent. Devices that are usually integrated or in some way attached [prefixAttribute]: #prefixattribute #### [prefixAttribute] -Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** +Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** + @@ -311,7 +339,8 @@ A components parent. Devices that are usually integrated or in some way attached [raidMode]: #raidmode #### [raidMode] A RAID controllers RAID mode. -Type: **string** +Type: **string** + @@ -321,7 +350,8 @@ A RAID controllers RAID mode. [revision]: #revision #### [revision] The component revision designation. -Type: **SoftLayer_Hardware_Component_Revision ** +Type: **SoftLayer_Hardware_Component_Revision ** + @@ -331,7 +361,8 @@ The component revision designation. [serviceProvider]: #serviceprovider #### [serviceProvider] -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -341,7 +372,8 @@ The component revision designation. [uplinkHardwareComponents]: #uplinkhardwarecomponents #### [uplinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -353,7 +385,8 @@ The component revision designation. [childrenCount]: #childrencount #### [childrenCount] A count of a components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **unsigned long** +Type: **unsigned long** + @@ -363,7 +396,8 @@ A count of a components sub components. Devices that are usually integrated or i [downlinkHardwareComponentCount]: #downlinkhardwarecomponentcount #### [downlinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -373,7 +407,8 @@ A count of [logicalVolumeStorageGroupCount]: #logicalvolumestoragegroupcount #### [logicalVolumeStorageGroupCount] A count of returns the associated logic volume storage groups for the hardware component. -Type: **unsigned long** +Type: **unsigned long** + @@ -383,7 +418,8 @@ A count of returns the associated logic volume storage groups for the hardware c [moduleComponentCount]: #modulecomponentcount #### [moduleComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -393,7 +429,8 @@ A count of the module's hardware components [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -403,7 +440,8 @@ A count of [moduleHardwareComponentCount]: #modulehardwarecomponentcount #### [moduleHardwareComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -413,7 +451,8 @@ A count of the module's hardware components [moduleNetworkComponentCount]: #modulenetworkcomponentcount #### [moduleNetworkComponentCount] A count of the module's network components -Type: **unsigned long** +Type: **unsigned long** + @@ -423,7 +462,8 @@ A count of the module's network components [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of the components local ethernet and remote management interfaces -Type: **unsigned long** +Type: **unsigned long** + @@ -433,7 +473,8 @@ A count of the components local ethernet and remote management interfaces [uplinkHardwareComponentCount]: #uplinkhardwarecomponentcount #### [uplinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Ram/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Ram/_index.md index c8694ec061..0439f6b754 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Ram/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Ram/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component_Ram data type abstracts information related to RAM. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_Ram data type abstracts information related to [hardwareComponentModelId]: #hardwarecomponentmodelid #### [hardwareComponentModelId] The internal identifier of a hardware component's component model. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of a hardware component's component model. [hardwareId]: #hardwareid #### [hardwareId] The internal identifier of the hardware that a hardware component resides inside. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The internal identifier of the hardware that a hardware component resides inside [id]: #id #### [id] A hardware component's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A hardware component's internal identifier. [modifyDate]: #modifydate #### [modifyDate] The date that a hardware component was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The date that a hardware component was last modified. [name]: #name #### [name] The name of this component as referenced by the operating system. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The name of this component as referenced by the operating system. [serialNumber]: #serialnumber #### [serialNumber] The component serial number. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The component serial number. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ A hardware's internal identification number at its service provider [capacity]: #capacity #### [capacity] A component's capacity. -Type: **decimal** +Type: **decimal** + @@ -131,7 +141,8 @@ A component's capacity. [children]: #children #### [children] A components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -141,7 +152,8 @@ A components sub components. Devices that are usually integrated or in some way [componentRevision]: #componentrevision #### [componentRevision] A component's Revision. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ A component's Revision. [downlinkHardwareComponents]: #downlinkhardwarecomponents #### [downlinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -161,7 +174,8 @@ A component's Revision. [hardware]: #hardware #### [hardware] The hardware object that this component belongs to. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -171,7 +185,8 @@ The hardware object that this component belongs to. [hardwareComponentModel]: #hardwarecomponentmodel #### [hardwareComponentModel] The general group of component models. -Type: **SoftLayer_Hardware_Component_Model ** +Type: **SoftLayer_Hardware_Component_Model ** + @@ -181,7 +196,8 @@ The general group of component models. [hardwareComponentType]: #hardwarecomponenttype #### [hardwareComponentType] A components type. -Type: **SoftLayer_Hardware_Component_Type ** +Type: **SoftLayer_Hardware_Component_Type ** + @@ -191,7 +207,8 @@ A components type. [isChildModule]: #ischildmodule #### [isChildModule] -Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ A components type. [logicalVolumeStorageGroups]: #logicalvolumestoragegroups #### [logicalVolumeStorageGroups] Returns the associated logic volume storage groups for the hardware component. -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + @@ -211,7 +229,8 @@ Returns the associated logic volume storage groups for the hardware component. [m2SataSlotCapacity]: #m2sataslotcapacity #### [m2SataSlotCapacity] A component's M.2 SATA capacity. -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ A component's M.2 SATA capacity. [moduleComponents]: #modulecomponents #### [moduleComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -231,7 +251,8 @@ The module's hardware components [moduleHardwareComponents]: #modulehardwarecomponents #### [moduleHardwareComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -241,7 +262,8 @@ The module's hardware components [moduleNetworkComponents]: #modulenetworkcomponents #### [moduleNetworkComponents] The module's network components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -251,7 +273,8 @@ The module's network components [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -261,7 +284,8 @@ The module's network components [networkComponents]: #networkcomponents #### [networkComponents] The components local ethernet and remote management interfaces -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -271,7 +295,8 @@ The components local ethernet and remote management interfaces [owner]: #owner #### [owner] The account this component belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -281,7 +306,8 @@ The account this component belongs to. [parent]: #parent #### [parent] A components parent. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -291,7 +317,8 @@ A components parent. Devices that are usually integrated or in some way attached [parentModule]: #parentmodule #### [parentModule] -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -301,7 +328,8 @@ A components parent. Devices that are usually integrated or in some way attached [prefixAttribute]: #prefixattribute #### [prefixAttribute] -Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** +Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** + @@ -311,7 +339,8 @@ A components parent. Devices that are usually integrated or in some way attached [raidMode]: #raidmode #### [raidMode] A RAID controllers RAID mode. -Type: **string** +Type: **string** + @@ -321,7 +350,8 @@ A RAID controllers RAID mode. [revision]: #revision #### [revision] The component revision designation. -Type: **SoftLayer_Hardware_Component_Revision ** +Type: **SoftLayer_Hardware_Component_Revision ** + @@ -331,7 +361,8 @@ The component revision designation. [serviceProvider]: #serviceprovider #### [serviceProvider] -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -341,7 +372,8 @@ The component revision designation. [uplinkHardwareComponents]: #uplinkhardwarecomponents #### [uplinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -353,7 +385,8 @@ The component revision designation. [childrenCount]: #childrencount #### [childrenCount] A count of a components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **unsigned long** +Type: **unsigned long** + @@ -363,7 +396,8 @@ A count of a components sub components. Devices that are usually integrated or i [downlinkHardwareComponentCount]: #downlinkhardwarecomponentcount #### [downlinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -373,7 +407,8 @@ A count of [logicalVolumeStorageGroupCount]: #logicalvolumestoragegroupcount #### [logicalVolumeStorageGroupCount] A count of returns the associated logic volume storage groups for the hardware component. -Type: **unsigned long** +Type: **unsigned long** + @@ -383,7 +418,8 @@ A count of returns the associated logic volume storage groups for the hardware c [moduleComponentCount]: #modulecomponentcount #### [moduleComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -393,7 +429,8 @@ A count of the module's hardware components [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -403,7 +440,8 @@ A count of [moduleHardwareComponentCount]: #modulehardwarecomponentcount #### [moduleHardwareComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -413,7 +451,8 @@ A count of the module's hardware components [moduleNetworkComponentCount]: #modulenetworkcomponentcount #### [moduleNetworkComponentCount] A count of the module's network components -Type: **unsigned long** +Type: **unsigned long** + @@ -423,7 +462,8 @@ A count of the module's network components [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of the components local ethernet and remote management interfaces -Type: **unsigned long** +Type: **unsigned long** + @@ -433,7 +473,8 @@ A count of the components local ethernet and remote management interfaces [uplinkHardwareComponentCount]: #uplinkhardwarecomponentcount #### [uplinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_RemoteManagement/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_RemoteManagement/_index.md index 067bc1e82c..2126420f67 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_RemoteManagement/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_RemoteManagement/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class adds functionality to the base SoftLayer_Hardware class for web servers (all server hardware) @@ -45,7 +47,8 @@ This class adds functionality to the base SoftLayer_Hardware class for web serve [hardwareComponentModelId]: #hardwarecomponentmodelid #### [hardwareComponentModelId] The internal identifier of a hardware component's component model. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of a hardware component's component model. [hardwareId]: #hardwareid #### [hardwareId] The internal identifier of the hardware that a hardware component resides inside. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The internal identifier of the hardware that a hardware component resides inside [id]: #id #### [id] A hardware component's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A hardware component's internal identifier. [modifyDate]: #modifydate #### [modifyDate] The date that a hardware component was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The date that a hardware component was last modified. [name]: #name #### [name] The name of this component as referenced by the operating system. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The name of this component as referenced by the operating system. [serialNumber]: #serialnumber #### [serialNumber] The component serial number. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The component serial number. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ A hardware's internal identification number at its service provider [capacity]: #capacity #### [capacity] A component's capacity. -Type: **decimal** +Type: **decimal** + @@ -131,7 +141,8 @@ A component's capacity. [children]: #children #### [children] A components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -141,7 +152,8 @@ A components sub components. Devices that are usually integrated or in some way [componentRevision]: #componentrevision #### [componentRevision] A component's Revision. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ A component's Revision. [downlinkHardwareComponents]: #downlinkhardwarecomponents #### [downlinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -161,7 +174,8 @@ A component's Revision. [hardware]: #hardware #### [hardware] The hardware object that this component belongs to. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -171,7 +185,8 @@ The hardware object that this component belongs to. [hardwareComponentModel]: #hardwarecomponentmodel #### [hardwareComponentModel] The general group of component models. -Type: **SoftLayer_Hardware_Component_Model ** +Type: **SoftLayer_Hardware_Component_Model ** + @@ -181,7 +196,8 @@ The general group of component models. [hardwareComponentType]: #hardwarecomponenttype #### [hardwareComponentType] A components type. -Type: **SoftLayer_Hardware_Component_Type ** +Type: **SoftLayer_Hardware_Component_Type ** + @@ -191,7 +207,8 @@ A components type. [isChildModule]: #ischildmodule #### [isChildModule] -Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ A components type. [logicalVolumeStorageGroups]: #logicalvolumestoragegroups #### [logicalVolumeStorageGroups] Returns the associated logic volume storage groups for the hardware component. -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + @@ -211,7 +229,8 @@ Returns the associated logic volume storage groups for the hardware component. [m2SataSlotCapacity]: #m2sataslotcapacity #### [m2SataSlotCapacity] A component's M.2 SATA capacity. -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ A component's M.2 SATA capacity. [moduleComponents]: #modulecomponents #### [moduleComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -231,7 +251,8 @@ The module's hardware components [moduleHardwareComponents]: #modulehardwarecomponents #### [moduleHardwareComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -241,7 +262,8 @@ The module's hardware components [moduleNetworkComponents]: #modulenetworkcomponents #### [moduleNetworkComponents] The module's network components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -251,7 +273,8 @@ The module's network components [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -261,7 +284,8 @@ The module's network components [networkComponent]: #networkcomponent #### [networkComponent] A network component data type. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -271,7 +295,8 @@ A network component data type. [networkComponents]: #networkcomponents #### [networkComponents] The components local ethernet and remote management interfaces -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -281,7 +306,8 @@ The components local ethernet and remote management interfaces [owner]: #owner #### [owner] The account this component belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -291,7 +317,8 @@ The account this component belongs to. [parent]: #parent #### [parent] A components parent. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -301,7 +328,8 @@ A components parent. Devices that are usually integrated or in some way attached [parentModule]: #parentmodule #### [parentModule] -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -311,7 +339,8 @@ A components parent. Devices that are usually integrated or in some way attached [prefixAttribute]: #prefixattribute #### [prefixAttribute] -Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** +Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** + @@ -321,7 +350,8 @@ A components parent. Devices that are usually integrated or in some way attached [raidMode]: #raidmode #### [raidMode] A RAID controllers RAID mode. -Type: **string** +Type: **string** + @@ -331,7 +361,8 @@ A RAID controllers RAID mode. [revision]: #revision #### [revision] The component revision designation. -Type: **SoftLayer_Hardware_Component_Revision ** +Type: **SoftLayer_Hardware_Component_Revision ** + @@ -341,7 +372,8 @@ The component revision designation. [serviceProvider]: #serviceprovider #### [serviceProvider] -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -351,7 +383,8 @@ The component revision designation. [uplinkHardwareComponents]: #uplinkhardwarecomponents #### [uplinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -363,7 +396,8 @@ The component revision designation. [childrenCount]: #childrencount #### [childrenCount] A count of a components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **unsigned long** +Type: **unsigned long** + @@ -373,7 +407,8 @@ A count of a components sub components. Devices that are usually integrated or i [downlinkHardwareComponentCount]: #downlinkhardwarecomponentcount #### [downlinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -383,7 +418,8 @@ A count of [logicalVolumeStorageGroupCount]: #logicalvolumestoragegroupcount #### [logicalVolumeStorageGroupCount] A count of returns the associated logic volume storage groups for the hardware component. -Type: **unsigned long** +Type: **unsigned long** + @@ -393,7 +429,8 @@ A count of returns the associated logic volume storage groups for the hardware c [moduleComponentCount]: #modulecomponentcount #### [moduleComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -403,7 +440,8 @@ A count of the module's hardware components [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -413,7 +451,8 @@ A count of [moduleHardwareComponentCount]: #modulehardwarecomponentcount #### [moduleHardwareComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -423,7 +462,8 @@ A count of the module's hardware components [moduleNetworkComponentCount]: #modulenetworkcomponentcount #### [moduleNetworkComponentCount] A count of the module's network components -Type: **unsigned long** +Type: **unsigned long** + @@ -433,7 +473,8 @@ A count of the module's network components [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of the components local ethernet and remote management interfaces -Type: **unsigned long** +Type: **unsigned long** + @@ -443,7 +484,8 @@ A count of the components local ethernet and remote management interfaces [uplinkHardwareComponentCount]: #uplinkhardwarecomponentcount #### [uplinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_RemoteManagement_Command/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_RemoteManagement_Command/_index.md index d2e968bbe3..9319128e7f 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_RemoteManagement_Command/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_RemoteManagement_Command/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Storage_Evault_Version6 contains the names of the remote m [keyName]: #keyname #### [keyName] The name of the remote management command. -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ The name of the remote management command. [requests]: #requests #### [requests] All requests issued for the remote management command. -Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request[] ** + @@ -73,7 +77,8 @@ All requests issued for the remote management command. [requestCount]: #requestcount #### [requestCount] A count of all requests issued for the remote management command. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_RemoteManagement_Command_Request/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_RemoteManagement_Command_Request/_index.md index 4f64feab42..5666cf65a8 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_RemoteManagement_Command_Request/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_RemoteManagement_Command_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_RemoteManagement_Command_Request contains detai [createDate]: #createdate #### [createDate] The timestamp the remote management command was issued. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The timestamp the remote management command was issued. [hardwareId]: #hardwareid #### [hardwareId] The hardware id the command was issued for. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The hardware id the command was issued for. [modifyDate]: #modifydate #### [modifyDate] The timestamp recorded when the remote management command returned a status of the command issued. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The timestamp recorded when the remote management command returned a status of t [processed]: #processed #### [processed] Execution status of the remote management command. True is successful. False is failure. -Type: **boolean** +Type: **boolean** + @@ -91,7 +97,8 @@ Execution status of the remote management command. True is successful. False i [hardware]: #hardware #### [hardware] The id of the hardware to perform the remote management or powerstrip command on. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -101,7 +108,8 @@ The id of the hardware to perform the remote management or powerstrip command on [networkComponent]: #networkcomponent #### [networkComponent] A hardware's network components. Network components are hardware components such as IPMI cards or Ethernet cards. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -111,7 +119,8 @@ A hardware's network components. Network components are hardware components such [remoteManagementCommand]: #remotemanagementcommand #### [remoteManagementCommand] The remote management command issued. -Type: **SoftLayer_Hardware_Component_RemoteManagement_Command ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_Command ** + @@ -121,7 +130,8 @@ The remote management command issued. [user]: #user #### [user] Information regarding the user who issued the remote management command. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_RemoteManagement_User/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_RemoteManagement_User/_index.md index c38fea3647..df64f4c30f 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_RemoteManagement_User/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_RemoteManagement_User/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The credentials used for remote management such as username, password, etc... @@ -45,7 +47,8 @@ The credentials used for remote management such as username, password, etc... [password]: #password #### [password] The password used for this remote management command. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The password used for this remote management command. [username]: #username #### [username] The username used for this remote management command. -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ The username used for this remote management command. [hardware]: #hardware #### [hardware] -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -81,7 +86,8 @@ The username used for this remote management command. [networkComponent]: #networkcomponent #### [networkComponent] -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Revision/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Revision/_index.md index 03b098c469..d25f481b7a 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Revision/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Revision/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [firmwareVersionId]: #firmwareversionid #### [firmwareVersionId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [hardwareComponentId]: #hardwarecomponentid #### [hardwareComponentId] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ classes: [biosDate]: #biosdate #### [biosDate] The firmware build date -Type: **dateTime** +Type: **dateTime** + @@ -91,7 +97,8 @@ The firmware build date [firmware]: #firmware #### [firmware] The Firmware installed on this record's Hardware Component. -Type: **SoftLayer_Hardware_Component_Firmware ** +Type: **SoftLayer_Hardware_Component_Firmware ** + @@ -101,7 +108,8 @@ The Firmware installed on this record's Hardware Component. [hardwareComponent]: #hardwarecomponent #### [hardwareComponent] The Hardware Component this revision record applies to. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -111,7 +119,8 @@ The Hardware Component this revision record applies to. [revision]: #revision #### [revision] The firmware revision -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_SecurityDevice/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_SecurityDevice/_index.md index 167e3a7401..9a0a93ac98 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_SecurityDevice/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_SecurityDevice/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component_SecurityDevice is used to determine the security devices attached to the hardware component. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_SecurityDevice is used to determine the securit [hardwareComponentModelId]: #hardwarecomponentmodelid #### [hardwareComponentModelId] The internal identifier of a hardware component's component model. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of a hardware component's component model. [hardwareId]: #hardwareid #### [hardwareId] The internal identifier of the hardware that a hardware component resides inside. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The internal identifier of the hardware that a hardware component resides inside [id]: #id #### [id] A hardware component's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A hardware component's internal identifier. [modifyDate]: #modifydate #### [modifyDate] The date that a hardware component was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The date that a hardware component was last modified. [name]: #name #### [name] The name of this component as referenced by the operating system. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The name of this component as referenced by the operating system. [serialNumber]: #serialnumber #### [serialNumber] The component serial number. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The component serial number. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ A hardware's internal identification number at its service provider [capacity]: #capacity #### [capacity] A component's capacity. -Type: **decimal** +Type: **decimal** + @@ -131,7 +141,8 @@ A component's capacity. [children]: #children #### [children] A components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -141,7 +152,8 @@ A components sub components. Devices that are usually integrated or in some way [componentRevision]: #componentrevision #### [componentRevision] A component's Revision. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ A component's Revision. [downlinkHardwareComponents]: #downlinkhardwarecomponents #### [downlinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -161,7 +174,8 @@ A component's Revision. [hardware]: #hardware #### [hardware] The hardware object that this component belongs to. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -171,7 +185,8 @@ The hardware object that this component belongs to. [hardwareComponentModel]: #hardwarecomponentmodel #### [hardwareComponentModel] The general group of component models. -Type: **SoftLayer_Hardware_Component_Model ** +Type: **SoftLayer_Hardware_Component_Model ** + @@ -181,7 +196,8 @@ The general group of component models. [hardwareComponentType]: #hardwarecomponenttype #### [hardwareComponentType] A components type. -Type: **SoftLayer_Hardware_Component_Type ** +Type: **SoftLayer_Hardware_Component_Type ** + @@ -191,7 +207,8 @@ A components type. [isChildModule]: #ischildmodule #### [isChildModule] -Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ A components type. [logicalVolumeStorageGroups]: #logicalvolumestoragegroups #### [logicalVolumeStorageGroups] Returns the associated logic volume storage groups for the hardware component. -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + @@ -211,7 +229,8 @@ Returns the associated logic volume storage groups for the hardware component. [m2SataSlotCapacity]: #m2sataslotcapacity #### [m2SataSlotCapacity] A component's M.2 SATA capacity. -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ A component's M.2 SATA capacity. [moduleComponents]: #modulecomponents #### [moduleComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -231,7 +251,8 @@ The module's hardware components [moduleHardwareComponents]: #modulehardwarecomponents #### [moduleHardwareComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -241,7 +262,8 @@ The module's hardware components [moduleNetworkComponents]: #modulenetworkcomponents #### [moduleNetworkComponents] The module's network components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -251,7 +273,8 @@ The module's network components [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -261,7 +284,8 @@ The module's network components [networkComponents]: #networkcomponents #### [networkComponents] The components local ethernet and remote management interfaces -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -271,7 +295,8 @@ The components local ethernet and remote management interfaces [owner]: #owner #### [owner] The account this component belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -281,7 +306,8 @@ The account this component belongs to. [parent]: #parent #### [parent] A components parent. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -291,7 +317,8 @@ A components parent. Devices that are usually integrated or in some way attached [parentModule]: #parentmodule #### [parentModule] -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -301,7 +328,8 @@ A components parent. Devices that are usually integrated or in some way attached [prefixAttribute]: #prefixattribute #### [prefixAttribute] -Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** +Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** + @@ -311,7 +339,8 @@ A components parent. Devices that are usually integrated or in some way attached [raidMode]: #raidmode #### [raidMode] A RAID controllers RAID mode. -Type: **string** +Type: **string** + @@ -321,7 +350,8 @@ A RAID controllers RAID mode. [revision]: #revision #### [revision] The component revision designation. -Type: **SoftLayer_Hardware_Component_Revision ** +Type: **SoftLayer_Hardware_Component_Revision ** + @@ -331,7 +361,8 @@ The component revision designation. [serviceProvider]: #serviceprovider #### [serviceProvider] -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -341,7 +372,8 @@ The component revision designation. [uplinkHardwareComponents]: #uplinkhardwarecomponents #### [uplinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -353,7 +385,8 @@ The component revision designation. [childrenCount]: #childrencount #### [childrenCount] A count of a components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **unsigned long** +Type: **unsigned long** + @@ -363,7 +396,8 @@ A count of a components sub components. Devices that are usually integrated or i [downlinkHardwareComponentCount]: #downlinkhardwarecomponentcount #### [downlinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -373,7 +407,8 @@ A count of [logicalVolumeStorageGroupCount]: #logicalvolumestoragegroupcount #### [logicalVolumeStorageGroupCount] A count of returns the associated logic volume storage groups for the hardware component. -Type: **unsigned long** +Type: **unsigned long** + @@ -383,7 +418,8 @@ A count of returns the associated logic volume storage groups for the hardware c [moduleComponentCount]: #modulecomponentcount #### [moduleComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -393,7 +429,8 @@ A count of the module's hardware components [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -403,7 +440,8 @@ A count of [moduleHardwareComponentCount]: #modulehardwarecomponentcount #### [moduleHardwareComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -413,7 +451,8 @@ A count of the module's hardware components [moduleNetworkComponentCount]: #modulenetworkcomponentcount #### [moduleNetworkComponentCount] A count of the module's network components -Type: **unsigned long** +Type: **unsigned long** + @@ -423,7 +462,8 @@ A count of the module's network components [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of the components local ethernet and remote management interfaces -Type: **unsigned long** +Type: **unsigned long** + @@ -433,7 +473,8 @@ A count of the components local ethernet and remote management interfaces [uplinkHardwareComponentCount]: #uplinkhardwarecomponentcount #### [uplinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_SecurityDevice_Infineon/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_SecurityDevice_Infineon/_index.md index f500e60d03..888bf80460 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_SecurityDevice_Infineon/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_SecurityDevice_Infineon/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component_SecurityDevice_Infineon is used to determine the Infineon security device attached to the hardware component. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_SecurityDevice_Infineon is used to determine th [hardwareComponentModelId]: #hardwarecomponentmodelid #### [hardwareComponentModelId] The internal identifier of a hardware component's component model. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of a hardware component's component model. [hardwareId]: #hardwareid #### [hardwareId] The internal identifier of the hardware that a hardware component resides inside. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The internal identifier of the hardware that a hardware component resides inside [id]: #id #### [id] A hardware component's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A hardware component's internal identifier. [modifyDate]: #modifydate #### [modifyDate] The date that a hardware component was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The date that a hardware component was last modified. [name]: #name #### [name] The name of this component as referenced by the operating system. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The name of this component as referenced by the operating system. [serialNumber]: #serialnumber #### [serialNumber] The component serial number. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The component serial number. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ A hardware's internal identification number at its service provider [capacity]: #capacity #### [capacity] A component's capacity. -Type: **decimal** +Type: **decimal** + @@ -131,7 +141,8 @@ A component's capacity. [children]: #children #### [children] A components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -141,7 +152,8 @@ A components sub components. Devices that are usually integrated or in some way [componentRevision]: #componentrevision #### [componentRevision] A component's Revision. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ A component's Revision. [downlinkHardwareComponents]: #downlinkhardwarecomponents #### [downlinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -161,7 +174,8 @@ A component's Revision. [hardware]: #hardware #### [hardware] The hardware object that this component belongs to. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -171,7 +185,8 @@ The hardware object that this component belongs to. [hardwareComponentModel]: #hardwarecomponentmodel #### [hardwareComponentModel] The general group of component models. -Type: **SoftLayer_Hardware_Component_Model ** +Type: **SoftLayer_Hardware_Component_Model ** + @@ -181,7 +196,8 @@ The general group of component models. [hardwareComponentType]: #hardwarecomponenttype #### [hardwareComponentType] A components type. -Type: **SoftLayer_Hardware_Component_Type ** +Type: **SoftLayer_Hardware_Component_Type ** + @@ -191,7 +207,8 @@ A components type. [isChildModule]: #ischildmodule #### [isChildModule] -Type: **boolean** +Type: **boolean** + @@ -201,7 +218,8 @@ A components type. [logicalVolumeStorageGroups]: #logicalvolumestoragegroups #### [logicalVolumeStorageGroups] Returns the associated logic volume storage groups for the hardware component. -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + @@ -211,7 +229,8 @@ Returns the associated logic volume storage groups for the hardware component. [m2SataSlotCapacity]: #m2sataslotcapacity #### [m2SataSlotCapacity] A component's M.2 SATA capacity. -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ A component's M.2 SATA capacity. [moduleComponents]: #modulecomponents #### [moduleComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -231,7 +251,8 @@ The module's hardware components [moduleHardwareComponents]: #modulehardwarecomponents #### [moduleHardwareComponents] The module's hardware components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -241,7 +262,8 @@ The module's hardware components [moduleNetworkComponents]: #modulenetworkcomponents #### [moduleNetworkComponents] The module's network components -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -251,7 +273,8 @@ The module's network components [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -261,7 +284,8 @@ The module's network components [networkComponents]: #networkcomponents #### [networkComponents] The components local ethernet and remote management interfaces -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -271,7 +295,8 @@ The components local ethernet and remote management interfaces [owner]: #owner #### [owner] The account this component belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -281,7 +306,8 @@ The account this component belongs to. [parent]: #parent #### [parent] A components parent. Devices that are usually integrated or in some way attached to a component. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -291,7 +317,8 @@ A components parent. Devices that are usually integrated or in some way attached [parentModule]: #parentmodule #### [parentModule] -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -301,7 +328,8 @@ A components parent. Devices that are usually integrated or in some way attached [prefixAttribute]: #prefixattribute #### [prefixAttribute] -Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** +Type: **SoftLayer_Hardware_Component_Model_Generic_Attribute ** + @@ -311,7 +339,8 @@ A components parent. Devices that are usually integrated or in some way attached [raidMode]: #raidmode #### [raidMode] A RAID controllers RAID mode. -Type: **string** +Type: **string** + @@ -321,7 +350,8 @@ A RAID controllers RAID mode. [revision]: #revision #### [revision] The component revision designation. -Type: **SoftLayer_Hardware_Component_Revision ** +Type: **SoftLayer_Hardware_Component_Revision ** + @@ -331,7 +361,8 @@ The component revision designation. [serviceProvider]: #serviceprovider #### [serviceProvider] -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -341,7 +372,8 @@ The component revision designation. [uplinkHardwareComponents]: #uplinkhardwarecomponents #### [uplinkHardwareComponents] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -353,7 +385,8 @@ The component revision designation. [childrenCount]: #childrencount #### [childrenCount] A count of a components sub components. Devices that are usually integrated or in some way attached to a component. -Type: **unsigned long** +Type: **unsigned long** + @@ -363,7 +396,8 @@ A count of a components sub components. Devices that are usually integrated or i [downlinkHardwareComponentCount]: #downlinkhardwarecomponentcount #### [downlinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -373,7 +407,8 @@ A count of [logicalVolumeStorageGroupCount]: #logicalvolumestoragegroupcount #### [logicalVolumeStorageGroupCount] A count of returns the associated logic volume storage groups for the hardware component. -Type: **unsigned long** +Type: **unsigned long** + @@ -383,7 +418,8 @@ A count of returns the associated logic volume storage groups for the hardware c [moduleComponentCount]: #modulecomponentcount #### [moduleComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -393,7 +429,8 @@ A count of the module's hardware components [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -403,7 +440,8 @@ A count of [moduleHardwareComponentCount]: #modulehardwarecomponentcount #### [moduleHardwareComponentCount] A count of the module's hardware components -Type: **unsigned long** +Type: **unsigned long** + @@ -413,7 +451,8 @@ A count of the module's hardware components [moduleNetworkComponentCount]: #modulenetworkcomponentcount #### [moduleNetworkComponentCount] A count of the module's network components -Type: **unsigned long** +Type: **unsigned long** + @@ -423,7 +462,8 @@ A count of the module's network components [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of the components local ethernet and remote management interfaces -Type: **unsigned long** +Type: **unsigned long** + @@ -433,7 +473,8 @@ A count of the components local ethernet and remote management interfaces [uplinkHardwareComponentCount]: #uplinkhardwarecomponentcount #### [uplinkHardwareComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Component_Type/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Component_Type/_index.md index bbb458aa0a..d19d810960 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Component_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Component_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Component_Type data type provides details on the type of component requested @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Component_Type data type provides details on the type of [id]: #id #### [id] The ID associated with this component type. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The ID associated with this component type. [keyName]: #keyname #### [keyName] The hardware component type key name or code. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The hardware component type key name or code. [type]: #type #### [type] The type associated with this component type. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The type associated with this component type. [typeParentId]: #typeparentid #### [typeParentId] The parent id associated with this component type. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The parent id associated with this component type. [hardwareGenericComponentModels]: #hardwaregenericcomponentmodels #### [hardwareGenericComponentModels] The generic component model description for this component type object. -Type: **SoftLayer_Hardware_Component_Model_Generic[] ** +Type: **SoftLayer_Hardware_Component_Model_Generic[] ** + @@ -101,7 +108,8 @@ The generic component model description for this component type object. [typeParent]: #typeparent #### [typeParent] The parent generic component model object for this generic component model object. -Type: **SoftLayer_Hardware_Component_Type ** +Type: **SoftLayer_Hardware_Component_Type ** + @@ -113,7 +121,8 @@ The parent generic component model object for this generic component model objec [hardwareGenericComponentModelCount]: #hardwaregenericcomponentmodelcount #### [hardwareGenericComponentModelCount] A count of the generic component model description for this component type object. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Firewall/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Firewall/_index.md index bd5416af26..bf99998496 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Firewall/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Firewall/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Firewall data type contains general information relating to a single SoftLayer firewall. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Firewall data type contains general information relating [accountId]: #accountid #### [accountId] A hardware's associated [SoftLayer_Account]({{}}) id. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ A hardware's associated [SoftLayer_Account]({{Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ When true, this flag specifies that a hardware is Bare Metal Server. Bare Metal [domain]: #domain #### [domain] A piece of hardware's local network domain name. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A piece of hardware's local network domain name. [fullyQualifiedDomainName]: #fullyqualifieddomainname #### [fullyQualifiedDomainName] A name reflecting the hostname and domain of the hardware. This is created from the combined values of the hardware's hostname and domain name automatically, and thus should not be edited directly. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ A name reflecting the hostname and domain of the hardware. This is created from [hardwareStatusId]: #hardwarestatusid #### [hardwareStatusId] A number reflecting the state of a hardware -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ A number reflecting the state of a hardware [hostname]: #hostname #### [hostname] A hardware's hostname -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ A hardware's hostname [id]: #id #### [id] A hardware's internal identification number -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A hardware's internal identification number [manufacturerSerialNumber]: #manufacturerserialnumber #### [manufacturerSerialNumber] A hardware's serial number that is supplied by the manufacturer. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A hardware's serial number that is supplied by the manufacturer. [notes]: #notes #### [notes] A small note about a piece of hardware to use at your discretion. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ A small note about a piece of hardware to use at your discretion. [postInstallScriptUri]: #postinstallscripturi #### [postInstallScriptUri] URI of the script to be downloaded and executed after installation is complete. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ URI of the script to be downloaded and executed after installation is complete. [provisionDate]: #provisiondate #### [provisionDate] -Type: **dateTime** +Type: **dateTime** + @@ -155,7 +168,8 @@ URI of the script to be downloaded and executed after installation is complete. [serialNumber]: #serialnumber #### [serialNumber] A hardware's serial number that is supplied by SoftLayer. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderResourceId]: #serviceproviderresourceid #### [serviceProviderResourceId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -191,7 +207,8 @@ A hardware's internal identification number at its service provider [account]: #account #### [account] The account associated with a piece of hardware. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -201,7 +218,8 @@ The account associated with a piece of hardware. [activeComponents]: #activecomponents #### [activeComponents] A piece of hardware's active physical components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -211,7 +229,8 @@ A piece of hardware's active physical components. [activeNetworkMonitorIncident]: #activenetworkmonitorincident #### [activeNetworkMonitorIncident] A piece of hardware's active network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -221,7 +240,8 @@ A piece of hardware's active network monitoring incidents. [allPowerComponents]: #allpowercomponents #### [allPowerComponents] -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -231,7 +251,8 @@ A piece of hardware's active network monitoring incidents. [allowedHost]: #allowedhost #### [allowedHost] The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. -Type: **SoftLayer_Network_Storage_Allowed_Host ** +Type: **SoftLayer_Network_Storage_Allowed_Host ** + @@ -241,7 +262,8 @@ The SoftLayer_Network_Storage_Allowed_Host information to connect this server to [allowedNetworkStorage]: #allowednetworkstorage #### [allowedNetworkStorage] The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -251,7 +273,8 @@ The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to [allowedNetworkStorageReplicas]: #allowednetworkstoragereplicas #### [allowedNetworkStorageReplicas] The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -261,7 +284,8 @@ The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware [antivirusSpywareSoftwareComponent]: #antivirusspywaresoftwarecomponent #### [antivirusSpywareSoftwareComponent] Information regarding an antivirus/spyware software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -271,7 +295,8 @@ Information regarding an antivirus/spyware software component object. [attributes]: #attributes #### [attributes] Information regarding a piece of hardware's specific attributes. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -281,7 +306,8 @@ Information regarding a piece of hardware's specific attributes. [averageDailyPublicBandwidthUsage]: #averagedailypublicbandwidthusage #### [averageDailyPublicBandwidthUsage] The average daily public bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -291,7 +317,8 @@ The average daily public bandwidth usage for the current billing cycle. [backendNetworkComponents]: #backendnetworkcomponents #### [backendNetworkComponents] A piece of hardware's back-end or private network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -301,7 +328,8 @@ A piece of hardware's back-end or private network components. [backendRouters]: #backendrouters #### [backendRouters] A hardware's backend or private router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -311,7 +339,8 @@ A hardware's backend or private router. [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] A hardware's allotted bandwidth (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -321,7 +350,8 @@ A hardware's allotted bandwidth (measured in GB). [bandwidthAllotmentDetail]: #bandwidthallotmentdetail #### [bandwidthAllotmentDetail] A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** + @@ -331,7 +361,8 @@ A hardware's allotted detail record. Allotment details link bandwidth allocation [benchmarkCertifications]: #benchmarkcertifications #### [benchmarkCertifications] Information regarding a piece of hardware's benchmark certifications. -Type: **SoftLayer_Hardware_Benchmark_Certification[] ** +Type: **SoftLayer_Hardware_Benchmark_Certification[] ** + @@ -341,7 +372,8 @@ Information regarding a piece of hardware's benchmark certifications. [billingItem]: #billingitem #### [billingItem] Information regarding the billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -351,7 +383,8 @@ Information regarding the billing item for a server. [billingItemFlag]: #billingitemflag #### [billingItemFlag] A flag indicating that a billing item exists. -Type: **boolean** +Type: **boolean** + @@ -361,7 +394,8 @@ A flag indicating that a billing item exists. [blockCancelBecauseDisconnectedFlag]: #blockcancelbecausedisconnectedflag #### [blockCancelBecauseDisconnectedFlag] Determines whether the hardware is ineligible for cancellation because it is disconnected. -Type: **boolean** +Type: **boolean** + @@ -371,7 +405,8 @@ Determines whether the hardware is ineligible for cancellation because it is dis [businessContinuanceInsuranceFlag]: #businesscontinuanceinsuranceflag #### [businessContinuanceInsuranceFlag] Status indicating whether or not a piece of hardware has business continuance insurance. -Type: **boolean** +Type: **boolean** + @@ -381,7 +416,8 @@ Status indicating whether or not a piece of hardware has business continuance in [childrenHardware]: #childrenhardware #### [childrenHardware] Child hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -391,7 +427,8 @@ Child hardware. [components]: #components #### [components] A piece of hardware's components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -401,7 +438,8 @@ A piece of hardware's components. [continuousDataProtectionSoftwareComponent]: #continuousdataprotectionsoftwarecomponent #### [continuousDataProtectionSoftwareComponent] A continuous data protection/server backup software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -411,7 +449,8 @@ A continuous data protection/server backup software component object. [currentBillableBandwidthUsage]: #currentbillablebandwidthusage #### [currentBillableBandwidthUsage] The current billable public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -421,7 +460,8 @@ The current billable public outbound bandwidth for this hardware for the current [datacenter]: #datacenter #### [datacenter] Information regarding the datacenter in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -431,7 +471,8 @@ Information regarding the datacenter in which a piece of hardware resides. [datacenterName]: #datacentername #### [datacenterName] The name of the datacenter in which a piece of hardware resides. -Type: **string** +Type: **string** + @@ -441,7 +482,8 @@ The name of the datacenter in which a piece of hardware resides. [daysInSparePool]: #daysinsparepool #### [daysInSparePool] Number of day(s) a server have been in spare pool. -Type: **integer** +Type: **integer** + @@ -451,7 +493,8 @@ Number of day(s) a server have been in spare pool. [downlinkHardware]: #downlinkhardware #### [downlinkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -461,7 +504,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkNetworkHardware]: #downlinknetworkhardware #### [downlinkNetworkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -471,7 +515,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkServers]: #downlinkservers #### [downlinkServers] Information regarding all servers attached to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -481,7 +526,8 @@ Information regarding all servers attached to a piece of network hardware. [downlinkVirtualGuests]: #downlinkvirtualguests #### [downlinkVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -491,7 +537,8 @@ Information regarding all virtual guests attached to a piece of network hardware [downstreamHardwareBindings]: #downstreamhardwarebindings #### [downstreamHardwareBindings] All hardware downstream from a network device. -Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** +Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** + @@ -501,7 +548,8 @@ All hardware downstream from a network device. [downstreamNetworkHardware]: #downstreamnetworkhardware #### [downstreamNetworkHardware] All network hardware downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -511,7 +559,8 @@ All network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidents]: #downstreamnetworkhardwarewithincidents #### [downstreamNetworkHardwareWithIncidents] All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -521,7 +570,8 @@ All network hardware with monitoring warnings or errors that are downstream from [downstreamServers]: #downstreamservers #### [downstreamServers] Information regarding all servers attached downstream to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -531,7 +581,8 @@ Information regarding all servers attached downstream to a piece of network hard [downstreamVirtualGuests]: #downstreamvirtualguests #### [downstreamVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -541,7 +592,8 @@ Information regarding all virtual guests attached to a piece of network hardware [driveControllers]: #drivecontrollers #### [driveControllers] The drive controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -551,7 +603,8 @@ The drive controllers contained within a piece of hardware. [evaultNetworkStorage]: #evaultnetworkstorage #### [evaultNetworkStorage] Information regarding a piece of hardware's associated EVault network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -561,7 +614,8 @@ Information regarding a piece of hardware's associated EVault network storage se [firewallServiceComponent]: #firewallservicecomponent #### [firewallServiceComponent] Information regarding a piece of hardware's firewall services. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -571,7 +625,8 @@ Information regarding a piece of hardware's firewall services. [fixedConfigurationPreset]: #fixedconfigurationpreset #### [fixedConfigurationPreset] Defines the fixed components in a fixed configuration bare metal server. -Type: **SoftLayer_Product_Package_Preset ** +Type: **SoftLayer_Product_Package_Preset ** + @@ -581,7 +636,8 @@ Defines the fixed components in a fixed configuration bare metal server. [frontendNetworkComponents]: #frontendnetworkcomponents #### [frontendNetworkComponents] A piece of hardware's front-end or public network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -591,7 +647,8 @@ A piece of hardware's front-end or public network components. [frontendRouters]: #frontendrouters #### [frontendRouters] A hardware's frontend or public router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -601,7 +658,8 @@ A hardware's frontend or public router. [futureBillingItem]: #futurebillingitem #### [futureBillingItem] Information regarding the future billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -611,7 +669,8 @@ Information regarding the future billing item for a server. [globalIdentifier]: #globalidentifier #### [globalIdentifier] A hardware's universally unique identifier. -Type: **string** +Type: **string** + @@ -621,7 +680,8 @@ A hardware's universally unique identifier. [hardDrives]: #harddrives #### [hardDrives] The hard drives contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -631,7 +691,8 @@ The hard drives contained within a piece of hardware. [hardwareChassis]: #hardwarechassis #### [hardwareChassis] The chassis that a piece of hardware is housed in. -Type: **SoftLayer_Hardware_Chassis ** +Type: **SoftLayer_Hardware_Chassis ** + @@ -641,7 +702,8 @@ The chassis that a piece of hardware is housed in. [hardwareFunction]: #hardwarefunction #### [hardwareFunction] A hardware's function. -Type: **SoftLayer_Hardware_Function ** +Type: **SoftLayer_Hardware_Function ** + @@ -651,7 +713,8 @@ A hardware's function. [hardwareFunctionDescription]: #hardwarefunctiondescription #### [hardwareFunctionDescription] A hardware's function. -Type: **string** +Type: **string** + @@ -661,7 +724,8 @@ A hardware's function. [hardwareStatus]: #hardwarestatus #### [hardwareStatus] A hardware's status. -Type: **SoftLayer_Hardware_Status ** +Type: **SoftLayer_Hardware_Status ** + @@ -671,7 +735,8 @@ A hardware's status. [hasTrustedPlatformModuleBillingItemFlag]: #hastrustedplatformmodulebillingitemflag #### [hasTrustedPlatformModuleBillingItemFlag] Determine in hardware object has TPM enabled. -Type: **boolean** +Type: **boolean** + @@ -681,7 +746,8 @@ Determine in hardware object has TPM enabled. [hostIpsSoftwareComponent]: #hostipssoftwarecomponent #### [hostIpsSoftwareComponent] Information regarding a host IPS software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -691,7 +757,8 @@ Information regarding a host IPS software component object. [hourlyBillingFlag]: #hourlybillingflag #### [hourlyBillingFlag] A server's hourly billing status. -Type: **boolean** +Type: **boolean** + @@ -701,7 +768,8 @@ A server's hourly billing status. [inboundBandwidthUsage]: #inboundbandwidthusage #### [inboundBandwidthUsage] The sum of all the inbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -711,7 +779,8 @@ The sum of all the inbound network traffic data for the last 30 days. [inboundPublicBandwidthUsage]: #inboundpublicbandwidthusage #### [inboundPublicBandwidthUsage] The total public inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -721,7 +790,8 @@ The total public inbound bandwidth for this hardware for the current billing cyc [isBillingTermChangeAvailableFlag]: #isbillingtermchangeavailableflag #### [isBillingTermChangeAvailableFlag] Whether or not this hardware object is eligible to change to term billing. -Type: **boolean** +Type: **boolean** + @@ -731,7 +801,8 @@ Whether or not this hardware object is eligible to change to term billing. [lastTransaction]: #lasttransaction #### [lastTransaction] Information regarding the last transaction a server performed. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -741,7 +812,8 @@ Information regarding the last transaction a server performed. [latestNetworkMonitorIncident]: #latestnetworkmonitorincident #### [latestNetworkMonitorIncident] A piece of hardware's latest network monitoring incident. -Type: **SoftLayer_Network_Monitor_Version1_Incident ** +Type: **SoftLayer_Network_Monitor_Version1_Incident ** + @@ -751,7 +823,8 @@ A piece of hardware's latest network monitoring incident. [location]: #location #### [location] Where a piece of hardware is located within SoftLayer's location hierarchy. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -761,7 +834,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [locationPathString]: #locationpathstring #### [locationPathString] -Type: **string** +Type: **string** + @@ -771,7 +845,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [lockboxNetworkStorage]: #lockboxnetworkstorage #### [lockboxNetworkStorage] Information regarding a lockbox account associated with a server. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -781,7 +856,8 @@ Information regarding a lockbox account associated with a server. [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the hardware is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ A flag indicating that the hardware is a managed resource. [memory]: #memory #### [memory] Information regarding a piece of hardware's memory. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -801,7 +878,8 @@ Information regarding a piece of hardware's memory. [memoryCapacity]: #memorycapacity #### [memoryCapacity] The amount of memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -811,7 +889,8 @@ The amount of memory a piece of hardware has, measured in gigabytes. [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A piece of hardware's metric tracking object. -Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** +Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** + @@ -821,7 +900,8 @@ A piece of hardware's metric tracking object. [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -831,7 +911,8 @@ A piece of hardware's metric tracking object. [monitoringRobot]: #monitoringrobot #### [monitoringRobot] -Type: **SoftLayer_Monitoring_Robot ** +Type: **SoftLayer_Monitoring_Robot ** + @@ -841,7 +922,8 @@ A piece of hardware's metric tracking object. [monitoringServiceComponent]: #monitoringservicecomponent #### [monitoringServiceComponent] Information regarding a piece of hardware's network monitoring services. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** + @@ -851,7 +933,8 @@ Information regarding a piece of hardware's network monitoring services. [monitoringServiceEligibilityFlag]: #monitoringserviceeligibilityflag #### [monitoringServiceEligibilityFlag] -Type: **boolean** +Type: **boolean** + @@ -861,7 +944,8 @@ Information regarding a piece of hardware's network monitoring services. [motherboard]: #motherboard #### [motherboard] Information regarding a piece of hardware's motherboard. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -871,7 +955,8 @@ Information regarding a piece of hardware's motherboard. [networkCards]: #networkcards #### [networkCards] Information regarding a piece of hardware's network cards. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -881,7 +966,8 @@ Information regarding a piece of hardware's network cards. [networkComponents]: #networkcomponents #### [networkComponents] Returns a hardware's network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -891,7 +977,8 @@ Returns a hardware's network components. [networkGatewayMember]: #networkgatewaymember #### [networkGatewayMember] The gateway member if this device is part of a network gateway. -Type: **SoftLayer_Network_Gateway_Member ** +Type: **SoftLayer_Network_Gateway_Member ** + @@ -901,7 +988,8 @@ The gateway member if this device is part of a network gateway. [networkGatewayMemberFlag]: #networkgatewaymemberflag #### [networkGatewayMemberFlag] Whether or not this device is part of a network gateway. -Type: **boolean** +Type: **boolean** + @@ -911,7 +999,8 @@ Whether or not this device is part of a network gateway. [networkMonitorAttachedDownHardware]: #networkmonitorattacheddownhardware #### [networkMonitorAttachedDownHardware] All servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -921,7 +1010,8 @@ All servers with failed monitoring that are attached downstream to a piece of ha [networkMonitorAttachedDownVirtualGuests]: #networkmonitorattacheddownvirtualguests #### [networkMonitorAttachedDownVirtualGuests] Virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -931,7 +1021,8 @@ Virtual guests that are attached downstream to a hardware that have failed monit [networkMonitorIncidents]: #networkmonitorincidents #### [networkMonitorIncidents] The status of all of a piece of hardware's network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -941,7 +1032,8 @@ The status of all of a piece of hardware's network monitoring incidents. [networkMonitors]: #networkmonitors #### [networkMonitors] Information regarding a piece of hardware's network monitors. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** + @@ -951,7 +1043,8 @@ Information regarding a piece of hardware's network monitors. [networkStatus]: #networkstatus #### [networkStatus] The value of a hardware's network status attribute. -Type: **string** +Type: **string** + @@ -961,7 +1054,8 @@ The value of a hardware's network status attribute. [networkStatusAttribute]: #networkstatusattribute #### [networkStatusAttribute] The hardware's related network status attribute. -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -971,7 +1065,8 @@ The hardware's related network status attribute. [networkStorage]: #networkstorage #### [networkStorage] Information regarding a piece of hardware's associated network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -981,7 +1076,8 @@ Information regarding a piece of hardware's associated network storage service a [networkVlans]: #networkvlans #### [networkVlans] The network virtual LANs (VLANs) associated with a piece of hardware's network components. -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -991,7 +1087,8 @@ The network virtual LANs (VLANs) associated with a piece of hardware's network c [nextBillingCycleBandwidthAllocation]: #nextbillingcyclebandwidthallocation #### [nextBillingCycleBandwidthAllocation] A hardware's allotted bandwidth for the next billing cycle (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -1001,7 +1098,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [notesHistory]: #noteshistory #### [notesHistory] -Type: **SoftLayer_Hardware_Note[] ** +Type: **SoftLayer_Hardware_Note[] ** + @@ -1011,7 +1109,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [nvRamCapacity]: #nvramcapacity #### [nvRamCapacity] The amount of non-volatile memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1021,7 +1120,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [nvRamComponentModels]: #nvramcomponentmodels #### [nvRamComponentModels] -Type: **SoftLayer_Hardware_Component_Model[] ** +Type: **SoftLayer_Hardware_Component_Model[] ** + @@ -1031,7 +1131,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [operatingSystemReferenceCode]: #operatingsystemreferencecode #### [operatingSystemReferenceCode] A hardware's operating system software description. -Type: **string** +Type: **string** + @@ -1041,7 +1142,8 @@ A hardware's operating system software description. [outboundBandwidthUsage]: #outboundbandwidthusage #### [outboundBandwidthUsage] The sum of all the outbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -1051,7 +1153,8 @@ The sum of all the outbound network traffic data for the last 30 days. [outboundPublicBandwidthUsage]: #outboundpublicbandwidthusage #### [outboundPublicBandwidthUsage] The total public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -1061,7 +1164,8 @@ The total public outbound bandwidth for this hardware for the current billing cy [parentBay]: #parentbay #### [parentBay] Blade Bay -Type: **SoftLayer_Hardware_Blade ** +Type: **SoftLayer_Hardware_Blade ** + @@ -1071,7 +1175,8 @@ Blade Bay [parentHardware]: #parenthardware #### [parentHardware] Parent Hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1081,7 +1186,8 @@ Parent Hardware. [pointOfPresenceLocation]: #pointofpresencelocation #### [pointOfPresenceLocation] Information regarding the Point of Presence (PoP) location in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1091,7 +1197,8 @@ Information regarding the Point of Presence (PoP) location in which a piece of h [powerComponents]: #powercomponents #### [powerComponents] The power components for a hardware object. -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -1101,7 +1208,8 @@ The power components for a hardware object. [powerSupply]: #powersupply #### [powerSupply] Information regarding a piece of hardware's power supply. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1111,7 +1219,8 @@ Information regarding a piece of hardware's power supply. [primaryIpAddress]: #primaryipaddress #### [primaryIpAddress] The firewall's primary public IP address. -Type: **string** +Type: **string** + @@ -1121,7 +1230,8 @@ The firewall's primary public IP address. [privateNetworkOnlyFlag]: #privatenetworkonlyflag #### [privateNetworkOnlyFlag] Whether the hardware only has access to the private network. -Type: **boolean** +Type: **boolean** + @@ -1131,7 +1241,8 @@ Whether the hardware only has access to the private network. [processorCoreAmount]: #processorcoreamount #### [processorCoreAmount] The total number of processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1141,7 +1252,8 @@ The total number of processor cores, summed from all processors that are attache [processorPhysicalCoreAmount]: #processorphysicalcoreamount #### [processorPhysicalCoreAmount] The total number of physical processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1151,7 +1263,8 @@ The total number of physical processor cores, summed from all processors that ar [processors]: #processors #### [processors] Information regarding a piece of hardware's processors. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1161,7 +1274,8 @@ Information regarding a piece of hardware's processors. [rack]: #rack #### [rack] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1171,7 +1285,8 @@ Information regarding a piece of hardware's processors. [raidControllers]: #raidcontrollers #### [raidControllers] The RAID controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1181,7 +1296,8 @@ The RAID controllers contained within a piece of hardware. [recentEvents]: #recentevents #### [recentEvents] Recent events that impact this hardware. -Type: **SoftLayer_Notification_Occurrence_Event[] ** +Type: **SoftLayer_Notification_Occurrence_Event[] ** + @@ -1191,7 +1307,8 @@ Recent events that impact this hardware. [remoteManagementAccounts]: #remotemanagementaccounts #### [remoteManagementAccounts] User credentials to issue commands and/or interact with the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** + @@ -1201,7 +1318,8 @@ User credentials to issue commands and/or interact with the server's remote mana [remoteManagementComponent]: #remotemanagementcomponent #### [remoteManagementComponent] A hardware's associated remote management component. This is normally IPMI. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1211,7 +1329,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceConfigurations]: #resourceconfigurations #### [resourceConfigurations] -Type: **SoftLayer_Hardware_Resource_Configuration[] ** +Type: **SoftLayer_Hardware_Resource_Configuration[] ** + @@ -1221,7 +1340,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroupMemberReferences]: #resourcegroupmemberreferences #### [resourceGroupMemberReferences] -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -1231,7 +1351,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroupRoles]: #resourcegrouproles #### [resourceGroupRoles] -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -1241,7 +1362,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroups]: #resourcegroups #### [resourceGroups] The resource groups in which this hardware is a member. -Type: **SoftLayer_Resource_Group[] ** +Type: **SoftLayer_Resource_Group[] ** + @@ -1251,7 +1373,8 @@ The resource groups in which this hardware is a member. [routers]: #routers #### [routers] A hardware's routers. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1261,7 +1384,8 @@ A hardware's routers. [scaleAssets]: #scaleassets #### [scaleAssets] Collection of scale assets this hardware corresponds to. -Type: **SoftLayer_Scale_Asset[] ** +Type: **SoftLayer_Scale_Asset[] ** + @@ -1271,7 +1395,8 @@ Collection of scale assets this hardware corresponds to. [securityScanRequests]: #securityscanrequests #### [securityScanRequests] Information regarding a piece of hardware's vulnerability scan requests. -Type: **SoftLayer_Network_Security_Scanner_Request[] ** +Type: **SoftLayer_Network_Security_Scanner_Request[] ** + @@ -1281,7 +1406,8 @@ Information regarding a piece of hardware's vulnerability scan requests. [serverRoom]: #serverroom #### [serverRoom] Information regarding the server room in which the hardware is located. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1291,7 +1417,8 @@ Information regarding the server room in which the hardware is located. [serviceProvider]: #serviceprovider #### [serviceProvider] Information regarding the piece of hardware's service provider. -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -1301,7 +1428,8 @@ Information regarding the piece of hardware's service provider. [softwareComponents]: #softwarecomponents #### [softwareComponents] Information regarding a piece of hardware's installed software. -Type: **SoftLayer_Software_Component[] ** +Type: **SoftLayer_Software_Component[] ** + @@ -1311,7 +1439,8 @@ Information regarding a piece of hardware's installed software. [sparePoolBillingItem]: #sparepoolbillingitem #### [sparePoolBillingItem] Information regarding the billing item for a spare pool server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -1321,7 +1450,8 @@ Information regarding the billing item for a spare pool server. [sshKeys]: #sshkeys #### [sshKeys] SSH keys to be installed on the server during provisioning or an OS reload. -Type: **SoftLayer_Security_Ssh_Key[] ** +Type: **SoftLayer_Security_Ssh_Key[] ** + @@ -1331,17 +1461,20 @@ SSH keys to be installed on the server during provisioning or an OS reload. [storageGroups]: #storagegroups #### [storageGroups] -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + -
      +
      ----- [storageNetworkComponents]: #storagenetworkcomponents #### [storageNetworkComponents] A piece of hardware's private storage network components. [Deprecated] -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + +Deprecated
      @@ -1351,7 +1484,8 @@ A piece of hardware's private storage network components. [Deprecated] [tagReferences]: #tagreferences #### [tagReferences] -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** +
      @@ -1361,7 +1495,8 @@ A piece of hardware's private storage network components. [Deprecated] [topLevelLocation]: #toplevellocation #### [topLevelLocation] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1371,7 +1506,8 @@ A piece of hardware's private storage network components. [Deprecated] [upgradeRequest]: #upgraderequest #### [upgradeRequest] An account's associated upgrade request object, if any. -Type: **SoftLayer_Product_Upgrade_Request ** +Type: **SoftLayer_Product_Upgrade_Request ** + @@ -1381,7 +1517,8 @@ An account's associated upgrade request object, if any. [uplinkHardware]: #uplinkhardware #### [uplinkHardware] The network device connected to a piece of hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1391,7 +1528,8 @@ The network device connected to a piece of hardware. [uplinkNetworkComponents]: #uplinknetworkcomponents #### [uplinkNetworkComponents] Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -1401,7 +1539,8 @@ Information regarding the network component that is one level higher than a piec [userData]: #userdata #### [userData] An array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -1411,7 +1550,8 @@ An array containing a single string of custom user data for a hardware order. Ma [users]: #users #### [users] A list of users that have access to this hardware firewall. -Type: **SoftLayer_User_Customer[] ** +Type: **SoftLayer_User_Customer[] ** + @@ -1421,7 +1561,8 @@ A list of users that have access to this hardware firewall. [virtualChassis]: #virtualchassis #### [virtualChassis] Information regarding the virtual chassis for a piece of hardware. -Type: **SoftLayer_Hardware_Group ** +Type: **SoftLayer_Hardware_Group ** + @@ -1431,7 +1572,8 @@ Information regarding the virtual chassis for a piece of hardware. [virtualChassisSiblings]: #virtualchassissiblings #### [virtualChassisSiblings] Information regarding the virtual chassis siblings for a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1441,7 +1583,8 @@ Information regarding the virtual chassis siblings for a piece of hardware. [virtualHost]: #virtualhost #### [virtualHost] A piece of hardware's virtual host record. -Type: **SoftLayer_Virtual_Host ** +Type: **SoftLayer_Virtual_Host ** + @@ -1451,7 +1594,8 @@ A piece of hardware's virtual host record. [virtualLicenses]: #virtuallicenses #### [virtualLicenses] Information regarding a piece of hardware's virtual software licenses. -Type: **SoftLayer_Software_VirtualLicense[] ** +Type: **SoftLayer_Software_VirtualLicense[] ** + @@ -1461,7 +1605,8 @@ Information regarding a piece of hardware's virtual software licenses. [virtualRack]: #virtualrack #### [virtualRack] Information regarding the bandwidth allotment to which a piece of hardware belongs. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** + @@ -1471,7 +1616,8 @@ Information regarding the bandwidth allotment to which a piece of hardware belon [virtualRackId]: #virtualrackid #### [virtualRackId] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **integer** +Type: **integer** + @@ -1481,7 +1627,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualRackName]: #virtualrackname #### [virtualRackName] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **string** +Type: **string** + @@ -1491,7 +1638,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualizationPlatform]: #virtualizationplatform #### [virtualizationPlatform] A piece of hardware's virtualization platform software. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -1503,7 +1651,8 @@ A piece of hardware's virtualization platform software. [activeComponentCount]: #activecomponentcount #### [activeComponentCount] A count of a piece of hardware's active physical components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1513,7 +1662,8 @@ A count of a piece of hardware's active physical components. [activeNetworkMonitorIncidentCount]: #activenetworkmonitorincidentcount #### [activeNetworkMonitorIncidentCount] A count of a piece of hardware's active network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -1523,7 +1673,8 @@ A count of a piece of hardware's active network monitoring incidents. [allPowerComponentCount]: #allpowercomponentcount #### [allPowerComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1533,7 +1684,8 @@ A count of [allowedNetworkStorageCount]: #allowednetworkstoragecount #### [allowedNetworkStorageCount] A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1543,7 +1695,8 @@ A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware ha [allowedNetworkStorageReplicaCount]: #allowednetworkstoragereplicacount #### [allowedNetworkStorageReplicaCount] A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1553,7 +1706,8 @@ A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLay [attributeCount]: #attributecount #### [attributeCount] A count of information regarding a piece of hardware's specific attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -1563,7 +1717,8 @@ A count of information regarding a piece of hardware's specific attributes. [backendNetworkComponentCount]: #backendnetworkcomponentcount #### [backendNetworkComponentCount] A count of a piece of hardware's back-end or private network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1573,7 +1728,8 @@ A count of a piece of hardware's back-end or private network components. [backendRouterCount]: #backendroutercount #### [backendRouterCount] A count of a hardware's backend or private router. -Type: **unsigned long** +Type: **unsigned long** + @@ -1583,7 +1739,8 @@ A count of a hardware's backend or private router. [benchmarkCertificationCount]: #benchmarkcertificationcount #### [benchmarkCertificationCount] A count of information regarding a piece of hardware's benchmark certifications. -Type: **unsigned long** +Type: **unsigned long** + @@ -1593,7 +1750,8 @@ A count of information regarding a piece of hardware's benchmark certifications. [childrenHardwareCount]: #childrenhardwarecount #### [childrenHardwareCount] A count of child hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1603,7 +1761,8 @@ A count of child hardware. [componentCount]: #componentcount #### [componentCount] A count of a piece of hardware's components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1613,7 +1772,8 @@ A count of a piece of hardware's components. [downlinkHardwareCount]: #downlinkhardwarecount #### [downlinkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1623,7 +1783,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkNetworkHardwareCount]: #downlinknetworkhardwarecount #### [downlinkNetworkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1633,7 +1794,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkServerCount]: #downlinkservercount #### [downlinkServerCount] A count of information regarding all servers attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1643,7 +1805,8 @@ A count of information regarding all servers attached to a piece of network hard [downlinkVirtualGuestCount]: #downlinkvirtualguestcount #### [downlinkVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1653,7 +1816,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [downstreamHardwareBindingCount]: #downstreamhardwarebindingcount #### [downstreamHardwareBindingCount] A count of all hardware downstream from a network device. -Type: **unsigned long** +Type: **unsigned long** + @@ -1663,7 +1827,8 @@ A count of all hardware downstream from a network device. [downstreamNetworkHardwareCount]: #downstreamnetworkhardwarecount #### [downstreamNetworkHardwareCount] A count of all network hardware downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1673,7 +1838,8 @@ A count of all network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidentCount]: #downstreamnetworkhardwarewithincidentcount #### [downstreamNetworkHardwareWithIncidentCount] A count of all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1683,7 +1849,8 @@ A count of all network hardware with monitoring warnings or errors that are down [downstreamServerCount]: #downstreamservercount #### [downstreamServerCount] A count of information regarding all servers attached downstream to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1693,7 +1860,8 @@ A count of information regarding all servers attached downstream to a piece of n [downstreamVirtualGuestCount]: #downstreamvirtualguestcount #### [downstreamVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1703,7 +1871,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [driveControllerCount]: #drivecontrollercount #### [driveControllerCount] A count of the drive controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1713,7 +1882,8 @@ A count of the drive controllers contained within a piece of hardware. [evaultNetworkStorageCount]: #evaultnetworkstoragecount #### [evaultNetworkStorageCount] A count of information regarding a piece of hardware's associated EVault network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -1723,7 +1893,8 @@ A count of information regarding a piece of hardware's associated EVault network [frontendNetworkComponentCount]: #frontendnetworkcomponentcount #### [frontendNetworkComponentCount] A count of a piece of hardware's front-end or public network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1733,7 +1904,8 @@ A count of a piece of hardware's front-end or public network components. [frontendRouterCount]: #frontendroutercount #### [frontendRouterCount] A count of a hardware's frontend or public router. -Type: **unsigned long** +Type: **unsigned long** + @@ -1743,7 +1915,8 @@ A count of a hardware's frontend or public router. [hardDriveCount]: #harddrivecount #### [hardDriveCount] A count of the hard drives contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1753,7 +1926,8 @@ A count of the hard drives contained within a piece of hardware. [memoryCount]: #memorycount #### [memoryCount] A count of information regarding a piece of hardware's memory. -Type: **unsigned long** +Type: **unsigned long** + @@ -1763,7 +1937,8 @@ A count of information regarding a piece of hardware's memory. [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1773,7 +1948,8 @@ A count of [networkCardCount]: #networkcardcount #### [networkCardCount] A count of information regarding a piece of hardware's network cards. -Type: **unsigned long** +Type: **unsigned long** + @@ -1783,7 +1959,8 @@ A count of information regarding a piece of hardware's network cards. [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of returns a hardware's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1793,7 +1970,8 @@ A count of returns a hardware's network components. [networkMonitorAttachedDownHardwareCount]: #networkmonitorattacheddownhardwarecount #### [networkMonitorAttachedDownHardwareCount] A count of all servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1803,7 +1981,8 @@ A count of all servers with failed monitoring that are attached downstream to a [networkMonitorAttachedDownVirtualGuestCount]: #networkmonitorattacheddownvirtualguestcount #### [networkMonitorAttachedDownVirtualGuestCount] A count of virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **unsigned long** +Type: **unsigned long** + @@ -1813,7 +1992,8 @@ A count of virtual guests that are attached downstream to a hardware that have f [networkMonitorCount]: #networkmonitorcount #### [networkMonitorCount] A count of information regarding a piece of hardware's network monitors. -Type: **unsigned long** +Type: **unsigned long** + @@ -1823,7 +2003,8 @@ A count of information regarding a piece of hardware's network monitors. [networkMonitorIncidentCount]: #networkmonitorincidentcount #### [networkMonitorIncidentCount] A count of the status of all of a piece of hardware's network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -1833,7 +2014,8 @@ A count of the status of all of a piece of hardware's network monitoring inciden [networkStorageCount]: #networkstoragecount #### [networkStorageCount] A count of information regarding a piece of hardware's associated network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -1843,7 +2025,8 @@ A count of information regarding a piece of hardware's associated network storag [networkVlanCount]: #networkvlancount #### [networkVlanCount] A count of the network virtual LANs (VLANs) associated with a piece of hardware's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1853,7 +2036,8 @@ A count of the network virtual LANs (VLANs) associated with a piece of hardware' [notesHistoryCount]: #noteshistorycount #### [notesHistoryCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1863,7 +2047,8 @@ A count of [nvRamComponentModelCount]: #nvramcomponentmodelcount #### [nvRamComponentModelCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1873,7 +2058,8 @@ A count of [powerComponentCount]: #powercomponentcount #### [powerComponentCount] A count of the power components for a hardware object. -Type: **unsigned long** +Type: **unsigned long** + @@ -1883,7 +2069,8 @@ A count of the power components for a hardware object. [powerSupplyCount]: #powersupplycount #### [powerSupplyCount] A count of information regarding a piece of hardware's power supply. -Type: **unsigned long** +Type: **unsigned long** + @@ -1893,7 +2080,8 @@ A count of information regarding a piece of hardware's power supply. [processorCount]: #processorcount #### [processorCount] A count of information regarding a piece of hardware's processors. -Type: **unsigned long** +Type: **unsigned long** + @@ -1903,7 +2091,8 @@ A count of information regarding a piece of hardware's processors. [raidControllerCount]: #raidcontrollercount #### [raidControllerCount] A count of the RAID controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1913,7 +2102,8 @@ A count of the RAID controllers contained within a piece of hardware. [recentEventCount]: #recenteventcount #### [recentEventCount] A count of recent events that impact this hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1923,7 +2113,8 @@ A count of recent events that impact this hardware. [remoteManagementAccountCount]: #remotemanagementaccountcount #### [remoteManagementAccountCount] A count of user credentials to issue commands and/or interact with the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -1933,7 +2124,8 @@ A count of user credentials to issue commands and/or interact with the server's [resourceConfigurationCount]: #resourceconfigurationcount #### [resourceConfigurationCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1943,7 +2135,8 @@ A count of [resourceGroupCount]: #resourcegroupcount #### [resourceGroupCount] A count of the resource groups in which this hardware is a member. -Type: **unsigned long** +Type: **unsigned long** + @@ -1953,7 +2146,8 @@ A count of the resource groups in which this hardware is a member. [resourceGroupMemberReferenceCount]: #resourcegroupmemberreferencecount #### [resourceGroupMemberReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1963,7 +2157,8 @@ A count of [resourceGroupRoleCount]: #resourcegrouprolecount #### [resourceGroupRoleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1973,7 +2168,8 @@ A count of [routerCount]: #routercount #### [routerCount] A count of a hardware's routers. -Type: **unsigned long** +Type: **unsigned long** + @@ -1983,7 +2179,8 @@ A count of a hardware's routers. [scaleAssetCount]: #scaleassetcount #### [scaleAssetCount] A count of collection of scale assets this hardware corresponds to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1993,7 +2190,8 @@ A count of collection of scale assets this hardware corresponds to. [securityScanRequestCount]: #securityscanrequestcount #### [securityScanRequestCount] A count of information regarding a piece of hardware's vulnerability scan requests. -Type: **unsigned long** +Type: **unsigned long** + @@ -2003,7 +2201,8 @@ A count of information regarding a piece of hardware's vulnerability scan reques [softwareComponentCount]: #softwarecomponentcount #### [softwareComponentCount] A count of information regarding a piece of hardware's installed software. -Type: **unsigned long** +Type: **unsigned long** + @@ -2013,7 +2212,8 @@ A count of information regarding a piece of hardware's installed software. [sshKeyCount]: #sshkeycount #### [sshKeyCount] A count of sSH keys to be installed on the server during provisioning or an OS reload. -Type: **unsigned long** +Type: **unsigned long** + @@ -2023,7 +2223,8 @@ A count of sSH keys to be installed on the server during provisioning or an OS r [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2033,7 +2234,8 @@ A count of [storageNetworkComponentCount]: #storagenetworkcomponentcount #### [storageNetworkComponentCount] A count of a piece of hardware's private storage network components. [Deprecated] -Type: **unsigned long** +Type: **unsigned long** + @@ -2043,7 +2245,8 @@ A count of a piece of hardware's private storage network components. [Deprecated [tagReferenceCount]: #tagreferencecount #### [tagReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2053,7 +2256,8 @@ A count of [uplinkNetworkComponentCount]: #uplinknetworkcomponentcount #### [uplinkNetworkComponentCount] A count of information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **unsigned long** +Type: **unsigned long** + @@ -2063,7 +2267,8 @@ A count of information regarding the network component that is one level higher [userCount]: #usercount #### [userCount] A count of a list of users that have access to this hardware firewall. -Type: **unsigned long** +Type: **unsigned long** + @@ -2073,7 +2278,8 @@ A count of a list of users that have access to this hardware firewall. [userDataCount]: #userdatacount #### [userDataCount] A count of an array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **unsigned long** +Type: **unsigned long** + @@ -2083,7 +2289,8 @@ A count of an array containing a single string of custom user data for a hardwar [virtualChassisSiblingCount]: #virtualchassissiblingcount #### [virtualChassisSiblingCount] A count of information regarding the virtual chassis siblings for a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2093,7 +2300,8 @@ A count of information regarding the virtual chassis siblings for a piece of har [virtualLicenseCount]: #virtuallicensecount #### [virtualLicenseCount] A count of information regarding a piece of hardware's virtual software licenses. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Function/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Function/_index.md index 9375ce7af0..16e7188879 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Function/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Function/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Function data type contains a generic object type for a piece of hardware, like switch, firewall, server, etc.. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Function data type contains a generic object type for a p [code]: #code #### [code] The code associated with this hardware function. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The code associated with this hardware function. [description]: #description #### [description] The description for a hardware function. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The description for a hardware function. [id]: #id #### [id] The id associated with a hardware function. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Group/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Group/_index.md index 78fbfa325f..4fca2bf724 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Group/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [domain]: #domain #### [domain] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [hostname]: #hostname #### [hostname] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ classes: [downlinkServers]: #downlinkservers #### [downlinkServers] All servers attached to a network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -91,7 +97,8 @@ All servers attached to a network hardware. [downlinkVirtualGuests]: #downlinkvirtualguests #### [downlinkVirtualGuests] All virtual guests attached to a network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -101,7 +108,8 @@ All virtual guests attached to a network hardware. [downstreamNetworkHardware]: #downstreamnetworkhardware #### [downstreamNetworkHardware] All network hardware downstream from this hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -111,7 +119,8 @@ All network hardware downstream from this hardware. [downstreamNetworkHardwareWithIncidents]: #downstreamnetworkhardwarewithincidents #### [downstreamNetworkHardwareWithIncidents] All network hardware with monitoring warnings or errors downstream from this hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -121,7 +130,8 @@ All network hardware with monitoring warnings or errors downstream from this har [hardwareChassis]: #hardwarechassis #### [hardwareChassis] The chassis that a piece of hardware is housed in. -Type: **SoftLayer_Hardware_Chassis ** +Type: **SoftLayer_Hardware_Chassis ** + @@ -131,7 +141,8 @@ The chassis that a piece of hardware is housed in. [networkMonitorAttachedDownHardware]: #networkmonitorattacheddownhardware #### [networkMonitorAttachedDownHardware] All servers attached downstream to a hardware that have failed monitoring -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -141,7 +152,8 @@ All servers attached downstream to a hardware that have failed monitoring [networkMonitorAttachedDownVirtualGuests]: #networkmonitorattacheddownvirtualguests #### [networkMonitorAttachedDownVirtualGuests] Virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -151,7 +163,8 @@ Virtual guests that are attached downstream to a hardware that have failed monit [networkStatus]: #networkstatus #### [networkStatus] The value of a hardware's network status attribute. -Type: **string** +Type: **string** + @@ -163,7 +176,8 @@ The value of a hardware's network status attribute. [downlinkServerCount]: #downlinkservercount #### [downlinkServerCount] A count of all servers attached to a network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -173,7 +187,8 @@ A count of all servers attached to a network hardware. [downlinkVirtualGuestCount]: #downlinkvirtualguestcount #### [downlinkVirtualGuestCount] A count of all virtual guests attached to a network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of all virtual guests attached to a network hardware. [downstreamNetworkHardwareCount]: #downstreamnetworkhardwarecount #### [downstreamNetworkHardwareCount] A count of all network hardware downstream from this hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -193,7 +209,8 @@ A count of all network hardware downstream from this hardware. [downstreamNetworkHardwareWithIncidentCount]: #downstreamnetworkhardwarewithincidentcount #### [downstreamNetworkHardwareWithIncidentCount] A count of all network hardware with monitoring warnings or errors downstream from this hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -203,7 +220,8 @@ A count of all network hardware with monitoring warnings or errors downstream fr [networkMonitorAttachedDownHardwareCount]: #networkmonitorattacheddownhardwarecount #### [networkMonitorAttachedDownHardwareCount] A count of all servers attached downstream to a hardware that have failed monitoring -Type: **unsigned long** +Type: **unsigned long** + @@ -213,7 +231,8 @@ A count of all servers attached downstream to a hardware that have failed monito [networkMonitorAttachedDownVirtualGuestCount]: #networkmonitorattacheddownvirtualguestcount #### [networkMonitorAttachedDownVirtualGuestCount] A count of virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_LoadBalancer/_index.md b/content/reference/datatypes/SoftLayer_Hardware_LoadBalancer/_index.md index d4d4af26c4..aedb29a2b9 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_LoadBalancer/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_LoadBalancer/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] A hardware's associated [SoftLayer_Account]({{}}) id. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ A hardware's associated [SoftLayer_Account]({{Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ When true, this flag specifies that a hardware is Bare Metal Server. Bare Metal [domain]: #domain #### [domain] A piece of hardware's local network domain name. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A piece of hardware's local network domain name. [fullyQualifiedDomainName]: #fullyqualifieddomainname #### [fullyQualifiedDomainName] A name reflecting the hostname and domain of the hardware. This is created from the combined values of the hardware's hostname and domain name automatically, and thus should not be edited directly. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ A name reflecting the hostname and domain of the hardware. This is created from [hardwareStatusId]: #hardwarestatusid #### [hardwareStatusId] A number reflecting the state of a hardware -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ A number reflecting the state of a hardware [hostname]: #hostname #### [hostname] A hardware's hostname -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ A hardware's hostname [id]: #id #### [id] A hardware's internal identification number -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A hardware's internal identification number [manufacturerSerialNumber]: #manufacturerserialnumber #### [manufacturerSerialNumber] A hardware's serial number that is supplied by the manufacturer. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A hardware's serial number that is supplied by the manufacturer. [notes]: #notes #### [notes] A small note about a piece of hardware to use at your discretion. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ A small note about a piece of hardware to use at your discretion. [postInstallScriptUri]: #postinstallscripturi #### [postInstallScriptUri] URI of the script to be downloaded and executed after installation is complete. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ URI of the script to be downloaded and executed after installation is complete. [provisionDate]: #provisiondate #### [provisionDate] -Type: **dateTime** +Type: **dateTime** + @@ -155,7 +168,8 @@ URI of the script to be downloaded and executed after installation is complete. [serialNumber]: #serialnumber #### [serialNumber] A hardware's serial number that is supplied by SoftLayer. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderResourceId]: #serviceproviderresourceid #### [serviceProviderResourceId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -191,7 +207,8 @@ A hardware's internal identification number at its service provider [account]: #account #### [account] The account associated with a piece of hardware. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -201,7 +218,8 @@ The account associated with a piece of hardware. [activeComponents]: #activecomponents #### [activeComponents] A piece of hardware's active physical components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -211,7 +229,8 @@ A piece of hardware's active physical components. [activeNetworkMonitorIncident]: #activenetworkmonitorincident #### [activeNetworkMonitorIncident] A piece of hardware's active network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -221,7 +240,8 @@ A piece of hardware's active network monitoring incidents. [allPowerComponents]: #allpowercomponents #### [allPowerComponents] -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -231,7 +251,8 @@ A piece of hardware's active network monitoring incidents. [allowedHost]: #allowedhost #### [allowedHost] The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. -Type: **SoftLayer_Network_Storage_Allowed_Host ** +Type: **SoftLayer_Network_Storage_Allowed_Host ** + @@ -241,7 +262,8 @@ The SoftLayer_Network_Storage_Allowed_Host information to connect this server to [allowedNetworkStorage]: #allowednetworkstorage #### [allowedNetworkStorage] The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -251,7 +273,8 @@ The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to [allowedNetworkStorageReplicas]: #allowednetworkstoragereplicas #### [allowedNetworkStorageReplicas] The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -261,7 +284,8 @@ The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware [antivirusSpywareSoftwareComponent]: #antivirusspywaresoftwarecomponent #### [antivirusSpywareSoftwareComponent] Information regarding an antivirus/spyware software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -271,7 +295,8 @@ Information regarding an antivirus/spyware software component object. [attributes]: #attributes #### [attributes] Information regarding a piece of hardware's specific attributes. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -281,7 +306,8 @@ Information regarding a piece of hardware's specific attributes. [averageDailyPublicBandwidthUsage]: #averagedailypublicbandwidthusage #### [averageDailyPublicBandwidthUsage] The average daily public bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -291,7 +317,8 @@ The average daily public bandwidth usage for the current billing cycle. [backendNetworkComponents]: #backendnetworkcomponents #### [backendNetworkComponents] A piece of hardware's back-end or private network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -301,7 +328,8 @@ A piece of hardware's back-end or private network components. [backendRouters]: #backendrouters #### [backendRouters] A hardware's backend or private router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -311,7 +339,8 @@ A hardware's backend or private router. [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] A hardware's allotted bandwidth (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -321,7 +350,8 @@ A hardware's allotted bandwidth (measured in GB). [bandwidthAllotmentDetail]: #bandwidthallotmentdetail #### [bandwidthAllotmentDetail] A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** + @@ -331,7 +361,8 @@ A hardware's allotted detail record. Allotment details link bandwidth allocation [benchmarkCertifications]: #benchmarkcertifications #### [benchmarkCertifications] Information regarding a piece of hardware's benchmark certifications. -Type: **SoftLayer_Hardware_Benchmark_Certification[] ** +Type: **SoftLayer_Hardware_Benchmark_Certification[] ** + @@ -341,7 +372,8 @@ Information regarding a piece of hardware's benchmark certifications. [billingItem]: #billingitem #### [billingItem] Information regarding the billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -351,7 +383,8 @@ Information regarding the billing item for a server. [billingItemFlag]: #billingitemflag #### [billingItemFlag] A flag indicating that a billing item exists. -Type: **boolean** +Type: **boolean** + @@ -361,7 +394,8 @@ A flag indicating that a billing item exists. [blockCancelBecauseDisconnectedFlag]: #blockcancelbecausedisconnectedflag #### [blockCancelBecauseDisconnectedFlag] Determines whether the hardware is ineligible for cancellation because it is disconnected. -Type: **boolean** +Type: **boolean** + @@ -371,7 +405,8 @@ Determines whether the hardware is ineligible for cancellation because it is dis [businessContinuanceInsuranceFlag]: #businesscontinuanceinsuranceflag #### [businessContinuanceInsuranceFlag] Status indicating whether or not a piece of hardware has business continuance insurance. -Type: **boolean** +Type: **boolean** + @@ -381,7 +416,8 @@ Status indicating whether or not a piece of hardware has business continuance in [childrenHardware]: #childrenhardware #### [childrenHardware] Child hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -391,7 +427,8 @@ Child hardware. [components]: #components #### [components] A piece of hardware's components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -401,7 +438,8 @@ A piece of hardware's components. [continuousDataProtectionSoftwareComponent]: #continuousdataprotectionsoftwarecomponent #### [continuousDataProtectionSoftwareComponent] A continuous data protection/server backup software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -411,7 +449,8 @@ A continuous data protection/server backup software component object. [currentBillableBandwidthUsage]: #currentbillablebandwidthusage #### [currentBillableBandwidthUsage] The current billable public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -421,7 +460,8 @@ The current billable public outbound bandwidth for this hardware for the current [datacenter]: #datacenter #### [datacenter] Information regarding the datacenter in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -431,7 +471,8 @@ Information regarding the datacenter in which a piece of hardware resides. [datacenterName]: #datacentername #### [datacenterName] The name of the datacenter in which a piece of hardware resides. -Type: **string** +Type: **string** + @@ -441,7 +482,8 @@ The name of the datacenter in which a piece of hardware resides. [daysInSparePool]: #daysinsparepool #### [daysInSparePool] Number of day(s) a server have been in spare pool. -Type: **integer** +Type: **integer** + @@ -451,7 +493,8 @@ Number of day(s) a server have been in spare pool. [downlinkHardware]: #downlinkhardware #### [downlinkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -461,7 +504,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkNetworkHardware]: #downlinknetworkhardware #### [downlinkNetworkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -471,7 +515,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkServers]: #downlinkservers #### [downlinkServers] Information regarding all servers attached to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -481,7 +526,8 @@ Information regarding all servers attached to a piece of network hardware. [downlinkVirtualGuests]: #downlinkvirtualguests #### [downlinkVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -491,7 +537,8 @@ Information regarding all virtual guests attached to a piece of network hardware [downstreamHardwareBindings]: #downstreamhardwarebindings #### [downstreamHardwareBindings] All hardware downstream from a network device. -Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** +Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** + @@ -501,7 +548,8 @@ All hardware downstream from a network device. [downstreamNetworkHardware]: #downstreamnetworkhardware #### [downstreamNetworkHardware] All network hardware downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -511,7 +559,8 @@ All network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidents]: #downstreamnetworkhardwarewithincidents #### [downstreamNetworkHardwareWithIncidents] All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -521,7 +570,8 @@ All network hardware with monitoring warnings or errors that are downstream from [downstreamServers]: #downstreamservers #### [downstreamServers] Information regarding all servers attached downstream to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -531,7 +581,8 @@ Information regarding all servers attached downstream to a piece of network hard [downstreamVirtualGuests]: #downstreamvirtualguests #### [downstreamVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -541,7 +592,8 @@ Information regarding all virtual guests attached to a piece of network hardware [driveControllers]: #drivecontrollers #### [driveControllers] The drive controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -551,7 +603,8 @@ The drive controllers contained within a piece of hardware. [evaultNetworkStorage]: #evaultnetworkstorage #### [evaultNetworkStorage] Information regarding a piece of hardware's associated EVault network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -561,7 +614,8 @@ Information regarding a piece of hardware's associated EVault network storage se [firewallServiceComponent]: #firewallservicecomponent #### [firewallServiceComponent] Information regarding a piece of hardware's firewall services. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -571,7 +625,8 @@ Information regarding a piece of hardware's firewall services. [fixedConfigurationPreset]: #fixedconfigurationpreset #### [fixedConfigurationPreset] Defines the fixed components in a fixed configuration bare metal server. -Type: **SoftLayer_Product_Package_Preset ** +Type: **SoftLayer_Product_Package_Preset ** + @@ -581,7 +636,8 @@ Defines the fixed components in a fixed configuration bare metal server. [frontendNetworkComponents]: #frontendnetworkcomponents #### [frontendNetworkComponents] A piece of hardware's front-end or public network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -591,7 +647,8 @@ A piece of hardware's front-end or public network components. [frontendRouters]: #frontendrouters #### [frontendRouters] A hardware's frontend or public router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -601,7 +658,8 @@ A hardware's frontend or public router. [futureBillingItem]: #futurebillingitem #### [futureBillingItem] Information regarding the future billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -611,7 +669,8 @@ Information regarding the future billing item for a server. [globalIdentifier]: #globalidentifier #### [globalIdentifier] A hardware's universally unique identifier. -Type: **string** +Type: **string** + @@ -621,7 +680,8 @@ A hardware's universally unique identifier. [hardDrives]: #harddrives #### [hardDrives] The hard drives contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -631,7 +691,8 @@ The hard drives contained within a piece of hardware. [hardwareChassis]: #hardwarechassis #### [hardwareChassis] The chassis that a piece of hardware is housed in. -Type: **SoftLayer_Hardware_Chassis ** +Type: **SoftLayer_Hardware_Chassis ** + @@ -641,7 +702,8 @@ The chassis that a piece of hardware is housed in. [hardwareFunction]: #hardwarefunction #### [hardwareFunction] A hardware's function. -Type: **SoftLayer_Hardware_Function ** +Type: **SoftLayer_Hardware_Function ** + @@ -651,7 +713,8 @@ A hardware's function. [hardwareFunctionDescription]: #hardwarefunctiondescription #### [hardwareFunctionDescription] A hardware's function. -Type: **string** +Type: **string** + @@ -661,7 +724,8 @@ A hardware's function. [hardwareStatus]: #hardwarestatus #### [hardwareStatus] A hardware's status. -Type: **SoftLayer_Hardware_Status ** +Type: **SoftLayer_Hardware_Status ** + @@ -671,7 +735,8 @@ A hardware's status. [hasTrustedPlatformModuleBillingItemFlag]: #hastrustedplatformmodulebillingitemflag #### [hasTrustedPlatformModuleBillingItemFlag] Determine in hardware object has TPM enabled. -Type: **boolean** +Type: **boolean** + @@ -681,7 +746,8 @@ Determine in hardware object has TPM enabled. [hostIpsSoftwareComponent]: #hostipssoftwarecomponent #### [hostIpsSoftwareComponent] Information regarding a host IPS software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -691,7 +757,8 @@ Information regarding a host IPS software component object. [hourlyBillingFlag]: #hourlybillingflag #### [hourlyBillingFlag] A server's hourly billing status. -Type: **boolean** +Type: **boolean** + @@ -701,7 +768,8 @@ A server's hourly billing status. [inboundBandwidthUsage]: #inboundbandwidthusage #### [inboundBandwidthUsage] The sum of all the inbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -711,7 +779,8 @@ The sum of all the inbound network traffic data for the last 30 days. [inboundPublicBandwidthUsage]: #inboundpublicbandwidthusage #### [inboundPublicBandwidthUsage] The total public inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -721,7 +790,8 @@ The total public inbound bandwidth for this hardware for the current billing cyc [isBillingTermChangeAvailableFlag]: #isbillingtermchangeavailableflag #### [isBillingTermChangeAvailableFlag] Whether or not this hardware object is eligible to change to term billing. -Type: **boolean** +Type: **boolean** + @@ -731,7 +801,8 @@ Whether or not this hardware object is eligible to change to term billing. [lastTransaction]: #lasttransaction #### [lastTransaction] Information regarding the last transaction a server performed. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -741,7 +812,8 @@ Information regarding the last transaction a server performed. [latestNetworkMonitorIncident]: #latestnetworkmonitorincident #### [latestNetworkMonitorIncident] A piece of hardware's latest network monitoring incident. -Type: **SoftLayer_Network_Monitor_Version1_Incident ** +Type: **SoftLayer_Network_Monitor_Version1_Incident ** + @@ -751,7 +823,8 @@ A piece of hardware's latest network monitoring incident. [location]: #location #### [location] Where a piece of hardware is located within SoftLayer's location hierarchy. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -761,7 +834,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [locationPathString]: #locationpathstring #### [locationPathString] -Type: **string** +Type: **string** + @@ -771,7 +845,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [lockboxNetworkStorage]: #lockboxnetworkstorage #### [lockboxNetworkStorage] Information regarding a lockbox account associated with a server. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -781,7 +856,8 @@ Information regarding a lockbox account associated with a server. [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the hardware is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -791,7 +867,8 @@ A flag indicating that the hardware is a managed resource. [memory]: #memory #### [memory] Information regarding a piece of hardware's memory. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -801,7 +878,8 @@ Information regarding a piece of hardware's memory. [memoryCapacity]: #memorycapacity #### [memoryCapacity] The amount of memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -811,7 +889,8 @@ The amount of memory a piece of hardware has, measured in gigabytes. [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A piece of hardware's metric tracking object. -Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** +Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** + @@ -821,7 +900,8 @@ A piece of hardware's metric tracking object. [modelFamily]: #modelfamily #### [modelFamily] -Type: **string** +Type: **string** + @@ -831,7 +911,8 @@ A piece of hardware's metric tracking object. [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -841,7 +922,8 @@ A piece of hardware's metric tracking object. [monitoringRobot]: #monitoringrobot #### [monitoringRobot] -Type: **SoftLayer_Monitoring_Robot ** +Type: **SoftLayer_Monitoring_Robot ** + @@ -851,7 +933,8 @@ A piece of hardware's metric tracking object. [monitoringServiceComponent]: #monitoringservicecomponent #### [monitoringServiceComponent] Information regarding a piece of hardware's network monitoring services. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** + @@ -861,7 +944,8 @@ Information regarding a piece of hardware's network monitoring services. [monitoringServiceEligibilityFlag]: #monitoringserviceeligibilityflag #### [monitoringServiceEligibilityFlag] -Type: **boolean** +Type: **boolean** + @@ -871,7 +955,8 @@ Information regarding a piece of hardware's network monitoring services. [motherboard]: #motherboard #### [motherboard] Information regarding a piece of hardware's motherboard. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -881,7 +966,8 @@ Information regarding a piece of hardware's motherboard. [networkCards]: #networkcards #### [networkCards] Information regarding a piece of hardware's network cards. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -891,7 +977,8 @@ Information regarding a piece of hardware's network cards. [networkComponents]: #networkcomponents #### [networkComponents] Returns a hardware's network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -901,7 +988,8 @@ Returns a hardware's network components. [networkGatewayMember]: #networkgatewaymember #### [networkGatewayMember] The gateway member if this device is part of a network gateway. -Type: **SoftLayer_Network_Gateway_Member ** +Type: **SoftLayer_Network_Gateway_Member ** + @@ -911,7 +999,8 @@ The gateway member if this device is part of a network gateway. [networkGatewayMemberFlag]: #networkgatewaymemberflag #### [networkGatewayMemberFlag] Whether or not this device is part of a network gateway. -Type: **boolean** +Type: **boolean** + @@ -921,7 +1010,8 @@ Whether or not this device is part of a network gateway. [networkManagementIpAddress]: #networkmanagementipaddress #### [networkManagementIpAddress] A piece of hardware's network management IP address. -Type: **string** +Type: **string** + @@ -931,7 +1021,8 @@ A piece of hardware's network management IP address. [networkMonitorAttachedDownHardware]: #networkmonitorattacheddownhardware #### [networkMonitorAttachedDownHardware] All servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -941,7 +1032,8 @@ All servers with failed monitoring that are attached downstream to a piece of ha [networkMonitorAttachedDownVirtualGuests]: #networkmonitorattacheddownvirtualguests #### [networkMonitorAttachedDownVirtualGuests] Virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -951,7 +1043,8 @@ Virtual guests that are attached downstream to a hardware that have failed monit [networkMonitorIncidents]: #networkmonitorincidents #### [networkMonitorIncidents] The status of all of a piece of hardware's network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -961,7 +1054,8 @@ The status of all of a piece of hardware's network monitoring incidents. [networkMonitors]: #networkmonitors #### [networkMonitors] Information regarding a piece of hardware's network monitors. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** + @@ -971,7 +1065,8 @@ Information regarding a piece of hardware's network monitors. [networkStatus]: #networkstatus #### [networkStatus] The value of a hardware's network status attribute. -Type: **string** +Type: **string** + @@ -981,7 +1076,8 @@ The value of a hardware's network status attribute. [networkStatusAttribute]: #networkstatusattribute #### [networkStatusAttribute] The hardware's related network status attribute. -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -991,7 +1087,8 @@ The hardware's related network status attribute. [networkStorage]: #networkstorage #### [networkStorage] Information regarding a piece of hardware's associated network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -1001,7 +1098,8 @@ Information regarding a piece of hardware's associated network storage service a [networkVlans]: #networkvlans #### [networkVlans] The network virtual LANs (VLANs) associated with a piece of hardware's network components. -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -1011,7 +1109,8 @@ The network virtual LANs (VLANs) associated with a piece of hardware's network c [nextBillingCycleBandwidthAllocation]: #nextbillingcyclebandwidthallocation #### [nextBillingCycleBandwidthAllocation] A hardware's allotted bandwidth for the next billing cycle (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -1021,7 +1120,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [notesHistory]: #noteshistory #### [notesHistory] -Type: **SoftLayer_Hardware_Note[] ** +Type: **SoftLayer_Hardware_Note[] ** + @@ -1031,7 +1131,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [nvRamCapacity]: #nvramcapacity #### [nvRamCapacity] The amount of non-volatile memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1041,7 +1142,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [nvRamComponentModels]: #nvramcomponentmodels #### [nvRamComponentModels] -Type: **SoftLayer_Hardware_Component_Model[] ** +Type: **SoftLayer_Hardware_Component_Model[] ** + @@ -1051,7 +1153,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [operatingSystemReferenceCode]: #operatingsystemreferencecode #### [operatingSystemReferenceCode] A hardware's operating system software description. -Type: **string** +Type: **string** + @@ -1061,7 +1164,8 @@ A hardware's operating system software description. [outboundBandwidthUsage]: #outboundbandwidthusage #### [outboundBandwidthUsage] The sum of all the outbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -1071,7 +1175,8 @@ The sum of all the outbound network traffic data for the last 30 days. [outboundPublicBandwidthUsage]: #outboundpublicbandwidthusage #### [outboundPublicBandwidthUsage] The total public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -1081,7 +1186,8 @@ The total public outbound bandwidth for this hardware for the current billing cy [parentBay]: #parentbay #### [parentBay] Blade Bay -Type: **SoftLayer_Hardware_Blade ** +Type: **SoftLayer_Hardware_Blade ** + @@ -1091,7 +1197,8 @@ Blade Bay [parentHardware]: #parenthardware #### [parentHardware] Parent Hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1101,7 +1208,8 @@ Parent Hardware. [pointOfPresenceLocation]: #pointofpresencelocation #### [pointOfPresenceLocation] Information regarding the Point of Presence (PoP) location in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1111,7 +1219,8 @@ Information regarding the Point of Presence (PoP) location in which a piece of h [powerComponents]: #powercomponents #### [powerComponents] The power components for a hardware object. -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -1121,7 +1230,8 @@ The power components for a hardware object. [powerSupply]: #powersupply #### [powerSupply] Information regarding a piece of hardware's power supply. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1131,7 +1241,8 @@ Information regarding a piece of hardware's power supply. [primaryBackendIpAddress]: #primarybackendipaddress #### [primaryBackendIpAddress] The hardware's primary private IP address. -Type: **string** +Type: **string** + @@ -1141,7 +1252,8 @@ The hardware's primary private IP address. [primaryBackendNetworkComponent]: #primarybackendnetworkcomponent #### [primaryBackendNetworkComponent] -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1151,7 +1263,8 @@ The hardware's primary private IP address. [primaryIpAddress]: #primaryipaddress #### [primaryIpAddress] The hardware's primary public IP address. -Type: **string** +Type: **string** + @@ -1161,7 +1274,8 @@ The hardware's primary public IP address. [primaryNetworkComponent]: #primarynetworkcomponent #### [primaryNetworkComponent] Information regarding the hardware's primary public network component. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1171,7 +1285,8 @@ Information regarding the hardware's primary public network component. [privateNetworkOnlyFlag]: #privatenetworkonlyflag #### [privateNetworkOnlyFlag] Whether the hardware only has access to the private network. -Type: **boolean** +Type: **boolean** + @@ -1181,7 +1296,8 @@ Whether the hardware only has access to the private network. [processorCoreAmount]: #processorcoreamount #### [processorCoreAmount] The total number of processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1191,7 +1307,8 @@ The total number of processor cores, summed from all processors that are attache [processorPhysicalCoreAmount]: #processorphysicalcoreamount #### [processorPhysicalCoreAmount] The total number of physical processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1201,7 +1318,8 @@ The total number of physical processor cores, summed from all processors that ar [processors]: #processors #### [processors] Information regarding a piece of hardware's processors. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1211,7 +1329,8 @@ Information regarding a piece of hardware's processors. [rack]: #rack #### [rack] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1221,7 +1340,8 @@ Information regarding a piece of hardware's processors. [raidControllers]: #raidcontrollers #### [raidControllers] The RAID controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1231,7 +1351,8 @@ The RAID controllers contained within a piece of hardware. [recentEvents]: #recentevents #### [recentEvents] Recent events that impact this hardware. -Type: **SoftLayer_Notification_Occurrence_Event[] ** +Type: **SoftLayer_Notification_Occurrence_Event[] ** + @@ -1241,7 +1362,8 @@ Recent events that impact this hardware. [remoteManagementAccounts]: #remotemanagementaccounts #### [remoteManagementAccounts] User credentials to issue commands and/or interact with the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** + @@ -1251,7 +1373,8 @@ User credentials to issue commands and/or interact with the server's remote mana [remoteManagementComponent]: #remotemanagementcomponent #### [remoteManagementComponent] A hardware's associated remote management component. This is normally IPMI. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1261,7 +1384,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceConfigurations]: #resourceconfigurations #### [resourceConfigurations] -Type: **SoftLayer_Hardware_Resource_Configuration[] ** +Type: **SoftLayer_Hardware_Resource_Configuration[] ** + @@ -1271,7 +1395,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroupMemberReferences]: #resourcegroupmemberreferences #### [resourceGroupMemberReferences] -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -1281,7 +1406,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroupRoles]: #resourcegrouproles #### [resourceGroupRoles] -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -1291,7 +1417,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroups]: #resourcegroups #### [resourceGroups] The resource groups in which this hardware is a member. -Type: **SoftLayer_Resource_Group[] ** +Type: **SoftLayer_Resource_Group[] ** + @@ -1301,7 +1428,8 @@ The resource groups in which this hardware is a member. [routers]: #routers #### [routers] A hardware's routers. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1311,7 +1439,8 @@ A hardware's routers. [scaleAssets]: #scaleassets #### [scaleAssets] Collection of scale assets this hardware corresponds to. -Type: **SoftLayer_Scale_Asset[] ** +Type: **SoftLayer_Scale_Asset[] ** + @@ -1321,7 +1450,8 @@ Collection of scale assets this hardware corresponds to. [securityScanRequests]: #securityscanrequests #### [securityScanRequests] Information regarding a piece of hardware's vulnerability scan requests. -Type: **SoftLayer_Network_Security_Scanner_Request[] ** +Type: **SoftLayer_Network_Security_Scanner_Request[] ** + @@ -1331,7 +1461,8 @@ Information regarding a piece of hardware's vulnerability scan requests. [serverRoom]: #serverroom #### [serverRoom] Information regarding the server room in which the hardware is located. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1341,7 +1472,8 @@ Information regarding the server room in which the hardware is located. [serviceProvider]: #serviceprovider #### [serviceProvider] Information regarding the piece of hardware's service provider. -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -1351,7 +1483,8 @@ Information regarding the piece of hardware's service provider. [softwareComponents]: #softwarecomponents #### [softwareComponents] Information regarding a piece of hardware's installed software. -Type: **SoftLayer_Software_Component[] ** +Type: **SoftLayer_Software_Component[] ** + @@ -1361,7 +1494,8 @@ Information regarding a piece of hardware's installed software. [sparePoolBillingItem]: #sparepoolbillingitem #### [sparePoolBillingItem] Information regarding the billing item for a spare pool server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -1371,7 +1505,8 @@ Information regarding the billing item for a spare pool server. [sshKeys]: #sshkeys #### [sshKeys] SSH keys to be installed on the server during provisioning or an OS reload. -Type: **SoftLayer_Security_Ssh_Key[] ** +Type: **SoftLayer_Security_Ssh_Key[] ** + @@ -1381,17 +1516,20 @@ SSH keys to be installed on the server during provisioning or an OS reload. [storageGroups]: #storagegroups #### [storageGroups] -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + -
      +
      ----- [storageNetworkComponents]: #storagenetworkcomponents #### [storageNetworkComponents] A piece of hardware's private storage network components. [Deprecated] -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + +Deprecated
      @@ -1401,7 +1539,8 @@ A piece of hardware's private storage network components. [Deprecated] [tagReferences]: #tagreferences #### [tagReferences] -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** +
      @@ -1411,7 +1550,8 @@ A piece of hardware's private storage network components. [Deprecated] [topLevelLocation]: #toplevellocation #### [topLevelLocation] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1421,7 +1561,8 @@ A piece of hardware's private storage network components. [Deprecated] [upgradeRequest]: #upgraderequest #### [upgradeRequest] An account's associated upgrade request object, if any. -Type: **SoftLayer_Product_Upgrade_Request ** +Type: **SoftLayer_Product_Upgrade_Request ** + @@ -1431,7 +1572,8 @@ An account's associated upgrade request object, if any. [uplinkHardware]: #uplinkhardware #### [uplinkHardware] The network device connected to a piece of hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1441,7 +1583,8 @@ The network device connected to a piece of hardware. [uplinkNetworkComponents]: #uplinknetworkcomponents #### [uplinkNetworkComponents] Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -1451,7 +1594,8 @@ Information regarding the network component that is one level higher than a piec [userData]: #userdata #### [userData] An array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -1461,7 +1605,8 @@ An array containing a single string of custom user data for a hardware order. Ma [users]: #users #### [users] A list of users that have access to this hardware load balancer. -Type: **SoftLayer_User_Customer[] ** +Type: **SoftLayer_User_Customer[] ** + @@ -1471,7 +1616,8 @@ A list of users that have access to this hardware load balancer. [virtualChassis]: #virtualchassis #### [virtualChassis] Information regarding the virtual chassis for a piece of hardware. -Type: **SoftLayer_Hardware_Group ** +Type: **SoftLayer_Hardware_Group ** + @@ -1481,7 +1627,8 @@ Information regarding the virtual chassis for a piece of hardware. [virtualChassisSiblings]: #virtualchassissiblings #### [virtualChassisSiblings] Information regarding the virtual chassis siblings for a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1491,7 +1638,8 @@ Information regarding the virtual chassis siblings for a piece of hardware. [virtualHost]: #virtualhost #### [virtualHost] A piece of hardware's virtual host record. -Type: **SoftLayer_Virtual_Host ** +Type: **SoftLayer_Virtual_Host ** + @@ -1501,7 +1649,8 @@ A piece of hardware's virtual host record. [virtualLicenses]: #virtuallicenses #### [virtualLicenses] Information regarding a piece of hardware's virtual software licenses. -Type: **SoftLayer_Software_VirtualLicense[] ** +Type: **SoftLayer_Software_VirtualLicense[] ** + @@ -1511,7 +1660,8 @@ Information regarding a piece of hardware's virtual software licenses. [virtualRack]: #virtualrack #### [virtualRack] Information regarding the bandwidth allotment to which a piece of hardware belongs. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** + @@ -1521,7 +1671,8 @@ Information regarding the bandwidth allotment to which a piece of hardware belon [virtualRackId]: #virtualrackid #### [virtualRackId] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **integer** +Type: **integer** + @@ -1531,7 +1682,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualRackName]: #virtualrackname #### [virtualRackName] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **string** +Type: **string** + @@ -1541,7 +1693,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualizationPlatform]: #virtualizationplatform #### [virtualizationPlatform] A piece of hardware's virtualization platform software. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -1553,7 +1706,8 @@ A piece of hardware's virtualization platform software. [activeComponentCount]: #activecomponentcount #### [activeComponentCount] A count of a piece of hardware's active physical components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1563,7 +1717,8 @@ A count of a piece of hardware's active physical components. [activeNetworkMonitorIncidentCount]: #activenetworkmonitorincidentcount #### [activeNetworkMonitorIncidentCount] A count of a piece of hardware's active network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -1573,7 +1728,8 @@ A count of a piece of hardware's active network monitoring incidents. [allPowerComponentCount]: #allpowercomponentcount #### [allPowerComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1583,7 +1739,8 @@ A count of [allowedNetworkStorageCount]: #allowednetworkstoragecount #### [allowedNetworkStorageCount] A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1593,7 +1750,8 @@ A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware ha [allowedNetworkStorageReplicaCount]: #allowednetworkstoragereplicacount #### [allowedNetworkStorageReplicaCount] A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1603,7 +1761,8 @@ A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLay [attributeCount]: #attributecount #### [attributeCount] A count of information regarding a piece of hardware's specific attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -1613,7 +1772,8 @@ A count of information regarding a piece of hardware's specific attributes. [backendNetworkComponentCount]: #backendnetworkcomponentcount #### [backendNetworkComponentCount] A count of a piece of hardware's back-end or private network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1623,7 +1783,8 @@ A count of a piece of hardware's back-end or private network components. [backendRouterCount]: #backendroutercount #### [backendRouterCount] A count of a hardware's backend or private router. -Type: **unsigned long** +Type: **unsigned long** + @@ -1633,7 +1794,8 @@ A count of a hardware's backend or private router. [benchmarkCertificationCount]: #benchmarkcertificationcount #### [benchmarkCertificationCount] A count of information regarding a piece of hardware's benchmark certifications. -Type: **unsigned long** +Type: **unsigned long** + @@ -1643,7 +1805,8 @@ A count of information regarding a piece of hardware's benchmark certifications. [childrenHardwareCount]: #childrenhardwarecount #### [childrenHardwareCount] A count of child hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1653,7 +1816,8 @@ A count of child hardware. [componentCount]: #componentcount #### [componentCount] A count of a piece of hardware's components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1663,7 +1827,8 @@ A count of a piece of hardware's components. [downlinkHardwareCount]: #downlinkhardwarecount #### [downlinkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1673,7 +1838,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkNetworkHardwareCount]: #downlinknetworkhardwarecount #### [downlinkNetworkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1683,7 +1849,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkServerCount]: #downlinkservercount #### [downlinkServerCount] A count of information regarding all servers attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1693,7 +1860,8 @@ A count of information regarding all servers attached to a piece of network hard [downlinkVirtualGuestCount]: #downlinkvirtualguestcount #### [downlinkVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1703,7 +1871,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [downstreamHardwareBindingCount]: #downstreamhardwarebindingcount #### [downstreamHardwareBindingCount] A count of all hardware downstream from a network device. -Type: **unsigned long** +Type: **unsigned long** + @@ -1713,7 +1882,8 @@ A count of all hardware downstream from a network device. [downstreamNetworkHardwareCount]: #downstreamnetworkhardwarecount #### [downstreamNetworkHardwareCount] A count of all network hardware downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1723,7 +1893,8 @@ A count of all network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidentCount]: #downstreamnetworkhardwarewithincidentcount #### [downstreamNetworkHardwareWithIncidentCount] A count of all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1733,7 +1904,8 @@ A count of all network hardware with monitoring warnings or errors that are down [downstreamServerCount]: #downstreamservercount #### [downstreamServerCount] A count of information regarding all servers attached downstream to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1743,7 +1915,8 @@ A count of information regarding all servers attached downstream to a piece of n [downstreamVirtualGuestCount]: #downstreamvirtualguestcount #### [downstreamVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1753,7 +1926,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [driveControllerCount]: #drivecontrollercount #### [driveControllerCount] A count of the drive controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1763,7 +1937,8 @@ A count of the drive controllers contained within a piece of hardware. [evaultNetworkStorageCount]: #evaultnetworkstoragecount #### [evaultNetworkStorageCount] A count of information regarding a piece of hardware's associated EVault network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -1773,7 +1948,8 @@ A count of information regarding a piece of hardware's associated EVault network [frontendNetworkComponentCount]: #frontendnetworkcomponentcount #### [frontendNetworkComponentCount] A count of a piece of hardware's front-end or public network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1783,7 +1959,8 @@ A count of a piece of hardware's front-end or public network components. [frontendRouterCount]: #frontendroutercount #### [frontendRouterCount] A count of a hardware's frontend or public router. -Type: **unsigned long** +Type: **unsigned long** + @@ -1793,7 +1970,8 @@ A count of a hardware's frontend or public router. [hardDriveCount]: #harddrivecount #### [hardDriveCount] A count of the hard drives contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1803,7 +1981,8 @@ A count of the hard drives contained within a piece of hardware. [memoryCount]: #memorycount #### [memoryCount] A count of information regarding a piece of hardware's memory. -Type: **unsigned long** +Type: **unsigned long** + @@ -1813,7 +1992,8 @@ A count of information regarding a piece of hardware's memory. [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1823,7 +2003,8 @@ A count of [networkCardCount]: #networkcardcount #### [networkCardCount] A count of information regarding a piece of hardware's network cards. -Type: **unsigned long** +Type: **unsigned long** + @@ -1833,7 +2014,8 @@ A count of information regarding a piece of hardware's network cards. [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of returns a hardware's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1843,7 +2025,8 @@ A count of returns a hardware's network components. [networkMonitorAttachedDownHardwareCount]: #networkmonitorattacheddownhardwarecount #### [networkMonitorAttachedDownHardwareCount] A count of all servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1853,7 +2036,8 @@ A count of all servers with failed monitoring that are attached downstream to a [networkMonitorAttachedDownVirtualGuestCount]: #networkmonitorattacheddownvirtualguestcount #### [networkMonitorAttachedDownVirtualGuestCount] A count of virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **unsigned long** +Type: **unsigned long** + @@ -1863,7 +2047,8 @@ A count of virtual guests that are attached downstream to a hardware that have f [networkMonitorCount]: #networkmonitorcount #### [networkMonitorCount] A count of information regarding a piece of hardware's network monitors. -Type: **unsigned long** +Type: **unsigned long** + @@ -1873,7 +2058,8 @@ A count of information regarding a piece of hardware's network monitors. [networkMonitorIncidentCount]: #networkmonitorincidentcount #### [networkMonitorIncidentCount] A count of the status of all of a piece of hardware's network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -1883,7 +2069,8 @@ A count of the status of all of a piece of hardware's network monitoring inciden [networkStorageCount]: #networkstoragecount #### [networkStorageCount] A count of information regarding a piece of hardware's associated network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -1893,7 +2080,8 @@ A count of information regarding a piece of hardware's associated network storag [networkVlanCount]: #networkvlancount #### [networkVlanCount] A count of the network virtual LANs (VLANs) associated with a piece of hardware's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1903,7 +2091,8 @@ A count of the network virtual LANs (VLANs) associated with a piece of hardware' [notesHistoryCount]: #noteshistorycount #### [notesHistoryCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1913,7 +2102,8 @@ A count of [nvRamComponentModelCount]: #nvramcomponentmodelcount #### [nvRamComponentModelCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1923,7 +2113,8 @@ A count of [powerComponentCount]: #powercomponentcount #### [powerComponentCount] A count of the power components for a hardware object. -Type: **unsigned long** +Type: **unsigned long** + @@ -1933,7 +2124,8 @@ A count of the power components for a hardware object. [powerSupplyCount]: #powersupplycount #### [powerSupplyCount] A count of information regarding a piece of hardware's power supply. -Type: **unsigned long** +Type: **unsigned long** + @@ -1943,7 +2135,8 @@ A count of information regarding a piece of hardware's power supply. [processorCount]: #processorcount #### [processorCount] A count of information regarding a piece of hardware's processors. -Type: **unsigned long** +Type: **unsigned long** + @@ -1953,7 +2146,8 @@ A count of information regarding a piece of hardware's processors. [raidControllerCount]: #raidcontrollercount #### [raidControllerCount] A count of the RAID controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1963,7 +2157,8 @@ A count of the RAID controllers contained within a piece of hardware. [recentEventCount]: #recenteventcount #### [recentEventCount] A count of recent events that impact this hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1973,7 +2168,8 @@ A count of recent events that impact this hardware. [remoteManagementAccountCount]: #remotemanagementaccountcount #### [remoteManagementAccountCount] A count of user credentials to issue commands and/or interact with the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -1983,7 +2179,8 @@ A count of user credentials to issue commands and/or interact with the server's [resourceConfigurationCount]: #resourceconfigurationcount #### [resourceConfigurationCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1993,7 +2190,8 @@ A count of [resourceGroupCount]: #resourcegroupcount #### [resourceGroupCount] A count of the resource groups in which this hardware is a member. -Type: **unsigned long** +Type: **unsigned long** + @@ -2003,7 +2201,8 @@ A count of the resource groups in which this hardware is a member. [resourceGroupMemberReferenceCount]: #resourcegroupmemberreferencecount #### [resourceGroupMemberReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2013,7 +2212,8 @@ A count of [resourceGroupRoleCount]: #resourcegrouprolecount #### [resourceGroupRoleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2023,7 +2223,8 @@ A count of [routerCount]: #routercount #### [routerCount] A count of a hardware's routers. -Type: **unsigned long** +Type: **unsigned long** + @@ -2033,7 +2234,8 @@ A count of a hardware's routers. [scaleAssetCount]: #scaleassetcount #### [scaleAssetCount] A count of collection of scale assets this hardware corresponds to. -Type: **unsigned long** +Type: **unsigned long** + @@ -2043,7 +2245,8 @@ A count of collection of scale assets this hardware corresponds to. [securityScanRequestCount]: #securityscanrequestcount #### [securityScanRequestCount] A count of information regarding a piece of hardware's vulnerability scan requests. -Type: **unsigned long** +Type: **unsigned long** + @@ -2053,7 +2256,8 @@ A count of information regarding a piece of hardware's vulnerability scan reques [softwareComponentCount]: #softwarecomponentcount #### [softwareComponentCount] A count of information regarding a piece of hardware's installed software. -Type: **unsigned long** +Type: **unsigned long** + @@ -2063,7 +2267,8 @@ A count of information regarding a piece of hardware's installed software. [sshKeyCount]: #sshkeycount #### [sshKeyCount] A count of sSH keys to be installed on the server during provisioning or an OS reload. -Type: **unsigned long** +Type: **unsigned long** + @@ -2073,7 +2278,8 @@ A count of sSH keys to be installed on the server during provisioning or an OS r [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2083,7 +2289,8 @@ A count of [storageNetworkComponentCount]: #storagenetworkcomponentcount #### [storageNetworkComponentCount] A count of a piece of hardware's private storage network components. [Deprecated] -Type: **unsigned long** +Type: **unsigned long** + @@ -2093,7 +2300,8 @@ A count of a piece of hardware's private storage network components. [Deprecated [tagReferenceCount]: #tagreferencecount #### [tagReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2103,7 +2311,8 @@ A count of [uplinkNetworkComponentCount]: #uplinknetworkcomponentcount #### [uplinkNetworkComponentCount] A count of information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **unsigned long** +Type: **unsigned long** + @@ -2113,7 +2322,8 @@ A count of information regarding the network component that is one level higher [userCount]: #usercount #### [userCount] A count of a list of users that have access to this hardware load balancer. -Type: **unsigned long** +Type: **unsigned long** + @@ -2123,7 +2333,8 @@ A count of a list of users that have access to this hardware load balancer. [userDataCount]: #userdatacount #### [userDataCount] A count of an array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **unsigned long** +Type: **unsigned long** + @@ -2133,7 +2344,8 @@ A count of an array containing a single string of custom user data for a hardwar [virtualChassisSiblingCount]: #virtualchassissiblingcount #### [virtualChassisSiblingCount] A count of information regarding the virtual chassis siblings for a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2143,7 +2355,8 @@ A count of information regarding the virtual chassis siblings for a piece of har [virtualLicenseCount]: #virtuallicensecount #### [virtualLicenseCount] A count of information regarding a piece of hardware's virtual software licenses. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Note/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Note/_index.md index c58c2c483d..9da578d197 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Note/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Note/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
      @@ -55,7 +58,8 @@ classes: [hardwareId]: #hardwareid #### [hardwareId] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ classes: [note]: #note #### [note] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [typeId]: #typeid #### [typeId] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [userRecordId]: #userrecordid #### [userRecordId] -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ classes: [employee]: #employee #### [employee] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -131,7 +141,8 @@ classes: [hardware]: #hardware #### [hardware] -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -141,7 +152,8 @@ classes: [type]: #type #### [type] -Type: **SoftLayer_Hardware_Note_Type ** +Type: **SoftLayer_Hardware_Note_Type ** + @@ -151,7 +163,8 @@ classes: [user]: #user #### [user] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Note_Type/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Note_Type/_index.md index 4838cefdcd..9f39edd3f7 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Note_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Note_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
      diff --git a/content/reference/datatypes/SoftLayer_Hardware_Power_Component/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Power_Component/_index.md index 4a3546c1f6..4d0f9961b7 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Power_Component/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Power_Component/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [hardwareId]: #hardwareid #### [hardwareId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -71,7 +75,8 @@ classes: [hardware]: #hardware #### [hardware] -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** +
      diff --git a/content/reference/datatypes/SoftLayer_Hardware_Resource_Configuration/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Resource_Configuration/_index.md index 0ecbd53c5d..0caa6d131a 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Resource_Configuration/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Resource_Configuration/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [configurationTypeId]: #configurationtypeid #### [configurationTypeId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [hardwareId]: #hardwareid #### [hardwareId] -Type: **integer** +Type: **integer** +
      @@ -71,7 +75,8 @@ classes: [hardware]: #hardware #### [hardware] -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -81,7 +86,8 @@ classes: [properties]: #properties #### [properties] -Type: **SoftLayer_Hardware_Resource_Configuration_Property[] ** +Type: **SoftLayer_Hardware_Resource_Configuration_Property[] ** + @@ -91,7 +97,8 @@ classes: [type]: #type #### [type] -Type: **SoftLayer_Hardware_Resource_Configuration_Type ** +Type: **SoftLayer_Hardware_Resource_Configuration_Type ** + @@ -103,7 +110,8 @@ classes: [propertyCount]: #propertycount #### [propertyCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Resource_Configuration_Property/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Resource_Configuration_Property/_index.md index 6e4bb4e6ff..f1a459c966 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Resource_Configuration_Property/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Resource_Configuration_Property/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [configurationId]: #configurationid #### [configurationId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [configurationPropertyTypeId]: #configurationpropertytypeid #### [configurationPropertyTypeId] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [value]: #value #### [value] -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ classes: [configuration]: #configuration #### [configuration] -Type: **SoftLayer_Hardware_Resource_Configuration ** +Type: **SoftLayer_Hardware_Resource_Configuration ** + @@ -91,7 +97,8 @@ classes: [type]: #type #### [type] -Type: **SoftLayer_Hardware_Resource_Configuration_Property_Type ** +Type: **SoftLayer_Hardware_Resource_Configuration_Property_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Resource_Configuration_Property_Type/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Resource_Configuration_Property_Type/_index.md index 29e428db63..0c991b0a9d 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Resource_Configuration_Property_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Resource_Configuration_Property_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [unit]: #unit #### [unit] -Type: **string** +Type: **string** +
      @@ -71,7 +75,8 @@ classes: [properties]: #properties #### [properties] -Type: **SoftLayer_Hardware_Resource_Configuration_Property[] ** +Type: **SoftLayer_Hardware_Resource_Configuration_Property[] ** + @@ -83,7 +88,8 @@ classes: [propertyCount]: #propertycount #### [propertyCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Resource_Configuration_Type/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Resource_Configuration_Type/_index.md index fbcc85131b..a67cce8c6a 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Resource_Configuration_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Resource_Configuration_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
      diff --git a/content/reference/datatypes/SoftLayer_Hardware_Router/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Router/_index.md index 0a5bbdbf14..3ef96a443c 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Router/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Router/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Router data type contains general information relating to a single SoftLayer router. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Router data type contains general information relating to [accountId]: #accountid #### [accountId] A hardware's associated [SoftLayer_Account]({{}}) id. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ A hardware's associated [SoftLayer_Account]({{Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ When true, this flag specifies that a hardware is Bare Metal Server. Bare Metal [domain]: #domain #### [domain] A piece of hardware's local network domain name. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A piece of hardware's local network domain name. [fullyQualifiedDomainName]: #fullyqualifieddomainname #### [fullyQualifiedDomainName] A name reflecting the hostname and domain of the hardware. This is created from the combined values of the hardware's hostname and domain name automatically, and thus should not be edited directly. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ A name reflecting the hostname and domain of the hardware. This is created from [hardwareStatusId]: #hardwarestatusid #### [hardwareStatusId] A number reflecting the state of a hardware -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ A number reflecting the state of a hardware [hostname]: #hostname #### [hostname] A hardware's hostname -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ A hardware's hostname [id]: #id #### [id] A hardware's internal identification number -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A hardware's internal identification number [manufacturerSerialNumber]: #manufacturerserialnumber #### [manufacturerSerialNumber] A hardware's serial number that is supplied by the manufacturer. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A hardware's serial number that is supplied by the manufacturer. [notes]: #notes #### [notes] A small note about a piece of hardware to use at your discretion. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ A small note about a piece of hardware to use at your discretion. [postInstallScriptUri]: #postinstallscripturi #### [postInstallScriptUri] URI of the script to be downloaded and executed after installation is complete. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ URI of the script to be downloaded and executed after installation is complete. [provisionDate]: #provisiondate #### [provisionDate] -Type: **dateTime** +Type: **dateTime** + @@ -155,7 +168,8 @@ URI of the script to be downloaded and executed after installation is complete. [serialNumber]: #serialnumber #### [serialNumber] A hardware's serial number that is supplied by SoftLayer. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderResourceId]: #serviceproviderresourceid #### [serviceProviderResourceId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -191,7 +207,8 @@ A hardware's internal identification number at its service provider [account]: #account #### [account] The account associated with a piece of hardware. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -201,7 +218,8 @@ The account associated with a piece of hardware. [activeComponents]: #activecomponents #### [activeComponents] A piece of hardware's active physical components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -211,7 +229,8 @@ A piece of hardware's active physical components. [activeNetworkMonitorIncident]: #activenetworkmonitorincident #### [activeNetworkMonitorIncident] A piece of hardware's active network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -221,7 +240,8 @@ A piece of hardware's active network monitoring incidents. [allPowerComponents]: #allpowercomponents #### [allPowerComponents] -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -231,7 +251,8 @@ A piece of hardware's active network monitoring incidents. [allowedHost]: #allowedhost #### [allowedHost] The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. -Type: **SoftLayer_Network_Storage_Allowed_Host ** +Type: **SoftLayer_Network_Storage_Allowed_Host ** + @@ -241,7 +262,8 @@ The SoftLayer_Network_Storage_Allowed_Host information to connect this server to [allowedNetworkStorage]: #allowednetworkstorage #### [allowedNetworkStorage] The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -251,7 +273,8 @@ The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to [allowedNetworkStorageReplicas]: #allowednetworkstoragereplicas #### [allowedNetworkStorageReplicas] The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -261,7 +284,8 @@ The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware [antivirusSpywareSoftwareComponent]: #antivirusspywaresoftwarecomponent #### [antivirusSpywareSoftwareComponent] Information regarding an antivirus/spyware software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -271,7 +295,8 @@ Information regarding an antivirus/spyware software component object. [attributes]: #attributes #### [attributes] Information regarding a piece of hardware's specific attributes. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -281,7 +306,8 @@ Information regarding a piece of hardware's specific attributes. [averageDailyPublicBandwidthUsage]: #averagedailypublicbandwidthusage #### [averageDailyPublicBandwidthUsage] The average daily public bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -291,7 +317,8 @@ The average daily public bandwidth usage for the current billing cycle. [backendNetworkComponents]: #backendnetworkcomponents #### [backendNetworkComponents] A piece of hardware's back-end or private network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -301,7 +328,8 @@ A piece of hardware's back-end or private network components. [backendRouters]: #backendrouters #### [backendRouters] A hardware's backend or private router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -311,7 +339,8 @@ A hardware's backend or private router. [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] A hardware's allotted bandwidth (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -321,7 +350,8 @@ A hardware's allotted bandwidth (measured in GB). [bandwidthAllotmentDetail]: #bandwidthallotmentdetail #### [bandwidthAllotmentDetail] A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** + @@ -331,7 +361,8 @@ A hardware's allotted detail record. Allotment details link bandwidth allocation [benchmarkCertifications]: #benchmarkcertifications #### [benchmarkCertifications] Information regarding a piece of hardware's benchmark certifications. -Type: **SoftLayer_Hardware_Benchmark_Certification[] ** +Type: **SoftLayer_Hardware_Benchmark_Certification[] ** + @@ -341,7 +372,8 @@ Information regarding a piece of hardware's benchmark certifications. [billingItem]: #billingitem #### [billingItem] Information regarding the billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -351,7 +383,8 @@ Information regarding the billing item for a server. [billingItemFlag]: #billingitemflag #### [billingItemFlag] A flag indicating that a billing item exists. -Type: **boolean** +Type: **boolean** + @@ -361,7 +394,8 @@ A flag indicating that a billing item exists. [blockCancelBecauseDisconnectedFlag]: #blockcancelbecausedisconnectedflag #### [blockCancelBecauseDisconnectedFlag] Determines whether the hardware is ineligible for cancellation because it is disconnected. -Type: **boolean** +Type: **boolean** + @@ -371,7 +405,8 @@ Determines whether the hardware is ineligible for cancellation because it is dis [boundSubnets]: #boundsubnets #### [boundSubnets] Associated subnets for a router object. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -381,7 +416,8 @@ Associated subnets for a router object. [businessContinuanceInsuranceFlag]: #businesscontinuanceinsuranceflag #### [businessContinuanceInsuranceFlag] Status indicating whether or not a piece of hardware has business continuance insurance. -Type: **boolean** +Type: **boolean** + @@ -391,7 +427,8 @@ Status indicating whether or not a piece of hardware has business continuance in [childrenHardware]: #childrenhardware #### [childrenHardware] Child hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -401,7 +438,8 @@ Child hardware. [components]: #components #### [components] A piece of hardware's components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -411,7 +449,8 @@ A piece of hardware's components. [continuousDataProtectionSoftwareComponent]: #continuousdataprotectionsoftwarecomponent #### [continuousDataProtectionSoftwareComponent] A continuous data protection/server backup software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -421,7 +460,8 @@ A continuous data protection/server backup software component object. [currentBillableBandwidthUsage]: #currentbillablebandwidthusage #### [currentBillableBandwidthUsage] The current billable public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -431,7 +471,8 @@ The current billable public outbound bandwidth for this hardware for the current [datacenter]: #datacenter #### [datacenter] Information regarding the datacenter in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -441,7 +482,8 @@ Information regarding the datacenter in which a piece of hardware resides. [datacenterName]: #datacentername #### [datacenterName] The name of the datacenter in which a piece of hardware resides. -Type: **string** +Type: **string** + @@ -451,7 +493,8 @@ The name of the datacenter in which a piece of hardware resides. [daysInSparePool]: #daysinsparepool #### [daysInSparePool] Number of day(s) a server have been in spare pool. -Type: **integer** +Type: **integer** + @@ -461,7 +504,8 @@ Number of day(s) a server have been in spare pool. [downlinkHardware]: #downlinkhardware #### [downlinkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -471,7 +515,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkNetworkHardware]: #downlinknetworkhardware #### [downlinkNetworkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -481,7 +526,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkServers]: #downlinkservers #### [downlinkServers] Information regarding all servers attached to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -491,7 +537,8 @@ Information regarding all servers attached to a piece of network hardware. [downlinkVirtualGuests]: #downlinkvirtualguests #### [downlinkVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -501,7 +548,8 @@ Information regarding all virtual guests attached to a piece of network hardware [downstreamHardwareBindings]: #downstreamhardwarebindings #### [downstreamHardwareBindings] All hardware downstream from a network device. -Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** +Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** + @@ -511,7 +559,8 @@ All hardware downstream from a network device. [downstreamNetworkHardware]: #downstreamnetworkhardware #### [downstreamNetworkHardware] All network hardware downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -521,7 +570,8 @@ All network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidents]: #downstreamnetworkhardwarewithincidents #### [downstreamNetworkHardwareWithIncidents] All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -531,7 +581,8 @@ All network hardware with monitoring warnings or errors that are downstream from [downstreamServers]: #downstreamservers #### [downstreamServers] Information regarding all servers attached downstream to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -541,7 +592,8 @@ Information regarding all servers attached downstream to a piece of network hard [downstreamVirtualGuests]: #downstreamvirtualguests #### [downstreamVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -551,7 +603,8 @@ Information regarding all virtual guests attached to a piece of network hardware [driveControllers]: #drivecontrollers #### [driveControllers] The drive controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -561,7 +614,8 @@ The drive controllers contained within a piece of hardware. [evaultNetworkStorage]: #evaultnetworkstorage #### [evaultNetworkStorage] Information regarding a piece of hardware's associated EVault network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -571,7 +625,8 @@ Information regarding a piece of hardware's associated EVault network storage se [firewallServiceComponent]: #firewallservicecomponent #### [firewallServiceComponent] Information regarding a piece of hardware's firewall services. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -581,7 +636,8 @@ Information regarding a piece of hardware's firewall services. [fixedConfigurationPreset]: #fixedconfigurationpreset #### [fixedConfigurationPreset] Defines the fixed components in a fixed configuration bare metal server. -Type: **SoftLayer_Product_Package_Preset ** +Type: **SoftLayer_Product_Package_Preset ** + @@ -591,7 +647,8 @@ Defines the fixed components in a fixed configuration bare metal server. [frontendNetworkComponents]: #frontendnetworkcomponents #### [frontendNetworkComponents] A piece of hardware's front-end or public network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -601,7 +658,8 @@ A piece of hardware's front-end or public network components. [frontendRouters]: #frontendrouters #### [frontendRouters] A hardware's frontend or public router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -611,7 +669,8 @@ A hardware's frontend or public router. [futureBillingItem]: #futurebillingitem #### [futureBillingItem] Information regarding the future billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -621,7 +680,8 @@ Information regarding the future billing item for a server. [globalIdentifier]: #globalidentifier #### [globalIdentifier] A hardware's universally unique identifier. -Type: **string** +Type: **string** + @@ -631,7 +691,8 @@ A hardware's universally unique identifier. [hardDrives]: #harddrives #### [hardDrives] The hard drives contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -641,7 +702,8 @@ The hard drives contained within a piece of hardware. [hardwareChassis]: #hardwarechassis #### [hardwareChassis] The chassis that a piece of hardware is housed in. -Type: **SoftLayer_Hardware_Chassis ** +Type: **SoftLayer_Hardware_Chassis ** + @@ -651,7 +713,8 @@ The chassis that a piece of hardware is housed in. [hardwareFunction]: #hardwarefunction #### [hardwareFunction] A hardware's function. -Type: **SoftLayer_Hardware_Function ** +Type: **SoftLayer_Hardware_Function ** + @@ -661,7 +724,8 @@ A hardware's function. [hardwareFunctionDescription]: #hardwarefunctiondescription #### [hardwareFunctionDescription] A hardware's function. -Type: **string** +Type: **string** + @@ -671,7 +735,8 @@ A hardware's function. [hardwareStatus]: #hardwarestatus #### [hardwareStatus] A hardware's status. -Type: **SoftLayer_Hardware_Status ** +Type: **SoftLayer_Hardware_Status ** + @@ -681,7 +746,8 @@ A hardware's status. [hasTrustedPlatformModuleBillingItemFlag]: #hastrustedplatformmodulebillingitemflag #### [hasTrustedPlatformModuleBillingItemFlag] Determine in hardware object has TPM enabled. -Type: **boolean** +Type: **boolean** + @@ -691,7 +757,8 @@ Determine in hardware object has TPM enabled. [hostIpsSoftwareComponent]: #hostipssoftwarecomponent #### [hostIpsSoftwareComponent] Information regarding a host IPS software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -701,7 +768,8 @@ Information regarding a host IPS software component object. [hourlyBillingFlag]: #hourlybillingflag #### [hourlyBillingFlag] A server's hourly billing status. -Type: **boolean** +Type: **boolean** + @@ -711,7 +779,8 @@ A server's hourly billing status. [inboundBandwidthUsage]: #inboundbandwidthusage #### [inboundBandwidthUsage] The sum of all the inbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -721,7 +790,8 @@ The sum of all the inbound network traffic data for the last 30 days. [inboundPublicBandwidthUsage]: #inboundpublicbandwidthusage #### [inboundPublicBandwidthUsage] The total public inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -731,7 +801,8 @@ The total public inbound bandwidth for this hardware for the current billing cyc [isBillingTermChangeAvailableFlag]: #isbillingtermchangeavailableflag #### [isBillingTermChangeAvailableFlag] Whether or not this hardware object is eligible to change to term billing. -Type: **boolean** +Type: **boolean** + @@ -741,7 +812,8 @@ Whether or not this hardware object is eligible to change to term billing. [lastTransaction]: #lasttransaction #### [lastTransaction] Information regarding the last transaction a server performed. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -751,7 +823,8 @@ Information regarding the last transaction a server performed. [latestNetworkMonitorIncident]: #latestnetworkmonitorincident #### [latestNetworkMonitorIncident] A piece of hardware's latest network monitoring incident. -Type: **SoftLayer_Network_Monitor_Version1_Incident ** +Type: **SoftLayer_Network_Monitor_Version1_Incident ** + @@ -761,7 +834,8 @@ A piece of hardware's latest network monitoring incident. [localDiskStorageCapabilityFlag]: #localdiskstoragecapabilityflag #### [localDiskStorageCapabilityFlag] A flag indicating that a VLAN on the router can be assigned to a host that has local disk functionality. -Type: **boolean** +Type: **boolean** + @@ -771,7 +845,8 @@ A flag indicating that a VLAN on the router can be assigned to a host that has l [location]: #location #### [location] Where a piece of hardware is located within SoftLayer's location hierarchy. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -781,7 +856,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [locationPathString]: #locationpathstring #### [locationPathString] -Type: **string** +Type: **string** + @@ -791,7 +867,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [lockboxNetworkStorage]: #lockboxnetworkstorage #### [lockboxNetworkStorage] Information regarding a lockbox account associated with a server. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -801,7 +878,8 @@ Information regarding a lockbox account associated with a server. [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the hardware is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -811,7 +889,8 @@ A flag indicating that the hardware is a managed resource. [memory]: #memory #### [memory] Information regarding a piece of hardware's memory. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -821,7 +900,8 @@ Information regarding a piece of hardware's memory. [memoryCapacity]: #memorycapacity #### [memoryCapacity] The amount of memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -831,7 +911,8 @@ The amount of memory a piece of hardware has, measured in gigabytes. [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A piece of hardware's metric tracking object. -Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** +Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** + @@ -841,7 +922,8 @@ A piece of hardware's metric tracking object. [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -851,7 +933,8 @@ A piece of hardware's metric tracking object. [monitoringRobot]: #monitoringrobot #### [monitoringRobot] -Type: **SoftLayer_Monitoring_Robot ** +Type: **SoftLayer_Monitoring_Robot ** + @@ -861,7 +944,8 @@ A piece of hardware's metric tracking object. [monitoringServiceComponent]: #monitoringservicecomponent #### [monitoringServiceComponent] Information regarding a piece of hardware's network monitoring services. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** + @@ -871,7 +955,8 @@ Information regarding a piece of hardware's network monitoring services. [monitoringServiceEligibilityFlag]: #monitoringserviceeligibilityflag #### [monitoringServiceEligibilityFlag] -Type: **boolean** +Type: **boolean** + @@ -881,7 +966,8 @@ Information regarding a piece of hardware's network monitoring services. [motherboard]: #motherboard #### [motherboard] Information regarding a piece of hardware's motherboard. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -891,7 +977,8 @@ Information regarding a piece of hardware's motherboard. [networkCards]: #networkcards #### [networkCards] Information regarding a piece of hardware's network cards. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -901,7 +988,8 @@ Information regarding a piece of hardware's network cards. [networkComponents]: #networkcomponents #### [networkComponents] Returns a hardware's network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -911,7 +999,8 @@ Returns a hardware's network components. [networkGatewayMember]: #networkgatewaymember #### [networkGatewayMember] The gateway member if this device is part of a network gateway. -Type: **SoftLayer_Network_Gateway_Member ** +Type: **SoftLayer_Network_Gateway_Member ** + @@ -921,7 +1010,8 @@ The gateway member if this device is part of a network gateway. [networkGatewayMemberFlag]: #networkgatewaymemberflag #### [networkGatewayMemberFlag] Whether or not this device is part of a network gateway. -Type: **boolean** +Type: **boolean** + @@ -931,7 +1021,8 @@ Whether or not this device is part of a network gateway. [networkMonitorAttachedDownHardware]: #networkmonitorattacheddownhardware #### [networkMonitorAttachedDownHardware] All servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -941,7 +1032,8 @@ All servers with failed monitoring that are attached downstream to a piece of ha [networkMonitorAttachedDownVirtualGuests]: #networkmonitorattacheddownvirtualguests #### [networkMonitorAttachedDownVirtualGuests] Virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -951,7 +1043,8 @@ Virtual guests that are attached downstream to a hardware that have failed monit [networkMonitorIncidents]: #networkmonitorincidents #### [networkMonitorIncidents] The status of all of a piece of hardware's network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -961,7 +1054,8 @@ The status of all of a piece of hardware's network monitoring incidents. [networkMonitors]: #networkmonitors #### [networkMonitors] Information regarding a piece of hardware's network monitors. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** + @@ -971,7 +1065,8 @@ Information regarding a piece of hardware's network monitors. [networkStatus]: #networkstatus #### [networkStatus] The value of a hardware's network status attribute. -Type: **string** +Type: **string** + @@ -981,7 +1076,8 @@ The value of a hardware's network status attribute. [networkStatusAttribute]: #networkstatusattribute #### [networkStatusAttribute] The hardware's related network status attribute. -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -991,7 +1087,8 @@ The hardware's related network status attribute. [networkStorage]: #networkstorage #### [networkStorage] Information regarding a piece of hardware's associated network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -1001,7 +1098,8 @@ Information regarding a piece of hardware's associated network storage service a [nextBillingCycleBandwidthAllocation]: #nextbillingcyclebandwidthallocation #### [nextBillingCycleBandwidthAllocation] A hardware's allotted bandwidth for the next billing cycle (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -1011,7 +1109,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [notesHistory]: #noteshistory #### [notesHistory] -Type: **SoftLayer_Hardware_Note[] ** +Type: **SoftLayer_Hardware_Note[] ** + @@ -1021,7 +1120,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [nvRamCapacity]: #nvramcapacity #### [nvRamCapacity] The amount of non-volatile memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1031,7 +1131,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [nvRamComponentModels]: #nvramcomponentmodels #### [nvRamComponentModels] -Type: **SoftLayer_Hardware_Component_Model[] ** +Type: **SoftLayer_Hardware_Component_Model[] ** + @@ -1041,7 +1142,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [operatingSystem]: #operatingsystem #### [operatingSystem] Information regarding a piece of hardware's operating system. -Type: **SoftLayer_Software_Component_OperatingSystem ** +Type: **SoftLayer_Software_Component_OperatingSystem ** + @@ -1051,7 +1153,8 @@ Information regarding a piece of hardware's operating system. [operatingSystemReferenceCode]: #operatingsystemreferencecode #### [operatingSystemReferenceCode] A hardware's operating system software description. -Type: **string** +Type: **string** + @@ -1061,7 +1164,8 @@ A hardware's operating system software description. [outboundBandwidthUsage]: #outboundbandwidthusage #### [outboundBandwidthUsage] The sum of all the outbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -1071,7 +1175,8 @@ The sum of all the outbound network traffic data for the last 30 days. [outboundPublicBandwidthUsage]: #outboundpublicbandwidthusage #### [outboundPublicBandwidthUsage] The total public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -1081,7 +1186,8 @@ The total public outbound bandwidth for this hardware for the current billing cy [parentBay]: #parentbay #### [parentBay] Blade Bay -Type: **SoftLayer_Hardware_Blade ** +Type: **SoftLayer_Hardware_Blade ** + @@ -1091,7 +1197,8 @@ Blade Bay [parentHardware]: #parenthardware #### [parentHardware] Parent Hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1101,7 +1208,8 @@ Parent Hardware. [pointOfPresenceLocation]: #pointofpresencelocation #### [pointOfPresenceLocation] Information regarding the Point of Presence (PoP) location in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1111,7 +1219,8 @@ Information regarding the Point of Presence (PoP) location in which a piece of h [powerComponents]: #powercomponents #### [powerComponents] The power components for a hardware object. -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -1121,7 +1230,8 @@ The power components for a hardware object. [powerSupply]: #powersupply #### [powerSupply] Information regarding a piece of hardware's power supply. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1131,7 +1241,8 @@ Information regarding a piece of hardware's power supply. [primaryBackendNetworkComponent]: #primarybackendnetworkcomponent #### [primaryBackendNetworkComponent] Information regarding the hardware's primary back-end network component. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1141,7 +1252,8 @@ Information regarding the hardware's primary back-end network component. [primaryNetworkComponent]: #primarynetworkcomponent #### [primaryNetworkComponent] Information regarding the hardware's primary public network component. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1151,7 +1263,8 @@ Information regarding the hardware's primary public network component. [privateNetworkOnlyFlag]: #privatenetworkonlyflag #### [privateNetworkOnlyFlag] Whether the hardware only has access to the private network. -Type: **boolean** +Type: **boolean** + @@ -1161,7 +1274,8 @@ Whether the hardware only has access to the private network. [processorCoreAmount]: #processorcoreamount #### [processorCoreAmount] The total number of processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1171,7 +1285,8 @@ The total number of processor cores, summed from all processors that are attache [processorPhysicalCoreAmount]: #processorphysicalcoreamount #### [processorPhysicalCoreAmount] The total number of physical processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1181,7 +1296,8 @@ The total number of physical processor cores, summed from all processors that ar [processors]: #processors #### [processors] Information regarding a piece of hardware's processors. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1191,7 +1307,8 @@ Information regarding a piece of hardware's processors. [rack]: #rack #### [rack] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1201,7 +1318,8 @@ Information regarding a piece of hardware's processors. [raidControllers]: #raidcontrollers #### [raidControllers] The RAID controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1211,7 +1329,8 @@ The RAID controllers contained within a piece of hardware. [recentEvents]: #recentevents #### [recentEvents] Recent events that impact this hardware. -Type: **SoftLayer_Notification_Occurrence_Event[] ** +Type: **SoftLayer_Notification_Occurrence_Event[] ** + @@ -1221,7 +1340,8 @@ Recent events that impact this hardware. [remoteManagementAccounts]: #remotemanagementaccounts #### [remoteManagementAccounts] User credentials to issue commands and/or interact with the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** + @@ -1231,7 +1351,8 @@ User credentials to issue commands and/or interact with the server's remote mana [remoteManagementComponent]: #remotemanagementcomponent #### [remoteManagementComponent] A hardware's associated remote management component. This is normally IPMI. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1241,7 +1362,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceConfigurations]: #resourceconfigurations #### [resourceConfigurations] -Type: **SoftLayer_Hardware_Resource_Configuration[] ** +Type: **SoftLayer_Hardware_Resource_Configuration[] ** + @@ -1251,7 +1373,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroupMemberReferences]: #resourcegroupmemberreferences #### [resourceGroupMemberReferences] -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -1261,7 +1384,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroupRoles]: #resourcegrouproles #### [resourceGroupRoles] -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -1271,7 +1395,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroups]: #resourcegroups #### [resourceGroups] The resource groups in which this hardware is a member. -Type: **SoftLayer_Resource_Group[] ** +Type: **SoftLayer_Resource_Group[] ** + @@ -1281,7 +1406,8 @@ The resource groups in which this hardware is a member. [routers]: #routers #### [routers] A hardware's routers. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1291,7 +1417,8 @@ A hardware's routers. [sanStorageCapabilityFlag]: #sanstoragecapabilityflag #### [sanStorageCapabilityFlag] A flag indicating that a VLAN on the router can be assigned to a host that has SAN disk functionality. -Type: **boolean** +Type: **boolean** + @@ -1301,7 +1428,8 @@ A flag indicating that a VLAN on the router can be assigned to a host that has S [scaleAssets]: #scaleassets #### [scaleAssets] Collection of scale assets this hardware corresponds to. -Type: **SoftLayer_Scale_Asset[] ** +Type: **SoftLayer_Scale_Asset[] ** + @@ -1311,7 +1439,8 @@ Collection of scale assets this hardware corresponds to. [securityScanRequests]: #securityscanrequests #### [securityScanRequests] Information regarding a piece of hardware's vulnerability scan requests. -Type: **SoftLayer_Network_Security_Scanner_Request[] ** +Type: **SoftLayer_Network_Security_Scanner_Request[] ** + @@ -1321,7 +1450,8 @@ Information regarding a piece of hardware's vulnerability scan requests. [serverRoom]: #serverroom #### [serverRoom] Information regarding the server room in which the hardware is located. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1331,7 +1461,8 @@ Information regarding the server room in which the hardware is located. [serviceProvider]: #serviceprovider #### [serviceProvider] Information regarding the piece of hardware's service provider. -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -1341,7 +1472,8 @@ Information regarding the piece of hardware's service provider. [softwareComponents]: #softwarecomponents #### [softwareComponents] Information regarding a piece of hardware's installed software. -Type: **SoftLayer_Software_Component[] ** +Type: **SoftLayer_Software_Component[] ** + @@ -1351,7 +1483,8 @@ Information regarding a piece of hardware's installed software. [sparePoolBillingItem]: #sparepoolbillingitem #### [sparePoolBillingItem] Information regarding the billing item for a spare pool server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -1361,7 +1494,8 @@ Information regarding the billing item for a spare pool server. [sshKeys]: #sshkeys #### [sshKeys] SSH keys to be installed on the server during provisioning or an OS reload. -Type: **SoftLayer_Security_Ssh_Key[] ** +Type: **SoftLayer_Security_Ssh_Key[] ** + @@ -1371,17 +1505,20 @@ SSH keys to be installed on the server during provisioning or an OS reload. [storageGroups]: #storagegroups #### [storageGroups] -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + -
      +
      ----- [storageNetworkComponents]: #storagenetworkcomponents #### [storageNetworkComponents] A piece of hardware's private storage network components. [Deprecated] -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + +Deprecated
      @@ -1391,7 +1528,8 @@ A piece of hardware's private storage network components. [Deprecated] [tagReferences]: #tagreferences #### [tagReferences] -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** +
      @@ -1401,7 +1539,8 @@ A piece of hardware's private storage network components. [Deprecated] [topLevelLocation]: #toplevellocation #### [topLevelLocation] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1411,7 +1550,8 @@ A piece of hardware's private storage network components. [Deprecated] [upgradeRequest]: #upgraderequest #### [upgradeRequest] An account's associated upgrade request object, if any. -Type: **SoftLayer_Product_Upgrade_Request ** +Type: **SoftLayer_Product_Upgrade_Request ** + @@ -1421,7 +1561,8 @@ An account's associated upgrade request object, if any. [uplinkHardware]: #uplinkhardware #### [uplinkHardware] The network device connected to a piece of hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1431,7 +1572,8 @@ The network device connected to a piece of hardware. [uplinkNetworkComponents]: #uplinknetworkcomponents #### [uplinkNetworkComponents] Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -1441,7 +1583,8 @@ Information regarding the network component that is one level higher than a piec [userData]: #userdata #### [userData] An array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -1451,7 +1594,8 @@ An array containing a single string of custom user data for a hardware order. Ma [virtualChassis]: #virtualchassis #### [virtualChassis] Information regarding the virtual chassis for a piece of hardware. -Type: **SoftLayer_Hardware_Group ** +Type: **SoftLayer_Hardware_Group ** + @@ -1461,7 +1605,8 @@ Information regarding the virtual chassis for a piece of hardware. [virtualChassisSiblings]: #virtualchassissiblings #### [virtualChassisSiblings] Information regarding the virtual chassis siblings for a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1471,7 +1616,8 @@ Information regarding the virtual chassis siblings for a piece of hardware. [virtualHost]: #virtualhost #### [virtualHost] A piece of hardware's virtual host record. -Type: **SoftLayer_Virtual_Host ** +Type: **SoftLayer_Virtual_Host ** + @@ -1481,7 +1627,8 @@ A piece of hardware's virtual host record. [virtualLicenses]: #virtuallicenses #### [virtualLicenses] Information regarding a piece of hardware's virtual software licenses. -Type: **SoftLayer_Software_VirtualLicense[] ** +Type: **SoftLayer_Software_VirtualLicense[] ** + @@ -1491,7 +1638,8 @@ Information regarding a piece of hardware's virtual software licenses. [virtualRack]: #virtualrack #### [virtualRack] Information regarding the bandwidth allotment to which a piece of hardware belongs. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** + @@ -1501,7 +1649,8 @@ Information regarding the bandwidth allotment to which a piece of hardware belon [virtualRackId]: #virtualrackid #### [virtualRackId] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **integer** +Type: **integer** + @@ -1511,7 +1660,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualRackName]: #virtualrackname #### [virtualRackName] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **string** +Type: **string** + @@ -1521,7 +1671,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualizationPlatform]: #virtualizationplatform #### [virtualizationPlatform] A piece of hardware's virtualization platform software. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -1533,7 +1684,8 @@ A piece of hardware's virtualization platform software. [activeComponentCount]: #activecomponentcount #### [activeComponentCount] A count of a piece of hardware's active physical components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1543,7 +1695,8 @@ A count of a piece of hardware's active physical components. [activeNetworkMonitorIncidentCount]: #activenetworkmonitorincidentcount #### [activeNetworkMonitorIncidentCount] A count of a piece of hardware's active network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -1553,7 +1706,8 @@ A count of a piece of hardware's active network monitoring incidents. [allPowerComponentCount]: #allpowercomponentcount #### [allPowerComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1563,7 +1717,8 @@ A count of [allowedNetworkStorageCount]: #allowednetworkstoragecount #### [allowedNetworkStorageCount] A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1573,7 +1728,8 @@ A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware ha [allowedNetworkStorageReplicaCount]: #allowednetworkstoragereplicacount #### [allowedNetworkStorageReplicaCount] A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1583,7 +1739,8 @@ A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLay [attributeCount]: #attributecount #### [attributeCount] A count of information regarding a piece of hardware's specific attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -1593,7 +1750,8 @@ A count of information regarding a piece of hardware's specific attributes. [backendNetworkComponentCount]: #backendnetworkcomponentcount #### [backendNetworkComponentCount] A count of a piece of hardware's back-end or private network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1603,7 +1761,8 @@ A count of a piece of hardware's back-end or private network components. [backendRouterCount]: #backendroutercount #### [backendRouterCount] A count of a hardware's backend or private router. -Type: **unsigned long** +Type: **unsigned long** + @@ -1613,7 +1772,8 @@ A count of a hardware's backend or private router. [benchmarkCertificationCount]: #benchmarkcertificationcount #### [benchmarkCertificationCount] A count of information regarding a piece of hardware's benchmark certifications. -Type: **unsigned long** +Type: **unsigned long** + @@ -1623,7 +1783,8 @@ A count of information regarding a piece of hardware's benchmark certifications. [boundSubnetCount]: #boundsubnetcount #### [boundSubnetCount] A count of associated subnets for a router object. -Type: **unsigned long** +Type: **unsigned long** + @@ -1633,7 +1794,8 @@ A count of associated subnets for a router object. [childrenHardwareCount]: #childrenhardwarecount #### [childrenHardwareCount] A count of child hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1643,7 +1805,8 @@ A count of child hardware. [componentCount]: #componentcount #### [componentCount] A count of a piece of hardware's components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1653,7 +1816,8 @@ A count of a piece of hardware's components. [downlinkHardwareCount]: #downlinkhardwarecount #### [downlinkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1663,7 +1827,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkNetworkHardwareCount]: #downlinknetworkhardwarecount #### [downlinkNetworkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1673,7 +1838,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkServerCount]: #downlinkservercount #### [downlinkServerCount] A count of information regarding all servers attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1683,7 +1849,8 @@ A count of information regarding all servers attached to a piece of network hard [downlinkVirtualGuestCount]: #downlinkvirtualguestcount #### [downlinkVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1693,7 +1860,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [downstreamHardwareBindingCount]: #downstreamhardwarebindingcount #### [downstreamHardwareBindingCount] A count of all hardware downstream from a network device. -Type: **unsigned long** +Type: **unsigned long** + @@ -1703,7 +1871,8 @@ A count of all hardware downstream from a network device. [downstreamNetworkHardwareCount]: #downstreamnetworkhardwarecount #### [downstreamNetworkHardwareCount] A count of all network hardware downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1713,7 +1882,8 @@ A count of all network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidentCount]: #downstreamnetworkhardwarewithincidentcount #### [downstreamNetworkHardwareWithIncidentCount] A count of all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1723,7 +1893,8 @@ A count of all network hardware with monitoring warnings or errors that are down [downstreamServerCount]: #downstreamservercount #### [downstreamServerCount] A count of information regarding all servers attached downstream to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1733,7 +1904,8 @@ A count of information regarding all servers attached downstream to a piece of n [downstreamVirtualGuestCount]: #downstreamvirtualguestcount #### [downstreamVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1743,7 +1915,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [driveControllerCount]: #drivecontrollercount #### [driveControllerCount] A count of the drive controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1753,7 +1926,8 @@ A count of the drive controllers contained within a piece of hardware. [evaultNetworkStorageCount]: #evaultnetworkstoragecount #### [evaultNetworkStorageCount] A count of information regarding a piece of hardware's associated EVault network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -1763,7 +1937,8 @@ A count of information regarding a piece of hardware's associated EVault network [frontendNetworkComponentCount]: #frontendnetworkcomponentcount #### [frontendNetworkComponentCount] A count of a piece of hardware's front-end or public network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1773,7 +1948,8 @@ A count of a piece of hardware's front-end or public network components. [frontendRouterCount]: #frontendroutercount #### [frontendRouterCount] A count of a hardware's frontend or public router. -Type: **unsigned long** +Type: **unsigned long** + @@ -1783,7 +1959,8 @@ A count of a hardware's frontend or public router. [hardDriveCount]: #harddrivecount #### [hardDriveCount] A count of the hard drives contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1793,7 +1970,8 @@ A count of the hard drives contained within a piece of hardware. [memoryCount]: #memorycount #### [memoryCount] A count of information regarding a piece of hardware's memory. -Type: **unsigned long** +Type: **unsigned long** + @@ -1803,7 +1981,8 @@ A count of information regarding a piece of hardware's memory. [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1813,7 +1992,8 @@ A count of [networkCardCount]: #networkcardcount #### [networkCardCount] A count of information regarding a piece of hardware's network cards. -Type: **unsigned long** +Type: **unsigned long** + @@ -1823,7 +2003,8 @@ A count of information regarding a piece of hardware's network cards. [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of returns a hardware's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1833,7 +2014,8 @@ A count of returns a hardware's network components. [networkMonitorAttachedDownHardwareCount]: #networkmonitorattacheddownhardwarecount #### [networkMonitorAttachedDownHardwareCount] A count of all servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1843,7 +2025,8 @@ A count of all servers with failed monitoring that are attached downstream to a [networkMonitorAttachedDownVirtualGuestCount]: #networkmonitorattacheddownvirtualguestcount #### [networkMonitorAttachedDownVirtualGuestCount] A count of virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **unsigned long** +Type: **unsigned long** + @@ -1853,7 +2036,8 @@ A count of virtual guests that are attached downstream to a hardware that have f [networkMonitorCount]: #networkmonitorcount #### [networkMonitorCount] A count of information regarding a piece of hardware's network monitors. -Type: **unsigned long** +Type: **unsigned long** + @@ -1863,7 +2047,8 @@ A count of information regarding a piece of hardware's network monitors. [networkMonitorIncidentCount]: #networkmonitorincidentcount #### [networkMonitorIncidentCount] A count of the status of all of a piece of hardware's network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -1873,7 +2058,8 @@ A count of the status of all of a piece of hardware's network monitoring inciden [networkStorageCount]: #networkstoragecount #### [networkStorageCount] A count of information regarding a piece of hardware's associated network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -1883,7 +2069,8 @@ A count of information regarding a piece of hardware's associated network storag [notesHistoryCount]: #noteshistorycount #### [notesHistoryCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1893,7 +2080,8 @@ A count of [nvRamComponentModelCount]: #nvramcomponentmodelcount #### [nvRamComponentModelCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1903,7 +2091,8 @@ A count of [powerComponentCount]: #powercomponentcount #### [powerComponentCount] A count of the power components for a hardware object. -Type: **unsigned long** +Type: **unsigned long** + @@ -1913,7 +2102,8 @@ A count of the power components for a hardware object. [powerSupplyCount]: #powersupplycount #### [powerSupplyCount] A count of information regarding a piece of hardware's power supply. -Type: **unsigned long** +Type: **unsigned long** + @@ -1923,7 +2113,8 @@ A count of information regarding a piece of hardware's power supply. [processorCount]: #processorcount #### [processorCount] A count of information regarding a piece of hardware's processors. -Type: **unsigned long** +Type: **unsigned long** + @@ -1933,7 +2124,8 @@ A count of information regarding a piece of hardware's processors. [raidControllerCount]: #raidcontrollercount #### [raidControllerCount] A count of the RAID controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1943,7 +2135,8 @@ A count of the RAID controllers contained within a piece of hardware. [recentEventCount]: #recenteventcount #### [recentEventCount] A count of recent events that impact this hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1953,7 +2146,8 @@ A count of recent events that impact this hardware. [remoteManagementAccountCount]: #remotemanagementaccountcount #### [remoteManagementAccountCount] A count of user credentials to issue commands and/or interact with the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -1963,7 +2157,8 @@ A count of user credentials to issue commands and/or interact with the server's [resourceConfigurationCount]: #resourceconfigurationcount #### [resourceConfigurationCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1973,7 +2168,8 @@ A count of [resourceGroupCount]: #resourcegroupcount #### [resourceGroupCount] A count of the resource groups in which this hardware is a member. -Type: **unsigned long** +Type: **unsigned long** + @@ -1983,7 +2179,8 @@ A count of the resource groups in which this hardware is a member. [resourceGroupMemberReferenceCount]: #resourcegroupmemberreferencecount #### [resourceGroupMemberReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1993,7 +2190,8 @@ A count of [resourceGroupRoleCount]: #resourcegrouprolecount #### [resourceGroupRoleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2003,7 +2201,8 @@ A count of [routerCount]: #routercount #### [routerCount] A count of a hardware's routers. -Type: **unsigned long** +Type: **unsigned long** + @@ -2013,7 +2212,8 @@ A count of a hardware's routers. [scaleAssetCount]: #scaleassetcount #### [scaleAssetCount] A count of collection of scale assets this hardware corresponds to. -Type: **unsigned long** +Type: **unsigned long** + @@ -2023,7 +2223,8 @@ A count of collection of scale assets this hardware corresponds to. [securityScanRequestCount]: #securityscanrequestcount #### [securityScanRequestCount] A count of information regarding a piece of hardware's vulnerability scan requests. -Type: **unsigned long** +Type: **unsigned long** + @@ -2033,7 +2234,8 @@ A count of information regarding a piece of hardware's vulnerability scan reques [softwareComponentCount]: #softwarecomponentcount #### [softwareComponentCount] A count of information regarding a piece of hardware's installed software. -Type: **unsigned long** +Type: **unsigned long** + @@ -2043,7 +2245,8 @@ A count of information regarding a piece of hardware's installed software. [sshKeyCount]: #sshkeycount #### [sshKeyCount] A count of sSH keys to be installed on the server during provisioning or an OS reload. -Type: **unsigned long** +Type: **unsigned long** + @@ -2053,7 +2256,8 @@ A count of sSH keys to be installed on the server during provisioning or an OS r [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2063,7 +2267,8 @@ A count of [storageNetworkComponentCount]: #storagenetworkcomponentcount #### [storageNetworkComponentCount] A count of a piece of hardware's private storage network components. [Deprecated] -Type: **unsigned long** +Type: **unsigned long** + @@ -2073,7 +2278,8 @@ A count of a piece of hardware's private storage network components. [Deprecated [tagReferenceCount]: #tagreferencecount #### [tagReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2083,7 +2289,8 @@ A count of [uplinkNetworkComponentCount]: #uplinknetworkcomponentcount #### [uplinkNetworkComponentCount] A count of information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **unsigned long** +Type: **unsigned long** + @@ -2093,7 +2300,8 @@ A count of information regarding the network component that is one level higher [userDataCount]: #userdatacount #### [userDataCount] A count of an array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **unsigned long** +Type: **unsigned long** + @@ -2103,7 +2311,8 @@ A count of an array containing a single string of custom user data for a hardwar [virtualChassisSiblingCount]: #virtualchassissiblingcount #### [virtualChassisSiblingCount] A count of information regarding the virtual chassis siblings for a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2113,7 +2322,8 @@ A count of information regarding the virtual chassis siblings for a piece of har [virtualLicenseCount]: #virtuallicensecount #### [virtualLicenseCount] A count of information regarding a piece of hardware's virtual software licenses. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Router_Backend/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Router_Backend/_index.md index 5925dbf0e8..a1cd28e1e8 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Router_Backend/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Router_Backend/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Router_Backend data type contains general information relating to a single SoftLayer router item for hardware. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Router_Backend data type contains general information rel [accountId]: #accountid #### [accountId] A hardware's associated [SoftLayer_Account]({{}}) id. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ A hardware's associated [SoftLayer_Account]({{Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ When true, this flag specifies that a hardware is Bare Metal Server. Bare Metal [domain]: #domain #### [domain] A piece of hardware's local network domain name. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A piece of hardware's local network domain name. [fullyQualifiedDomainName]: #fullyqualifieddomainname #### [fullyQualifiedDomainName] A name reflecting the hostname and domain of the hardware. This is created from the combined values of the hardware's hostname and domain name automatically, and thus should not be edited directly. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ A name reflecting the hostname and domain of the hardware. This is created from [hardwareStatusId]: #hardwarestatusid #### [hardwareStatusId] A number reflecting the state of a hardware -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ A number reflecting the state of a hardware [hostname]: #hostname #### [hostname] A hardware's hostname -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ A hardware's hostname [id]: #id #### [id] A hardware's internal identification number -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A hardware's internal identification number [manufacturerSerialNumber]: #manufacturerserialnumber #### [manufacturerSerialNumber] A hardware's serial number that is supplied by the manufacturer. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A hardware's serial number that is supplied by the manufacturer. [notes]: #notes #### [notes] A small note about a piece of hardware to use at your discretion. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ A small note about a piece of hardware to use at your discretion. [postInstallScriptUri]: #postinstallscripturi #### [postInstallScriptUri] URI of the script to be downloaded and executed after installation is complete. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ URI of the script to be downloaded and executed after installation is complete. [provisionDate]: #provisiondate #### [provisionDate] -Type: **dateTime** +Type: **dateTime** + @@ -155,7 +168,8 @@ URI of the script to be downloaded and executed after installation is complete. [serialNumber]: #serialnumber #### [serialNumber] A hardware's serial number that is supplied by SoftLayer. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderResourceId]: #serviceproviderresourceid #### [serviceProviderResourceId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -191,7 +207,8 @@ A hardware's internal identification number at its service provider [account]: #account #### [account] The account associated with a piece of hardware. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -201,7 +218,8 @@ The account associated with a piece of hardware. [activeComponents]: #activecomponents #### [activeComponents] A piece of hardware's active physical components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -211,7 +229,8 @@ A piece of hardware's active physical components. [activeNetworkMonitorIncident]: #activenetworkmonitorincident #### [activeNetworkMonitorIncident] A piece of hardware's active network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -221,7 +240,8 @@ A piece of hardware's active network monitoring incidents. [allPowerComponents]: #allpowercomponents #### [allPowerComponents] -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -231,7 +251,8 @@ A piece of hardware's active network monitoring incidents. [allowedHost]: #allowedhost #### [allowedHost] The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. -Type: **SoftLayer_Network_Storage_Allowed_Host ** +Type: **SoftLayer_Network_Storage_Allowed_Host ** + @@ -241,7 +262,8 @@ The SoftLayer_Network_Storage_Allowed_Host information to connect this server to [allowedNetworkStorage]: #allowednetworkstorage #### [allowedNetworkStorage] The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -251,7 +273,8 @@ The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to [allowedNetworkStorageReplicas]: #allowednetworkstoragereplicas #### [allowedNetworkStorageReplicas] The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -261,7 +284,8 @@ The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware [antivirusSpywareSoftwareComponent]: #antivirusspywaresoftwarecomponent #### [antivirusSpywareSoftwareComponent] Information regarding an antivirus/spyware software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -271,7 +295,8 @@ Information regarding an antivirus/spyware software component object. [attributes]: #attributes #### [attributes] Information regarding a piece of hardware's specific attributes. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -281,7 +306,8 @@ Information regarding a piece of hardware's specific attributes. [averageDailyPublicBandwidthUsage]: #averagedailypublicbandwidthusage #### [averageDailyPublicBandwidthUsage] The average daily public bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -291,7 +317,8 @@ The average daily public bandwidth usage for the current billing cycle. [backendNetworkComponents]: #backendnetworkcomponents #### [backendNetworkComponents] A piece of hardware's back-end or private network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -301,7 +328,8 @@ A piece of hardware's back-end or private network components. [backendRouters]: #backendrouters #### [backendRouters] A hardware's backend or private router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -311,7 +339,8 @@ A hardware's backend or private router. [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] A hardware's allotted bandwidth (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -321,7 +350,8 @@ A hardware's allotted bandwidth (measured in GB). [bandwidthAllotmentDetail]: #bandwidthallotmentdetail #### [bandwidthAllotmentDetail] A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** + @@ -331,7 +361,8 @@ A hardware's allotted detail record. Allotment details link bandwidth allocation [benchmarkCertifications]: #benchmarkcertifications #### [benchmarkCertifications] Information regarding a piece of hardware's benchmark certifications. -Type: **SoftLayer_Hardware_Benchmark_Certification[] ** +Type: **SoftLayer_Hardware_Benchmark_Certification[] ** + @@ -341,7 +372,8 @@ Information regarding a piece of hardware's benchmark certifications. [billingItem]: #billingitem #### [billingItem] Information regarding the billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -351,7 +383,8 @@ Information regarding the billing item for a server. [billingItemFlag]: #billingitemflag #### [billingItemFlag] A flag indicating that a billing item exists. -Type: **boolean** +Type: **boolean** + @@ -361,7 +394,8 @@ A flag indicating that a billing item exists. [blockCancelBecauseDisconnectedFlag]: #blockcancelbecausedisconnectedflag #### [blockCancelBecauseDisconnectedFlag] Determines whether the hardware is ineligible for cancellation because it is disconnected. -Type: **boolean** +Type: **boolean** + @@ -371,7 +405,8 @@ Determines whether the hardware is ineligible for cancellation because it is dis [boundSubnets]: #boundsubnets #### [boundSubnets] Associated subnets for a router object. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -381,7 +416,8 @@ Associated subnets for a router object. [businessContinuanceInsuranceFlag]: #businesscontinuanceinsuranceflag #### [businessContinuanceInsuranceFlag] Status indicating whether or not a piece of hardware has business continuance insurance. -Type: **boolean** +Type: **boolean** + @@ -391,7 +427,8 @@ Status indicating whether or not a piece of hardware has business continuance in [childrenHardware]: #childrenhardware #### [childrenHardware] Child hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -401,7 +438,8 @@ Child hardware. [components]: #components #### [components] A piece of hardware's components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -411,7 +449,8 @@ A piece of hardware's components. [continuousDataProtectionSoftwareComponent]: #continuousdataprotectionsoftwarecomponent #### [continuousDataProtectionSoftwareComponent] A continuous data protection/server backup software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -421,7 +460,8 @@ A continuous data protection/server backup software component object. [currentBillableBandwidthUsage]: #currentbillablebandwidthusage #### [currentBillableBandwidthUsage] The current billable public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -431,7 +471,8 @@ The current billable public outbound bandwidth for this hardware for the current [datacenter]: #datacenter #### [datacenter] Information regarding the datacenter in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -441,7 +482,8 @@ Information regarding the datacenter in which a piece of hardware resides. [datacenterName]: #datacentername #### [datacenterName] The name of the datacenter in which a piece of hardware resides. -Type: **string** +Type: **string** + @@ -451,7 +493,8 @@ The name of the datacenter in which a piece of hardware resides. [daysInSparePool]: #daysinsparepool #### [daysInSparePool] Number of day(s) a server have been in spare pool. -Type: **integer** +Type: **integer** + @@ -461,7 +504,8 @@ Number of day(s) a server have been in spare pool. [downlinkHardware]: #downlinkhardware #### [downlinkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -471,7 +515,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkNetworkHardware]: #downlinknetworkhardware #### [downlinkNetworkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -481,7 +526,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkServers]: #downlinkservers #### [downlinkServers] Information regarding all servers attached to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -491,7 +537,8 @@ Information regarding all servers attached to a piece of network hardware. [downlinkVirtualGuests]: #downlinkvirtualguests #### [downlinkVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -501,7 +548,8 @@ Information regarding all virtual guests attached to a piece of network hardware [downstreamHardwareBindings]: #downstreamhardwarebindings #### [downstreamHardwareBindings] All hardware downstream from a network device. -Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** +Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** + @@ -511,7 +559,8 @@ All hardware downstream from a network device. [downstreamNetworkHardware]: #downstreamnetworkhardware #### [downstreamNetworkHardware] All network hardware downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -521,7 +570,8 @@ All network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidents]: #downstreamnetworkhardwarewithincidents #### [downstreamNetworkHardwareWithIncidents] All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -531,7 +581,8 @@ All network hardware with monitoring warnings or errors that are downstream from [downstreamServers]: #downstreamservers #### [downstreamServers] Information regarding all servers attached downstream to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -541,7 +592,8 @@ Information regarding all servers attached downstream to a piece of network hard [downstreamVirtualGuests]: #downstreamvirtualguests #### [downstreamVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -551,7 +603,8 @@ Information regarding all virtual guests attached to a piece of network hardware [driveControllers]: #drivecontrollers #### [driveControllers] The drive controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -561,7 +614,8 @@ The drive controllers contained within a piece of hardware. [evaultNetworkStorage]: #evaultnetworkstorage #### [evaultNetworkStorage] Information regarding a piece of hardware's associated EVault network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -571,7 +625,8 @@ Information regarding a piece of hardware's associated EVault network storage se [firewallServiceComponent]: #firewallservicecomponent #### [firewallServiceComponent] Information regarding a piece of hardware's firewall services. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -581,7 +636,8 @@ Information regarding a piece of hardware's firewall services. [fixedConfigurationPreset]: #fixedconfigurationpreset #### [fixedConfigurationPreset] Defines the fixed components in a fixed configuration bare metal server. -Type: **SoftLayer_Product_Package_Preset ** +Type: **SoftLayer_Product_Package_Preset ** + @@ -591,7 +647,8 @@ Defines the fixed components in a fixed configuration bare metal server. [frontendNetworkComponents]: #frontendnetworkcomponents #### [frontendNetworkComponents] A piece of hardware's front-end or public network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -601,7 +658,8 @@ A piece of hardware's front-end or public network components. [frontendRouters]: #frontendrouters #### [frontendRouters] A hardware's frontend or public router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -611,7 +669,8 @@ A hardware's frontend or public router. [futureBillingItem]: #futurebillingitem #### [futureBillingItem] Information regarding the future billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -621,7 +680,8 @@ Information regarding the future billing item for a server. [globalIdentifier]: #globalidentifier #### [globalIdentifier] A hardware's universally unique identifier. -Type: **string** +Type: **string** + @@ -631,7 +691,8 @@ A hardware's universally unique identifier. [hardDrives]: #harddrives #### [hardDrives] The hard drives contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -641,7 +702,8 @@ The hard drives contained within a piece of hardware. [hardwareChassis]: #hardwarechassis #### [hardwareChassis] The chassis that a piece of hardware is housed in. -Type: **SoftLayer_Hardware_Chassis ** +Type: **SoftLayer_Hardware_Chassis ** + @@ -651,7 +713,8 @@ The chassis that a piece of hardware is housed in. [hardwareFunction]: #hardwarefunction #### [hardwareFunction] A hardware's function. -Type: **SoftLayer_Hardware_Function ** +Type: **SoftLayer_Hardware_Function ** + @@ -661,7 +724,8 @@ A hardware's function. [hardwareFunctionDescription]: #hardwarefunctiondescription #### [hardwareFunctionDescription] A hardware's function. -Type: **string** +Type: **string** + @@ -671,7 +735,8 @@ A hardware's function. [hardwareStatus]: #hardwarestatus #### [hardwareStatus] A hardware's status. -Type: **SoftLayer_Hardware_Status ** +Type: **SoftLayer_Hardware_Status ** + @@ -681,7 +746,8 @@ A hardware's status. [hasTrustedPlatformModuleBillingItemFlag]: #hastrustedplatformmodulebillingitemflag #### [hasTrustedPlatformModuleBillingItemFlag] Determine in hardware object has TPM enabled. -Type: **boolean** +Type: **boolean** + @@ -691,7 +757,8 @@ Determine in hardware object has TPM enabled. [hostIpsSoftwareComponent]: #hostipssoftwarecomponent #### [hostIpsSoftwareComponent] Information regarding a host IPS software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -701,7 +768,8 @@ Information regarding a host IPS software component object. [hourlyBillingFlag]: #hourlybillingflag #### [hourlyBillingFlag] A server's hourly billing status. -Type: **boolean** +Type: **boolean** + @@ -711,7 +779,8 @@ A server's hourly billing status. [inboundBandwidthUsage]: #inboundbandwidthusage #### [inboundBandwidthUsage] The sum of all the inbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -721,7 +790,8 @@ The sum of all the inbound network traffic data for the last 30 days. [inboundPublicBandwidthUsage]: #inboundpublicbandwidthusage #### [inboundPublicBandwidthUsage] The total public inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -731,7 +801,8 @@ The total public inbound bandwidth for this hardware for the current billing cyc [isBillingTermChangeAvailableFlag]: #isbillingtermchangeavailableflag #### [isBillingTermChangeAvailableFlag] Whether or not this hardware object is eligible to change to term billing. -Type: **boolean** +Type: **boolean** + @@ -741,7 +812,8 @@ Whether or not this hardware object is eligible to change to term billing. [lastTransaction]: #lasttransaction #### [lastTransaction] Information regarding the last transaction a server performed. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -751,7 +823,8 @@ Information regarding the last transaction a server performed. [latestNetworkMonitorIncident]: #latestnetworkmonitorincident #### [latestNetworkMonitorIncident] A piece of hardware's latest network monitoring incident. -Type: **SoftLayer_Network_Monitor_Version1_Incident ** +Type: **SoftLayer_Network_Monitor_Version1_Incident ** + @@ -761,7 +834,8 @@ A piece of hardware's latest network monitoring incident. [localDiskStorageCapabilityFlag]: #localdiskstoragecapabilityflag #### [localDiskStorageCapabilityFlag] A flag indicating that a VLAN on the router can be assigned to a host that has local disk functionality. -Type: **boolean** +Type: **boolean** + @@ -771,7 +845,8 @@ A flag indicating that a VLAN on the router can be assigned to a host that has l [location]: #location #### [location] Where a piece of hardware is located within SoftLayer's location hierarchy. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -781,7 +856,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [locationPathString]: #locationpathstring #### [locationPathString] -Type: **string** +Type: **string** + @@ -791,7 +867,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [lockboxNetworkStorage]: #lockboxnetworkstorage #### [lockboxNetworkStorage] Information regarding a lockbox account associated with a server. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -801,7 +878,8 @@ Information regarding a lockbox account associated with a server. [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the hardware is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -811,7 +889,8 @@ A flag indicating that the hardware is a managed resource. [memory]: #memory #### [memory] Information regarding a piece of hardware's memory. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -821,7 +900,8 @@ Information regarding a piece of hardware's memory. [memoryCapacity]: #memorycapacity #### [memoryCapacity] The amount of memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -831,7 +911,8 @@ The amount of memory a piece of hardware has, measured in gigabytes. [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A piece of hardware's metric tracking object. -Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** +Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** + @@ -841,7 +922,8 @@ A piece of hardware's metric tracking object. [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -851,7 +933,8 @@ A piece of hardware's metric tracking object. [monitoringRobot]: #monitoringrobot #### [monitoringRobot] -Type: **SoftLayer_Monitoring_Robot ** +Type: **SoftLayer_Monitoring_Robot ** + @@ -861,7 +944,8 @@ A piece of hardware's metric tracking object. [monitoringServiceComponent]: #monitoringservicecomponent #### [monitoringServiceComponent] Information regarding a piece of hardware's network monitoring services. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** + @@ -871,7 +955,8 @@ Information regarding a piece of hardware's network monitoring services. [monitoringServiceEligibilityFlag]: #monitoringserviceeligibilityflag #### [monitoringServiceEligibilityFlag] -Type: **boolean** +Type: **boolean** + @@ -881,7 +966,8 @@ Information regarding a piece of hardware's network monitoring services. [motherboard]: #motherboard #### [motherboard] Information regarding a piece of hardware's motherboard. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -891,7 +977,8 @@ Information regarding a piece of hardware's motherboard. [networkCards]: #networkcards #### [networkCards] Information regarding a piece of hardware's network cards. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -901,7 +988,8 @@ Information regarding a piece of hardware's network cards. [networkComponents]: #networkcomponents #### [networkComponents] Returns a hardware's network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -911,7 +999,8 @@ Returns a hardware's network components. [networkGatewayMember]: #networkgatewaymember #### [networkGatewayMember] The gateway member if this device is part of a network gateway. -Type: **SoftLayer_Network_Gateway_Member ** +Type: **SoftLayer_Network_Gateway_Member ** + @@ -921,7 +1010,8 @@ The gateway member if this device is part of a network gateway. [networkGatewayMemberFlag]: #networkgatewaymemberflag #### [networkGatewayMemberFlag] Whether or not this device is part of a network gateway. -Type: **boolean** +Type: **boolean** + @@ -931,7 +1021,8 @@ Whether or not this device is part of a network gateway. [networkMonitorAttachedDownHardware]: #networkmonitorattacheddownhardware #### [networkMonitorAttachedDownHardware] All servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -941,7 +1032,8 @@ All servers with failed monitoring that are attached downstream to a piece of ha [networkMonitorAttachedDownVirtualGuests]: #networkmonitorattacheddownvirtualguests #### [networkMonitorAttachedDownVirtualGuests] Virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -951,7 +1043,8 @@ Virtual guests that are attached downstream to a hardware that have failed monit [networkMonitorIncidents]: #networkmonitorincidents #### [networkMonitorIncidents] The status of all of a piece of hardware's network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -961,7 +1054,8 @@ The status of all of a piece of hardware's network monitoring incidents. [networkMonitors]: #networkmonitors #### [networkMonitors] Information regarding a piece of hardware's network monitors. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** + @@ -971,7 +1065,8 @@ Information regarding a piece of hardware's network monitors. [networkStatus]: #networkstatus #### [networkStatus] The value of a hardware's network status attribute. -Type: **string** +Type: **string** + @@ -981,7 +1076,8 @@ The value of a hardware's network status attribute. [networkStatusAttribute]: #networkstatusattribute #### [networkStatusAttribute] The hardware's related network status attribute. -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -991,7 +1087,8 @@ The hardware's related network status attribute. [networkStorage]: #networkstorage #### [networkStorage] Information regarding a piece of hardware's associated network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -1001,7 +1098,8 @@ Information regarding a piece of hardware's associated network storage service a [nextBillingCycleBandwidthAllocation]: #nextbillingcyclebandwidthallocation #### [nextBillingCycleBandwidthAllocation] A hardware's allotted bandwidth for the next billing cycle (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -1011,7 +1109,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [notesHistory]: #noteshistory #### [notesHistory] -Type: **SoftLayer_Hardware_Note[] ** +Type: **SoftLayer_Hardware_Note[] ** + @@ -1021,7 +1120,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [nvRamCapacity]: #nvramcapacity #### [nvRamCapacity] The amount of non-volatile memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1031,7 +1131,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [nvRamComponentModels]: #nvramcomponentmodels #### [nvRamComponentModels] -Type: **SoftLayer_Hardware_Component_Model[] ** +Type: **SoftLayer_Hardware_Component_Model[] ** + @@ -1041,7 +1142,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [operatingSystem]: #operatingsystem #### [operatingSystem] Information regarding a piece of hardware's operating system. -Type: **SoftLayer_Software_Component_OperatingSystem ** +Type: **SoftLayer_Software_Component_OperatingSystem ** + @@ -1051,7 +1153,8 @@ Information regarding a piece of hardware's operating system. [operatingSystemReferenceCode]: #operatingsystemreferencecode #### [operatingSystemReferenceCode] A hardware's operating system software description. -Type: **string** +Type: **string** + @@ -1061,7 +1164,8 @@ A hardware's operating system software description. [outboundBandwidthUsage]: #outboundbandwidthusage #### [outboundBandwidthUsage] The sum of all the outbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -1071,7 +1175,8 @@ The sum of all the outbound network traffic data for the last 30 days. [outboundPublicBandwidthUsage]: #outboundpublicbandwidthusage #### [outboundPublicBandwidthUsage] The total public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -1081,7 +1186,8 @@ The total public outbound bandwidth for this hardware for the current billing cy [parentBay]: #parentbay #### [parentBay] Blade Bay -Type: **SoftLayer_Hardware_Blade ** +Type: **SoftLayer_Hardware_Blade ** + @@ -1091,7 +1197,8 @@ Blade Bay [parentHardware]: #parenthardware #### [parentHardware] Parent Hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1101,7 +1208,8 @@ Parent Hardware. [pointOfPresenceLocation]: #pointofpresencelocation #### [pointOfPresenceLocation] Information regarding the Point of Presence (PoP) location in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1111,7 +1219,8 @@ Information regarding the Point of Presence (PoP) location in which a piece of h [powerComponents]: #powercomponents #### [powerComponents] The power components for a hardware object. -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -1121,7 +1230,8 @@ The power components for a hardware object. [powerSupply]: #powersupply #### [powerSupply] Information regarding a piece of hardware's power supply. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1131,7 +1241,8 @@ Information regarding a piece of hardware's power supply. [primaryBackendNetworkComponent]: #primarybackendnetworkcomponent #### [primaryBackendNetworkComponent] Information regarding the hardware's primary back-end network component. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1141,7 +1252,8 @@ Information regarding the hardware's primary back-end network component. [primaryNetworkComponent]: #primarynetworkcomponent #### [primaryNetworkComponent] Information regarding the hardware's primary public network component. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1151,7 +1263,8 @@ Information regarding the hardware's primary public network component. [privateNetworkOnlyFlag]: #privatenetworkonlyflag #### [privateNetworkOnlyFlag] Whether the hardware only has access to the private network. -Type: **boolean** +Type: **boolean** + @@ -1161,7 +1274,8 @@ Whether the hardware only has access to the private network. [processorCoreAmount]: #processorcoreamount #### [processorCoreAmount] The total number of processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1171,7 +1285,8 @@ The total number of processor cores, summed from all processors that are attache [processorPhysicalCoreAmount]: #processorphysicalcoreamount #### [processorPhysicalCoreAmount] The total number of physical processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1181,7 +1296,8 @@ The total number of physical processor cores, summed from all processors that ar [processors]: #processors #### [processors] Information regarding a piece of hardware's processors. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1191,7 +1307,8 @@ Information regarding a piece of hardware's processors. [rack]: #rack #### [rack] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1201,7 +1318,8 @@ Information regarding a piece of hardware's processors. [raidControllers]: #raidcontrollers #### [raidControllers] The RAID controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1211,7 +1329,8 @@ The RAID controllers contained within a piece of hardware. [recentEvents]: #recentevents #### [recentEvents] Recent events that impact this hardware. -Type: **SoftLayer_Notification_Occurrence_Event[] ** +Type: **SoftLayer_Notification_Occurrence_Event[] ** + @@ -1221,7 +1340,8 @@ Recent events that impact this hardware. [remoteManagementAccounts]: #remotemanagementaccounts #### [remoteManagementAccounts] User credentials to issue commands and/or interact with the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** + @@ -1231,7 +1351,8 @@ User credentials to issue commands and/or interact with the server's remote mana [remoteManagementComponent]: #remotemanagementcomponent #### [remoteManagementComponent] A hardware's associated remote management component. This is normally IPMI. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1241,7 +1362,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceConfigurations]: #resourceconfigurations #### [resourceConfigurations] -Type: **SoftLayer_Hardware_Resource_Configuration[] ** +Type: **SoftLayer_Hardware_Resource_Configuration[] ** + @@ -1251,7 +1373,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroupMemberReferences]: #resourcegroupmemberreferences #### [resourceGroupMemberReferences] -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -1261,7 +1384,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroupRoles]: #resourcegrouproles #### [resourceGroupRoles] -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -1271,7 +1395,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroups]: #resourcegroups #### [resourceGroups] The resource groups in which this hardware is a member. -Type: **SoftLayer_Resource_Group[] ** +Type: **SoftLayer_Resource_Group[] ** + @@ -1281,7 +1406,8 @@ The resource groups in which this hardware is a member. [routers]: #routers #### [routers] A hardware's routers. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1291,7 +1417,8 @@ A hardware's routers. [sanStorageCapabilityFlag]: #sanstoragecapabilityflag #### [sanStorageCapabilityFlag] A flag indicating that a VLAN on the router can be assigned to a host that has SAN disk functionality. -Type: **boolean** +Type: **boolean** + @@ -1301,7 +1428,8 @@ A flag indicating that a VLAN on the router can be assigned to a host that has S [scaleAssets]: #scaleassets #### [scaleAssets] Collection of scale assets this hardware corresponds to. -Type: **SoftLayer_Scale_Asset[] ** +Type: **SoftLayer_Scale_Asset[] ** + @@ -1311,7 +1439,8 @@ Collection of scale assets this hardware corresponds to. [securityScanRequests]: #securityscanrequests #### [securityScanRequests] Information regarding a piece of hardware's vulnerability scan requests. -Type: **SoftLayer_Network_Security_Scanner_Request[] ** +Type: **SoftLayer_Network_Security_Scanner_Request[] ** + @@ -1321,7 +1450,8 @@ Information regarding a piece of hardware's vulnerability scan requests. [serverRoom]: #serverroom #### [serverRoom] Information regarding the server room in which the hardware is located. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1331,7 +1461,8 @@ Information regarding the server room in which the hardware is located. [serviceProvider]: #serviceprovider #### [serviceProvider] Information regarding the piece of hardware's service provider. -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -1341,7 +1472,8 @@ Information regarding the piece of hardware's service provider. [softwareComponents]: #softwarecomponents #### [softwareComponents] Information regarding a piece of hardware's installed software. -Type: **SoftLayer_Software_Component[] ** +Type: **SoftLayer_Software_Component[] ** + @@ -1351,7 +1483,8 @@ Information regarding a piece of hardware's installed software. [sparePoolBillingItem]: #sparepoolbillingitem #### [sparePoolBillingItem] Information regarding the billing item for a spare pool server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -1361,7 +1494,8 @@ Information regarding the billing item for a spare pool server. [sshKeys]: #sshkeys #### [sshKeys] SSH keys to be installed on the server during provisioning or an OS reload. -Type: **SoftLayer_Security_Ssh_Key[] ** +Type: **SoftLayer_Security_Ssh_Key[] ** + @@ -1371,17 +1505,20 @@ SSH keys to be installed on the server during provisioning or an OS reload. [storageGroups]: #storagegroups #### [storageGroups] -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + -
      +
      ----- [storageNetworkComponents]: #storagenetworkcomponents #### [storageNetworkComponents] A piece of hardware's private storage network components. [Deprecated] -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + +Deprecated
      @@ -1391,7 +1528,8 @@ A piece of hardware's private storage network components. [Deprecated] [tagReferences]: #tagreferences #### [tagReferences] -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** +
      @@ -1401,7 +1539,8 @@ A piece of hardware's private storage network components. [Deprecated] [topLevelLocation]: #toplevellocation #### [topLevelLocation] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1411,7 +1550,8 @@ A piece of hardware's private storage network components. [Deprecated] [upgradeRequest]: #upgraderequest #### [upgradeRequest] An account's associated upgrade request object, if any. -Type: **SoftLayer_Product_Upgrade_Request ** +Type: **SoftLayer_Product_Upgrade_Request ** + @@ -1421,7 +1561,8 @@ An account's associated upgrade request object, if any. [uplinkHardware]: #uplinkhardware #### [uplinkHardware] The network device connected to a piece of hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1431,7 +1572,8 @@ The network device connected to a piece of hardware. [uplinkNetworkComponents]: #uplinknetworkcomponents #### [uplinkNetworkComponents] Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -1441,7 +1583,8 @@ Information regarding the network component that is one level higher than a piec [userData]: #userdata #### [userData] An array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -1451,7 +1594,8 @@ An array containing a single string of custom user data for a hardware order. Ma [virtualChassis]: #virtualchassis #### [virtualChassis] Information regarding the virtual chassis for a piece of hardware. -Type: **SoftLayer_Hardware_Group ** +Type: **SoftLayer_Hardware_Group ** + @@ -1461,7 +1605,8 @@ Information regarding the virtual chassis for a piece of hardware. [virtualChassisSiblings]: #virtualchassissiblings #### [virtualChassisSiblings] Information regarding the virtual chassis siblings for a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1471,7 +1616,8 @@ Information regarding the virtual chassis siblings for a piece of hardware. [virtualHost]: #virtualhost #### [virtualHost] A piece of hardware's virtual host record. -Type: **SoftLayer_Virtual_Host ** +Type: **SoftLayer_Virtual_Host ** + @@ -1481,7 +1627,8 @@ A piece of hardware's virtual host record. [virtualLicenses]: #virtuallicenses #### [virtualLicenses] Information regarding a piece of hardware's virtual software licenses. -Type: **SoftLayer_Software_VirtualLicense[] ** +Type: **SoftLayer_Software_VirtualLicense[] ** + @@ -1491,7 +1638,8 @@ Information regarding a piece of hardware's virtual software licenses. [virtualRack]: #virtualrack #### [virtualRack] Information regarding the bandwidth allotment to which a piece of hardware belongs. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** + @@ -1501,7 +1649,8 @@ Information regarding the bandwidth allotment to which a piece of hardware belon [virtualRackId]: #virtualrackid #### [virtualRackId] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **integer** +Type: **integer** + @@ -1511,7 +1660,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualRackName]: #virtualrackname #### [virtualRackName] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **string** +Type: **string** + @@ -1521,7 +1671,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualizationPlatform]: #virtualizationplatform #### [virtualizationPlatform] A piece of hardware's virtualization platform software. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -1533,7 +1684,8 @@ A piece of hardware's virtualization platform software. [activeComponentCount]: #activecomponentcount #### [activeComponentCount] A count of a piece of hardware's active physical components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1543,7 +1695,8 @@ A count of a piece of hardware's active physical components. [activeNetworkMonitorIncidentCount]: #activenetworkmonitorincidentcount #### [activeNetworkMonitorIncidentCount] A count of a piece of hardware's active network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -1553,7 +1706,8 @@ A count of a piece of hardware's active network monitoring incidents. [allPowerComponentCount]: #allpowercomponentcount #### [allPowerComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1563,7 +1717,8 @@ A count of [allowedNetworkStorageCount]: #allowednetworkstoragecount #### [allowedNetworkStorageCount] A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1573,7 +1728,8 @@ A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware ha [allowedNetworkStorageReplicaCount]: #allowednetworkstoragereplicacount #### [allowedNetworkStorageReplicaCount] A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1583,7 +1739,8 @@ A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLay [attributeCount]: #attributecount #### [attributeCount] A count of information regarding a piece of hardware's specific attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -1593,7 +1750,8 @@ A count of information regarding a piece of hardware's specific attributes. [backendNetworkComponentCount]: #backendnetworkcomponentcount #### [backendNetworkComponentCount] A count of a piece of hardware's back-end or private network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1603,7 +1761,8 @@ A count of a piece of hardware's back-end or private network components. [backendRouterCount]: #backendroutercount #### [backendRouterCount] A count of a hardware's backend or private router. -Type: **unsigned long** +Type: **unsigned long** + @@ -1613,7 +1772,8 @@ A count of a hardware's backend or private router. [benchmarkCertificationCount]: #benchmarkcertificationcount #### [benchmarkCertificationCount] A count of information regarding a piece of hardware's benchmark certifications. -Type: **unsigned long** +Type: **unsigned long** + @@ -1623,7 +1783,8 @@ A count of information regarding a piece of hardware's benchmark certifications. [boundSubnetCount]: #boundsubnetcount #### [boundSubnetCount] A count of associated subnets for a router object. -Type: **unsigned long** +Type: **unsigned long** + @@ -1633,7 +1794,8 @@ A count of associated subnets for a router object. [childrenHardwareCount]: #childrenhardwarecount #### [childrenHardwareCount] A count of child hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1643,7 +1805,8 @@ A count of child hardware. [componentCount]: #componentcount #### [componentCount] A count of a piece of hardware's components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1653,7 +1816,8 @@ A count of a piece of hardware's components. [downlinkHardwareCount]: #downlinkhardwarecount #### [downlinkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1663,7 +1827,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkNetworkHardwareCount]: #downlinknetworkhardwarecount #### [downlinkNetworkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1673,7 +1838,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkServerCount]: #downlinkservercount #### [downlinkServerCount] A count of information regarding all servers attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1683,7 +1849,8 @@ A count of information regarding all servers attached to a piece of network hard [downlinkVirtualGuestCount]: #downlinkvirtualguestcount #### [downlinkVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1693,7 +1860,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [downstreamHardwareBindingCount]: #downstreamhardwarebindingcount #### [downstreamHardwareBindingCount] A count of all hardware downstream from a network device. -Type: **unsigned long** +Type: **unsigned long** + @@ -1703,7 +1871,8 @@ A count of all hardware downstream from a network device. [downstreamNetworkHardwareCount]: #downstreamnetworkhardwarecount #### [downstreamNetworkHardwareCount] A count of all network hardware downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1713,7 +1882,8 @@ A count of all network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidentCount]: #downstreamnetworkhardwarewithincidentcount #### [downstreamNetworkHardwareWithIncidentCount] A count of all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1723,7 +1893,8 @@ A count of all network hardware with monitoring warnings or errors that are down [downstreamServerCount]: #downstreamservercount #### [downstreamServerCount] A count of information regarding all servers attached downstream to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1733,7 +1904,8 @@ A count of information regarding all servers attached downstream to a piece of n [downstreamVirtualGuestCount]: #downstreamvirtualguestcount #### [downstreamVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1743,7 +1915,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [driveControllerCount]: #drivecontrollercount #### [driveControllerCount] A count of the drive controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1753,7 +1926,8 @@ A count of the drive controllers contained within a piece of hardware. [evaultNetworkStorageCount]: #evaultnetworkstoragecount #### [evaultNetworkStorageCount] A count of information regarding a piece of hardware's associated EVault network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -1763,7 +1937,8 @@ A count of information regarding a piece of hardware's associated EVault network [frontendNetworkComponentCount]: #frontendnetworkcomponentcount #### [frontendNetworkComponentCount] A count of a piece of hardware's front-end or public network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1773,7 +1948,8 @@ A count of a piece of hardware's front-end or public network components. [frontendRouterCount]: #frontendroutercount #### [frontendRouterCount] A count of a hardware's frontend or public router. -Type: **unsigned long** +Type: **unsigned long** + @@ -1783,7 +1959,8 @@ A count of a hardware's frontend or public router. [hardDriveCount]: #harddrivecount #### [hardDriveCount] A count of the hard drives contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1793,7 +1970,8 @@ A count of the hard drives contained within a piece of hardware. [memoryCount]: #memorycount #### [memoryCount] A count of information regarding a piece of hardware's memory. -Type: **unsigned long** +Type: **unsigned long** + @@ -1803,7 +1981,8 @@ A count of information regarding a piece of hardware's memory. [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1813,7 +1992,8 @@ A count of [networkCardCount]: #networkcardcount #### [networkCardCount] A count of information regarding a piece of hardware's network cards. -Type: **unsigned long** +Type: **unsigned long** + @@ -1823,7 +2003,8 @@ A count of information regarding a piece of hardware's network cards. [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of returns a hardware's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1833,7 +2014,8 @@ A count of returns a hardware's network components. [networkMonitorAttachedDownHardwareCount]: #networkmonitorattacheddownhardwarecount #### [networkMonitorAttachedDownHardwareCount] A count of all servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1843,7 +2025,8 @@ A count of all servers with failed monitoring that are attached downstream to a [networkMonitorAttachedDownVirtualGuestCount]: #networkmonitorattacheddownvirtualguestcount #### [networkMonitorAttachedDownVirtualGuestCount] A count of virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **unsigned long** +Type: **unsigned long** + @@ -1853,7 +2036,8 @@ A count of virtual guests that are attached downstream to a hardware that have f [networkMonitorCount]: #networkmonitorcount #### [networkMonitorCount] A count of information regarding a piece of hardware's network monitors. -Type: **unsigned long** +Type: **unsigned long** + @@ -1863,7 +2047,8 @@ A count of information regarding a piece of hardware's network monitors. [networkMonitorIncidentCount]: #networkmonitorincidentcount #### [networkMonitorIncidentCount] A count of the status of all of a piece of hardware's network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -1873,7 +2058,8 @@ A count of the status of all of a piece of hardware's network monitoring inciden [networkStorageCount]: #networkstoragecount #### [networkStorageCount] A count of information regarding a piece of hardware's associated network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -1883,7 +2069,8 @@ A count of information regarding a piece of hardware's associated network storag [notesHistoryCount]: #noteshistorycount #### [notesHistoryCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1893,7 +2080,8 @@ A count of [nvRamComponentModelCount]: #nvramcomponentmodelcount #### [nvRamComponentModelCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1903,7 +2091,8 @@ A count of [powerComponentCount]: #powercomponentcount #### [powerComponentCount] A count of the power components for a hardware object. -Type: **unsigned long** +Type: **unsigned long** + @@ -1913,7 +2102,8 @@ A count of the power components for a hardware object. [powerSupplyCount]: #powersupplycount #### [powerSupplyCount] A count of information regarding a piece of hardware's power supply. -Type: **unsigned long** +Type: **unsigned long** + @@ -1923,7 +2113,8 @@ A count of information regarding a piece of hardware's power supply. [processorCount]: #processorcount #### [processorCount] A count of information regarding a piece of hardware's processors. -Type: **unsigned long** +Type: **unsigned long** + @@ -1933,7 +2124,8 @@ A count of information regarding a piece of hardware's processors. [raidControllerCount]: #raidcontrollercount #### [raidControllerCount] A count of the RAID controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1943,7 +2135,8 @@ A count of the RAID controllers contained within a piece of hardware. [recentEventCount]: #recenteventcount #### [recentEventCount] A count of recent events that impact this hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1953,7 +2146,8 @@ A count of recent events that impact this hardware. [remoteManagementAccountCount]: #remotemanagementaccountcount #### [remoteManagementAccountCount] A count of user credentials to issue commands and/or interact with the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -1963,7 +2157,8 @@ A count of user credentials to issue commands and/or interact with the server's [resourceConfigurationCount]: #resourceconfigurationcount #### [resourceConfigurationCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1973,7 +2168,8 @@ A count of [resourceGroupCount]: #resourcegroupcount #### [resourceGroupCount] A count of the resource groups in which this hardware is a member. -Type: **unsigned long** +Type: **unsigned long** + @@ -1983,7 +2179,8 @@ A count of the resource groups in which this hardware is a member. [resourceGroupMemberReferenceCount]: #resourcegroupmemberreferencecount #### [resourceGroupMemberReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1993,7 +2190,8 @@ A count of [resourceGroupRoleCount]: #resourcegrouprolecount #### [resourceGroupRoleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2003,7 +2201,8 @@ A count of [routerCount]: #routercount #### [routerCount] A count of a hardware's routers. -Type: **unsigned long** +Type: **unsigned long** + @@ -2013,7 +2212,8 @@ A count of a hardware's routers. [scaleAssetCount]: #scaleassetcount #### [scaleAssetCount] A count of collection of scale assets this hardware corresponds to. -Type: **unsigned long** +Type: **unsigned long** + @@ -2023,7 +2223,8 @@ A count of collection of scale assets this hardware corresponds to. [securityScanRequestCount]: #securityscanrequestcount #### [securityScanRequestCount] A count of information regarding a piece of hardware's vulnerability scan requests. -Type: **unsigned long** +Type: **unsigned long** + @@ -2033,7 +2234,8 @@ A count of information regarding a piece of hardware's vulnerability scan reques [softwareComponentCount]: #softwarecomponentcount #### [softwareComponentCount] A count of information regarding a piece of hardware's installed software. -Type: **unsigned long** +Type: **unsigned long** + @@ -2043,7 +2245,8 @@ A count of information regarding a piece of hardware's installed software. [sshKeyCount]: #sshkeycount #### [sshKeyCount] A count of sSH keys to be installed on the server during provisioning or an OS reload. -Type: **unsigned long** +Type: **unsigned long** + @@ -2053,7 +2256,8 @@ A count of sSH keys to be installed on the server during provisioning or an OS r [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2063,7 +2267,8 @@ A count of [storageNetworkComponentCount]: #storagenetworkcomponentcount #### [storageNetworkComponentCount] A count of a piece of hardware's private storage network components. [Deprecated] -Type: **unsigned long** +Type: **unsigned long** + @@ -2073,7 +2278,8 @@ A count of a piece of hardware's private storage network components. [Deprecated [tagReferenceCount]: #tagreferencecount #### [tagReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2083,7 +2289,8 @@ A count of [uplinkNetworkComponentCount]: #uplinknetworkcomponentcount #### [uplinkNetworkComponentCount] A count of information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **unsigned long** +Type: **unsigned long** + @@ -2093,7 +2300,8 @@ A count of information regarding the network component that is one level higher [userDataCount]: #userdatacount #### [userDataCount] A count of an array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **unsigned long** +Type: **unsigned long** + @@ -2103,7 +2311,8 @@ A count of an array containing a single string of custom user data for a hardwar [virtualChassisSiblingCount]: #virtualchassissiblingcount #### [virtualChassisSiblingCount] A count of information regarding the virtual chassis siblings for a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2113,7 +2322,8 @@ A count of information regarding the virtual chassis siblings for a piece of har [virtualLicenseCount]: #virtuallicensecount #### [virtualLicenseCount] A count of information regarding a piece of hardware's virtual software licenses. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Router_Frontend/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Router_Frontend/_index.md index 05919514b3..500b4a8157 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Router_Frontend/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Router_Frontend/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Router_Frontend data type contains general information relating to a single SoftLayer router item for hardware. @@ -45,7 +47,8 @@ The SoftLayer_Hardware_Router_Frontend data type contains general information re [accountId]: #accountid #### [accountId] A hardware's associated [SoftLayer_Account]({{}}) id. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ A hardware's associated [SoftLayer_Account]({{Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ When true, this flag specifies that a hardware is Bare Metal Server. Bare Metal [domain]: #domain #### [domain] A piece of hardware's local network domain name. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A piece of hardware's local network domain name. [fullyQualifiedDomainName]: #fullyqualifieddomainname #### [fullyQualifiedDomainName] A name reflecting the hostname and domain of the hardware. This is created from the combined values of the hardware's hostname and domain name automatically, and thus should not be edited directly. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ A name reflecting the hostname and domain of the hardware. This is created from [hardwareStatusId]: #hardwarestatusid #### [hardwareStatusId] A number reflecting the state of a hardware -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ A number reflecting the state of a hardware [hostname]: #hostname #### [hostname] A hardware's hostname -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ A hardware's hostname [id]: #id #### [id] A hardware's internal identification number -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A hardware's internal identification number [manufacturerSerialNumber]: #manufacturerserialnumber #### [manufacturerSerialNumber] A hardware's serial number that is supplied by the manufacturer. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A hardware's serial number that is supplied by the manufacturer. [notes]: #notes #### [notes] A small note about a piece of hardware to use at your discretion. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ A small note about a piece of hardware to use at your discretion. [postInstallScriptUri]: #postinstallscripturi #### [postInstallScriptUri] URI of the script to be downloaded and executed after installation is complete. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ URI of the script to be downloaded and executed after installation is complete. [provisionDate]: #provisiondate #### [provisionDate] -Type: **dateTime** +Type: **dateTime** + @@ -155,7 +168,8 @@ URI of the script to be downloaded and executed after installation is complete. [serialNumber]: #serialnumber #### [serialNumber] A hardware's serial number that is supplied by SoftLayer. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderResourceId]: #serviceproviderresourceid #### [serviceProviderResourceId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -191,7 +207,8 @@ A hardware's internal identification number at its service provider [account]: #account #### [account] The account associated with a piece of hardware. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -201,7 +218,8 @@ The account associated with a piece of hardware. [activeComponents]: #activecomponents #### [activeComponents] A piece of hardware's active physical components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -211,7 +229,8 @@ A piece of hardware's active physical components. [activeNetworkMonitorIncident]: #activenetworkmonitorincident #### [activeNetworkMonitorIncident] A piece of hardware's active network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -221,7 +240,8 @@ A piece of hardware's active network monitoring incidents. [allPowerComponents]: #allpowercomponents #### [allPowerComponents] -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -231,7 +251,8 @@ A piece of hardware's active network monitoring incidents. [allowedHost]: #allowedhost #### [allowedHost] The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. -Type: **SoftLayer_Network_Storage_Allowed_Host ** +Type: **SoftLayer_Network_Storage_Allowed_Host ** + @@ -241,7 +262,8 @@ The SoftLayer_Network_Storage_Allowed_Host information to connect this server to [allowedNetworkStorage]: #allowednetworkstorage #### [allowedNetworkStorage] The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -251,7 +273,8 @@ The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to [allowedNetworkStorageReplicas]: #allowednetworkstoragereplicas #### [allowedNetworkStorageReplicas] The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -261,7 +284,8 @@ The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware [antivirusSpywareSoftwareComponent]: #antivirusspywaresoftwarecomponent #### [antivirusSpywareSoftwareComponent] Information regarding an antivirus/spyware software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -271,7 +295,8 @@ Information regarding an antivirus/spyware software component object. [attributes]: #attributes #### [attributes] Information regarding a piece of hardware's specific attributes. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -281,7 +306,8 @@ Information regarding a piece of hardware's specific attributes. [averageDailyPublicBandwidthUsage]: #averagedailypublicbandwidthusage #### [averageDailyPublicBandwidthUsage] The average daily public bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -291,7 +317,8 @@ The average daily public bandwidth usage for the current billing cycle. [backendNetworkComponents]: #backendnetworkcomponents #### [backendNetworkComponents] A piece of hardware's back-end or private network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -301,7 +328,8 @@ A piece of hardware's back-end or private network components. [backendRouters]: #backendrouters #### [backendRouters] A hardware's backend or private router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -311,7 +339,8 @@ A hardware's backend or private router. [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] A hardware's allotted bandwidth (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -321,7 +350,8 @@ A hardware's allotted bandwidth (measured in GB). [bandwidthAllotmentDetail]: #bandwidthallotmentdetail #### [bandwidthAllotmentDetail] A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** + @@ -331,7 +361,8 @@ A hardware's allotted detail record. Allotment details link bandwidth allocation [benchmarkCertifications]: #benchmarkcertifications #### [benchmarkCertifications] Information regarding a piece of hardware's benchmark certifications. -Type: **SoftLayer_Hardware_Benchmark_Certification[] ** +Type: **SoftLayer_Hardware_Benchmark_Certification[] ** + @@ -341,7 +372,8 @@ Information regarding a piece of hardware's benchmark certifications. [billingItem]: #billingitem #### [billingItem] Information regarding the billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -351,7 +383,8 @@ Information regarding the billing item for a server. [billingItemFlag]: #billingitemflag #### [billingItemFlag] A flag indicating that a billing item exists. -Type: **boolean** +Type: **boolean** + @@ -361,7 +394,8 @@ A flag indicating that a billing item exists. [blockCancelBecauseDisconnectedFlag]: #blockcancelbecausedisconnectedflag #### [blockCancelBecauseDisconnectedFlag] Determines whether the hardware is ineligible for cancellation because it is disconnected. -Type: **boolean** +Type: **boolean** + @@ -371,7 +405,8 @@ Determines whether the hardware is ineligible for cancellation because it is dis [boundSubnets]: #boundsubnets #### [boundSubnets] Associated subnets for a router object. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -381,7 +416,8 @@ Associated subnets for a router object. [businessContinuanceInsuranceFlag]: #businesscontinuanceinsuranceflag #### [businessContinuanceInsuranceFlag] Status indicating whether or not a piece of hardware has business continuance insurance. -Type: **boolean** +Type: **boolean** + @@ -391,7 +427,8 @@ Status indicating whether or not a piece of hardware has business continuance in [childrenHardware]: #childrenhardware #### [childrenHardware] Child hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -401,7 +438,8 @@ Child hardware. [components]: #components #### [components] A piece of hardware's components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -411,7 +449,8 @@ A piece of hardware's components. [continuousDataProtectionSoftwareComponent]: #continuousdataprotectionsoftwarecomponent #### [continuousDataProtectionSoftwareComponent] A continuous data protection/server backup software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -421,7 +460,8 @@ A continuous data protection/server backup software component object. [currentBillableBandwidthUsage]: #currentbillablebandwidthusage #### [currentBillableBandwidthUsage] The current billable public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -431,7 +471,8 @@ The current billable public outbound bandwidth for this hardware for the current [datacenter]: #datacenter #### [datacenter] Information regarding the datacenter in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -441,7 +482,8 @@ Information regarding the datacenter in which a piece of hardware resides. [datacenterName]: #datacentername #### [datacenterName] The name of the datacenter in which a piece of hardware resides. -Type: **string** +Type: **string** + @@ -451,7 +493,8 @@ The name of the datacenter in which a piece of hardware resides. [daysInSparePool]: #daysinsparepool #### [daysInSparePool] Number of day(s) a server have been in spare pool. -Type: **integer** +Type: **integer** + @@ -461,7 +504,8 @@ Number of day(s) a server have been in spare pool. [downlinkHardware]: #downlinkhardware #### [downlinkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -471,7 +515,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkNetworkHardware]: #downlinknetworkhardware #### [downlinkNetworkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -481,7 +526,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkServers]: #downlinkservers #### [downlinkServers] Information regarding all servers attached to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -491,7 +537,8 @@ Information regarding all servers attached to a piece of network hardware. [downlinkVirtualGuests]: #downlinkvirtualguests #### [downlinkVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -501,7 +548,8 @@ Information regarding all virtual guests attached to a piece of network hardware [downstreamHardwareBindings]: #downstreamhardwarebindings #### [downstreamHardwareBindings] All hardware downstream from a network device. -Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** +Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** + @@ -511,7 +559,8 @@ All hardware downstream from a network device. [downstreamNetworkHardware]: #downstreamnetworkhardware #### [downstreamNetworkHardware] All network hardware downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -521,7 +570,8 @@ All network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidents]: #downstreamnetworkhardwarewithincidents #### [downstreamNetworkHardwareWithIncidents] All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -531,7 +581,8 @@ All network hardware with monitoring warnings or errors that are downstream from [downstreamServers]: #downstreamservers #### [downstreamServers] Information regarding all servers attached downstream to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -541,7 +592,8 @@ Information regarding all servers attached downstream to a piece of network hard [downstreamVirtualGuests]: #downstreamvirtualguests #### [downstreamVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -551,7 +603,8 @@ Information regarding all virtual guests attached to a piece of network hardware [driveControllers]: #drivecontrollers #### [driveControllers] The drive controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -561,7 +614,8 @@ The drive controllers contained within a piece of hardware. [evaultNetworkStorage]: #evaultnetworkstorage #### [evaultNetworkStorage] Information regarding a piece of hardware's associated EVault network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -571,7 +625,8 @@ Information regarding a piece of hardware's associated EVault network storage se [firewallServiceComponent]: #firewallservicecomponent #### [firewallServiceComponent] Information regarding a piece of hardware's firewall services. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -581,7 +636,8 @@ Information regarding a piece of hardware's firewall services. [fixedConfigurationPreset]: #fixedconfigurationpreset #### [fixedConfigurationPreset] Defines the fixed components in a fixed configuration bare metal server. -Type: **SoftLayer_Product_Package_Preset ** +Type: **SoftLayer_Product_Package_Preset ** + @@ -591,7 +647,8 @@ Defines the fixed components in a fixed configuration bare metal server. [frontendNetworkComponents]: #frontendnetworkcomponents #### [frontendNetworkComponents] A piece of hardware's front-end or public network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -601,7 +658,8 @@ A piece of hardware's front-end or public network components. [frontendRouters]: #frontendrouters #### [frontendRouters] A hardware's frontend or public router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -611,7 +669,8 @@ A hardware's frontend or public router. [futureBillingItem]: #futurebillingitem #### [futureBillingItem] Information regarding the future billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -621,7 +680,8 @@ Information regarding the future billing item for a server. [globalIdentifier]: #globalidentifier #### [globalIdentifier] A hardware's universally unique identifier. -Type: **string** +Type: **string** + @@ -631,7 +691,8 @@ A hardware's universally unique identifier. [hardDrives]: #harddrives #### [hardDrives] The hard drives contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -641,7 +702,8 @@ The hard drives contained within a piece of hardware. [hardwareChassis]: #hardwarechassis #### [hardwareChassis] The chassis that a piece of hardware is housed in. -Type: **SoftLayer_Hardware_Chassis ** +Type: **SoftLayer_Hardware_Chassis ** + @@ -651,7 +713,8 @@ The chassis that a piece of hardware is housed in. [hardwareFunction]: #hardwarefunction #### [hardwareFunction] A hardware's function. -Type: **SoftLayer_Hardware_Function ** +Type: **SoftLayer_Hardware_Function ** + @@ -661,7 +724,8 @@ A hardware's function. [hardwareFunctionDescription]: #hardwarefunctiondescription #### [hardwareFunctionDescription] A hardware's function. -Type: **string** +Type: **string** + @@ -671,7 +735,8 @@ A hardware's function. [hardwareStatus]: #hardwarestatus #### [hardwareStatus] A hardware's status. -Type: **SoftLayer_Hardware_Status ** +Type: **SoftLayer_Hardware_Status ** + @@ -681,7 +746,8 @@ A hardware's status. [hasTrustedPlatformModuleBillingItemFlag]: #hastrustedplatformmodulebillingitemflag #### [hasTrustedPlatformModuleBillingItemFlag] Determine in hardware object has TPM enabled. -Type: **boolean** +Type: **boolean** + @@ -691,7 +757,8 @@ Determine in hardware object has TPM enabled. [hostIpsSoftwareComponent]: #hostipssoftwarecomponent #### [hostIpsSoftwareComponent] Information regarding a host IPS software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -701,7 +768,8 @@ Information regarding a host IPS software component object. [hourlyBillingFlag]: #hourlybillingflag #### [hourlyBillingFlag] A server's hourly billing status. -Type: **boolean** +Type: **boolean** + @@ -711,7 +779,8 @@ A server's hourly billing status. [inboundBandwidthUsage]: #inboundbandwidthusage #### [inboundBandwidthUsage] The sum of all the inbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -721,7 +790,8 @@ The sum of all the inbound network traffic data for the last 30 days. [inboundPublicBandwidthUsage]: #inboundpublicbandwidthusage #### [inboundPublicBandwidthUsage] The total public inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -731,7 +801,8 @@ The total public inbound bandwidth for this hardware for the current billing cyc [isBillingTermChangeAvailableFlag]: #isbillingtermchangeavailableflag #### [isBillingTermChangeAvailableFlag] Whether or not this hardware object is eligible to change to term billing. -Type: **boolean** +Type: **boolean** + @@ -741,7 +812,8 @@ Whether or not this hardware object is eligible to change to term billing. [lastTransaction]: #lasttransaction #### [lastTransaction] Information regarding the last transaction a server performed. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -751,7 +823,8 @@ Information regarding the last transaction a server performed. [latestNetworkMonitorIncident]: #latestnetworkmonitorincident #### [latestNetworkMonitorIncident] A piece of hardware's latest network monitoring incident. -Type: **SoftLayer_Network_Monitor_Version1_Incident ** +Type: **SoftLayer_Network_Monitor_Version1_Incident ** + @@ -761,7 +834,8 @@ A piece of hardware's latest network monitoring incident. [localDiskStorageCapabilityFlag]: #localdiskstoragecapabilityflag #### [localDiskStorageCapabilityFlag] A flag indicating that a VLAN on the router can be assigned to a host that has local disk functionality. -Type: **boolean** +Type: **boolean** + @@ -771,7 +845,8 @@ A flag indicating that a VLAN on the router can be assigned to a host that has l [location]: #location #### [location] Where a piece of hardware is located within SoftLayer's location hierarchy. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -781,7 +856,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [locationPathString]: #locationpathstring #### [locationPathString] -Type: **string** +Type: **string** + @@ -791,7 +867,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [lockboxNetworkStorage]: #lockboxnetworkstorage #### [lockboxNetworkStorage] Information regarding a lockbox account associated with a server. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -801,7 +878,8 @@ Information regarding a lockbox account associated with a server. [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the hardware is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -811,7 +889,8 @@ A flag indicating that the hardware is a managed resource. [memory]: #memory #### [memory] Information regarding a piece of hardware's memory. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -821,7 +900,8 @@ Information regarding a piece of hardware's memory. [memoryCapacity]: #memorycapacity #### [memoryCapacity] The amount of memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -831,7 +911,8 @@ The amount of memory a piece of hardware has, measured in gigabytes. [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A piece of hardware's metric tracking object. -Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** +Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** + @@ -841,7 +922,8 @@ A piece of hardware's metric tracking object. [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -851,7 +933,8 @@ A piece of hardware's metric tracking object. [monitoringRobot]: #monitoringrobot #### [monitoringRobot] -Type: **SoftLayer_Monitoring_Robot ** +Type: **SoftLayer_Monitoring_Robot ** + @@ -861,7 +944,8 @@ A piece of hardware's metric tracking object. [monitoringServiceComponent]: #monitoringservicecomponent #### [monitoringServiceComponent] Information regarding a piece of hardware's network monitoring services. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** + @@ -871,7 +955,8 @@ Information regarding a piece of hardware's network monitoring services. [monitoringServiceEligibilityFlag]: #monitoringserviceeligibilityflag #### [monitoringServiceEligibilityFlag] -Type: **boolean** +Type: **boolean** + @@ -881,7 +966,8 @@ Information regarding a piece of hardware's network monitoring services. [motherboard]: #motherboard #### [motherboard] Information regarding a piece of hardware's motherboard. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -891,7 +977,8 @@ Information regarding a piece of hardware's motherboard. [networkCards]: #networkcards #### [networkCards] Information regarding a piece of hardware's network cards. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -901,7 +988,8 @@ Information regarding a piece of hardware's network cards. [networkComponents]: #networkcomponents #### [networkComponents] Returns a hardware's network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -911,7 +999,8 @@ Returns a hardware's network components. [networkGatewayMember]: #networkgatewaymember #### [networkGatewayMember] The gateway member if this device is part of a network gateway. -Type: **SoftLayer_Network_Gateway_Member ** +Type: **SoftLayer_Network_Gateway_Member ** + @@ -921,7 +1010,8 @@ The gateway member if this device is part of a network gateway. [networkGatewayMemberFlag]: #networkgatewaymemberflag #### [networkGatewayMemberFlag] Whether or not this device is part of a network gateway. -Type: **boolean** +Type: **boolean** + @@ -931,7 +1021,8 @@ Whether or not this device is part of a network gateway. [networkMonitorAttachedDownHardware]: #networkmonitorattacheddownhardware #### [networkMonitorAttachedDownHardware] All servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -941,7 +1032,8 @@ All servers with failed monitoring that are attached downstream to a piece of ha [networkMonitorAttachedDownVirtualGuests]: #networkmonitorattacheddownvirtualguests #### [networkMonitorAttachedDownVirtualGuests] Virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -951,7 +1043,8 @@ Virtual guests that are attached downstream to a hardware that have failed monit [networkMonitorIncidents]: #networkmonitorincidents #### [networkMonitorIncidents] The status of all of a piece of hardware's network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -961,7 +1054,8 @@ The status of all of a piece of hardware's network monitoring incidents. [networkMonitors]: #networkmonitors #### [networkMonitors] Information regarding a piece of hardware's network monitors. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** + @@ -971,7 +1065,8 @@ Information regarding a piece of hardware's network monitors. [networkStatus]: #networkstatus #### [networkStatus] The value of a hardware's network status attribute. -Type: **string** +Type: **string** + @@ -981,7 +1076,8 @@ The value of a hardware's network status attribute. [networkStatusAttribute]: #networkstatusattribute #### [networkStatusAttribute] The hardware's related network status attribute. -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -991,7 +1087,8 @@ The hardware's related network status attribute. [networkStorage]: #networkstorage #### [networkStorage] Information regarding a piece of hardware's associated network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -1001,7 +1098,8 @@ Information regarding a piece of hardware's associated network storage service a [nextBillingCycleBandwidthAllocation]: #nextbillingcyclebandwidthallocation #### [nextBillingCycleBandwidthAllocation] A hardware's allotted bandwidth for the next billing cycle (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -1011,7 +1109,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [notesHistory]: #noteshistory #### [notesHistory] -Type: **SoftLayer_Hardware_Note[] ** +Type: **SoftLayer_Hardware_Note[] ** + @@ -1021,7 +1120,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [nvRamCapacity]: #nvramcapacity #### [nvRamCapacity] The amount of non-volatile memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1031,7 +1131,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [nvRamComponentModels]: #nvramcomponentmodels #### [nvRamComponentModels] -Type: **SoftLayer_Hardware_Component_Model[] ** +Type: **SoftLayer_Hardware_Component_Model[] ** + @@ -1041,7 +1142,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [operatingSystem]: #operatingsystem #### [operatingSystem] Information regarding a piece of hardware's operating system. -Type: **SoftLayer_Software_Component_OperatingSystem ** +Type: **SoftLayer_Software_Component_OperatingSystem ** + @@ -1051,7 +1153,8 @@ Information regarding a piece of hardware's operating system. [operatingSystemReferenceCode]: #operatingsystemreferencecode #### [operatingSystemReferenceCode] A hardware's operating system software description. -Type: **string** +Type: **string** + @@ -1061,7 +1164,8 @@ A hardware's operating system software description. [outboundBandwidthUsage]: #outboundbandwidthusage #### [outboundBandwidthUsage] The sum of all the outbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -1071,7 +1175,8 @@ The sum of all the outbound network traffic data for the last 30 days. [outboundPublicBandwidthUsage]: #outboundpublicbandwidthusage #### [outboundPublicBandwidthUsage] The total public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -1081,7 +1186,8 @@ The total public outbound bandwidth for this hardware for the current billing cy [parentBay]: #parentbay #### [parentBay] Blade Bay -Type: **SoftLayer_Hardware_Blade ** +Type: **SoftLayer_Hardware_Blade ** + @@ -1091,7 +1197,8 @@ Blade Bay [parentHardware]: #parenthardware #### [parentHardware] Parent Hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1101,7 +1208,8 @@ Parent Hardware. [pointOfPresenceLocation]: #pointofpresencelocation #### [pointOfPresenceLocation] Information regarding the Point of Presence (PoP) location in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1111,7 +1219,8 @@ Information regarding the Point of Presence (PoP) location in which a piece of h [powerComponents]: #powercomponents #### [powerComponents] The power components for a hardware object. -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -1121,7 +1230,8 @@ The power components for a hardware object. [powerSupply]: #powersupply #### [powerSupply] Information regarding a piece of hardware's power supply. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1131,7 +1241,8 @@ Information regarding a piece of hardware's power supply. [primaryBackendNetworkComponent]: #primarybackendnetworkcomponent #### [primaryBackendNetworkComponent] Information regarding the hardware's primary back-end network component. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1141,7 +1252,8 @@ Information regarding the hardware's primary back-end network component. [primaryNetworkComponent]: #primarynetworkcomponent #### [primaryNetworkComponent] Information regarding the hardware's primary public network component. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1151,7 +1263,8 @@ Information regarding the hardware's primary public network component. [privateNetworkOnlyFlag]: #privatenetworkonlyflag #### [privateNetworkOnlyFlag] Whether the hardware only has access to the private network. -Type: **boolean** +Type: **boolean** + @@ -1161,7 +1274,8 @@ Whether the hardware only has access to the private network. [processorCoreAmount]: #processorcoreamount #### [processorCoreAmount] The total number of processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1171,7 +1285,8 @@ The total number of processor cores, summed from all processors that are attache [processorPhysicalCoreAmount]: #processorphysicalcoreamount #### [processorPhysicalCoreAmount] The total number of physical processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1181,7 +1296,8 @@ The total number of physical processor cores, summed from all processors that ar [processors]: #processors #### [processors] Information regarding a piece of hardware's processors. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1191,7 +1307,8 @@ Information regarding a piece of hardware's processors. [rack]: #rack #### [rack] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1201,7 +1318,8 @@ Information regarding a piece of hardware's processors. [raidControllers]: #raidcontrollers #### [raidControllers] The RAID controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1211,7 +1329,8 @@ The RAID controllers contained within a piece of hardware. [recentEvents]: #recentevents #### [recentEvents] Recent events that impact this hardware. -Type: **SoftLayer_Notification_Occurrence_Event[] ** +Type: **SoftLayer_Notification_Occurrence_Event[] ** + @@ -1221,7 +1340,8 @@ Recent events that impact this hardware. [remoteManagementAccounts]: #remotemanagementaccounts #### [remoteManagementAccounts] User credentials to issue commands and/or interact with the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** + @@ -1231,7 +1351,8 @@ User credentials to issue commands and/or interact with the server's remote mana [remoteManagementComponent]: #remotemanagementcomponent #### [remoteManagementComponent] A hardware's associated remote management component. This is normally IPMI. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1241,7 +1362,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceConfigurations]: #resourceconfigurations #### [resourceConfigurations] -Type: **SoftLayer_Hardware_Resource_Configuration[] ** +Type: **SoftLayer_Hardware_Resource_Configuration[] ** + @@ -1251,7 +1373,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroupMemberReferences]: #resourcegroupmemberreferences #### [resourceGroupMemberReferences] -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -1261,7 +1384,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroupRoles]: #resourcegrouproles #### [resourceGroupRoles] -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -1271,7 +1395,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroups]: #resourcegroups #### [resourceGroups] The resource groups in which this hardware is a member. -Type: **SoftLayer_Resource_Group[] ** +Type: **SoftLayer_Resource_Group[] ** + @@ -1281,7 +1406,8 @@ The resource groups in which this hardware is a member. [routers]: #routers #### [routers] A hardware's routers. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1291,7 +1417,8 @@ A hardware's routers. [sanStorageCapabilityFlag]: #sanstoragecapabilityflag #### [sanStorageCapabilityFlag] A flag indicating that a VLAN on the router can be assigned to a host that has SAN disk functionality. -Type: **boolean** +Type: **boolean** + @@ -1301,7 +1428,8 @@ A flag indicating that a VLAN on the router can be assigned to a host that has S [scaleAssets]: #scaleassets #### [scaleAssets] Collection of scale assets this hardware corresponds to. -Type: **SoftLayer_Scale_Asset[] ** +Type: **SoftLayer_Scale_Asset[] ** + @@ -1311,7 +1439,8 @@ Collection of scale assets this hardware corresponds to. [securityScanRequests]: #securityscanrequests #### [securityScanRequests] Information regarding a piece of hardware's vulnerability scan requests. -Type: **SoftLayer_Network_Security_Scanner_Request[] ** +Type: **SoftLayer_Network_Security_Scanner_Request[] ** + @@ -1321,7 +1450,8 @@ Information regarding a piece of hardware's vulnerability scan requests. [serverRoom]: #serverroom #### [serverRoom] Information regarding the server room in which the hardware is located. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1331,7 +1461,8 @@ Information regarding the server room in which the hardware is located. [serviceProvider]: #serviceprovider #### [serviceProvider] Information regarding the piece of hardware's service provider. -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -1341,7 +1472,8 @@ Information regarding the piece of hardware's service provider. [softwareComponents]: #softwarecomponents #### [softwareComponents] Information regarding a piece of hardware's installed software. -Type: **SoftLayer_Software_Component[] ** +Type: **SoftLayer_Software_Component[] ** + @@ -1351,7 +1483,8 @@ Information regarding a piece of hardware's installed software. [sparePoolBillingItem]: #sparepoolbillingitem #### [sparePoolBillingItem] Information regarding the billing item for a spare pool server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -1361,7 +1494,8 @@ Information regarding the billing item for a spare pool server. [sshKeys]: #sshkeys #### [sshKeys] SSH keys to be installed on the server during provisioning or an OS reload. -Type: **SoftLayer_Security_Ssh_Key[] ** +Type: **SoftLayer_Security_Ssh_Key[] ** + @@ -1371,17 +1505,20 @@ SSH keys to be installed on the server during provisioning or an OS reload. [storageGroups]: #storagegroups #### [storageGroups] -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + -
      +
      ----- [storageNetworkComponents]: #storagenetworkcomponents #### [storageNetworkComponents] A piece of hardware's private storage network components. [Deprecated] -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + +Deprecated
      @@ -1391,7 +1528,8 @@ A piece of hardware's private storage network components. [Deprecated] [tagReferences]: #tagreferences #### [tagReferences] -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** +
      @@ -1401,7 +1539,8 @@ A piece of hardware's private storage network components. [Deprecated] [topLevelLocation]: #toplevellocation #### [topLevelLocation] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1411,7 +1550,8 @@ A piece of hardware's private storage network components. [Deprecated] [upgradeRequest]: #upgraderequest #### [upgradeRequest] An account's associated upgrade request object, if any. -Type: **SoftLayer_Product_Upgrade_Request ** +Type: **SoftLayer_Product_Upgrade_Request ** + @@ -1421,7 +1561,8 @@ An account's associated upgrade request object, if any. [uplinkHardware]: #uplinkhardware #### [uplinkHardware] The network device connected to a piece of hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1431,7 +1572,8 @@ The network device connected to a piece of hardware. [uplinkNetworkComponents]: #uplinknetworkcomponents #### [uplinkNetworkComponents] Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -1441,7 +1583,8 @@ Information regarding the network component that is one level higher than a piec [userData]: #userdata #### [userData] An array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -1451,7 +1594,8 @@ An array containing a single string of custom user data for a hardware order. Ma [virtualChassis]: #virtualchassis #### [virtualChassis] Information regarding the virtual chassis for a piece of hardware. -Type: **SoftLayer_Hardware_Group ** +Type: **SoftLayer_Hardware_Group ** + @@ -1461,7 +1605,8 @@ Information regarding the virtual chassis for a piece of hardware. [virtualChassisSiblings]: #virtualchassissiblings #### [virtualChassisSiblings] Information regarding the virtual chassis siblings for a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1471,7 +1616,8 @@ Information regarding the virtual chassis siblings for a piece of hardware. [virtualHost]: #virtualhost #### [virtualHost] A piece of hardware's virtual host record. -Type: **SoftLayer_Virtual_Host ** +Type: **SoftLayer_Virtual_Host ** + @@ -1481,7 +1627,8 @@ A piece of hardware's virtual host record. [virtualLicenses]: #virtuallicenses #### [virtualLicenses] Information regarding a piece of hardware's virtual software licenses. -Type: **SoftLayer_Software_VirtualLicense[] ** +Type: **SoftLayer_Software_VirtualLicense[] ** + @@ -1491,7 +1638,8 @@ Information regarding a piece of hardware's virtual software licenses. [virtualRack]: #virtualrack #### [virtualRack] Information regarding the bandwidth allotment to which a piece of hardware belongs. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** + @@ -1501,7 +1649,8 @@ Information regarding the bandwidth allotment to which a piece of hardware belon [virtualRackId]: #virtualrackid #### [virtualRackId] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **integer** +Type: **integer** + @@ -1511,7 +1660,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualRackName]: #virtualrackname #### [virtualRackName] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **string** +Type: **string** + @@ -1521,7 +1671,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualizationPlatform]: #virtualizationplatform #### [virtualizationPlatform] A piece of hardware's virtualization platform software. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -1533,7 +1684,8 @@ A piece of hardware's virtualization platform software. [activeComponentCount]: #activecomponentcount #### [activeComponentCount] A count of a piece of hardware's active physical components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1543,7 +1695,8 @@ A count of a piece of hardware's active physical components. [activeNetworkMonitorIncidentCount]: #activenetworkmonitorincidentcount #### [activeNetworkMonitorIncidentCount] A count of a piece of hardware's active network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -1553,7 +1706,8 @@ A count of a piece of hardware's active network monitoring incidents. [allPowerComponentCount]: #allpowercomponentcount #### [allPowerComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1563,7 +1717,8 @@ A count of [allowedNetworkStorageCount]: #allowednetworkstoragecount #### [allowedNetworkStorageCount] A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1573,7 +1728,8 @@ A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware ha [allowedNetworkStorageReplicaCount]: #allowednetworkstoragereplicacount #### [allowedNetworkStorageReplicaCount] A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1583,7 +1739,8 @@ A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLay [attributeCount]: #attributecount #### [attributeCount] A count of information regarding a piece of hardware's specific attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -1593,7 +1750,8 @@ A count of information regarding a piece of hardware's specific attributes. [backendNetworkComponentCount]: #backendnetworkcomponentcount #### [backendNetworkComponentCount] A count of a piece of hardware's back-end or private network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1603,7 +1761,8 @@ A count of a piece of hardware's back-end or private network components. [backendRouterCount]: #backendroutercount #### [backendRouterCount] A count of a hardware's backend or private router. -Type: **unsigned long** +Type: **unsigned long** + @@ -1613,7 +1772,8 @@ A count of a hardware's backend or private router. [benchmarkCertificationCount]: #benchmarkcertificationcount #### [benchmarkCertificationCount] A count of information regarding a piece of hardware's benchmark certifications. -Type: **unsigned long** +Type: **unsigned long** + @@ -1623,7 +1783,8 @@ A count of information regarding a piece of hardware's benchmark certifications. [boundSubnetCount]: #boundsubnetcount #### [boundSubnetCount] A count of associated subnets for a router object. -Type: **unsigned long** +Type: **unsigned long** + @@ -1633,7 +1794,8 @@ A count of associated subnets for a router object. [childrenHardwareCount]: #childrenhardwarecount #### [childrenHardwareCount] A count of child hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1643,7 +1805,8 @@ A count of child hardware. [componentCount]: #componentcount #### [componentCount] A count of a piece of hardware's components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1653,7 +1816,8 @@ A count of a piece of hardware's components. [downlinkHardwareCount]: #downlinkhardwarecount #### [downlinkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1663,7 +1827,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkNetworkHardwareCount]: #downlinknetworkhardwarecount #### [downlinkNetworkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1673,7 +1838,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkServerCount]: #downlinkservercount #### [downlinkServerCount] A count of information regarding all servers attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1683,7 +1849,8 @@ A count of information regarding all servers attached to a piece of network hard [downlinkVirtualGuestCount]: #downlinkvirtualguestcount #### [downlinkVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1693,7 +1860,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [downstreamHardwareBindingCount]: #downstreamhardwarebindingcount #### [downstreamHardwareBindingCount] A count of all hardware downstream from a network device. -Type: **unsigned long** +Type: **unsigned long** + @@ -1703,7 +1871,8 @@ A count of all hardware downstream from a network device. [downstreamNetworkHardwareCount]: #downstreamnetworkhardwarecount #### [downstreamNetworkHardwareCount] A count of all network hardware downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1713,7 +1882,8 @@ A count of all network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidentCount]: #downstreamnetworkhardwarewithincidentcount #### [downstreamNetworkHardwareWithIncidentCount] A count of all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1723,7 +1893,8 @@ A count of all network hardware with monitoring warnings or errors that are down [downstreamServerCount]: #downstreamservercount #### [downstreamServerCount] A count of information regarding all servers attached downstream to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1733,7 +1904,8 @@ A count of information regarding all servers attached downstream to a piece of n [downstreamVirtualGuestCount]: #downstreamvirtualguestcount #### [downstreamVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1743,7 +1915,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [driveControllerCount]: #drivecontrollercount #### [driveControllerCount] A count of the drive controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1753,7 +1926,8 @@ A count of the drive controllers contained within a piece of hardware. [evaultNetworkStorageCount]: #evaultnetworkstoragecount #### [evaultNetworkStorageCount] A count of information regarding a piece of hardware's associated EVault network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -1763,7 +1937,8 @@ A count of information regarding a piece of hardware's associated EVault network [frontendNetworkComponentCount]: #frontendnetworkcomponentcount #### [frontendNetworkComponentCount] A count of a piece of hardware's front-end or public network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1773,7 +1948,8 @@ A count of a piece of hardware's front-end or public network components. [frontendRouterCount]: #frontendroutercount #### [frontendRouterCount] A count of a hardware's frontend or public router. -Type: **unsigned long** +Type: **unsigned long** + @@ -1783,7 +1959,8 @@ A count of a hardware's frontend or public router. [hardDriveCount]: #harddrivecount #### [hardDriveCount] A count of the hard drives contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1793,7 +1970,8 @@ A count of the hard drives contained within a piece of hardware. [memoryCount]: #memorycount #### [memoryCount] A count of information regarding a piece of hardware's memory. -Type: **unsigned long** +Type: **unsigned long** + @@ -1803,7 +1981,8 @@ A count of information regarding a piece of hardware's memory. [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1813,7 +1992,8 @@ A count of [networkCardCount]: #networkcardcount #### [networkCardCount] A count of information regarding a piece of hardware's network cards. -Type: **unsigned long** +Type: **unsigned long** + @@ -1823,7 +2003,8 @@ A count of information regarding a piece of hardware's network cards. [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of returns a hardware's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1833,7 +2014,8 @@ A count of returns a hardware's network components. [networkMonitorAttachedDownHardwareCount]: #networkmonitorattacheddownhardwarecount #### [networkMonitorAttachedDownHardwareCount] A count of all servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1843,7 +2025,8 @@ A count of all servers with failed monitoring that are attached downstream to a [networkMonitorAttachedDownVirtualGuestCount]: #networkmonitorattacheddownvirtualguestcount #### [networkMonitorAttachedDownVirtualGuestCount] A count of virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **unsigned long** +Type: **unsigned long** + @@ -1853,7 +2036,8 @@ A count of virtual guests that are attached downstream to a hardware that have f [networkMonitorCount]: #networkmonitorcount #### [networkMonitorCount] A count of information regarding a piece of hardware's network monitors. -Type: **unsigned long** +Type: **unsigned long** + @@ -1863,7 +2047,8 @@ A count of information regarding a piece of hardware's network monitors. [networkMonitorIncidentCount]: #networkmonitorincidentcount #### [networkMonitorIncidentCount] A count of the status of all of a piece of hardware's network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -1873,7 +2058,8 @@ A count of the status of all of a piece of hardware's network monitoring inciden [networkStorageCount]: #networkstoragecount #### [networkStorageCount] A count of information regarding a piece of hardware's associated network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -1883,7 +2069,8 @@ A count of information regarding a piece of hardware's associated network storag [notesHistoryCount]: #noteshistorycount #### [notesHistoryCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1893,7 +2080,8 @@ A count of [nvRamComponentModelCount]: #nvramcomponentmodelcount #### [nvRamComponentModelCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1903,7 +2091,8 @@ A count of [powerComponentCount]: #powercomponentcount #### [powerComponentCount] A count of the power components for a hardware object. -Type: **unsigned long** +Type: **unsigned long** + @@ -1913,7 +2102,8 @@ A count of the power components for a hardware object. [powerSupplyCount]: #powersupplycount #### [powerSupplyCount] A count of information regarding a piece of hardware's power supply. -Type: **unsigned long** +Type: **unsigned long** + @@ -1923,7 +2113,8 @@ A count of information regarding a piece of hardware's power supply. [processorCount]: #processorcount #### [processorCount] A count of information regarding a piece of hardware's processors. -Type: **unsigned long** +Type: **unsigned long** + @@ -1933,7 +2124,8 @@ A count of information regarding a piece of hardware's processors. [raidControllerCount]: #raidcontrollercount #### [raidControllerCount] A count of the RAID controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1943,7 +2135,8 @@ A count of the RAID controllers contained within a piece of hardware. [recentEventCount]: #recenteventcount #### [recentEventCount] A count of recent events that impact this hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1953,7 +2146,8 @@ A count of recent events that impact this hardware. [remoteManagementAccountCount]: #remotemanagementaccountcount #### [remoteManagementAccountCount] A count of user credentials to issue commands and/or interact with the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -1963,7 +2157,8 @@ A count of user credentials to issue commands and/or interact with the server's [resourceConfigurationCount]: #resourceconfigurationcount #### [resourceConfigurationCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1973,7 +2168,8 @@ A count of [resourceGroupCount]: #resourcegroupcount #### [resourceGroupCount] A count of the resource groups in which this hardware is a member. -Type: **unsigned long** +Type: **unsigned long** + @@ -1983,7 +2179,8 @@ A count of the resource groups in which this hardware is a member. [resourceGroupMemberReferenceCount]: #resourcegroupmemberreferencecount #### [resourceGroupMemberReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1993,7 +2190,8 @@ A count of [resourceGroupRoleCount]: #resourcegrouprolecount #### [resourceGroupRoleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2003,7 +2201,8 @@ A count of [routerCount]: #routercount #### [routerCount] A count of a hardware's routers. -Type: **unsigned long** +Type: **unsigned long** + @@ -2013,7 +2212,8 @@ A count of a hardware's routers. [scaleAssetCount]: #scaleassetcount #### [scaleAssetCount] A count of collection of scale assets this hardware corresponds to. -Type: **unsigned long** +Type: **unsigned long** + @@ -2023,7 +2223,8 @@ A count of collection of scale assets this hardware corresponds to. [securityScanRequestCount]: #securityscanrequestcount #### [securityScanRequestCount] A count of information regarding a piece of hardware's vulnerability scan requests. -Type: **unsigned long** +Type: **unsigned long** + @@ -2033,7 +2234,8 @@ A count of information regarding a piece of hardware's vulnerability scan reques [softwareComponentCount]: #softwarecomponentcount #### [softwareComponentCount] A count of information regarding a piece of hardware's installed software. -Type: **unsigned long** +Type: **unsigned long** + @@ -2043,7 +2245,8 @@ A count of information regarding a piece of hardware's installed software. [sshKeyCount]: #sshkeycount #### [sshKeyCount] A count of sSH keys to be installed on the server during provisioning or an OS reload. -Type: **unsigned long** +Type: **unsigned long** + @@ -2053,7 +2256,8 @@ A count of sSH keys to be installed on the server during provisioning or an OS r [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2063,7 +2267,8 @@ A count of [storageNetworkComponentCount]: #storagenetworkcomponentcount #### [storageNetworkComponentCount] A count of a piece of hardware's private storage network components. [Deprecated] -Type: **unsigned long** +Type: **unsigned long** + @@ -2073,7 +2278,8 @@ A count of a piece of hardware's private storage network components. [Deprecated [tagReferenceCount]: #tagreferencecount #### [tagReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2083,7 +2289,8 @@ A count of [uplinkNetworkComponentCount]: #uplinknetworkcomponentcount #### [uplinkNetworkComponentCount] A count of information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **unsigned long** +Type: **unsigned long** + @@ -2093,7 +2300,8 @@ A count of information regarding the network component that is one level higher [userDataCount]: #userdatacount #### [userDataCount] A count of an array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **unsigned long** +Type: **unsigned long** + @@ -2103,7 +2311,8 @@ A count of an array containing a single string of custom user data for a hardwar [virtualChassisSiblingCount]: #virtualchassissiblingcount #### [virtualChassisSiblingCount] A count of information regarding the virtual chassis siblings for a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2113,7 +2322,8 @@ A count of information regarding the virtual chassis siblings for a piece of har [virtualLicenseCount]: #virtuallicensecount #### [virtualLicenseCount] A count of information regarding a piece of hardware's virtual software licenses. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_SecurityModule/_index.md b/content/reference/datatypes/SoftLayer_Hardware_SecurityModule/_index.md index 38c7dce496..1e8602d36c 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_SecurityModule/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_SecurityModule/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] A hardware's associated [SoftLayer_Account]({{}}) id. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ A hardware's associated [SoftLayer_Account]({{Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ When true, this flag specifies that a hardware is Bare Metal Server. Bare Metal [domain]: #domain #### [domain] A piece of hardware's local network domain name. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A piece of hardware's local network domain name. [fullyQualifiedDomainName]: #fullyqualifieddomainname #### [fullyQualifiedDomainName] A name reflecting the hostname and domain of the hardware. This is created from the combined values of the hardware's hostname and domain name automatically, and thus should not be edited directly. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ A name reflecting the hostname and domain of the hardware. This is created from [hardwareStatusId]: #hardwarestatusid #### [hardwareStatusId] A number reflecting the state of a hardware -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ A number reflecting the state of a hardware [hostname]: #hostname #### [hostname] A hardware's hostname -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ A hardware's hostname [id]: #id #### [id] A hardware's internal identification number -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A hardware's internal identification number [manufacturerSerialNumber]: #manufacturerserialnumber #### [manufacturerSerialNumber] A hardware's serial number that is supplied by the manufacturer. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A hardware's serial number that is supplied by the manufacturer. [notes]: #notes #### [notes] A small note about a piece of hardware to use at your discretion. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ A small note about a piece of hardware to use at your discretion. [postInstallScriptUri]: #postinstallscripturi #### [postInstallScriptUri] URI of the script to be downloaded and executed after installation is complete. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ URI of the script to be downloaded and executed after installation is complete. [provisionDate]: #provisiondate #### [provisionDate] -Type: **dateTime** +Type: **dateTime** + @@ -155,7 +168,8 @@ URI of the script to be downloaded and executed after installation is complete. [serialNumber]: #serialnumber #### [serialNumber] A hardware's serial number that is supplied by SoftLayer. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderResourceId]: #serviceproviderresourceid #### [serviceProviderResourceId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -191,7 +207,8 @@ A hardware's internal identification number at its service provider [account]: #account #### [account] The account associated with a piece of hardware. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -201,7 +218,8 @@ The account associated with a piece of hardware. [activeComponents]: #activecomponents #### [activeComponents] A piece of hardware's active physical components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -211,7 +229,8 @@ A piece of hardware's active physical components. [activeNetworkFirewallBillingItem]: #activenetworkfirewallbillingitem #### [activeNetworkFirewallBillingItem] The billing item for a server's attached network firewall. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -221,7 +240,8 @@ The billing item for a server's attached network firewall. [activeNetworkMonitorIncident]: #activenetworkmonitorincident #### [activeNetworkMonitorIncident] A piece of hardware's active network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -231,7 +251,8 @@ A piece of hardware's active network monitoring incidents. [activeTickets]: #activetickets #### [activeTickets] -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -241,7 +262,8 @@ A piece of hardware's active network monitoring incidents. [activeTransaction]: #activetransaction #### [activeTransaction] Transaction currently running for server. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -251,7 +273,8 @@ Transaction currently running for server. [activeTransactions]: #activetransactions #### [activeTransactions] Any active transaction(s) that are currently running for the server (example: os reload). -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + @@ -261,7 +284,8 @@ Any active transaction(s) that are currently running for the server (example: os [allPowerComponents]: #allpowercomponents #### [allPowerComponents] -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -271,7 +295,8 @@ Any active transaction(s) that are currently running for the server (example: os [allowedHost]: #allowedhost #### [allowedHost] The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. -Type: **SoftLayer_Network_Storage_Allowed_Host ** +Type: **SoftLayer_Network_Storage_Allowed_Host ** + @@ -281,7 +306,8 @@ The SoftLayer_Network_Storage_Allowed_Host information to connect this server to [allowedNetworkStorage]: #allowednetworkstorage #### [allowedNetworkStorage] The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -291,7 +317,8 @@ The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to [allowedNetworkStorageReplicas]: #allowednetworkstoragereplicas #### [allowedNetworkStorageReplicas] The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -301,7 +328,8 @@ The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware [antivirusSpywareSoftwareComponent]: #antivirusspywaresoftwarecomponent #### [antivirusSpywareSoftwareComponent] Information regarding an antivirus/spyware software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -311,7 +339,8 @@ Information regarding an antivirus/spyware software component object. [attributes]: #attributes #### [attributes] Information regarding a piece of hardware's specific attributes. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -321,7 +350,8 @@ Information regarding a piece of hardware's specific attributes. [availableMonitoring]: #availablemonitoring #### [availableMonitoring] An object that stores the maximum level for the monitoring query types and response types. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum[] ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum[] ** + @@ -331,7 +361,8 @@ An object that stores the maximum level for the monitoring query types and respo [averageDailyBandwidthUsage]: #averagedailybandwidthusage #### [averageDailyBandwidthUsage] The average daily total bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -341,7 +372,8 @@ The average daily total bandwidth usage for the current billing cycle. [averageDailyPrivateBandwidthUsage]: #averagedailyprivatebandwidthusage #### [averageDailyPrivateBandwidthUsage] The average daily private bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -351,7 +383,8 @@ The average daily private bandwidth usage for the current billing cycle. [averageDailyPublicBandwidthUsage]: #averagedailypublicbandwidthusage #### [averageDailyPublicBandwidthUsage] The average daily public bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -361,7 +394,8 @@ The average daily public bandwidth usage for the current billing cycle. [backendNetworkComponents]: #backendnetworkcomponents #### [backendNetworkComponents] A piece of hardware's back-end or private network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -371,7 +405,8 @@ A piece of hardware's back-end or private network components. [backendRouters]: #backendrouters #### [backendRouters] A hardware's backend or private router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -381,7 +416,8 @@ A hardware's backend or private router. [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] A hardware's allotted bandwidth (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -391,7 +427,8 @@ A hardware's allotted bandwidth (measured in GB). [bandwidthAllotmentDetail]: #bandwidthallotmentdetail #### [bandwidthAllotmentDetail] A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** + @@ -401,7 +438,8 @@ A hardware's allotted detail record. Allotment details link bandwidth allocation [benchmarkCertifications]: #benchmarkcertifications #### [benchmarkCertifications] Information regarding a piece of hardware's benchmark certifications. -Type: **SoftLayer_Hardware_Benchmark_Certification[] ** +Type: **SoftLayer_Hardware_Benchmark_Certification[] ** + @@ -411,7 +449,8 @@ Information regarding a piece of hardware's benchmark certifications. [billingCycleBandwidthUsage]: #billingcyclebandwidthusage #### [billingCycleBandwidthUsage] The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -421,7 +460,8 @@ The raw bandwidth usage data for the current billing cycle. One object will be r [billingCyclePrivateBandwidthUsage]: #billingcycleprivatebandwidthusage #### [billingCyclePrivateBandwidthUsage] The raw private bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage ** +Type: **SoftLayer_Network_Bandwidth_Usage ** + @@ -431,7 +471,8 @@ The raw private bandwidth usage data for the current billing cycle. [billingCyclePublicBandwidthUsage]: #billingcyclepublicbandwidthusage #### [billingCyclePublicBandwidthUsage] The raw public bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage ** +Type: **SoftLayer_Network_Bandwidth_Usage ** + @@ -441,7 +482,8 @@ The raw public bandwidth usage data for the current billing cycle. [billingItem]: #billingitem #### [billingItem] Information regarding the billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -451,7 +493,8 @@ Information regarding the billing item for a server. [billingItemFlag]: #billingitemflag #### [billingItemFlag] A flag indicating that a billing item exists. -Type: **boolean** +Type: **boolean** + @@ -461,7 +504,8 @@ A flag indicating that a billing item exists. [biosPasswordNullFlag]: #biospasswordnullflag #### [biosPasswordNullFlag] Determine if BIOS password should be left as null. -Type: **boolean** +Type: **boolean** + @@ -471,7 +515,8 @@ Determine if BIOS password should be left as null. [blockCancelBecauseDisconnectedFlag]: #blockcancelbecausedisconnectedflag #### [blockCancelBecauseDisconnectedFlag] Determines whether the hardware is ineligible for cancellation because it is disconnected. -Type: **boolean** +Type: **boolean** + @@ -481,7 +526,8 @@ Determines whether the hardware is ineligible for cancellation because it is dis [businessContinuanceInsuranceFlag]: #businesscontinuanceinsuranceflag #### [businessContinuanceInsuranceFlag] Status indicating whether or not a piece of hardware has business continuance insurance. -Type: **boolean** +Type: **boolean** + @@ -491,7 +537,8 @@ Status indicating whether or not a piece of hardware has business continuance in [captureEnabledFlag]: #captureenabledflag #### [captureEnabledFlag] Determine if the server is able to be image captured. If unable to image capture a reason will be provided. -Type: **SoftLayer_Container_Hardware_CaptureEnabled ** +Type: **SoftLayer_Container_Hardware_CaptureEnabled ** + @@ -501,7 +548,8 @@ Determine if the server is able to be image captured. If unable to image capture [childrenHardware]: #childrenhardware #### [childrenHardware] Child hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -511,7 +559,8 @@ Child hardware. [components]: #components #### [components] A piece of hardware's components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -521,7 +570,8 @@ A piece of hardware's components. [containsSolidStateDrivesFlag]: #containssolidstatedrivesflag #### [containsSolidStateDrivesFlag] -Type: **boolean** +Type: **boolean** + @@ -531,7 +581,8 @@ A piece of hardware's components. [continuousDataProtectionSoftwareComponent]: #continuousdataprotectionsoftwarecomponent #### [continuousDataProtectionSoftwareComponent] A continuous data protection/server backup software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -541,7 +592,8 @@ A continuous data protection/server backup software component object. [controlPanel]: #controlpanel #### [controlPanel] A server's control panel. -Type: **SoftLayer_Software_Component_ControlPanel ** +Type: **SoftLayer_Software_Component_ControlPanel ** + @@ -551,7 +603,8 @@ A server's control panel. [cost]: #cost #### [cost] The total cost of a server, measured in US Dollars ($USD). -Type: **float** +Type: **float** + @@ -561,7 +614,8 @@ The total cost of a server, measured in US Dollars ($USD). [currentBandwidthSummary]: #currentbandwidthsummary #### [currentBandwidthSummary] An object that provides commonly used bandwidth summary components for the current billing cycle. -Type: **SoftLayer_Metric_Tracking_Object_Bandwidth_Summary ** +Type: **SoftLayer_Metric_Tracking_Object_Bandwidth_Summary ** + @@ -571,7 +625,8 @@ An object that provides commonly used bandwidth summary components for the curre [currentBillableBandwidthUsage]: #currentbillablebandwidthusage #### [currentBillableBandwidthUsage] The current billable public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -581,7 +636,8 @@ The current billable public outbound bandwidth for this hardware for the current [customerInstalledOperatingSystemFlag]: #customerinstalledoperatingsystemflag #### [customerInstalledOperatingSystemFlag] Indicates if a server has a Customer Installed OS -Type: **boolean** +Type: **boolean** + @@ -591,7 +647,8 @@ Indicates if a server has a Customer Installed OS [customerOwnedFlag]: #customerownedflag #### [customerOwnedFlag] Indicates if a server is a customer owned device. -Type: **boolean** +Type: **boolean** + @@ -601,7 +658,8 @@ Indicates if a server is a customer owned device. [datacenter]: #datacenter #### [datacenter] Information regarding the datacenter in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -611,7 +669,8 @@ Information regarding the datacenter in which a piece of hardware resides. [datacenterName]: #datacentername #### [datacenterName] The name of the datacenter in which a piece of hardware resides. -Type: **string** +Type: **string** + @@ -621,7 +680,8 @@ The name of the datacenter in which a piece of hardware resides. [daysInSparePool]: #daysinsparepool #### [daysInSparePool] Number of day(s) a server have been in spare pool. -Type: **integer** +Type: **integer** + @@ -631,7 +691,8 @@ Number of day(s) a server have been in spare pool. [downlinkHardware]: #downlinkhardware #### [downlinkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -641,7 +702,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkNetworkHardware]: #downlinknetworkhardware #### [downlinkNetworkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -651,7 +713,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkServers]: #downlinkservers #### [downlinkServers] Information regarding all servers attached to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -661,7 +724,8 @@ Information regarding all servers attached to a piece of network hardware. [downlinkVirtualGuests]: #downlinkvirtualguests #### [downlinkVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -671,7 +735,8 @@ Information regarding all virtual guests attached to a piece of network hardware [downstreamHardwareBindings]: #downstreamhardwarebindings #### [downstreamHardwareBindings] All hardware downstream from a network device. -Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** +Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** + @@ -681,7 +746,8 @@ All hardware downstream from a network device. [downstreamNetworkHardware]: #downstreamnetworkhardware #### [downstreamNetworkHardware] All network hardware downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -691,7 +757,8 @@ All network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidents]: #downstreamnetworkhardwarewithincidents #### [downstreamNetworkHardwareWithIncidents] All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -701,7 +768,8 @@ All network hardware with monitoring warnings or errors that are downstream from [downstreamServers]: #downstreamservers #### [downstreamServers] Information regarding all servers attached downstream to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -711,7 +779,8 @@ Information regarding all servers attached downstream to a piece of network hard [downstreamVirtualGuests]: #downstreamvirtualguests #### [downstreamVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -721,7 +790,8 @@ Information regarding all virtual guests attached to a piece of network hardware [driveControllers]: #drivecontrollers #### [driveControllers] The drive controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -731,7 +801,8 @@ The drive controllers contained within a piece of hardware. [evaultNetworkStorage]: #evaultnetworkstorage #### [evaultNetworkStorage] Information regarding a piece of hardware's associated EVault network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -741,7 +812,8 @@ Information regarding a piece of hardware's associated EVault network storage se [firewallServiceComponent]: #firewallservicecomponent #### [firewallServiceComponent] Information regarding a piece of hardware's firewall services. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -751,7 +823,8 @@ Information regarding a piece of hardware's firewall services. [fixedConfigurationPreset]: #fixedconfigurationpreset #### [fixedConfigurationPreset] Defines the fixed components in a fixed configuration bare metal server. -Type: **SoftLayer_Product_Package_Preset ** +Type: **SoftLayer_Product_Package_Preset ** + @@ -761,7 +834,8 @@ Defines the fixed components in a fixed configuration bare metal server. [frontendNetworkComponents]: #frontendnetworkcomponents #### [frontendNetworkComponents] A piece of hardware's front-end or public network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -771,7 +845,8 @@ A piece of hardware's front-end or public network components. [frontendRouters]: #frontendrouters #### [frontendRouters] A hardware's frontend or public router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -781,7 +856,8 @@ A hardware's frontend or public router. [futureBillingItem]: #futurebillingitem #### [futureBillingItem] Information regarding the future billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -791,7 +867,8 @@ Information regarding the future billing item for a server. [globalIdentifier]: #globalidentifier #### [globalIdentifier] A hardware's universally unique identifier. -Type: **string** +Type: **string** + @@ -801,7 +878,8 @@ A hardware's universally unique identifier. [hardDrives]: #harddrives #### [hardDrives] The hard drives contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -811,7 +889,8 @@ The hard drives contained within a piece of hardware. [hardwareChassis]: #hardwarechassis #### [hardwareChassis] The chassis that a piece of hardware is housed in. -Type: **SoftLayer_Hardware_Chassis ** +Type: **SoftLayer_Hardware_Chassis ** + @@ -821,7 +900,8 @@ The chassis that a piece of hardware is housed in. [hardwareFunction]: #hardwarefunction #### [hardwareFunction] A hardware's function. -Type: **SoftLayer_Hardware_Function ** +Type: **SoftLayer_Hardware_Function ** + @@ -831,7 +911,8 @@ A hardware's function. [hardwareFunctionDescription]: #hardwarefunctiondescription #### [hardwareFunctionDescription] A hardware's function. -Type: **string** +Type: **string** + @@ -841,7 +922,8 @@ A hardware's function. [hardwareStatus]: #hardwarestatus #### [hardwareStatus] A hardware's status. -Type: **SoftLayer_Hardware_Status ** +Type: **SoftLayer_Hardware_Status ** + @@ -851,7 +933,8 @@ A hardware's status. [hasSingleRootVirtualizationBillingItemFlag]: #hassinglerootvirtualizationbillingitemflag #### [hasSingleRootVirtualizationBillingItemFlag] Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item. -Type: **boolean** +Type: **boolean** + @@ -861,7 +944,8 @@ Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item. [hasTrustedPlatformModuleBillingItemFlag]: #hastrustedplatformmodulebillingitemflag #### [hasTrustedPlatformModuleBillingItemFlag] Determine in hardware object has TPM enabled. -Type: **boolean** +Type: **boolean** + @@ -871,7 +955,8 @@ Determine in hardware object has TPM enabled. [hostIpsSoftwareComponent]: #hostipssoftwarecomponent #### [hostIpsSoftwareComponent] Information regarding a host IPS software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -881,7 +966,8 @@ Information regarding a host IPS software component object. [hourlyBillingFlag]: #hourlybillingflag #### [hourlyBillingFlag] A server's hourly billing status. -Type: **boolean** +Type: **boolean** + @@ -891,7 +977,8 @@ A server's hourly billing status. [inboundBandwidthUsage]: #inboundbandwidthusage #### [inboundBandwidthUsage] The sum of all the inbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -901,7 +988,8 @@ The sum of all the inbound network traffic data for the last 30 days. [inboundPrivateBandwidthUsage]: #inboundprivatebandwidthusage #### [inboundPrivateBandwidthUsage] The total private inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -911,7 +999,8 @@ The total private inbound bandwidth for this hardware for the current billing cy [inboundPublicBandwidthUsage]: #inboundpublicbandwidthusage #### [inboundPublicBandwidthUsage] The total public inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -921,7 +1010,8 @@ The total public inbound bandwidth for this hardware for the current billing cyc [isBillingTermChangeAvailableFlag]: #isbillingtermchangeavailableflag #### [isBillingTermChangeAvailableFlag] Whether or not this hardware object is eligible to change to term billing. -Type: **boolean** +Type: **boolean** + @@ -931,7 +1021,8 @@ Whether or not this hardware object is eligible to change to term billing. [isCloudReadyNodeCertified]: #iscloudreadynodecertified #### [isCloudReadyNodeCertified] Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute. -Type: **boolean** +Type: **boolean** + @@ -941,7 +1032,8 @@ Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute. [isIpmiDisabled]: #isipmidisabled #### [isIpmiDisabled] Determine if remote management has been disabled due to port speed. -Type: **boolean** +Type: **boolean** + @@ -951,7 +1043,8 @@ Determine if remote management has been disabled due to port speed. [isVirtualPrivateCloudNode]: #isvirtualprivatecloudnode #### [isVirtualPrivateCloudNode] Determine if hardware object is a Virtual Private Cloud node. -Type: **boolean** +Type: **boolean** + @@ -961,7 +1054,8 @@ Determine if hardware object is a Virtual Private Cloud node. [lastOperatingSystemReload]: #lastoperatingsystemreload #### [lastOperatingSystemReload] The last transaction that a server's operating system was loaded. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -971,7 +1065,8 @@ The last transaction that a server's operating system was loaded. [lastTransaction]: #lasttransaction #### [lastTransaction] Information regarding the last transaction a server performed. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -981,7 +1076,8 @@ Information regarding the last transaction a server performed. [latestNetworkMonitorIncident]: #latestnetworkmonitorincident #### [latestNetworkMonitorIncident] A piece of hardware's latest network monitoring incident. -Type: **SoftLayer_Network_Monitor_Version1_Incident ** +Type: **SoftLayer_Network_Monitor_Version1_Incident ** + @@ -991,7 +1087,8 @@ A piece of hardware's latest network monitoring incident. [location]: #location #### [location] Where a piece of hardware is located within SoftLayer's location hierarchy. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1001,7 +1098,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [locationPathString]: #locationpathstring #### [locationPathString] -Type: **string** +Type: **string** + @@ -1011,7 +1109,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [lockboxNetworkStorage]: #lockboxnetworkstorage #### [lockboxNetworkStorage] Information regarding a lockbox account associated with a server. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -1021,7 +1120,8 @@ Information regarding a lockbox account associated with a server. [logicalVolumeStorageGroups]: #logicalvolumestoragegroups #### [logicalVolumeStorageGroups] Returns a list of logical volumes on the physical machine. -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + @@ -1031,7 +1131,8 @@ Returns a list of logical volumes on the physical machine. [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the hardware is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -1041,7 +1142,8 @@ A flag indicating that the hardware is a managed resource. [memory]: #memory #### [memory] Information regarding a piece of hardware's memory. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1051,7 +1153,8 @@ Information regarding a piece of hardware's memory. [memoryCapacity]: #memorycapacity #### [memoryCapacity] The amount of memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1061,7 +1164,8 @@ The amount of memory a piece of hardware has, measured in gigabytes. [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A piece of hardware's metric tracking object. -Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** +Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** + @@ -1071,7 +1175,8 @@ A piece of hardware's metric tracking object. [metricTrackingObjectId]: #metrictrackingobjectid #### [metricTrackingObjectId] The metric tracking object id for this server. -Type: **integer** +Type: **integer** + @@ -1081,7 +1186,8 @@ The metric tracking object id for this server. [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1091,7 +1197,8 @@ The metric tracking object id for this server. [monitoringRobot]: #monitoringrobot #### [monitoringRobot] -Type: **SoftLayer_Monitoring_Robot ** +Type: **SoftLayer_Monitoring_Robot ** + @@ -1101,7 +1208,8 @@ The metric tracking object id for this server. [monitoringServiceComponent]: #monitoringservicecomponent #### [monitoringServiceComponent] Information regarding a piece of hardware's network monitoring services. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** + @@ -1111,7 +1219,8 @@ Information regarding a piece of hardware's network monitoring services. [monitoringServiceEligibilityFlag]: #monitoringserviceeligibilityflag #### [monitoringServiceEligibilityFlag] -Type: **boolean** +Type: **boolean** + @@ -1121,7 +1230,8 @@ Information regarding a piece of hardware's network monitoring services. [monitoringUserNotification]: #monitoringusernotification #### [monitoringUserNotification] The monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails -Type: **SoftLayer_User_Customer_Notification_Hardware[] ** +Type: **SoftLayer_User_Customer_Notification_Hardware[] ** + @@ -1131,7 +1241,8 @@ The monitoring notification objects for this hardware. Each object links this ha [motherboard]: #motherboard #### [motherboard] A server's motherboard. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -1141,7 +1252,8 @@ A server's motherboard. [networkCards]: #networkcards #### [networkCards] Information regarding a piece of hardware's network cards. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1151,7 +1263,8 @@ Information regarding a piece of hardware's network cards. [networkComponents]: #networkcomponents #### [networkComponents] Returns a hardware's network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -1161,7 +1274,8 @@ Returns a hardware's network components. [networkGatewayMember]: #networkgatewaymember #### [networkGatewayMember] The gateway member if this device is part of a network gateway. -Type: **SoftLayer_Network_Gateway_Member ** +Type: **SoftLayer_Network_Gateway_Member ** + @@ -1171,7 +1285,8 @@ The gateway member if this device is part of a network gateway. [networkGatewayMemberFlag]: #networkgatewaymemberflag #### [networkGatewayMemberFlag] Whether or not this device is part of a network gateway. -Type: **boolean** +Type: **boolean** + @@ -1181,7 +1296,8 @@ Whether or not this device is part of a network gateway. [networkManagementIpAddress]: #networkmanagementipaddress #### [networkManagementIpAddress] A piece of hardware's network management IP address. -Type: **string** +Type: **string** + @@ -1191,7 +1307,8 @@ A piece of hardware's network management IP address. [networkMonitorAttachedDownHardware]: #networkmonitorattacheddownhardware #### [networkMonitorAttachedDownHardware] All servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1201,7 +1318,8 @@ All servers with failed monitoring that are attached downstream to a piece of ha [networkMonitorAttachedDownVirtualGuests]: #networkmonitorattacheddownvirtualguests #### [networkMonitorAttachedDownVirtualGuests] Virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -1211,7 +1329,8 @@ Virtual guests that are attached downstream to a hardware that have failed monit [networkMonitorIncidents]: #networkmonitorincidents #### [networkMonitorIncidents] The status of all of a piece of hardware's network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -1221,7 +1340,8 @@ The status of all of a piece of hardware's network monitoring incidents. [networkMonitors]: #networkmonitors #### [networkMonitors] Information regarding a piece of hardware's network monitors. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** + @@ -1231,7 +1351,8 @@ Information regarding a piece of hardware's network monitors. [networkStatus]: #networkstatus #### [networkStatus] The value of a hardware's network status attribute. -Type: **string** +Type: **string** + @@ -1241,7 +1362,8 @@ The value of a hardware's network status attribute. [networkStatusAttribute]: #networkstatusattribute #### [networkStatusAttribute] The hardware's related network status attribute. -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -1251,7 +1373,8 @@ The hardware's related network status attribute. [networkStorage]: #networkstorage #### [networkStorage] Information regarding a piece of hardware's associated network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -1261,7 +1384,8 @@ Information regarding a piece of hardware's associated network storage service a [networkVlans]: #networkvlans #### [networkVlans] The network virtual LANs (VLANs) associated with a piece of hardware's network components. -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -1271,7 +1395,8 @@ The network virtual LANs (VLANs) associated with a piece of hardware's network c [nextBillingCycleBandwidthAllocation]: #nextbillingcyclebandwidthallocation #### [nextBillingCycleBandwidthAllocation] A hardware's allotted bandwidth for the next billing cycle (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -1281,7 +1406,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [notesHistory]: #noteshistory #### [notesHistory] -Type: **SoftLayer_Hardware_Note[] ** +Type: **SoftLayer_Hardware_Note[] ** + @@ -1291,7 +1417,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [nvRamCapacity]: #nvramcapacity #### [nvRamCapacity] The amount of non-volatile memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1301,7 +1428,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [nvRamComponentModels]: #nvramcomponentmodels #### [nvRamComponentModels] -Type: **SoftLayer_Hardware_Component_Model[] ** +Type: **SoftLayer_Hardware_Component_Model[] ** + @@ -1311,7 +1439,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [openCancellationTicket]: #opencancellationticket #### [openCancellationTicket] An open ticket requesting cancellation of this server, if one exists. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -1321,7 +1450,8 @@ An open ticket requesting cancellation of this server, if one exists. [operatingSystem]: #operatingsystem #### [operatingSystem] Information regarding a piece of hardware's operating system. -Type: **SoftLayer_Software_Component_OperatingSystem ** +Type: **SoftLayer_Software_Component_OperatingSystem ** + @@ -1331,7 +1461,8 @@ Information regarding a piece of hardware's operating system. [operatingSystemReferenceCode]: #operatingsystemreferencecode #### [operatingSystemReferenceCode] A hardware's operating system software description. -Type: **string** +Type: **string** + @@ -1341,7 +1472,8 @@ A hardware's operating system software description. [outboundBandwidthUsage]: #outboundbandwidthusage #### [outboundBandwidthUsage] The sum of all the outbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -1351,7 +1483,8 @@ The sum of all the outbound network traffic data for the last 30 days. [outboundPrivateBandwidthUsage]: #outboundprivatebandwidthusage #### [outboundPrivateBandwidthUsage] The total private outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -1361,7 +1494,8 @@ The total private outbound bandwidth for this hardware for the current billing c [outboundPublicBandwidthUsage]: #outboundpublicbandwidthusage #### [outboundPublicBandwidthUsage] The total public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -1371,7 +1505,8 @@ The total public outbound bandwidth for this hardware for the current billing cy [overBandwidthAllocationFlag]: #overbandwidthallocationflag #### [overBandwidthAllocationFlag] Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation. -Type: **integer** +Type: **integer** + @@ -1381,7 +1516,8 @@ Whether the bandwidth usage for this hardware for the current billing cycle exce [parentBay]: #parentbay #### [parentBay] Blade Bay -Type: **SoftLayer_Hardware_Blade ** +Type: **SoftLayer_Hardware_Blade ** + @@ -1391,7 +1527,8 @@ Blade Bay [parentHardware]: #parenthardware #### [parentHardware] Parent Hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1401,7 +1538,8 @@ Parent Hardware. [partitions]: #partitions #### [partitions] -Type: **SoftLayer_Hardware_Server_Partition[] ** +Type: **SoftLayer_Hardware_Server_Partition[] ** + @@ -1411,7 +1549,8 @@ Parent Hardware. [pointOfPresenceLocation]: #pointofpresencelocation #### [pointOfPresenceLocation] Information regarding the Point of Presence (PoP) location in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1421,7 +1560,8 @@ Information regarding the Point of Presence (PoP) location in which a piece of h [powerComponents]: #powercomponents #### [powerComponents] The power components for a hardware object. -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -1431,7 +1571,8 @@ The power components for a hardware object. [powerSupply]: #powersupply #### [powerSupply] A server's power supply. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1441,7 +1582,8 @@ A server's power supply. [primaryBackendIpAddress]: #primarybackendipaddress #### [primaryBackendIpAddress] The hardware's primary private IP address. -Type: **string** +Type: **string** + @@ -1451,7 +1593,8 @@ The hardware's primary private IP address. [primaryIpAddress]: #primaryipaddress #### [primaryIpAddress] The hardware's primary public IP address. -Type: **string** +Type: **string** + @@ -1461,7 +1604,8 @@ The hardware's primary public IP address. [privateIpAddress]: #privateipaddress #### [privateIpAddress] A server's primary private IP address. -Type: **string** +Type: **string** + @@ -1471,7 +1615,8 @@ A server's primary private IP address. [privateNetworkOnlyFlag]: #privatenetworkonlyflag #### [privateNetworkOnlyFlag] Whether the hardware only has access to the private network. -Type: **boolean** +Type: **boolean** + @@ -1481,7 +1626,8 @@ Whether the hardware only has access to the private network. [processorCoreAmount]: #processorcoreamount #### [processorCoreAmount] The total number of processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1491,7 +1637,8 @@ The total number of processor cores, summed from all processors that are attache [processorPhysicalCoreAmount]: #processorphysicalcoreamount #### [processorPhysicalCoreAmount] The total number of physical processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1501,7 +1648,8 @@ The total number of physical processor cores, summed from all processors that ar [processors]: #processors #### [processors] Information regarding a piece of hardware's processors. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1511,7 +1659,8 @@ Information regarding a piece of hardware's processors. [projectedOverBandwidthAllocationFlag]: #projectedoverbandwidthallocationflag #### [projectedOverBandwidthAllocationFlag] Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation. -Type: **integer** +Type: **integer** + @@ -1521,7 +1670,8 @@ Whether the bandwidth usage for this hardware for the current billing cycle is p [projectedPublicBandwidthUsage]: #projectedpublicbandwidthusage #### [projectedPublicBandwidthUsage] The projected public outbound bandwidth for this hardware for the current billing cycle. -Type: **float** +Type: **float** + @@ -1531,7 +1681,8 @@ The projected public outbound bandwidth for this hardware for the current billin [rack]: #rack #### [rack] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1541,7 +1692,8 @@ The projected public outbound bandwidth for this hardware for the current billin [raidControllers]: #raidcontrollers #### [raidControllers] The RAID controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1551,7 +1703,8 @@ The RAID controllers contained within a piece of hardware. [readyNodeFlag]: #readynodeflag #### [readyNodeFlag] Determine if hardware object is vSan Ready Node. -Type: **boolean** +Type: **boolean** + @@ -1561,7 +1714,8 @@ Determine if hardware object is vSan Ready Node. [recentEvents]: #recentevents #### [recentEvents] Recent events that impact this hardware. -Type: **SoftLayer_Notification_Occurrence_Event[] ** +Type: **SoftLayer_Notification_Occurrence_Event[] ** + @@ -1571,7 +1725,8 @@ Recent events that impact this hardware. [recentRemoteManagementCommands]: #recentremotemanagementcommands #### [recentRemoteManagementCommands] The last five commands issued to the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request[] ** + @@ -1581,7 +1736,8 @@ The last five commands issued to the server's remote management card. [regionalInternetRegistry]: #regionalinternetregistry #### [regionalInternetRegistry] -Type: **SoftLayer_Network_Regional_Internet_Registry ** +Type: **SoftLayer_Network_Regional_Internet_Registry ** + @@ -1591,7 +1747,8 @@ The last five commands issued to the server's remote management card. [remoteManagement]: #remotemanagement #### [remoteManagement] A server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement ** +Type: **SoftLayer_Hardware_Component_RemoteManagement ** + @@ -1601,7 +1758,8 @@ A server's remote management card. [remoteManagementAccounts]: #remotemanagementaccounts #### [remoteManagementAccounts] User credentials to issue commands and/or interact with the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** + @@ -1611,7 +1769,8 @@ User credentials to issue commands and/or interact with the server's remote mana [remoteManagementComponent]: #remotemanagementcomponent #### [remoteManagementComponent] A hardware's associated remote management component. This is normally IPMI. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1621,7 +1780,8 @@ A hardware's associated remote management component. This is normally IPMI. [remoteManagementUsers]: #remotemanagementusers #### [remoteManagementUsers] User(s) who have access to issue commands and/or interact with the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** + @@ -1631,7 +1791,8 @@ User(s) who have access to issue commands and/or interact with the server's remo [resourceConfigurations]: #resourceconfigurations #### [resourceConfigurations] -Type: **SoftLayer_Hardware_Resource_Configuration[] ** +Type: **SoftLayer_Hardware_Resource_Configuration[] ** + @@ -1641,7 +1802,8 @@ User(s) who have access to issue commands and/or interact with the server's remo [resourceGroupMemberReferences]: #resourcegroupmemberreferences #### [resourceGroupMemberReferences] -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -1651,7 +1813,8 @@ User(s) who have access to issue commands and/or interact with the server's remo [resourceGroupRoles]: #resourcegrouproles #### [resourceGroupRoles] -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -1661,7 +1824,8 @@ User(s) who have access to issue commands and/or interact with the server's remo [resourceGroups]: #resourcegroups #### [resourceGroups] The resource groups in which this hardware is a member. -Type: **SoftLayer_Resource_Group[] ** +Type: **SoftLayer_Resource_Group[] ** + @@ -1671,7 +1835,8 @@ The resource groups in which this hardware is a member. [routers]: #routers #### [routers] A hardware's routers. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1681,7 +1846,8 @@ A hardware's routers. [scaleAssets]: #scaleassets #### [scaleAssets] Collection of scale assets this hardware corresponds to. -Type: **SoftLayer_Scale_Asset[] ** +Type: **SoftLayer_Scale_Asset[] ** + @@ -1691,7 +1857,8 @@ Collection of scale assets this hardware corresponds to. [securityScanRequests]: #securityscanrequests #### [securityScanRequests] Information regarding a piece of hardware's vulnerability scan requests. -Type: **SoftLayer_Network_Security_Scanner_Request[] ** +Type: **SoftLayer_Network_Security_Scanner_Request[] ** + @@ -1701,7 +1868,8 @@ Information regarding a piece of hardware's vulnerability scan requests. [serverRoom]: #serverroom #### [serverRoom] Information regarding the server room in which the hardware is located. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1711,7 +1879,8 @@ Information regarding the server room in which the hardware is located. [serviceProvider]: #serviceprovider #### [serviceProvider] Information regarding the piece of hardware's service provider. -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -1721,7 +1890,8 @@ Information regarding the piece of hardware's service provider. [softwareComponents]: #softwarecomponents #### [softwareComponents] Information regarding a piece of hardware's installed software. -Type: **SoftLayer_Software_Component[] ** +Type: **SoftLayer_Software_Component[] ** + @@ -1731,7 +1901,8 @@ Information regarding a piece of hardware's installed software. [softwareGuardExtensionEnabled]: #softwareguardextensionenabled #### [softwareGuardExtensionEnabled] Determine if hardware object has Software Guard Extension (SGX) enabled. -Type: **boolean** +Type: **boolean** + @@ -1741,7 +1912,8 @@ Determine if hardware object has Software Guard Extension (SGX) enabled. [sshKeys]: #sshkeys #### [sshKeys] SSH keys to be installed on the server during provisioning or an OS reload. -Type: **SoftLayer_Security_Ssh_Key[] ** +Type: **SoftLayer_Security_Ssh_Key[] ** + @@ -1751,7 +1923,8 @@ SSH keys to be installed on the server during provisioning or an OS reload. [statisticsRemoteManagement]: #statisticsremotemanagement #### [statisticsRemoteManagement] A server's remote management card used for statistics. -Type: **SoftLayer_Hardware_Component_RemoteManagement ** +Type: **SoftLayer_Hardware_Component_RemoteManagement ** + @@ -1761,17 +1934,20 @@ A server's remote management card used for statistics. [storageGroups]: #storagegroups #### [storageGroups] -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + -
      +
      ----- [storageNetworkComponents]: #storagenetworkcomponents #### [storageNetworkComponents] A piece of hardware's private storage network components. [Deprecated] -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + +Deprecated
      @@ -1781,7 +1957,8 @@ A piece of hardware's private storage network components. [Deprecated] [tagReferences]: #tagreferences #### [tagReferences] -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** +
      @@ -1791,7 +1968,8 @@ A piece of hardware's private storage network components. [Deprecated] [topLevelLocation]: #toplevellocation #### [topLevelLocation] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1801,7 +1979,8 @@ A piece of hardware's private storage network components. [Deprecated] [uefiBootFlag]: #uefibootflag #### [uefiBootFlag] Whether to use UEFI boot instead of BIOS. -Type: **boolean** +Type: **boolean** + @@ -1811,7 +1990,8 @@ Whether to use UEFI boot instead of BIOS. [upgradeRequest]: #upgraderequest #### [upgradeRequest] An account's associated upgrade request object, if any. -Type: **SoftLayer_Product_Upgrade_Request ** +Type: **SoftLayer_Product_Upgrade_Request ** + @@ -1821,7 +2001,8 @@ An account's associated upgrade request object, if any. [uplinkHardware]: #uplinkhardware #### [uplinkHardware] The network device connected to a piece of hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1831,7 +2012,8 @@ The network device connected to a piece of hardware. [uplinkNetworkComponents]: #uplinknetworkcomponents #### [uplinkNetworkComponents] Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -1841,7 +2023,8 @@ Information regarding the network component that is one level higher than a piec [userData]: #userdata #### [userData] An array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -1851,7 +2034,8 @@ An array containing a single string of custom user data for a hardware order. Ma [users]: #users #### [users] A list of users that have access to this computing instance. -Type: **SoftLayer_User_Customer[] ** +Type: **SoftLayer_User_Customer[] ** + @@ -1861,7 +2045,8 @@ A list of users that have access to this computing instance. [virtualChassis]: #virtualchassis #### [virtualChassis] Information regarding the virtual chassis for a piece of hardware. -Type: **SoftLayer_Hardware_Group ** +Type: **SoftLayer_Hardware_Group ** + @@ -1871,7 +2056,8 @@ Information regarding the virtual chassis for a piece of hardware. [virtualChassisSiblings]: #virtualchassissiblings #### [virtualChassisSiblings] Information regarding the virtual chassis siblings for a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1881,7 +2067,8 @@ Information regarding the virtual chassis siblings for a piece of hardware. [virtualGuests]: #virtualguests #### [virtualGuests] A hardware server's virtual servers. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -1891,7 +2078,8 @@ A hardware server's virtual servers. [virtualHost]: #virtualhost #### [virtualHost] A piece of hardware's virtual host record. -Type: **SoftLayer_Virtual_Host ** +Type: **SoftLayer_Virtual_Host ** + @@ -1901,7 +2089,8 @@ A piece of hardware's virtual host record. [virtualLicenses]: #virtuallicenses #### [virtualLicenses] Information regarding a piece of hardware's virtual software licenses. -Type: **SoftLayer_Software_VirtualLicense[] ** +Type: **SoftLayer_Software_VirtualLicense[] ** + @@ -1911,7 +2100,8 @@ Information regarding a piece of hardware's virtual software licenses. [virtualRack]: #virtualrack #### [virtualRack] Information regarding the bandwidth allotment to which a piece of hardware belongs. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** + @@ -1921,7 +2111,8 @@ Information regarding the bandwidth allotment to which a piece of hardware belon [virtualRackId]: #virtualrackid #### [virtualRackId] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **integer** +Type: **integer** + @@ -1931,7 +2122,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualRackName]: #virtualrackname #### [virtualRackName] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **string** +Type: **string** + @@ -1941,7 +2133,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualizationPlatform]: #virtualizationplatform #### [virtualizationPlatform] A piece of hardware's virtualization platform software. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -1953,7 +2146,8 @@ A piece of hardware's virtualization platform software. [activeComponentCount]: #activecomponentcount #### [activeComponentCount] A count of a piece of hardware's active physical components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1963,7 +2157,8 @@ A count of a piece of hardware's active physical components. [activeNetworkMonitorIncidentCount]: #activenetworkmonitorincidentcount #### [activeNetworkMonitorIncidentCount] A count of a piece of hardware's active network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -1973,7 +2168,8 @@ A count of a piece of hardware's active network monitoring incidents. [activeTicketCount]: #activeticketcount #### [activeTicketCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1983,7 +2179,8 @@ A count of [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of any active transaction(s) that are currently running for the server (example: os reload). -Type: **unsigned long** +Type: **unsigned long** + @@ -1993,7 +2190,8 @@ A count of any active transaction(s) that are currently running for the server ( [allPowerComponentCount]: #allpowercomponentcount #### [allPowerComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2003,7 +2201,8 @@ A count of [allowedNetworkStorageCount]: #allowednetworkstoragecount #### [allowedNetworkStorageCount] A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -2013,7 +2212,8 @@ A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware ha [allowedNetworkStorageReplicaCount]: #allowednetworkstoragereplicacount #### [allowedNetworkStorageReplicaCount] A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -2023,7 +2223,8 @@ A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLay [attributeCount]: #attributecount #### [attributeCount] A count of information regarding a piece of hardware's specific attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -2033,7 +2234,8 @@ A count of information regarding a piece of hardware's specific attributes. [availableMonitoringCount]: #availablemonitoringcount #### [availableMonitoringCount] A count of an object that stores the maximum level for the monitoring query types and response types. -Type: **unsigned long** +Type: **unsigned long** + @@ -2043,7 +2245,8 @@ A count of an object that stores the maximum level for the monitoring query type [backendNetworkComponentCount]: #backendnetworkcomponentcount #### [backendNetworkComponentCount] A count of a piece of hardware's back-end or private network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -2053,7 +2256,8 @@ A count of a piece of hardware's back-end or private network components. [backendRouterCount]: #backendroutercount #### [backendRouterCount] A count of a hardware's backend or private router. -Type: **unsigned long** +Type: **unsigned long** + @@ -2063,7 +2267,8 @@ A count of a hardware's backend or private router. [benchmarkCertificationCount]: #benchmarkcertificationcount #### [benchmarkCertificationCount] A count of information regarding a piece of hardware's benchmark certifications. -Type: **unsigned long** +Type: **unsigned long** + @@ -2073,7 +2278,8 @@ A count of information regarding a piece of hardware's benchmark certifications. [billingCycleBandwidthUsageCount]: #billingcyclebandwidthusagecount #### [billingCycleBandwidthUsageCount] A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -2083,7 +2289,8 @@ A count of the raw bandwidth usage data for the current billing cycle. One objec [childrenHardwareCount]: #childrenhardwarecount #### [childrenHardwareCount] A count of child hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2093,7 +2300,8 @@ A count of child hardware. [componentCount]: #componentcount #### [componentCount] A count of a piece of hardware's components. -Type: **unsigned long** +Type: **unsigned long** + @@ -2103,7 +2311,8 @@ A count of a piece of hardware's components. [downlinkHardwareCount]: #downlinkhardwarecount #### [downlinkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2113,7 +2322,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkNetworkHardwareCount]: #downlinknetworkhardwarecount #### [downlinkNetworkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2123,7 +2333,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkServerCount]: #downlinkservercount #### [downlinkServerCount] A count of information regarding all servers attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2133,7 +2344,8 @@ A count of information regarding all servers attached to a piece of network hard [downlinkVirtualGuestCount]: #downlinkvirtualguestcount #### [downlinkVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2143,7 +2355,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [downstreamHardwareBindingCount]: #downstreamhardwarebindingcount #### [downstreamHardwareBindingCount] A count of all hardware downstream from a network device. -Type: **unsigned long** +Type: **unsigned long** + @@ -2153,7 +2366,8 @@ A count of all hardware downstream from a network device. [downstreamNetworkHardwareCount]: #downstreamnetworkhardwarecount #### [downstreamNetworkHardwareCount] A count of all network hardware downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2163,7 +2377,8 @@ A count of all network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidentCount]: #downstreamnetworkhardwarewithincidentcount #### [downstreamNetworkHardwareWithIncidentCount] A count of all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2173,7 +2388,8 @@ A count of all network hardware with monitoring warnings or errors that are down [downstreamServerCount]: #downstreamservercount #### [downstreamServerCount] A count of information regarding all servers attached downstream to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2183,7 +2399,8 @@ A count of information regarding all servers attached downstream to a piece of n [downstreamVirtualGuestCount]: #downstreamvirtualguestcount #### [downstreamVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2193,7 +2410,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [driveControllerCount]: #drivecontrollercount #### [driveControllerCount] A count of the drive controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2203,7 +2421,8 @@ A count of the drive controllers contained within a piece of hardware. [evaultNetworkStorageCount]: #evaultnetworkstoragecount #### [evaultNetworkStorageCount] A count of information regarding a piece of hardware's associated EVault network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -2213,7 +2432,8 @@ A count of information regarding a piece of hardware's associated EVault network [frontendNetworkComponentCount]: #frontendnetworkcomponentcount #### [frontendNetworkComponentCount] A count of a piece of hardware's front-end or public network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -2223,7 +2443,8 @@ A count of a piece of hardware's front-end or public network components. [frontendRouterCount]: #frontendroutercount #### [frontendRouterCount] A count of a hardware's frontend or public router. -Type: **unsigned long** +Type: **unsigned long** + @@ -2233,7 +2454,8 @@ A count of a hardware's frontend or public router. [hardDriveCount]: #harddrivecount #### [hardDriveCount] A count of the hard drives contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2243,7 +2465,8 @@ A count of the hard drives contained within a piece of hardware. [logicalVolumeStorageGroupCount]: #logicalvolumestoragegroupcount #### [logicalVolumeStorageGroupCount] A count of returns a list of logical volumes on the physical machine. -Type: **unsigned long** +Type: **unsigned long** + @@ -2253,7 +2476,8 @@ A count of returns a list of logical volumes on the physical machine. [memoryCount]: #memorycount #### [memoryCount] A count of information regarding a piece of hardware's memory. -Type: **unsigned long** +Type: **unsigned long** + @@ -2263,7 +2487,8 @@ A count of information regarding a piece of hardware's memory. [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2273,7 +2498,8 @@ A count of [monitoringUserNotificationCount]: #monitoringusernotificationcount #### [monitoringUserNotificationCount] A count of the monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails -Type: **unsigned long** +Type: **unsigned long** + @@ -2283,7 +2509,8 @@ A count of the monitoring notification objects for this hardware. Each object li [networkCardCount]: #networkcardcount #### [networkCardCount] A count of information regarding a piece of hardware's network cards. -Type: **unsigned long** +Type: **unsigned long** + @@ -2293,7 +2520,8 @@ A count of information regarding a piece of hardware's network cards. [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of returns a hardware's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -2303,7 +2531,8 @@ A count of returns a hardware's network components. [networkMonitorAttachedDownHardwareCount]: #networkmonitorattacheddownhardwarecount #### [networkMonitorAttachedDownHardwareCount] A count of all servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2313,7 +2542,8 @@ A count of all servers with failed monitoring that are attached downstream to a [networkMonitorAttachedDownVirtualGuestCount]: #networkmonitorattacheddownvirtualguestcount #### [networkMonitorAttachedDownVirtualGuestCount] A count of virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **unsigned long** +Type: **unsigned long** + @@ -2323,7 +2553,8 @@ A count of virtual guests that are attached downstream to a hardware that have f [networkMonitorCount]: #networkmonitorcount #### [networkMonitorCount] A count of information regarding a piece of hardware's network monitors. -Type: **unsigned long** +Type: **unsigned long** + @@ -2333,7 +2564,8 @@ A count of information regarding a piece of hardware's network monitors. [networkMonitorIncidentCount]: #networkmonitorincidentcount #### [networkMonitorIncidentCount] A count of the status of all of a piece of hardware's network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -2343,7 +2575,8 @@ A count of the status of all of a piece of hardware's network monitoring inciden [networkStorageCount]: #networkstoragecount #### [networkStorageCount] A count of information regarding a piece of hardware's associated network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -2353,7 +2586,8 @@ A count of information regarding a piece of hardware's associated network storag [networkVlanCount]: #networkvlancount #### [networkVlanCount] A count of the network virtual LANs (VLANs) associated with a piece of hardware's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -2363,7 +2597,8 @@ A count of the network virtual LANs (VLANs) associated with a piece of hardware' [notesHistoryCount]: #noteshistorycount #### [notesHistoryCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2373,7 +2608,8 @@ A count of [nvRamComponentModelCount]: #nvramcomponentmodelcount #### [nvRamComponentModelCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2383,7 +2619,8 @@ A count of [partitionCount]: #partitioncount #### [partitionCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2393,7 +2630,8 @@ A count of [powerComponentCount]: #powercomponentcount #### [powerComponentCount] A count of the power components for a hardware object. -Type: **unsigned long** +Type: **unsigned long** + @@ -2403,7 +2641,8 @@ A count of the power components for a hardware object. [powerSupplyCount]: #powersupplycount #### [powerSupplyCount] A count of a server's power supply. -Type: **unsigned long** +Type: **unsigned long** + @@ -2413,7 +2652,8 @@ A count of a server's power supply. [processorCount]: #processorcount #### [processorCount] A count of information regarding a piece of hardware's processors. -Type: **unsigned long** +Type: **unsigned long** + @@ -2423,7 +2663,8 @@ A count of information regarding a piece of hardware's processors. [raidControllerCount]: #raidcontrollercount #### [raidControllerCount] A count of the RAID controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2433,7 +2674,8 @@ A count of the RAID controllers contained within a piece of hardware. [recentEventCount]: #recenteventcount #### [recentEventCount] A count of recent events that impact this hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2443,7 +2685,8 @@ A count of recent events that impact this hardware. [recentRemoteManagementCommandCount]: #recentremotemanagementcommandcount #### [recentRemoteManagementCommandCount] A count of the last five commands issued to the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -2453,7 +2696,8 @@ A count of the last five commands issued to the server's remote management card. [remoteManagementAccountCount]: #remotemanagementaccountcount #### [remoteManagementAccountCount] A count of user credentials to issue commands and/or interact with the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -2463,7 +2707,8 @@ A count of user credentials to issue commands and/or interact with the server's [remoteManagementUserCount]: #remotemanagementusercount #### [remoteManagementUserCount] A count of user(s) who have access to issue commands and/or interact with the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -2473,7 +2718,8 @@ A count of user(s) who have access to issue commands and/or interact with the se [resourceConfigurationCount]: #resourceconfigurationcount #### [resourceConfigurationCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2483,7 +2729,8 @@ A count of [resourceGroupCount]: #resourcegroupcount #### [resourceGroupCount] A count of the resource groups in which this hardware is a member. -Type: **unsigned long** +Type: **unsigned long** + @@ -2493,7 +2740,8 @@ A count of the resource groups in which this hardware is a member. [resourceGroupMemberReferenceCount]: #resourcegroupmemberreferencecount #### [resourceGroupMemberReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2503,7 +2751,8 @@ A count of [resourceGroupRoleCount]: #resourcegrouprolecount #### [resourceGroupRoleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2513,7 +2762,8 @@ A count of [routerCount]: #routercount #### [routerCount] A count of a hardware's routers. -Type: **unsigned long** +Type: **unsigned long** + @@ -2523,7 +2773,8 @@ A count of a hardware's routers. [scaleAssetCount]: #scaleassetcount #### [scaleAssetCount] A count of collection of scale assets this hardware corresponds to. -Type: **unsigned long** +Type: **unsigned long** + @@ -2533,7 +2784,8 @@ A count of collection of scale assets this hardware corresponds to. [securityScanRequestCount]: #securityscanrequestcount #### [securityScanRequestCount] A count of information regarding a piece of hardware's vulnerability scan requests. -Type: **unsigned long** +Type: **unsigned long** + @@ -2543,7 +2795,8 @@ A count of information regarding a piece of hardware's vulnerability scan reques [softwareComponentCount]: #softwarecomponentcount #### [softwareComponentCount] A count of information regarding a piece of hardware's installed software. -Type: **unsigned long** +Type: **unsigned long** + @@ -2553,7 +2806,8 @@ A count of information regarding a piece of hardware's installed software. [sshKeyCount]: #sshkeycount #### [sshKeyCount] A count of sSH keys to be installed on the server during provisioning or an OS reload. -Type: **unsigned long** +Type: **unsigned long** + @@ -2563,7 +2817,8 @@ A count of sSH keys to be installed on the server during provisioning or an OS r [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2573,7 +2828,8 @@ A count of [storageNetworkComponentCount]: #storagenetworkcomponentcount #### [storageNetworkComponentCount] A count of a piece of hardware's private storage network components. [Deprecated] -Type: **unsigned long** +Type: **unsigned long** + @@ -2583,7 +2839,8 @@ A count of a piece of hardware's private storage network components. [Deprecated [tagReferenceCount]: #tagreferencecount #### [tagReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2593,7 +2850,8 @@ A count of [uplinkNetworkComponentCount]: #uplinknetworkcomponentcount #### [uplinkNetworkComponentCount] A count of information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **unsigned long** +Type: **unsigned long** + @@ -2603,7 +2861,8 @@ A count of information regarding the network component that is one level higher [userCount]: #usercount #### [userCount] A count of a list of users that have access to this computing instance. -Type: **unsigned long** +Type: **unsigned long** + @@ -2613,7 +2872,8 @@ A count of a list of users that have access to this computing instance. [userDataCount]: #userdatacount #### [userDataCount] A count of an array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **unsigned long** +Type: **unsigned long** + @@ -2623,7 +2883,8 @@ A count of an array containing a single string of custom user data for a hardwar [virtualChassisSiblingCount]: #virtualchassissiblingcount #### [virtualChassisSiblingCount] A count of information regarding the virtual chassis siblings for a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2633,7 +2894,8 @@ A count of information regarding the virtual chassis siblings for a piece of har [virtualGuestCount]: #virtualguestcount #### [virtualGuestCount] A count of a hardware server's virtual servers. -Type: **unsigned long** +Type: **unsigned long** + @@ -2643,7 +2905,8 @@ A count of a hardware server's virtual servers. [virtualLicenseCount]: #virtuallicensecount #### [virtualLicenseCount] A count of information regarding a piece of hardware's virtual software licenses. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_SecurityModule750/_index.md b/content/reference/datatypes/SoftLayer_Hardware_SecurityModule750/_index.md index 025450e68a..5f42e42f39 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_SecurityModule750/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_SecurityModule750/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] A hardware's associated [SoftLayer_Account]({{}}) id. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ A hardware's associated [SoftLayer_Account]({{Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ When true, this flag specifies that a hardware is Bare Metal Server. Bare Metal [domain]: #domain #### [domain] A piece of hardware's local network domain name. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A piece of hardware's local network domain name. [fullyQualifiedDomainName]: #fullyqualifieddomainname #### [fullyQualifiedDomainName] A name reflecting the hostname and domain of the hardware. This is created from the combined values of the hardware's hostname and domain name automatically, and thus should not be edited directly. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ A name reflecting the hostname and domain of the hardware. This is created from [hardwareStatusId]: #hardwarestatusid #### [hardwareStatusId] A number reflecting the state of a hardware -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ A number reflecting the state of a hardware [hostname]: #hostname #### [hostname] A hardware's hostname -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ A hardware's hostname [id]: #id #### [id] A hardware's internal identification number -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A hardware's internal identification number [manufacturerSerialNumber]: #manufacturerserialnumber #### [manufacturerSerialNumber] A hardware's serial number that is supplied by the manufacturer. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A hardware's serial number that is supplied by the manufacturer. [notes]: #notes #### [notes] A small note about a piece of hardware to use at your discretion. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ A small note about a piece of hardware to use at your discretion. [postInstallScriptUri]: #postinstallscripturi #### [postInstallScriptUri] URI of the script to be downloaded and executed after installation is complete. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ URI of the script to be downloaded and executed after installation is complete. [provisionDate]: #provisiondate #### [provisionDate] -Type: **dateTime** +Type: **dateTime** + @@ -155,7 +168,8 @@ URI of the script to be downloaded and executed after installation is complete. [serialNumber]: #serialnumber #### [serialNumber] A hardware's serial number that is supplied by SoftLayer. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderResourceId]: #serviceproviderresourceid #### [serviceProviderResourceId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -191,7 +207,8 @@ A hardware's internal identification number at its service provider [account]: #account #### [account] The account associated with a piece of hardware. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -201,7 +218,8 @@ The account associated with a piece of hardware. [activeComponents]: #activecomponents #### [activeComponents] A piece of hardware's active physical components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -211,7 +229,8 @@ A piece of hardware's active physical components. [activeNetworkFirewallBillingItem]: #activenetworkfirewallbillingitem #### [activeNetworkFirewallBillingItem] The billing item for a server's attached network firewall. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -221,7 +240,8 @@ The billing item for a server's attached network firewall. [activeNetworkMonitorIncident]: #activenetworkmonitorincident #### [activeNetworkMonitorIncident] A piece of hardware's active network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -231,7 +251,8 @@ A piece of hardware's active network monitoring incidents. [activeTickets]: #activetickets #### [activeTickets] -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -241,7 +262,8 @@ A piece of hardware's active network monitoring incidents. [activeTransaction]: #activetransaction #### [activeTransaction] Transaction currently running for server. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -251,7 +273,8 @@ Transaction currently running for server. [activeTransactions]: #activetransactions #### [activeTransactions] Any active transaction(s) that are currently running for the server (example: os reload). -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + @@ -261,7 +284,8 @@ Any active transaction(s) that are currently running for the server (example: os [allPowerComponents]: #allpowercomponents #### [allPowerComponents] -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -271,7 +295,8 @@ Any active transaction(s) that are currently running for the server (example: os [allowedHost]: #allowedhost #### [allowedHost] The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. -Type: **SoftLayer_Network_Storage_Allowed_Host ** +Type: **SoftLayer_Network_Storage_Allowed_Host ** + @@ -281,7 +306,8 @@ The SoftLayer_Network_Storage_Allowed_Host information to connect this server to [allowedNetworkStorage]: #allowednetworkstorage #### [allowedNetworkStorage] The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -291,7 +317,8 @@ The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to [allowedNetworkStorageReplicas]: #allowednetworkstoragereplicas #### [allowedNetworkStorageReplicas] The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -301,7 +328,8 @@ The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware [antivirusSpywareSoftwareComponent]: #antivirusspywaresoftwarecomponent #### [antivirusSpywareSoftwareComponent] Information regarding an antivirus/spyware software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -311,7 +339,8 @@ Information regarding an antivirus/spyware software component object. [attributes]: #attributes #### [attributes] Information regarding a piece of hardware's specific attributes. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -321,7 +350,8 @@ Information regarding a piece of hardware's specific attributes. [availableMonitoring]: #availablemonitoring #### [availableMonitoring] An object that stores the maximum level for the monitoring query types and response types. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum[] ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum[] ** + @@ -331,7 +361,8 @@ An object that stores the maximum level for the monitoring query types and respo [averageDailyBandwidthUsage]: #averagedailybandwidthusage #### [averageDailyBandwidthUsage] The average daily total bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -341,7 +372,8 @@ The average daily total bandwidth usage for the current billing cycle. [averageDailyPrivateBandwidthUsage]: #averagedailyprivatebandwidthusage #### [averageDailyPrivateBandwidthUsage] The average daily private bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -351,7 +383,8 @@ The average daily private bandwidth usage for the current billing cycle. [averageDailyPublicBandwidthUsage]: #averagedailypublicbandwidthusage #### [averageDailyPublicBandwidthUsage] The average daily public bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -361,7 +394,8 @@ The average daily public bandwidth usage for the current billing cycle. [backendNetworkComponents]: #backendnetworkcomponents #### [backendNetworkComponents] A piece of hardware's back-end or private network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -371,7 +405,8 @@ A piece of hardware's back-end or private network components. [backendRouters]: #backendrouters #### [backendRouters] A hardware's backend or private router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -381,7 +416,8 @@ A hardware's backend or private router. [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] A hardware's allotted bandwidth (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -391,7 +427,8 @@ A hardware's allotted bandwidth (measured in GB). [bandwidthAllotmentDetail]: #bandwidthallotmentdetail #### [bandwidthAllotmentDetail] A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** + @@ -401,7 +438,8 @@ A hardware's allotted detail record. Allotment details link bandwidth allocation [benchmarkCertifications]: #benchmarkcertifications #### [benchmarkCertifications] Information regarding a piece of hardware's benchmark certifications. -Type: **SoftLayer_Hardware_Benchmark_Certification[] ** +Type: **SoftLayer_Hardware_Benchmark_Certification[] ** + @@ -411,7 +449,8 @@ Information regarding a piece of hardware's benchmark certifications. [billingCycleBandwidthUsage]: #billingcyclebandwidthusage #### [billingCycleBandwidthUsage] The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -421,7 +460,8 @@ The raw bandwidth usage data for the current billing cycle. One object will be r [billingCyclePrivateBandwidthUsage]: #billingcycleprivatebandwidthusage #### [billingCyclePrivateBandwidthUsage] The raw private bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage ** +Type: **SoftLayer_Network_Bandwidth_Usage ** + @@ -431,7 +471,8 @@ The raw private bandwidth usage data for the current billing cycle. [billingCyclePublicBandwidthUsage]: #billingcyclepublicbandwidthusage #### [billingCyclePublicBandwidthUsage] The raw public bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage ** +Type: **SoftLayer_Network_Bandwidth_Usage ** + @@ -441,7 +482,8 @@ The raw public bandwidth usage data for the current billing cycle. [billingItem]: #billingitem #### [billingItem] Information regarding the billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -451,7 +493,8 @@ Information regarding the billing item for a server. [billingItemFlag]: #billingitemflag #### [billingItemFlag] A flag indicating that a billing item exists. -Type: **boolean** +Type: **boolean** + @@ -461,7 +504,8 @@ A flag indicating that a billing item exists. [biosPasswordNullFlag]: #biospasswordnullflag #### [biosPasswordNullFlag] Determine if BIOS password should be left as null. -Type: **boolean** +Type: **boolean** + @@ -471,7 +515,8 @@ Determine if BIOS password should be left as null. [blockCancelBecauseDisconnectedFlag]: #blockcancelbecausedisconnectedflag #### [blockCancelBecauseDisconnectedFlag] Determines whether the hardware is ineligible for cancellation because it is disconnected. -Type: **boolean** +Type: **boolean** + @@ -481,7 +526,8 @@ Determines whether the hardware is ineligible for cancellation because it is dis [businessContinuanceInsuranceFlag]: #businesscontinuanceinsuranceflag #### [businessContinuanceInsuranceFlag] Status indicating whether or not a piece of hardware has business continuance insurance. -Type: **boolean** +Type: **boolean** + @@ -491,7 +537,8 @@ Status indicating whether or not a piece of hardware has business continuance in [captureEnabledFlag]: #captureenabledflag #### [captureEnabledFlag] Determine if the server is able to be image captured. If unable to image capture a reason will be provided. -Type: **SoftLayer_Container_Hardware_CaptureEnabled ** +Type: **SoftLayer_Container_Hardware_CaptureEnabled ** + @@ -501,7 +548,8 @@ Determine if the server is able to be image captured. If unable to image capture [childrenHardware]: #childrenhardware #### [childrenHardware] Child hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -511,7 +559,8 @@ Child hardware. [components]: #components #### [components] A piece of hardware's components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -521,7 +570,8 @@ A piece of hardware's components. [containsSolidStateDrivesFlag]: #containssolidstatedrivesflag #### [containsSolidStateDrivesFlag] -Type: **boolean** +Type: **boolean** + @@ -531,7 +581,8 @@ A piece of hardware's components. [continuousDataProtectionSoftwareComponent]: #continuousdataprotectionsoftwarecomponent #### [continuousDataProtectionSoftwareComponent] A continuous data protection/server backup software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -541,7 +592,8 @@ A continuous data protection/server backup software component object. [controlPanel]: #controlpanel #### [controlPanel] A server's control panel. -Type: **SoftLayer_Software_Component_ControlPanel ** +Type: **SoftLayer_Software_Component_ControlPanel ** + @@ -551,7 +603,8 @@ A server's control panel. [cost]: #cost #### [cost] The total cost of a server, measured in US Dollars ($USD). -Type: **float** +Type: **float** + @@ -561,7 +614,8 @@ The total cost of a server, measured in US Dollars ($USD). [currentBandwidthSummary]: #currentbandwidthsummary #### [currentBandwidthSummary] An object that provides commonly used bandwidth summary components for the current billing cycle. -Type: **SoftLayer_Metric_Tracking_Object_Bandwidth_Summary ** +Type: **SoftLayer_Metric_Tracking_Object_Bandwidth_Summary ** + @@ -571,7 +625,8 @@ An object that provides commonly used bandwidth summary components for the curre [currentBillableBandwidthUsage]: #currentbillablebandwidthusage #### [currentBillableBandwidthUsage] The current billable public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -581,7 +636,8 @@ The current billable public outbound bandwidth for this hardware for the current [customerInstalledOperatingSystemFlag]: #customerinstalledoperatingsystemflag #### [customerInstalledOperatingSystemFlag] Indicates if a server has a Customer Installed OS -Type: **boolean** +Type: **boolean** + @@ -591,7 +647,8 @@ Indicates if a server has a Customer Installed OS [customerOwnedFlag]: #customerownedflag #### [customerOwnedFlag] Indicates if a server is a customer owned device. -Type: **boolean** +Type: **boolean** + @@ -601,7 +658,8 @@ Indicates if a server is a customer owned device. [datacenter]: #datacenter #### [datacenter] Information regarding the datacenter in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -611,7 +669,8 @@ Information regarding the datacenter in which a piece of hardware resides. [datacenterName]: #datacentername #### [datacenterName] The name of the datacenter in which a piece of hardware resides. -Type: **string** +Type: **string** + @@ -621,7 +680,8 @@ The name of the datacenter in which a piece of hardware resides. [daysInSparePool]: #daysinsparepool #### [daysInSparePool] Number of day(s) a server have been in spare pool. -Type: **integer** +Type: **integer** + @@ -631,7 +691,8 @@ Number of day(s) a server have been in spare pool. [downlinkHardware]: #downlinkhardware #### [downlinkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -641,7 +702,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkNetworkHardware]: #downlinknetworkhardware #### [downlinkNetworkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -651,7 +713,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkServers]: #downlinkservers #### [downlinkServers] Information regarding all servers attached to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -661,7 +724,8 @@ Information regarding all servers attached to a piece of network hardware. [downlinkVirtualGuests]: #downlinkvirtualguests #### [downlinkVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -671,7 +735,8 @@ Information regarding all virtual guests attached to a piece of network hardware [downstreamHardwareBindings]: #downstreamhardwarebindings #### [downstreamHardwareBindings] All hardware downstream from a network device. -Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** +Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** + @@ -681,7 +746,8 @@ All hardware downstream from a network device. [downstreamNetworkHardware]: #downstreamnetworkhardware #### [downstreamNetworkHardware] All network hardware downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -691,7 +757,8 @@ All network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidents]: #downstreamnetworkhardwarewithincidents #### [downstreamNetworkHardwareWithIncidents] All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -701,7 +768,8 @@ All network hardware with monitoring warnings or errors that are downstream from [downstreamServers]: #downstreamservers #### [downstreamServers] Information regarding all servers attached downstream to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -711,7 +779,8 @@ Information regarding all servers attached downstream to a piece of network hard [downstreamVirtualGuests]: #downstreamvirtualguests #### [downstreamVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -721,7 +790,8 @@ Information regarding all virtual guests attached to a piece of network hardware [driveControllers]: #drivecontrollers #### [driveControllers] The drive controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -731,7 +801,8 @@ The drive controllers contained within a piece of hardware. [evaultNetworkStorage]: #evaultnetworkstorage #### [evaultNetworkStorage] Information regarding a piece of hardware's associated EVault network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -741,7 +812,8 @@ Information regarding a piece of hardware's associated EVault network storage se [firewallServiceComponent]: #firewallservicecomponent #### [firewallServiceComponent] Information regarding a piece of hardware's firewall services. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -751,7 +823,8 @@ Information regarding a piece of hardware's firewall services. [fixedConfigurationPreset]: #fixedconfigurationpreset #### [fixedConfigurationPreset] Defines the fixed components in a fixed configuration bare metal server. -Type: **SoftLayer_Product_Package_Preset ** +Type: **SoftLayer_Product_Package_Preset ** + @@ -761,7 +834,8 @@ Defines the fixed components in a fixed configuration bare metal server. [frontendNetworkComponents]: #frontendnetworkcomponents #### [frontendNetworkComponents] A piece of hardware's front-end or public network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -771,7 +845,8 @@ A piece of hardware's front-end or public network components. [frontendRouters]: #frontendrouters #### [frontendRouters] A hardware's frontend or public router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -781,7 +856,8 @@ A hardware's frontend or public router. [futureBillingItem]: #futurebillingitem #### [futureBillingItem] Information regarding the future billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -791,7 +867,8 @@ Information regarding the future billing item for a server. [globalIdentifier]: #globalidentifier #### [globalIdentifier] A hardware's universally unique identifier. -Type: **string** +Type: **string** + @@ -801,7 +878,8 @@ A hardware's universally unique identifier. [hardDrives]: #harddrives #### [hardDrives] The hard drives contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -811,7 +889,8 @@ The hard drives contained within a piece of hardware. [hardwareChassis]: #hardwarechassis #### [hardwareChassis] The chassis that a piece of hardware is housed in. -Type: **SoftLayer_Hardware_Chassis ** +Type: **SoftLayer_Hardware_Chassis ** + @@ -821,7 +900,8 @@ The chassis that a piece of hardware is housed in. [hardwareFunction]: #hardwarefunction #### [hardwareFunction] A hardware's function. -Type: **SoftLayer_Hardware_Function ** +Type: **SoftLayer_Hardware_Function ** + @@ -831,7 +911,8 @@ A hardware's function. [hardwareFunctionDescription]: #hardwarefunctiondescription #### [hardwareFunctionDescription] A hardware's function. -Type: **string** +Type: **string** + @@ -841,7 +922,8 @@ A hardware's function. [hardwareStatus]: #hardwarestatus #### [hardwareStatus] A hardware's status. -Type: **SoftLayer_Hardware_Status ** +Type: **SoftLayer_Hardware_Status ** + @@ -851,7 +933,8 @@ A hardware's status. [hasSingleRootVirtualizationBillingItemFlag]: #hassinglerootvirtualizationbillingitemflag #### [hasSingleRootVirtualizationBillingItemFlag] Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item. -Type: **boolean** +Type: **boolean** + @@ -861,7 +944,8 @@ Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item. [hasTrustedPlatformModuleBillingItemFlag]: #hastrustedplatformmodulebillingitemflag #### [hasTrustedPlatformModuleBillingItemFlag] Determine in hardware object has TPM enabled. -Type: **boolean** +Type: **boolean** + @@ -871,7 +955,8 @@ Determine in hardware object has TPM enabled. [hostIpsSoftwareComponent]: #hostipssoftwarecomponent #### [hostIpsSoftwareComponent] Information regarding a host IPS software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -881,7 +966,8 @@ Information regarding a host IPS software component object. [hourlyBillingFlag]: #hourlybillingflag #### [hourlyBillingFlag] A server's hourly billing status. -Type: **boolean** +Type: **boolean** + @@ -891,7 +977,8 @@ A server's hourly billing status. [inboundBandwidthUsage]: #inboundbandwidthusage #### [inboundBandwidthUsage] The sum of all the inbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -901,7 +988,8 @@ The sum of all the inbound network traffic data for the last 30 days. [inboundPrivateBandwidthUsage]: #inboundprivatebandwidthusage #### [inboundPrivateBandwidthUsage] The total private inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -911,7 +999,8 @@ The total private inbound bandwidth for this hardware for the current billing cy [inboundPublicBandwidthUsage]: #inboundpublicbandwidthusage #### [inboundPublicBandwidthUsage] The total public inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -921,7 +1010,8 @@ The total public inbound bandwidth for this hardware for the current billing cyc [isBillingTermChangeAvailableFlag]: #isbillingtermchangeavailableflag #### [isBillingTermChangeAvailableFlag] Whether or not this hardware object is eligible to change to term billing. -Type: **boolean** +Type: **boolean** + @@ -931,7 +1021,8 @@ Whether or not this hardware object is eligible to change to term billing. [isCloudReadyNodeCertified]: #iscloudreadynodecertified #### [isCloudReadyNodeCertified] Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute. -Type: **boolean** +Type: **boolean** + @@ -941,7 +1032,8 @@ Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute. [isIpmiDisabled]: #isipmidisabled #### [isIpmiDisabled] Determine if remote management has been disabled due to port speed. -Type: **boolean** +Type: **boolean** + @@ -951,7 +1043,8 @@ Determine if remote management has been disabled due to port speed. [isVirtualPrivateCloudNode]: #isvirtualprivatecloudnode #### [isVirtualPrivateCloudNode] Determine if hardware object is a Virtual Private Cloud node. -Type: **boolean** +Type: **boolean** + @@ -961,7 +1054,8 @@ Determine if hardware object is a Virtual Private Cloud node. [lastOperatingSystemReload]: #lastoperatingsystemreload #### [lastOperatingSystemReload] The last transaction that a server's operating system was loaded. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -971,7 +1065,8 @@ The last transaction that a server's operating system was loaded. [lastTransaction]: #lasttransaction #### [lastTransaction] Information regarding the last transaction a server performed. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -981,7 +1076,8 @@ Information regarding the last transaction a server performed. [latestNetworkMonitorIncident]: #latestnetworkmonitorincident #### [latestNetworkMonitorIncident] A piece of hardware's latest network monitoring incident. -Type: **SoftLayer_Network_Monitor_Version1_Incident ** +Type: **SoftLayer_Network_Monitor_Version1_Incident ** + @@ -991,7 +1087,8 @@ A piece of hardware's latest network monitoring incident. [location]: #location #### [location] Where a piece of hardware is located within SoftLayer's location hierarchy. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1001,7 +1098,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [locationPathString]: #locationpathstring #### [locationPathString] -Type: **string** +Type: **string** + @@ -1011,7 +1109,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [lockboxNetworkStorage]: #lockboxnetworkstorage #### [lockboxNetworkStorage] Information regarding a lockbox account associated with a server. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -1021,7 +1120,8 @@ Information regarding a lockbox account associated with a server. [logicalVolumeStorageGroups]: #logicalvolumestoragegroups #### [logicalVolumeStorageGroups] Returns a list of logical volumes on the physical machine. -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + @@ -1031,7 +1131,8 @@ Returns a list of logical volumes on the physical machine. [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the hardware is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -1041,7 +1142,8 @@ A flag indicating that the hardware is a managed resource. [memory]: #memory #### [memory] Information regarding a piece of hardware's memory. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1051,7 +1153,8 @@ Information regarding a piece of hardware's memory. [memoryCapacity]: #memorycapacity #### [memoryCapacity] The amount of memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1061,7 +1164,8 @@ The amount of memory a piece of hardware has, measured in gigabytes. [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A piece of hardware's metric tracking object. -Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** +Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** + @@ -1071,7 +1175,8 @@ A piece of hardware's metric tracking object. [metricTrackingObjectId]: #metrictrackingobjectid #### [metricTrackingObjectId] The metric tracking object id for this server. -Type: **integer** +Type: **integer** + @@ -1081,7 +1186,8 @@ The metric tracking object id for this server. [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1091,7 +1197,8 @@ The metric tracking object id for this server. [monitoringRobot]: #monitoringrobot #### [monitoringRobot] -Type: **SoftLayer_Monitoring_Robot ** +Type: **SoftLayer_Monitoring_Robot ** + @@ -1101,7 +1208,8 @@ The metric tracking object id for this server. [monitoringServiceComponent]: #monitoringservicecomponent #### [monitoringServiceComponent] Information regarding a piece of hardware's network monitoring services. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** + @@ -1111,7 +1219,8 @@ Information regarding a piece of hardware's network monitoring services. [monitoringServiceEligibilityFlag]: #monitoringserviceeligibilityflag #### [monitoringServiceEligibilityFlag] -Type: **boolean** +Type: **boolean** + @@ -1121,7 +1230,8 @@ Information regarding a piece of hardware's network monitoring services. [monitoringUserNotification]: #monitoringusernotification #### [monitoringUserNotification] The monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails -Type: **SoftLayer_User_Customer_Notification_Hardware[] ** +Type: **SoftLayer_User_Customer_Notification_Hardware[] ** + @@ -1131,7 +1241,8 @@ The monitoring notification objects for this hardware. Each object links this ha [motherboard]: #motherboard #### [motherboard] A server's motherboard. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -1141,7 +1252,8 @@ A server's motherboard. [networkCards]: #networkcards #### [networkCards] Information regarding a piece of hardware's network cards. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1151,7 +1263,8 @@ Information regarding a piece of hardware's network cards. [networkComponents]: #networkcomponents #### [networkComponents] Returns a hardware's network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -1161,7 +1274,8 @@ Returns a hardware's network components. [networkGatewayMember]: #networkgatewaymember #### [networkGatewayMember] The gateway member if this device is part of a network gateway. -Type: **SoftLayer_Network_Gateway_Member ** +Type: **SoftLayer_Network_Gateway_Member ** + @@ -1171,7 +1285,8 @@ The gateway member if this device is part of a network gateway. [networkGatewayMemberFlag]: #networkgatewaymemberflag #### [networkGatewayMemberFlag] Whether or not this device is part of a network gateway. -Type: **boolean** +Type: **boolean** + @@ -1181,7 +1296,8 @@ Whether or not this device is part of a network gateway. [networkManagementIpAddress]: #networkmanagementipaddress #### [networkManagementIpAddress] A piece of hardware's network management IP address. -Type: **string** +Type: **string** + @@ -1191,7 +1307,8 @@ A piece of hardware's network management IP address. [networkMonitorAttachedDownHardware]: #networkmonitorattacheddownhardware #### [networkMonitorAttachedDownHardware] All servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1201,7 +1318,8 @@ All servers with failed monitoring that are attached downstream to a piece of ha [networkMonitorAttachedDownVirtualGuests]: #networkmonitorattacheddownvirtualguests #### [networkMonitorAttachedDownVirtualGuests] Virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -1211,7 +1329,8 @@ Virtual guests that are attached downstream to a hardware that have failed monit [networkMonitorIncidents]: #networkmonitorincidents #### [networkMonitorIncidents] The status of all of a piece of hardware's network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -1221,7 +1340,8 @@ The status of all of a piece of hardware's network monitoring incidents. [networkMonitors]: #networkmonitors #### [networkMonitors] Information regarding a piece of hardware's network monitors. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** + @@ -1231,7 +1351,8 @@ Information regarding a piece of hardware's network monitors. [networkStatus]: #networkstatus #### [networkStatus] The value of a hardware's network status attribute. -Type: **string** +Type: **string** + @@ -1241,7 +1362,8 @@ The value of a hardware's network status attribute. [networkStatusAttribute]: #networkstatusattribute #### [networkStatusAttribute] The hardware's related network status attribute. -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -1251,7 +1373,8 @@ The hardware's related network status attribute. [networkStorage]: #networkstorage #### [networkStorage] Information regarding a piece of hardware's associated network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -1261,7 +1384,8 @@ Information regarding a piece of hardware's associated network storage service a [networkVlans]: #networkvlans #### [networkVlans] The network virtual LANs (VLANs) associated with a piece of hardware's network components. -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -1271,7 +1395,8 @@ The network virtual LANs (VLANs) associated with a piece of hardware's network c [nextBillingCycleBandwidthAllocation]: #nextbillingcyclebandwidthallocation #### [nextBillingCycleBandwidthAllocation] A hardware's allotted bandwidth for the next billing cycle (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -1281,7 +1406,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [notesHistory]: #noteshistory #### [notesHistory] -Type: **SoftLayer_Hardware_Note[] ** +Type: **SoftLayer_Hardware_Note[] ** + @@ -1291,7 +1417,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [nvRamCapacity]: #nvramcapacity #### [nvRamCapacity] The amount of non-volatile memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1301,7 +1428,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [nvRamComponentModels]: #nvramcomponentmodels #### [nvRamComponentModels] -Type: **SoftLayer_Hardware_Component_Model[] ** +Type: **SoftLayer_Hardware_Component_Model[] ** + @@ -1311,7 +1439,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [openCancellationTicket]: #opencancellationticket #### [openCancellationTicket] An open ticket requesting cancellation of this server, if one exists. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -1321,7 +1450,8 @@ An open ticket requesting cancellation of this server, if one exists. [operatingSystem]: #operatingsystem #### [operatingSystem] Information regarding a piece of hardware's operating system. -Type: **SoftLayer_Software_Component_OperatingSystem ** +Type: **SoftLayer_Software_Component_OperatingSystem ** + @@ -1331,7 +1461,8 @@ Information regarding a piece of hardware's operating system. [operatingSystemReferenceCode]: #operatingsystemreferencecode #### [operatingSystemReferenceCode] A hardware's operating system software description. -Type: **string** +Type: **string** + @@ -1341,7 +1472,8 @@ A hardware's operating system software description. [outboundBandwidthUsage]: #outboundbandwidthusage #### [outboundBandwidthUsage] The sum of all the outbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -1351,7 +1483,8 @@ The sum of all the outbound network traffic data for the last 30 days. [outboundPrivateBandwidthUsage]: #outboundprivatebandwidthusage #### [outboundPrivateBandwidthUsage] The total private outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -1361,7 +1494,8 @@ The total private outbound bandwidth for this hardware for the current billing c [outboundPublicBandwidthUsage]: #outboundpublicbandwidthusage #### [outboundPublicBandwidthUsage] The total public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -1371,7 +1505,8 @@ The total public outbound bandwidth for this hardware for the current billing cy [overBandwidthAllocationFlag]: #overbandwidthallocationflag #### [overBandwidthAllocationFlag] Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation. -Type: **integer** +Type: **integer** + @@ -1381,7 +1516,8 @@ Whether the bandwidth usage for this hardware for the current billing cycle exce [parentBay]: #parentbay #### [parentBay] Blade Bay -Type: **SoftLayer_Hardware_Blade ** +Type: **SoftLayer_Hardware_Blade ** + @@ -1391,7 +1527,8 @@ Blade Bay [parentHardware]: #parenthardware #### [parentHardware] Parent Hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1401,7 +1538,8 @@ Parent Hardware. [partitions]: #partitions #### [partitions] -Type: **SoftLayer_Hardware_Server_Partition[] ** +Type: **SoftLayer_Hardware_Server_Partition[] ** + @@ -1411,7 +1549,8 @@ Parent Hardware. [pointOfPresenceLocation]: #pointofpresencelocation #### [pointOfPresenceLocation] Information regarding the Point of Presence (PoP) location in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1421,7 +1560,8 @@ Information regarding the Point of Presence (PoP) location in which a piece of h [powerComponents]: #powercomponents #### [powerComponents] The power components for a hardware object. -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -1431,7 +1571,8 @@ The power components for a hardware object. [powerSupply]: #powersupply #### [powerSupply] A server's power supply. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1441,7 +1582,8 @@ A server's power supply. [primaryBackendIpAddress]: #primarybackendipaddress #### [primaryBackendIpAddress] The hardware's primary private IP address. -Type: **string** +Type: **string** + @@ -1451,7 +1593,8 @@ The hardware's primary private IP address. [primaryIpAddress]: #primaryipaddress #### [primaryIpAddress] The hardware's primary public IP address. -Type: **string** +Type: **string** + @@ -1461,7 +1604,8 @@ The hardware's primary public IP address. [privateIpAddress]: #privateipaddress #### [privateIpAddress] A server's primary private IP address. -Type: **string** +Type: **string** + @@ -1471,7 +1615,8 @@ A server's primary private IP address. [privateNetworkOnlyFlag]: #privatenetworkonlyflag #### [privateNetworkOnlyFlag] Whether the hardware only has access to the private network. -Type: **boolean** +Type: **boolean** + @@ -1481,7 +1626,8 @@ Whether the hardware only has access to the private network. [processorCoreAmount]: #processorcoreamount #### [processorCoreAmount] The total number of processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1491,7 +1637,8 @@ The total number of processor cores, summed from all processors that are attache [processorPhysicalCoreAmount]: #processorphysicalcoreamount #### [processorPhysicalCoreAmount] The total number of physical processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1501,7 +1648,8 @@ The total number of physical processor cores, summed from all processors that ar [processors]: #processors #### [processors] Information regarding a piece of hardware's processors. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1511,7 +1659,8 @@ Information regarding a piece of hardware's processors. [projectedOverBandwidthAllocationFlag]: #projectedoverbandwidthallocationflag #### [projectedOverBandwidthAllocationFlag] Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation. -Type: **integer** +Type: **integer** + @@ -1521,7 +1670,8 @@ Whether the bandwidth usage for this hardware for the current billing cycle is p [projectedPublicBandwidthUsage]: #projectedpublicbandwidthusage #### [projectedPublicBandwidthUsage] The projected public outbound bandwidth for this hardware for the current billing cycle. -Type: **float** +Type: **float** + @@ -1531,7 +1681,8 @@ The projected public outbound bandwidth for this hardware for the current billin [rack]: #rack #### [rack] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1541,7 +1692,8 @@ The projected public outbound bandwidth for this hardware for the current billin [raidControllers]: #raidcontrollers #### [raidControllers] The RAID controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1551,7 +1703,8 @@ The RAID controllers contained within a piece of hardware. [readyNodeFlag]: #readynodeflag #### [readyNodeFlag] Determine if hardware object is vSan Ready Node. -Type: **boolean** +Type: **boolean** + @@ -1561,7 +1714,8 @@ Determine if hardware object is vSan Ready Node. [recentEvents]: #recentevents #### [recentEvents] Recent events that impact this hardware. -Type: **SoftLayer_Notification_Occurrence_Event[] ** +Type: **SoftLayer_Notification_Occurrence_Event[] ** + @@ -1571,7 +1725,8 @@ Recent events that impact this hardware. [recentRemoteManagementCommands]: #recentremotemanagementcommands #### [recentRemoteManagementCommands] The last five commands issued to the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request[] ** + @@ -1581,7 +1736,8 @@ The last five commands issued to the server's remote management card. [regionalInternetRegistry]: #regionalinternetregistry #### [regionalInternetRegistry] -Type: **SoftLayer_Network_Regional_Internet_Registry ** +Type: **SoftLayer_Network_Regional_Internet_Registry ** + @@ -1591,7 +1747,8 @@ The last five commands issued to the server's remote management card. [remoteManagement]: #remotemanagement #### [remoteManagement] A server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement ** +Type: **SoftLayer_Hardware_Component_RemoteManagement ** + @@ -1601,7 +1758,8 @@ A server's remote management card. [remoteManagementAccounts]: #remotemanagementaccounts #### [remoteManagementAccounts] User credentials to issue commands and/or interact with the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** + @@ -1611,7 +1769,8 @@ User credentials to issue commands and/or interact with the server's remote mana [remoteManagementComponent]: #remotemanagementcomponent #### [remoteManagementComponent] A hardware's associated remote management component. This is normally IPMI. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1621,7 +1780,8 @@ A hardware's associated remote management component. This is normally IPMI. [remoteManagementUsers]: #remotemanagementusers #### [remoteManagementUsers] User(s) who have access to issue commands and/or interact with the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** + @@ -1631,7 +1791,8 @@ User(s) who have access to issue commands and/or interact with the server's remo [resourceConfigurations]: #resourceconfigurations #### [resourceConfigurations] -Type: **SoftLayer_Hardware_Resource_Configuration[] ** +Type: **SoftLayer_Hardware_Resource_Configuration[] ** + @@ -1641,7 +1802,8 @@ User(s) who have access to issue commands and/or interact with the server's remo [resourceGroupMemberReferences]: #resourcegroupmemberreferences #### [resourceGroupMemberReferences] -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -1651,7 +1813,8 @@ User(s) who have access to issue commands and/or interact with the server's remo [resourceGroupRoles]: #resourcegrouproles #### [resourceGroupRoles] -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -1661,7 +1824,8 @@ User(s) who have access to issue commands and/or interact with the server's remo [resourceGroups]: #resourcegroups #### [resourceGroups] The resource groups in which this hardware is a member. -Type: **SoftLayer_Resource_Group[] ** +Type: **SoftLayer_Resource_Group[] ** + @@ -1671,7 +1835,8 @@ The resource groups in which this hardware is a member. [routers]: #routers #### [routers] A hardware's routers. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1681,7 +1846,8 @@ A hardware's routers. [scaleAssets]: #scaleassets #### [scaleAssets] Collection of scale assets this hardware corresponds to. -Type: **SoftLayer_Scale_Asset[] ** +Type: **SoftLayer_Scale_Asset[] ** + @@ -1691,7 +1857,8 @@ Collection of scale assets this hardware corresponds to. [securityScanRequests]: #securityscanrequests #### [securityScanRequests] Information regarding a piece of hardware's vulnerability scan requests. -Type: **SoftLayer_Network_Security_Scanner_Request[] ** +Type: **SoftLayer_Network_Security_Scanner_Request[] ** + @@ -1701,7 +1868,8 @@ Information regarding a piece of hardware's vulnerability scan requests. [serverRoom]: #serverroom #### [serverRoom] Information regarding the server room in which the hardware is located. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1711,7 +1879,8 @@ Information regarding the server room in which the hardware is located. [serviceProvider]: #serviceprovider #### [serviceProvider] Information regarding the piece of hardware's service provider. -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -1721,7 +1890,8 @@ Information regarding the piece of hardware's service provider. [softwareComponents]: #softwarecomponents #### [softwareComponents] Information regarding a piece of hardware's installed software. -Type: **SoftLayer_Software_Component[] ** +Type: **SoftLayer_Software_Component[] ** + @@ -1731,7 +1901,8 @@ Information regarding a piece of hardware's installed software. [softwareGuardExtensionEnabled]: #softwareguardextensionenabled #### [softwareGuardExtensionEnabled] Determine if hardware object has Software Guard Extension (SGX) enabled. -Type: **boolean** +Type: **boolean** + @@ -1741,7 +1912,8 @@ Determine if hardware object has Software Guard Extension (SGX) enabled. [sshKeys]: #sshkeys #### [sshKeys] SSH keys to be installed on the server during provisioning or an OS reload. -Type: **SoftLayer_Security_Ssh_Key[] ** +Type: **SoftLayer_Security_Ssh_Key[] ** + @@ -1751,7 +1923,8 @@ SSH keys to be installed on the server during provisioning or an OS reload. [statisticsRemoteManagement]: #statisticsremotemanagement #### [statisticsRemoteManagement] A server's remote management card used for statistics. -Type: **SoftLayer_Hardware_Component_RemoteManagement ** +Type: **SoftLayer_Hardware_Component_RemoteManagement ** + @@ -1761,17 +1934,20 @@ A server's remote management card used for statistics. [storageGroups]: #storagegroups #### [storageGroups] -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + -
      +
      ----- [storageNetworkComponents]: #storagenetworkcomponents #### [storageNetworkComponents] A piece of hardware's private storage network components. [Deprecated] -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + +Deprecated
      @@ -1781,7 +1957,8 @@ A piece of hardware's private storage network components. [Deprecated] [tagReferences]: #tagreferences #### [tagReferences] -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** +
      @@ -1791,7 +1968,8 @@ A piece of hardware's private storage network components. [Deprecated] [topLevelLocation]: #toplevellocation #### [topLevelLocation] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1801,7 +1979,8 @@ A piece of hardware's private storage network components. [Deprecated] [uefiBootFlag]: #uefibootflag #### [uefiBootFlag] Whether to use UEFI boot instead of BIOS. -Type: **boolean** +Type: **boolean** + @@ -1811,7 +1990,8 @@ Whether to use UEFI boot instead of BIOS. [upgradeRequest]: #upgraderequest #### [upgradeRequest] An account's associated upgrade request object, if any. -Type: **SoftLayer_Product_Upgrade_Request ** +Type: **SoftLayer_Product_Upgrade_Request ** + @@ -1821,7 +2001,8 @@ An account's associated upgrade request object, if any. [uplinkHardware]: #uplinkhardware #### [uplinkHardware] The network device connected to a piece of hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1831,7 +2012,8 @@ The network device connected to a piece of hardware. [uplinkNetworkComponents]: #uplinknetworkcomponents #### [uplinkNetworkComponents] Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -1841,7 +2023,8 @@ Information regarding the network component that is one level higher than a piec [userData]: #userdata #### [userData] An array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -1851,7 +2034,8 @@ An array containing a single string of custom user data for a hardware order. Ma [users]: #users #### [users] A list of users that have access to this computing instance. -Type: **SoftLayer_User_Customer[] ** +Type: **SoftLayer_User_Customer[] ** + @@ -1861,7 +2045,8 @@ A list of users that have access to this computing instance. [virtualChassis]: #virtualchassis #### [virtualChassis] Information regarding the virtual chassis for a piece of hardware. -Type: **SoftLayer_Hardware_Group ** +Type: **SoftLayer_Hardware_Group ** + @@ -1871,7 +2056,8 @@ Information regarding the virtual chassis for a piece of hardware. [virtualChassisSiblings]: #virtualchassissiblings #### [virtualChassisSiblings] Information regarding the virtual chassis siblings for a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1881,7 +2067,8 @@ Information regarding the virtual chassis siblings for a piece of hardware. [virtualGuests]: #virtualguests #### [virtualGuests] A hardware server's virtual servers. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -1891,7 +2078,8 @@ A hardware server's virtual servers. [virtualHost]: #virtualhost #### [virtualHost] A piece of hardware's virtual host record. -Type: **SoftLayer_Virtual_Host ** +Type: **SoftLayer_Virtual_Host ** + @@ -1901,7 +2089,8 @@ A piece of hardware's virtual host record. [virtualLicenses]: #virtuallicenses #### [virtualLicenses] Information regarding a piece of hardware's virtual software licenses. -Type: **SoftLayer_Software_VirtualLicense[] ** +Type: **SoftLayer_Software_VirtualLicense[] ** + @@ -1911,7 +2100,8 @@ Information regarding a piece of hardware's virtual software licenses. [virtualRack]: #virtualrack #### [virtualRack] Information regarding the bandwidth allotment to which a piece of hardware belongs. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** + @@ -1921,7 +2111,8 @@ Information regarding the bandwidth allotment to which a piece of hardware belon [virtualRackId]: #virtualrackid #### [virtualRackId] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **integer** +Type: **integer** + @@ -1931,7 +2122,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualRackName]: #virtualrackname #### [virtualRackName] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **string** +Type: **string** + @@ -1941,7 +2133,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualizationPlatform]: #virtualizationplatform #### [virtualizationPlatform] A piece of hardware's virtualization platform software. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -1953,7 +2146,8 @@ A piece of hardware's virtualization platform software. [activeComponentCount]: #activecomponentcount #### [activeComponentCount] A count of a piece of hardware's active physical components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1963,7 +2157,8 @@ A count of a piece of hardware's active physical components. [activeNetworkMonitorIncidentCount]: #activenetworkmonitorincidentcount #### [activeNetworkMonitorIncidentCount] A count of a piece of hardware's active network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -1973,7 +2168,8 @@ A count of a piece of hardware's active network monitoring incidents. [activeTicketCount]: #activeticketcount #### [activeTicketCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1983,7 +2179,8 @@ A count of [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of any active transaction(s) that are currently running for the server (example: os reload). -Type: **unsigned long** +Type: **unsigned long** + @@ -1993,7 +2190,8 @@ A count of any active transaction(s) that are currently running for the server ( [allPowerComponentCount]: #allpowercomponentcount #### [allPowerComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2003,7 +2201,8 @@ A count of [allowedNetworkStorageCount]: #allowednetworkstoragecount #### [allowedNetworkStorageCount] A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -2013,7 +2212,8 @@ A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware ha [allowedNetworkStorageReplicaCount]: #allowednetworkstoragereplicacount #### [allowedNetworkStorageReplicaCount] A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -2023,7 +2223,8 @@ A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLay [attributeCount]: #attributecount #### [attributeCount] A count of information regarding a piece of hardware's specific attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -2033,7 +2234,8 @@ A count of information regarding a piece of hardware's specific attributes. [availableMonitoringCount]: #availablemonitoringcount #### [availableMonitoringCount] A count of an object that stores the maximum level for the monitoring query types and response types. -Type: **unsigned long** +Type: **unsigned long** + @@ -2043,7 +2245,8 @@ A count of an object that stores the maximum level for the monitoring query type [backendNetworkComponentCount]: #backendnetworkcomponentcount #### [backendNetworkComponentCount] A count of a piece of hardware's back-end or private network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -2053,7 +2256,8 @@ A count of a piece of hardware's back-end or private network components. [backendRouterCount]: #backendroutercount #### [backendRouterCount] A count of a hardware's backend or private router. -Type: **unsigned long** +Type: **unsigned long** + @@ -2063,7 +2267,8 @@ A count of a hardware's backend or private router. [benchmarkCertificationCount]: #benchmarkcertificationcount #### [benchmarkCertificationCount] A count of information regarding a piece of hardware's benchmark certifications. -Type: **unsigned long** +Type: **unsigned long** + @@ -2073,7 +2278,8 @@ A count of information regarding a piece of hardware's benchmark certifications. [billingCycleBandwidthUsageCount]: #billingcyclebandwidthusagecount #### [billingCycleBandwidthUsageCount] A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -2083,7 +2289,8 @@ A count of the raw bandwidth usage data for the current billing cycle. One objec [childrenHardwareCount]: #childrenhardwarecount #### [childrenHardwareCount] A count of child hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2093,7 +2300,8 @@ A count of child hardware. [componentCount]: #componentcount #### [componentCount] A count of a piece of hardware's components. -Type: **unsigned long** +Type: **unsigned long** + @@ -2103,7 +2311,8 @@ A count of a piece of hardware's components. [downlinkHardwareCount]: #downlinkhardwarecount #### [downlinkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2113,7 +2322,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkNetworkHardwareCount]: #downlinknetworkhardwarecount #### [downlinkNetworkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2123,7 +2333,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkServerCount]: #downlinkservercount #### [downlinkServerCount] A count of information regarding all servers attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2133,7 +2344,8 @@ A count of information regarding all servers attached to a piece of network hard [downlinkVirtualGuestCount]: #downlinkvirtualguestcount #### [downlinkVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2143,7 +2355,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [downstreamHardwareBindingCount]: #downstreamhardwarebindingcount #### [downstreamHardwareBindingCount] A count of all hardware downstream from a network device. -Type: **unsigned long** +Type: **unsigned long** + @@ -2153,7 +2366,8 @@ A count of all hardware downstream from a network device. [downstreamNetworkHardwareCount]: #downstreamnetworkhardwarecount #### [downstreamNetworkHardwareCount] A count of all network hardware downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2163,7 +2377,8 @@ A count of all network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidentCount]: #downstreamnetworkhardwarewithincidentcount #### [downstreamNetworkHardwareWithIncidentCount] A count of all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2173,7 +2388,8 @@ A count of all network hardware with monitoring warnings or errors that are down [downstreamServerCount]: #downstreamservercount #### [downstreamServerCount] A count of information regarding all servers attached downstream to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2183,7 +2399,8 @@ A count of information regarding all servers attached downstream to a piece of n [downstreamVirtualGuestCount]: #downstreamvirtualguestcount #### [downstreamVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2193,7 +2410,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [driveControllerCount]: #drivecontrollercount #### [driveControllerCount] A count of the drive controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2203,7 +2421,8 @@ A count of the drive controllers contained within a piece of hardware. [evaultNetworkStorageCount]: #evaultnetworkstoragecount #### [evaultNetworkStorageCount] A count of information regarding a piece of hardware's associated EVault network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -2213,7 +2432,8 @@ A count of information regarding a piece of hardware's associated EVault network [frontendNetworkComponentCount]: #frontendnetworkcomponentcount #### [frontendNetworkComponentCount] A count of a piece of hardware's front-end or public network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -2223,7 +2443,8 @@ A count of a piece of hardware's front-end or public network components. [frontendRouterCount]: #frontendroutercount #### [frontendRouterCount] A count of a hardware's frontend or public router. -Type: **unsigned long** +Type: **unsigned long** + @@ -2233,7 +2454,8 @@ A count of a hardware's frontend or public router. [hardDriveCount]: #harddrivecount #### [hardDriveCount] A count of the hard drives contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2243,7 +2465,8 @@ A count of the hard drives contained within a piece of hardware. [logicalVolumeStorageGroupCount]: #logicalvolumestoragegroupcount #### [logicalVolumeStorageGroupCount] A count of returns a list of logical volumes on the physical machine. -Type: **unsigned long** +Type: **unsigned long** + @@ -2253,7 +2476,8 @@ A count of returns a list of logical volumes on the physical machine. [memoryCount]: #memorycount #### [memoryCount] A count of information regarding a piece of hardware's memory. -Type: **unsigned long** +Type: **unsigned long** + @@ -2263,7 +2487,8 @@ A count of information regarding a piece of hardware's memory. [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2273,7 +2498,8 @@ A count of [monitoringUserNotificationCount]: #monitoringusernotificationcount #### [monitoringUserNotificationCount] A count of the monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails -Type: **unsigned long** +Type: **unsigned long** + @@ -2283,7 +2509,8 @@ A count of the monitoring notification objects for this hardware. Each object li [networkCardCount]: #networkcardcount #### [networkCardCount] A count of information regarding a piece of hardware's network cards. -Type: **unsigned long** +Type: **unsigned long** + @@ -2293,7 +2520,8 @@ A count of information regarding a piece of hardware's network cards. [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of returns a hardware's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -2303,7 +2531,8 @@ A count of returns a hardware's network components. [networkMonitorAttachedDownHardwareCount]: #networkmonitorattacheddownhardwarecount #### [networkMonitorAttachedDownHardwareCount] A count of all servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2313,7 +2542,8 @@ A count of all servers with failed monitoring that are attached downstream to a [networkMonitorAttachedDownVirtualGuestCount]: #networkmonitorattacheddownvirtualguestcount #### [networkMonitorAttachedDownVirtualGuestCount] A count of virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **unsigned long** +Type: **unsigned long** + @@ -2323,7 +2553,8 @@ A count of virtual guests that are attached downstream to a hardware that have f [networkMonitorCount]: #networkmonitorcount #### [networkMonitorCount] A count of information regarding a piece of hardware's network monitors. -Type: **unsigned long** +Type: **unsigned long** + @@ -2333,7 +2564,8 @@ A count of information regarding a piece of hardware's network monitors. [networkMonitorIncidentCount]: #networkmonitorincidentcount #### [networkMonitorIncidentCount] A count of the status of all of a piece of hardware's network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -2343,7 +2575,8 @@ A count of the status of all of a piece of hardware's network monitoring inciden [networkStorageCount]: #networkstoragecount #### [networkStorageCount] A count of information regarding a piece of hardware's associated network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -2353,7 +2586,8 @@ A count of information regarding a piece of hardware's associated network storag [networkVlanCount]: #networkvlancount #### [networkVlanCount] A count of the network virtual LANs (VLANs) associated with a piece of hardware's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -2363,7 +2597,8 @@ A count of the network virtual LANs (VLANs) associated with a piece of hardware' [notesHistoryCount]: #noteshistorycount #### [notesHistoryCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2373,7 +2608,8 @@ A count of [nvRamComponentModelCount]: #nvramcomponentmodelcount #### [nvRamComponentModelCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2383,7 +2619,8 @@ A count of [partitionCount]: #partitioncount #### [partitionCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2393,7 +2630,8 @@ A count of [powerComponentCount]: #powercomponentcount #### [powerComponentCount] A count of the power components for a hardware object. -Type: **unsigned long** +Type: **unsigned long** + @@ -2403,7 +2641,8 @@ A count of the power components for a hardware object. [powerSupplyCount]: #powersupplycount #### [powerSupplyCount] A count of a server's power supply. -Type: **unsigned long** +Type: **unsigned long** + @@ -2413,7 +2652,8 @@ A count of a server's power supply. [processorCount]: #processorcount #### [processorCount] A count of information regarding a piece of hardware's processors. -Type: **unsigned long** +Type: **unsigned long** + @@ -2423,7 +2663,8 @@ A count of information regarding a piece of hardware's processors. [raidControllerCount]: #raidcontrollercount #### [raidControllerCount] A count of the RAID controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2433,7 +2674,8 @@ A count of the RAID controllers contained within a piece of hardware. [recentEventCount]: #recenteventcount #### [recentEventCount] A count of recent events that impact this hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2443,7 +2685,8 @@ A count of recent events that impact this hardware. [recentRemoteManagementCommandCount]: #recentremotemanagementcommandcount #### [recentRemoteManagementCommandCount] A count of the last five commands issued to the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -2453,7 +2696,8 @@ A count of the last five commands issued to the server's remote management card. [remoteManagementAccountCount]: #remotemanagementaccountcount #### [remoteManagementAccountCount] A count of user credentials to issue commands and/or interact with the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -2463,7 +2707,8 @@ A count of user credentials to issue commands and/or interact with the server's [remoteManagementUserCount]: #remotemanagementusercount #### [remoteManagementUserCount] A count of user(s) who have access to issue commands and/or interact with the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -2473,7 +2718,8 @@ A count of user(s) who have access to issue commands and/or interact with the se [resourceConfigurationCount]: #resourceconfigurationcount #### [resourceConfigurationCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2483,7 +2729,8 @@ A count of [resourceGroupCount]: #resourcegroupcount #### [resourceGroupCount] A count of the resource groups in which this hardware is a member. -Type: **unsigned long** +Type: **unsigned long** + @@ -2493,7 +2740,8 @@ A count of the resource groups in which this hardware is a member. [resourceGroupMemberReferenceCount]: #resourcegroupmemberreferencecount #### [resourceGroupMemberReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2503,7 +2751,8 @@ A count of [resourceGroupRoleCount]: #resourcegrouprolecount #### [resourceGroupRoleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2513,7 +2762,8 @@ A count of [routerCount]: #routercount #### [routerCount] A count of a hardware's routers. -Type: **unsigned long** +Type: **unsigned long** + @@ -2523,7 +2773,8 @@ A count of a hardware's routers. [scaleAssetCount]: #scaleassetcount #### [scaleAssetCount] A count of collection of scale assets this hardware corresponds to. -Type: **unsigned long** +Type: **unsigned long** + @@ -2533,7 +2784,8 @@ A count of collection of scale assets this hardware corresponds to. [securityScanRequestCount]: #securityscanrequestcount #### [securityScanRequestCount] A count of information regarding a piece of hardware's vulnerability scan requests. -Type: **unsigned long** +Type: **unsigned long** + @@ -2543,7 +2795,8 @@ A count of information regarding a piece of hardware's vulnerability scan reques [softwareComponentCount]: #softwarecomponentcount #### [softwareComponentCount] A count of information regarding a piece of hardware's installed software. -Type: **unsigned long** +Type: **unsigned long** + @@ -2553,7 +2806,8 @@ A count of information regarding a piece of hardware's installed software. [sshKeyCount]: #sshkeycount #### [sshKeyCount] A count of sSH keys to be installed on the server during provisioning or an OS reload. -Type: **unsigned long** +Type: **unsigned long** + @@ -2563,7 +2817,8 @@ A count of sSH keys to be installed on the server during provisioning or an OS r [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2573,7 +2828,8 @@ A count of [storageNetworkComponentCount]: #storagenetworkcomponentcount #### [storageNetworkComponentCount] A count of a piece of hardware's private storage network components. [Deprecated] -Type: **unsigned long** +Type: **unsigned long** + @@ -2583,7 +2839,8 @@ A count of a piece of hardware's private storage network components. [Deprecated [tagReferenceCount]: #tagreferencecount #### [tagReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2593,7 +2850,8 @@ A count of [uplinkNetworkComponentCount]: #uplinknetworkcomponentcount #### [uplinkNetworkComponentCount] A count of information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **unsigned long** +Type: **unsigned long** + @@ -2603,7 +2861,8 @@ A count of information regarding the network component that is one level higher [userCount]: #usercount #### [userCount] A count of a list of users that have access to this computing instance. -Type: **unsigned long** +Type: **unsigned long** + @@ -2613,7 +2872,8 @@ A count of a list of users that have access to this computing instance. [userDataCount]: #userdatacount #### [userDataCount] A count of an array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **unsigned long** +Type: **unsigned long** + @@ -2623,7 +2883,8 @@ A count of an array containing a single string of custom user data for a hardwar [virtualChassisSiblingCount]: #virtualchassissiblingcount #### [virtualChassisSiblingCount] A count of information regarding the virtual chassis siblings for a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2633,7 +2894,8 @@ A count of information regarding the virtual chassis siblings for a piece of har [virtualGuestCount]: #virtualguestcount #### [virtualGuestCount] A count of a hardware server's virtual servers. -Type: **unsigned long** +Type: **unsigned long** + @@ -2643,7 +2905,8 @@ A count of a hardware server's virtual servers. [virtualLicenseCount]: #virtuallicensecount #### [virtualLicenseCount] A count of information regarding a piece of hardware's virtual software licenses. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Server/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Server/_index.md index 56e46c05c3..fe2cead66b 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Server/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Server/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Server data type contains general information relating to a single SoftLayer server. @@ -54,7 +56,8 @@ The SoftLayer_Hardware_Server data type contains general information relating to [accountId]: #accountid #### [accountId] A hardware's associated [SoftLayer_Account]({{}}) id. -Type: **integer** +Type: **integer** + @@ -64,7 +67,8 @@ A hardware's associated [SoftLayer_Account]({{Type: **integer** +Type: **integer** + @@ -74,7 +78,8 @@ When true, this flag specifies that a hardware is Bare Metal Server. Bare Metal [domain]: #domain #### [domain] A piece of hardware's local network domain name. -Type: **string** +Type: **string** + @@ -84,7 +89,8 @@ A piece of hardware's local network domain name. [fullyQualifiedDomainName]: #fullyqualifieddomainname #### [fullyQualifiedDomainName] A name reflecting the hostname and domain of the hardware. This is created from the combined values of the hardware's hostname and domain name automatically, and thus should not be edited directly. -Type: **string** +Type: **string** + @@ -94,7 +100,8 @@ A name reflecting the hostname and domain of the hardware. This is created from [hardwareStatusId]: #hardwarestatusid #### [hardwareStatusId] A number reflecting the state of a hardware -Type: **integer** +Type: **integer** + @@ -104,7 +111,8 @@ A number reflecting the state of a hardware [hostname]: #hostname #### [hostname] A hardware's hostname -Type: **string** +Type: **string** + @@ -114,7 +122,8 @@ A hardware's hostname [id]: #id #### [id] A hardware's internal identification number -Type: **integer** +Type: **integer** + @@ -124,7 +133,8 @@ A hardware's internal identification number [manufacturerSerialNumber]: #manufacturerserialnumber #### [manufacturerSerialNumber] A hardware's serial number that is supplied by the manufacturer. -Type: **string** +Type: **string** + @@ -134,7 +144,8 @@ A hardware's serial number that is supplied by the manufacturer. [notes]: #notes #### [notes] A small note about a piece of hardware to use at your discretion. -Type: **string** +Type: **string** + @@ -144,7 +155,8 @@ A small note about a piece of hardware to use at your discretion. [postInstallScriptUri]: #postinstallscripturi #### [postInstallScriptUri] URI of the script to be downloaded and executed after installation is complete. -Type: **string** +Type: **string** + @@ -154,7 +166,8 @@ URI of the script to be downloaded and executed after installation is complete. [provisionDate]: #provisiondate #### [provisionDate] -Type: **dateTime** +Type: **dateTime** + @@ -164,7 +177,8 @@ URI of the script to be downloaded and executed after installation is complete. [serialNumber]: #serialnumber #### [serialNumber] A hardware's serial number that is supplied by SoftLayer. -Type: **string** +Type: **string** + @@ -174,7 +188,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] -Type: **integer** +Type: **integer** + @@ -184,7 +199,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderResourceId]: #serviceproviderresourceid #### [serviceProviderResourceId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -200,7 +216,8 @@ A hardware's internal identification number at its service provider [account]: #account #### [account] The account associated with a piece of hardware. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -210,7 +227,8 @@ The account associated with a piece of hardware. [activeComponents]: #activecomponents #### [activeComponents] A piece of hardware's active physical components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -220,7 +238,8 @@ A piece of hardware's active physical components. [activeNetworkFirewallBillingItem]: #activenetworkfirewallbillingitem #### [activeNetworkFirewallBillingItem] The billing item for a server's attached network firewall. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -230,7 +249,8 @@ The billing item for a server's attached network firewall. [activeNetworkMonitorIncident]: #activenetworkmonitorincident #### [activeNetworkMonitorIncident] A piece of hardware's active network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -240,7 +260,8 @@ A piece of hardware's active network monitoring incidents. [activeTickets]: #activetickets #### [activeTickets] -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -250,7 +271,8 @@ A piece of hardware's active network monitoring incidents. [activeTransaction]: #activetransaction #### [activeTransaction] Transaction currently running for server. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -260,7 +282,8 @@ Transaction currently running for server. [activeTransactions]: #activetransactions #### [activeTransactions] Any active transaction(s) that are currently running for the server (example: os reload). -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + @@ -270,7 +293,8 @@ Any active transaction(s) that are currently running for the server (example: os [allPowerComponents]: #allpowercomponents #### [allPowerComponents] -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -280,7 +304,8 @@ Any active transaction(s) that are currently running for the server (example: os [allowedHost]: #allowedhost #### [allowedHost] The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. -Type: **SoftLayer_Network_Storage_Allowed_Host ** +Type: **SoftLayer_Network_Storage_Allowed_Host ** + @@ -290,7 +315,8 @@ The SoftLayer_Network_Storage_Allowed_Host information to connect this server to [allowedNetworkStorage]: #allowednetworkstorage #### [allowedNetworkStorage] The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -300,7 +326,8 @@ The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to [allowedNetworkStorageReplicas]: #allowednetworkstoragereplicas #### [allowedNetworkStorageReplicas] The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -310,7 +337,8 @@ The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware [antivirusSpywareSoftwareComponent]: #antivirusspywaresoftwarecomponent #### [antivirusSpywareSoftwareComponent] Information regarding an antivirus/spyware software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -320,7 +348,8 @@ Information regarding an antivirus/spyware software component object. [attributes]: #attributes #### [attributes] Information regarding a piece of hardware's specific attributes. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -330,7 +359,8 @@ Information regarding a piece of hardware's specific attributes. [availableMonitoring]: #availablemonitoring #### [availableMonitoring] An object that stores the maximum level for the monitoring query types and response types. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum[] ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum[] ** + @@ -340,7 +370,8 @@ An object that stores the maximum level for the monitoring query types and respo [averageDailyBandwidthUsage]: #averagedailybandwidthusage #### [averageDailyBandwidthUsage] The average daily total bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -350,7 +381,8 @@ The average daily total bandwidth usage for the current billing cycle. [averageDailyPrivateBandwidthUsage]: #averagedailyprivatebandwidthusage #### [averageDailyPrivateBandwidthUsage] The average daily private bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -360,7 +392,8 @@ The average daily private bandwidth usage for the current billing cycle. [averageDailyPublicBandwidthUsage]: #averagedailypublicbandwidthusage #### [averageDailyPublicBandwidthUsage] The average daily public bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -370,7 +403,8 @@ The average daily public bandwidth usage for the current billing cycle. [backendNetworkComponents]: #backendnetworkcomponents #### [backendNetworkComponents] A piece of hardware's back-end or private network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -380,7 +414,8 @@ A piece of hardware's back-end or private network components. [backendRouters]: #backendrouters #### [backendRouters] A hardware's backend or private router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -390,7 +425,8 @@ A hardware's backend or private router. [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] A hardware's allotted bandwidth (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -400,7 +436,8 @@ A hardware's allotted bandwidth (measured in GB). [bandwidthAllotmentDetail]: #bandwidthallotmentdetail #### [bandwidthAllotmentDetail] A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** + @@ -410,7 +447,8 @@ A hardware's allotted detail record. Allotment details link bandwidth allocation [benchmarkCertifications]: #benchmarkcertifications #### [benchmarkCertifications] Information regarding a piece of hardware's benchmark certifications. -Type: **SoftLayer_Hardware_Benchmark_Certification[] ** +Type: **SoftLayer_Hardware_Benchmark_Certification[] ** + @@ -420,7 +458,8 @@ Information regarding a piece of hardware's benchmark certifications. [billingCycleBandwidthUsage]: #billingcyclebandwidthusage #### [billingCycleBandwidthUsage] The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -430,7 +469,8 @@ The raw bandwidth usage data for the current billing cycle. One object will be r [billingCyclePrivateBandwidthUsage]: #billingcycleprivatebandwidthusage #### [billingCyclePrivateBandwidthUsage] The raw private bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage ** +Type: **SoftLayer_Network_Bandwidth_Usage ** + @@ -440,7 +480,8 @@ The raw private bandwidth usage data for the current billing cycle. [billingCyclePublicBandwidthUsage]: #billingcyclepublicbandwidthusage #### [billingCyclePublicBandwidthUsage] The raw public bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage ** +Type: **SoftLayer_Network_Bandwidth_Usage ** + @@ -450,7 +491,8 @@ The raw public bandwidth usage data for the current billing cycle. [billingItem]: #billingitem #### [billingItem] The billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -460,7 +502,8 @@ The billing item for a server. [billingItemFlag]: #billingitemflag #### [billingItemFlag] A flag indicating that a billing item exists. -Type: **boolean** +Type: **boolean** + @@ -470,7 +513,8 @@ A flag indicating that a billing item exists. [biosPasswordNullFlag]: #biospasswordnullflag #### [biosPasswordNullFlag] Determine if BIOS password should be left as null. -Type: **boolean** +Type: **boolean** + @@ -480,7 +524,8 @@ Determine if BIOS password should be left as null. [blockCancelBecauseDisconnectedFlag]: #blockcancelbecausedisconnectedflag #### [blockCancelBecauseDisconnectedFlag] Determines whether the hardware is ineligible for cancellation because it is disconnected. -Type: **boolean** +Type: **boolean** + @@ -490,7 +535,8 @@ Determines whether the hardware is ineligible for cancellation because it is dis [businessContinuanceInsuranceFlag]: #businesscontinuanceinsuranceflag #### [businessContinuanceInsuranceFlag] Status indicating whether or not a piece of hardware has business continuance insurance. -Type: **boolean** +Type: **boolean** + @@ -500,7 +546,8 @@ Status indicating whether or not a piece of hardware has business continuance in [captureEnabledFlag]: #captureenabledflag #### [captureEnabledFlag] Determine if the server is able to be image captured. If unable to image capture a reason will be provided. -Type: **SoftLayer_Container_Hardware_CaptureEnabled ** +Type: **SoftLayer_Container_Hardware_CaptureEnabled ** + @@ -510,7 +557,8 @@ Determine if the server is able to be image captured. If unable to image capture [childrenHardware]: #childrenhardware #### [childrenHardware] Child hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -520,7 +568,8 @@ Child hardware. [components]: #components #### [components] A piece of hardware's components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -530,7 +579,8 @@ A piece of hardware's components. [containsSolidStateDrivesFlag]: #containssolidstatedrivesflag #### [containsSolidStateDrivesFlag] -Type: **boolean** +Type: **boolean** + @@ -540,7 +590,8 @@ A piece of hardware's components. [continuousDataProtectionSoftwareComponent]: #continuousdataprotectionsoftwarecomponent #### [continuousDataProtectionSoftwareComponent] A continuous data protection/server backup software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -550,7 +601,8 @@ A continuous data protection/server backup software component object. [controlPanel]: #controlpanel #### [controlPanel] A server's control panel. -Type: **SoftLayer_Software_Component_ControlPanel ** +Type: **SoftLayer_Software_Component_ControlPanel ** + @@ -560,7 +612,8 @@ A server's control panel. [cost]: #cost #### [cost] The total cost of a server, measured in US Dollars ($USD). -Type: **float** +Type: **float** + @@ -570,7 +623,8 @@ The total cost of a server, measured in US Dollars ($USD). [currentBandwidthSummary]: #currentbandwidthsummary #### [currentBandwidthSummary] An object that provides commonly used bandwidth summary components for the current billing cycle. -Type: **SoftLayer_Metric_Tracking_Object_Bandwidth_Summary ** +Type: **SoftLayer_Metric_Tracking_Object_Bandwidth_Summary ** + @@ -580,7 +634,8 @@ An object that provides commonly used bandwidth summary components for the curre [currentBillableBandwidthUsage]: #currentbillablebandwidthusage #### [currentBillableBandwidthUsage] The current billable public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -590,7 +645,8 @@ The current billable public outbound bandwidth for this hardware for the current [customerInstalledOperatingSystemFlag]: #customerinstalledoperatingsystemflag #### [customerInstalledOperatingSystemFlag] Indicates if a server has a Customer Installed OS -Type: **boolean** +Type: **boolean** + @@ -600,7 +656,8 @@ Indicates if a server has a Customer Installed OS [customerOwnedFlag]: #customerownedflag #### [customerOwnedFlag] Indicates if a server is a customer owned device. -Type: **boolean** +Type: **boolean** + @@ -610,7 +667,8 @@ Indicates if a server is a customer owned device. [datacenter]: #datacenter #### [datacenter] Information regarding the datacenter in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -620,7 +678,8 @@ Information regarding the datacenter in which a piece of hardware resides. [datacenterName]: #datacentername #### [datacenterName] The name of the datacenter in which a piece of hardware resides. -Type: **string** +Type: **string** + @@ -630,7 +689,8 @@ The name of the datacenter in which a piece of hardware resides. [daysInSparePool]: #daysinsparepool #### [daysInSparePool] Number of day(s) a server have been in spare pool. -Type: **integer** +Type: **integer** + @@ -640,7 +700,8 @@ Number of day(s) a server have been in spare pool. [downlinkHardware]: #downlinkhardware #### [downlinkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -650,7 +711,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkNetworkHardware]: #downlinknetworkhardware #### [downlinkNetworkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -660,7 +722,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkServers]: #downlinkservers #### [downlinkServers] Information regarding all servers attached to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -670,7 +733,8 @@ Information regarding all servers attached to a piece of network hardware. [downlinkVirtualGuests]: #downlinkvirtualguests #### [downlinkVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -680,7 +744,8 @@ Information regarding all virtual guests attached to a piece of network hardware [downstreamHardwareBindings]: #downstreamhardwarebindings #### [downstreamHardwareBindings] All hardware downstream from a network device. -Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** +Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** + @@ -690,7 +755,8 @@ All hardware downstream from a network device. [downstreamNetworkHardware]: #downstreamnetworkhardware #### [downstreamNetworkHardware] All network hardware downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -700,7 +766,8 @@ All network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidents]: #downstreamnetworkhardwarewithincidents #### [downstreamNetworkHardwareWithIncidents] All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -710,7 +777,8 @@ All network hardware with monitoring warnings or errors that are downstream from [downstreamServers]: #downstreamservers #### [downstreamServers] Information regarding all servers attached downstream to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -720,7 +788,8 @@ Information regarding all servers attached downstream to a piece of network hard [downstreamVirtualGuests]: #downstreamvirtualguests #### [downstreamVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -730,7 +799,8 @@ Information regarding all virtual guests attached to a piece of network hardware [driveControllers]: #drivecontrollers #### [driveControllers] The drive controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -740,7 +810,8 @@ The drive controllers contained within a piece of hardware. [evaultNetworkStorage]: #evaultnetworkstorage #### [evaultNetworkStorage] Information regarding a piece of hardware's associated EVault network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -750,7 +821,8 @@ Information regarding a piece of hardware's associated EVault network storage se [firewallServiceComponent]: #firewallservicecomponent #### [firewallServiceComponent] Information regarding a piece of hardware's firewall services. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -760,7 +832,8 @@ Information regarding a piece of hardware's firewall services. [fixedConfigurationPreset]: #fixedconfigurationpreset #### [fixedConfigurationPreset] Defines the fixed components in a fixed configuration bare metal server. -Type: **SoftLayer_Product_Package_Preset ** +Type: **SoftLayer_Product_Package_Preset ** + @@ -770,7 +843,8 @@ Defines the fixed components in a fixed configuration bare metal server. [frontendNetworkComponents]: #frontendnetworkcomponents #### [frontendNetworkComponents] A piece of hardware's front-end or public network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -780,7 +854,8 @@ A piece of hardware's front-end or public network components. [frontendRouters]: #frontendrouters #### [frontendRouters] A hardware's frontend or public router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -790,7 +865,8 @@ A hardware's frontend or public router. [futureBillingItem]: #futurebillingitem #### [futureBillingItem] Information regarding the future billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -800,7 +876,8 @@ Information regarding the future billing item for a server. [globalIdentifier]: #globalidentifier #### [globalIdentifier] A hardware's universally unique identifier. -Type: **string** +Type: **string** + @@ -810,7 +887,8 @@ A hardware's universally unique identifier. [hardDrives]: #harddrives #### [hardDrives] The hard drives contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -820,7 +898,8 @@ The hard drives contained within a piece of hardware. [hardwareChassis]: #hardwarechassis #### [hardwareChassis] The chassis that a piece of hardware is housed in. -Type: **SoftLayer_Hardware_Chassis ** +Type: **SoftLayer_Hardware_Chassis ** + @@ -830,7 +909,8 @@ The chassis that a piece of hardware is housed in. [hardwareFunction]: #hardwarefunction #### [hardwareFunction] A hardware's function. -Type: **SoftLayer_Hardware_Function ** +Type: **SoftLayer_Hardware_Function ** + @@ -840,7 +920,8 @@ A hardware's function. [hardwareFunctionDescription]: #hardwarefunctiondescription #### [hardwareFunctionDescription] A hardware's function. -Type: **string** +Type: **string** + @@ -850,7 +931,8 @@ A hardware's function. [hardwareStatus]: #hardwarestatus #### [hardwareStatus] A hardware's status. -Type: **SoftLayer_Hardware_Status ** +Type: **SoftLayer_Hardware_Status ** + @@ -860,7 +942,8 @@ A hardware's status. [hasSingleRootVirtualizationBillingItemFlag]: #hassinglerootvirtualizationbillingitemflag #### [hasSingleRootVirtualizationBillingItemFlag] Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item. -Type: **boolean** +Type: **boolean** + @@ -870,7 +953,8 @@ Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item. [hasTrustedPlatformModuleBillingItemFlag]: #hastrustedplatformmodulebillingitemflag #### [hasTrustedPlatformModuleBillingItemFlag] Determine in hardware object has TPM enabled. -Type: **boolean** +Type: **boolean** + @@ -880,7 +964,8 @@ Determine in hardware object has TPM enabled. [hostIpsSoftwareComponent]: #hostipssoftwarecomponent #### [hostIpsSoftwareComponent] Information regarding a host IPS software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -890,7 +975,8 @@ Information regarding a host IPS software component object. [hourlyBillingFlag]: #hourlybillingflag #### [hourlyBillingFlag] A server's hourly billing status. -Type: **boolean** +Type: **boolean** + @@ -900,7 +986,8 @@ A server's hourly billing status. [inboundBandwidthUsage]: #inboundbandwidthusage #### [inboundBandwidthUsage] The sum of all the inbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -910,7 +997,8 @@ The sum of all the inbound network traffic data for the last 30 days. [inboundPrivateBandwidthUsage]: #inboundprivatebandwidthusage #### [inboundPrivateBandwidthUsage] The total private inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -920,7 +1008,8 @@ The total private inbound bandwidth for this hardware for the current billing cy [inboundPublicBandwidthUsage]: #inboundpublicbandwidthusage #### [inboundPublicBandwidthUsage] The total public inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -930,7 +1019,8 @@ The total public inbound bandwidth for this hardware for the current billing cyc [isBillingTermChangeAvailableFlag]: #isbillingtermchangeavailableflag #### [isBillingTermChangeAvailableFlag] Whether or not this hardware object is eligible to change to term billing. -Type: **boolean** +Type: **boolean** + @@ -940,7 +1030,8 @@ Whether or not this hardware object is eligible to change to term billing. [isCloudReadyNodeCertified]: #iscloudreadynodecertified #### [isCloudReadyNodeCertified] Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute. -Type: **boolean** +Type: **boolean** + @@ -950,7 +1041,8 @@ Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute. [isIpmiDisabled]: #isipmidisabled #### [isIpmiDisabled] Determine if remote management has been disabled due to port speed. -Type: **boolean** +Type: **boolean** + @@ -960,7 +1052,8 @@ Determine if remote management has been disabled due to port speed. [isVirtualPrivateCloudNode]: #isvirtualprivatecloudnode #### [isVirtualPrivateCloudNode] Determine if hardware object is a Virtual Private Cloud node. -Type: **boolean** +Type: **boolean** + @@ -970,7 +1063,8 @@ Determine if hardware object is a Virtual Private Cloud node. [lastOperatingSystemReload]: #lastoperatingsystemreload #### [lastOperatingSystemReload] The last transaction that a server's operating system was loaded. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -980,7 +1074,8 @@ The last transaction that a server's operating system was loaded. [lastTransaction]: #lasttransaction #### [lastTransaction] Information regarding the last transaction a server performed. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -990,7 +1085,8 @@ Information regarding the last transaction a server performed. [latestNetworkMonitorIncident]: #latestnetworkmonitorincident #### [latestNetworkMonitorIncident] A piece of hardware's latest network monitoring incident. -Type: **SoftLayer_Network_Monitor_Version1_Incident ** +Type: **SoftLayer_Network_Monitor_Version1_Incident ** + @@ -1000,7 +1096,8 @@ A piece of hardware's latest network monitoring incident. [location]: #location #### [location] Where a piece of hardware is located within SoftLayer's location hierarchy. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1010,7 +1107,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [locationPathString]: #locationpathstring #### [locationPathString] -Type: **string** +Type: **string** + @@ -1020,7 +1118,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [lockboxNetworkStorage]: #lockboxnetworkstorage #### [lockboxNetworkStorage] Information regarding a lockbox account associated with a server. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -1030,7 +1129,8 @@ Information regarding a lockbox account associated with a server. [logicalVolumeStorageGroups]: #logicalvolumestoragegroups #### [logicalVolumeStorageGroups] Returns a list of logical volumes on the physical machine. -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + @@ -1040,7 +1140,8 @@ Returns a list of logical volumes on the physical machine. [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the hardware is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -1050,7 +1151,8 @@ A flag indicating that the hardware is a managed resource. [memory]: #memory #### [memory] Information regarding a piece of hardware's memory. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1060,7 +1162,8 @@ Information regarding a piece of hardware's memory. [memoryCapacity]: #memorycapacity #### [memoryCapacity] The amount of memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1070,7 +1173,8 @@ The amount of memory a piece of hardware has, measured in gigabytes. [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A piece of hardware's metric tracking object. -Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** +Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** + @@ -1080,7 +1184,8 @@ A piece of hardware's metric tracking object. [metricTrackingObjectId]: #metrictrackingobjectid #### [metricTrackingObjectId] The metric tracking object id for this server. -Type: **integer** +Type: **integer** + @@ -1090,7 +1195,8 @@ The metric tracking object id for this server. [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1100,7 +1206,8 @@ The metric tracking object id for this server. [monitoringRobot]: #monitoringrobot #### [monitoringRobot] -Type: **SoftLayer_Monitoring_Robot ** +Type: **SoftLayer_Monitoring_Robot ** + @@ -1110,7 +1217,8 @@ The metric tracking object id for this server. [monitoringServiceComponent]: #monitoringservicecomponent #### [monitoringServiceComponent] Information regarding a piece of hardware's network monitoring services. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** + @@ -1120,7 +1228,8 @@ Information regarding a piece of hardware's network monitoring services. [monitoringServiceEligibilityFlag]: #monitoringserviceeligibilityflag #### [monitoringServiceEligibilityFlag] -Type: **boolean** +Type: **boolean** + @@ -1130,7 +1239,8 @@ Information regarding a piece of hardware's network monitoring services. [monitoringUserNotification]: #monitoringusernotification #### [monitoringUserNotification] The monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails -Type: **SoftLayer_User_Customer_Notification_Hardware[] ** +Type: **SoftLayer_User_Customer_Notification_Hardware[] ** + @@ -1140,7 +1250,8 @@ The monitoring notification objects for this hardware. Each object links this ha [motherboard]: #motherboard #### [motherboard] A server's motherboard. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -1150,7 +1261,8 @@ A server's motherboard. [networkCards]: #networkcards #### [networkCards] Information regarding a piece of hardware's network cards. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1160,7 +1272,8 @@ Information regarding a piece of hardware's network cards. [networkComponents]: #networkcomponents #### [networkComponents] Returns a hardware's network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -1170,7 +1283,8 @@ Returns a hardware's network components. [networkGatewayMember]: #networkgatewaymember #### [networkGatewayMember] The gateway member if this device is part of a network gateway. -Type: **SoftLayer_Network_Gateway_Member ** +Type: **SoftLayer_Network_Gateway_Member ** + @@ -1180,7 +1294,8 @@ The gateway member if this device is part of a network gateway. [networkGatewayMemberFlag]: #networkgatewaymemberflag #### [networkGatewayMemberFlag] Whether or not this device is part of a network gateway. -Type: **boolean** +Type: **boolean** + @@ -1190,7 +1305,8 @@ Whether or not this device is part of a network gateway. [networkManagementIpAddress]: #networkmanagementipaddress #### [networkManagementIpAddress] A piece of hardware's network management IP address. -Type: **string** +Type: **string** + @@ -1200,7 +1316,8 @@ A piece of hardware's network management IP address. [networkMonitorAttachedDownHardware]: #networkmonitorattacheddownhardware #### [networkMonitorAttachedDownHardware] All servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1210,7 +1327,8 @@ All servers with failed monitoring that are attached downstream to a piece of ha [networkMonitorAttachedDownVirtualGuests]: #networkmonitorattacheddownvirtualguests #### [networkMonitorAttachedDownVirtualGuests] Virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -1220,7 +1338,8 @@ Virtual guests that are attached downstream to a hardware that have failed monit [networkMonitorIncidents]: #networkmonitorincidents #### [networkMonitorIncidents] The status of all of a piece of hardware's network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -1230,7 +1349,8 @@ The status of all of a piece of hardware's network monitoring incidents. [networkMonitors]: #networkmonitors #### [networkMonitors] Information regarding a piece of hardware's network monitors. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** + @@ -1240,7 +1360,8 @@ Information regarding a piece of hardware's network monitors. [networkStatus]: #networkstatus #### [networkStatus] The value of a hardware's network status attribute. -Type: **string** +Type: **string** + @@ -1250,7 +1371,8 @@ The value of a hardware's network status attribute. [networkStatusAttribute]: #networkstatusattribute #### [networkStatusAttribute] The hardware's related network status attribute. -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -1260,7 +1382,8 @@ The hardware's related network status attribute. [networkStorage]: #networkstorage #### [networkStorage] Information regarding a piece of hardware's associated network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -1270,7 +1393,8 @@ Information regarding a piece of hardware's associated network storage service a [networkVlans]: #networkvlans #### [networkVlans] The network virtual LANs (VLANs) associated with a piece of hardware's network components. -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -1280,7 +1404,8 @@ The network virtual LANs (VLANs) associated with a piece of hardware's network c [nextBillingCycleBandwidthAllocation]: #nextbillingcyclebandwidthallocation #### [nextBillingCycleBandwidthAllocation] A hardware's allotted bandwidth for the next billing cycle (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -1290,7 +1415,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [notesHistory]: #noteshistory #### [notesHistory] -Type: **SoftLayer_Hardware_Note[] ** +Type: **SoftLayer_Hardware_Note[] ** + @@ -1300,7 +1426,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [nvRamCapacity]: #nvramcapacity #### [nvRamCapacity] The amount of non-volatile memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1310,7 +1437,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [nvRamComponentModels]: #nvramcomponentmodels #### [nvRamComponentModels] -Type: **SoftLayer_Hardware_Component_Model[] ** +Type: **SoftLayer_Hardware_Component_Model[] ** + @@ -1320,7 +1448,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [openCancellationTicket]: #opencancellationticket #### [openCancellationTicket] An open ticket requesting cancellation of this server, if one exists. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -1330,7 +1459,8 @@ An open ticket requesting cancellation of this server, if one exists. [operatingSystem]: #operatingsystem #### [operatingSystem] Information regarding a piece of hardware's operating system. -Type: **SoftLayer_Software_Component_OperatingSystem ** +Type: **SoftLayer_Software_Component_OperatingSystem ** + @@ -1340,7 +1470,8 @@ Information regarding a piece of hardware's operating system. [operatingSystemReferenceCode]: #operatingsystemreferencecode #### [operatingSystemReferenceCode] A hardware's operating system software description. -Type: **string** +Type: **string** + @@ -1350,7 +1481,8 @@ A hardware's operating system software description. [outboundBandwidthUsage]: #outboundbandwidthusage #### [outboundBandwidthUsage] The sum of all the outbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -1360,7 +1492,8 @@ The sum of all the outbound network traffic data for the last 30 days. [outboundPrivateBandwidthUsage]: #outboundprivatebandwidthusage #### [outboundPrivateBandwidthUsage] The total private outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -1370,7 +1503,8 @@ The total private outbound bandwidth for this hardware for the current billing c [outboundPublicBandwidthUsage]: #outboundpublicbandwidthusage #### [outboundPublicBandwidthUsage] The total public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -1380,7 +1514,8 @@ The total public outbound bandwidth for this hardware for the current billing cy [overBandwidthAllocationFlag]: #overbandwidthallocationflag #### [overBandwidthAllocationFlag] Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation. -Type: **integer** +Type: **integer** + @@ -1390,7 +1525,8 @@ Whether the bandwidth usage for this hardware for the current billing cycle exce [parentBay]: #parentbay #### [parentBay] Blade Bay -Type: **SoftLayer_Hardware_Blade ** +Type: **SoftLayer_Hardware_Blade ** + @@ -1400,7 +1536,8 @@ Blade Bay [parentHardware]: #parenthardware #### [parentHardware] Parent Hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1410,7 +1547,8 @@ Parent Hardware. [partitions]: #partitions #### [partitions] -Type: **SoftLayer_Hardware_Server_Partition[] ** +Type: **SoftLayer_Hardware_Server_Partition[] ** + @@ -1420,7 +1558,8 @@ Parent Hardware. [pointOfPresenceLocation]: #pointofpresencelocation #### [pointOfPresenceLocation] Information regarding the Point of Presence (PoP) location in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1430,7 +1569,8 @@ Information regarding the Point of Presence (PoP) location in which a piece of h [powerComponents]: #powercomponents #### [powerComponents] The power components for a hardware object. -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -1440,7 +1580,8 @@ The power components for a hardware object. [powerSupply]: #powersupply #### [powerSupply] A server's power supply. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1450,7 +1591,8 @@ A server's power supply. [primaryBackendIpAddress]: #primarybackendipaddress #### [primaryBackendIpAddress] The hardware's primary private IP address. -Type: **string** +Type: **string** + @@ -1460,7 +1602,8 @@ The hardware's primary private IP address. [primaryBackendNetworkComponent]: #primarybackendnetworkcomponent #### [primaryBackendNetworkComponent] Information regarding the hardware's primary back-end network component. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1470,7 +1613,8 @@ Information regarding the hardware's primary back-end network component. [primaryIpAddress]: #primaryipaddress #### [primaryIpAddress] The hardware's primary public IP address. -Type: **string** +Type: **string** + @@ -1480,7 +1624,8 @@ The hardware's primary public IP address. [primaryNetworkComponent]: #primarynetworkcomponent #### [primaryNetworkComponent] Information regarding the hardware's primary public network component. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1490,7 +1635,8 @@ Information regarding the hardware's primary public network component. [privateIpAddress]: #privateipaddress #### [privateIpAddress] A server's primary private IP address. -Type: **string** +Type: **string** + @@ -1500,7 +1646,8 @@ A server's primary private IP address. [privateNetworkOnlyFlag]: #privatenetworkonlyflag #### [privateNetworkOnlyFlag] Whether the hardware only has access to the private network. -Type: **boolean** +Type: **boolean** + @@ -1510,7 +1657,8 @@ Whether the hardware only has access to the private network. [processorCoreAmount]: #processorcoreamount #### [processorCoreAmount] The total number of processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1520,7 +1668,8 @@ The total number of processor cores, summed from all processors that are attache [processorPhysicalCoreAmount]: #processorphysicalcoreamount #### [processorPhysicalCoreAmount] The total number of physical processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1530,7 +1679,8 @@ The total number of physical processor cores, summed from all processors that ar [processors]: #processors #### [processors] Information regarding a piece of hardware's processors. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1540,7 +1690,8 @@ Information regarding a piece of hardware's processors. [projectedOverBandwidthAllocationFlag]: #projectedoverbandwidthallocationflag #### [projectedOverBandwidthAllocationFlag] Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation. -Type: **integer** +Type: **integer** + @@ -1550,7 +1701,8 @@ Whether the bandwidth usage for this hardware for the current billing cycle is p [projectedPublicBandwidthUsage]: #projectedpublicbandwidthusage #### [projectedPublicBandwidthUsage] The projected public outbound bandwidth for this hardware for the current billing cycle. -Type: **float** +Type: **float** + @@ -1560,7 +1712,8 @@ The projected public outbound bandwidth for this hardware for the current billin [rack]: #rack #### [rack] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1570,7 +1723,8 @@ The projected public outbound bandwidth for this hardware for the current billin [raidControllers]: #raidcontrollers #### [raidControllers] The RAID controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1580,7 +1734,8 @@ The RAID controllers contained within a piece of hardware. [readyNodeFlag]: #readynodeflag #### [readyNodeFlag] Determine if hardware object is vSan Ready Node. -Type: **boolean** +Type: **boolean** + @@ -1590,7 +1745,8 @@ Determine if hardware object is vSan Ready Node. [recentEvents]: #recentevents #### [recentEvents] Recent events that impact this hardware. -Type: **SoftLayer_Notification_Occurrence_Event[] ** +Type: **SoftLayer_Notification_Occurrence_Event[] ** + @@ -1600,7 +1756,8 @@ Recent events that impact this hardware. [recentRemoteManagementCommands]: #recentremotemanagementcommands #### [recentRemoteManagementCommands] The last five commands issued to the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request[] ** + @@ -1610,7 +1767,8 @@ The last five commands issued to the server's remote management card. [regionalInternetRegistry]: #regionalinternetregistry #### [regionalInternetRegistry] -Type: **SoftLayer_Network_Regional_Internet_Registry ** +Type: **SoftLayer_Network_Regional_Internet_Registry ** + @@ -1620,7 +1778,8 @@ The last five commands issued to the server's remote management card. [remoteManagement]: #remotemanagement #### [remoteManagement] A server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement ** +Type: **SoftLayer_Hardware_Component_RemoteManagement ** + @@ -1630,7 +1789,8 @@ A server's remote management card. [remoteManagementAccounts]: #remotemanagementaccounts #### [remoteManagementAccounts] User credentials to issue commands and/or interact with the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** + @@ -1640,7 +1800,8 @@ User credentials to issue commands and/or interact with the server's remote mana [remoteManagementComponent]: #remotemanagementcomponent #### [remoteManagementComponent] A hardware's associated remote management component. This is normally IPMI. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1650,7 +1811,8 @@ A hardware's associated remote management component. This is normally IPMI. [remoteManagementUsers]: #remotemanagementusers #### [remoteManagementUsers] User(s) who have access to issue commands and/or interact with the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** + @@ -1660,7 +1822,8 @@ User(s) who have access to issue commands and/or interact with the server's remo [resourceConfigurations]: #resourceconfigurations #### [resourceConfigurations] -Type: **SoftLayer_Hardware_Resource_Configuration[] ** +Type: **SoftLayer_Hardware_Resource_Configuration[] ** + @@ -1670,7 +1833,8 @@ User(s) who have access to issue commands and/or interact with the server's remo [resourceGroupMemberReferences]: #resourcegroupmemberreferences #### [resourceGroupMemberReferences] -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -1680,7 +1844,8 @@ User(s) who have access to issue commands and/or interact with the server's remo [resourceGroupRoles]: #resourcegrouproles #### [resourceGroupRoles] -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -1690,7 +1855,8 @@ User(s) who have access to issue commands and/or interact with the server's remo [resourceGroups]: #resourcegroups #### [resourceGroups] The resource groups in which this hardware is a member. -Type: **SoftLayer_Resource_Group[] ** +Type: **SoftLayer_Resource_Group[] ** + @@ -1700,7 +1866,8 @@ The resource groups in which this hardware is a member. [routers]: #routers #### [routers] A hardware's routers. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1710,7 +1877,8 @@ A hardware's routers. [scaleAssets]: #scaleassets #### [scaleAssets] Collection of scale assets this hardware corresponds to. -Type: **SoftLayer_Scale_Asset[] ** +Type: **SoftLayer_Scale_Asset[] ** + @@ -1720,7 +1888,8 @@ Collection of scale assets this hardware corresponds to. [securityScanRequests]: #securityscanrequests #### [securityScanRequests] Information regarding a piece of hardware's vulnerability scan requests. -Type: **SoftLayer_Network_Security_Scanner_Request[] ** +Type: **SoftLayer_Network_Security_Scanner_Request[] ** + @@ -1730,7 +1899,8 @@ Information regarding a piece of hardware's vulnerability scan requests. [serverRoom]: #serverroom #### [serverRoom] Information regarding the server room in which the hardware is located. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1740,7 +1910,8 @@ Information regarding the server room in which the hardware is located. [serviceProvider]: #serviceprovider #### [serviceProvider] Information regarding the piece of hardware's service provider. -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -1750,7 +1921,8 @@ Information regarding the piece of hardware's service provider. [softwareComponents]: #softwarecomponents #### [softwareComponents] Information regarding a piece of hardware's installed software. -Type: **SoftLayer_Software_Component[] ** +Type: **SoftLayer_Software_Component[] ** + @@ -1760,7 +1932,8 @@ Information regarding a piece of hardware's installed software. [softwareGuardExtensionEnabled]: #softwareguardextensionenabled #### [softwareGuardExtensionEnabled] Determine if hardware object has Software Guard Extension (SGX) enabled. -Type: **boolean** +Type: **boolean** + @@ -1770,7 +1943,8 @@ Determine if hardware object has Software Guard Extension (SGX) enabled. [sshKeys]: #sshkeys #### [sshKeys] SSH keys to be installed on the server during provisioning or an OS reload. -Type: **SoftLayer_Security_Ssh_Key[] ** +Type: **SoftLayer_Security_Ssh_Key[] ** + @@ -1780,7 +1954,8 @@ SSH keys to be installed on the server during provisioning or an OS reload. [statisticsRemoteManagement]: #statisticsremotemanagement #### [statisticsRemoteManagement] A server's remote management card used for statistics. -Type: **SoftLayer_Hardware_Component_RemoteManagement ** +Type: **SoftLayer_Hardware_Component_RemoteManagement ** + @@ -1790,17 +1965,20 @@ A server's remote management card used for statistics. [storageGroups]: #storagegroups #### [storageGroups] -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + -
      +
      ----- [storageNetworkComponents]: #storagenetworkcomponents #### [storageNetworkComponents] A piece of hardware's private storage network components. [Deprecated] -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + +Deprecated
      @@ -1810,7 +1988,8 @@ A piece of hardware's private storage network components. [Deprecated] [tagReferences]: #tagreferences #### [tagReferences] -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** +
      @@ -1820,7 +1999,8 @@ A piece of hardware's private storage network components. [Deprecated] [topLevelLocation]: #toplevellocation #### [topLevelLocation] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1830,7 +2010,8 @@ A piece of hardware's private storage network components. [Deprecated] [uefiBootFlag]: #uefibootflag #### [uefiBootFlag] Whether to use UEFI boot instead of BIOS. -Type: **boolean** +Type: **boolean** + @@ -1840,7 +2021,8 @@ Whether to use UEFI boot instead of BIOS. [upgradeRequest]: #upgraderequest #### [upgradeRequest] An account's associated upgrade request object, if any. -Type: **SoftLayer_Product_Upgrade_Request ** +Type: **SoftLayer_Product_Upgrade_Request ** + @@ -1850,7 +2032,8 @@ An account's associated upgrade request object, if any. [uplinkHardware]: #uplinkhardware #### [uplinkHardware] The network device connected to a piece of hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1860,7 +2043,8 @@ The network device connected to a piece of hardware. [uplinkNetworkComponents]: #uplinknetworkcomponents #### [uplinkNetworkComponents] Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -1870,7 +2054,8 @@ Information regarding the network component that is one level higher than a piec [userData]: #userdata #### [userData] An array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -1880,7 +2065,8 @@ An array containing a single string of custom user data for a hardware order. Ma [users]: #users #### [users] A list of users that have access to this computing instance. -Type: **SoftLayer_User_Customer[] ** +Type: **SoftLayer_User_Customer[] ** + @@ -1890,7 +2076,8 @@ A list of users that have access to this computing instance. [virtualChassis]: #virtualchassis #### [virtualChassis] Information regarding the virtual chassis for a piece of hardware. -Type: **SoftLayer_Hardware_Group ** +Type: **SoftLayer_Hardware_Group ** + @@ -1900,7 +2087,8 @@ Information regarding the virtual chassis for a piece of hardware. [virtualChassisSiblings]: #virtualchassissiblings #### [virtualChassisSiblings] Information regarding the virtual chassis siblings for a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1910,7 +2098,8 @@ Information regarding the virtual chassis siblings for a piece of hardware. [virtualGuests]: #virtualguests #### [virtualGuests] A hardware server's virtual servers. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -1920,7 +2109,8 @@ A hardware server's virtual servers. [virtualHost]: #virtualhost #### [virtualHost] A piece of hardware's virtual host record. -Type: **SoftLayer_Virtual_Host ** +Type: **SoftLayer_Virtual_Host ** + @@ -1930,7 +2120,8 @@ A piece of hardware's virtual host record. [virtualLicenses]: #virtuallicenses #### [virtualLicenses] Information regarding a piece of hardware's virtual software licenses. -Type: **SoftLayer_Software_VirtualLicense[] ** +Type: **SoftLayer_Software_VirtualLicense[] ** + @@ -1940,7 +2131,8 @@ Information regarding a piece of hardware's virtual software licenses. [virtualRack]: #virtualrack #### [virtualRack] Information regarding the bandwidth allotment to which a piece of hardware belongs. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** + @@ -1950,7 +2142,8 @@ Information regarding the bandwidth allotment to which a piece of hardware belon [virtualRackId]: #virtualrackid #### [virtualRackId] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **integer** +Type: **integer** + @@ -1960,7 +2153,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualRackName]: #virtualrackname #### [virtualRackName] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **string** +Type: **string** + @@ -1970,7 +2164,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualizationPlatform]: #virtualizationplatform #### [virtualizationPlatform] A piece of hardware's virtualization platform software. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -1982,7 +2177,8 @@ A piece of hardware's virtualization platform software. [activeComponentCount]: #activecomponentcount #### [activeComponentCount] A count of a piece of hardware's active physical components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1992,7 +2188,8 @@ A count of a piece of hardware's active physical components. [activeNetworkMonitorIncidentCount]: #activenetworkmonitorincidentcount #### [activeNetworkMonitorIncidentCount] A count of a piece of hardware's active network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -2002,7 +2199,8 @@ A count of a piece of hardware's active network monitoring incidents. [activeTicketCount]: #activeticketcount #### [activeTicketCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2012,7 +2210,8 @@ A count of [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of any active transaction(s) that are currently running for the server (example: os reload). -Type: **unsigned long** +Type: **unsigned long** + @@ -2022,7 +2221,8 @@ A count of any active transaction(s) that are currently running for the server ( [allPowerComponentCount]: #allpowercomponentcount #### [allPowerComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2032,7 +2232,8 @@ A count of [allowedNetworkStorageCount]: #allowednetworkstoragecount #### [allowedNetworkStorageCount] A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -2042,7 +2243,8 @@ A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware ha [allowedNetworkStorageReplicaCount]: #allowednetworkstoragereplicacount #### [allowedNetworkStorageReplicaCount] A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -2052,7 +2254,8 @@ A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLay [attributeCount]: #attributecount #### [attributeCount] A count of information regarding a piece of hardware's specific attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -2062,7 +2265,8 @@ A count of information regarding a piece of hardware's specific attributes. [availableMonitoringCount]: #availablemonitoringcount #### [availableMonitoringCount] A count of an object that stores the maximum level for the monitoring query types and response types. -Type: **unsigned long** +Type: **unsigned long** + @@ -2072,7 +2276,8 @@ A count of an object that stores the maximum level for the monitoring query type [backendNetworkComponentCount]: #backendnetworkcomponentcount #### [backendNetworkComponentCount] A count of a piece of hardware's back-end or private network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -2082,7 +2287,8 @@ A count of a piece of hardware's back-end or private network components. [backendRouterCount]: #backendroutercount #### [backendRouterCount] A count of a hardware's backend or private router. -Type: **unsigned long** +Type: **unsigned long** + @@ -2092,7 +2298,8 @@ A count of a hardware's backend or private router. [benchmarkCertificationCount]: #benchmarkcertificationcount #### [benchmarkCertificationCount] A count of information regarding a piece of hardware's benchmark certifications. -Type: **unsigned long** +Type: **unsigned long** + @@ -2102,7 +2309,8 @@ A count of information regarding a piece of hardware's benchmark certifications. [billingCycleBandwidthUsageCount]: #billingcyclebandwidthusagecount #### [billingCycleBandwidthUsageCount] A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -2112,7 +2320,8 @@ A count of the raw bandwidth usage data for the current billing cycle. One objec [childrenHardwareCount]: #childrenhardwarecount #### [childrenHardwareCount] A count of child hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2122,7 +2331,8 @@ A count of child hardware. [componentCount]: #componentcount #### [componentCount] A count of a piece of hardware's components. -Type: **unsigned long** +Type: **unsigned long** + @@ -2132,7 +2342,8 @@ A count of a piece of hardware's components. [downlinkHardwareCount]: #downlinkhardwarecount #### [downlinkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2142,7 +2353,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkNetworkHardwareCount]: #downlinknetworkhardwarecount #### [downlinkNetworkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2152,7 +2364,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkServerCount]: #downlinkservercount #### [downlinkServerCount] A count of information regarding all servers attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2162,7 +2375,8 @@ A count of information regarding all servers attached to a piece of network hard [downlinkVirtualGuestCount]: #downlinkvirtualguestcount #### [downlinkVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2172,7 +2386,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [downstreamHardwareBindingCount]: #downstreamhardwarebindingcount #### [downstreamHardwareBindingCount] A count of all hardware downstream from a network device. -Type: **unsigned long** +Type: **unsigned long** + @@ -2182,7 +2397,8 @@ A count of all hardware downstream from a network device. [downstreamNetworkHardwareCount]: #downstreamnetworkhardwarecount #### [downstreamNetworkHardwareCount] A count of all network hardware downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2192,7 +2408,8 @@ A count of all network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidentCount]: #downstreamnetworkhardwarewithincidentcount #### [downstreamNetworkHardwareWithIncidentCount] A count of all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2202,7 +2419,8 @@ A count of all network hardware with monitoring warnings or errors that are down [downstreamServerCount]: #downstreamservercount #### [downstreamServerCount] A count of information regarding all servers attached downstream to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2212,7 +2430,8 @@ A count of information regarding all servers attached downstream to a piece of n [downstreamVirtualGuestCount]: #downstreamvirtualguestcount #### [downstreamVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2222,7 +2441,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [driveControllerCount]: #drivecontrollercount #### [driveControllerCount] A count of the drive controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2232,7 +2452,8 @@ A count of the drive controllers contained within a piece of hardware. [evaultNetworkStorageCount]: #evaultnetworkstoragecount #### [evaultNetworkStorageCount] A count of information regarding a piece of hardware's associated EVault network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -2242,7 +2463,8 @@ A count of information regarding a piece of hardware's associated EVault network [frontendNetworkComponentCount]: #frontendnetworkcomponentcount #### [frontendNetworkComponentCount] A count of a piece of hardware's front-end or public network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -2252,7 +2474,8 @@ A count of a piece of hardware's front-end or public network components. [frontendRouterCount]: #frontendroutercount #### [frontendRouterCount] A count of a hardware's frontend or public router. -Type: **unsigned long** +Type: **unsigned long** + @@ -2262,7 +2485,8 @@ A count of a hardware's frontend or public router. [hardDriveCount]: #harddrivecount #### [hardDriveCount] A count of the hard drives contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2272,7 +2496,8 @@ A count of the hard drives contained within a piece of hardware. [logicalVolumeStorageGroupCount]: #logicalvolumestoragegroupcount #### [logicalVolumeStorageGroupCount] A count of returns a list of logical volumes on the physical machine. -Type: **unsigned long** +Type: **unsigned long** + @@ -2282,7 +2507,8 @@ A count of returns a list of logical volumes on the physical machine. [memoryCount]: #memorycount #### [memoryCount] A count of information regarding a piece of hardware's memory. -Type: **unsigned long** +Type: **unsigned long** + @@ -2292,7 +2518,8 @@ A count of information regarding a piece of hardware's memory. [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2302,7 +2529,8 @@ A count of [monitoringUserNotificationCount]: #monitoringusernotificationcount #### [monitoringUserNotificationCount] A count of the monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails -Type: **unsigned long** +Type: **unsigned long** + @@ -2312,7 +2540,8 @@ A count of the monitoring notification objects for this hardware. Each object li [networkCardCount]: #networkcardcount #### [networkCardCount] A count of information regarding a piece of hardware's network cards. -Type: **unsigned long** +Type: **unsigned long** + @@ -2322,7 +2551,8 @@ A count of information regarding a piece of hardware's network cards. [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of returns a hardware's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -2332,7 +2562,8 @@ A count of returns a hardware's network components. [networkMonitorAttachedDownHardwareCount]: #networkmonitorattacheddownhardwarecount #### [networkMonitorAttachedDownHardwareCount] A count of all servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2342,7 +2573,8 @@ A count of all servers with failed monitoring that are attached downstream to a [networkMonitorAttachedDownVirtualGuestCount]: #networkmonitorattacheddownvirtualguestcount #### [networkMonitorAttachedDownVirtualGuestCount] A count of virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **unsigned long** +Type: **unsigned long** + @@ -2352,7 +2584,8 @@ A count of virtual guests that are attached downstream to a hardware that have f [networkMonitorCount]: #networkmonitorcount #### [networkMonitorCount] A count of information regarding a piece of hardware's network monitors. -Type: **unsigned long** +Type: **unsigned long** + @@ -2362,7 +2595,8 @@ A count of information regarding a piece of hardware's network monitors. [networkMonitorIncidentCount]: #networkmonitorincidentcount #### [networkMonitorIncidentCount] A count of the status of all of a piece of hardware's network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -2372,7 +2606,8 @@ A count of the status of all of a piece of hardware's network monitoring inciden [networkStorageCount]: #networkstoragecount #### [networkStorageCount] A count of information regarding a piece of hardware's associated network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -2382,7 +2617,8 @@ A count of information regarding a piece of hardware's associated network storag [networkVlanCount]: #networkvlancount #### [networkVlanCount] A count of the network virtual LANs (VLANs) associated with a piece of hardware's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -2392,7 +2628,8 @@ A count of the network virtual LANs (VLANs) associated with a piece of hardware' [notesHistoryCount]: #noteshistorycount #### [notesHistoryCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2402,7 +2639,8 @@ A count of [nvRamComponentModelCount]: #nvramcomponentmodelcount #### [nvRamComponentModelCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2412,7 +2650,8 @@ A count of [partitionCount]: #partitioncount #### [partitionCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2422,7 +2661,8 @@ A count of [powerComponentCount]: #powercomponentcount #### [powerComponentCount] A count of the power components for a hardware object. -Type: **unsigned long** +Type: **unsigned long** + @@ -2432,7 +2672,8 @@ A count of the power components for a hardware object. [powerSupplyCount]: #powersupplycount #### [powerSupplyCount] A count of a server's power supply. -Type: **unsigned long** +Type: **unsigned long** + @@ -2442,7 +2683,8 @@ A count of a server's power supply. [processorCount]: #processorcount #### [processorCount] A count of information regarding a piece of hardware's processors. -Type: **unsigned long** +Type: **unsigned long** + @@ -2452,7 +2694,8 @@ A count of information regarding a piece of hardware's processors. [raidControllerCount]: #raidcontrollercount #### [raidControllerCount] A count of the RAID controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2462,7 +2705,8 @@ A count of the RAID controllers contained within a piece of hardware. [recentEventCount]: #recenteventcount #### [recentEventCount] A count of recent events that impact this hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2472,7 +2716,8 @@ A count of recent events that impact this hardware. [recentRemoteManagementCommandCount]: #recentremotemanagementcommandcount #### [recentRemoteManagementCommandCount] A count of the last five commands issued to the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -2482,7 +2727,8 @@ A count of the last five commands issued to the server's remote management card. [remoteManagementAccountCount]: #remotemanagementaccountcount #### [remoteManagementAccountCount] A count of user credentials to issue commands and/or interact with the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -2492,7 +2738,8 @@ A count of user credentials to issue commands and/or interact with the server's [remoteManagementUserCount]: #remotemanagementusercount #### [remoteManagementUserCount] A count of user(s) who have access to issue commands and/or interact with the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -2502,7 +2749,8 @@ A count of user(s) who have access to issue commands and/or interact with the se [resourceConfigurationCount]: #resourceconfigurationcount #### [resourceConfigurationCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2512,7 +2760,8 @@ A count of [resourceGroupCount]: #resourcegroupcount #### [resourceGroupCount] A count of the resource groups in which this hardware is a member. -Type: **unsigned long** +Type: **unsigned long** + @@ -2522,7 +2771,8 @@ A count of the resource groups in which this hardware is a member. [resourceGroupMemberReferenceCount]: #resourcegroupmemberreferencecount #### [resourceGroupMemberReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2532,7 +2782,8 @@ A count of [resourceGroupRoleCount]: #resourcegrouprolecount #### [resourceGroupRoleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2542,7 +2793,8 @@ A count of [routerCount]: #routercount #### [routerCount] A count of a hardware's routers. -Type: **unsigned long** +Type: **unsigned long** + @@ -2552,7 +2804,8 @@ A count of a hardware's routers. [scaleAssetCount]: #scaleassetcount #### [scaleAssetCount] A count of collection of scale assets this hardware corresponds to. -Type: **unsigned long** +Type: **unsigned long** + @@ -2562,7 +2815,8 @@ A count of collection of scale assets this hardware corresponds to. [securityScanRequestCount]: #securityscanrequestcount #### [securityScanRequestCount] A count of information regarding a piece of hardware's vulnerability scan requests. -Type: **unsigned long** +Type: **unsigned long** + @@ -2572,7 +2826,8 @@ A count of information regarding a piece of hardware's vulnerability scan reques [softwareComponentCount]: #softwarecomponentcount #### [softwareComponentCount] A count of information regarding a piece of hardware's installed software. -Type: **unsigned long** +Type: **unsigned long** + @@ -2582,7 +2837,8 @@ A count of information regarding a piece of hardware's installed software. [sshKeyCount]: #sshkeycount #### [sshKeyCount] A count of sSH keys to be installed on the server during provisioning or an OS reload. -Type: **unsigned long** +Type: **unsigned long** + @@ -2592,7 +2848,8 @@ A count of sSH keys to be installed on the server during provisioning or an OS r [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2602,7 +2859,8 @@ A count of [storageNetworkComponentCount]: #storagenetworkcomponentcount #### [storageNetworkComponentCount] A count of a piece of hardware's private storage network components. [Deprecated] -Type: **unsigned long** +Type: **unsigned long** + @@ -2612,7 +2870,8 @@ A count of a piece of hardware's private storage network components. [Deprecated [tagReferenceCount]: #tagreferencecount #### [tagReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2622,7 +2881,8 @@ A count of [uplinkNetworkComponentCount]: #uplinknetworkcomponentcount #### [uplinkNetworkComponentCount] A count of information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **unsigned long** +Type: **unsigned long** + @@ -2632,7 +2892,8 @@ A count of information regarding the network component that is one level higher [userCount]: #usercount #### [userCount] A count of a list of users that have access to this computing instance. -Type: **unsigned long** +Type: **unsigned long** + @@ -2642,7 +2903,8 @@ A count of a list of users that have access to this computing instance. [userDataCount]: #userdatacount #### [userDataCount] A count of an array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **unsigned long** +Type: **unsigned long** + @@ -2652,7 +2914,8 @@ A count of an array containing a single string of custom user data for a hardwar [virtualChassisSiblingCount]: #virtualchassissiblingcount #### [virtualChassisSiblingCount] A count of information regarding the virtual chassis siblings for a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2662,7 +2925,8 @@ A count of information regarding the virtual chassis siblings for a piece of har [virtualGuestCount]: #virtualguestcount #### [virtualGuestCount] A count of a hardware server's virtual servers. -Type: **unsigned long** +Type: **unsigned long** + @@ -2672,7 +2936,8 @@ A count of a hardware server's virtual servers. [virtualLicenseCount]: #virtuallicensecount #### [virtualLicenseCount] A count of information regarding a piece of hardware's virtual software licenses. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Server_Partition/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Server_Partition/_index.md index c309672f89..9181bfc67a 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Server_Partition/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Server_Partition/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [hardwareId]: #hardwareid #### [hardwareId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [hostname]: #hostname #### [hostname] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [macAddress]: #macaddress #### [macAddress] -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ classes: [hardware]: #hardware #### [hardware] -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -91,7 +97,8 @@ classes: [networkComponentAttributes]: #networkcomponentattributes #### [networkComponentAttributes] -Type: **SoftLayer_Hardware_Server_Partition_Network_Attribute[] ** +Type: **SoftLayer_Hardware_Server_Partition_Network_Attribute[] ** + @@ -103,7 +110,8 @@ classes: [networkComponentAttributeCount]: #networkcomponentattributecount #### [networkComponentAttributeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Server_Partition_Network_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Server_Partition_Network_Attribute/_index.md index 63a362e2e6..cd819c6998 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Server_Partition_Network_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Server_Partition_Network_Attribute/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [ipAddress]: #ipaddress #### [ipAddress] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [macAddress]: #macaddress #### [macAddress] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [partitionId]: #partitionid #### [partitionId] -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_State/_index.md b/content/reference/datatypes/SoftLayer_Hardware_State/_index.md index 31556833c4..49f8640008 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_State/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_State/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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). @@ -45,7 +47,8 @@ The SoftLayer_Hardware_State type contains general information about the current [hardwareId]: #hardwareid #### [hardwareId] The hardware this state is assigned to. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The hardware this state is assigned to. [id]: #id #### [id] A hardware state's unique identifier. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A hardware state's unique identifier. [state]: #state #### [state] Represents the current state of the assigned hardware. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Status/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Status/_index.md index e29d613b52..f5b53c126e 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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: @@ -65,7 +67,8 @@ Servers in production and in use should stay in the ACTIVE state. If a server's [id]: #id #### [id] A hardware status' internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +78,8 @@ A hardware status' internal identifier. [status]: #status #### [status] A hardware's status code. See the SoftLayer_Hardware_Status Overview for ''status''' possible values. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Hardware_Switch/_index.md b/content/reference/datatypes/SoftLayer_Hardware_Switch/_index.md index 338ab58641..eacc1172ef 100644 --- a/content/reference/datatypes/SoftLayer_Hardware_Switch/_index.md +++ b/content/reference/datatypes/SoftLayer_Hardware_Switch/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Switch object extends the base functionality of the SoftLayer_Hardware service. ### External Links @@ -51,7 +53,8 @@ The SoftLayer_Hardware_Switch object extends the base functionality of the SoftL [accountId]: #accountid #### [accountId] A hardware's associated [SoftLayer_Account]({{}}) id. -Type: **integer** +Type: **integer** + @@ -61,7 +64,8 @@ A hardware's associated [SoftLayer_Account]({{Type: **integer** +Type: **integer** + @@ -71,7 +75,8 @@ When true, this flag specifies that a hardware is Bare Metal Server. Bare Metal [domain]: #domain #### [domain] A piece of hardware's local network domain name. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A piece of hardware's local network domain name. [fullyQualifiedDomainName]: #fullyqualifieddomainname #### [fullyQualifiedDomainName] A name reflecting the hostname and domain of the hardware. This is created from the combined values of the hardware's hostname and domain name automatically, and thus should not be edited directly. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A name reflecting the hostname and domain of the hardware. This is created from [hardwareStatusId]: #hardwarestatusid #### [hardwareStatusId] A number reflecting the state of a hardware -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ A number reflecting the state of a hardware [hostname]: #hostname #### [hostname] A hardware's hostname -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ A hardware's hostname [id]: #id #### [id] A hardware's internal identification number -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ A hardware's internal identification number [manufacturerSerialNumber]: #manufacturerserialnumber #### [manufacturerSerialNumber] A hardware's serial number that is supplied by the manufacturer. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ A hardware's serial number that is supplied by the manufacturer. [notes]: #notes #### [notes] A small note about a piece of hardware to use at your discretion. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ A small note about a piece of hardware to use at your discretion. [postInstallScriptUri]: #postinstallscripturi #### [postInstallScriptUri] URI of the script to be downloaded and executed after installation is complete. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ URI of the script to be downloaded and executed after installation is complete. [provisionDate]: #provisiondate #### [provisionDate] -Type: **dateTime** +Type: **dateTime** + @@ -161,7 +174,8 @@ URI of the script to be downloaded and executed after installation is complete. [serialNumber]: #serialnumber #### [serialNumber] A hardware's serial number that is supplied by SoftLayer. -Type: **string** +Type: **string** + @@ -171,7 +185,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] -Type: **integer** +Type: **integer** + @@ -181,7 +196,8 @@ A hardware's serial number that is supplied by SoftLayer. [serviceProviderResourceId]: #serviceproviderresourceid #### [serviceProviderResourceId] A hardware's internal identification number at its service provider -Type: **integer** +Type: **integer** + @@ -197,7 +213,8 @@ A hardware's internal identification number at its service provider [account]: #account #### [account] The account associated with a piece of hardware. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -207,7 +224,8 @@ The account associated with a piece of hardware. [activeComponents]: #activecomponents #### [activeComponents] A piece of hardware's active physical components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -217,7 +235,8 @@ A piece of hardware's active physical components. [activeNetworkMonitorIncident]: #activenetworkmonitorincident #### [activeNetworkMonitorIncident] A piece of hardware's active network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -227,7 +246,8 @@ A piece of hardware's active network monitoring incidents. [allPowerComponents]: #allpowercomponents #### [allPowerComponents] -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -237,7 +257,8 @@ A piece of hardware's active network monitoring incidents. [allowedHost]: #allowedhost #### [allowedHost] The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. -Type: **SoftLayer_Network_Storage_Allowed_Host ** +Type: **SoftLayer_Network_Storage_Allowed_Host ** + @@ -247,7 +268,8 @@ The SoftLayer_Network_Storage_Allowed_Host information to connect this server to [allowedNetworkStorage]: #allowednetworkstorage #### [allowedNetworkStorage] The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -257,7 +279,8 @@ The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to [allowedNetworkStorageReplicas]: #allowednetworkstoragereplicas #### [allowedNetworkStorageReplicas] The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -267,7 +290,8 @@ The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware [antivirusSpywareSoftwareComponent]: #antivirusspywaresoftwarecomponent #### [antivirusSpywareSoftwareComponent] Information regarding an antivirus/spyware software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -277,7 +301,8 @@ Information regarding an antivirus/spyware software component object. [attributes]: #attributes #### [attributes] Information regarding a piece of hardware's specific attributes. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -287,7 +312,8 @@ Information regarding a piece of hardware's specific attributes. [averageDailyPublicBandwidthUsage]: #averagedailypublicbandwidthusage #### [averageDailyPublicBandwidthUsage] The average daily public bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -297,7 +323,8 @@ The average daily public bandwidth usage for the current billing cycle. [backendNetworkComponents]: #backendnetworkcomponents #### [backendNetworkComponents] A piece of hardware's back-end or private network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -307,7 +334,8 @@ A piece of hardware's back-end or private network components. [backendRouters]: #backendrouters #### [backendRouters] A hardware's backend or private router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -317,7 +345,8 @@ A hardware's backend or private router. [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] A hardware's allotted bandwidth (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -327,7 +356,8 @@ A hardware's allotted bandwidth (measured in GB). [bandwidthAllotmentDetail]: #bandwidthallotmentdetail #### [bandwidthAllotmentDetail] A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** + @@ -337,7 +367,8 @@ A hardware's allotted detail record. Allotment details link bandwidth allocation [benchmarkCertifications]: #benchmarkcertifications #### [benchmarkCertifications] Information regarding a piece of hardware's benchmark certifications. -Type: **SoftLayer_Hardware_Benchmark_Certification[] ** +Type: **SoftLayer_Hardware_Benchmark_Certification[] ** + @@ -347,7 +378,8 @@ Information regarding a piece of hardware's benchmark certifications. [billingItem]: #billingitem #### [billingItem] Information regarding the billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -357,7 +389,8 @@ Information regarding the billing item for a server. [billingItemFlag]: #billingitemflag #### [billingItemFlag] A flag indicating that a billing item exists. -Type: **boolean** +Type: **boolean** + @@ -367,7 +400,8 @@ A flag indicating that a billing item exists. [blockCancelBecauseDisconnectedFlag]: #blockcancelbecausedisconnectedflag #### [blockCancelBecauseDisconnectedFlag] Determines whether the hardware is ineligible for cancellation because it is disconnected. -Type: **boolean** +Type: **boolean** + @@ -377,7 +411,8 @@ Determines whether the hardware is ineligible for cancellation because it is dis [businessContinuanceInsuranceFlag]: #businesscontinuanceinsuranceflag #### [businessContinuanceInsuranceFlag] Status indicating whether or not a piece of hardware has business continuance insurance. -Type: **boolean** +Type: **boolean** + @@ -387,7 +422,8 @@ Status indicating whether or not a piece of hardware has business continuance in [childrenHardware]: #childrenhardware #### [childrenHardware] Child hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -397,7 +433,8 @@ Child hardware. [components]: #components #### [components] A piece of hardware's components. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -407,7 +444,8 @@ A piece of hardware's components. [continuousDataProtectionSoftwareComponent]: #continuousdataprotectionsoftwarecomponent #### [continuousDataProtectionSoftwareComponent] A continuous data protection/server backup software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -417,7 +455,8 @@ A continuous data protection/server backup software component object. [currentBillableBandwidthUsage]: #currentbillablebandwidthusage #### [currentBillableBandwidthUsage] The current billable public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -427,7 +466,8 @@ The current billable public outbound bandwidth for this hardware for the current [datacenter]: #datacenter #### [datacenter] Information regarding the datacenter in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -437,7 +477,8 @@ Information regarding the datacenter in which a piece of hardware resides. [datacenterName]: #datacentername #### [datacenterName] The name of the datacenter in which a piece of hardware resides. -Type: **string** +Type: **string** + @@ -447,7 +488,8 @@ The name of the datacenter in which a piece of hardware resides. [daysInSparePool]: #daysinsparepool #### [daysInSparePool] Number of day(s) a server have been in spare pool. -Type: **integer** +Type: **integer** + @@ -457,7 +499,8 @@ Number of day(s) a server have been in spare pool. [downlinkHardware]: #downlinkhardware #### [downlinkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -467,7 +510,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkNetworkHardware]: #downlinknetworkhardware #### [downlinkNetworkHardware] All hardware that has uplink network connections to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -477,7 +521,8 @@ All hardware that has uplink network connections to a piece of hardware. [downlinkServers]: #downlinkservers #### [downlinkServers] Information regarding all servers attached to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -487,7 +532,8 @@ Information regarding all servers attached to a piece of network hardware. [downlinkVirtualGuests]: #downlinkvirtualguests #### [downlinkVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -497,7 +543,8 @@ Information regarding all virtual guests attached to a piece of network hardware [downstreamHardwareBindings]: #downstreamhardwarebindings #### [downstreamHardwareBindings] All hardware downstream from a network device. -Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** +Type: **SoftLayer_Network_Component_Uplink_Hardware[] ** + @@ -507,7 +554,8 @@ All hardware downstream from a network device. [downstreamNetworkHardware]: #downstreamnetworkhardware #### [downstreamNetworkHardware] All network hardware downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -517,7 +565,8 @@ All network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidents]: #downstreamnetworkhardwarewithincidents #### [downstreamNetworkHardwareWithIncidents] All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -527,7 +576,8 @@ All network hardware with monitoring warnings or errors that are downstream from [downstreamServers]: #downstreamservers #### [downstreamServers] Information regarding all servers attached downstream to a piece of network hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -537,7 +587,8 @@ Information regarding all servers attached downstream to a piece of network hard [downstreamVirtualGuests]: #downstreamvirtualguests #### [downstreamVirtualGuests] Information regarding all virtual guests attached to a piece of network hardware. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -547,7 +598,8 @@ Information regarding all virtual guests attached to a piece of network hardware [driveControllers]: #drivecontrollers #### [driveControllers] The drive controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -557,7 +609,8 @@ The drive controllers contained within a piece of hardware. [evaultNetworkStorage]: #evaultnetworkstorage #### [evaultNetworkStorage] Information regarding a piece of hardware's associated EVault network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -567,7 +620,8 @@ Information regarding a piece of hardware's associated EVault network storage se [firewallServiceComponent]: #firewallservicecomponent #### [firewallServiceComponent] Information regarding a piece of hardware's firewall services. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -577,7 +631,8 @@ Information regarding a piece of hardware's firewall services. [fixedConfigurationPreset]: #fixedconfigurationpreset #### [fixedConfigurationPreset] Defines the fixed components in a fixed configuration bare metal server. -Type: **SoftLayer_Product_Package_Preset ** +Type: **SoftLayer_Product_Package_Preset ** + @@ -587,7 +642,8 @@ Defines the fixed components in a fixed configuration bare metal server. [frontendNetworkComponents]: #frontendnetworkcomponents #### [frontendNetworkComponents] A piece of hardware's front-end or public network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -597,7 +653,8 @@ A piece of hardware's front-end or public network components. [frontendRouters]: #frontendrouters #### [frontendRouters] A hardware's frontend or public router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -607,7 +664,8 @@ A hardware's frontend or public router. [futureBillingItem]: #futurebillingitem #### [futureBillingItem] Information regarding the future billing item for a server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -617,7 +675,8 @@ Information regarding the future billing item for a server. [globalIdentifier]: #globalidentifier #### [globalIdentifier] A hardware's universally unique identifier. -Type: **string** +Type: **string** + @@ -627,7 +686,8 @@ A hardware's universally unique identifier. [hardDrives]: #harddrives #### [hardDrives] The hard drives contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -637,7 +697,8 @@ The hard drives contained within a piece of hardware. [hardwareChassis]: #hardwarechassis #### [hardwareChassis] The chassis that a piece of hardware is housed in. -Type: **SoftLayer_Hardware_Chassis ** +Type: **SoftLayer_Hardware_Chassis ** + @@ -647,7 +708,8 @@ The chassis that a piece of hardware is housed in. [hardwareFunction]: #hardwarefunction #### [hardwareFunction] A hardware's function. -Type: **SoftLayer_Hardware_Function ** +Type: **SoftLayer_Hardware_Function ** + @@ -657,7 +719,8 @@ A hardware's function. [hardwareFunctionDescription]: #hardwarefunctiondescription #### [hardwareFunctionDescription] A hardware's function. -Type: **string** +Type: **string** + @@ -667,7 +730,8 @@ A hardware's function. [hardwareStatus]: #hardwarestatus #### [hardwareStatus] A hardware's status. -Type: **SoftLayer_Hardware_Status ** +Type: **SoftLayer_Hardware_Status ** + @@ -677,7 +741,8 @@ A hardware's status. [hasTrustedPlatformModuleBillingItemFlag]: #hastrustedplatformmodulebillingitemflag #### [hasTrustedPlatformModuleBillingItemFlag] Determine in hardware object has TPM enabled. -Type: **boolean** +Type: **boolean** + @@ -687,7 +752,8 @@ Determine in hardware object has TPM enabled. [hostIpsSoftwareComponent]: #hostipssoftwarecomponent #### [hostIpsSoftwareComponent] Information regarding a host IPS software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -697,7 +763,8 @@ Information regarding a host IPS software component object. [hourlyBillingFlag]: #hourlybillingflag #### [hourlyBillingFlag] A server's hourly billing status. -Type: **boolean** +Type: **boolean** + @@ -707,7 +774,8 @@ A server's hourly billing status. [inboundBandwidthUsage]: #inboundbandwidthusage #### [inboundBandwidthUsage] The sum of all the inbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -717,7 +785,8 @@ The sum of all the inbound network traffic data for the last 30 days. [inboundPublicBandwidthUsage]: #inboundpublicbandwidthusage #### [inboundPublicBandwidthUsage] The total public inbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -727,7 +796,8 @@ The total public inbound bandwidth for this hardware for the current billing cyc [isBillingTermChangeAvailableFlag]: #isbillingtermchangeavailableflag #### [isBillingTermChangeAvailableFlag] Whether or not this hardware object is eligible to change to term billing. -Type: **boolean** +Type: **boolean** + @@ -737,7 +807,8 @@ Whether or not this hardware object is eligible to change to term billing. [lastTransaction]: #lasttransaction #### [lastTransaction] Information regarding the last transaction a server performed. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -747,7 +818,8 @@ Information regarding the last transaction a server performed. [latestNetworkMonitorIncident]: #latestnetworkmonitorincident #### [latestNetworkMonitorIncident] A piece of hardware's latest network monitoring incident. -Type: **SoftLayer_Network_Monitor_Version1_Incident ** +Type: **SoftLayer_Network_Monitor_Version1_Incident ** + @@ -757,7 +829,8 @@ A piece of hardware's latest network monitoring incident. [location]: #location #### [location] Where a piece of hardware is located within SoftLayer's location hierarchy. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -767,7 +840,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [locationPathString]: #locationpathstring #### [locationPathString] -Type: **string** +Type: **string** + @@ -777,7 +851,8 @@ Where a piece of hardware is located within SoftLayer's location hierarchy. [lockboxNetworkStorage]: #lockboxnetworkstorage #### [lockboxNetworkStorage] Information regarding a lockbox account associated with a server. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -787,7 +862,8 @@ Information regarding a lockbox account associated with a server. [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the hardware is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -797,7 +873,8 @@ A flag indicating that the hardware is a managed resource. [memory]: #memory #### [memory] Information regarding a piece of hardware's memory. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -807,7 +884,8 @@ Information regarding a piece of hardware's memory. [memoryCapacity]: #memorycapacity #### [memoryCapacity] The amount of memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -817,7 +895,8 @@ The amount of memory a piece of hardware has, measured in gigabytes. [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A piece of hardware's metric tracking object. -Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** +Type: **SoftLayer_Metric_Tracking_Object_HardwareServer ** + @@ -827,7 +906,8 @@ A piece of hardware's metric tracking object. [modules]: #modules #### [modules] -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -837,7 +917,8 @@ A piece of hardware's metric tracking object. [monitoringRobot]: #monitoringrobot #### [monitoringRobot] -Type: **SoftLayer_Monitoring_Robot ** +Type: **SoftLayer_Monitoring_Robot ** + @@ -847,7 +928,8 @@ A piece of hardware's metric tracking object. [monitoringServiceComponent]: #monitoringservicecomponent #### [monitoringServiceComponent] Information regarding a piece of hardware's network monitoring services. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** + @@ -857,7 +939,8 @@ Information regarding a piece of hardware's network monitoring services. [monitoringServiceEligibilityFlag]: #monitoringserviceeligibilityflag #### [monitoringServiceEligibilityFlag] -Type: **boolean** +Type: **boolean** + @@ -867,7 +950,8 @@ Information regarding a piece of hardware's network monitoring services. [motherboard]: #motherboard #### [motherboard] Information regarding a piece of hardware's motherboard. -Type: **SoftLayer_Hardware_Component ** +Type: **SoftLayer_Hardware_Component ** + @@ -877,7 +961,8 @@ Information regarding a piece of hardware's motherboard. [networkCards]: #networkcards #### [networkCards] Information regarding a piece of hardware's network cards. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -887,7 +972,8 @@ Information regarding a piece of hardware's network cards. [networkComponents]: #networkcomponents #### [networkComponents] Returns a hardware's network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -897,7 +983,8 @@ Returns a hardware's network components. [networkGatewayMember]: #networkgatewaymember #### [networkGatewayMember] The gateway member if this device is part of a network gateway. -Type: **SoftLayer_Network_Gateway_Member ** +Type: **SoftLayer_Network_Gateway_Member ** + @@ -907,7 +994,8 @@ The gateway member if this device is part of a network gateway. [networkGatewayMemberFlag]: #networkgatewaymemberflag #### [networkGatewayMemberFlag] Whether or not this device is part of a network gateway. -Type: **boolean** +Type: **boolean** + @@ -917,7 +1005,8 @@ Whether or not this device is part of a network gateway. [networkMonitorAttachedDownHardware]: #networkmonitorattacheddownhardware #### [networkMonitorAttachedDownHardware] All servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -927,7 +1016,8 @@ All servers with failed monitoring that are attached downstream to a piece of ha [networkMonitorAttachedDownVirtualGuests]: #networkmonitorattacheddownvirtualguests #### [networkMonitorAttachedDownVirtualGuests] Virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -937,7 +1027,8 @@ Virtual guests that are attached downstream to a hardware that have failed monit [networkMonitorIncidents]: #networkmonitorincidents #### [networkMonitorIncidents] The status of all of a piece of hardware's network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -947,7 +1038,8 @@ The status of all of a piece of hardware's network monitoring incidents. [networkMonitors]: #networkmonitors #### [networkMonitors] Information regarding a piece of hardware's network monitors. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** + @@ -957,7 +1049,8 @@ Information regarding a piece of hardware's network monitors. [networkStatus]: #networkstatus #### [networkStatus] The value of a hardware's network status attribute. -Type: **string** +Type: **string** + @@ -967,7 +1060,8 @@ The value of a hardware's network status attribute. [networkStatusAttribute]: #networkstatusattribute #### [networkStatusAttribute] The hardware's related network status attribute. -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -977,7 +1071,8 @@ The hardware's related network status attribute. [networkStorage]: #networkstorage #### [networkStorage] Information regarding a piece of hardware's associated network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -987,7 +1082,8 @@ Information regarding a piece of hardware's associated network storage service a [networkVlans]: #networkvlans #### [networkVlans] The network virtual LANs (VLANs) associated with a piece of hardware's network components. -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -997,7 +1093,8 @@ The network virtual LANs (VLANs) associated with a piece of hardware's network c [nextBillingCycleBandwidthAllocation]: #nextbillingcyclebandwidthallocation #### [nextBillingCycleBandwidthAllocation] A hardware's allotted bandwidth for the next billing cycle (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -1007,7 +1104,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [notesHistory]: #noteshistory #### [notesHistory] -Type: **SoftLayer_Hardware_Note[] ** +Type: **SoftLayer_Hardware_Note[] ** + @@ -1017,7 +1115,8 @@ A hardware's allotted bandwidth for the next billing cycle (measured in GB). [nvRamCapacity]: #nvramcapacity #### [nvRamCapacity] The amount of non-volatile memory a piece of hardware has, measured in gigabytes. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1027,7 +1126,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [nvRamComponentModels]: #nvramcomponentmodels #### [nvRamComponentModels] -Type: **SoftLayer_Hardware_Component_Model[] ** +Type: **SoftLayer_Hardware_Component_Model[] ** + @@ -1037,7 +1137,8 @@ The amount of non-volatile memory a piece of hardware has, measured in gigabytes [operatingSystem]: #operatingsystem #### [operatingSystem] Information regarding a piece of hardware's operating system. -Type: **SoftLayer_Software_Component_OperatingSystem ** +Type: **SoftLayer_Software_Component_OperatingSystem ** + @@ -1047,7 +1148,8 @@ Information regarding a piece of hardware's operating system. [operatingSystemReferenceCode]: #operatingsystemreferencecode #### [operatingSystemReferenceCode] A hardware's operating system software description. -Type: **string** +Type: **string** + @@ -1057,7 +1159,8 @@ A hardware's operating system software description. [outboundBandwidthUsage]: #outboundbandwidthusage #### [outboundBandwidthUsage] The sum of all the outbound network traffic data for the last 30 days. -Type: **decimal** +Type: **decimal** + @@ -1067,7 +1170,8 @@ The sum of all the outbound network traffic data for the last 30 days. [outboundPublicBandwidthUsage]: #outboundpublicbandwidthusage #### [outboundPublicBandwidthUsage] The total public outbound bandwidth for this hardware for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -1077,7 +1181,8 @@ The total public outbound bandwidth for this hardware for the current billing cy [parentBay]: #parentbay #### [parentBay] Blade Bay -Type: **SoftLayer_Hardware_Blade ** +Type: **SoftLayer_Hardware_Blade ** + @@ -1087,7 +1192,8 @@ Blade Bay [parentHardware]: #parenthardware #### [parentHardware] Parent Hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1097,7 +1203,8 @@ Parent Hardware. [pointOfPresenceLocation]: #pointofpresencelocation #### [pointOfPresenceLocation] Information regarding the Point of Presence (PoP) location in which a piece of hardware resides. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1107,7 +1214,8 @@ Information regarding the Point of Presence (PoP) location in which a piece of h [powerComponents]: #powercomponents #### [powerComponents] The power components for a hardware object. -Type: **SoftLayer_Hardware_Power_Component[] ** +Type: **SoftLayer_Hardware_Power_Component[] ** + @@ -1117,7 +1225,8 @@ The power components for a hardware object. [powerSupply]: #powersupply #### [powerSupply] Information regarding a piece of hardware's power supply. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1127,7 +1236,8 @@ Information regarding a piece of hardware's power supply. [primaryBackendNetworkComponent]: #primarybackendnetworkcomponent #### [primaryBackendNetworkComponent] Information regarding the hardware's primary back-end network component. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1137,7 +1247,8 @@ Information regarding the hardware's primary back-end network component. [primaryIpAddress]: #primaryipaddress #### [primaryIpAddress] The administrative ip address of the switch. -Type: **string** +Type: **string** + @@ -1147,7 +1258,8 @@ The administrative ip address of the switch. [primaryNetworkComponent]: #primarynetworkcomponent #### [primaryNetworkComponent] Information regarding the hardware's primary public network component. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1157,7 +1269,8 @@ Information regarding the hardware's primary public network component. [privateNetworkOnlyFlag]: #privatenetworkonlyflag #### [privateNetworkOnlyFlag] Whether the hardware only has access to the private network. -Type: **boolean** +Type: **boolean** + @@ -1167,7 +1280,8 @@ Whether the hardware only has access to the private network. [processorCoreAmount]: #processorcoreamount #### [processorCoreAmount] The total number of processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1177,7 +1291,8 @@ The total number of processor cores, summed from all processors that are attache [processorPhysicalCoreAmount]: #processorphysicalcoreamount #### [processorPhysicalCoreAmount] The total number of physical processor cores, summed from all processors that are attached to a piece of hardware -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1187,7 +1302,8 @@ The total number of physical processor cores, summed from all processors that ar [processors]: #processors #### [processors] Information regarding a piece of hardware's processors. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1197,7 +1313,8 @@ Information regarding a piece of hardware's processors. [rack]: #rack #### [rack] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1207,7 +1324,8 @@ Information regarding a piece of hardware's processors. [raidControllers]: #raidcontrollers #### [raidControllers] The RAID controllers contained within a piece of hardware. -Type: **SoftLayer_Hardware_Component[] ** +Type: **SoftLayer_Hardware_Component[] ** + @@ -1217,7 +1335,8 @@ The RAID controllers contained within a piece of hardware. [recentEvents]: #recentevents #### [recentEvents] Recent events that impact this hardware. -Type: **SoftLayer_Notification_Occurrence_Event[] ** +Type: **SoftLayer_Notification_Occurrence_Event[] ** + @@ -1227,7 +1346,8 @@ Recent events that impact this hardware. [remoteManagementAccounts]: #remotemanagementaccounts #### [remoteManagementAccounts] User credentials to issue commands and/or interact with the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** + @@ -1237,7 +1357,8 @@ User credentials to issue commands and/or interact with the server's remote mana [remoteManagementComponent]: #remotemanagementcomponent #### [remoteManagementComponent] A hardware's associated remote management component. This is normally IPMI. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -1247,7 +1368,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceConfigurations]: #resourceconfigurations #### [resourceConfigurations] -Type: **SoftLayer_Hardware_Resource_Configuration[] ** +Type: **SoftLayer_Hardware_Resource_Configuration[] ** + @@ -1257,7 +1379,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroupMemberReferences]: #resourcegroupmemberreferences #### [resourceGroupMemberReferences] -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -1267,7 +1390,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroupRoles]: #resourcegrouproles #### [resourceGroupRoles] -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -1277,7 +1401,8 @@ A hardware's associated remote management component. This is normally IPMI. [resourceGroups]: #resourcegroups #### [resourceGroups] The resource groups in which this hardware is a member. -Type: **SoftLayer_Resource_Group[] ** +Type: **SoftLayer_Resource_Group[] ** + @@ -1287,7 +1412,8 @@ The resource groups in which this hardware is a member. [routers]: #routers #### [routers] A hardware's routers. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1297,7 +1423,8 @@ A hardware's routers. [scaleAssets]: #scaleassets #### [scaleAssets] Collection of scale assets this hardware corresponds to. -Type: **SoftLayer_Scale_Asset[] ** +Type: **SoftLayer_Scale_Asset[] ** + @@ -1307,7 +1434,8 @@ Collection of scale assets this hardware corresponds to. [securityScanRequests]: #securityscanrequests #### [securityScanRequests] Information regarding a piece of hardware's vulnerability scan requests. -Type: **SoftLayer_Network_Security_Scanner_Request[] ** +Type: **SoftLayer_Network_Security_Scanner_Request[] ** + @@ -1317,7 +1445,8 @@ Information regarding a piece of hardware's vulnerability scan requests. [serverRoom]: #serverroom #### [serverRoom] Information regarding the server room in which the hardware is located. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1327,7 +1456,8 @@ Information regarding the server room in which the hardware is located. [serviceProvider]: #serviceprovider #### [serviceProvider] Information regarding the piece of hardware's service provider. -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -1337,7 +1467,8 @@ Information regarding the piece of hardware's service provider. [softwareComponents]: #softwarecomponents #### [softwareComponents] Information regarding a piece of hardware's installed software. -Type: **SoftLayer_Software_Component[] ** +Type: **SoftLayer_Software_Component[] ** + @@ -1347,7 +1478,8 @@ Information regarding a piece of hardware's installed software. [sparePoolBillingItem]: #sparepoolbillingitem #### [sparePoolBillingItem] Information regarding the billing item for a spare pool server. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + @@ -1357,7 +1489,8 @@ Information regarding the billing item for a spare pool server. [sshKeys]: #sshkeys #### [sshKeys] SSH keys to be installed on the server during provisioning or an OS reload. -Type: **SoftLayer_Security_Ssh_Key[] ** +Type: **SoftLayer_Security_Ssh_Key[] ** + @@ -1367,17 +1500,20 @@ SSH keys to be installed on the server during provisioning or an OS reload. [storageGroups]: #storagegroups #### [storageGroups] -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + -
      +
      ----- [storageNetworkComponents]: #storagenetworkcomponents #### [storageNetworkComponents] A piece of hardware's private storage network components. [Deprecated] -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + +Deprecated
      @@ -1387,7 +1523,8 @@ A piece of hardware's private storage network components. [Deprecated] [tagReferences]: #tagreferences #### [tagReferences] -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** +
      @@ -1397,7 +1534,8 @@ A piece of hardware's private storage network components. [Deprecated] [topLevelLocation]: #toplevellocation #### [topLevelLocation] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1407,7 +1545,8 @@ A piece of hardware's private storage network components. [Deprecated] [upgradeRequest]: #upgraderequest #### [upgradeRequest] An account's associated upgrade request object, if any. -Type: **SoftLayer_Product_Upgrade_Request ** +Type: **SoftLayer_Product_Upgrade_Request ** + @@ -1417,7 +1556,8 @@ An account's associated upgrade request object, if any. [uplinkHardware]: #uplinkhardware #### [uplinkHardware] The network device connected to a piece of hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -1427,7 +1567,8 @@ The network device connected to a piece of hardware. [uplinkNetworkComponents]: #uplinknetworkcomponents #### [uplinkNetworkComponents] Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -1437,7 +1578,8 @@ Information regarding the network component that is one level higher than a piec [userData]: #userdata #### [userData] An array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **SoftLayer_Hardware_Attribute[] ** +Type: **SoftLayer_Hardware_Attribute[] ** + @@ -1447,7 +1589,8 @@ An array containing a single string of custom user data for a hardware order. Ma [virtualChassis]: #virtualchassis #### [virtualChassis] Information regarding the virtual chassis for a piece of hardware. -Type: **SoftLayer_Hardware_Group ** +Type: **SoftLayer_Hardware_Group ** + @@ -1457,7 +1600,8 @@ Information regarding the virtual chassis for a piece of hardware. [virtualChassisSiblings]: #virtualchassissiblings #### [virtualChassisSiblings] Information regarding the virtual chassis siblings for a piece of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -1467,7 +1611,8 @@ Information regarding the virtual chassis siblings for a piece of hardware. [virtualHost]: #virtualhost #### [virtualHost] A piece of hardware's virtual host record. -Type: **SoftLayer_Virtual_Host ** +Type: **SoftLayer_Virtual_Host ** + @@ -1477,7 +1622,8 @@ A piece of hardware's virtual host record. [virtualLicenses]: #virtuallicenses #### [virtualLicenses] Information regarding a piece of hardware's virtual software licenses. -Type: **SoftLayer_Software_VirtualLicense[] ** +Type: **SoftLayer_Software_VirtualLicense[] ** + @@ -1487,7 +1633,8 @@ Information regarding a piece of hardware's virtual software licenses. [virtualRack]: #virtualrack #### [virtualRack] Information regarding the bandwidth allotment to which a piece of hardware belongs. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** + @@ -1497,7 +1644,8 @@ Information regarding the bandwidth allotment to which a piece of hardware belon [virtualRackId]: #virtualrackid #### [virtualRackId] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **integer** +Type: **integer** + @@ -1507,7 +1655,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualRackName]: #virtualrackname #### [virtualRackName] The name of the bandwidth allotment belonging to a piece of hardware. -Type: **string** +Type: **string** + @@ -1517,7 +1666,8 @@ The name of the bandwidth allotment belonging to a piece of hardware. [virtualizationPlatform]: #virtualizationplatform #### [virtualizationPlatform] A piece of hardware's virtualization platform software. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -1529,7 +1679,8 @@ A piece of hardware's virtualization platform software. [activeComponentCount]: #activecomponentcount #### [activeComponentCount] A count of a piece of hardware's active physical components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1539,7 +1690,8 @@ A count of a piece of hardware's active physical components. [activeNetworkMonitorIncidentCount]: #activenetworkmonitorincidentcount #### [activeNetworkMonitorIncidentCount] A count of a piece of hardware's active network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -1549,7 +1701,8 @@ A count of a piece of hardware's active network monitoring incidents. [allPowerComponentCount]: #allpowercomponentcount #### [allPowerComponentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1559,7 +1712,8 @@ A count of [allowedNetworkStorageCount]: #allowednetworkstoragecount #### [allowedNetworkStorageCount] A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1569,7 +1723,8 @@ A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware ha [allowedNetworkStorageReplicaCount]: #allowednetworkstoragereplicacount #### [allowedNetworkStorageReplicaCount] A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1579,7 +1734,8 @@ A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLay [attributeCount]: #attributecount #### [attributeCount] A count of information regarding a piece of hardware's specific attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -1589,7 +1745,8 @@ A count of information regarding a piece of hardware's specific attributes. [backendNetworkComponentCount]: #backendnetworkcomponentcount #### [backendNetworkComponentCount] A count of a piece of hardware's back-end or private network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1599,7 +1756,8 @@ A count of a piece of hardware's back-end or private network components. [backendRouterCount]: #backendroutercount #### [backendRouterCount] A count of a hardware's backend or private router. -Type: **unsigned long** +Type: **unsigned long** + @@ -1609,7 +1767,8 @@ A count of a hardware's backend or private router. [benchmarkCertificationCount]: #benchmarkcertificationcount #### [benchmarkCertificationCount] A count of information regarding a piece of hardware's benchmark certifications. -Type: **unsigned long** +Type: **unsigned long** + @@ -1619,7 +1778,8 @@ A count of information regarding a piece of hardware's benchmark certifications. [childrenHardwareCount]: #childrenhardwarecount #### [childrenHardwareCount] A count of child hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1629,7 +1789,8 @@ A count of child hardware. [componentCount]: #componentcount #### [componentCount] A count of a piece of hardware's components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1639,7 +1800,8 @@ A count of a piece of hardware's components. [downlinkHardwareCount]: #downlinkhardwarecount #### [downlinkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1649,7 +1811,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkNetworkHardwareCount]: #downlinknetworkhardwarecount #### [downlinkNetworkHardwareCount] A count of all hardware that has uplink network connections to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1659,7 +1822,8 @@ A count of all hardware that has uplink network connections to a piece of hardwa [downlinkServerCount]: #downlinkservercount #### [downlinkServerCount] A count of information regarding all servers attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1669,7 +1833,8 @@ A count of information regarding all servers attached to a piece of network hard [downlinkVirtualGuestCount]: #downlinkvirtualguestcount #### [downlinkVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1679,7 +1844,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [downstreamHardwareBindingCount]: #downstreamhardwarebindingcount #### [downstreamHardwareBindingCount] A count of all hardware downstream from a network device. -Type: **unsigned long** +Type: **unsigned long** + @@ -1689,7 +1855,8 @@ A count of all hardware downstream from a network device. [downstreamNetworkHardwareCount]: #downstreamnetworkhardwarecount #### [downstreamNetworkHardwareCount] A count of all network hardware downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1699,7 +1866,8 @@ A count of all network hardware downstream from the selected piece of hardware. [downstreamNetworkHardwareWithIncidentCount]: #downstreamnetworkhardwarewithincidentcount #### [downstreamNetworkHardwareWithIncidentCount] A count of all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1709,7 +1877,8 @@ A count of all network hardware with monitoring warnings or errors that are down [downstreamServerCount]: #downstreamservercount #### [downstreamServerCount] A count of information regarding all servers attached downstream to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1719,7 +1888,8 @@ A count of information regarding all servers attached downstream to a piece of n [downstreamVirtualGuestCount]: #downstreamvirtualguestcount #### [downstreamVirtualGuestCount] A count of information regarding all virtual guests attached to a piece of network hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1729,7 +1899,8 @@ A count of information regarding all virtual guests attached to a piece of netwo [driveControllerCount]: #drivecontrollercount #### [driveControllerCount] A count of the drive controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1739,7 +1910,8 @@ A count of the drive controllers contained within a piece of hardware. [evaultNetworkStorageCount]: #evaultnetworkstoragecount #### [evaultNetworkStorageCount] A count of information regarding a piece of hardware's associated EVault network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -1749,7 +1921,8 @@ A count of information regarding a piece of hardware's associated EVault network [frontendNetworkComponentCount]: #frontendnetworkcomponentcount #### [frontendNetworkComponentCount] A count of a piece of hardware's front-end or public network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1759,7 +1932,8 @@ A count of a piece of hardware's front-end or public network components. [frontendRouterCount]: #frontendroutercount #### [frontendRouterCount] A count of a hardware's frontend or public router. -Type: **unsigned long** +Type: **unsigned long** + @@ -1769,7 +1943,8 @@ A count of a hardware's frontend or public router. [hardDriveCount]: #harddrivecount #### [hardDriveCount] A count of the hard drives contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1779,7 +1954,8 @@ A count of the hard drives contained within a piece of hardware. [memoryCount]: #memorycount #### [memoryCount] A count of information regarding a piece of hardware's memory. -Type: **unsigned long** +Type: **unsigned long** + @@ -1789,7 +1965,8 @@ A count of information regarding a piece of hardware's memory. [moduleCount]: #modulecount #### [moduleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1799,7 +1976,8 @@ A count of [networkCardCount]: #networkcardcount #### [networkCardCount] A count of information regarding a piece of hardware's network cards. -Type: **unsigned long** +Type: **unsigned long** + @@ -1809,7 +1987,8 @@ A count of information regarding a piece of hardware's network cards. [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of returns a hardware's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1819,7 +1998,8 @@ A count of returns a hardware's network components. [networkMonitorAttachedDownHardwareCount]: #networkmonitorattacheddownhardwarecount #### [networkMonitorAttachedDownHardwareCount] A count of all servers with failed monitoring that are attached downstream to a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1829,7 +2009,8 @@ A count of all servers with failed monitoring that are attached downstream to a [networkMonitorAttachedDownVirtualGuestCount]: #networkmonitorattacheddownvirtualguestcount #### [networkMonitorAttachedDownVirtualGuestCount] A count of virtual guests that are attached downstream to a hardware that have failed monitoring -Type: **unsigned long** +Type: **unsigned long** + @@ -1839,7 +2020,8 @@ A count of virtual guests that are attached downstream to a hardware that have f [networkMonitorCount]: #networkmonitorcount #### [networkMonitorCount] A count of information regarding a piece of hardware's network monitors. -Type: **unsigned long** +Type: **unsigned long** + @@ -1849,7 +2031,8 @@ A count of information regarding a piece of hardware's network monitors. [networkMonitorIncidentCount]: #networkmonitorincidentcount #### [networkMonitorIncidentCount] A count of the status of all of a piece of hardware's network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -1859,7 +2042,8 @@ A count of the status of all of a piece of hardware's network monitoring inciden [networkStorageCount]: #networkstoragecount #### [networkStorageCount] A count of information regarding a piece of hardware's associated network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -1869,7 +2053,8 @@ A count of information regarding a piece of hardware's associated network storag [networkVlanCount]: #networkvlancount #### [networkVlanCount] A count of the network virtual LANs (VLANs) associated with a piece of hardware's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1879,7 +2064,8 @@ A count of the network virtual LANs (VLANs) associated with a piece of hardware' [notesHistoryCount]: #noteshistorycount #### [notesHistoryCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1889,7 +2075,8 @@ A count of [nvRamComponentModelCount]: #nvramcomponentmodelcount #### [nvRamComponentModelCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1899,7 +2086,8 @@ A count of [powerComponentCount]: #powercomponentcount #### [powerComponentCount] A count of the power components for a hardware object. -Type: **unsigned long** +Type: **unsigned long** + @@ -1909,7 +2097,8 @@ A count of the power components for a hardware object. [powerSupplyCount]: #powersupplycount #### [powerSupplyCount] A count of information regarding a piece of hardware's power supply. -Type: **unsigned long** +Type: **unsigned long** + @@ -1919,7 +2108,8 @@ A count of information regarding a piece of hardware's power supply. [processorCount]: #processorcount #### [processorCount] A count of information regarding a piece of hardware's processors. -Type: **unsigned long** +Type: **unsigned long** + @@ -1929,7 +2119,8 @@ A count of information regarding a piece of hardware's processors. [raidControllerCount]: #raidcontrollercount #### [raidControllerCount] A count of the RAID controllers contained within a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1939,7 +2130,8 @@ A count of the RAID controllers contained within a piece of hardware. [recentEventCount]: #recenteventcount #### [recentEventCount] A count of recent events that impact this hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -1949,7 +2141,8 @@ A count of recent events that impact this hardware. [remoteManagementAccountCount]: #remotemanagementaccountcount #### [remoteManagementAccountCount] A count of user credentials to issue commands and/or interact with the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -1959,7 +2152,8 @@ A count of user credentials to issue commands and/or interact with the server's [resourceConfigurationCount]: #resourceconfigurationcount #### [resourceConfigurationCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1969,7 +2163,8 @@ A count of [resourceGroupCount]: #resourcegroupcount #### [resourceGroupCount] A count of the resource groups in which this hardware is a member. -Type: **unsigned long** +Type: **unsigned long** + @@ -1979,7 +2174,8 @@ A count of the resource groups in which this hardware is a member. [resourceGroupMemberReferenceCount]: #resourcegroupmemberreferencecount #### [resourceGroupMemberReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1989,7 +2185,8 @@ A count of [resourceGroupRoleCount]: #resourcegrouprolecount #### [resourceGroupRoleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1999,7 +2196,8 @@ A count of [routerCount]: #routercount #### [routerCount] A count of a hardware's routers. -Type: **unsigned long** +Type: **unsigned long** + @@ -2009,7 +2207,8 @@ A count of a hardware's routers. [scaleAssetCount]: #scaleassetcount #### [scaleAssetCount] A count of collection of scale assets this hardware corresponds to. -Type: **unsigned long** +Type: **unsigned long** + @@ -2019,7 +2218,8 @@ A count of collection of scale assets this hardware corresponds to. [securityScanRequestCount]: #securityscanrequestcount #### [securityScanRequestCount] A count of information regarding a piece of hardware's vulnerability scan requests. -Type: **unsigned long** +Type: **unsigned long** + @@ -2029,7 +2229,8 @@ A count of information regarding a piece of hardware's vulnerability scan reques [softwareComponentCount]: #softwarecomponentcount #### [softwareComponentCount] A count of information regarding a piece of hardware's installed software. -Type: **unsigned long** +Type: **unsigned long** + @@ -2039,7 +2240,8 @@ A count of information regarding a piece of hardware's installed software. [sshKeyCount]: #sshkeycount #### [sshKeyCount] A count of sSH keys to be installed on the server during provisioning or an OS reload. -Type: **unsigned long** +Type: **unsigned long** + @@ -2049,7 +2251,8 @@ A count of sSH keys to be installed on the server during provisioning or an OS r [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2059,7 +2262,8 @@ A count of [storageNetworkComponentCount]: #storagenetworkcomponentcount #### [storageNetworkComponentCount] A count of a piece of hardware's private storage network components. [Deprecated] -Type: **unsigned long** +Type: **unsigned long** + @@ -2069,7 +2273,8 @@ A count of a piece of hardware's private storage network components. [Deprecated [tagReferenceCount]: #tagreferencecount #### [tagReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -2079,7 +2284,8 @@ A count of [uplinkNetworkComponentCount]: #uplinknetworkcomponentcount #### [uplinkNetworkComponentCount] A count of information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -Type: **unsigned long** +Type: **unsigned long** + @@ -2089,7 +2295,8 @@ A count of information regarding the network component that is one level higher [userDataCount]: #userdatacount #### [userDataCount] A count of an array containing a single string of custom user data for a hardware order. Max size is 16 kb. -Type: **unsigned long** +Type: **unsigned long** + @@ -2099,7 +2306,8 @@ A count of an array containing a single string of custom user data for a hardwar [virtualChassisSiblingCount]: #virtualchassissiblingcount #### [virtualChassisSiblingCount] A count of information regarding the virtual chassis siblings for a piece of hardware. -Type: **unsigned long** +Type: **unsigned long** + @@ -2109,7 +2317,8 @@ A count of information regarding the virtual chassis siblings for a piece of har [virtualLicenseCount]: #virtuallicensecount #### [virtualLicenseCount] A count of information regarding a piece of hardware's virtual software licenses. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Layout_Container/_index.md b/content/reference/datatypes/SoftLayer_Layout_Container/_index.md index 52524c7408..874bd1a6c8 100644 --- a/content/reference/datatypes/SoftLayer_Layout_Container/_index.md +++ b/content/reference/datatypes/SoftLayer_Layout_Container/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Layout_Container contains definitions for default page layouts @@ -45,7 +47,8 @@ The SoftLayer_Layout_Container contains definitions for default page layouts [id]: #id #### [id] The internal identifier of a layout container -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of a layout container [keyname]: #keyname #### [keyname] The unique key name of the layout container, used primarily for programmatic purposes -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The unique key name of the layout container, used primarily for programmatic pur [layoutContainerTypeId]: #layoutcontainertypeid #### [layoutContainerTypeId] The internal identifier of the related [SoftLayer_Layout_Container_Type]({{}}) -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The internal identifier of the related [SoftLayer_Layout_Container_Type]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The friendly name of the layout container [layoutContainerType]: #layoutcontainertype #### [layoutContainerType] The type of the layout container object -Type: **SoftLayer_Layout_Container_Type ** +Type: **SoftLayer_Layout_Container_Type ** + @@ -101,7 +108,8 @@ The type of the layout container object [layoutItems]: #layoutitems #### [layoutItems] The layout items assigned to this layout container -Type: **SoftLayer_Layout_Item[] ** +Type: **SoftLayer_Layout_Item[] ** + @@ -113,7 +121,8 @@ The layout items assigned to this layout container [layoutItemCount]: #layoutitemcount #### [layoutItemCount] A count of the layout items assigned to this layout container -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Layout_Container_Type/_index.md b/content/reference/datatypes/SoftLayer_Layout_Container_Type/_index.md index c0989f4b48..2d3f7d85de 100644 --- a/content/reference/datatypes/SoftLayer_Layout_Container_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Layout_Container_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Layout_Container_Type contains definitions for container types @@ -45,7 +47,8 @@ The SoftLayer_Layout_Container_Type contains definitions for container types [id]: #id #### [id] The internal identifier of the container type -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of the container type [keyname]: #keyname #### [keyname] The unique key name of the container type, used primarily for programmatic purposes -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The unique key name of the container type, used primarily for programmatic purpo [name]: #name #### [name] The friendly name of the container type -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Layout_Item/_index.md b/content/reference/datatypes/SoftLayer_Layout_Item/_index.md index 616d972403..f1cdab1b43 100644 --- a/content/reference/datatypes/SoftLayer_Layout_Item/_index.md +++ b/content/reference/datatypes/SoftLayer_Layout_Item/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Layout_Item contains definitions for default layout items @@ -45,7 +47,8 @@ The SoftLayer_Layout_Item contains definitions for default layout items [id]: #id #### [id] The internal identifier of a layout item -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of a layout item [keyname]: #keyname #### [keyname] The unique key name of the layout item, used primarily for programmatic purposes -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The unique key name of the layout item, used primarily for programmatic purposes [layoutItemTypeId]: #layoutitemtypeid #### [layoutItemTypeId] The internal identifier of the related [SoftLayer_Layout_Item_Type]({{}}) -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The internal identifier of the related [SoftLayer_Layout_Item_Type]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The friendly name of the layout item [layoutItemPreferences]: #layoutitempreferences #### [layoutItemPreferences] The layout preferences assigned to this layout item -Type: **SoftLayer_Layout_Preference[] ** +Type: **SoftLayer_Layout_Preference[] ** + @@ -101,7 +108,8 @@ The layout preferences assigned to this layout item [layoutItemType]: #layoutitemtype #### [layoutItemType] The type of the layout item object -Type: **SoftLayer_Layout_Item_Type ** +Type: **SoftLayer_Layout_Item_Type ** + @@ -113,7 +121,8 @@ The type of the layout item object [layoutItemPreferenceCount]: #layoutitempreferencecount #### [layoutItemPreferenceCount] A count of the layout preferences assigned to this layout item -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Layout_Item_Type/_index.md b/content/reference/datatypes/SoftLayer_Layout_Item_Type/_index.md index 0b76ab36fc..94ae687f2c 100644 --- a/content/reference/datatypes/SoftLayer_Layout_Item_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Layout_Item_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Layout_Item_Type contains definitions for item types @@ -45,7 +47,8 @@ The SoftLayer_Layout_Item_Type contains definitions for item types [id]: #id #### [id] The internal identifier of the item type -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of the item type [keyname]: #keyname #### [keyname] The unique key name of the item type, used primarily for programmatic purposes -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The unique key name of the item type, used primarily for programmatic purposes [name]: #name #### [name] The friendly name of the item type -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Layout_Preference/_index.md b/content/reference/datatypes/SoftLayer_Layout_Preference/_index.md index aeb90c3f61..21360dcbd5 100644 --- a/content/reference/datatypes/SoftLayer_Layout_Preference/_index.md +++ b/content/reference/datatypes/SoftLayer_Layout_Preference/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Layout_Preference contains definitions for default layout item preferences @@ -45,7 +47,8 @@ The SoftLayer_Layout_Preference contains definitions for default layout item pre [id]: #id #### [id] The internal identifier of a layout preference -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of a layout preference [layoutPreferenceTypeId]: #layoutpreferencetypeid #### [layoutPreferenceTypeId] The internal identifier of the related [SoftLayer_Layout_Preference_Type]({{}}) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The internal identifier of the related [SoftLayer_Layout_Preference_Type]({{Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ The default value of the preference [layoutPreferenceType]: #layoutpreferencetype #### [layoutPreferenceType] The type of the preference object -Type: **SoftLayer_Layout_Preference_Type ** +Type: **SoftLayer_Layout_Preference_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Layout_Preference_Type/_index.md b/content/reference/datatypes/SoftLayer_Layout_Preference_Type/_index.md index 1f33a79bd4..d0febbc4f5 100644 --- a/content/reference/datatypes/SoftLayer_Layout_Preference_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Layout_Preference_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Layout_Preference_Type contains definitions for preference types @@ -45,7 +47,8 @@ The SoftLayer_Layout_Preference_Type contains definitions for preference types [id]: #id #### [id] The internal identifier of the item type -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of the item type [keyname]: #keyname #### [keyname] The unique key name of the item type, used primarily for programmatic purposes -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The unique key name of the item type, used primarily for programmatic purposes [name]: #name #### [name] The friendly name of the item type -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The friendly name of the item type [valueExpression]: #valueexpression #### [valueExpression] A regular expression used to validate the related [SoftLayer_Layout_Preference]({{}}) -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Layout_Profile/_index.md b/content/reference/datatypes/SoftLayer_Layout_Profile/_index.md index 79357b1827..32136b2849 100644 --- a/content/reference/datatypes/SoftLayer_Layout_Profile/_index.md +++ b/content/reference/datatypes/SoftLayer_Layout_Profile/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Layout_Profile contains the definition of the layout profile @@ -45,7 +47,8 @@ The SoftLayer_Layout_Profile contains the definition of the layout profile [activeFlag]: #activeflag #### [activeFlag] Active status of the layout profile -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Active status of the layout profile [createDate]: #createdate #### [createDate] Timestamp of when the layout profile was created -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ Timestamp of when the layout profile was created [id]: #id #### [id] The internal identifier of a layout profile -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The internal identifier of a layout profile [modifyDate]: #modifydate #### [modifyDate] Timestamp of when the layout profile was last updated -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ Timestamp of when the layout profile was last updated [name]: #name #### [name] The friendly name of the layout profile -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The friendly name of the layout profile [userRecordId]: #userrecordid #### [userRecordId] The [SoftLayer_User_Customer]({{}}) owning this layout profile -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The [SoftLayer_User_Customer]({{Type: **SoftLayer_Layout_Container[] ** +Type: **SoftLayer_Layout_Container[] ** + @@ -121,7 +130,8 @@ The [SoftLayer_User_Customer]({{Type: **SoftLayer_Layout_Profile_Preference[] ** +Type: **SoftLayer_Layout_Profile_Preference[] ** + @@ -133,7 +143,8 @@ The [SoftLayer_User_Customer]({{Type: **unsigned long** +Type: **unsigned long** + @@ -143,7 +154,8 @@ A count of [layoutPreferenceCount]: #layoutpreferencecount #### [layoutPreferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Layout_Profile_Containers/_index.md b/content/reference/datatypes/SoftLayer_Layout_Profile_Containers/_index.md index a4b30518ed..c6584721fa 100644 --- a/content/reference/datatypes/SoftLayer_Layout_Profile_Containers/_index.md +++ b/content/reference/datatypes/SoftLayer_Layout_Profile_Containers/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] Timestamp of when the reference was created -Type: **dateTime** +Type: **dateTime** +
      @@ -55,7 +58,8 @@ Timestamp of when the reference was created [id]: #id #### [id] The internal identifier of the container reference -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ The internal identifier of the container reference [layoutContainerId]: #layoutcontainerid #### [layoutContainerId] The id of the referenced [SoftLayer_Layout_Container]({{}}) -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The id of the referenced [SoftLayer_Layout_Container]({{}}) -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The id of the referenced [SoftLayer_Layout_Profile]({{Type: **dateTime** +Type: **dateTime** + @@ -101,7 +108,8 @@ Timestamp of when the reference was last updated [layoutContainerType]: #layoutcontainertype #### [layoutContainerType] The container to be contained -Type: **SoftLayer_Layout_Container ** +Type: **SoftLayer_Layout_Container ** + @@ -111,7 +119,8 @@ The container to be contained [layoutProfile]: #layoutprofile #### [layoutProfile] The profile containing this container -Type: **SoftLayer_Layout_Profile ** +Type: **SoftLayer_Layout_Profile ** + diff --git a/content/reference/datatypes/SoftLayer_Layout_Profile_Customer/_index.md b/content/reference/datatypes/SoftLayer_Layout_Profile_Customer/_index.md index 47f25dec2c..c0e538399f 100644 --- a/content/reference/datatypes/SoftLayer_Layout_Profile_Customer/_index.md +++ b/content/reference/datatypes/SoftLayer_Layout_Profile_Customer/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [activeFlag]: #activeflag #### [activeFlag] Active status of the layout profile -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ Active status of the layout profile [createDate]: #createdate #### [createDate] Timestamp of when the layout profile was created -Type: **dateTime** +Type: **dateTime** +
      @@ -65,7 +69,8 @@ Timestamp of when the layout profile was created [id]: #id #### [id] The internal identifier of a layout profile -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The internal identifier of a layout profile [modifyDate]: #modifydate #### [modifyDate] Timestamp of when the layout profile was last updated -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ Timestamp of when the layout profile was last updated [name]: #name #### [name] The friendly name of the layout profile -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The friendly name of the layout profile [userRecordId]: #userrecordid #### [userRecordId] The [SoftLayer_User_Customer]({{}}) owning this layout profile -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The [SoftLayer_User_Customer]({{Type: **SoftLayer_Layout_Container[] ** +Type: **SoftLayer_Layout_Container[] ** + @@ -121,7 +130,8 @@ The [SoftLayer_User_Customer]({{Type: **SoftLayer_Layout_Profile_Preference[] ** +Type: **SoftLayer_Layout_Profile_Preference[] ** + @@ -131,7 +141,8 @@ The [SoftLayer_User_Customer]({{Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -143,7 +154,8 @@ The [SoftLayer_User_Customer]({{Type: **unsigned long** +Type: **unsigned long** + @@ -153,7 +165,8 @@ A count of [layoutPreferenceCount]: #layoutpreferencecount #### [layoutPreferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Layout_Profile_Preference/_index.md b/content/reference/datatypes/SoftLayer_Layout_Profile_Preference/_index.md index ff8cddb299..511ddfcaef 100644 --- a/content/reference/datatypes/SoftLayer_Layout_Profile_Preference/_index.md +++ b/content/reference/datatypes/SoftLayer_Layout_Profile_Preference/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Layout_Profile_Preference contains definitions for layout preferences @@ -45,7 +47,8 @@ The SoftLayer_Layout_Profile_Preference contains definitions for layout preferen [createDate]: #createdate #### [createDate] Timestamp of when the preference was created -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ Timestamp of when the preference was created [defaultValueFlag]: #defaultvalueflag #### [defaultValueFlag] Indicates whether this is a default value or not -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Indicates whether this is a default value or not [layoutContainerId]: #layoutcontainerid #### [layoutContainerId] The id of the related [SoftLayer_Layout_Container]({{}}) -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The id of the related [SoftLayer_Layout_Container]({{}}) -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The id of the related [SoftLayer_Layout_Item]({{}}) -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The internal identifier of the overridden [SoftLayer_Layout_Preference]({{}}) -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The internal identifier of the related [SoftLayer_Layout_Profile]({{Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ Timestamp of when the preference was last updated [value]: #value #### [value] The value overriding the default value -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The value overriding the default value [layoutContainer]: #layoutcontainer #### [layoutContainer] -Type: **SoftLayer_Layout_Container ** +Type: **SoftLayer_Layout_Container ** + @@ -141,7 +152,8 @@ The value overriding the default value [layoutItem]: #layoutitem #### [layoutItem] -Type: **SoftLayer_Layout_Item ** +Type: **SoftLayer_Layout_Item ** + @@ -151,7 +163,8 @@ The value overriding the default value [layoutPreference]: #layoutpreference #### [layoutPreference] -Type: **SoftLayer_Layout_Preference ** +Type: **SoftLayer_Layout_Preference ** + @@ -161,7 +174,8 @@ The value overriding the default value [layoutProfile]: #layoutprofile #### [layoutProfile] -Type: **SoftLayer_Layout_Profile ** +Type: **SoftLayer_Layout_Profile ** + diff --git a/content/reference/datatypes/SoftLayer_Legal_RegulatedWorkload/_index.md b/content/reference/datatypes/SoftLayer_Legal_RegulatedWorkload/_index.md index 9870153b4d..e89ddcebe8 100644 --- a/content/reference/datatypes/SoftLayer_Legal_RegulatedWorkload/_index.md +++ b/content/reference/datatypes/SoftLayer_Legal_RegulatedWorkload/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [enabledFlag]: #enabledflag #### [enabledFlag] -Type: **boolean** +Type: **boolean** +
      @@ -65,7 +69,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [workloadTypeId]: #workloadtypeid #### [workloadTypeId] -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ classes: [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -101,7 +108,8 @@ classes: [type]: #type #### [type] -Type: **SoftLayer_Legal_RegulatedWorkload_Type ** +Type: **SoftLayer_Legal_RegulatedWorkload_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Legal_RegulatedWorkload_Type/_index.md b/content/reference/datatypes/SoftLayer_Legal_RegulatedWorkload_Type/_index.md index 5cd1498fca..78a5e7383b 100644 --- a/content/reference/datatypes/SoftLayer_Legal_RegulatedWorkload_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Legal_RegulatedWorkload_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Locale/_index.md b/content/reference/datatypes/SoftLayer_Locale/_index.md index 6da2d8c45a..9f1ca23bbb 100644 --- a/content/reference/datatypes/SoftLayer_Locale/_index.md +++ b/content/reference/datatypes/SoftLayer_Locale/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [friendlyName]: #friendlyname #### [friendlyName] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] Internal identification number of a locale -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ Internal identification number of a locale [languageTag]: #languagetag #### [languageTag] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Internal identification number of a locale [name]: #name #### [name] Locale name -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Locale_Country/_index.md b/content/reference/datatypes/SoftLayer_Locale_Country/_index.md index 2ea5ac5db2..7d32fdb1ea 100644 --- a/content/reference/datatypes/SoftLayer_Locale_Country/_index.md +++ b/content/reference/datatypes/SoftLayer_Locale_Country/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [isEuropeanUnionFlag]: #iseuropeanunionflag #### [isEuropeanUnionFlag] Binary flag denoting if this country is part of the European Union -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ Binary flag denoting if this country is part of the European Union [isoCodeAlphaThree]: #isocodealphathree #### [isoCodeAlphaThree] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ Binary flag denoting if this country is part of the European Union [longName]: #longname #### [longName] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Binary flag denoting if this country is part of the European Union [postalCodeFormat]: #postalcodeformat #### [postalCodeFormat] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ Binary flag denoting if this country is part of the European Union [postalCodeRequiredFlag]: #postalcoderequiredflag #### [postalCodeRequiredFlag] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ Binary flag denoting if this country is part of the European Union [shortName]: #shortname #### [shortName] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ Binary flag denoting if this country is part of the European Union [vatIdRegex]: #vatidregex #### [vatIdRegex] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ Binary flag denoting if this country is part of the European Union [vatIdRequiredFlag]: #vatidrequiredflag #### [vatIdRequiredFlag] -Type: **boolean** +Type: **boolean** + @@ -131,7 +141,8 @@ Binary flag denoting if this country is part of the European Union [states]: #states #### [states] States that belong to this country. -Type: **SoftLayer_Locale_StateProvince[] ** +Type: **SoftLayer_Locale_StateProvince[] ** + @@ -143,7 +154,8 @@ States that belong to this country. [stateCount]: #statecount #### [stateCount] A count of states that belong to this country. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Locale_StateProvince/_index.md b/content/reference/datatypes/SoftLayer_Locale_StateProvince/_index.md index 70e7ec5bf6..8d1efb7b6b 100644 --- a/content/reference/datatypes/SoftLayer_Locale_StateProvince/_index.md +++ b/content/reference/datatypes/SoftLayer_Locale_StateProvince/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object represents a state or province for a country. @@ -45,7 +47,8 @@ This object represents a state or province for a country. [longName]: #longname #### [longName] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ This object represents a state or province for a country. [shortName]: #shortname #### [shortName] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Locale_Timezone/_index.md b/content/reference/datatypes/SoftLayer_Locale_Timezone/_index.md index 886811b427..e4dfdd06c2 100644 --- a/content/reference/datatypes/SoftLayer_Locale_Timezone/_index.md +++ b/content/reference/datatypes/SoftLayer_Locale_Timezone/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Each User is assigned a timezone allowing for a precise local timestamp. @@ -55,7 +57,8 @@ Each User is assigned a timezone allowing for a precise local timestamp. [id]: #id #### [id] A timezone's identifying number. -Type: **integer** +Type: **integer** + @@ -65,7 +68,8 @@ A timezone's identifying number. [longName]: #longname #### [longName] A timezone's long name. For example, "(GMT-06:00) America/Dallas - CST". -Type: **string** +Type: **string** + @@ -75,7 +79,8 @@ A timezone's long name. For example, "(GMT-06:00) America/Dallas - CST". [name]: #name #### [name] A timezone's name. For example, "America/Dallas". -Type: **string** +Type: **string** + @@ -85,7 +90,8 @@ A timezone's name. For example, "America/Dallas". [offset]: #offset #### [offset] A timezone's offset based on the GMT standard. For example, Central Standard Time's offset is "-0600" from GMT=0000. -Type: **string** +Type: **string** + @@ -95,7 +101,8 @@ A timezone's offset based on the GMT standard. For example, Central Standard Tim [shortName]: #shortname #### [shortName] A timezone's common abbreviation. For example, Central Standard Time's abbreviation is "CST". -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Location/_index.md b/content/reference/datatypes/SoftLayer_Location/_index.md index a3730085c2..e60142bc25 100644 --- a/content/reference/datatypes/SoftLayer_Location/_index.md +++ b/content/reference/datatypes/SoftLayer_Location/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. Network backbones are tied to datacenters only, not to a room, rack, or slot. @@ -52,7 +54,8 @@ Every piece of hardware and network connection owned by SoftLayer is tracked phy [id]: #id #### [id] The unique identifier of a specific location. -Type: **integer** +Type: **integer** + @@ -62,7 +65,8 @@ The unique identifier of a specific location. [longName]: #longname #### [longName] A longer location description. -Type: **string** +Type: **string** + @@ -72,7 +76,8 @@ A longer location description. [name]: #name #### [name] A short location description. -Type: **string** +Type: **string** + @@ -82,7 +87,8 @@ A short location description. [statusId]: #statusid #### [statusId] -Type: **integer** +Type: **integer** + @@ -98,7 +104,8 @@ A short location description. [activePresaleEvents]: #activepresaleevents #### [activePresaleEvents] -Type: **SoftLayer_Sales_Presale_Event[] ** +Type: **SoftLayer_Sales_Presale_Event[] ** + @@ -108,7 +115,8 @@ A short location description. [backboneDependents]: #backbonedependents #### [backboneDependents] -Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** +Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** + @@ -118,7 +126,8 @@ A short location description. [bnppCompliantFlag]: #bnppcompliantflag #### [bnppCompliantFlag] A flag indicating whether or not the datacenter/location is BNPP compliant. -Type: **boolean** +Type: **boolean** + @@ -128,7 +137,8 @@ A flag indicating whether or not the datacenter/location is BNPP compliant. [euCompliantFlag]: #eucompliantflag #### [euCompliantFlag] A flag indicating whether or not the datacenter/location is EU compliant. -Type: **boolean** +Type: **boolean** + @@ -138,7 +148,8 @@ A flag indicating whether or not the datacenter/location is EU compliant. [groups]: #groups #### [groups] A location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -148,7 +159,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [hardwareFirewalls]: #hardwarefirewalls #### [hardwareFirewalls] -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -158,7 +170,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [locationAddress]: #locationaddress #### [locationAddress] A location's physical address. -Type: **SoftLayer_Account_Address ** +Type: **SoftLayer_Account_Address ** + @@ -168,7 +181,8 @@ A location's physical address. [locationAddresses]: #locationaddresses #### [locationAddresses] A location's physical addresses. -Type: **SoftLayer_Account_Address[] ** +Type: **SoftLayer_Account_Address[] ** + @@ -178,7 +192,8 @@ A location's physical addresses. [locationReservationMember]: #locationreservationmember #### [locationReservationMember] A location's Dedicated Rack member -Type: **SoftLayer_Location_Reservation_Rack_Member ** +Type: **SoftLayer_Location_Reservation_Rack_Member ** + @@ -188,7 +203,8 @@ A location's Dedicated Rack member [locationStatus]: #locationstatus #### [locationStatus] The current locations status. -Type: **SoftLayer_Location_Status ** +Type: **SoftLayer_Location_Status ** + @@ -198,7 +214,8 @@ The current locations status. [networkConfigurationAttribute]: #networkconfigurationattribute #### [networkConfigurationAttribute] -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -208,7 +225,8 @@ The current locations status. [onlineSslVpnUserCount]: #onlinesslvpnusercount #### [onlineSslVpnUserCount] The total number of users online using SoftLayer's SSL VPN service for a location. -Type: **integer** +Type: **integer** + @@ -218,7 +236,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [pathString]: #pathstring #### [pathString] -Type: **string** +Type: **string** + @@ -228,7 +247,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [priceGroups]: #pricegroups #### [priceGroups] A location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -238,7 +258,8 @@ A location can be a member of 1 or more Price Groups. This will show which group [regions]: #regions #### [regions] A location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **SoftLayer_Location_Region[] ** +Type: **SoftLayer_Location_Region[] ** + @@ -248,7 +269,8 @@ A location can be a member of 1 or more regions. This will show which regions to [timezone]: #timezone #### [timezone] -Type: **SoftLayer_Locale_Timezone ** +Type: **SoftLayer_Locale_Timezone ** + @@ -258,7 +280,8 @@ A location can be a member of 1 or more regions. This will show which regions to [vdrGroup]: #vdrgroup #### [vdrGroup] A location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs. -Type: **SoftLayer_Location_Group_Location_CrossReference ** +Type: **SoftLayer_Location_Group_Location_CrossReference ** + @@ -270,7 +293,8 @@ A location can be a member of 1 Bandwidth Pooling Group. This will show which gr [activePresaleEventCount]: #activepresaleeventcount #### [activePresaleEventCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -280,7 +304,8 @@ A count of [backboneDependentCount]: #backbonedependentcount #### [backboneDependentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -290,7 +315,8 @@ A count of [groupCount]: #groupcount #### [groupCount] A count of a location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -300,7 +326,8 @@ A count of a location can be a member of 1 or more groups. This will show which [hardwareFirewallCount]: #hardwarefirewallcount #### [hardwareFirewallCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -310,7 +337,8 @@ A count of [locationAddressCount]: #locationaddresscount #### [locationAddressCount] A count of a location's physical addresses. -Type: **unsigned long** +Type: **unsigned long** + @@ -320,7 +348,8 @@ A count of a location's physical addresses. [priceGroupCount]: #pricegroupcount #### [priceGroupCount] A count of a location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -330,7 +359,8 @@ A count of a location can be a member of 1 or more Price Groups. This will show [regionCount]: #regioncount #### [regionCount] A count of a location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Location_Datacenter/_index.md b/content/reference/datatypes/SoftLayer_Location_Datacenter/_index.md index 6a2b54a403..215d1bf371 100644 --- a/content/reference/datatypes/SoftLayer_Location_Datacenter/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Datacenter/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Location_Datacenter extends the [SoftLayer_Location]({{}}) data type to include datacenter-specific properties. @@ -56,7 +58,8 @@ SoftLayer_Location_Datacenter extends the [SoftLayer_Location]({{Type: **integer** +Type: **integer** + @@ -66,7 +69,8 @@ The unique identifier of a specific location. [longName]: #longname #### [longName] A longer location description. -Type: **string** +Type: **string** + @@ -76,7 +80,8 @@ A longer location description. [name]: #name #### [name] A short location description. -Type: **string** +Type: **string** + @@ -86,7 +91,8 @@ A short location description. [statusId]: #statusid #### [statusId] -Type: **integer** +Type: **integer** + @@ -102,7 +108,8 @@ A short location description. [activeItemPresaleEvents]: #activeitempresaleevents #### [activeItemPresaleEvents] -Type: **SoftLayer_Sales_Presale_Event[] ** +Type: **SoftLayer_Sales_Presale_Event[] ** + @@ -112,7 +119,8 @@ A short location description. [activePresaleEvents]: #activepresaleevents #### [activePresaleEvents] -Type: **SoftLayer_Sales_Presale_Event[] ** +Type: **SoftLayer_Sales_Presale_Event[] ** + @@ -122,7 +130,8 @@ A short location description. [backboneDependents]: #backbonedependents #### [backboneDependents] -Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** +Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** + @@ -132,7 +141,8 @@ A short location description. [backendHardwareRouters]: #backendhardwarerouters #### [backendHardwareRouters] -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -142,7 +152,8 @@ A short location description. [bnppCompliantFlag]: #bnppcompliantflag #### [bnppCompliantFlag] A flag indicating whether or not the datacenter/location is BNPP compliant. -Type: **boolean** +Type: **boolean** + @@ -152,7 +163,8 @@ A flag indicating whether or not the datacenter/location is BNPP compliant. [boundSubnets]: #boundsubnets #### [boundSubnets] Subnets which are directly bound to one or more routers in a given datacenter, and currently allow routing. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -162,7 +174,8 @@ Subnets which are directly bound to one or more routers in a given datacenter, a [brandCountryRestrictions]: #brandcountryrestrictions #### [brandCountryRestrictions] This references 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 this brand for customers that live in Great Britain. -Type: **SoftLayer_Brand_Restriction_Location_CustomerCountry[] ** +Type: **SoftLayer_Brand_Restriction_Location_CustomerCountry[] ** + @@ -172,7 +185,8 @@ This references relationship between brands, locations and countries associated [euCompliantFlag]: #eucompliantflag #### [euCompliantFlag] A flag indicating whether or not the datacenter/location is EU compliant. -Type: **boolean** +Type: **boolean** + @@ -182,7 +196,8 @@ A flag indicating whether or not the datacenter/location is EU compliant. [frontendHardwareRouters]: #frontendhardwarerouters #### [frontendHardwareRouters] -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -192,7 +207,8 @@ A flag indicating whether or not the datacenter/location is EU compliant. [groups]: #groups #### [groups] A location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -202,7 +218,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [hardwareFirewalls]: #hardwarefirewalls #### [hardwareFirewalls] -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -212,7 +229,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [hardwareRouters]: #hardwarerouters #### [hardwareRouters] -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -222,7 +240,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [locationAddress]: #locationaddress #### [locationAddress] A location's physical address. -Type: **SoftLayer_Account_Address ** +Type: **SoftLayer_Account_Address ** + @@ -232,7 +251,8 @@ A location's physical address. [locationAddresses]: #locationaddresses #### [locationAddresses] A location's physical addresses. -Type: **SoftLayer_Account_Address[] ** +Type: **SoftLayer_Account_Address[] ** + @@ -242,7 +262,8 @@ A location's physical addresses. [locationReservationMember]: #locationreservationmember #### [locationReservationMember] A location's Dedicated Rack member -Type: **SoftLayer_Location_Reservation_Rack_Member ** +Type: **SoftLayer_Location_Reservation_Rack_Member ** + @@ -252,7 +273,8 @@ A location's Dedicated Rack member [locationStatus]: #locationstatus #### [locationStatus] The current locations status. -Type: **SoftLayer_Location_Status ** +Type: **SoftLayer_Location_Status ** + @@ -262,7 +284,8 @@ The current locations status. [networkConfigurationAttribute]: #networkconfigurationattribute #### [networkConfigurationAttribute] -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -272,7 +295,8 @@ The current locations status. [onlineSslVpnUserCount]: #onlinesslvpnusercount #### [onlineSslVpnUserCount] The total number of users online using SoftLayer's SSL VPN service for a location. -Type: **integer** +Type: **integer** + @@ -282,7 +306,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [pathString]: #pathstring #### [pathString] -Type: **string** +Type: **string** + @@ -292,7 +317,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [presaleEvents]: #presaleevents #### [presaleEvents] -Type: **SoftLayer_Sales_Presale_Event[] ** +Type: **SoftLayer_Sales_Presale_Event[] ** + @@ -302,7 +328,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [priceGroups]: #pricegroups #### [priceGroups] A location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -312,7 +339,8 @@ A location can be a member of 1 or more Price Groups. This will show which group [regionalGroup]: #regionalgroup #### [regionalGroup] The regional group this datacenter belongs to. -Type: **SoftLayer_Location_Group_Regional ** +Type: **SoftLayer_Location_Group_Regional ** + @@ -322,7 +350,8 @@ The regional group this datacenter belongs to. [regionalInternetRegistry]: #regionalinternetregistry #### [regionalInternetRegistry] -Type: **SoftLayer_Network_Regional_Internet_Registry ** +Type: **SoftLayer_Network_Regional_Internet_Registry ** + @@ -332,7 +361,8 @@ The regional group this datacenter belongs to. [regions]: #regions #### [regions] A location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **SoftLayer_Location_Region[] ** +Type: **SoftLayer_Location_Region[] ** + @@ -342,7 +372,8 @@ A location can be a member of 1 or more regions. This will show which regions to [routableBoundSubnets]: #routableboundsubnets #### [routableBoundSubnets] Retrieve all subnets that are eligible to be routed; those which the account has permission to associate with a vlan. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -352,7 +383,8 @@ Retrieve all subnets that are eligible to be routed; those which the account has [timezone]: #timezone #### [timezone] -Type: **SoftLayer_Locale_Timezone ** +Type: **SoftLayer_Locale_Timezone ** + @@ -362,7 +394,8 @@ Retrieve all subnets that are eligible to be routed; those which the account has [vdrGroup]: #vdrgroup #### [vdrGroup] A location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs. -Type: **SoftLayer_Location_Group_Location_CrossReference ** +Type: **SoftLayer_Location_Group_Location_CrossReference ** + @@ -374,7 +407,8 @@ A location can be a member of 1 Bandwidth Pooling Group. This will show which gr [activeItemPresaleEventCount]: #activeitempresaleeventcount #### [activeItemPresaleEventCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -384,7 +418,8 @@ A count of [activePresaleEventCount]: #activepresaleeventcount #### [activePresaleEventCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -394,7 +429,8 @@ A count of [backboneDependentCount]: #backbonedependentcount #### [backboneDependentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -404,7 +440,8 @@ A count of [backendHardwareRouterCount]: #backendhardwareroutercount #### [backendHardwareRouterCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -414,7 +451,8 @@ A count of [boundSubnetCount]: #boundsubnetcount #### [boundSubnetCount] A count of subnets which are directly bound to one or more routers in a given datacenter, and currently allow routing. -Type: **unsigned long** +Type: **unsigned long** + @@ -424,7 +462,8 @@ A count of subnets which are directly bound to one or more routers in a given da [brandCountryRestrictionCount]: #brandcountryrestrictioncount #### [brandCountryRestrictionCount] A count of this references 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 this brand for customers that live in Great Britain. -Type: **unsigned long** +Type: **unsigned long** + @@ -434,7 +473,8 @@ A count of this references relationship between brands, locations and countries [frontendHardwareRouterCount]: #frontendhardwareroutercount #### [frontendHardwareRouterCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -444,7 +484,8 @@ A count of [groupCount]: #groupcount #### [groupCount] A count of a location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -454,7 +495,8 @@ A count of a location can be a member of 1 or more groups. This will show which [hardwareFirewallCount]: #hardwarefirewallcount #### [hardwareFirewallCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -464,7 +506,8 @@ A count of [hardwareRouterCount]: #hardwareroutercount #### [hardwareRouterCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -474,7 +517,8 @@ A count of [locationAddressCount]: #locationaddresscount #### [locationAddressCount] A count of a location's physical addresses. -Type: **unsigned long** +Type: **unsigned long** + @@ -484,7 +528,8 @@ A count of a location's physical addresses. [presaleEventCount]: #presaleeventcount #### [presaleEventCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -494,7 +539,8 @@ A count of [priceGroupCount]: #pricegroupcount #### [priceGroupCount] A count of a location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -504,7 +550,8 @@ A count of a location can be a member of 1 or more Price Groups. This will show [regionCount]: #regioncount #### [regionCount] A count of a location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -514,7 +561,8 @@ A count of a location can be a member of 1 or more regions. This will show which [routableBoundSubnetCount]: #routableboundsubnetcount #### [routableBoundSubnetCount] A count of retrieve all subnets that are eligible to be routed; those which the account has permission to associate with a vlan. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Location_Group/_index.md b/content/reference/datatypes/SoftLayer_Location_Group/_index.md index d31b2dc75a..1c4aa0f27f 100644 --- a/content/reference/datatypes/SoftLayer_Location_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Group/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [locationGroupTypeId]: #locationgrouptypeid #### [locationGroupTypeId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [securityLevelId]: #securitylevelid #### [securityLevelId] -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ classes: [locationGroupType]: #locationgrouptype #### [locationGroupType] The type for this location group. -Type: **SoftLayer_Location_Group_Type ** +Type: **SoftLayer_Location_Group_Type ** + @@ -111,7 +119,8 @@ The type for this location group. [locations]: #locations #### [locations] The locations in a group. -Type: **SoftLayer_Location[] ** +Type: **SoftLayer_Location[] ** + @@ -123,7 +132,8 @@ The locations in a group. [locationCount]: #locationcount #### [locationCount] A count of the locations in a group. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Location_Group_Location_CrossReference/_index.md b/content/reference/datatypes/SoftLayer_Location_Group_Location_CrossReference/_index.md index 20d5d60194..72f143b194 100644 --- a/content/reference/datatypes/SoftLayer_Location_Group_Location_CrossReference/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Group_Location_CrossReference/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [locationGroupId]: #locationgroupid #### [locationGroupId] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [locationId]: #locationid #### [locationId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [priority]: #priority #### [priority] If set, this is the priority of this cross reference record in the group. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ If set, this is the priority of this cross reference record in the group. [location]: #location #### [location] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -101,7 +108,8 @@ If set, this is the priority of this cross reference record in the group. [locationGroup]: #locationgroup #### [locationGroup] -Type: **SoftLayer_Location_Group ** +Type: **SoftLayer_Location_Group ** + diff --git a/content/reference/datatypes/SoftLayer_Location_Group_Pricing/_index.md b/content/reference/datatypes/SoftLayer_Location_Group_Pricing/_index.md index a4764cee26..84349abafa 100644 --- a/content/reference/datatypes/SoftLayer_Location_Group_Pricing/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Group_Pricing/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [locationGroupTypeId]: #locationgrouptypeid #### [locationGroupTypeId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [securityLevelId]: #securitylevelid #### [securityLevelId] -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ classes: [locationGroupType]: #locationgrouptype #### [locationGroupType] The type for this location group. -Type: **SoftLayer_Location_Group_Type ** +Type: **SoftLayer_Location_Group_Type ** + @@ -111,7 +119,8 @@ The type for this location group. [locations]: #locations #### [locations] The locations that this pricing location group is applicable for. This limits the locations that the prices referenced by this pricing location group can be used with. -Type: **SoftLayer_Location[] ** +Type: **SoftLayer_Location[] ** + @@ -121,7 +130,8 @@ The locations that this pricing location group is applicable for. This limits th [prices]: #prices #### [prices] The prices that this pricing location group limits. All of these prices will only be available in the locations defined by this pricing location group. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -133,7 +143,8 @@ The prices that this pricing location group limits. All of these prices will onl [locationCount]: #locationcount #### [locationCount] A count of the locations that this pricing location group is applicable for. This limits the locations that the prices referenced by this pricing location group can be used with. -Type: **unsigned long** +Type: **unsigned long** + @@ -143,7 +154,8 @@ A count of the locations that this pricing location group is applicable for. Thi [priceCount]: #pricecount #### [priceCount] A count of the prices that this pricing location group limits. All of these prices will only be available in the locations defined by this pricing location group. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Location_Group_Regional/_index.md b/content/reference/datatypes/SoftLayer_Location_Group_Regional/_index.md index 9d9ab8f1c2..f5beaf26be 100644 --- a/content/reference/datatypes/SoftLayer_Location_Group_Regional/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Group_Regional/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [locationGroupTypeId]: #locationgrouptypeid #### [locationGroupTypeId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [securityLevelId]: #securitylevelid #### [securityLevelId] -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ classes: [datacenters]: #datacenters #### [datacenters] The datacenters in a group. -Type: **SoftLayer_Location[] ** +Type: **SoftLayer_Location[] ** + @@ -111,7 +119,8 @@ The datacenters in a group. [locationGroupType]: #locationgrouptype #### [locationGroupType] The type for this location group. -Type: **SoftLayer_Location_Group_Type ** +Type: **SoftLayer_Location_Group_Type ** + @@ -121,7 +130,8 @@ The type for this location group. [locations]: #locations #### [locations] The locations in a group. -Type: **SoftLayer_Location[] ** +Type: **SoftLayer_Location[] ** + @@ -131,7 +141,8 @@ The locations in a group. [preferredDatacenter]: #preferreddatacenter #### [preferredDatacenter] The preferred datacenters of a group. -Type: **SoftLayer_Location_Datacenter ** +Type: **SoftLayer_Location_Datacenter ** + @@ -143,7 +154,8 @@ The preferred datacenters of a group. [datacenterCount]: #datacentercount #### [datacenterCount] A count of the datacenters in a group. -Type: **unsigned long** +Type: **unsigned long** + @@ -153,7 +165,8 @@ A count of the datacenters in a group. [locationCount]: #locationcount #### [locationCount] A count of the locations in a group. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Location_Group_Type/_index.md b/content/reference/datatypes/SoftLayer_Location_Group_Type/_index.md index 5695342174..96da2e15d3 100644 --- a/content/reference/datatypes/SoftLayer_Location_Group_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Group_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
      diff --git a/content/reference/datatypes/SoftLayer_Location_Inventory_Room/_index.md b/content/reference/datatypes/SoftLayer_Location_Inventory_Room/_index.md index 159128c42f..8cb3280831 100644 --- a/content/reference/datatypes/SoftLayer_Location_Inventory_Room/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Inventory_Room/_index.md @@ -18,6 +18,8 @@ classes:
      ## Description + + SoftLayer_Location_Inventory_Room extends the [SoftLayer_Location]({{}}) data type to include inventory room-specific properties. @@ -50,7 +52,8 @@ SoftLayer_Location_Inventory_Room extends the [SoftLayer_Location]({{Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ The unique identifier of a specific location. [longName]: #longname #### [longName] A longer location description. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ A longer location description. [name]: #name #### [name] A short location description. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ A short location description. [statusId]: #statusid #### [statusId] -Type: **integer** +Type: **integer** + @@ -96,7 +102,8 @@ A short location description. [activePresaleEvents]: #activepresaleevents #### [activePresaleEvents] -Type: **SoftLayer_Sales_Presale_Event[] ** +Type: **SoftLayer_Sales_Presale_Event[] ** + @@ -106,7 +113,8 @@ A short location description. [backboneDependents]: #backbonedependents #### [backboneDependents] -Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** +Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** + @@ -116,7 +124,8 @@ A short location description. [bnppCompliantFlag]: #bnppcompliantflag #### [bnppCompliantFlag] A flag indicating whether or not the datacenter/location is BNPP compliant. -Type: **boolean** +Type: **boolean** + @@ -126,7 +135,8 @@ A flag indicating whether or not the datacenter/location is BNPP compliant. [euCompliantFlag]: #eucompliantflag #### [euCompliantFlag] A flag indicating whether or not the datacenter/location is EU compliant. -Type: **boolean** +Type: **boolean** + @@ -136,7 +146,8 @@ A flag indicating whether or not the datacenter/location is EU compliant. [groups]: #groups #### [groups] A location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -146,7 +157,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [hardwareFirewalls]: #hardwarefirewalls #### [hardwareFirewalls] -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -156,7 +168,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [locationAddress]: #locationaddress #### [locationAddress] A location's physical address. -Type: **SoftLayer_Account_Address ** +Type: **SoftLayer_Account_Address ** + @@ -166,7 +179,8 @@ A location's physical address. [locationAddresses]: #locationaddresses #### [locationAddresses] A location's physical addresses. -Type: **SoftLayer_Account_Address[] ** +Type: **SoftLayer_Account_Address[] ** + @@ -176,7 +190,8 @@ A location's physical addresses. [locationReservationMember]: #locationreservationmember #### [locationReservationMember] A location's Dedicated Rack member -Type: **SoftLayer_Location_Reservation_Rack_Member ** +Type: **SoftLayer_Location_Reservation_Rack_Member ** + @@ -186,7 +201,8 @@ A location's Dedicated Rack member [locationStatus]: #locationstatus #### [locationStatus] The current locations status. -Type: **SoftLayer_Location_Status ** +Type: **SoftLayer_Location_Status ** + @@ -196,7 +212,8 @@ The current locations status. [networkConfigurationAttribute]: #networkconfigurationattribute #### [networkConfigurationAttribute] -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -206,7 +223,8 @@ The current locations status. [onlineSslVpnUserCount]: #onlinesslvpnusercount #### [onlineSslVpnUserCount] The total number of users online using SoftLayer's SSL VPN service for a location. -Type: **integer** +Type: **integer** + @@ -216,7 +234,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [pathString]: #pathstring #### [pathString] -Type: **string** +Type: **string** + @@ -226,7 +245,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [priceGroups]: #pricegroups #### [priceGroups] A location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -236,7 +256,8 @@ A location can be a member of 1 or more Price Groups. This will show which group [regions]: #regions #### [regions] A location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **SoftLayer_Location_Region[] ** +Type: **SoftLayer_Location_Region[] ** + @@ -246,7 +267,8 @@ A location can be a member of 1 or more regions. This will show which regions to [timezone]: #timezone #### [timezone] -Type: **SoftLayer_Locale_Timezone ** +Type: **SoftLayer_Locale_Timezone ** + @@ -256,7 +278,8 @@ A location can be a member of 1 or more regions. This will show which regions to [vdrGroup]: #vdrgroup #### [vdrGroup] A location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs. -Type: **SoftLayer_Location_Group_Location_CrossReference ** +Type: **SoftLayer_Location_Group_Location_CrossReference ** + @@ -268,7 +291,8 @@ A location can be a member of 1 Bandwidth Pooling Group. This will show which gr [activePresaleEventCount]: #activepresaleeventcount #### [activePresaleEventCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -278,7 +302,8 @@ A count of [backboneDependentCount]: #backbonedependentcount #### [backboneDependentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -288,7 +313,8 @@ A count of [groupCount]: #groupcount #### [groupCount] A count of a location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -298,7 +324,8 @@ A count of a location can be a member of 1 or more groups. This will show which [hardwareFirewallCount]: #hardwarefirewallcount #### [hardwareFirewallCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -308,7 +335,8 @@ A count of [locationAddressCount]: #locationaddresscount #### [locationAddressCount] A count of a location's physical addresses. -Type: **unsigned long** +Type: **unsigned long** + @@ -318,7 +346,8 @@ A count of a location's physical addresses. [priceGroupCount]: #pricegroupcount #### [priceGroupCount] A count of a location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -328,7 +357,8 @@ A count of a location can be a member of 1 or more Price Groups. This will show [regionCount]: #regioncount #### [regionCount] A count of a location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Location_Network_Operations_Center/_index.md b/content/reference/datatypes/SoftLayer_Location_Network_Operations_Center/_index.md index d13d2de560..d9f5dcb497 100644 --- a/content/reference/datatypes/SoftLayer_Location_Network_Operations_Center/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Network_Operations_Center/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Location_Network_Operations_Center extends the [SoftLayer_Location]({{}}) data type to include network operation center-specific properties. @@ -50,7 +52,8 @@ SoftLayer_Location_Network_Operations_Center extends the [SoftLayer_Location]({{ [id]: #id #### [id] The unique identifier of a specific location. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ The unique identifier of a specific location. [longName]: #longname #### [longName] A longer location description. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ A longer location description. [name]: #name #### [name] A short location description. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ A short location description. [statusId]: #statusid #### [statusId] -Type: **integer** +Type: **integer** + @@ -96,7 +102,8 @@ A short location description. [activePresaleEvents]: #activepresaleevents #### [activePresaleEvents] -Type: **SoftLayer_Sales_Presale_Event[] ** +Type: **SoftLayer_Sales_Presale_Event[] ** + @@ -106,7 +113,8 @@ A short location description. [backboneDependents]: #backbonedependents #### [backboneDependents] -Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** +Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** + @@ -116,7 +124,8 @@ A short location description. [bnppCompliantFlag]: #bnppcompliantflag #### [bnppCompliantFlag] A flag indicating whether or not the datacenter/location is BNPP compliant. -Type: **boolean** +Type: **boolean** + @@ -126,7 +135,8 @@ A flag indicating whether or not the datacenter/location is BNPP compliant. [euCompliantFlag]: #eucompliantflag #### [euCompliantFlag] A flag indicating whether or not the datacenter/location is EU compliant. -Type: **boolean** +Type: **boolean** + @@ -136,7 +146,8 @@ A flag indicating whether or not the datacenter/location is EU compliant. [groups]: #groups #### [groups] A location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -146,7 +157,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [hardwareFirewalls]: #hardwarefirewalls #### [hardwareFirewalls] -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -156,7 +168,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [locationAddress]: #locationaddress #### [locationAddress] A location's physical address. -Type: **SoftLayer_Account_Address ** +Type: **SoftLayer_Account_Address ** + @@ -166,7 +179,8 @@ A location's physical address. [locationAddresses]: #locationaddresses #### [locationAddresses] A location's physical addresses. -Type: **SoftLayer_Account_Address[] ** +Type: **SoftLayer_Account_Address[] ** + @@ -176,7 +190,8 @@ A location's physical addresses. [locationReservationMember]: #locationreservationmember #### [locationReservationMember] A location's Dedicated Rack member -Type: **SoftLayer_Location_Reservation_Rack_Member ** +Type: **SoftLayer_Location_Reservation_Rack_Member ** + @@ -186,7 +201,8 @@ A location's Dedicated Rack member [locationStatus]: #locationstatus #### [locationStatus] The current locations status. -Type: **SoftLayer_Location_Status ** +Type: **SoftLayer_Location_Status ** + @@ -196,7 +212,8 @@ The current locations status. [networkConfigurationAttribute]: #networkconfigurationattribute #### [networkConfigurationAttribute] -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -206,7 +223,8 @@ The current locations status. [onlineSslVpnUserCount]: #onlinesslvpnusercount #### [onlineSslVpnUserCount] The total number of users online using SoftLayer's SSL VPN service for a location. -Type: **integer** +Type: **integer** + @@ -216,7 +234,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [pathString]: #pathstring #### [pathString] -Type: **string** +Type: **string** + @@ -226,7 +245,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [priceGroups]: #pricegroups #### [priceGroups] A location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -236,7 +256,8 @@ A location can be a member of 1 or more Price Groups. This will show which group [regions]: #regions #### [regions] A location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **SoftLayer_Location_Region[] ** +Type: **SoftLayer_Location_Region[] ** + @@ -246,7 +267,8 @@ A location can be a member of 1 or more regions. This will show which regions to [timezone]: #timezone #### [timezone] -Type: **SoftLayer_Locale_Timezone ** +Type: **SoftLayer_Locale_Timezone ** + @@ -256,7 +278,8 @@ A location can be a member of 1 or more regions. This will show which regions to [vdrGroup]: #vdrgroup #### [vdrGroup] A location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs. -Type: **SoftLayer_Location_Group_Location_CrossReference ** +Type: **SoftLayer_Location_Group_Location_CrossReference ** + @@ -268,7 +291,8 @@ A location can be a member of 1 Bandwidth Pooling Group. This will show which gr [activePresaleEventCount]: #activepresaleeventcount #### [activePresaleEventCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -278,7 +302,8 @@ A count of [backboneDependentCount]: #backbonedependentcount #### [backboneDependentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -288,7 +313,8 @@ A count of [groupCount]: #groupcount #### [groupCount] A count of a location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -298,7 +324,8 @@ A count of a location can be a member of 1 or more groups. This will show which [hardwareFirewallCount]: #hardwarefirewallcount #### [hardwareFirewallCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -308,7 +335,8 @@ A count of [locationAddressCount]: #locationaddresscount #### [locationAddressCount] A count of a location's physical addresses. -Type: **unsigned long** +Type: **unsigned long** + @@ -318,7 +346,8 @@ A count of a location's physical addresses. [priceGroupCount]: #pricegroupcount #### [priceGroupCount] A count of a location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -328,7 +357,8 @@ A count of a location can be a member of 1 or more Price Groups. This will show [regionCount]: #regioncount #### [regionCount] A count of a location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Location_Office/_index.md b/content/reference/datatypes/SoftLayer_Location_Office/_index.md index 01b781a2f0..5c78d0b90c 100644 --- a/content/reference/datatypes/SoftLayer_Location_Office/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Office/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Location_Office extends the [SoftLayer_Location]({{}}) data type to include office-specific properties. @@ -50,7 +52,8 @@ SoftLayer_Location_Office extends the [SoftLayer_Location]({{Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ The unique identifier of a specific location. [longName]: #longname #### [longName] A longer location description. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ A longer location description. [name]: #name #### [name] A short location description. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ A short location description. [statusId]: #statusid #### [statusId] -Type: **integer** +Type: **integer** + @@ -96,7 +102,8 @@ A short location description. [activePresaleEvents]: #activepresaleevents #### [activePresaleEvents] -Type: **SoftLayer_Sales_Presale_Event[] ** +Type: **SoftLayer_Sales_Presale_Event[] ** + @@ -106,7 +113,8 @@ A short location description. [backboneDependents]: #backbonedependents #### [backboneDependents] -Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** +Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** + @@ -116,7 +124,8 @@ A short location description. [bnppCompliantFlag]: #bnppcompliantflag #### [bnppCompliantFlag] A flag indicating whether or not the datacenter/location is BNPP compliant. -Type: **boolean** +Type: **boolean** + @@ -126,7 +135,8 @@ A flag indicating whether or not the datacenter/location is BNPP compliant. [euCompliantFlag]: #eucompliantflag #### [euCompliantFlag] A flag indicating whether or not the datacenter/location is EU compliant. -Type: **boolean** +Type: **boolean** + @@ -136,7 +146,8 @@ A flag indicating whether or not the datacenter/location is EU compliant. [groups]: #groups #### [groups] A location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -146,7 +157,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [hardwareFirewalls]: #hardwarefirewalls #### [hardwareFirewalls] -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -156,7 +168,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [locationAddress]: #locationaddress #### [locationAddress] A location's physical address. -Type: **SoftLayer_Account_Address ** +Type: **SoftLayer_Account_Address ** + @@ -166,7 +179,8 @@ A location's physical address. [locationAddresses]: #locationaddresses #### [locationAddresses] A location's physical addresses. -Type: **SoftLayer_Account_Address[] ** +Type: **SoftLayer_Account_Address[] ** + @@ -176,7 +190,8 @@ A location's physical addresses. [locationReservationMember]: #locationreservationmember #### [locationReservationMember] A location's Dedicated Rack member -Type: **SoftLayer_Location_Reservation_Rack_Member ** +Type: **SoftLayer_Location_Reservation_Rack_Member ** + @@ -186,7 +201,8 @@ A location's Dedicated Rack member [locationStatus]: #locationstatus #### [locationStatus] The current locations status. -Type: **SoftLayer_Location_Status ** +Type: **SoftLayer_Location_Status ** + @@ -196,7 +212,8 @@ The current locations status. [networkConfigurationAttribute]: #networkconfigurationattribute #### [networkConfigurationAttribute] -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -206,7 +223,8 @@ The current locations status. [onlineSslVpnUserCount]: #onlinesslvpnusercount #### [onlineSslVpnUserCount] The total number of users online using SoftLayer's SSL VPN service for a location. -Type: **integer** +Type: **integer** + @@ -216,7 +234,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [pathString]: #pathstring #### [pathString] -Type: **string** +Type: **string** + @@ -226,7 +245,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [priceGroups]: #pricegroups #### [priceGroups] A location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -236,7 +256,8 @@ A location can be a member of 1 or more Price Groups. This will show which group [regions]: #regions #### [regions] A location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **SoftLayer_Location_Region[] ** +Type: **SoftLayer_Location_Region[] ** + @@ -246,7 +267,8 @@ A location can be a member of 1 or more regions. This will show which regions to [timezone]: #timezone #### [timezone] -Type: **SoftLayer_Locale_Timezone ** +Type: **SoftLayer_Locale_Timezone ** + @@ -256,7 +278,8 @@ A location can be a member of 1 or more regions. This will show which regions to [vdrGroup]: #vdrgroup #### [vdrGroup] A location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs. -Type: **SoftLayer_Location_Group_Location_CrossReference ** +Type: **SoftLayer_Location_Group_Location_CrossReference ** + @@ -268,7 +291,8 @@ A location can be a member of 1 Bandwidth Pooling Group. This will show which gr [activePresaleEventCount]: #activepresaleeventcount #### [activePresaleEventCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -278,7 +302,8 @@ A count of [backboneDependentCount]: #backbonedependentcount #### [backboneDependentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -288,7 +313,8 @@ A count of [groupCount]: #groupcount #### [groupCount] A count of a location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -298,7 +324,8 @@ A count of a location can be a member of 1 or more groups. This will show which [hardwareFirewallCount]: #hardwarefirewallcount #### [hardwareFirewallCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -308,7 +335,8 @@ A count of [locationAddressCount]: #locationaddresscount #### [locationAddressCount] A count of a location's physical addresses. -Type: **unsigned long** +Type: **unsigned long** + @@ -318,7 +346,8 @@ A count of a location's physical addresses. [priceGroupCount]: #pricegroupcount #### [priceGroupCount] A count of a location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -328,7 +357,8 @@ A count of a location can be a member of 1 or more Price Groups. This will show [regionCount]: #regioncount #### [regionCount] A count of a location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Location_Rack/_index.md b/content/reference/datatypes/SoftLayer_Location_Rack/_index.md index 81f12979de..6ee9583483 100644 --- a/content/reference/datatypes/SoftLayer_Location_Rack/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Rack/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Location_Rack extends the [SoftLayer_Location]({{}}) data type to include rack-specific properties. @@ -50,7 +52,8 @@ SoftLayer_Location_Rack extends the [SoftLayer_Location]({{Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ The unique identifier of a specific location. [longName]: #longname #### [longName] A longer location description. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ A longer location description. [name]: #name #### [name] A short location description. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ A short location description. [statusId]: #statusid #### [statusId] -Type: **integer** +Type: **integer** + @@ -96,7 +102,8 @@ A short location description. [activePresaleEvents]: #activepresaleevents #### [activePresaleEvents] -Type: **SoftLayer_Sales_Presale_Event[] ** +Type: **SoftLayer_Sales_Presale_Event[] ** + @@ -106,7 +113,8 @@ A short location description. [backboneDependents]: #backbonedependents #### [backboneDependents] -Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** +Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** + @@ -116,7 +124,8 @@ A short location description. [bnppCompliantFlag]: #bnppcompliantflag #### [bnppCompliantFlag] A flag indicating whether or not the datacenter/location is BNPP compliant. -Type: **boolean** +Type: **boolean** + @@ -126,7 +135,8 @@ A flag indicating whether or not the datacenter/location is BNPP compliant. [euCompliantFlag]: #eucompliantflag #### [euCompliantFlag] A flag indicating whether or not the datacenter/location is EU compliant. -Type: **boolean** +Type: **boolean** + @@ -136,7 +146,8 @@ A flag indicating whether or not the datacenter/location is EU compliant. [groups]: #groups #### [groups] A location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -146,7 +157,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [hardwareFirewalls]: #hardwarefirewalls #### [hardwareFirewalls] -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -156,7 +168,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [locationAddress]: #locationaddress #### [locationAddress] A location's physical address. -Type: **SoftLayer_Account_Address ** +Type: **SoftLayer_Account_Address ** + @@ -166,7 +179,8 @@ A location's physical address. [locationAddresses]: #locationaddresses #### [locationAddresses] A location's physical addresses. -Type: **SoftLayer_Account_Address[] ** +Type: **SoftLayer_Account_Address[] ** + @@ -176,7 +190,8 @@ A location's physical addresses. [locationReservationMember]: #locationreservationmember #### [locationReservationMember] A location's Dedicated Rack member -Type: **SoftLayer_Location_Reservation_Rack_Member ** +Type: **SoftLayer_Location_Reservation_Rack_Member ** + @@ -186,7 +201,8 @@ A location's Dedicated Rack member [locationStatus]: #locationstatus #### [locationStatus] The current locations status. -Type: **SoftLayer_Location_Status ** +Type: **SoftLayer_Location_Status ** + @@ -196,7 +212,8 @@ The current locations status. [networkConfigurationAttribute]: #networkconfigurationattribute #### [networkConfigurationAttribute] -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -206,7 +223,8 @@ The current locations status. [onlineSslVpnUserCount]: #onlinesslvpnusercount #### [onlineSslVpnUserCount] The total number of users online using SoftLayer's SSL VPN service for a location. -Type: **integer** +Type: **integer** + @@ -216,7 +234,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [pathString]: #pathstring #### [pathString] -Type: **string** +Type: **string** + @@ -226,7 +245,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [priceGroups]: #pricegroups #### [priceGroups] A location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -236,7 +256,8 @@ A location can be a member of 1 or more Price Groups. This will show which group [regions]: #regions #### [regions] A location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **SoftLayer_Location_Region[] ** +Type: **SoftLayer_Location_Region[] ** + @@ -246,7 +267,8 @@ A location can be a member of 1 or more regions. This will show which regions to [timezone]: #timezone #### [timezone] -Type: **SoftLayer_Locale_Timezone ** +Type: **SoftLayer_Locale_Timezone ** + @@ -256,7 +278,8 @@ A location can be a member of 1 or more regions. This will show which regions to [vdrGroup]: #vdrgroup #### [vdrGroup] A location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs. -Type: **SoftLayer_Location_Group_Location_CrossReference ** +Type: **SoftLayer_Location_Group_Location_CrossReference ** + @@ -268,7 +291,8 @@ A location can be a member of 1 Bandwidth Pooling Group. This will show which gr [activePresaleEventCount]: #activepresaleeventcount #### [activePresaleEventCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -278,7 +302,8 @@ A count of [backboneDependentCount]: #backbonedependentcount #### [backboneDependentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -288,7 +313,8 @@ A count of [groupCount]: #groupcount #### [groupCount] A count of a location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -298,7 +324,8 @@ A count of a location can be a member of 1 or more groups. This will show which [hardwareFirewallCount]: #hardwarefirewallcount #### [hardwareFirewallCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -308,7 +335,8 @@ A count of [locationAddressCount]: #locationaddresscount #### [locationAddressCount] A count of a location's physical addresses. -Type: **unsigned long** +Type: **unsigned long** + @@ -318,7 +346,8 @@ A count of a location's physical addresses. [priceGroupCount]: #pricegroupcount #### [priceGroupCount] A count of a location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -328,7 +357,8 @@ A count of a location can be a member of 1 or more Price Groups. This will show [regionCount]: #regioncount #### [regionCount] A count of a location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Location_Region/_index.md b/content/reference/datatypes/SoftLayer_Location_Region/_index.md index d4ad1c0415..bdc851c906 100644 --- a/content/reference/datatypes/SoftLayer_Location_Region/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Region/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ A region is made up of a keyname and a description of that region. A region keyn [description]: #description #### [description] A short description of a region's name. This description is seen on the order forms. -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ A short description of a region's name. This description is seen on the order fo [keyname]: #keyname #### [keyname] A unique key name for a region. Provided for easy debugging. This is to be sent in with an order. -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ A unique key name for a region. Provided for easy debugging. This is to be sent [sortOrder]: #sortorder #### [sortOrder] An integer representing the order in which this element is displayed. -Type: **integer** +Type: **integer** + @@ -87,7 +92,8 @@ An integer representing the order in which this element is displayed. [location]: #location #### [location] Each region can have many locations tied to it. However, this is the location we currently provision to for a region. This location is the current valid location for a region. (Deprecated, use 'locations') -Type: **SoftLayer_Location_Region_Location ** +Type: **SoftLayer_Location_Region_Location ** + @@ -97,7 +103,8 @@ Each region can have many locations tied to it. However, this is the location we [locations]: #locations #### [locations] The locations (like datacenters or PoPs) in this region. -Type: **SoftLayer_Location_Region_Location[] ** +Type: **SoftLayer_Location_Region_Location[] ** + @@ -109,7 +116,8 @@ The locations (like datacenters or PoPs) in this region. [locationCount]: #locationcount #### [locationCount] A count of the locations (like datacenters or PoPs) in this region. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Location_Region_Location/_index.md b/content/reference/datatypes/SoftLayer_Location_Region_Location/_index.md index 8dce480089..bc38837dca 100644 --- a/content/reference/datatypes/SoftLayer_Location_Region_Location/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Region_Location/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Location_Region_Location is very specific to the location where se [locationId]: #locationid #### [locationId] -Type: **integer** +Type: **integer** + @@ -61,7 +64,8 @@ The SoftLayer_Location_Region_Location is very specific to the location where se [location]: #location #### [location] The SoftLayer_Location tied to a region's location. This provides more information about the location, including specific datacenter information. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -71,7 +75,8 @@ The SoftLayer_Location tied to a region's location. This provides more informati [locationPackageDetails]: #locationpackagedetails #### [locationPackageDetails] A region's location also has delivery information as well as other information to be determined. For now, availability is provided and could weigh into the decision as to where to decide to have a server provisioned.' -Type: **SoftLayer_Product_Package_Locations[] ** +Type: **SoftLayer_Product_Package_Locations[] ** + @@ -81,7 +86,8 @@ A region's location also has delivery information as well as other information t [region]: #region #### [region] The region to which this location belongs. -Type: **SoftLayer_Location_Region ** +Type: **SoftLayer_Location_Region ** + @@ -93,7 +99,8 @@ The region to which this location belongs. [locationPackageDetailCount]: #locationpackagedetailcount #### [locationPackageDetailCount] A count of a region's location also has delivery information as well as other information to be determined. For now, availability is provided and could weigh into the decision as to where to decide to have a server provisioned.' -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Location_Reservation/_index.md b/content/reference/datatypes/SoftLayer_Location_Reservation/_index.md index 20f8a1f67c..1f2443c735 100644 --- a/content/reference/datatypes/SoftLayer_Location_Reservation/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Reservation/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [allotmentId]: #allotmentid #### [allotmentId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [locationId]: #locationid #### [locationId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [notes]: #notes #### [notes] -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ classes: [account]: #account #### [account] The account that a billing item belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -111,7 +119,8 @@ The account that a billing item belongs to. [allotment]: #allotment #### [allotment] The bandwidth allotment that the reservation belongs to. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** + @@ -121,7 +130,8 @@ The bandwidth allotment that the reservation belongs to. [billingItem]: #billingitem #### [billingItem] The bandwidth allotment that the reservation belongs to. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -131,7 +141,8 @@ The bandwidth allotment that the reservation belongs to. [location]: #location #### [location] The datacenter location that the reservation belongs to. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -141,7 +152,8 @@ The datacenter location that the reservation belongs to. [locationReservationRack]: #locationreservationrack #### [locationReservationRack] Rack information for the reservation -Type: **SoftLayer_Location_Reservation_Rack ** +Type: **SoftLayer_Location_Reservation_Rack ** + diff --git a/content/reference/datatypes/SoftLayer_Location_Reservation_Rack/_index.md b/content/reference/datatypes/SoftLayer_Location_Reservation_Rack/_index.md index bd7de5cff0..fd3cd3ebf1 100644 --- a/content/reference/datatypes/SoftLayer_Location_Reservation_Rack/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Reservation_Rack/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [locationId]: #locationid #### [locationId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [locationReservationId]: #locationreservationid #### [locationReservationId] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [networkConnectionCapacity]: #networkconnectioncapacity #### [networkConnectionCapacity] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [networkConnectionReservation]: #networkconnectionreservation #### [networkConnectionReservation] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [powerConnectionCapacity]: #powerconnectioncapacity #### [powerConnectionCapacity] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [powerConnectionReservation]: #powerconnectionreservation #### [powerConnectionReservation] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [slotCapacity]: #slotcapacity #### [slotCapacity] -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ classes: [slotReservation]: #slotreservation #### [slotReservation] -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ classes: [allotment]: #allotment #### [allotment] The bandwidth allotment that the reservation belongs to. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** + @@ -141,7 +152,8 @@ The bandwidth allotment that the reservation belongs to. [children]: #children #### [children] Members of the rack. -Type: **SoftLayer_Location_Reservation_Rack_Member[] ** +Type: **SoftLayer_Location_Reservation_Rack_Member[] ** + @@ -151,7 +163,8 @@ Members of the rack. [location]: #location #### [location] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -161,7 +174,8 @@ Members of the rack. [locationReservation]: #locationreservation #### [locationReservation] -Type: **SoftLayer_Location_Reservation ** +Type: **SoftLayer_Location_Reservation ** + @@ -173,7 +187,8 @@ Members of the rack. [childrenCount]: #childrencount #### [childrenCount] A count of members of the rack. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Location_Reservation_Rack_Member/_index.md b/content/reference/datatypes/SoftLayer_Location_Reservation_Rack_Member/_index.md index 1a1928862d..a813c52caf 100644 --- a/content/reference/datatypes/SoftLayer_Location_Reservation_Rack_Member/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Reservation_Rack_Member/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [locationId]: #locationid #### [locationId] -Type: **integer** +Type: **integer** +
      @@ -71,7 +75,8 @@ classes: [location]: #location #### [location] Location relation for the rack member -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -81,7 +86,8 @@ Location relation for the rack member [locationReservationRack]: #locationreservationrack #### [locationReservationRack] -Type: **SoftLayer_Location_Reservation_Rack ** +Type: **SoftLayer_Location_Reservation_Rack ** + diff --git a/content/reference/datatypes/SoftLayer_Location_Root/_index.md b/content/reference/datatypes/SoftLayer_Location_Root/_index.md index 637898d88c..94695de82f 100644 --- a/content/reference/datatypes/SoftLayer_Location_Root/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Root/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Location_Root extends the [SoftLayer_Location]({{}}) data type to include root-specific properties. @@ -50,7 +52,8 @@ SoftLayer_Location_Root extends the [SoftLayer_Location]({{Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ The unique identifier of a specific location. [longName]: #longname #### [longName] A longer location description. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ A longer location description. [name]: #name #### [name] A short location description. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ A short location description. [statusId]: #statusid #### [statusId] -Type: **integer** +Type: **integer** + @@ -96,7 +102,8 @@ A short location description. [activePresaleEvents]: #activepresaleevents #### [activePresaleEvents] -Type: **SoftLayer_Sales_Presale_Event[] ** +Type: **SoftLayer_Sales_Presale_Event[] ** + @@ -106,7 +113,8 @@ A short location description. [backboneDependents]: #backbonedependents #### [backboneDependents] -Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** +Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** + @@ -116,7 +124,8 @@ A short location description. [bnppCompliantFlag]: #bnppcompliantflag #### [bnppCompliantFlag] A flag indicating whether or not the datacenter/location is BNPP compliant. -Type: **boolean** +Type: **boolean** + @@ -126,7 +135,8 @@ A flag indicating whether or not the datacenter/location is BNPP compliant. [euCompliantFlag]: #eucompliantflag #### [euCompliantFlag] A flag indicating whether or not the datacenter/location is EU compliant. -Type: **boolean** +Type: **boolean** + @@ -136,7 +146,8 @@ A flag indicating whether or not the datacenter/location is EU compliant. [groups]: #groups #### [groups] A location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -146,7 +157,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [hardwareFirewalls]: #hardwarefirewalls #### [hardwareFirewalls] -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -156,7 +168,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [locationAddress]: #locationaddress #### [locationAddress] A location's physical address. -Type: **SoftLayer_Account_Address ** +Type: **SoftLayer_Account_Address ** + @@ -166,7 +179,8 @@ A location's physical address. [locationAddresses]: #locationaddresses #### [locationAddresses] A location's physical addresses. -Type: **SoftLayer_Account_Address[] ** +Type: **SoftLayer_Account_Address[] ** + @@ -176,7 +190,8 @@ A location's physical addresses. [locationReservationMember]: #locationreservationmember #### [locationReservationMember] A location's Dedicated Rack member -Type: **SoftLayer_Location_Reservation_Rack_Member ** +Type: **SoftLayer_Location_Reservation_Rack_Member ** + @@ -186,7 +201,8 @@ A location's Dedicated Rack member [locationStatus]: #locationstatus #### [locationStatus] The current locations status. -Type: **SoftLayer_Location_Status ** +Type: **SoftLayer_Location_Status ** + @@ -196,7 +212,8 @@ The current locations status. [networkConfigurationAttribute]: #networkconfigurationattribute #### [networkConfigurationAttribute] -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -206,7 +223,8 @@ The current locations status. [onlineSslVpnUserCount]: #onlinesslvpnusercount #### [onlineSslVpnUserCount] The total number of users online using SoftLayer's SSL VPN service for a location. -Type: **integer** +Type: **integer** + @@ -216,7 +234,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [pathString]: #pathstring #### [pathString] -Type: **string** +Type: **string** + @@ -226,7 +245,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [priceGroups]: #pricegroups #### [priceGroups] A location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -236,7 +256,8 @@ A location can be a member of 1 or more Price Groups. This will show which group [regions]: #regions #### [regions] A location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **SoftLayer_Location_Region[] ** +Type: **SoftLayer_Location_Region[] ** + @@ -246,7 +267,8 @@ A location can be a member of 1 or more regions. This will show which regions to [timezone]: #timezone #### [timezone] -Type: **SoftLayer_Locale_Timezone ** +Type: **SoftLayer_Locale_Timezone ** + @@ -256,7 +278,8 @@ A location can be a member of 1 or more regions. This will show which regions to [vdrGroup]: #vdrgroup #### [vdrGroup] A location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs. -Type: **SoftLayer_Location_Group_Location_CrossReference ** +Type: **SoftLayer_Location_Group_Location_CrossReference ** + @@ -268,7 +291,8 @@ A location can be a member of 1 Bandwidth Pooling Group. This will show which gr [activePresaleEventCount]: #activepresaleeventcount #### [activePresaleEventCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -278,7 +302,8 @@ A count of [backboneDependentCount]: #backbonedependentcount #### [backboneDependentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -288,7 +313,8 @@ A count of [groupCount]: #groupcount #### [groupCount] A count of a location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -298,7 +324,8 @@ A count of a location can be a member of 1 or more groups. This will show which [hardwareFirewallCount]: #hardwarefirewallcount #### [hardwareFirewallCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -308,7 +335,8 @@ A count of [locationAddressCount]: #locationaddresscount #### [locationAddressCount] A count of a location's physical addresses. -Type: **unsigned long** +Type: **unsigned long** + @@ -318,7 +346,8 @@ A count of a location's physical addresses. [priceGroupCount]: #pricegroupcount #### [priceGroupCount] A count of a location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -328,7 +357,8 @@ A count of a location can be a member of 1 or more Price Groups. This will show [regionCount]: #regioncount #### [regionCount] A count of a location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Location_Server_Room/_index.md b/content/reference/datatypes/SoftLayer_Location_Server_Room/_index.md index 6509895b7a..758fe55d29 100644 --- a/content/reference/datatypes/SoftLayer_Location_Server_Room/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Server_Room/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Location_Server_Room extends the [SoftLayer_Location]({{}}) data type to include server room-specific properties. @@ -50,7 +52,8 @@ SoftLayer_Location_Server_Room extends the [SoftLayer_Location]({{Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ The unique identifier of a specific location. [longName]: #longname #### [longName] A longer location description. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ A longer location description. [name]: #name #### [name] A short location description. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ A short location description. [statusId]: #statusid #### [statusId] -Type: **integer** +Type: **integer** + @@ -96,7 +102,8 @@ A short location description. [activePresaleEvents]: #activepresaleevents #### [activePresaleEvents] -Type: **SoftLayer_Sales_Presale_Event[] ** +Type: **SoftLayer_Sales_Presale_Event[] ** + @@ -106,7 +113,8 @@ A short location description. [backboneDependents]: #backbonedependents #### [backboneDependents] -Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** +Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** + @@ -116,7 +124,8 @@ A short location description. [bnppCompliantFlag]: #bnppcompliantflag #### [bnppCompliantFlag] A flag indicating whether or not the datacenter/location is BNPP compliant. -Type: **boolean** +Type: **boolean** + @@ -126,7 +135,8 @@ A flag indicating whether or not the datacenter/location is BNPP compliant. [euCompliantFlag]: #eucompliantflag #### [euCompliantFlag] A flag indicating whether or not the datacenter/location is EU compliant. -Type: **boolean** +Type: **boolean** + @@ -136,7 +146,8 @@ A flag indicating whether or not the datacenter/location is EU compliant. [groups]: #groups #### [groups] A location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -146,7 +157,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [hardwareFirewalls]: #hardwarefirewalls #### [hardwareFirewalls] -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -156,7 +168,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [locationAddress]: #locationaddress #### [locationAddress] A location's physical address. -Type: **SoftLayer_Account_Address ** +Type: **SoftLayer_Account_Address ** + @@ -166,7 +179,8 @@ A location's physical address. [locationAddresses]: #locationaddresses #### [locationAddresses] A location's physical addresses. -Type: **SoftLayer_Account_Address[] ** +Type: **SoftLayer_Account_Address[] ** + @@ -176,7 +190,8 @@ A location's physical addresses. [locationReservationMember]: #locationreservationmember #### [locationReservationMember] A location's Dedicated Rack member -Type: **SoftLayer_Location_Reservation_Rack_Member ** +Type: **SoftLayer_Location_Reservation_Rack_Member ** + @@ -186,7 +201,8 @@ A location's Dedicated Rack member [locationStatus]: #locationstatus #### [locationStatus] The current locations status. -Type: **SoftLayer_Location_Status ** +Type: **SoftLayer_Location_Status ** + @@ -196,7 +212,8 @@ The current locations status. [networkConfigurationAttribute]: #networkconfigurationattribute #### [networkConfigurationAttribute] -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -206,7 +223,8 @@ The current locations status. [onlineSslVpnUserCount]: #onlinesslvpnusercount #### [onlineSslVpnUserCount] The total number of users online using SoftLayer's SSL VPN service for a location. -Type: **integer** +Type: **integer** + @@ -216,7 +234,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [pathString]: #pathstring #### [pathString] -Type: **string** +Type: **string** + @@ -226,7 +245,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [priceGroups]: #pricegroups #### [priceGroups] A location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -236,7 +256,8 @@ A location can be a member of 1 or more Price Groups. This will show which group [regions]: #regions #### [regions] A location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **SoftLayer_Location_Region[] ** +Type: **SoftLayer_Location_Region[] ** + @@ -246,7 +267,8 @@ A location can be a member of 1 or more regions. This will show which regions to [timezone]: #timezone #### [timezone] -Type: **SoftLayer_Locale_Timezone ** +Type: **SoftLayer_Locale_Timezone ** + @@ -256,7 +278,8 @@ A location can be a member of 1 or more regions. This will show which regions to [vdrGroup]: #vdrgroup #### [vdrGroup] A location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs. -Type: **SoftLayer_Location_Group_Location_CrossReference ** +Type: **SoftLayer_Location_Group_Location_CrossReference ** + @@ -268,7 +291,8 @@ A location can be a member of 1 Bandwidth Pooling Group. This will show which gr [activePresaleEventCount]: #activepresaleeventcount #### [activePresaleEventCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -278,7 +302,8 @@ A count of [backboneDependentCount]: #backbonedependentcount #### [backboneDependentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -288,7 +313,8 @@ A count of [groupCount]: #groupcount #### [groupCount] A count of a location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -298,7 +324,8 @@ A count of a location can be a member of 1 or more groups. This will show which [hardwareFirewallCount]: #hardwarefirewallcount #### [hardwareFirewallCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -308,7 +335,8 @@ A count of [locationAddressCount]: #locationaddresscount #### [locationAddressCount] A count of a location's physical addresses. -Type: **unsigned long** +Type: **unsigned long** + @@ -318,7 +346,8 @@ A count of a location's physical addresses. [priceGroupCount]: #pricegroupcount #### [priceGroupCount] A count of a location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -328,7 +357,8 @@ A count of a location can be a member of 1 or more Price Groups. This will show [regionCount]: #regioncount #### [regionCount] A count of a location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Location_Slot/_index.md b/content/reference/datatypes/SoftLayer_Location_Slot/_index.md index 117bd851ee..68a940bdc2 100644 --- a/content/reference/datatypes/SoftLayer_Location_Slot/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Slot/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Location_Slot extends the [SoftLayer_Location]({{}}) data type to include slot-specific properties. @@ -50,7 +52,8 @@ SoftLayer_Location_Slot extends the [SoftLayer_Location]({{Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ The unique identifier of a specific location. [longName]: #longname #### [longName] A longer location description. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ A longer location description. [name]: #name #### [name] A short location description. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ A short location description. [statusId]: #statusid #### [statusId] -Type: **integer** +Type: **integer** + @@ -96,7 +102,8 @@ A short location description. [activePresaleEvents]: #activepresaleevents #### [activePresaleEvents] -Type: **SoftLayer_Sales_Presale_Event[] ** +Type: **SoftLayer_Sales_Presale_Event[] ** + @@ -106,7 +113,8 @@ A short location description. [backboneDependents]: #backbonedependents #### [backboneDependents] -Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** +Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** + @@ -116,7 +124,8 @@ A short location description. [bnppCompliantFlag]: #bnppcompliantflag #### [bnppCompliantFlag] A flag indicating whether or not the datacenter/location is BNPP compliant. -Type: **boolean** +Type: **boolean** + @@ -126,7 +135,8 @@ A flag indicating whether or not the datacenter/location is BNPP compliant. [euCompliantFlag]: #eucompliantflag #### [euCompliantFlag] A flag indicating whether or not the datacenter/location is EU compliant. -Type: **boolean** +Type: **boolean** + @@ -136,7 +146,8 @@ A flag indicating whether or not the datacenter/location is EU compliant. [groups]: #groups #### [groups] A location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -146,7 +157,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [hardwareFirewalls]: #hardwarefirewalls #### [hardwareFirewalls] -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -156,7 +168,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [locationAddress]: #locationaddress #### [locationAddress] A location's physical address. -Type: **SoftLayer_Account_Address ** +Type: **SoftLayer_Account_Address ** + @@ -166,7 +179,8 @@ A location's physical address. [locationAddresses]: #locationaddresses #### [locationAddresses] A location's physical addresses. -Type: **SoftLayer_Account_Address[] ** +Type: **SoftLayer_Account_Address[] ** + @@ -176,7 +190,8 @@ A location's physical addresses. [locationReservationMember]: #locationreservationmember #### [locationReservationMember] A location's Dedicated Rack member -Type: **SoftLayer_Location_Reservation_Rack_Member ** +Type: **SoftLayer_Location_Reservation_Rack_Member ** + @@ -186,7 +201,8 @@ A location's Dedicated Rack member [locationStatus]: #locationstatus #### [locationStatus] The current locations status. -Type: **SoftLayer_Location_Status ** +Type: **SoftLayer_Location_Status ** + @@ -196,7 +212,8 @@ The current locations status. [networkConfigurationAttribute]: #networkconfigurationattribute #### [networkConfigurationAttribute] -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -206,7 +223,8 @@ The current locations status. [onlineSslVpnUserCount]: #onlinesslvpnusercount #### [onlineSslVpnUserCount] The total number of users online using SoftLayer's SSL VPN service for a location. -Type: **integer** +Type: **integer** + @@ -216,7 +234,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [pathString]: #pathstring #### [pathString] -Type: **string** +Type: **string** + @@ -226,7 +245,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [priceGroups]: #pricegroups #### [priceGroups] A location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -236,7 +256,8 @@ A location can be a member of 1 or more Price Groups. This will show which group [regions]: #regions #### [regions] A location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **SoftLayer_Location_Region[] ** +Type: **SoftLayer_Location_Region[] ** + @@ -246,7 +267,8 @@ A location can be a member of 1 or more regions. This will show which regions to [timezone]: #timezone #### [timezone] -Type: **SoftLayer_Locale_Timezone ** +Type: **SoftLayer_Locale_Timezone ** + @@ -256,7 +278,8 @@ A location can be a member of 1 or more regions. This will show which regions to [vdrGroup]: #vdrgroup #### [vdrGroup] A location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs. -Type: **SoftLayer_Location_Group_Location_CrossReference ** +Type: **SoftLayer_Location_Group_Location_CrossReference ** + @@ -268,7 +291,8 @@ A location can be a member of 1 Bandwidth Pooling Group. This will show which gr [activePresaleEventCount]: #activepresaleeventcount #### [activePresaleEventCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -278,7 +302,8 @@ A count of [backboneDependentCount]: #backbonedependentcount #### [backboneDependentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -288,7 +313,8 @@ A count of [groupCount]: #groupcount #### [groupCount] A count of a location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -298,7 +324,8 @@ A count of a location can be a member of 1 or more groups. This will show which [hardwareFirewallCount]: #hardwarefirewallcount #### [hardwareFirewallCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -308,7 +335,8 @@ A count of [locationAddressCount]: #locationaddresscount #### [locationAddressCount] A count of a location's physical addresses. -Type: **unsigned long** +Type: **unsigned long** + @@ -318,7 +346,8 @@ A count of a location's physical addresses. [priceGroupCount]: #pricegroupcount #### [priceGroupCount] A count of a location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -328,7 +357,8 @@ A count of a location can be a member of 1 or more Price Groups. This will show [regionCount]: #regioncount #### [regionCount] A count of a location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Location_Status/_index.md b/content/reference/datatypes/SoftLayer_Location_Status/_index.md index fec68d250e..2c4e1cce9d 100644 --- a/content/reference/datatypes/SoftLayer_Location_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Status/_index.md @@ -21,6 +21,8 @@ classes: ## Description + + SoftLayer_Location_Status models the state of any location. SoftLayer uses the following status codes: @@ -61,7 +63,8 @@ Locations in use should stay in the ACTIVE state. If a locations status ever rea [id]: #id #### [id] A locations status's internal identifier. -Type: **integer** +Type: **integer** + @@ -71,7 +74,8 @@ A locations status's internal identifier. [status]: #status #### [status] A Location's status code. See the SoftLayer_Locaiton_Status Overview for ''status''' possible values. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Location_Storage_Room/_index.md b/content/reference/datatypes/SoftLayer_Location_Storage_Room/_index.md index f5283395ef..03edf7708b 100644 --- a/content/reference/datatypes/SoftLayer_Location_Storage_Room/_index.md +++ b/content/reference/datatypes/SoftLayer_Location_Storage_Room/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Location_Storage_Room extends the [SoftLayer_Location]({{}}) data type to include storage room-specific properties. @@ -50,7 +52,8 @@ SoftLayer_Location_Storage_Room extends the [SoftLayer_Location]({{Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ The unique identifier of a specific location. [longName]: #longname #### [longName] A longer location description. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ A longer location description. [name]: #name #### [name] A short location description. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ A short location description. [statusId]: #statusid #### [statusId] -Type: **integer** +Type: **integer** + @@ -96,7 +102,8 @@ A short location description. [activePresaleEvents]: #activepresaleevents #### [activePresaleEvents] -Type: **SoftLayer_Sales_Presale_Event[] ** +Type: **SoftLayer_Sales_Presale_Event[] ** + @@ -106,7 +113,8 @@ A short location description. [backboneDependents]: #backbonedependents #### [backboneDependents] -Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** +Type: **SoftLayer_Network_Backbone_Location_Dependent[] ** + @@ -116,7 +124,8 @@ A short location description. [bnppCompliantFlag]: #bnppcompliantflag #### [bnppCompliantFlag] A flag indicating whether or not the datacenter/location is BNPP compliant. -Type: **boolean** +Type: **boolean** + @@ -126,7 +135,8 @@ A flag indicating whether or not the datacenter/location is BNPP compliant. [euCompliantFlag]: #eucompliantflag #### [euCompliantFlag] A flag indicating whether or not the datacenter/location is EU compliant. -Type: **boolean** +Type: **boolean** + @@ -136,7 +146,8 @@ A flag indicating whether or not the datacenter/location is EU compliant. [groups]: #groups #### [groups] A location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -146,7 +157,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [hardwareFirewalls]: #hardwarefirewalls #### [hardwareFirewalls] -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -156,7 +168,8 @@ A location can be a member of 1 or more groups. This will show which groups to w [locationAddress]: #locationaddress #### [locationAddress] A location's physical address. -Type: **SoftLayer_Account_Address ** +Type: **SoftLayer_Account_Address ** + @@ -166,7 +179,8 @@ A location's physical address. [locationAddresses]: #locationaddresses #### [locationAddresses] A location's physical addresses. -Type: **SoftLayer_Account_Address[] ** +Type: **SoftLayer_Account_Address[] ** + @@ -176,7 +190,8 @@ A location's physical addresses. [locationReservationMember]: #locationreservationmember #### [locationReservationMember] A location's Dedicated Rack member -Type: **SoftLayer_Location_Reservation_Rack_Member ** +Type: **SoftLayer_Location_Reservation_Rack_Member ** + @@ -186,7 +201,8 @@ A location's Dedicated Rack member [locationStatus]: #locationstatus #### [locationStatus] The current locations status. -Type: **SoftLayer_Location_Status ** +Type: **SoftLayer_Location_Status ** + @@ -196,7 +212,8 @@ The current locations status. [networkConfigurationAttribute]: #networkconfigurationattribute #### [networkConfigurationAttribute] -Type: **SoftLayer_Hardware_Attribute ** +Type: **SoftLayer_Hardware_Attribute ** + @@ -206,7 +223,8 @@ The current locations status. [onlineSslVpnUserCount]: #onlinesslvpnusercount #### [onlineSslVpnUserCount] The total number of users online using SoftLayer's SSL VPN service for a location. -Type: **integer** +Type: **integer** + @@ -216,7 +234,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [pathString]: #pathstring #### [pathString] -Type: **string** +Type: **string** + @@ -226,7 +245,8 @@ The total number of users online using SoftLayer's SSL VPN service for a locatio [priceGroups]: #pricegroups #### [priceGroups] A location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **SoftLayer_Location_Group[] ** +Type: **SoftLayer_Location_Group[] ** + @@ -236,7 +256,8 @@ A location can be a member of 1 or more Price Groups. This will show which group [regions]: #regions #### [regions] A location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **SoftLayer_Location_Region[] ** +Type: **SoftLayer_Location_Region[] ** + @@ -246,7 +267,8 @@ A location can be a member of 1 or more regions. This will show which regions to [timezone]: #timezone #### [timezone] -Type: **SoftLayer_Locale_Timezone ** +Type: **SoftLayer_Locale_Timezone ** + @@ -256,7 +278,8 @@ A location can be a member of 1 or more regions. This will show which regions to [vdrGroup]: #vdrgroup #### [vdrGroup] A location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs. -Type: **SoftLayer_Location_Group_Location_CrossReference ** +Type: **SoftLayer_Location_Group_Location_CrossReference ** + @@ -268,7 +291,8 @@ A location can be a member of 1 Bandwidth Pooling Group. This will show which gr [activePresaleEventCount]: #activepresaleeventcount #### [activePresaleEventCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -278,7 +302,8 @@ A count of [backboneDependentCount]: #backbonedependentcount #### [backboneDependentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -288,7 +313,8 @@ A count of [groupCount]: #groupcount #### [groupCount] A count of a location can be a member of 1 or more groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -298,7 +324,8 @@ A count of a location can be a member of 1 or more groups. This will show which [hardwareFirewallCount]: #hardwarefirewallcount #### [hardwareFirewallCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -308,7 +335,8 @@ A count of [locationAddressCount]: #locationaddresscount #### [locationAddressCount] A count of a location's physical addresses. -Type: **unsigned long** +Type: **unsigned long** + @@ -318,7 +346,8 @@ A count of a location's physical addresses. [priceGroupCount]: #pricegroupcount #### [priceGroupCount] A count of a location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + @@ -328,7 +357,8 @@ A count of a location can be a member of 1 or more Price Groups. This will show [regionCount]: #regioncount #### [regionCount] A count of a location can be a member of 1 or more regions. This will show which regions to which a location belongs. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Marketplace_EmailDistribution/_index.md b/content/reference/datatypes/SoftLayer_Marketplace_EmailDistribution/_index.md index 00a5eb905c..d57f023833 100644 --- a/content/reference/datatypes/SoftLayer_Marketplace_EmailDistribution/_index.md +++ b/content/reference/datatypes/SoftLayer_Marketplace_EmailDistribution/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [email]: #email #### [email] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      diff --git a/content/reference/datatypes/SoftLayer_Marketplace_Partner/_index.md b/content/reference/datatypes/SoftLayer_Marketplace_Partner/_index.md index c8e30fb79d..c8c694e9a9 100644 --- a/content/reference/datatypes/SoftLayer_Marketplace_Partner/_index.md +++ b/content/reference/datatypes/SoftLayer_Marketplace_Partner/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [attachedFiles]: #attachedfiles #### [attachedFiles] -Type: **SoftLayer_Marketplace_Partner_Attachment[] ** +Type: **SoftLayer_Marketplace_Partner_Attachment[] ** +
      @@ -65,7 +69,8 @@ classes: [companyDescription]: #companydescription #### [companyDescription] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [companyName]: #companyname #### [companyName] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [headlineDescription]: #headlinedescription #### [headlineDescription] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [linkFreeTrial]: #linkfreetrial #### [linkFreeTrial] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [linkOrderPage]: #linkorderpage #### [linkOrderPage] -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ classes: [linkWebsite]: #linkwebsite #### [linkWebsite] -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ classes: [metaDescription]: #metadescription #### [metaDescription] -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ classes: [metaKeywords]: #metakeywords #### [metaKeywords] -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ classes: [productBenefits]: #productbenefits #### [productBenefits] -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ classes: [productCategoryId]: #productcategoryid #### [productCategoryId] -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ classes: [productDescriptionLong]: #productdescriptionlong #### [productDescriptionLong] -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ classes: [productDescriptionShort]: #productdescriptionshort #### [productDescriptionShort] -Type: **string** +Type: **string** + @@ -195,7 +212,8 @@ classes: [productFeatures]: #productfeatures #### [productFeatures] -Type: **string** +Type: **string** + @@ -205,7 +223,8 @@ classes: [productName]: #productname #### [productName] -Type: **string** +Type: **string** + @@ -215,7 +234,8 @@ classes: [productTitle]: #producttitle #### [productTitle] -Type: **string** +Type: **string** + @@ -225,7 +245,8 @@ classes: [urlIdentifier]: #urlidentifier #### [urlIdentifier] -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ classes: [attachments]: #attachments #### [attachments] -Type: **SoftLayer_Marketplace_Partner_Attachment[] ** +Type: **SoftLayer_Marketplace_Partner_Attachment[] ** + @@ -251,7 +273,8 @@ classes: [logoMedium]: #logomedium #### [logoMedium] -Type: **SoftLayer_Marketplace_Partner_Attachment ** +Type: **SoftLayer_Marketplace_Partner_Attachment ** + @@ -261,7 +284,8 @@ classes: [logoMediumTemp]: #logomediumtemp #### [logoMediumTemp] -Type: **SoftLayer_Marketplace_Partner_Attachment ** +Type: **SoftLayer_Marketplace_Partner_Attachment ** + @@ -271,7 +295,8 @@ classes: [logoSmall]: #logosmall #### [logoSmall] -Type: **SoftLayer_Marketplace_Partner_Attachment ** +Type: **SoftLayer_Marketplace_Partner_Attachment ** + @@ -281,7 +306,8 @@ classes: [logoSmallTemp]: #logosmalltemp #### [logoSmallTemp] -Type: **SoftLayer_Marketplace_Partner_Attachment ** +Type: **SoftLayer_Marketplace_Partner_Attachment ** + @@ -293,7 +319,8 @@ classes: [attachmentCount]: #attachmentcount #### [attachmentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Marketplace_Partner_Attachment/_index.md b/content/reference/datatypes/SoftLayer_Marketplace_Partner_Attachment/_index.md index b795f06cf1..3c578f8519 100644 --- a/content/reference/datatypes/SoftLayer_Marketplace_Partner_Attachment/_index.md +++ b/content/reference/datatypes/SoftLayer_Marketplace_Partner_Attachment/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [attachmentTypeId]: #attachmenttypeid #### [attachmentTypeId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [baseName]: #basename #### [baseName] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [displayName]: #displayname #### [displayName] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [fileName]: #filename #### [fileName] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [marketplacePartnerId]: #marketplacepartnerid #### [marketplacePartnerId] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [saveAsName]: #saveasname #### [saveAsName] -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ classes: [attachmentType]: #attachmenttype #### [attachmentType] -Type: **SoftLayer_Marketplace_Partner_Attachment_Type ** +Type: **SoftLayer_Marketplace_Partner_Attachment_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Marketplace_Partner_Attachment_Type/_index.md b/content/reference/datatypes/SoftLayer_Marketplace_Partner_Attachment_Type/_index.md index 31874e72bd..a0eca50a60 100644 --- a/content/reference/datatypes/SoftLayer_Marketplace_Partner_Attachment_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Marketplace_Partner_Attachment_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [type]: #type #### [type] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Marketplace_Partner_File/_index.md b/content/reference/datatypes/SoftLayer_Marketplace_Partner_File/_index.md index 86b94df173..cdee78c741 100644 --- a/content/reference/datatypes/SoftLayer_Marketplace_Partner_File/_index.md +++ b/content/reference/datatypes/SoftLayer_Marketplace_Partner_File/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [attributes]: #attributes #### [attributes] -Type: **SoftLayer_Marketplace_Partner_File_Attributes ** +Type: **SoftLayer_Marketplace_Partner_File_Attributes ** +
      @@ -55,7 +58,8 @@ classes: [contents]: #contents #### [contents] -Type: **binary data** +Type: **binary data** +
      diff --git a/content/reference/datatypes/SoftLayer_Marketplace_Partner_File_Attributes/_index.md b/content/reference/datatypes/SoftLayer_Marketplace_Partner_File_Attributes/_index.md index c8a754ebcd..2c7b8dacb8 100644 --- a/content/reference/datatypes/SoftLayer_Marketplace_Partner_File_Attributes/_index.md +++ b/content/reference/datatypes/SoftLayer_Marketplace_Partner_File_Attributes/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [bits]: #bits #### [bits] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [channels]: #channels #### [channels] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [height]: #height #### [height] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [htmlAttributes]: #htmlattributes #### [htmlAttributes] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [imageType]: #imagetype #### [imageType] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [isImage]: #isimage #### [isImage] -Type: **boolean** +Type: **boolean** + @@ -105,7 +113,8 @@ classes: [mimeType]: #mimetype #### [mimeType] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [width]: #width #### [width] -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object/_index.md b/content/reference/datatypes/SoftLayer_Metric_Tracking_Object/_index.md index b8e802dbc2..db6d5590c9 100644 --- a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object/_index.md +++ b/content/reference/datatypes/SoftLayer_Metric_Tracking_Object/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) service to retrieve raw and graph data from a tracking object. @@ -50,7 +52,8 @@ Metric tracking objects provides a common interface to all metrics provided by S [data]: #data #### [data] The data recorded by a tracking object. -Type: **SoftLayer_Metric_Tracking_Object_Data[] ** +Type: **SoftLayer_Metric_Tracking_Object_Data[] ** + @@ -60,7 +63,8 @@ The data recorded by a tracking object. [id]: #id #### [id] A tracking object's internal identifier. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ A tracking object's internal identifier. [label]: #label #### [label] Tracking object label -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ Tracking object label [resourceTableId]: #resourcetableid #### [resourceTableId] The identifier of the existing resource this object is attempting to track. -Type: **integer** +Type: **integer** + @@ -90,7 +96,8 @@ The identifier of the existing resource this object is attempting to track. [startDate]: #startdate #### [startDate] The date this tracker began tracking this particular resource. -Type: **dateTime** +Type: **dateTime** + @@ -106,7 +113,8 @@ The date this tracker began tracking this particular resource. [type]: #type #### [type] The type of data that a tracking object polls. -Type: **SoftLayer_Metric_Tracking_Object_Type ** +Type: **SoftLayer_Metric_Tracking_Object_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Abstract/_index.md b/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Abstract/_index.md index e3a43c0c99..0f02763be0 100644 --- a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Abstract/_index.md +++ b/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Abstract/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ SoftLayer_Metric_Tracking_Object_Abstract models a generic tracking object type. [data]: #data #### [data] The data recorded by a tracking object. -Type: **SoftLayer_Metric_Tracking_Object_Data[] ** +Type: **SoftLayer_Metric_Tracking_Object_Data[] ** + @@ -60,7 +63,8 @@ The data recorded by a tracking object. [id]: #id #### [id] A tracking object's internal identifier. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ A tracking object's internal identifier. [label]: #label #### [label] Tracking object label -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ Tracking object label [resourceTableId]: #resourcetableid #### [resourceTableId] The identifier of the existing resource this object is attempting to track. -Type: **integer** +Type: **integer** + @@ -90,7 +96,8 @@ The identifier of the existing resource this object is attempting to track. [startDate]: #startdate #### [startDate] The date this tracker began tracking this particular resource. -Type: **dateTime** +Type: **dateTime** + @@ -106,7 +113,8 @@ The date this tracker began tracking this particular resource. [type]: #type #### [type] The type of data that a tracking object polls. -Type: **SoftLayer_Metric_Tracking_Object_Type ** +Type: **SoftLayer_Metric_Tracking_Object_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary/_index.md b/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary/_index.md index 9fa03bb806..7a26bda7de 100644 --- a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary/_index.md +++ b/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This data type provides commonly used bandwidth summary components for the current billing cycle. @@ -45,7 +47,8 @@ This data type provides commonly used bandwidth summary components for the curre [allocationAmount]: #allocationamount #### [allocationAmount] This is the amount of bandwidth (measured in gigabytes) allocated for this tracking object. -Type: **float** +Type: **float** + @@ -55,7 +58,8 @@ This is the amount of bandwidth (measured in gigabytes) allocated for this track [allocationId]: #allocationid #### [allocationId] -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ This is the amount of bandwidth (measured in gigabytes) allocated for this track [amountOut]: #amountout #### [amountOut] The amount of outbound bandwidth (measured in gigabytes) currently used this billing period. Same as $outboundBandwidthAmount. Aliased for backward compatability. -Type: **decimal** +Type: **decimal** + @@ -75,7 +80,8 @@ The amount of outbound bandwidth (measured in gigabytes) currently used this bil [averageDailyUsage]: #averagedailyusage #### [averageDailyUsage] The daily average amount of outbound bandwidth usage. -Type: **float** +Type: **float** + @@ -85,7 +91,8 @@ The daily average amount of outbound bandwidth usage. [currentlyOverAllocationFlag]: #currentlyoverallocationflag #### [currentlyOverAllocationFlag] A flag that tells whether or not this tracking object's bandwidth usage is already over the allocation. 1 means yes, 0 means no. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ A flag that tells whether or not this tracking object's bandwidth usage is alrea [id]: #id #### [id] The metric tracking id for this resource. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The metric tracking id for this resource. [outboundBandwidthAmount]: #outboundbandwidthamount #### [outboundBandwidthAmount] The amount of outbound bandwidth (measured in gigabytes) currently used this billing period -Type: **decimal** +Type: **decimal** + @@ -115,7 +124,8 @@ The amount of outbound bandwidth (measured in gigabytes) currently used this bil [projectedBandwidthUsage]: #projectedbandwidthusage #### [projectedBandwidthUsage] The amount of bandwidth (measured in gigabytes) of projected usage, using a basic average calculation of daily usage. -Type: **float** +Type: **float** + @@ -125,7 +135,8 @@ The amount of bandwidth (measured in gigabytes) of projected usage, using a basi [projectedOverAllocationFlag]: #projectedoverallocationflag #### [projectedOverAllocationFlag] A flag that tells whether or not this tracking object's bandwidth usage is projected to go over the allocation, based on daily average usage. 1 means yes, 0 means no. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Data/_index.md b/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Data/_index.md index 7b97f5f6dd..b767b09679 100644 --- a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Data/_index.md +++ b/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Data/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -55,7 +57,8 @@ SoftLayer_Metric_Tracking_Object_Data models an individual unit of data tracked [counter]: #counter #### [counter] The value stored for a data record. -Type: **float** +Type: **float** + @@ -65,7 +68,8 @@ The value stored for a data record. [dateTime]: #datetime #### [dateTime] The time a data record was stored. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +79,8 @@ The time a data record was stored. [type]: #type #### [type] The type of data held in a record. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_HardwareServer/_index.md b/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_HardwareServer/_index.md index b96a4dfb17..d01c6026dc 100644 --- a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_HardwareServer/_index.md +++ b/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_HardwareServer/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Metric_Tracking_Object_HardwareServer models tracking objects specific to physical hardware and the data that are recorded by those servers. @@ -53,7 +55,8 @@ SoftLayer_Metric_Tracking_Object_HardwareServer models tracking objects specific [data]: #data #### [data] The data recorded by a tracking object. -Type: **SoftLayer_Metric_Tracking_Object_Data[] ** +Type: **SoftLayer_Metric_Tracking_Object_Data[] ** + @@ -63,7 +66,8 @@ The data recorded by a tracking object. [id]: #id #### [id] A tracking object's internal identifier. -Type: **integer** +Type: **integer** + @@ -73,7 +77,8 @@ A tracking object's internal identifier. [label]: #label #### [label] Tracking object label -Type: **string** +Type: **string** + @@ -83,7 +88,8 @@ Tracking object label [resourceTableId]: #resourcetableid #### [resourceTableId] The identifier of the existing resource this object is attempting to track. -Type: **integer** +Type: **integer** + @@ -93,7 +99,8 @@ The identifier of the existing resource this object is attempting to track. [startDate]: #startdate #### [startDate] The date this tracker began tracking this particular resource. -Type: **dateTime** +Type: **dateTime** + @@ -109,7 +116,8 @@ The date this tracker began tracking this particular resource. [billingCycleBandwidthUsage]: #billingcyclebandwidthusage #### [billingCycleBandwidthUsage] The raw bandwidth usage data for the current billing cycle. One object is returned for each network this server is attached to. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -119,7 +127,8 @@ The raw bandwidth usage data for the current billing cycle. One object is return [billingCyclePrivateBandwidthUsage]: #billingcycleprivatebandwidthusage #### [billingCyclePrivateBandwidthUsage] The raw bandwidth usage data for the current billing cycle. One object is returned for each network this server is attached to. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -129,7 +138,8 @@ The raw bandwidth usage data for the current billing cycle. One object is return [billingCyclePrivateUsageIn]: #billingcycleprivateusagein #### [billingCyclePrivateUsageIn] The total private inbound bandwidth for this item's resource for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -139,7 +149,8 @@ The total private inbound bandwidth for this item's resource for the current bil [billingCyclePrivateUsageOut]: #billingcycleprivateusageout #### [billingCyclePrivateUsageOut] The total private outbound bandwidth for this item's resource for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -149,7 +160,8 @@ The total private outbound bandwidth for this item's resource for the current bi [billingCyclePrivateUsageTotal]: #billingcycleprivateusagetotal #### [billingCyclePrivateUsageTotal] The total private bandwidth for this item's resource for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -159,7 +171,8 @@ The total private bandwidth for this item's resource for the current billing cyc [billingCyclePublicBandwidthUsage]: #billingcyclepublicbandwidthusage #### [billingCyclePublicBandwidthUsage] The raw public bandwidth usage data for the current billing cycle. One object is returned for each network this server is attached to. -Type: **SoftLayer_Network_Bandwidth_Usage ** +Type: **SoftLayer_Network_Bandwidth_Usage ** + @@ -169,7 +182,8 @@ The raw public bandwidth usage data for the current billing cycle. One object is [billingCyclePublicUsageIn]: #billingcyclepublicusagein #### [billingCyclePublicUsageIn] The total public inbound bandwidth for this item's resource for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -179,7 +193,8 @@ The total public inbound bandwidth for this item's resource for the current bill [billingCyclePublicUsageOut]: #billingcyclepublicusageout #### [billingCyclePublicUsageOut] The total public outbound bandwidth for this item's resource for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -189,7 +204,8 @@ The total public outbound bandwidth for this item's resource for the current bil [billingCyclePublicUsageTotal]: #billingcyclepublicusagetotal #### [billingCyclePublicUsageTotal] The total public bandwidth for this item's resource for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -199,7 +215,8 @@ The total public bandwidth for this item's resource for the current billing cycl [resource]: #resource #### [resource] The server that this tracking object tracks. -Type: **SoftLayer_Hardware_Server ** +Type: **SoftLayer_Hardware_Server ** + @@ -209,7 +226,8 @@ The server that this tracking object tracks. [type]: #type #### [type] The type of data that a tracking object polls. -Type: **SoftLayer_Metric_Tracking_Object_Type ** +Type: **SoftLayer_Metric_Tracking_Object_Type ** + @@ -221,7 +239,8 @@ The type of data that a tracking object polls. [billingCycleBandwidthUsageCount]: #billingcyclebandwidthusagecount #### [billingCycleBandwidthUsageCount] A count of the raw bandwidth usage data for the current billing cycle. One object is returned for each network this server is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -231,7 +250,8 @@ A count of the raw bandwidth usage data for the current billing cycle. One objec [billingCyclePrivateBandwidthUsageCount]: #billingcycleprivatebandwidthusagecount #### [billingCyclePrivateBandwidthUsageCount] A count of the raw bandwidth usage data for the current billing cycle. One object is returned for each network this server is attached to. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Type/_index.md b/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Type/_index.md index 2dff88b415..f2d5f29745 100644 --- a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer [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. @@ -50,7 +52,8 @@ SoftLayer [SoftLayer_Metric_Tracking_Object]({{Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ Description A tracking object type's key name. This is a shorter description of [name]: #name #### [name] Description A tracking object type's name. This describes what kind of data a tracking object group is polling. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_VirtualDedicatedRack/_index.md b/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_VirtualDedicatedRack/_index.md index 4193442716..92d802741b 100644 --- a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_VirtualDedicatedRack/_index.md +++ b/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_VirtualDedicatedRack/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ SoftLayer_Metric_Tracking_Object_VirtualDedicatedRack models tracking objects sp [data]: #data #### [data] The data recorded by a tracking object. -Type: **SoftLayer_Metric_Tracking_Object_Data[] ** +Type: **SoftLayer_Metric_Tracking_Object_Data[] ** + @@ -60,7 +63,8 @@ The data recorded by a tracking object. [id]: #id #### [id] A tracking object's internal identifier. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ A tracking object's internal identifier. [label]: #label #### [label] Tracking object label -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ Tracking object label [resourceTableId]: #resourcetableid #### [resourceTableId] The identifier of the existing resource this object is attempting to track. -Type: **integer** +Type: **integer** + @@ -90,7 +96,8 @@ The identifier of the existing resource this object is attempting to track. [startDate]: #startdate #### [startDate] The date this tracker began tracking this particular resource. -Type: **dateTime** +Type: **dateTime** + @@ -106,7 +113,8 @@ The date this tracker began tracking this particular resource. [billingCycleBandwidthUsage]: #billingcyclebandwidthusage #### [billingCycleBandwidthUsage] The raw bandwidth usage data for the current billing cycle. One object is returned for each network this server is attached to. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -116,7 +124,8 @@ The raw bandwidth usage data for the current billing cycle. One object is return [billingCyclePrivateBandwidthUsage]: #billingcycleprivatebandwidthusage #### [billingCyclePrivateBandwidthUsage] The raw bandwidth usage data for the current billing cycle. One object is returned for each network this server is attached to. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -126,7 +135,8 @@ The raw bandwidth usage data for the current billing cycle. One object is return [billingCyclePrivateUsageIn]: #billingcycleprivateusagein #### [billingCyclePrivateUsageIn] The total private inbound bandwidth for this item's resource for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -136,7 +146,8 @@ The total private inbound bandwidth for this item's resource for the current bil [billingCyclePrivateUsageOut]: #billingcycleprivateusageout #### [billingCyclePrivateUsageOut] The total private outbound bandwidth for this item's resource for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -146,7 +157,8 @@ The total private outbound bandwidth for this item's resource for the current bi [billingCyclePrivateUsageTotal]: #billingcycleprivateusagetotal #### [billingCyclePrivateUsageTotal] The total private bandwidth for this item's resource for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -156,7 +168,8 @@ The total private bandwidth for this item's resource for the current billing cyc [billingCyclePublicBandwidthUsage]: #billingcyclepublicbandwidthusage #### [billingCyclePublicBandwidthUsage] The raw bandwidth usage data for the current billing cycle. One object is returned for each network this server is attached to. -Type: **SoftLayer_Network_Bandwidth_Usage ** +Type: **SoftLayer_Network_Bandwidth_Usage ** + @@ -166,7 +179,8 @@ The raw bandwidth usage data for the current billing cycle. One object is return [billingCyclePublicUsageIn]: #billingcyclepublicusagein #### [billingCyclePublicUsageIn] The total public inbound bandwidth for this item's resource for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -176,7 +190,8 @@ The total public inbound bandwidth for this item's resource for the current bill [billingCyclePublicUsageOut]: #billingcyclepublicusageout #### [billingCyclePublicUsageOut] The total public outbound bandwidth for this item's resource for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -186,7 +201,8 @@ The total public outbound bandwidth for this item's resource for the current bil [billingCyclePublicUsageTotal]: #billingcyclepublicusagetotal #### [billingCyclePublicUsageTotal] The total public bandwidth for this item's resource for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -196,7 +212,8 @@ The total public bandwidth for this item's resource for the current billing cycl [resource]: #resource #### [resource] The virtual rack that this tracking object tracks. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** + @@ -206,7 +223,8 @@ The virtual rack that this tracking object tracks. [type]: #type #### [type] The type of data that a tracking object polls. -Type: **SoftLayer_Metric_Tracking_Object_Type ** +Type: **SoftLayer_Metric_Tracking_Object_Type ** + @@ -218,7 +236,8 @@ The type of data that a tracking object polls. [billingCycleBandwidthUsageCount]: #billingcyclebandwidthusagecount #### [billingCycleBandwidthUsageCount] A count of the raw bandwidth usage data for the current billing cycle. One object is returned for each network this server is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -228,7 +247,8 @@ A count of the raw bandwidth usage data for the current billing cycle. One objec [billingCyclePrivateBandwidthUsageCount]: #billingcycleprivatebandwidthusagecount #### [billingCyclePrivateBandwidthUsageCount] A count of the raw bandwidth usage data for the current billing cycle. One object is returned for each network this server is attached to. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository/_index.md b/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository/_index.md index 92a6b10ace..b15a97d01a 100644 --- a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository/_index.md +++ b/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [data]: #data #### [data] The data recorded by a tracking object. -Type: **SoftLayer_Metric_Tracking_Object_Data[] ** +Type: **SoftLayer_Metric_Tracking_Object_Data[] ** +
      @@ -55,7 +58,8 @@ The data recorded by a tracking object. [id]: #id #### [id] A tracking object's internal identifier. -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ A tracking object's internal identifier. [label]: #label #### [label] Tracking object label -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Tracking object label [resourceTableId]: #resourcetableid #### [resourceTableId] The identifier of the existing resource this object is attempting to track. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The identifier of the existing resource this object is attempting to track. [startDate]: #startdate #### [startDate] The date this tracker began tracking this particular resource. -Type: **dateTime** +Type: **dateTime** + @@ -101,7 +108,8 @@ The date this tracker began tracking this particular resource. [resource]: #resource #### [resource] The virtual storage repository that this tracking object tracks. -Type: **SoftLayer_Virtual_Storage_Repository ** +Type: **SoftLayer_Virtual_Storage_Repository ** + @@ -111,7 +119,8 @@ The virtual storage repository that this tracking object tracks. [type]: #type #### [type] The type of data that a tracking object polls. -Type: **SoftLayer_Metric_Tracking_Object_Type ** +Type: **SoftLayer_Metric_Tracking_Object_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Monitoring_Robot/_index.md b/content/reference/datatypes/SoftLayer_Monitoring_Robot/_index.md index addf5d964e..7387418301 100644 --- a/content/reference/datatypes/SoftLayer_Monitoring_Robot/_index.md +++ b/content/reference/datatypes/SoftLayer_Monitoring_Robot/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + DEPRECATED. The SoftLayer_Monitoring_Robot data type contains general information relating to a monitoring robot. @@ -45,7 +47,8 @@ DEPRECATED. The SoftLayer_Monitoring_Robot data type contains general informatio [accountId]: #accountid #### [accountId] DEPRECATED. Internal identifier of a SoftLayer account that this robot belongs to -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ DEPRECATED. Internal identifier of a SoftLayer account that this robot belongs t [id]: #id #### [id] DEPRECATED. Internal identifier of a monitoring robot -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ DEPRECATED. Internal identifier of a monitoring robot [name]: #name #### [name] DEPRECATED. Robot name -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ DEPRECATED. Robot name [statusId]: #statusid #### [statusId] DEPRECATED. Internal identifier of a monitoring robot status -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Monitoring_Robot_Status/_index.md b/content/reference/datatypes/SoftLayer_Monitoring_Robot_Status/_index.md index 49e949fffa..e218d5dd01 100644 --- a/content/reference/datatypes/SoftLayer_Monitoring_Robot_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Monitoring_Robot_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -49,7 +51,8 @@ See [SoftLayer_Monitoring_Robot::resetStatus]({{Type: **string** +Type: **string** + @@ -59,7 +62,8 @@ DEPRECATED. Monitoring robot status description [id]: #id #### [id] DEPRECATED. Internal identifier of a monitoring robot status -Type: **integer** +Type: **integer** + @@ -69,7 +73,8 @@ DEPRECATED. Internal identifier of a monitoring robot status [name]: #name #### [name] DEPRECATED. Monitoring robot status name -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network/_index.md b/content/reference/datatypes/SoftLayer_Network/_index.md index 5de4b551b7..38b3e919a3 100644 --- a/content/reference/datatypes/SoftLayer_Network/_index.md +++ b/content/reference/datatypes/SoftLayer_Network/_index.md @@ -24,6 +24,8 @@ classes: + +
      diff --git a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller/_index.md b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller/_index.md index a31212a3da..0f10fc8c62 100644 --- a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller/_index.md @@ -18,6 +18,8 @@ classes:
      ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Application_Delivery_Controller data type models a single [accountId]: #accountid #### [accountId] The unique identifier of the SoftLayer customer account that owns an application delivery controller record -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The unique identifier of the SoftLayer customer account that owns an application [createDate]: #createdate #### [createDate] The date that an application delivery controller record was created -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The date that an application delivery controller record was created [id]: #id #### [id] An application delivery controller's unique identifier -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ An application delivery controller's unique identifier [modifyDate]: #modifydate #### [modifyDate] The date that an application delivery controller record was last modified -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The date that an application delivery controller record was last modified [name]: #name #### [name] An application delivery controller's name -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ An application delivery controller's name [notes]: #notes #### [notes] Editable notes used to describe an application delivery controller's function -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ Editable notes used to describe an application delivery controller's function [typeId]: #typeid #### [typeId] -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ Editable notes used to describe an application delivery controller's function [account]: #account #### [account] The SoftLayer customer account that owns an application delivery controller record. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -131,7 +141,8 @@ The SoftLayer customer account that owns an application delivery controller reco [averageDailyPublicBandwidthUsage]: #averagedailypublicbandwidthusage #### [averageDailyPublicBandwidthUsage] The average daily public bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -141,7 +152,8 @@ The average daily public bandwidth usage for the current billing cycle. [billingItem]: #billingitem #### [billingItem] The billing item for a Application Delivery Controller. -Type: **SoftLayer_Billing_Item_Network_Application_Delivery_Controller ** +Type: **SoftLayer_Billing_Item_Network_Application_Delivery_Controller ** + @@ -151,7 +163,8 @@ The billing item for a Application Delivery Controller. [configurationHistory]: #configurationhistory #### [configurationHistory] Previous configurations for an Application Delivery Controller. -Type: **SoftLayer_Network_Application_Delivery_Controller_Configuration_History[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller_Configuration_History[] ** + @@ -161,7 +174,8 @@ Previous configurations for an Application Delivery Controller. [datacenter]: #datacenter #### [datacenter] The datacenter that the application delivery controller resides in. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -171,7 +185,8 @@ The datacenter that the application delivery controller resides in. [description]: #description #### [description] A brief description of an application delivery controller record. -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ A brief description of an application delivery controller record. [licenseExpirationDate]: #licenseexpirationdate #### [licenseExpirationDate] The date in which the license for this application delivery controller will expire. -Type: **dateTime** +Type: **dateTime** + @@ -191,7 +207,8 @@ The date in which the license for this application delivery controller will expi [loadBalancers]: #loadbalancers #### [loadBalancers] The virtual IP address records that belong to an application delivery controller based load balancer. -Type: **SoftLayer_Network_LoadBalancer_VirtualIpAddress[] ** +Type: **SoftLayer_Network_LoadBalancer_VirtualIpAddress[] ** + @@ -201,7 +218,8 @@ The virtual IP address records that belong to an application delivery controller [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that this Application Delivery Controller is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -211,7 +229,8 @@ A flag indicating that this Application Delivery Controller is a managed resourc [managementIpAddress]: #managementipaddress #### [managementIpAddress] An application delivery controller's management ip address. -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ An application delivery controller's management ip address. [networkVlan]: #networkvlan #### [networkVlan] The network VLAN that an application delivery controller resides on. -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + @@ -231,7 +251,8 @@ The network VLAN that an application delivery controller resides on. [networkVlans]: #networkvlans #### [networkVlans] The network VLANs that an application delivery controller resides on. -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -241,7 +262,8 @@ The network VLANs that an application delivery controller resides on. [outboundPublicBandwidthUsage]: #outboundpublicbandwidthusage #### [outboundPublicBandwidthUsage] The total public outbound bandwidth for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -251,7 +273,8 @@ The total public outbound bandwidth for the current billing cycle. [password]: #password #### [password] The password used to connect to an application delivery controller's management interface when it is operating in advanced view mode. -Type: **SoftLayer_Software_Component_Password ** +Type: **SoftLayer_Software_Component_Password ** + @@ -261,7 +284,8 @@ The password used to connect to an application delivery controller's management [primaryIpAddress]: #primaryipaddress #### [primaryIpAddress] An application delivery controller's primary public IP address. -Type: **string** +Type: **string** + @@ -271,7 +295,8 @@ An application delivery controller's primary public IP address. [projectedPublicBandwidthUsage]: #projectedpublicbandwidthusage #### [projectedPublicBandwidthUsage] The projected public outbound bandwidth for the current billing cycle. -Type: **float** +Type: **float** + @@ -281,7 +306,8 @@ The projected public outbound bandwidth for the current billing cycle. [subnets]: #subnets #### [subnets] A network application controller's subnets. A subnet is a group of IP addresses -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -291,7 +317,8 @@ A network application controller's subnets. A subnet is a group of IP addresses [tagReferences]: #tagreferences #### [tagReferences] -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** + @@ -301,7 +328,8 @@ A network application controller's subnets. A subnet is a group of IP addresses [type]: #type #### [type] -Type: **SoftLayer_Network_Application_Delivery_Controller_Type ** +Type: **SoftLayer_Network_Application_Delivery_Controller_Type ** + @@ -311,7 +339,8 @@ A network application controller's subnets. A subnet is a group of IP addresses [virtualIpAddresses]: #virtualipaddresses #### [virtualIpAddresses] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress[] ** + @@ -323,7 +352,8 @@ A network application controller's subnets. A subnet is a group of IP addresses [configurationHistoryCount]: #configurationhistorycount #### [configurationHistoryCount] A count of previous configurations for an Application Delivery Controller. -Type: **unsigned long** +Type: **unsigned long** + @@ -333,7 +363,8 @@ A count of previous configurations for an Application Delivery Controller. [loadBalancerCount]: #loadbalancercount #### [loadBalancerCount] A count of the virtual IP address records that belong to an application delivery controller based load balancer. -Type: **unsigned long** +Type: **unsigned long** + @@ -343,7 +374,8 @@ A count of the virtual IP address records that belong to an application delivery [networkVlanCount]: #networkvlancount #### [networkVlanCount] A count of the network VLANs that an application delivery controller resides on. -Type: **unsigned long** +Type: **unsigned long** + @@ -353,7 +385,8 @@ A count of the network VLANs that an application delivery controller resides on. [subnetCount]: #subnetcount #### [subnetCount] A count of a network application controller's subnets. A subnet is a group of IP addresses -Type: **unsigned long** +Type: **unsigned long** + @@ -363,7 +396,8 @@ A count of a network application controller's subnets. A subnet is a group of IP [tagReferenceCount]: #tagreferencecount #### [tagReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -373,7 +407,8 @@ A count of [virtualIpAddressCount]: #virtualipaddresscount #### [virtualIpAddressCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/_index.md b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/_index.md index d3ab558917..1a0ade27fe 100644 --- a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Application_Delivery_Controller_Configuration_History data [createDate]: #createdate #### [createDate] The date a configuration history record was created. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The date a configuration history record was created. [id]: #id #### [id] An configuration history record's unique identifier -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An configuration history record's unique identifier [notes]: #notes #### [notes] Editable notes used to describe a configuration history record -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ Editable notes used to describe a configuration history record [controller]: #controller #### [controller] The application delivery controller that a configuration history record belongs to. -Type: **SoftLayer_Network_Application_Delivery_Controller ** +Type: **SoftLayer_Network_Application_Delivery_Controller ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/_index.md index 9a071ab91d..22688cdf35 100644 --- a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [healthAttributeTypeId]: #healthattributetypeid #### [healthAttributeTypeId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [healthCheckId]: #healthcheckid #### [healthCheckId] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [value]: #value #### [value] -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ classes: [healthCheck]: #healthcheck #### [healthCheck] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check ** + @@ -101,7 +108,8 @@ classes: [type]: #type #### [type] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/_index.md index 64cce27e18..b8676d420b 100644 --- a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [keyname]: #keyname #### [keyname] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [valueExpression]: #valueexpression #### [valueExpression] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/_index.md b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/_index.md index bea1788956..7bb8d48f05 100644 --- a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [healthCheckTypeId]: #healthchecktypeid #### [healthCheckTypeId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [notes]: #notes #### [notes] -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ classes: [attributes]: #attributes #### [attributes] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute[] ** + @@ -101,7 +108,8 @@ classes: [scaleLoadBalancers]: #scaleloadbalancers #### [scaleLoadBalancers] Collection of scale load balancers that use this health check. -Type: **SoftLayer_Scale_LoadBalancer[] ** +Type: **SoftLayer_Scale_LoadBalancer[] ** + @@ -111,7 +119,8 @@ Collection of scale load balancers that use this health check. [services]: #services #### [services] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service[] ** + @@ -121,7 +130,8 @@ Collection of scale load balancers that use this health check. [type]: #type #### [type] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type ** + @@ -133,7 +143,8 @@ Collection of scale load balancers that use this health check. [attributeCount]: #attributecount #### [attributeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -143,7 +154,8 @@ A count of [scaleLoadBalancerCount]: #scaleloadbalancercount #### [scaleLoadBalancerCount] A count of collection of scale load balancers that use this health check. -Type: **unsigned long** +Type: **unsigned long** + @@ -153,7 +165,8 @@ A count of collection of scale load balancers that use this health check. [serviceCount]: #servicecount #### [serviceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/_index.md index 81a59c4a23..81db6ba98b 100644 --- a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [keyname]: #keyname #### [keyname] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/_index.md b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/_index.md index 676c08b113..5fc1abcc48 100644 --- a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [keyname]: #keyname #### [keyname] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/_index.md index 1e78e00c3c..5ff623ea97 100644 --- a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [keyname]: #keyname #### [keyname] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/_index.md b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/_index.md index 864bb91596..dcf4567024 100644 --- a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [enabled]: #enabled #### [enabled] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [ipAddressId]: #ipaddressid #### [ipAddressId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [notes]: #notes #### [notes] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [port]: #port #### [port] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [status]: #status #### [status] -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ classes: [groupReferences]: #groupreferences #### [groupReferences] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group_CrossReference[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group_CrossReference[] ** + @@ -131,7 +141,8 @@ classes: [groups]: #groups #### [groups] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group[] ** + @@ -141,7 +152,8 @@ classes: [healthCheck]: #healthcheck #### [healthCheck] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check ** + @@ -151,7 +163,8 @@ classes: [healthChecks]: #healthchecks #### [healthChecks] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check[] ** + @@ -161,7 +174,8 @@ classes: [ipAddress]: #ipaddress #### [ipAddress] -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -171,7 +185,8 @@ classes: [serviceGroup]: #servicegroup #### [serviceGroup] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group ** + @@ -183,7 +198,8 @@ classes: [groupCount]: #groupcount #### [groupCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -193,7 +209,8 @@ A count of [groupReferenceCount]: #groupreferencecount #### [groupReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -203,7 +220,8 @@ A count of [healthCheckCount]: #healthcheckcount #### [healthCheckCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/_index.md b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/_index.md index f2cbb8ba1b..2bb2dd0215 100644 --- a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [notes]: #notes #### [notes] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [routingMethodId]: #routingmethodid #### [routingMethodId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [routingTypeId]: #routingtypeid #### [routingTypeId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [timeout]: #timeout #### [timeout] The timeout value for connections from remote clients to the load balancer. Timeout values are only valid for HTTP service groups. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The timeout value for connections from remote clients to the load balancer. Time [routingMethod]: #routingmethod #### [routingMethod] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method ** + @@ -121,7 +130,8 @@ The timeout value for connections from remote clients to the load balancer. Time [routingType]: #routingtype #### [routingType] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type ** + @@ -131,7 +141,8 @@ The timeout value for connections from remote clients to the load balancer. Time [serviceReferences]: #servicereferences #### [serviceReferences] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group_CrossReference[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group_CrossReference[] ** + @@ -141,7 +152,8 @@ The timeout value for connections from remote clients to the load balancer. Time [services]: #services #### [services] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service[] ** + @@ -151,7 +163,8 @@ The timeout value for connections from remote clients to the load balancer. Time [virtualServer]: #virtualserver #### [virtualServer] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer ** + @@ -161,7 +174,8 @@ The timeout value for connections from remote clients to the load balancer. Time [virtualServers]: #virtualservers #### [virtualServers] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer[] ** + @@ -173,7 +187,8 @@ The timeout value for connections from remote clients to the load balancer. Time [serviceCount]: #servicecount #### [serviceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of [serviceReferenceCount]: #servicereferencecount #### [serviceReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -193,7 +209,8 @@ A count of [virtualServerCount]: #virtualservercount #### [virtualServerCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group_CrossReference/_index.md b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group_CrossReference/_index.md index 9cd377a3a3..57cca6abbb 100644 --- a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group_CrossReference/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group_CrossReference/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [serviceGroupId]: #servicegroupid #### [serviceGroupId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [serviceId]: #serviceid #### [serviceId] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [weight]: #weight #### [weight] -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ classes: [service]: #service #### [service] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service ** + @@ -91,7 +97,8 @@ classes: [serviceGroup]: #servicegroup #### [serviceGroup] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/_index.md b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/_index.md index a21523cbbc..f7ce2a8804 100644 --- a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The unique identifier of the SoftLayer customer account that owns the virtual IP address -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The unique identifier of the SoftLayer customer account that owns the virtual IP [connectionLimit]: #connectionlimit #### [connectionLimit] The connection limit for this virtual IP address -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ The connection limit for this virtual IP address [connectionLimitUnits]: #connectionlimitunits #### [connectionLimitUnits] The units for the connection limit -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The units for the connection limit [dedicatedFlag]: #dedicatedflag #### [dedicatedFlag] A flag that determines if a VIP is dedicated or not. This is used to override the connection limit and use an unlimited value. -Type: **boolean** +Type: **boolean** + @@ -85,7 +91,8 @@ A flag that determines if a VIP is dedicated or not. This is used to override th [id]: #id #### [id] The unique identifier of the virtual IP address record -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The unique identifier of the virtual IP address record [ipAddressId]: #ipaddressid #### [ipAddressId] ID of the IP address this virtual IP utilizes -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ ID of the IP address this virtual IP utilizes [notes]: #notes #### [notes] User-created notes for this load balancer virtual IP address -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ User-created notes for this load balancer virtual IP address [securityCertificateId]: #securitycertificateid #### [securityCertificateId] The unique identifier of the Security Certificate to be utilized when SSL support is enabled. -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ The unique identifier of the Security Certificate to be utilized when SSL suppor [sslActiveFlag]: #sslactiveflag #### [sslActiveFlag] Determines if the VIP currently has SSL acceleration enabled -Type: **boolean** +Type: **boolean** + @@ -135,7 +146,8 @@ Determines if the VIP currently has SSL acceleration enabled [sslEnabledFlag]: #sslenabledflag #### [sslEnabledFlag] Determines if the VIP is _allowed_ to utilize SSL acceleration -Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ Determines if the VIP is _allowed_ to utilize SSL acceleration [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -161,7 +174,8 @@ Determines if the VIP is _allowed_ to utilize SSL acceleration [applicationDeliveryController]: #applicationdeliverycontroller #### [applicationDeliveryController] A virtual IP address's associated application delivery controller. -Type: **SoftLayer_Network_Application_Delivery_Controller ** +Type: **SoftLayer_Network_Application_Delivery_Controller ** + @@ -171,7 +185,8 @@ A virtual IP address's associated application delivery controller. [applicationDeliveryControllers]: #applicationdeliverycontrollers #### [applicationDeliveryControllers] A virtual IP address's associated application delivery controllers. -Type: **SoftLayer_Network_Application_Delivery_Controller[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller[] ** + @@ -181,7 +196,8 @@ A virtual IP address's associated application delivery controllers. [billingItem]: #billingitem #### [billingItem] The current billing item for the load balancer virtual IP. This is only valid when dedicatedFlag is false. This is an independent virtual IP, and if canceled, will only affect the associated virtual IP. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -191,7 +207,8 @@ The current billing item for the load balancer virtual IP. This is only valid wh [dedicatedBillingItem]: #dedicatedbillingitem #### [dedicatedBillingItem] The current billing item for the load balancing device housing the virtual IP. This billing item represents a device which could contain other virtual IPs. Caution should be taken when canceling. This is only valid when dedicatedFlag is true. -Type: **SoftLayer_Billing_Item_Network_LoadBalancer ** +Type: **SoftLayer_Billing_Item_Network_LoadBalancer ** + @@ -201,7 +218,8 @@ The current billing item for the load balancing device housing the virtual IP. T [highAvailabilityFlag]: #highavailabilityflag #### [highAvailabilityFlag] Denotes whether the virtual IP is configured within a high availability cluster. -Type: **boolean** +Type: **boolean** + @@ -211,7 +229,8 @@ Denotes whether the virtual IP is configured within a high availability cluster. [ipAddress]: #ipaddress #### [ipAddress] -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -221,7 +240,8 @@ Denotes whether the virtual IP is configured within a high availability cluster. [loadBalancerHardware]: #loadbalancerhardware #### [loadBalancerHardware] -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -231,7 +251,8 @@ Denotes whether the virtual IP is configured within a high availability cluster. [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the load balancer is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -241,7 +262,8 @@ A flag indicating that the load balancer is a managed resource. [secureTransportCiphers]: #securetransportciphers #### [secureTransportCiphers] The list of security ciphers enabled for this virtual IP address -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportCipher[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportCipher[] ** + @@ -251,7 +273,8 @@ The list of security ciphers enabled for this virtual IP address [secureTransportProtocols]: #securetransportprotocols #### [secureTransportProtocols] The list of secure transport protocols enabled for this virtual IP address -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportProtocol[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportProtocol[] ** + @@ -261,7 +284,8 @@ The list of secure transport protocols enabled for this virtual IP address [securityCertificate]: #securitycertificate #### [securityCertificate] The SSL certificate currently associated with the VIP. -Type: **SoftLayer_Security_Certificate ** +Type: **SoftLayer_Security_Certificate ** + @@ -271,7 +295,8 @@ The SSL certificate currently associated with the VIP. [securityCertificateEntry]: #securitycertificateentry #### [securityCertificateEntry] The SSL certificate currently associated with the VIP. Provides chosen certificate visibility to unprivileged users. -Type: **SoftLayer_Security_Certificate_Entry ** +Type: **SoftLayer_Security_Certificate_Entry ** + @@ -281,7 +306,8 @@ The SSL certificate currently associated with the VIP. Provides chosen certifica [virtualServers]: #virtualservers #### [virtualServers] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer[] ** + @@ -293,7 +319,8 @@ The SSL certificate currently associated with the VIP. Provides chosen certifica [applicationDeliveryControllerCount]: #applicationdeliverycontrollercount #### [applicationDeliveryControllerCount] A count of a virtual IP address's associated application delivery controllers. -Type: **unsigned long** +Type: **unsigned long** + @@ -303,7 +330,8 @@ A count of a virtual IP address's associated application delivery controllers. [loadBalancerHardwareCount]: #loadbalancerhardwarecount #### [loadBalancerHardwareCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -313,7 +341,8 @@ A count of [secureTransportCipherCount]: #securetransportciphercount #### [secureTransportCipherCount] A count of the list of security ciphers enabled for this virtual IP address -Type: **unsigned long** +Type: **unsigned long** + @@ -323,7 +352,8 @@ A count of the list of security ciphers enabled for this virtual IP address [secureTransportProtocolCount]: #securetransportprotocolcount #### [secureTransportProtocolCount] A count of the list of secure transport protocols enabled for this virtual IP address -Type: **unsigned long** +Type: **unsigned long** + @@ -333,7 +363,8 @@ A count of the list of secure transport protocols enabled for this virtual IP ad [virtualServerCount]: #virtualservercount #### [virtualServerCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportCipher/_index.md b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportCipher/_index.md index 78e3e3e0ee..9ac6c28dcf 100644 --- a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportCipher/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportCipher/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ A single cipher configured for a load balancer virtual IP address instance. Inst [id]: #id #### [id] Unique identifier for the cipher instance -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Unique identifier for the cipher instance [keyName]: #keyname #### [keyName] Identifier for the associated encryption algorithm -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Identifier for the associated encryption algorithm [virtualIpAddressId]: #virtualipaddressid #### [virtualIpAddressId] Identifier for the associated [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress]({{}}) instance -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ Identifier for the associated [SoftLayer_Network_Application_Delivery_Controller [virtualIpAddress]: #virtualipaddress #### [virtualIpAddress] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportProtocol/_index.md b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportProtocol/_index.md index 7bc450ed4f..b380f199f2 100644 --- a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportProtocol/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportProtocol/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ Links a SSL transport protocol with a virtual IP address instance. Instances of [id]: #id #### [id] Unique identifier for the protocol instance -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Unique identifier for the protocol instance [keyName]: #keyname #### [keyName] Identifier for the associated communication protocol -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Identifier for the associated communication protocol [virtualIpAddressId]: #virtualipaddressid #### [virtualIpAddressId] Identifier for the associated [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress]({{}}) instance -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ Identifier for the associated [SoftLayer_Network_Application_Delivery_Controller [virtualIpAddress]: #virtualipaddress #### [virtualIpAddress] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/_index.md b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/_index.md index 5c7ef5df0b..120dd39289 100644 --- a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [allocation]: #allocation #### [allocation] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [notes]: #notes #### [notes] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [port]: #port #### [port] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [routingMethodId]: #routingmethodid #### [routingMethodId] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [virtualIpAddressId]: #virtualipaddressid #### [virtualIpAddressId] -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ classes: [routingMethod]: #routingmethod #### [routingMethod] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method ** + @@ -131,7 +141,8 @@ classes: [scaleLoadBalancers]: #scaleloadbalancers #### [scaleLoadBalancers] Collection of scale load balancers this virtual server applies to. -Type: **SoftLayer_Scale_LoadBalancer[] ** +Type: **SoftLayer_Scale_LoadBalancer[] ** + @@ -141,7 +152,8 @@ Collection of scale load balancers this virtual server applies to. [serviceGroups]: #servicegroups #### [serviceGroups] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group[] ** + @@ -151,7 +163,8 @@ Collection of scale load balancers this virtual server applies to. [virtualIpAddress]: #virtualipaddress #### [virtualIpAddress] -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress ** + @@ -163,7 +176,8 @@ Collection of scale load balancers this virtual server applies to. [scaleLoadBalancerCount]: #scaleloadbalancercount #### [scaleLoadBalancerCount] A count of collection of scale load balancers this virtual server applies to. -Type: **unsigned long** +Type: **unsigned long** + @@ -173,7 +187,8 @@ A count of collection of scale load balancers this virtual server applies to. [serviceGroupCount]: #servicegroupcount #### [serviceGroupCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_Type/_index.md index 677b04fe11..645cf1599d 100644 --- a/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
      diff --git a/content/reference/datatypes/SoftLayer_Network_Backbone/_index.md b/content/reference/datatypes/SoftLayer_Network_Backbone/_index.md index e2b3b76d0e..d839fb9b7c 100644 --- a/content/reference/datatypes/SoftLayer_Network_Backbone/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Backbone/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A SoftLayer_Network_Backbone represents a single backbone connection from SoftLayer to the public Internet, from the Internet to the SoftLayer private network, or a link that connects the private networks between SoftLayer's datacenters. The SoftLayer_Network_Backbone data type is a collection of data associated with one of those connections. @@ -51,7 +53,8 @@ A SoftLayer_Network_Backbone represents a single backbone connection from SoftLa [capacity]: #capacity #### [capacity] The numeric portion of the bandwidth capacity of a SoftLayer backbone. For instance, if a backbone is rated at "1 GigE" capacity then the capacity property of the backbone is 1. -Type: **integer** +Type: **integer** + @@ -61,7 +64,8 @@ The numeric portion of the bandwidth capacity of a SoftLayer backbone. For insta [capacityUnits]: #capacityunits #### [capacityUnits] The unit portion of the bandwidth capacity of a SoftLayer backbone. For instance, if a backbone is rated at "10 G" capacity then the capacityUnits property of the backbone is "G". -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ The unit portion of the bandwidth capacity of a SoftLayer backbone. For instance [id]: #id #### [id] A backbone's internal identifier. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ A backbone's internal identifier. [name]: #name #### [name] A backbone's name. This is usually the name of the backbone's network provider followed by a number in case SoftLayer uses more than one backbone from a provider. Backbone provider numbers start with the number one and increment from there. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A backbone's name. This is usually the name of the backbone's network provider f [networkComponentId]: #networkcomponentid #### [networkComponentId] The internal identifier of the network component that backbone is connected to. -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ The internal identifier of the network component that backbone is connected to. [type]: #type #### [type] Whether a SoftLayer backbone connects to the public Internet, to the private network, or connecting the private networks of SoftLayer's datacenters. Type is either the string "public", "private", or "private-interconnect". -Type: **string** +Type: **string** + @@ -117,7 +125,8 @@ Whether a SoftLayer backbone connects to the public Internet, to the private net [health]: #health #### [health] A backbone's status. -Type: **string** +Type: **string** + @@ -127,7 +136,8 @@ A backbone's status. [location]: #location #### [location] Which of the SoftLayer datacenters a backbone is connected to. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -137,7 +147,8 @@ Which of the SoftLayer datacenters a backbone is connected to. [networkComponent]: #networkcomponent #### [networkComponent] A backbone's primary network component. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Backbone_Location_Dependent/_index.md b/content/reference/datatypes/SoftLayer_Network_Backbone_Location_Dependent/_index.md index d0d9021fa9..ae3f569490 100644 --- a/content/reference/datatypes/SoftLayer_Network_Backbone_Location_Dependent/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Backbone_Location_Dependent/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [dependentLocationId]: #dependentlocationid #### [dependentLocationId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [sourceLocationId]: #sourcelocationid #### [sourceLocationId] -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ classes: [dependentLocation]: #dependentlocation #### [dependentLocation] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -91,7 +97,8 @@ classes: [sourceLocation]: #sourcelocation #### [sourceLocation] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Usage/_index.md b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Usage/_index.md index eabe063923..0f63636f86 100644 --- a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Usage/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Usage/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Bandwidth_Usage data type contains specific information re [amountIn]: #amountin #### [amountIn] Incoming bandwidth utilization. -Type: **decimal** +Type: **decimal** + @@ -55,7 +58,8 @@ Incoming bandwidth utilization. [amountOut]: #amountout #### [amountOut] Outgoing bandwidth utilization. -Type: **decimal** +Type: **decimal** + @@ -65,7 +69,8 @@ Outgoing bandwidth utilization. [bandwidthUsageDetailTypeId]: #bandwidthusagedetailtypeid #### [bandwidthUsageDetailTypeId] ID of the bandwidth usage detail type for this record. -Type: **decimal** +Type: **decimal** + @@ -81,7 +86,8 @@ ID of the bandwidth usage detail type for this record. [trackingObject]: #trackingobject #### [trackingObject] The tracking object this bandwidth usage record describes. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -91,7 +97,8 @@ The tracking object this bandwidth usage record describes. [type]: #type #### [type] In and out bandwidth utilization for a specified time stamp. -Type: **SoftLayer_Network_Bandwidth_Version1_Usage_Detail_Type ** +Type: **SoftLayer_Network_Bandwidth_Version1_Usage_Detail_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Allocation/_index.md b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Allocation/_index.md index c1887229c6..e47e45f464 100644 --- a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Allocation/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Allocation/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Bandwidth_Version1_Allocation data type contains general information relating to a single bandwidth allocation record. @@ -45,7 +47,8 @@ The SoftLayer_Network_Bandwidth_Version1_Allocation data type contains general i [amount]: #amount #### [amount] The amount of bandwidth allocated. -Type: **decimal** +Type: **decimal** + @@ -55,7 +58,8 @@ The amount of bandwidth allocated. [id]: #id #### [id] Internal ID associated with this allocation. -Type: **integer** +Type: **integer** + @@ -71,7 +75,8 @@ Internal ID associated with this allocation. [allotmentDetail]: #allotmentdetail #### [allotmentDetail] A bandwidth allotment detail. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** + @@ -81,7 +86,8 @@ A bandwidth allotment detail. [billingItem]: #billingitem #### [billingItem] Billing item associated with this hardware allocation. -Type: **SoftLayer_Billing_Item_Hardware ** +Type: **SoftLayer_Billing_Item_Hardware ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Allotment/_index.md b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Allotment/_index.md index 4227bed7d6..4b9ec1d3af 100644 --- a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Allotment/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Allotment/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Bandwidth_Version1_Allotment class provides methods and da [accountId]: #accountid #### [accountId] The user account identifier associated with this allotment. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The user account identifier associated with this allotment. [bandwidthAllotmentTypeId]: #bandwidthallotmenttypeid #### [bandwidthAllotmentTypeId] An identifier marking this allotment as a virtual private rack (1) or a bandwidth pooling(2). -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An identifier marking this allotment as a virtual private rack (1) or a bandwidt [createDate]: #createdate #### [createDate] Creation date for an allotment. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ Creation date for an allotment. [endDate]: #enddate #### [endDate] End date for an allotment. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ End date for an allotment. [id]: #id #### [id] A virtual rack's internal identifier. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ A virtual rack's internal identifier. [locationGroupId]: #locationgroupid #### [locationGroupId] Location Group Id for an allotment -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ Location Group Id for an allotment [name]: #name #### [name] Text A virtual rack's name. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ Text A virtual rack's name. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] Service Provider Id for an allotment -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ Service Provider Id for an allotment [account]: #account #### [account] The account associated with this virtual rack. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -141,7 +152,8 @@ The account associated with this virtual rack. [activeDetails]: #activedetails #### [activeDetails] The bandwidth allotment detail records associated with this virtual rack. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail[] ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail[] ** + @@ -151,7 +163,8 @@ The bandwidth allotment detail records associated with this virtual rack. [applicationDeliveryControllers]: #applicationdeliverycontrollers #### [applicationDeliveryControllers] The Application Delivery Controller contained within a virtual rack. -Type: **SoftLayer_Network_Application_Delivery_Controller[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller[] ** + @@ -161,7 +174,8 @@ The Application Delivery Controller contained within a virtual rack. [averageDailyPublicBandwidthUsage]: #averagedailypublicbandwidthusage #### [averageDailyPublicBandwidthUsage] The average daily public bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -171,7 +185,8 @@ The average daily public bandwidth usage for the current billing cycle. [bandwidthAllotmentType]: #bandwidthallotmenttype #### [bandwidthAllotmentType] The bandwidth allotment type of this virtual rack. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Type ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Type ** + @@ -181,7 +196,8 @@ The bandwidth allotment type of this virtual rack. [bareMetalInstances]: #baremetalinstances #### [bareMetalInstances] The bare metal server instances contained within a virtual rack. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -191,7 +207,8 @@ The bare metal server instances contained within a virtual rack. [billingCycleBandwidthUsage]: #billingcyclebandwidthusage #### [billingCycleBandwidthUsage] A virtual rack's raw bandwidth usage data for an account's current billing cycle. One object is returned for each network this server is attached to. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -201,7 +218,8 @@ A virtual rack's raw bandwidth usage data for an account's current billing cycle [billingCyclePrivateBandwidthUsage]: #billingcycleprivatebandwidthusage #### [billingCyclePrivateBandwidthUsage] A virtual rack's raw private network bandwidth usage data for an account's current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage ** +Type: **SoftLayer_Network_Bandwidth_Usage ** + @@ -211,7 +229,8 @@ A virtual rack's raw private network bandwidth usage data for an account's curre [billingCyclePublicBandwidthUsage]: #billingcyclepublicbandwidthusage #### [billingCyclePublicBandwidthUsage] A virtual rack's raw public network bandwidth usage data for an account's current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage ** +Type: **SoftLayer_Network_Bandwidth_Usage ** + @@ -221,7 +240,8 @@ A virtual rack's raw public network bandwidth usage data for an account's curren [billingCyclePublicUsageTotal]: #billingcyclepublicusagetotal #### [billingCyclePublicUsageTotal] The total public bandwidth used in this virtual rack for an account's current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -231,7 +251,8 @@ The total public bandwidth used in this virtual rack for an account's current bi [billingItem]: #billingitem #### [billingItem] A virtual rack's billing item. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -241,7 +262,8 @@ A virtual rack's billing item. [currentBandwidthSummary]: #currentbandwidthsummary #### [currentBandwidthSummary] An object that provides commonly used bandwidth summary components for the current billing cycle. -Type: **SoftLayer_Metric_Tracking_Object_Bandwidth_Summary ** +Type: **SoftLayer_Metric_Tracking_Object_Bandwidth_Summary ** + @@ -251,7 +273,8 @@ An object that provides commonly used bandwidth summary components for the curre [details]: #details #### [details] The bandwidth allotment detail records associated with this virtual rack. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail[] ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail[] ** + @@ -261,7 +284,8 @@ The bandwidth allotment detail records associated with this virtual rack. [hardware]: #hardware #### [hardware] The hardware contained within a virtual rack. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -271,7 +295,8 @@ The hardware contained within a virtual rack. [inboundPublicBandwidthUsage]: #inboundpublicbandwidthusage #### [inboundPublicBandwidthUsage] The total public inbound bandwidth used in this virtual rack for an account's current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -281,7 +306,8 @@ The total public inbound bandwidth used in this virtual rack for an account's cu [locationGroup]: #locationgroup #### [locationGroup] The location group associated with this virtual rack. -Type: **SoftLayer_Location_Group ** +Type: **SoftLayer_Location_Group ** + @@ -291,7 +317,8 @@ The location group associated with this virtual rack. [managedBareMetalInstances]: #managedbaremetalinstances #### [managedBareMetalInstances] The managed bare metal server instances contained within a virtual rack. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -301,7 +328,8 @@ The managed bare metal server instances contained within a virtual rack. [managedHardware]: #managedhardware #### [managedHardware] The managed hardware contained within a virtual rack. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -311,7 +339,8 @@ The managed hardware contained within a virtual rack. [managedVirtualGuests]: #managedvirtualguests #### [managedVirtualGuests] The managed Virtual Server contained within a virtual rack. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -321,7 +350,8 @@ The managed Virtual Server contained within a virtual rack. [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A virtual rack's metric tracking object. This object records all periodic polled data available to this rack. -Type: **SoftLayer_Metric_Tracking_Object_VirtualDedicatedRack ** +Type: **SoftLayer_Metric_Tracking_Object_VirtualDedicatedRack ** + @@ -331,7 +361,8 @@ A virtual rack's metric tracking object. This object records all periodic polled [metricTrackingObjectId]: #metrictrackingobjectid #### [metricTrackingObjectId] The metric tracking object id for this allotment. -Type: **integer** +Type: **integer** + @@ -341,7 +372,8 @@ The metric tracking object id for this allotment. [outboundPublicBandwidthUsage]: #outboundpublicbandwidthusage #### [outboundPublicBandwidthUsage] The total public outbound bandwidth used in this virtual rack for an account's current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -351,7 +383,8 @@ The total public outbound bandwidth used in this virtual rack for an account's c [overBandwidthAllocationFlag]: #overbandwidthallocationflag #### [overBandwidthAllocationFlag] Whether the bandwidth usage for this bandwidth pool for the current billing cycle exceeds the allocation. -Type: **integer** +Type: **integer** + @@ -361,7 +394,8 @@ Whether the bandwidth usage for this bandwidth pool for the current billing cycl [privateNetworkOnlyHardware]: #privatenetworkonlyhardware #### [privateNetworkOnlyHardware] The private network only hardware contained within a virtual rack. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -371,7 +405,8 @@ The private network only hardware contained within a virtual rack. [projectedOverBandwidthAllocationFlag]: #projectedoverbandwidthallocationflag #### [projectedOverBandwidthAllocationFlag] Whether the bandwidth usage for this bandwidth pool for the current billing cycle is projected to exceed the allocation. -Type: **integer** +Type: **integer** + @@ -381,7 +416,8 @@ Whether the bandwidth usage for this bandwidth pool for the current billing cycl [projectedPublicBandwidthUsage]: #projectedpublicbandwidthusage #### [projectedPublicBandwidthUsage] The projected public outbound bandwidth for this virtual server for the current billing cycle. -Type: **float** +Type: **float** + @@ -391,7 +427,8 @@ The projected public outbound bandwidth for this virtual server for the current [serviceProvider]: #serviceprovider #### [serviceProvider] -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -401,7 +438,8 @@ The projected public outbound bandwidth for this virtual server for the current [totalBandwidthAllocated]: #totalbandwidthallocated #### [totalBandwidthAllocated] The combined allocated bandwidth for all servers in a virtual rack. -Type: **unsigned long** +Type: **unsigned long** + @@ -411,7 +449,8 @@ The combined allocated bandwidth for all servers in a virtual rack. [virtualGuests]: #virtualguests #### [virtualGuests] The Virtual Server contained within a virtual rack. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -423,7 +462,8 @@ The Virtual Server contained within a virtual rack. [activeDetailCount]: #activedetailcount #### [activeDetailCount] A count of the bandwidth allotment detail records associated with this virtual rack. -Type: **unsigned long** +Type: **unsigned long** + @@ -433,7 +473,8 @@ A count of the bandwidth allotment detail records associated with this virtual r [applicationDeliveryControllerCount]: #applicationdeliverycontrollercount #### [applicationDeliveryControllerCount] A count of the Application Delivery Controller contained within a virtual rack. -Type: **unsigned long** +Type: **unsigned long** + @@ -443,7 +484,8 @@ A count of the Application Delivery Controller contained within a virtual rack. [bareMetalInstanceCount]: #baremetalinstancecount #### [bareMetalInstanceCount] A count of the bare metal server instances contained within a virtual rack. -Type: **unsigned long** +Type: **unsigned long** + @@ -453,7 +495,8 @@ A count of the bare metal server instances contained within a virtual rack. [billingCycleBandwidthUsageCount]: #billingcyclebandwidthusagecount #### [billingCycleBandwidthUsageCount] A count of a virtual rack's raw bandwidth usage data for an account's current billing cycle. One object is returned for each network this server is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -463,7 +506,8 @@ A count of a virtual rack's raw bandwidth usage data for an account's current bi [detailCount]: #detailcount #### [detailCount] A count of the bandwidth allotment detail records associated with this virtual rack. -Type: **unsigned long** +Type: **unsigned long** + @@ -473,7 +517,8 @@ A count of the bandwidth allotment detail records associated with this virtual r [hardwareCount]: #hardwarecount #### [hardwareCount] A count of the hardware contained within a virtual rack. -Type: **unsigned long** +Type: **unsigned long** + @@ -483,7 +528,8 @@ A count of the hardware contained within a virtual rack. [managedBareMetalInstanceCount]: #managedbaremetalinstancecount #### [managedBareMetalInstanceCount] A count of the managed bare metal server instances contained within a virtual rack. -Type: **unsigned long** +Type: **unsigned long** + @@ -493,7 +539,8 @@ A count of the managed bare metal server instances contained within a virtual ra [managedHardwareCount]: #managedhardwarecount #### [managedHardwareCount] A count of the managed hardware contained within a virtual rack. -Type: **unsigned long** +Type: **unsigned long** + @@ -503,7 +550,8 @@ A count of the managed hardware contained within a virtual rack. [managedVirtualGuestCount]: #managedvirtualguestcount #### [managedVirtualGuestCount] A count of the managed Virtual Server contained within a virtual rack. -Type: **unsigned long** +Type: **unsigned long** + @@ -513,7 +561,8 @@ A count of the managed Virtual Server contained within a virtual rack. [privateNetworkOnlyHardwareCount]: #privatenetworkonlyhardwarecount #### [privateNetworkOnlyHardwareCount] A count of the private network only hardware contained within a virtual rack. -Type: **unsigned long** +Type: **unsigned long** + @@ -523,7 +572,8 @@ A count of the private network only hardware contained within a virtual rack. [virtualGuestCount]: #virtualguestcount #### [virtualGuestCount] A count of the Virtual Server contained within a virtual rack. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Allotment_Detail/_index.md b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Allotment_Detail/_index.md index c7d22f8851..585d53dc37 100644 --- a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Allotment_Detail/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Allotment_Detail/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Bandwidth_Version1_Allotment_Detail data type contains specific information relating to a single bandwidth allotment record. @@ -45,7 +47,8 @@ The SoftLayer_Network_Bandwidth_Version1_Allotment_Detail data type contains spe [allocationId]: #allocationid #### [allocationId] Allocated bandwidth. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Allocated bandwidth. [bandwidthAllotmentId]: #bandwidthallotmentid #### [bandwidthAllotmentId] Bandwidth Pool associated with this detail. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Bandwidth Pool associated with this detail. [effectiveDate]: #effectivedate #### [effectiveDate] Beginning this date the bandwidth allotment is active. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ Beginning this date the bandwidth allotment is active. [endEffectiveDate]: #endeffectivedate #### [endEffectiveDate] From this date the bandwidth allotment is no longer active. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ From this date the bandwidth allotment is no longer active. [id]: #id #### [id] Internal ID associated with this allotment detail. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ Internal ID associated with this allotment detail. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] Service Provider Id for an allotment -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ Service Provider Id for an allotment [allocation]: #allocation #### [allocation] Allocated bandwidth. -Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allocation ** + @@ -121,7 +130,8 @@ Allocated bandwidth. [bandwidthAllotment]: #bandwidthallotment #### [bandwidthAllotment] The parent Bandwidth Pool. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** + @@ -131,7 +141,8 @@ The parent Bandwidth Pool. [bandwidthUsage]: #bandwidthusage #### [bandwidthUsage] Bandwidth used. -Type: **SoftLayer_Network_Bandwidth_Version1_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Version1_Usage[] ** + @@ -143,7 +154,8 @@ Bandwidth used. [bandwidthUsageCount]: #bandwidthusagecount #### [bandwidthUsageCount] A count of bandwidth used. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Allotment_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Allotment_Type/_index.md index 1122b63146..664e429d5c 100644 --- a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Allotment_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Allotment_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Bandwidth_Version1_Allotment_Type contains a description of the associated SoftLayer_Network_Bandwidth_Version1_Allotment object. @@ -45,7 +47,8 @@ The SoftLayer_Network_Bandwidth_Version1_Allotment_Type contains a description o [description]: #description #### [description] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The SoftLayer_Network_Bandwidth_Version1_Allotment_Type contains a description o [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The SoftLayer_Network_Bandwidth_Version1_Allotment_Type contains a description o [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The SoftLayer_Network_Bandwidth_Version1_Allotment_Type contains a description o [shortDescription]: #shortdescription #### [shortDescription] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Host/_index.md b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Host/_index.md index 67ad38a5b9..76ec7a0650 100644 --- a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Host/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Host/_index.md @@ -18,6 +18,9 @@ classes: ## Description + +
      Deprecated
      + [DEPRECATED] The SoftLayer_Network_Bandwidth_Version1_Host type contains general information used to the route a server to its pod. @@ -45,7 +48,8 @@ classes: [podId]: #podid #### [podId] Pod ID for this host device. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Interface/_index.md b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Interface/_index.md index 878a21db98..eb083b87f8 100644 --- a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Interface/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Interface/_index.md @@ -18,6 +18,9 @@ classes: ## Description + +
      Deprecated
      + [DEPRECATED] All bandwidth tracking is maintained through the switch that the bandwidth is used through. All bandwidth is stored in a "pod" repository. An interface links the hardware switch with the pod repository identification number. This is only relevant to bandwidth data. It is not common to use this. @@ -45,7 +48,8 @@ classes: [hostId]: #hostid #### [hostId] A interface's host. The host stores the pod number for the bandwidth data. -Type: **integer** +Type: **integer** + @@ -55,7 +59,8 @@ A interface's host. The host stores the pod number for the bandwidth data. [networkComponentId]: #networkcomponentid #### [networkComponentId] The network component for this interface. -Type: **integer** +Type: **integer** + @@ -71,7 +76,8 @@ The network component for this interface. [host]: #host #### [host] [DEPRECATED] The host for an interface. This is not to be confused with SoftLayer Hardware -Type: **SoftLayer_Network_Bandwidth_Version1_Host ** +Type: **SoftLayer_Network_Bandwidth_Version1_Host ** + @@ -81,7 +87,8 @@ The network component for this interface. [networkComponent]: #networkcomponent #### [networkComponent] [DEPRECATED] The switch for an interface. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Usage/_index.md b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Usage/_index.md index efa4ce15b8..d9399ea136 100644 --- a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Usage/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Usage/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Bandwidth_Version1_Usage data type contains general information relating to a single bandwidth usage record. @@ -51,7 +53,8 @@ The SoftLayer_Network_Bandwidth_Version1_Usage data type contains general inform [bandwidthAllotmentDetail]: #bandwidthallotmentdetail #### [bandwidthAllotmentDetail] Bandwidth allotment detail for this hardware. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** + @@ -61,7 +64,8 @@ Bandwidth allotment detail for this hardware. [bandwidthUsageDetail]: #bandwidthusagedetail #### [bandwidthUsageDetail] Bandwidth usage details for this hardware. -Type: **SoftLayer_Network_Bandwidth_Version1_Usage_Detail[] ** +Type: **SoftLayer_Network_Bandwidth_Version1_Usage_Detail[] ** + @@ -73,7 +77,8 @@ Bandwidth usage details for this hardware. [bandwidthUsageDetailCount]: #bandwidthusagedetailcount #### [bandwidthUsageDetailCount] A count of bandwidth usage details for this hardware. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Usage_Detail/_index.md b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Usage_Detail/_index.md index 0d062492c1..e4c1a9744a 100644 --- a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Usage_Detail/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Usage_Detail/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Bandwidth_Version1_Usage_Detail data type contains specifi [amountIn]: #amountin #### [amountIn] Incoming bandwidth utilization . -Type: **decimal** +Type: **decimal** + @@ -55,7 +58,8 @@ Incoming bandwidth utilization . [amountOut]: #amountout #### [amountOut] Outgoing bandwidth utilization . -Type: **decimal** +Type: **decimal** + @@ -65,7 +69,8 @@ Outgoing bandwidth utilization . [day]: #day #### [day] Day and time this bandwidth utilization event was recorded. -Type: **dateTime** +Type: **dateTime** + @@ -81,7 +86,8 @@ Day and time this bandwidth utilization event was recorded. [bandwidthUsage]: #bandwidthusage #### [bandwidthUsage] In and out bandwidth utilization for a specified time stamp. -Type: **SoftLayer_Network_Bandwidth_Version1_Usage ** +Type: **SoftLayer_Network_Bandwidth_Version1_Usage ** + @@ -91,7 +97,8 @@ In and out bandwidth utilization for a specified time stamp. [bandwidthUsageDetailType]: #bandwidthusagedetailtype #### [bandwidthUsageDetailType] Describes this bandwidth utilization record as on the public or private network interface. -Type: **SoftLayer_Network_Bandwidth_Version1_Usage_Detail_Type ** +Type: **SoftLayer_Network_Bandwidth_Version1_Usage_Detail_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Usage_Detail_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Usage_Detail_Type/_index.md index f9cc623130..bf2c5e2b32 100644 --- a/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Usage_Detail_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Usage_Detail_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Bandwidth_Version1_Usage_Detail_Type data type contains ge [alias]: #alias #### [alias] Database key associated with this bandwidth detail type. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Account/_index.md b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Account/_index.md index d7d5dab43f..f2995fea0d 100644 --- a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Account/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Account/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ The SoftLayer_Network_CdnMarketplace_Account data type models an individual CDN [account]: #account #### [account] SoftLayer account to which the CDN account belongs. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -61,7 +64,8 @@ SoftLayer account to which the CDN account belongs. [billingItem]: #billingitem #### [billingItem] An associated parent billing item which is active. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + diff --git a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/_index.md b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/_index.md index 3f02111888..1d8d4fdbd1 100644 --- a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accessType]: #accesstype #### [accessType] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [regionType]: #regiontype #### [regionType] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [regions]: #regions #### [regions] -Type: **array of strings** +Type: **array of strings** + @@ -75,7 +80,8 @@ classes: [status]: #status #### [status] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking_Type/_index.md index 44ec9188d6..3da83d073f 100644 --- a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accessType]: #accesstype #### [accessType] -Type: **array of strings** +Type: **array of strings** +
      @@ -55,7 +58,8 @@ classes: [continent]: #continent #### [continent] -Type: **array of strings** +Type: **array of strings** +
      @@ -65,7 +69,8 @@ classes: [countryOrRegion]: #countryorregion #### [countryOrRegion] -Type: **array of strings** +Type: **array of strings** + @@ -75,7 +80,8 @@ classes: [regionType]: #regiontype #### [regionType] -Type: **array of strings** +Type: **array of strings** + diff --git a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/_index.md b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/_index.md index 1dbc5cc758..4cabe1a808 100644 --- a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [protectionType]: #protectiontype #### [protectionType] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [refererValues]: #referervalues #### [refererValues] -Type: **string** +Type: **string** +
      diff --git a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/_index.md b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/_index.md index 00bb70f9ed..fd46d83a35 100644 --- a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/_index.md @@ -24,6 +24,8 @@ classes: + +
      diff --git a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/_index.md b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/_index.md index 3584276188..69dd878831 100644 --- a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/_index.md @@ -24,6 +24,8 @@ classes: + +
      diff --git a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/_index.md b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/_index.md index 6bbfdaffb5..06397e27ca 100644 --- a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/_index.md @@ -18,6 +18,8 @@ classes:
      ## Description + + 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. diff --git a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/_index.md b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/_index.md index 46bdb57c21..69ec227618 100644 --- a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/_index.md @@ -18,6 +18,8 @@ classes:
      ## Description + + 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. diff --git a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/_index.md b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/_index.md index c60ccd54e5..a5a979d972 100644 --- a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/_index.md @@ -18,6 +18,8 @@ classes:
      ## Description + + 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". diff --git a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/_index.md b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/_index.md index 9c375a181c..76770b3ded 100644 --- a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/_index.md @@ -18,6 +18,8 @@ classes:
      ## Description + + 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. @@ -45,7 +47,8 @@ This data type models a purge event that occurs repetitively and automatically i [createDate]: #createdate #### [createDate] date record is created -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ date record is created [path]: #path #### [path] Path where purge will be executed after TTL -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Path where purge will be executed after TTL [timeToLive]: #timetolive #### [timeToLive] Time interval after which purge will occur repeatedly -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/_index.md b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/_index.md index 27a95771f6..ac6dbd6bc6 100644 --- a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. diff --git a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/_index.md b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/_index.md index afc8a7a285..4d85f5181c 100644 --- a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/_index.md @@ -24,6 +24,8 @@ classes: + +
      diff --git a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Metrics/_index.md b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Metrics/_index.md index 8c60480555..ec1c0a2c91 100644 --- a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Metrics/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Metrics/_index.md @@ -18,6 +18,8 @@ classes:
      ## Description + + This Metrics class provides methods to get CDN metrics based on account or mapping unique id. diff --git a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Utils_Response/_index.md b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Utils_Response/_index.md index e33db008c9..5b97dd4756 100644 --- a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Utils_Response/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Utils_Response/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [code]: #code #### [code] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [message]: #message #### [message] -Type: **string** +Type: **string** +
      diff --git a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Vendor/_index.md b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Vendor/_index.md index b2d237a86c..a71376095b 100644 --- a/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Vendor/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_CdnMarketplace_Vendor/_index.md @@ -18,6 +18,8 @@ classes:
      ## Description + + The SoftLayer_Network_CdnMarketplace_Vendor contains information regarding
 a CDN Vendor. This class is associated with
 SoftLayer_Network_CdnMarketplace_Vendor_Attribute class.
 diff --git a/content/reference/datatypes/SoftLayer_Network_Component/_index.md b/content/reference/datatypes/SoftLayer_Network_Component/_index.md index ca50e5d9ed..bfcd9cb5d8 100644 --- a/content/reference/datatypes/SoftLayer_Network_Component/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Component/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -71,7 +73,8 @@ Every piece of hardware running in SoftLayer's datacenters connected to the publ [duplexModeId]: #duplexmodeid #### [duplexModeId] A network component's Duplex mode. -Type: **string** +Type: **string** + @@ -81,7 +84,8 @@ A network component's Duplex mode. [hardwareId]: #hardwareid #### [hardwareId] The internal identifier of the hardware that a network component belongs to. -Type: **integer** +Type: **integer** + @@ -91,7 +95,8 @@ The internal identifier of the hardware that a network component belongs to. [id]: #id #### [id] A network component's internal identifier. -Type: **integer** +Type: **integer** + @@ -101,7 +106,8 @@ A network component's internal identifier. [ipmiIpAddress]: #ipmiipaddress #### [ipmiIpAddress] The IP address of an IPMI-based management network component. -Type: **string** +Type: **string** + @@ -111,7 +117,8 @@ The IP address of an IPMI-based management network component. [ipmiMacAddress]: #ipmimacaddress #### [ipmiMacAddress] The MAC address of an IPMI-based management network component. -Type: **string** +Type: **string** + @@ -121,7 +128,8 @@ The MAC address of an IPMI-based management network component. [macAddress]: #macaddress #### [macAddress] A network component's unique MAC address. IPMI-based management network interfaces may not have a MAC address. -Type: **string** +Type: **string** + @@ -131,7 +139,8 @@ A network component's unique MAC address. IPMI-based management network interfac [maxSpeed]: #maxspeed #### [maxSpeed] A network component's maximum allowed speed, measured in Mbit per second. ''maxSpeed'' is determined by the capabilities of the network interface and the port speed purchased on your SoftLayer server. -Type: **integer** +Type: **integer** + @@ -141,7 +150,8 @@ A network component's maximum allowed speed, measured in Mbit per second. ''maxS [modifyDate]: #modifydate #### [modifyDate] The date a network component was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -151,7 +161,8 @@ The date a network component was last modified. [name]: #name #### [name] A network component's short name. For most servers this is the string "eth" for ethernet ports or "mgmt" for remote management ports. Use this in conjunction with the ''port'' property to identify a network component. For instance, the "eth0" interface on a server has the network component name "eth" and port 0. -Type: **string** +Type: **string** + @@ -161,7 +172,8 @@ A network component's short name. For most servers this is the string "eth" for [networkVlanId]: #networkvlanid #### [networkVlanId] The unique internal id of the network VLAN that the port belongs to. -Type: **integer** +Type: **integer** + @@ -171,7 +183,8 @@ The unique internal id of the network VLAN that the port belongs to. [port]: #port #### [port] A network component's port number. Most hardware has more than one network interface. The port property separates these interfaces. Use this in conjunction with the ''name'' property to identify a network component. For instance, the "eth0" interface on a server has the network component name "eth" and port 0. -Type: **integer** +Type: **integer** + @@ -181,7 +194,8 @@ A network component's port number. Most hardware has more than one network inter [primaryIpAddress]: #primaryipaddress #### [primaryIpAddress] A network component's primary IP address. IPMI-based management network interfaces may not have an IP address. -Type: **string** +Type: **string** + @@ -191,7 +205,8 @@ A network component's primary IP address. IPMI-based management network interfac [speed]: #speed #### [speed] A network component's speed, measured in Mbit per second. -Type: **integer** +Type: **integer** + @@ -201,7 +216,8 @@ A network component's speed, measured in Mbit per second. [status]: #status #### [status] A network component's status. This can take one of four possible values: "ACTIVE", "DISABLE", "USER_OFF", or "MACWAIT". "ACTIVE" network components are enabled and in use on a servers. "DISABLE" status components have been administratively disabled by SoftLayer accounting or abuse. "USER_OFF" components have been administratively disabled by you, the user. "MACWAIT" components only exist on network components that have not been provisioned. You should never see a network interface in MACWAIT state. If you happen to see one please contact SoftLayer support. -Type: **string** +Type: **string** + @@ -217,7 +233,8 @@ A network component's status. This can take one of four possible values: "ACTIVE [activeCommand]: #activecommand #### [activeCommand] Reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command currently executing by the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request ** + @@ -227,7 +244,8 @@ Reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and power [downlinkComponent]: #downlinkcomponent #### [downlinkComponent] The network component linking this object to a child device -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -237,7 +255,8 @@ The network component linking this object to a child device [duplexMode]: #duplexmode #### [duplexMode] The duplex mode of a network component. -Type: **SoftLayer_Network_Component_Duplex_Mode ** +Type: **SoftLayer_Network_Component_Duplex_Mode ** + @@ -247,7 +266,8 @@ The duplex mode of a network component. [hardware]: #hardware #### [hardware] The hardware that a network component resides in. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -257,7 +277,8 @@ The hardware that a network component resides in. [highAvailabilityFirewallFlag]: #highavailabilityfirewallflag #### [highAvailabilityFirewallFlag] -Type: **boolean** +Type: **boolean** + @@ -267,7 +288,8 @@ The hardware that a network component resides in. [interface]: #interface #### [interface] [DEPRECATED] A hardware switch's interface to the bandwidth pod. -Type: **SoftLayer_Network_Bandwidth_Version1_Interface ** +Type: **SoftLayer_Network_Bandwidth_Version1_Interface ** + @@ -277,7 +299,8 @@ The hardware that a network component resides in. [ipAddressBindings]: #ipaddressbindings #### [ipAddressBindings] The records of all IP addresses bound to a network component. -Type: **SoftLayer_Network_Component_IpAddress[] ** +Type: **SoftLayer_Network_Component_IpAddress[] ** + @@ -287,7 +310,8 @@ The records of all IP addresses bound to a network component. [ipAddresses]: #ipaddresses #### [ipAddresses] -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -297,7 +321,8 @@ The records of all IP addresses bound to a network component. [lastCommand]: #lastcommand #### [lastCommand] Last reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command issued to the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request ** + @@ -307,7 +332,8 @@ Last reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] The metric tracking object for this network component. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -317,7 +343,8 @@ The metric tracking object for this network component. [networkComponentFirewall]: #networkcomponentfirewall #### [networkComponentFirewall] The upstream network component firewall. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -327,7 +354,8 @@ The upstream network component firewall. [networkComponentGroup]: #networkcomponentgroup #### [networkComponentGroup] A network component's associated group. -Type: **SoftLayer_Network_Component_Group ** +Type: **SoftLayer_Network_Component_Group ** + @@ -337,7 +365,8 @@ A network component's associated group. [networkHardware]: #networkhardware #### [networkHardware] All network devices in SoftLayer's network hierarchy that this device is connected to. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -347,7 +376,8 @@ All network devices in SoftLayer's network hierarchy that this device is connect [networkVlan]: #networkvlan #### [networkVlan] The VLAN that a network component's subnet is associated with. -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + @@ -357,7 +387,8 @@ The VLAN that a network component's subnet is associated with. [networkVlanTrunks]: #networkvlantrunks #### [networkVlanTrunks] The VLANs that are trunked to this network component. -Type: **SoftLayer_Network_Component_Network_Vlan_Trunk[] ** +Type: **SoftLayer_Network_Component_Network_Vlan_Trunk[] ** + @@ -367,7 +398,8 @@ The VLANs that are trunked to this network component. [primaryIpAddressRecord]: #primaryipaddressrecord #### [primaryIpAddressRecord] The primary IPv4 Address record for a network component. -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -377,7 +409,8 @@ The primary IPv4 Address record for a network component. [primarySubnet]: #primarysubnet #### [primarySubnet] The subnet of the primary IP address assigned to this network component. -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + @@ -387,7 +420,8 @@ The subnet of the primary IP address assigned to this network component. [primaryVersion6IpAddressRecord]: #primaryversion6ipaddressrecord #### [primaryVersion6IpAddressRecord] The primary IPv6 Address record for a network component. -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -397,7 +431,8 @@ The primary IPv6 Address record for a network component. [recentCommands]: #recentcommands #### [recentCommands] The last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request[] ** + @@ -407,7 +442,8 @@ The last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powe [redundancyCapableFlag]: #redundancycapableflag #### [redundancyCapableFlag] Indicates whether the network component is participating in a group of two or more components capable of being operationally redundant, if enabled. -Type: **boolean** +Type: **boolean** + @@ -417,7 +453,8 @@ Indicates whether the network component is participating in a group of two or mo [redundancyEnabledFlag]: #redundancyenabledflag #### [redundancyEnabledFlag] Indicates whether the network component is participating in a group of two or more components which is actively providing link redundancy. -Type: **boolean** +Type: **boolean** + @@ -427,7 +464,8 @@ Indicates whether the network component is participating in a group of two or mo [remoteManagementUsers]: #remotemanagementusers #### [remoteManagementUsers] User(s) credentials to issue commands and/or interact with the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** + @@ -437,17 +475,20 @@ User(s) credentials to issue commands and/or interact with the server's remote m [router]: #router #### [router] A network component's routers. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + -
      +
      ----- [storageNetworkFlag]: #storagenetworkflag #### [storageNetworkFlag] Whether a network component's primary ip address is from a storage network subnet or not. [Deprecated] -Type: **boolean** +Type: **boolean** + +Deprecated
      @@ -457,7 +498,8 @@ Whether a network component's primary ip address is from a storage network subne [subnets]: #subnets #### [subnets] A network component's subnets. A subnet is a group of IP addresses -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** +
      @@ -467,7 +509,8 @@ A network component's subnets. A subnet is a group of IP addresses [uplinkComponent]: #uplinkcomponent #### [uplinkComponent] The network component linking this object to parent -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -477,7 +520,8 @@ The network component linking this object to parent [uplinkDuplexMode]: #uplinkduplexmode #### [uplinkDuplexMode] The duplex mode of the uplink network component linking to this object -Type: **SoftLayer_Network_Component_Duplex_Mode ** +Type: **SoftLayer_Network_Component_Duplex_Mode ** + @@ -489,7 +533,8 @@ The duplex mode of the uplink network component linking to this object [ipAddressBindingCount]: #ipaddressbindingcount #### [ipAddressBindingCount] A count of the records of all IP addresses bound to a network component. -Type: **unsigned long** +Type: **unsigned long** + @@ -499,7 +544,8 @@ A count of the records of all IP addresses bound to a network component. [ipAddressCount]: #ipaddresscount #### [ipAddressCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -509,7 +555,8 @@ A count of [networkHardwareCount]: #networkhardwarecount #### [networkHardwareCount] A count of all network devices in SoftLayer's network hierarchy that this device is connected to. -Type: **unsigned long** +Type: **unsigned long** + @@ -519,7 +566,8 @@ A count of all network devices in SoftLayer's network hierarchy that this device [networkVlanTrunkCount]: #networkvlantrunkcount #### [networkVlanTrunkCount] A count of the VLANs that are trunked to this network component. -Type: **unsigned long** +Type: **unsigned long** + @@ -529,7 +577,8 @@ A count of the VLANs that are trunked to this network component. [recentCommandCount]: #recentcommandcount #### [recentCommandCount] A count of the last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -539,7 +588,8 @@ A count of the last five reboot/power (rebootDefault, rebootSoft, rebootHard, po [remoteManagementUserCount]: #remotemanagementusercount #### [remoteManagementUserCount] A count of user(s) credentials to issue commands and/or interact with the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -549,7 +599,8 @@ A count of user(s) credentials to issue commands and/or interact with the server [subnetCount]: #subnetcount #### [subnetCount] A count of a network component's subnets. A subnet is a group of IP addresses -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Component_Duplex_Mode/_index.md b/content/reference/datatypes/SoftLayer_Network_Component_Duplex_Mode/_index.md index 563ff44d41..319def4d3a 100644 --- a/content/reference/datatypes/SoftLayer_Network_Component_Duplex_Mode/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Component_Duplex_Mode/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Duplex Mode allows finer grained control over networking options and settings. @@ -45,7 +47,8 @@ Duplex Mode allows finer grained control over networking options and settings. [description]: #description #### [description] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Duplex Mode allows finer grained control over networking options and settings. [keyname]: #keyname #### [keyname] -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Duplex Mode allows finer grained control over networking options and settings. [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Component_Firewall/_index.md b/content/reference/datatypes/SoftLayer_Network_Component_Firewall/_index.md index fa282b159a..3afe189e73 100644 --- a/content/reference/datatypes/SoftLayer_Network_Component_Firewall/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Component_Firewall/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -59,7 +61,8 @@ The SoftLayer_Network_Component_Firewall data type contains general information [guestNetworkComponentId]: #guestnetworkcomponentid #### [guestNetworkComponentId] Unique ID for the network component of the switch interface that this network component firewall is attached to. -Type: **integer** +Type: **integer** + @@ -69,7 +72,8 @@ Unique ID for the network component of the switch interface that this network co [id]: #id #### [id] Unique ID for the network component firewall. -Type: **integer** +Type: **integer** + @@ -79,7 +83,8 @@ Unique ID for the network component firewall. [networkComponentId]: #networkcomponentid #### [networkComponentId] Unique ID for the network component of the switch interface that this network component firewall is attached to. -Type: **integer** +Type: **integer** + @@ -89,7 +94,8 @@ Unique ID for the network component of the switch interface that this network co [status]: #status #### [status] Current status of the network component firewall. -Type: **string** +Type: **string** + @@ -105,7 +111,8 @@ Current status of the network component firewall. [applyServerRuleSubnets]: #applyserverrulesubnets #### [applyServerRuleSubnets] The additional subnets linked to this network component firewall, that inherit rules from the host that the context slot is attached to. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -115,7 +122,8 @@ The additional subnets linked to this network component firewall, that inherit r [billingItem]: #billingitem #### [billingItem] The billing item for a Hardware Firewall (Dedicated). -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -125,7 +133,8 @@ The billing item for a Hardware Firewall (Dedicated). [guestNetworkComponent]: #guestnetworkcomponent #### [guestNetworkComponent] The network component of the guest virtual server that this network component firewall belongs to. -Type: **SoftLayer_Virtual_Guest_Network_Component ** +Type: **SoftLayer_Virtual_Guest_Network_Component ** + @@ -135,7 +144,8 @@ The network component of the guest virtual server that this network component fi [networkComponent]: #networkcomponent #### [networkComponent] The network component of the switch interface that this network component firewall belongs to. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -145,7 +155,8 @@ The network component of the switch interface that this network component firewa [networkFirewallUpdateRequest]: #networkfirewallupdaterequest #### [networkFirewallUpdateRequest] The update requests made for this firewall. -Type: **SoftLayer_Network_Firewall_Update_Request[] ** +Type: **SoftLayer_Network_Firewall_Update_Request[] ** + @@ -155,7 +166,8 @@ The update requests made for this firewall. [rules]: #rules #### [rules] The currently running rule set of this network component firewall. -Type: **SoftLayer_Network_Component_Firewall_Rule[] ** +Type: **SoftLayer_Network_Component_Firewall_Rule[] ** + @@ -165,7 +177,8 @@ The currently running rule set of this network component firewall. [subnets]: #subnets #### [subnets] The additional subnets linked to this network component firewall. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -177,7 +190,8 @@ The additional subnets linked to this network component firewall. [applyServerRuleSubnetCount]: #applyserverrulesubnetcount #### [applyServerRuleSubnetCount] A count of the additional subnets linked to this network component firewall, that inherit rules from the host that the context slot is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -187,7 +201,8 @@ A count of the additional subnets linked to this network component firewall, tha [networkFirewallUpdateRequestCount]: #networkfirewallupdaterequestcount #### [networkFirewallUpdateRequestCount] A count of the update requests made for this firewall. -Type: **unsigned long** +Type: **unsigned long** + @@ -197,7 +212,8 @@ A count of the update requests made for this firewall. [ruleCount]: #rulecount #### [ruleCount] A count of the currently running rule set of this network component firewall. -Type: **unsigned long** +Type: **unsigned long** + @@ -207,7 +223,8 @@ A count of the currently running rule set of this network component firewall. [subnetCount]: #subnetcount #### [subnetCount] A count of the additional subnets linked to this network component firewall. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Component_Firewall_Rule/_index.md b/content/reference/datatypes/SoftLayer_Network_Component_Firewall_Rule/_index.md index ec37203425..84b6c12546 100644 --- a/content/reference/datatypes/SoftLayer_Network_Component_Firewall_Rule/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Component_Firewall_Rule/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -51,7 +53,8 @@ A SoftLayer_Network_Component_Firewall_Rule object type represents a currently r [action]: #action #### [action] The action that the rule is to take [permit or deny]. -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ The action that the rule is to take [permit or deny]. [destinationIpAddress]: #destinationipaddress #### [destinationIpAddress] The destination IP address considered for determining rule application. -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ The destination IP address considered for determining rule application. [destinationIpCidr]: #destinationipcidr #### [destinationIpCidr] The CIDR is used for determining rule application. This value will -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ The CIDR is used for determining rule application. This value will [destinationIpSubnetMask]: #destinationipsubnetmask #### [destinationIpSubnetMask] The destination IP subnet mask considered for determining rule application. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The destination IP subnet mask considered for determining rule application. [destinationPortRangeEnd]: #destinationportrangeend #### [destinationPortRangeEnd] The ending (upper end of range) destination port considered for determining rule application. -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ The ending (upper end of range) destination port considered for determining rule [destinationPortRangeStart]: #destinationportrangestart #### [destinationPortRangeStart] The starting (lower end of range) destination port considered for determining rule application. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The starting (lower end of range) destination port considered for determining ru [id]: #id #### [id] The rule's internal identifier. -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ The rule's internal identifier. [notes]: #notes #### [notes] The notes field for the rule. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The notes field for the rule. [orderValue]: #ordervalue #### [orderValue] The numeric value describing the order in which the rule should be applied. -Type: **integer** +Type: **integer** + @@ -141,7 +152,8 @@ The numeric value describing the order in which the rule should be applied. [protocol]: #protocol #### [protocol] The protocol considered for determining rule application. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ The protocol considered for determining rule application. [sourceIpAddress]: #sourceipaddress #### [sourceIpAddress] The source IP address considered for determining rule application. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ The source IP address considered for determining rule application. [sourceIpCidr]: #sourceipcidr #### [sourceIpCidr] The CIDR is used for determining rule application. This value will -Type: **integer** +Type: **integer** + @@ -171,7 +185,8 @@ The CIDR is used for determining rule application. This value will [sourceIpSubnetMask]: #sourceipsubnetmask #### [sourceIpSubnetMask] The source IP subnet mask considered for determining rule application. -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ The source IP subnet mask considered for determining rule application. [status]: #status #### [status] Current status of the network component firewall. -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ Current status of the network component firewall. [version]: #version #### [version] Whether this rule is an IPv4 rule or an IPv6 rule. If -Type: **integer** +Type: **integer** + @@ -207,7 +224,8 @@ Whether this rule is an IPv4 rule or an IPv6 rule. If [networkComponentFirewall]: #networkcomponentfirewall #### [networkComponentFirewall] The network component firewall that this rule belongs to. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Component_Firewall_Subnets/_index.md b/content/reference/datatypes/SoftLayer_Network_Component_Firewall_Subnets/_index.md index 9b60f90fa1..d61c85fd80 100644 --- a/content/reference/datatypes/SoftLayer_Network_Component_Firewall_Subnets/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Component_Firewall_Subnets/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -51,7 +53,8 @@ A SoftLayer_Network_Component_Firewall_Subnets object type represents the curren [applyServerRulesFlag]: #applyserverrulesflag #### [applyServerRulesFlag] A boolean flag that indicates whether the subnet should receive all the rules intended for the host on this context slot. -Type: **boolean** +Type: **boolean** + @@ -61,7 +64,8 @@ A boolean flag that indicates whether the subnet should receive all the rules in [subnetId]: #subnetid #### [subnetId] The unique identifier of the subnet being linked to the network component firewall. -Type: **integer** +Type: **integer** + @@ -77,7 +81,8 @@ The unique identifier of the subnet being linked to the network component firewa [networkComponentFirewall]: #networkcomponentfirewall #### [networkComponentFirewall] The network component firewall that write rules for this subnet. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -87,7 +92,8 @@ The network component firewall that write rules for this subnet. [subnet]: #subnet #### [subnet] The subnet that this link binds to the network component firewall. -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Component_Group/_index.md b/content/reference/datatypes/SoftLayer_Network_Component_Group/_index.md index 38f9f20733..47f47b9d92 100644 --- a/content/reference/datatypes/SoftLayer_Network_Component_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Component_Group/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [groupTypeId]: #grouptypeid #### [groupTypeId] -Type: **integer** +Type: **integer** +
      @@ -61,7 +64,8 @@ classes: [membersDescription]: #membersdescription #### [membersDescription] A succinct label describing the members of this grouping. -Type: **string** +Type: **string** +
      @@ -71,7 +75,8 @@ A succinct label describing the members of this grouping. [networkComponents]: #networkcomponents #### [networkComponents] A network component group's associated network components. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -83,7 +88,8 @@ A network component group's associated network components. [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of a network component group's associated network components. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Component_IpAddress/_index.md b/content/reference/datatypes/SoftLayer_Network_Component_IpAddress/_index.md index bb9161ec53..d9507a3897 100644 --- a/content/reference/datatypes/SoftLayer_Network_Component_IpAddress/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Component_IpAddress/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -57,7 +59,8 @@ The SoftLayer_Network_Component_IpAddress data type contains general information [ipAddress]: #ipaddress #### [ipAddress] The IP address associated with this object's network component. -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -67,7 +70,8 @@ The IP address associated with this object's network component. [networkComponent]: #networkcomponent #### [networkComponent] The network component associated with this object's IP address. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Component_Network_Vlan_Trunk/_index.md b/content/reference/datatypes/SoftLayer_Network_Component_Network_Vlan_Trunk/_index.md index eeae755994..efdb914e53 100644 --- a/content/reference/datatypes/SoftLayer_Network_Component_Network_Vlan_Trunk/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Component_Network_Vlan_Trunk/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -51,7 +53,8 @@ Represents the association between a Network_Component and Network_Vlan in the m [networkComponentId]: #networkcomponentid #### [networkComponentId] The network component's identifier. -Type: **integer** +Type: **integer** + @@ -61,7 +64,8 @@ The network component's identifier. [networkVlanId]: #networkvlanid #### [networkVlanId] The identifier of the network VLAN that is a trunk on the network component. -Type: **integer** +Type: **integer** + @@ -77,7 +81,8 @@ The identifier of the network VLAN that is a trunk on the network component. [networkComponent]: #networkcomponent #### [networkComponent] The network component that the VLAN is being trunked to. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -87,7 +92,8 @@ The network component that the VLAN is being trunked to. [networkVlan]: #networkvlan #### [networkVlan] The VLAN that is being trunked to the network component. -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Component_RemoteManagement/_index.md b/content/reference/datatypes/SoftLayer_Network_Component_RemoteManagement/_index.md index 06b876e22e..2b4d80eaae 100644 --- a/content/reference/datatypes/SoftLayer_Network_Component_RemoteManagement/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Component_RemoteManagement/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Component_RemoteManagement data type contains general information relating to a single SoftLayer remote management network component. @@ -45,7 +47,8 @@ The SoftLayer_Network_Component_RemoteManagement data type contains general info [duplexModeId]: #duplexmodeid #### [duplexModeId] A network component's Duplex mode. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ A network component's Duplex mode. [hardwareId]: #hardwareid #### [hardwareId] The internal identifier of the hardware that a network component belongs to. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The internal identifier of the hardware that a network component belongs to. [id]: #id #### [id] A network component's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A network component's internal identifier. [ipmiIpAddress]: #ipmiipaddress #### [ipmiIpAddress] The IP address of an IPMI-based management network component. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The IP address of an IPMI-based management network component. [ipmiMacAddress]: #ipmimacaddress #### [ipmiMacAddress] The MAC address of an IPMI-based management network component. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The MAC address of an IPMI-based management network component. [macAddress]: #macaddress #### [macAddress] A network component's unique MAC address. IPMI-based management network interfaces may not have a MAC address. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ A network component's unique MAC address. IPMI-based management network interfac [maxSpeed]: #maxspeed #### [maxSpeed] A network component's maximum allowed speed, measured in Mbit per second. ''maxSpeed'' is determined by the capabilities of the network interface and the port speed purchased on your SoftLayer server. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A network component's maximum allowed speed, measured in Mbit per second. ''maxS [modifyDate]: #modifydate #### [modifyDate] The date a network component was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -125,7 +135,8 @@ The date a network component was last modified. [name]: #name #### [name] A network component's short name. For most servers this is the string "eth" for ethernet ports or "mgmt" for remote management ports. Use this in conjunction with the ''port'' property to identify a network component. For instance, the "eth0" interface on a server has the network component name "eth" and port 0. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ A network component's short name. For most servers this is the string "eth" for [networkVlanId]: #networkvlanid #### [networkVlanId] The unique internal id of the network VLAN that the port belongs to. -Type: **integer** +Type: **integer** + @@ -145,7 +157,8 @@ The unique internal id of the network VLAN that the port belongs to. [port]: #port #### [port] A network component's port number. Most hardware has more than one network interface. The port property separates these interfaces. Use this in conjunction with the ''name'' property to identify a network component. For instance, the "eth0" interface on a server has the network component name "eth" and port 0. -Type: **integer** +Type: **integer** + @@ -155,7 +168,8 @@ A network component's port number. Most hardware has more than one network inter [primaryIpAddress]: #primaryipaddress #### [primaryIpAddress] A network component's primary IP address. IPMI-based management network interfaces may not have an IP address. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ A network component's primary IP address. IPMI-based management network interfac [speed]: #speed #### [speed] A network component's speed, measured in Mbit per second. -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ A network component's speed, measured in Mbit per second. [status]: #status #### [status] A network component's status. This can take one of four possible values: "ACTIVE", "DISABLE", "USER_OFF", or "MACWAIT". "ACTIVE" network components are enabled and in use on a servers. "DISABLE" status components have been administratively disabled by SoftLayer accounting or abuse. "USER_OFF" components have been administratively disabled by you, the user. "MACWAIT" components only exist on network components that have not been provisioned. You should never see a network interface in MACWAIT state. If you happen to see one please contact SoftLayer support. -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ A network component's status. This can take one of four possible values: "ACTIVE [activeCommand]: #activecommand #### [activeCommand] Reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command currently executing by the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request ** + @@ -201,7 +218,8 @@ Reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and power [downlinkComponent]: #downlinkcomponent #### [downlinkComponent] The network component linking this object to a child device -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -211,7 +229,8 @@ The network component linking this object to a child device [duplexMode]: #duplexmode #### [duplexMode] The duplex mode of a network component. -Type: **SoftLayer_Network_Component_Duplex_Mode ** +Type: **SoftLayer_Network_Component_Duplex_Mode ** + @@ -221,7 +240,8 @@ The duplex mode of a network component. [hardware]: #hardware #### [hardware] The hardware that a network component resides in. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -231,7 +251,8 @@ The hardware that a network component resides in. [highAvailabilityFirewallFlag]: #highavailabilityfirewallflag #### [highAvailabilityFirewallFlag] -Type: **boolean** +Type: **boolean** + @@ -241,7 +262,8 @@ The hardware that a network component resides in. [interface]: #interface #### [interface] [DEPRECATED] A hardware switch's interface to the bandwidth pod. -Type: **SoftLayer_Network_Bandwidth_Version1_Interface ** +Type: **SoftLayer_Network_Bandwidth_Version1_Interface ** + @@ -251,7 +273,8 @@ The hardware that a network component resides in. [ipAddressBindings]: #ipaddressbindings #### [ipAddressBindings] The records of all IP addresses bound to a network component. -Type: **SoftLayer_Network_Component_IpAddress[] ** +Type: **SoftLayer_Network_Component_IpAddress[] ** + @@ -261,7 +284,8 @@ The records of all IP addresses bound to a network component. [ipAddresses]: #ipaddresses #### [ipAddresses] -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -271,7 +295,8 @@ The records of all IP addresses bound to a network component. [lastCommand]: #lastcommand #### [lastCommand] Last reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command issued to the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request ** + @@ -281,7 +306,8 @@ Last reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] The metric tracking object for this network component. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -291,7 +317,8 @@ The metric tracking object for this network component. [networkComponentFirewall]: #networkcomponentfirewall #### [networkComponentFirewall] The upstream network component firewall. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -301,7 +328,8 @@ The upstream network component firewall. [networkComponentGroup]: #networkcomponentgroup #### [networkComponentGroup] A network component's associated group. -Type: **SoftLayer_Network_Component_Group ** +Type: **SoftLayer_Network_Component_Group ** + @@ -311,7 +339,8 @@ A network component's associated group. [networkHardware]: #networkhardware #### [networkHardware] All network devices in SoftLayer's network hierarchy that this device is connected to. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -321,7 +350,8 @@ All network devices in SoftLayer's network hierarchy that this device is connect [networkVlan]: #networkvlan #### [networkVlan] The VLAN that a network component's subnet is associated with. -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + @@ -331,7 +361,8 @@ The VLAN that a network component's subnet is associated with. [networkVlanTrunks]: #networkvlantrunks #### [networkVlanTrunks] The VLANs that are trunked to this network component. -Type: **SoftLayer_Network_Component_Network_Vlan_Trunk[] ** +Type: **SoftLayer_Network_Component_Network_Vlan_Trunk[] ** + @@ -341,7 +372,8 @@ The VLANs that are trunked to this network component. [primaryIpAddressRecord]: #primaryipaddressrecord #### [primaryIpAddressRecord] The primary IPv4 Address record for a network component. -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -351,7 +383,8 @@ The primary IPv4 Address record for a network component. [primarySubnet]: #primarysubnet #### [primarySubnet] A remote management component's subnet for the primary IP address of the card. -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + @@ -361,7 +394,8 @@ A remote management component's subnet for the primary IP address of the card. [primaryVersion6IpAddressRecord]: #primaryversion6ipaddressrecord #### [primaryVersion6IpAddressRecord] The primary IPv6 Address record for a network component. -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -371,7 +405,8 @@ The primary IPv6 Address record for a network component. [recentCommands]: #recentcommands #### [recentCommands] The last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_Command_Request[] ** + @@ -381,7 +416,8 @@ The last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powe [redundancyCapableFlag]: #redundancycapableflag #### [redundancyCapableFlag] Indicates whether the network component is participating in a group of two or more components capable of being operationally redundant, if enabled. -Type: **boolean** +Type: **boolean** + @@ -391,7 +427,8 @@ Indicates whether the network component is participating in a group of two or mo [redundancyEnabledFlag]: #redundancyenabledflag #### [redundancyEnabledFlag] Indicates whether the network component is participating in a group of two or more components which is actively providing link redundancy. -Type: **boolean** +Type: **boolean** + @@ -401,7 +438,8 @@ Indicates whether the network component is participating in a group of two or mo [remoteManagementUsers]: #remotemanagementusers #### [remoteManagementUsers] User(s) credentials to issue commands and/or interact with the server's remote management card. -Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** +Type: **SoftLayer_Hardware_Component_RemoteManagement_User[] ** + @@ -411,17 +449,20 @@ User(s) credentials to issue commands and/or interact with the server's remote m [router]: #router #### [router] A network component's routers. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + -
      +
      ----- [storageNetworkFlag]: #storagenetworkflag #### [storageNetworkFlag] Whether a network component's primary ip address is from a storage network subnet or not. [Deprecated] -Type: **boolean** +Type: **boolean** + +Deprecated
      @@ -431,7 +472,8 @@ Whether a network component's primary ip address is from a storage network subne [subnets]: #subnets #### [subnets] A network component's subnets. A subnet is a group of IP addresses -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** +
      @@ -441,7 +483,8 @@ A network component's subnets. A subnet is a group of IP addresses [uplinkComponent]: #uplinkcomponent #### [uplinkComponent] The network component linking this object to parent -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -451,7 +494,8 @@ The network component linking this object to parent [uplinkDuplexMode]: #uplinkduplexmode #### [uplinkDuplexMode] The duplex mode of the uplink network component linking to this object -Type: **SoftLayer_Network_Component_Duplex_Mode ** +Type: **SoftLayer_Network_Component_Duplex_Mode ** + @@ -463,7 +507,8 @@ The duplex mode of the uplink network component linking to this object [ipAddressBindingCount]: #ipaddressbindingcount #### [ipAddressBindingCount] A count of the records of all IP addresses bound to a network component. -Type: **unsigned long** +Type: **unsigned long** + @@ -473,7 +518,8 @@ A count of the records of all IP addresses bound to a network component. [ipAddressCount]: #ipaddresscount #### [ipAddressCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -483,7 +529,8 @@ A count of [networkHardwareCount]: #networkhardwarecount #### [networkHardwareCount] A count of all network devices in SoftLayer's network hierarchy that this device is connected to. -Type: **unsigned long** +Type: **unsigned long** + @@ -493,7 +540,8 @@ A count of all network devices in SoftLayer's network hierarchy that this device [networkVlanTrunkCount]: #networkvlantrunkcount #### [networkVlanTrunkCount] A count of the VLANs that are trunked to this network component. -Type: **unsigned long** +Type: **unsigned long** + @@ -503,7 +551,8 @@ A count of the VLANs that are trunked to this network component. [recentCommandCount]: #recentcommandcount #### [recentCommandCount] A count of the last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -513,7 +562,8 @@ A count of the last five reboot/power (rebootDefault, rebootSoft, rebootHard, po [remoteManagementUserCount]: #remotemanagementusercount #### [remoteManagementUserCount] A count of user(s) credentials to issue commands and/or interact with the server's remote management card. -Type: **unsigned long** +Type: **unsigned long** + @@ -523,7 +573,8 @@ A count of user(s) credentials to issue commands and/or interact with the server [subnetCount]: #subnetcount #### [subnetCount] A count of a network component's subnets. A subnet is a group of IP addresses -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Component_Uplink_Hardware/_index.md b/content/reference/datatypes/SoftLayer_Network_Component_Uplink_Hardware/_index.md index 34950a784c..8d215cf01c 100644 --- a/content/reference/datatypes/SoftLayer_Network_Component_Uplink_Hardware/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Component_Uplink_Hardware/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -63,7 +65,8 @@ It is populated via triggers on the network_connection table (SoftLayer_Network_ [hardware]: #hardware #### [hardware] A network component uplink's connected [SoftLayer_Hardware]({{}}). -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -73,7 +76,8 @@ A network component uplink's connected [SoftLayer_Hardware]({{}}) that a uplink connection belongs to.. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Customer_Subnet/_index.md b/content/reference/datatypes/SoftLayer_Network_Customer_Subnet/_index.md index 51e3c71bf1..e6dab26b91 100644 --- a/content/reference/datatypes/SoftLayer_Network_Customer_Subnet/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Customer_Subnet/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Customer_Subnet data type contains general information relating to a single customer subnet (remote). @@ -45,7 +47,8 @@ The SoftLayer_Network_Customer_Subnet data type contains general information rel [accountId]: #accountid #### [accountId] The account id a customer subnet belongs to. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The account id a customer subnet belongs to. [cidr]: #cidr #### [cidr] A subnet's Classless Inter-Domain Routing prefix. This is a number between 0 and 32 signifying the number of bits in a subnet's netmask. These bits separate a subnet's network address from it's host addresses. It performs the same function as the ''netmask'' property, but is represented as an integer. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A subnet's Classless Inter-Domain Routing prefix. This is a number between 0 and [id]: #id #### [id] A customer subnet's unique identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A customer subnet's unique identifier. [netmask]: #netmask #### [netmask] A bitmask in dotted-quad format that is used to separate a subnet's network address from it's host addresses. This performs the same function as the ''cidr'' property, but is expressed in a string format. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ A bitmask in dotted-quad format that is used to separate a subnet's network addr [networkIdentifier]: #networkidentifier #### [networkIdentifier] A subnet's network identifier. This is the first IP address of a subnet. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ A subnet's network identifier. This is the first IP address of a subnet. [totalIpAddresses]: #totalipaddresses #### [totalIpAddresses] The total number of ip addresses in a subnet. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The total number of ip addresses in a subnet. [ipAddresses]: #ipaddresses #### [ipAddresses] All ip addresses associated with a subnet. -Type: **SoftLayer_Network_Customer_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Customer_Subnet_IpAddress[] ** + @@ -123,7 +132,8 @@ All ip addresses associated with a subnet. [ipAddressCount]: #ipaddresscount #### [ipAddressCount] A count of all ip addresses associated with a subnet. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Customer_Subnet_IpAddress/_index.md b/content/reference/datatypes/SoftLayer_Network_Customer_Subnet_IpAddress/_index.md index deb3ce7f8e..f359ca856c 100644 --- a/content/reference/datatypes/SoftLayer_Network_Customer_Subnet_IpAddress/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Customer_Subnet_IpAddress/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Customer_Subnet_IpAddress data type contains general information relating to a single Customer Subnet (Remote) IPv4 address. @@ -45,7 +47,8 @@ The SoftLayer_Network_Customer_Subnet_IpAddress data type contains general infor [id]: #id #### [id] Unique identifier for an ip address. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Unique identifier for an ip address. [ipAddress]: #ipaddress #### [ipAddress] An IP address expressed in dotted quad format. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ An IP address expressed in dotted quad format. [notes]: #notes #### [notes] An IP address' user defined note. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ An IP address' user defined note. [subnetId]: #subnetid #### [subnetId] The unique identifier for the customer subnet (remote) the ip address belongs to. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The unique identifier for the customer subnet (remote) the ip address belongs to [subnet]: #subnet #### [subnet] The customer subnet (remote) that the ip address belongs to. -Type: **SoftLayer_Network_Customer_Subnet ** +Type: **SoftLayer_Network_Customer_Subnet ** + @@ -101,7 +108,8 @@ The customer subnet (remote) that the ip address belongs to. [translations]: #translations #### [translations] All the address translations that are tied to an IP address. -Type: **SoftLayer_Network_Tunnel_Module_Context_Address_Translation[] ** +Type: **SoftLayer_Network_Tunnel_Module_Context_Address_Translation[] ** + @@ -113,7 +121,8 @@ All the address translations that are tied to an IP address. [translationCount]: #translationcount #### [translationCount] A count of all the address translations that are tied to an IP address. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_DirectLink_Location/_index.md b/content/reference/datatypes/SoftLayer_Network_DirectLink_Location/_index.md index d858c54643..9f0a991fa2 100644 --- a/content/reference/datatypes/SoftLayer_Network_DirectLink_Location/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_DirectLink_Location/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_DirectLink_Location presents a structure containing attributes of a Direct Link location, and its related object SoftLayer location. @@ -45,7 +47,8 @@ The SoftLayer_Network_DirectLink_Location presents a structure containing attrib [buildingColocationOwner]: #buildingcolocationowner #### [buildingColocationOwner] The Direct Link specific location owner for POP/DC facilities. Like Equinix, Pacnet, Verizon etc. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The Direct Link specific location owner for POP/DC facilities. Like Equinix, Pac [id]: #id #### [id] The unique identifier of a Direct Link location. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The unique identifier of a Direct Link location. [isRedundantXcr]: #isredundantxcr #### [isRedundantXcr] Specifies if The Direct Link specific location has Redundancy:secondary XCR availability. -Type: **boolean** +Type: **boolean** + @@ -75,7 +80,8 @@ Specifies if The Direct Link specific location has Redundancy:secondary XCR avai [locationId]: #locationid #### [locationId] The Direct Link specific location ie. Data Center & Network POP facility. Refer to location object Like Dallas in US, London in England etc. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The Direct Link specific location ie. Data Center & Network POP facility. Refer [marketGeography]: #marketgeography #### [marketGeography] The Direct Link Market location used in Direct Link Order. Like Europe, North America, Asia pacific etc. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The Direct Link Market location used in Direct Link Order. Like Europe, North Am [location]: #location #### [location] The location of Direct Link facility. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -111,7 +119,8 @@ The location of Direct Link facility. [provider]: #provider #### [provider] The Id of Direct Link provider. -Type: **SoftLayer_Network_DirectLink_Provider ** +Type: **SoftLayer_Network_DirectLink_Provider ** + @@ -121,7 +130,8 @@ The Id of Direct Link provider. [serviceType]: #servicetype #### [serviceType] The Id of Direct Link service type. -Type: **SoftLayer_Network_DirectLink_ServiceType ** +Type: **SoftLayer_Network_DirectLink_ServiceType ** + diff --git a/content/reference/datatypes/SoftLayer_Network_DirectLink_Provider/_index.md b/content/reference/datatypes/SoftLayer_Network_DirectLink_Provider/_index.md index 0282a815f1..66077a4b1d 100644 --- a/content/reference/datatypes/SoftLayer_Network_DirectLink_Provider/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_DirectLink_Provider/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_DirectLink_Provider presents a structure containing attributes of a Direct Link provider. @@ -45,7 +47,8 @@ The SoftLayer_Network_DirectLink_Provider presents a structure containing attrib [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The SoftLayer_Network_DirectLink_Provider presents a structure containing attrib [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_DirectLink_ServiceType/_index.md b/content/reference/datatypes/SoftLayer_Network_DirectLink_ServiceType/_index.md index 11684b28ec..f53815ef19 100644 --- a/content/reference/datatypes/SoftLayer_Network_DirectLink_ServiceType/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_DirectLink_ServiceType/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_DirectLink_ServiceType presents a structure containing attributes of a Direct Link Service Type. @@ -45,7 +47,8 @@ The SoftLayer_Network_DirectLink_ServiceType presents a structure containing att [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The SoftLayer_Network_DirectLink_ServiceType presents a structure containing att [type]: #type #### [type] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_FbDbChangeRequestHistory/_index.md b/content/reference/datatypes/SoftLayer_Network_FbDbChangeRequestHistory/_index.md new file mode 100644 index 0000000000..cd06c7bd37 --- /dev/null +++ b/content/reference/datatypes/SoftLayer_Network_FbDbChangeRequestHistory/_index.md @@ -0,0 +1,49 @@ +--- +title: "SoftLayer_Network_FbDbChangeRequestHistory" +description: "" +layout: "datatype" +tags: + - "datatype" + - "sldn" + - "Network" +classes: + - "SoftLayer_Network_FbDbChangeRequestHistory" +--- + +# SoftLayer_Network_FbDbChangeRequestHistory +
      + +
      + +## Description + + + + + + + + + +
      +
      +
      + +
      +
      +
      + + +
      +
      + +## Local +
      + + +
      + + diff --git a/content/reference/datatypes/SoftLayer_Network_Firewall_AccessControlList/_index.md b/content/reference/datatypes/SoftLayer_Network_Firewall_AccessControlList/_index.md index 63bb3aae32..6d02950b7c 100644 --- a/content/reference/datatypes/SoftLayer_Network_Firewall_AccessControlList/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Firewall_AccessControlList/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -59,7 +61,8 @@ The SoftLayer_Network_Firewall_AccessControlList data type contains general info [direction]: #direction #### [direction] -Type: **string** +Type: **string** + @@ -69,7 +72,8 @@ The SoftLayer_Network_Firewall_AccessControlList data type contains general info [firewallContextInterfaceId]: #firewallcontextinterfaceid #### [firewallContextInterfaceId] -Type: **integer** +Type: **integer** + @@ -79,7 +83,8 @@ The SoftLayer_Network_Firewall_AccessControlList data type contains general info [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -95,7 +100,8 @@ The SoftLayer_Network_Firewall_AccessControlList data type contains general info [networkFirewallUpdateRequests]: #networkfirewallupdaterequests #### [networkFirewallUpdateRequests] The update requests made for this firewall. -Type: **SoftLayer_Network_Firewall_Update_Request[] ** +Type: **SoftLayer_Network_Firewall_Update_Request[] ** + @@ -105,7 +111,8 @@ The update requests made for this firewall. [networkVlan]: #networkvlan #### [networkVlan] -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + @@ -115,7 +122,8 @@ The update requests made for this firewall. [rules]: #rules #### [rules] The currently running rule set of this context access control list firewall. -Type: **SoftLayer_Network_Vlan_Firewall_Rule[] ** +Type: **SoftLayer_Network_Vlan_Firewall_Rule[] ** + @@ -127,7 +135,8 @@ The currently running rule set of this context access control list firewall. [networkFirewallUpdateRequestCount]: #networkfirewallupdaterequestcount #### [networkFirewallUpdateRequestCount] A count of the update requests made for this firewall. -Type: **unsigned long** +Type: **unsigned long** + @@ -137,7 +146,8 @@ A count of the update requests made for this firewall. [ruleCount]: #rulecount #### [ruleCount] A count of the currently running rule set of this context access control list firewall. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Firewall_Interface/_index.md b/content/reference/datatypes/SoftLayer_Network_Firewall_Interface/_index.md index 7eaf3f1d3e..4c226e370c 100644 --- a/content/reference/datatypes/SoftLayer_Network_Firewall_Interface/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Firewall_Interface/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -59,7 +61,8 @@ The SoftLayer_Network_Firewall_Interface data type contains general information [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -69,7 +72,8 @@ The SoftLayer_Network_Firewall_Interface data type contains general information [name]: #name #### [name] -Type: **string** +Type: **string** + @@ -85,7 +89,8 @@ The SoftLayer_Network_Firewall_Interface data type contains general information [firewallContextAccessControlLists]: #firewallcontextaccesscontrollists #### [firewallContextAccessControlLists] -Type: **SoftLayer_Network_Firewall_AccessControlList[] ** +Type: **SoftLayer_Network_Firewall_AccessControlList[] ** + @@ -95,7 +100,8 @@ The SoftLayer_Network_Firewall_Interface data type contains general information [networkVlan]: #networkvlan #### [networkVlan] -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + @@ -107,7 +113,8 @@ The SoftLayer_Network_Firewall_Interface data type contains general information [firewallContextAccessControlListCount]: #firewallcontextaccesscontrollistcount #### [firewallContextAccessControlListCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Firewall_Module_Context_Interface/_index.md b/content/reference/datatypes/SoftLayer_Network_Firewall_Module_Context_Interface/_index.md index 92ea84d6d0..ee133b392e 100644 --- a/content/reference/datatypes/SoftLayer_Network_Firewall_Module_Context_Interface/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Firewall_Module_Context_Interface/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
      @@ -71,7 +75,8 @@ classes: [firewallContextAccessControlLists]: #firewallcontextaccesscontrollists #### [firewallContextAccessControlLists] -Type: **SoftLayer_Network_Firewall_AccessControlList[] ** +Type: **SoftLayer_Network_Firewall_AccessControlList[] ** + @@ -81,7 +86,8 @@ classes: [networkVlan]: #networkvlan #### [networkVlan] -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + @@ -93,7 +99,8 @@ classes: [firewallContextAccessControlListCount]: #firewallcontextaccesscontrollistcount #### [firewallContextAccessControlListCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Firewall_Template/_index.md b/content/reference/datatypes/SoftLayer_Network_Firewall_Template/_index.md index d02f51efa9..98cae6bcb1 100644 --- a/content/reference/datatypes/SoftLayer_Network_Firewall_Template/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Firewall_Template/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + 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. @@ -55,7 +57,8 @@ Firewall templates are recommend rule sets for use with SoftLayer Hardware Firew [id]: #id #### [id] A Firewall template's internal identifier. -Type: **integer** +Type: **integer** + @@ -65,7 +68,8 @@ A Firewall template's internal identifier. [name]: #name #### [name] The name of the firewall rules template. -Type: **string** +Type: **string** + @@ -81,7 +85,8 @@ The name of the firewall rules template. [rules]: #rules #### [rules] The rule set that belongs to this firewall rules template. -Type: **SoftLayer_Network_Firewall_Template_Rule[] ** +Type: **SoftLayer_Network_Firewall_Template_Rule[] ** + @@ -93,7 +98,8 @@ The rule set that belongs to this firewall rules template. [ruleCount]: #rulecount #### [ruleCount] A count of the rule set that belongs to this firewall rules template. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Firewall_Template_Rule/_index.md b/content/reference/datatypes/SoftLayer_Network_Firewall_Template_Rule/_index.md index 81f77a09cf..e3b96cfc32 100644 --- a/content/reference/datatypes/SoftLayer_Network_Firewall_Template_Rule/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Firewall_Template_Rule/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -51,7 +53,8 @@ The SoftLayer_Network_Component_Firewall_Rule type contains general information [action]: #action #### [action] The action that this template rule is to take [permit or deny]. -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ The action that this template rule is to take [permit or deny]. [destinationIpAddress]: #destinationipaddress #### [destinationIpAddress] The destination IP address considered for determining rule application. -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ The destination IP address considered for determining rule application. [destinationIpSubnetMask]: #destinationipsubnetmask #### [destinationIpSubnetMask] The destination IP subnet mask considered for determining rule application. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ The destination IP subnet mask considered for determining rule application. [destinationPortRangeEnd]: #destinationportrangeend #### [destinationPortRangeEnd] The ending (upper end of range) destination port considered for determining rule application. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The ending (upper end of range) destination port considered for determining rule [destinationPortRangeStart]: #destinationportrangestart #### [destinationPortRangeStart] The starting (lower end of range) destination port considered for determining rule application. -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ The starting (lower end of range) destination port considered for determining ru [firewallTemplateId]: #firewalltemplateid #### [firewallTemplateId] The unique identifier of the firewall template that a firewall template rule is associated with. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The unique identifier of the firewall template that a firewall template rule is [id]: #id #### [id] A Firewall template rule's internal identifier. -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ A Firewall template rule's internal identifier. [notes]: #notes #### [notes] The notes field for the firewall template rule. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The notes field for the firewall template rule. [orderValue]: #ordervalue #### [orderValue] The numeric value describing the order in which the rule set should be applied. -Type: **integer** +Type: **integer** + @@ -141,7 +152,8 @@ The numeric value describing the order in which the rule set should be applied. [protocol]: #protocol #### [protocol] The protocol considered for determining rule application. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ The protocol considered for determining rule application. [sourceIpAddress]: #sourceipaddress #### [sourceIpAddress] The source IP address considered for determining rule application. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ The source IP address considered for determining rule application. [sourceIpSubnetMask]: #sourceipsubnetmask #### [sourceIpSubnetMask] The source IP subnet mask considered for determining rule application. -Type: **string** +Type: **string** + @@ -177,7 +191,8 @@ The source IP subnet mask considered for determining rule application. [firewallTemplate]: #firewalltemplate #### [firewallTemplate] The firewall template that this rule is attached to. -Type: **SoftLayer_Network_Firewall_Template ** +Type: **SoftLayer_Network_Firewall_Template ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request/_index.md b/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request/_index.md index cba37d80a4..0253f824f9 100644 --- a/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -51,7 +53,8 @@ The SoftLayer_Network_Firewall_Update_Request data type contains information rel [applyDate]: #applydate #### [applyDate] Timestamp of when the rules from the update request were applied to the firewall. -Type: **dateTime** +Type: **dateTime** + @@ -61,7 +64,8 @@ Timestamp of when the rules from the update request were applied to the firewall [authorizingUserId]: #authorizinguserid #### [authorizingUserId] The unique identifier of the user that authorized the update request. -Type: **integer** +Type: **integer** + @@ -71,7 +75,8 @@ The unique identifier of the user that authorized the update request. [authorizingUserType]: #authorizingusertype #### [authorizingUserType] The type of user that authorized the update request [EMP or USR]. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ The type of user that authorized the update request [EMP or USR]. [bypassFlag]: #bypassflag #### [bypassFlag] Flag indicating whether the request is for a rule bypass configuration [0 or 1]. -Type: **boolean** +Type: **boolean** + @@ -91,7 +97,8 @@ Flag indicating whether the request is for a rule bypass configuration [0 or 1]. [createDate]: #createdate #### [createDate] Timestamp of the creation of the record. -Type: **dateTime** +Type: **dateTime** + @@ -101,7 +108,8 @@ Timestamp of the creation of the record. [firewallContextAccessControlListId]: #firewallcontextaccesscontrollistid #### [firewallContextAccessControlListId] The unique identifier of the firewall access control list that the rule set is destined for. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The unique identifier of the firewall access control list that the rule set is d [hardwareId]: #hardwareid #### [hardwareId] The unique identifier of the server that the rule set is destined to protect. -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ The unique identifier of the server that the rule set is destined to protect. [id]: #id #### [id] The unique identifier of the firewall update request. -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ The unique identifier of the firewall update request. [networkComponentFirewallId]: #networkcomponentfirewallid #### [networkComponentFirewallId] The unique identifier of the network component firewall that the rule set is destined for. -Type: **integer** +Type: **integer** + @@ -147,7 +158,8 @@ The unique identifier of the network component firewall that the rule set is des [authorizingUser]: #authorizinguser #### [authorizingUser] The user that authorized this firewall update request. -Type: **SoftLayer_User_Interface ** +Type: **SoftLayer_User_Interface ** + @@ -157,7 +169,8 @@ The user that authorized this firewall update request. [guest]: #guest #### [guest] The downstream virtual server that the rule set will be applied to. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -167,7 +180,8 @@ The downstream virtual server that the rule set will be applied to. [hardware]: #hardware #### [hardware] The downstream server that the rule set will be applied to. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -177,7 +191,8 @@ The downstream server that the rule set will be applied to. [networkComponentFirewall]: #networkcomponentfirewall #### [networkComponentFirewall] The network component firewall that the rule set will be applied to. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -187,7 +202,8 @@ The network component firewall that the rule set will be applied to. [rules]: #rules #### [rules] The group of rules contained within the update request. -Type: **SoftLayer_Network_Firewall_Update_Request_Rule[] ** +Type: **SoftLayer_Network_Firewall_Update_Request_Rule[] ** + @@ -199,7 +215,8 @@ The group of rules contained within the update request. [ruleCount]: #rulecount #### [ruleCount] A count of the group of rules contained within the update request. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request_Customer/_index.md b/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request_Customer/_index.md index 4a2ae0de56..c4f84f76bf 100644 --- a/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request_Customer/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request_Customer/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A SoftLayer_Ticket_Update_Customer is a single update made by a customer to a ticket. @@ -45,7 +47,8 @@ A SoftLayer_Ticket_Update_Customer is a single update made by a customer to a ti [applyDate]: #applydate #### [applyDate] Timestamp of when the rules from the update request were applied to the firewall. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ Timestamp of when the rules from the update request were applied to the firewall [authorizingUserId]: #authorizinguserid #### [authorizingUserId] The unique identifier of the user that authorized the update request. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The unique identifier of the user that authorized the update request. [authorizingUserType]: #authorizingusertype #### [authorizingUserType] The type of user that authorized the update request [EMP or USR]. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The type of user that authorized the update request [EMP or USR]. [bypassFlag]: #bypassflag #### [bypassFlag] Flag indicating whether the request is for a rule bypass configuration [0 or 1]. -Type: **boolean** +Type: **boolean** + @@ -85,7 +91,8 @@ Flag indicating whether the request is for a rule bypass configuration [0 or 1]. [createDate]: #createdate #### [createDate] Timestamp of the creation of the record. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ Timestamp of the creation of the record. [firewallContextAccessControlListId]: #firewallcontextaccesscontrollistid #### [firewallContextAccessControlListId] The unique identifier of the firewall access control list that the rule set is destined for. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The unique identifier of the firewall access control list that the rule set is d [hardwareId]: #hardwareid #### [hardwareId] The unique identifier of the server that the rule set is destined to protect. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ The unique identifier of the server that the rule set is destined to protect. [id]: #id #### [id] The unique identifier of the firewall update request. -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ The unique identifier of the firewall update request. [networkComponentFirewallId]: #networkcomponentfirewallid #### [networkComponentFirewallId] The unique identifier of the network component firewall that the rule set is destined for. -Type: **integer** +Type: **integer** + @@ -141,7 +152,8 @@ The unique identifier of the network component firewall that the rule set is des [authorizingUser]: #authorizinguser #### [authorizingUser] A user object for the customer user who created the firewall update request. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -151,7 +163,8 @@ A user object for the customer user who created the firewall update request. [guest]: #guest #### [guest] The downstream virtual server that the rule set will be applied to. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -161,7 +174,8 @@ The downstream virtual server that the rule set will be applied to. [hardware]: #hardware #### [hardware] The downstream server that the rule set will be applied to. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -171,7 +185,8 @@ The downstream server that the rule set will be applied to. [networkComponentFirewall]: #networkcomponentfirewall #### [networkComponentFirewall] The network component firewall that the rule set will be applied to. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -181,7 +196,8 @@ The network component firewall that the rule set will be applied to. [rules]: #rules #### [rules] The group of rules contained within the update request. -Type: **SoftLayer_Network_Firewall_Update_Request_Rule[] ** +Type: **SoftLayer_Network_Firewall_Update_Request_Rule[] ** + @@ -193,7 +209,8 @@ The group of rules contained within the update request. [ruleCount]: #rulecount #### [ruleCount] A count of the group of rules contained within the update request. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request_Employee/_index.md b/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request_Employee/_index.md index 1ec909dc5c..7a6940640b 100644 --- a/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request_Employee/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request_Employee/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Firewall_Update_Request_Employee data type returns a user object for the SoftLayer employee that created the request. @@ -45,7 +47,8 @@ The SoftLayer_Network_Firewall_Update_Request_Employee data type returns a user [applyDate]: #applydate #### [applyDate] Timestamp of when the rules from the update request were applied to the firewall. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ Timestamp of when the rules from the update request were applied to the firewall [authorizingUserId]: #authorizinguserid #### [authorizingUserId] The unique identifier of the user that authorized the update request. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The unique identifier of the user that authorized the update request. [authorizingUserType]: #authorizingusertype #### [authorizingUserType] The type of user that authorized the update request [EMP or USR]. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The type of user that authorized the update request [EMP or USR]. [bypassFlag]: #bypassflag #### [bypassFlag] Flag indicating whether the request is for a rule bypass configuration [0 or 1]. -Type: **boolean** +Type: **boolean** + @@ -85,7 +91,8 @@ Flag indicating whether the request is for a rule bypass configuration [0 or 1]. [createDate]: #createdate #### [createDate] Timestamp of the creation of the record. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ Timestamp of the creation of the record. [firewallContextAccessControlListId]: #firewallcontextaccesscontrollistid #### [firewallContextAccessControlListId] The unique identifier of the firewall access control list that the rule set is destined for. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The unique identifier of the firewall access control list that the rule set is d [hardwareId]: #hardwareid #### [hardwareId] The unique identifier of the server that the rule set is destined to protect. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ The unique identifier of the server that the rule set is destined to protect. [id]: #id #### [id] The unique identifier of the firewall update request. -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ The unique identifier of the firewall update request. [networkComponentFirewallId]: #networkcomponentfirewallid #### [networkComponentFirewallId] The unique identifier of the network component firewall that the rule set is destined for. -Type: **integer** +Type: **integer** + @@ -141,7 +152,8 @@ The unique identifier of the network component firewall that the rule set is des [authorizingUser]: #authorizinguser #### [authorizingUser] A user object for the SoftLayer employee who created the firewall update request. -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -151,7 +163,8 @@ A user object for the SoftLayer employee who created the firewall update request [guest]: #guest #### [guest] The downstream virtual server that the rule set will be applied to. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -161,7 +174,8 @@ The downstream virtual server that the rule set will be applied to. [hardware]: #hardware #### [hardware] The downstream server that the rule set will be applied to. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -171,7 +185,8 @@ The downstream server that the rule set will be applied to. [networkComponentFirewall]: #networkcomponentfirewall #### [networkComponentFirewall] The network component firewall that the rule set will be applied to. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -181,7 +196,8 @@ The network component firewall that the rule set will be applied to. [rules]: #rules #### [rules] The group of rules contained within the update request. -Type: **SoftLayer_Network_Firewall_Update_Request_Rule[] ** +Type: **SoftLayer_Network_Firewall_Update_Request_Rule[] ** + @@ -193,7 +209,8 @@ The group of rules contained within the update request. [ruleCount]: #rulecount #### [ruleCount] A count of the group of rules contained within the update request. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request_Rule/_index.md b/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request_Rule/_index.md index 45573d0c08..dde2f71a2f 100644 --- a/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request_Rule/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request_Rule/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -51,7 +53,8 @@ The SoftLayer_Network_Firewall_Update_Request_Rule type contains information rel [action]: #action #### [action] The action that this update request rule is to take [permit or deny]. -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ The action that this update request rule is to take [permit or deny]. [destinationIpAddress]: #destinationipaddress #### [destinationIpAddress] The destination IP address considered for determining rule application. -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ The destination IP address considered for determining rule application. [destinationIpCidr]: #destinationipcidr #### [destinationIpCidr] The CIDR is used for determining rule application. This value will -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ The CIDR is used for determining rule application. This value will [destinationIpSubnetMask]: #destinationipsubnetmask #### [destinationIpSubnetMask] The destination IP subnet mask considered for determining rule application. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The destination IP subnet mask considered for determining rule application. [destinationPortRangeEnd]: #destinationportrangeend #### [destinationPortRangeEnd] The ending (upper end of range) destination port considered for determining rule application. -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ The ending (upper end of range) destination port considered for determining rule [destinationPortRangeStart]: #destinationportrangestart #### [destinationPortRangeStart] The starting (lower end of range) destination port considered for determining rule application. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The starting (lower end of range) destination port considered for determining ru [firewallUpdateRequestId]: #firewallupdaterequestid #### [firewallUpdateRequestId] The unique identifier of the firewall update request that a firewall update request rule is associated with. -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ The unique identifier of the firewall update request that a firewall update requ [id]: #id #### [id] A Firewall update request rule's internal identifier. -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ A Firewall update request rule's internal identifier. [notes]: #notes #### [notes] The notes field for the firewall update request rule. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ The notes field for the firewall update request rule. [orderValue]: #ordervalue #### [orderValue] The numeric value describing the order in which the rule should be applied. -Type: **integer** +Type: **integer** + @@ -151,7 +163,8 @@ The numeric value describing the order in which the rule should be applied. [protocol]: #protocol #### [protocol] The protocol considered for determining rule application. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ The protocol considered for determining rule application. [sourceIpAddress]: #sourceipaddress #### [sourceIpAddress] The source IP address considered for determining rule application. -Type: **string** +Type: **string** + @@ -171,7 +185,8 @@ The source IP address considered for determining rule application. [sourceIpCidr]: #sourceipcidr #### [sourceIpCidr] The CIDR is used for determining rule application. This value will -Type: **integer** +Type: **integer** + @@ -181,7 +196,8 @@ The CIDR is used for determining rule application. This value will [sourceIpSubnetMask]: #sourceipsubnetmask #### [sourceIpSubnetMask] The source IP subnet mask considered for determining rule application. -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ The source IP subnet mask considered for determining rule application. [version]: #version #### [version] Whether this rule is an IPv4 rule or an IPv6 rule. If -Type: **integer** +Type: **integer** + @@ -207,7 +224,8 @@ Whether this rule is an IPv4 rule or an IPv6 rule. If [firewallUpdateRequest]: #firewallupdaterequest #### [firewallUpdateRequest] The update request that this rule belongs to. -Type: **SoftLayer_Network_Firewall_Update_Request ** +Type: **SoftLayer_Network_Firewall_Update_Request ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request_Rule_Version6/_index.md b/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request_Rule_Version6/_index.md index 067b03c982..405ab08757 100644 --- a/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request_Rule_Version6/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Firewall_Update_Request_Rule_Version6/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Firewall_Update_Request_Rule_Version6 type contains inform [action]: #action #### [action] The action that this update request rule is to take [permit or deny]. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The action that this update request rule is to take [permit or deny]. [destinationIpAddress]: #destinationipaddress #### [destinationIpAddress] The destination IP address considered for determining rule application. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The destination IP address considered for determining rule application. [destinationIpCidr]: #destinationipcidr #### [destinationIpCidr] The CIDR is used for determining rule application. This value will -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The CIDR is used for determining rule application. This value will [destinationIpSubnetMask]: #destinationipsubnetmask #### [destinationIpSubnetMask] The destination IP subnet mask considered for determining rule application. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The destination IP subnet mask considered for determining rule application. [destinationPortRangeEnd]: #destinationportrangeend #### [destinationPortRangeEnd] The ending (upper end of range) destination port considered for determining rule application. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The ending (upper end of range) destination port considered for determining rule [destinationPortRangeStart]: #destinationportrangestart #### [destinationPortRangeStart] The starting (lower end of range) destination port considered for determining rule application. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The starting (lower end of range) destination port considered for determining ru [firewallUpdateRequestId]: #firewallupdaterequestid #### [firewallUpdateRequestId] The unique identifier of the firewall update request that a firewall update request rule is associated with. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ The unique identifier of the firewall update request that a firewall update requ [id]: #id #### [id] A Firewall update request rule's internal identifier. -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ A Firewall update request rule's internal identifier. [notes]: #notes #### [notes] The notes field for the firewall update request rule. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The notes field for the firewall update request rule. [orderValue]: #ordervalue #### [orderValue] The numeric value describing the order in which the rule should be applied. -Type: **integer** +Type: **integer** + @@ -145,7 +157,8 @@ The numeric value describing the order in which the rule should be applied. [protocol]: #protocol #### [protocol] The protocol considered for determining rule application. -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ The protocol considered for determining rule application. [sourceIpAddress]: #sourceipaddress #### [sourceIpAddress] The source IP address considered for determining rule application. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ The source IP address considered for determining rule application. [sourceIpCidr]: #sourceipcidr #### [sourceIpCidr] The CIDR is used for determining rule application. This value will -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The CIDR is used for determining rule application. This value will [sourceIpSubnetMask]: #sourceipsubnetmask #### [sourceIpSubnetMask] The source IP subnet mask considered for determining rule application. -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ The source IP subnet mask considered for determining rule application. [version]: #version #### [version] Whether this rule is an IPv4 rule or an IPv6 rule. If -Type: **integer** +Type: **integer** + @@ -201,7 +218,8 @@ Whether this rule is an IPv4 rule or an IPv6 rule. If [firewallUpdateRequest]: #firewallupdaterequest #### [firewallUpdateRequest] The update request that this rule belongs to. -Type: **SoftLayer_Network_Firewall_Update_Request ** +Type: **SoftLayer_Network_Firewall_Update_Request ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Gateway/_index.md b/content/reference/datatypes/SoftLayer_Network_Gateway/_index.md index 4f38728b4c..9ce54809ac 100644 --- a/content/reference/datatypes/SoftLayer_Network_Gateway/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Gateway/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The internal identifier of the account assigned to this gateway. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The internal identifier of the account assigned to this gateway. [groupNumber]: #groupnumber #### [groupNumber] The VRRP group number for this gateway. This is set internally and cannot be provided on create. -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ The VRRP group number for this gateway. This is set internally and cannot be pro [id]: #id #### [id] A gateway's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A gateway's internal identifier. [name]: #name #### [name] A gateway's name. This is required on create and can be no more than 255 characters. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ A gateway's name. This is required on create and can be no more than 255 charact [networkSpace]: #networkspace #### [networkSpace] A gateway's network space. Currently, only 'private' or 'both' is allowed. When this value is 'private', it is a backend gateway only. Otherwise, it is a gateway for both frontend and backend traffic. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ A gateway's network space. Currently, only 'private' or 'both' is allowed. When [privateIpAddressId]: #privateipaddressid #### [privateIpAddressId] The internal identifier of the private IP address for this gateway. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The internal identifier of the private IP address for this gateway. [privateVlanId]: #privatevlanid #### [privateVlanId] The internal identifier of the private VLAN for this gateway. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ The internal identifier of the private VLAN for this gateway. [publicIpAddressId]: #publicipaddressid #### [publicIpAddressId] The internal identifier of the public IP address for this gateway. -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ The internal identifier of the public IP address for this gateway. [publicIpv6AddressId]: #publicipv6addressid #### [publicIpv6AddressId] The internal identifier of the public IPv6 address for this gateway. -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ The internal identifier of the public IPv6 address for this gateway. [publicVlanId]: #publicvlanid #### [publicVlanId] The internal identifier of the public VLAN for this gateway. This is set internally and cannot be provided on create. -Type: **integer** +Type: **integer** + @@ -145,7 +157,8 @@ The internal identifier of the public VLAN for this gateway. This is set interna [statusId]: #statusid #### [statusId] The current status of this gateway. This is always active unless there is a process running to change the gateway. This can not be set on creation. -Type: **integer** +Type: **integer** + @@ -161,7 +174,8 @@ The current status of this gateway. This is always active unless there is a proc [account]: #account #### [account] The account for this gateway. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -171,7 +185,8 @@ The account for this gateway. [insideVlans]: #insidevlans #### [insideVlans] All VLANs trunked to this gateway. -Type: **SoftLayer_Network_Gateway_Vlan[] ** +Type: **SoftLayer_Network_Gateway_Vlan[] ** + @@ -181,7 +196,8 @@ All VLANs trunked to this gateway. [members]: #members #### [members] The members for this gateway. -Type: **SoftLayer_Network_Gateway_Member[] ** +Type: **SoftLayer_Network_Gateway_Member[] ** + @@ -191,7 +207,8 @@ The members for this gateway. [networkFirewall]: #networkfirewall #### [networkFirewall] The firewall associated with this gateway, if any. -Type: **SoftLayer_Network_Vlan_Firewall ** +Type: **SoftLayer_Network_Vlan_Firewall ** + @@ -201,7 +218,8 @@ The firewall associated with this gateway, if any. [networkFirewallFlag]: #networkfirewallflag #### [networkFirewallFlag] Whether or not there is a firewall associated with this gateway. -Type: **boolean** +Type: **boolean** + @@ -211,7 +229,8 @@ Whether or not there is a firewall associated with this gateway. [privateIpAddress]: #privateipaddress #### [privateIpAddress] The private gateway IP address. -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -221,7 +240,8 @@ The private gateway IP address. [privateVlan]: #privatevlan #### [privateVlan] The private VLAN for accessing this gateway. -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + @@ -231,7 +251,8 @@ The private VLAN for accessing this gateway. [publicIpAddress]: #publicipaddress #### [publicIpAddress] The public gateway IP address. -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -241,7 +262,8 @@ The public gateway IP address. [publicIpv6Address]: #publicipv6address #### [publicIpv6Address] The public gateway IPv6 address. -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -251,7 +273,8 @@ The public gateway IPv6 address. [publicVlan]: #publicvlan #### [publicVlan] The public VLAN for accessing this gateway. -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + @@ -261,7 +284,8 @@ The public VLAN for accessing this gateway. [status]: #status #### [status] The current status of the gateway. -Type: **SoftLayer_Network_Gateway_Status ** +Type: **SoftLayer_Network_Gateway_Status ** + @@ -273,7 +297,8 @@ The current status of the gateway. [insideVlanCount]: #insidevlancount #### [insideVlanCount] A count of all VLANs trunked to this gateway. -Type: **unsigned long** +Type: **unsigned long** + @@ -283,7 +308,8 @@ A count of all VLANs trunked to this gateway. [memberCount]: #membercount #### [memberCount] A count of the members for this gateway. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Gateway_Member/_index.md b/content/reference/datatypes/SoftLayer_Network_Gateway_Member/_index.md index 92dddeb800..b004188156 100644 --- a/content/reference/datatypes/SoftLayer_Network_Gateway_Member/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Gateway_Member/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [hardwareId]: #hardwareid #### [hardwareId] The internal identifier of the hardware for this member. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The internal identifier of the hardware for this member. [id]: #id #### [id] A gateway member's internal identifier. -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ A gateway member's internal identifier. [networkGatewayId]: #networkgatewayid #### [networkGatewayId] The internal identifier of the gateway this member belongs to. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The internal identifier of the gateway this member belongs to. [priority]: #priority #### [priority] The priority for this gateway member. This is set internally and cannot be provided on create. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The priority for this gateway member. This is set internally and cannot be provi [attributes]: #attributes #### [attributes] The attributes for this member. -Type: **SoftLayer_Network_Gateway_Member_Attribute ** +Type: **SoftLayer_Network_Gateway_Member_Attribute ** + @@ -101,7 +108,8 @@ The attributes for this member. [hardware]: #hardware #### [hardware] The device for this member. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -111,7 +119,8 @@ The device for this member. [networkGateway]: #networkgateway #### [networkGateway] The gateway this member belongs to. -Type: **SoftLayer_Network_Gateway ** +Type: **SoftLayer_Network_Gateway ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Gateway_Member_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Network_Gateway_Member_Attribute/_index.md index a2466259b5..69b443ef3e 100644 --- a/content/reference/datatypes/SoftLayer_Network_Gateway_Member_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Gateway_Member_Attribute/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] A gateway member's internal identifier. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ A gateway member's internal identifier. [isUpgraded]: #isupgraded #### [isUpgraded] Indicates if the member has been upgraded. -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ Indicates if the member has been upgraded. [lastvSRXVersion]: #lastvsrxversion #### [lastvSRXVersion] The previous vSRX version of the gateway software -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The previous vSRX version of the gateway software [licenseExpirationDate]: #licenseexpirationdate #### [licenseExpirationDate] Timestamp for the expiration date of the license key -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ Timestamp for the expiration date of the license key [licenseKey]: #licensekey #### [licenseKey] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Timestamp for the expiration date of the license key [memberId]: #memberid #### [memberId] The gateway member for this attribute. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The gateway member for this attribute. [networkModel]: #networkmodel #### [networkModel] Network model of the gateway. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ Network model of the gateway. [password]: #password #### [password] Password of the user name. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ Password of the user name. [sshKeyId]: #sshkeyid #### [sshKeyId] The SSH key id of key assigned to Gateway. -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ The SSH key id of key assigned to Gateway. [upgradedDate]: #upgradeddate #### [upgradedDate] Timestamp when this gateway member was last upgraded -Type: **dateTime** +Type: **dateTime** + @@ -145,7 +157,8 @@ Timestamp when this gateway member was last upgraded [username]: #username #### [username] Username associated with the gateway. -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ Username associated with the gateway. [vSRXVersion]: #vsrxversion #### [vSRXVersion] The vSRX version of the gateway software -Type: **string** +Type: **string** + @@ -171,7 +185,8 @@ The vSRX version of the gateway software [gatewayMember]: #gatewaymember #### [gatewayMember] The gateway member has these attributes. -Type: **SoftLayer_Network_Gateway_Member ** +Type: **SoftLayer_Network_Gateway_Member ** + @@ -181,7 +196,8 @@ The gateway member has these attributes. [sshKey]: #sshkey #### [sshKey] -Type: **SoftLayer_Security_Ssh_Key ** +Type: **SoftLayer_Security_Ssh_Key ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Gateway_Precheck/_index.md b/content/reference/datatypes/SoftLayer_Network_Gateway_Precheck/_index.md index a051668041..8760b7daa9 100644 --- a/content/reference/datatypes/SoftLayer_Network_Gateway_Precheck/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Gateway_Precheck/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [category]: #category #### [category] Category name -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ Category name [gatewayReadinessValue]: #gatewayreadinessvalue #### [gatewayReadinessValue] Gateway precheck status -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ Gateway precheck status [memberId]: #memberid #### [memberId] The gateway member for this precheck. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The gateway member for this precheck. [memberReadinessValue]: #memberreadinessvalue #### [memberReadinessValue] Gateway precheck status -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ Gateway precheck status [returnCode]: #returncode #### [returnCode] The precheck error status of the member -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Network_Gateway_Status/_index.md b/content/reference/datatypes/SoftLayer_Network_Gateway_Status/_index.md index b3725f3304..664f7e725d 100644 --- a/content/reference/datatypes/SoftLayer_Network_Gateway_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Gateway_Status/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] A gateway status's description. -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ A gateway status's description. [id]: #id #### [id] A gateway status's internal identifier. -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ A gateway status's internal identifier. [keyName]: #keyname #### [keyName] A gateway status's programmatic name. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A gateway status's programmatic name. [name]: #name #### [name] A gateway status's human-friendly name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Gateway_VersionUpgrade/_index.md b/content/reference/datatypes/SoftLayer_Network_Gateway_VersionUpgrade/_index.md index 60353f9679..04f49b6da5 100644 --- a/content/reference/datatypes/SoftLayer_Network_Gateway_VersionUpgrade/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Gateway_VersionUpgrade/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [fromVersion]: #fromversion #### [fromVersion] Gateway version being upgraded from. -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ Gateway version being upgraded from. [id]: #id #### [id] A gateway status's internal identifier. -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ A gateway status's internal identifier. [osReloadRequired]: #osreloadrequired #### [osReloadRequired] Is OS Reload required after version upgrade?. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ Is OS Reload required after version upgrade?. [toVersion]: #toversion #### [toVersion] Gateway version available for upgrade. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Gateway_Vlan/_index.md b/content/reference/datatypes/SoftLayer_Network_Gateway_Vlan/_index.md index b68ec8f8bf..ed663a6ead 100644 --- a/content/reference/datatypes/SoftLayer_Network_Gateway_Vlan/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Gateway_Vlan/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [bypassFlag]: #bypassflag #### [bypassFlag] If true, this VLAN is bypassed. If false, it is routed through the gateway. -Type: **boolean** +Type: **boolean** +
      @@ -55,7 +58,8 @@ If true, this VLAN is bypassed. If false, it is routed through the gateway. [id]: #id #### [id] A gateway VLAN's internal identifier. -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ A gateway VLAN's internal identifier. [networkGatewayId]: #networkgatewayid #### [networkGatewayId] The internal identifier of the gateway this VLAN is attached to. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The internal identifier of the gateway this VLAN is attached to. [networkVlanId]: #networkvlanid #### [networkVlanId] The internal identifier of the network VLAN. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The internal identifier of the network VLAN. [networkGateway]: #networkgateway #### [networkGateway] The gateway this VLAN is attached to. -Type: **SoftLayer_Network_Gateway ** +Type: **SoftLayer_Network_Gateway ** + @@ -101,7 +108,8 @@ The gateway this VLAN is attached to. [networkVlan]: #networkvlan #### [networkVlan] The network VLAN record. -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Interconnect_Tenant/_index.md b/content/reference/datatypes/SoftLayer_Network_Interconnect_Tenant/_index.md index e7840f4f53..3b84692fa1 100644 --- a/content/reference/datatypes/SoftLayer_Network_Interconnect_Tenant/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Interconnect_Tenant/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [bgpAsn]: #bgpasn #### [bgpAsn] Specifies ASN used for BGP. -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ Specifies ASN used for BGP. [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ Specifies ASN used for BGP. [errorMessage]: #errormessage #### [errorMessage] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ Specifies ASN used for BGP. [globalRoutingFlag]: #globalroutingflag #### [globalRoutingFlag] The Direct Link connectivity to all SoftLayer data centers if globalRoutingFlag = 1 and local connectivity if globalRoutingFlag = 0. -Type: **boolean** +Type: **boolean** + @@ -95,7 +102,8 @@ The Direct Link connectivity to all SoftLayer data centers if globalRoutingFlag [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The Direct Link connectivity to all SoftLayer data centers if globalRoutingFlag [interconnectType]: #interconnecttype #### [interconnectType] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The Direct Link connectivity to all SoftLayer data centers if globalRoutingFlag [linkSpeed]: #linkspeed #### [linkSpeed] Link speed of a Direct Link connection. -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ Link speed of a Direct Link connection. [localIpAddress]: #localipaddress #### [localIpAddress] IP address (v4 or v6) of "near" router serial interface. No check/update of IP Address table. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ IP address (v4 or v6) of "near" router serial interface. No check/update of IP A [location]: #location #### [location] -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ IP address (v4 or v6) of "near" router serial interface. No check/update of IP A [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -155,7 +168,8 @@ IP address (v4 or v6) of "near" router serial interface. No check/update of IP A [name]: #name #### [name] Specifies the Interconnect connection name. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ Specifies the Interconnect connection name. [newGlobalRoutingFlag]: #newglobalroutingflag #### [newGlobalRoutingFlag] Direct Link provider can request change to existing routing, Customer can approve the change. newGlobalRoutingFlag = 1 gives connectivity to all IBM data centers, and if newGlobalRoutingFlag = 0, it gives local connectivity. -Type: **boolean** +Type: **boolean** + @@ -175,7 +190,8 @@ Direct Link provider can request change to existing routing, Customer can approv [newLinkSpeed]: #newlinkspeed #### [newLinkSpeed] Updated Link speed of a Direct Link connection. -Type: **integer** +Type: **integer** + @@ -185,7 +201,8 @@ Updated Link speed of a Direct Link connection. [note]: #note #### [note] This field will have the ticket id if the tenant workflow fails -Type: **string** +Type: **string** + @@ -195,7 +212,8 @@ This field will have the ticket id if the tenant workflow fails [peerLinkSpeed]: #peerlinkspeed #### [peerLinkSpeed] Link speed of a Direct Link connection on Equinix Side. -Type: **integer** +Type: **integer** + @@ -205,7 +223,8 @@ Link speed of a Direct Link connection on Equinix Side. [port]: #port #### [port] -Type: **string** +Type: **string** + @@ -215,7 +234,8 @@ Link speed of a Direct Link connection on Equinix Side. [provider]: #provider #### [provider] -Type: **string** +Type: **string** + @@ -225,7 +245,8 @@ Link speed of a Direct Link connection on Equinix Side. [providerAccountId]: #provideraccountid #### [providerAccountId] -Type: **integer** +Type: **integer** + @@ -235,7 +256,8 @@ Link speed of a Direct Link connection on Equinix Side. [redundancyFlag]: #redundancyflag #### [redundancyFlag] Specifies redundant connection is available if 1. -Type: **boolean** +Type: **boolean** + @@ -245,7 +267,8 @@ Specifies redundant connection is available if 1. [remoteIpAddress]: #remoteipaddress #### [remoteIpAddress] -Type: **string** +Type: **string** + @@ -255,7 +278,8 @@ Specifies redundant connection is available if 1. [serviceKey]: #servicekey #### [serviceKey] Service key for Interconnect connection. -Type: **string** +Type: **string** + @@ -265,7 +289,8 @@ Service key for Interconnect connection. [serviceTypeId]: #servicetypeid #### [serviceTypeId] -Type: **integer** +Type: **integer** + @@ -275,7 +300,8 @@ Service key for Interconnect connection. [status]: #status #### [status] The direct link connection status. IN_PROGRESS, PROVISIONING, CONNECTION_UP, CONNECTION_DOWN -Type: **string** +Type: **string** + @@ -285,7 +311,8 @@ The direct link connection status. IN_PROGRESS, PROVISIONING, CONNECTION_UP, CON [vlanId]: #vlanid #### [vlanId] -Type: **integer** +Type: **integer** + @@ -301,7 +328,8 @@ The direct link connection status. IN_PROGRESS, PROVISIONING, CONNECTION_UP, CON [billingItem]: #billingitem #### [billingItem] The active billing item for a network interconnect. -Type: **SoftLayer_Billing_Item_Network_Interconnect ** +Type: **SoftLayer_Billing_Item_Network_Interconnect ** + @@ -311,7 +339,8 @@ The active billing item for a network interconnect. [datacenterName]: #datacentername #### [datacenterName] -Type: **string** +Type: **string** + @@ -321,7 +350,8 @@ The active billing item for a network interconnect. [portLabel]: #portlabel #### [portLabel] -Type: **string** +Type: **string** + @@ -331,7 +361,8 @@ The active billing item for a network interconnect. [serviceType]: #servicetype #### [serviceType] -Type: **SoftLayer_Network_DirectLink_ServiceType ** +Type: **SoftLayer_Network_DirectLink_ServiceType ** + @@ -341,7 +372,8 @@ The active billing item for a network interconnect. [vendorName]: #vendorname #### [vendorName] -Type: **string** +Type: **string** + @@ -351,7 +383,8 @@ The active billing item for a network interconnect. [zoneName]: #zonename #### [zoneName] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_HealthMonitor/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_HealthMonitor/_index.md index cb3dd86c94..a96387680e 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_HealthMonitor/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_HealthMonitor/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -45,7 +47,8 @@ The SoftLayer_Network_LBaaS_HealthMonitor type presents a structure containing a [createDate]: #createdate #### [createDate] Create date of the health monitor instance -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ Create date of the health monitor instance [id]: #id #### [id] Health monitor's identifier -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Health monitor's identifier [interval]: #interval #### [interval] Interval in seconds to perform health check -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ Interval in seconds to perform health check [maxRetries]: #maxretries #### [maxRetries] Maximum number of health check retries in case of failure -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Maximum number of health check retries in case of failure [modifyDate]: #modifydate #### [modifyDate] Modify date of the health monitor instance -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ Modify date of the health monitor instance [monitorType]: #monitortype #### [monitorType] Type of health check, valid values are "TCP", "HTTP" and "HTTPS" -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ Type of health check, valid values are "TCP", "HTTP" and "HTTPS" [provisioningStatus]: #provisioningstatus #### [provisioningStatus] Provisioning status of the health monitor, supported values are "CREATE_PENDING", -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ Provisioning status of the health monitor, supported values are "CREATE_PENDING" [timeout]: #timeout #### [timeout] Timeout in seconds to wait for health checks response -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ Timeout in seconds to wait for health checks response [urlPath]: #urlpath #### [urlPath] If monitorType is "HTTP" this specifies the whole URL path -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ If monitorType is "HTTP" this specifies the whole URL path [uuid]: #uuid #### [uuid] Health monitor's UUID -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_L7HealthMonitor/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_L7HealthMonitor/_index.md index e0ddec4d1b..d426c79363 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_L7HealthMonitor/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_L7HealthMonitor/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -49,7 +51,8 @@ The SoftLayer_Network_LBaaS_L7HealthMonitor type presents a structure containing [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -59,7 +62,8 @@ The SoftLayer_Network_LBaaS_L7HealthMonitor type presents a structure containing [interval]: #interval #### [interval] -Type: **integer** +Type: **integer** + @@ -69,7 +73,8 @@ The SoftLayer_Network_LBaaS_L7HealthMonitor type presents a structure containing [maxRetries]: #maxretries #### [maxRetries] -Type: **integer** +Type: **integer** + @@ -79,7 +84,8 @@ The SoftLayer_Network_LBaaS_L7HealthMonitor type presents a structure containing [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -89,7 +95,8 @@ The SoftLayer_Network_LBaaS_L7HealthMonitor type presents a structure containing [monitorType]: #monitortype #### [monitorType] -Type: **string** +Type: **string** + @@ -99,7 +106,8 @@ The SoftLayer_Network_LBaaS_L7HealthMonitor type presents a structure containing [provisioningStatus]: #provisioningstatus #### [provisioningStatus] -Type: **string** +Type: **string** + @@ -109,7 +117,8 @@ The SoftLayer_Network_LBaaS_L7HealthMonitor type presents a structure containing [timeout]: #timeout #### [timeout] -Type: **integer** +Type: **integer** + @@ -119,7 +128,8 @@ The SoftLayer_Network_LBaaS_L7HealthMonitor type presents a structure containing [urlPath]: #urlpath #### [urlPath] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_L7Member/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_L7Member/_index.md index df158abc58..e21203de90 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_L7Member/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_L7Member/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_LBaaS_L7Member represents the backend member for a L7 pool [address]: #address #### [address] The IP address of a L7 pool member. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The IP address of a L7 pool member. [createDate]: #createdate #### [createDate] <<< EOT Specifies when a L7 pool member -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The IP address of a L7 pool member. [id]: #id #### [id] The ID of a L7 pool member. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The ID of a L7 pool member. [modifyDate]: #modifydate #### [modifyDate] <<< EOT Specifies when a L7 Pool -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The ID of a L7 pool member. [port]: #port #### [port] Backends protocol port -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ Backends protocol port [provisioningStatus]: #provisioningstatus #### [provisioningStatus] <<< EOT The provisioning status of a L7 pool member. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ Backends protocol port [uuid]: #uuid #### [uuid] The UUID of a L7 pool member. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The UUID of a L7 pool member. [weight]: #weight #### [weight] The weight of a L7 pool member. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_L7Policy/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_L7Policy/_index.md index 4e818fe2a9..2c4eb2e830 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_L7Policy/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_L7Policy/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_LBaaS_L7Policy represents the policy for a listener. @@ -45,7 +47,8 @@ The SoftLayer_Network_LBaaS_L7Policy represents the policy for a listener. [action]: #action #### [action] The Action to take if the rules belonging to this policy match. It can be set to any of the following values: REDIRECT_URL, REDIRECT_POOL, REDIRECT_HTTPS, REJECT. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The Action to take if the rules belonging to this policy match. It can be set to [createDate]: #createdate #### [createDate] Specifies when a L7 Policy was created. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ Specifies when a L7 Policy was created. [id]: #id #### [id] The unique identifier of a policy. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The unique identifier of a policy. [modifyDate]: #modifydate #### [modifyDate] Specifies when a L7 Policy was updated previously. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ Specifies when a L7 Policy was updated previously. [name]: #name #### [name] Name of a Policy. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Name of a Policy. [priority]: #priority #### [priority] The order in which the policy is evaluated. Each policy should have a unique priority -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The order in which the policy is evaluated. Each policy should have a unique pri [redirectL7PoolId]: #redirectl7poolid #### [redirectL7PoolId] The L7 pool id to which traffic is redirected -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ The L7 pool id to which traffic is redirected [redirectL7PoolUuid]: #redirectl7pooluuid #### [redirectL7PoolUuid] The UUID of the L7 pool object referenced by the policy when the policy action is set to REDIRECT_POOL -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The UUID of the L7 pool object referenced by the policy when the policy action i [redirectUrl]: #redirecturl #### [redirectUrl] The URL to which traffic is redirected when the action is set to REDIRECT_URL. Or the port to which listener traffic is redirected to when the action is set to REDIRECT_HTTPS. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The URL to which traffic is redirected when the action is set to REDIRECT_URL. O [uuid]: #uuid #### [uuid] The UUID of a Policy. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ The UUID of a Policy. [l7Rules]: #l7rules #### [l7Rules] -Type: **SoftLayer_Network_LBaaS_L7Rule[] ** +Type: **SoftLayer_Network_LBaaS_L7Rule[] ** + @@ -163,7 +176,8 @@ The UUID of a Policy. [l7RuleCount]: #l7rulecount #### [l7RuleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_L7Pool/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_L7Pool/_index.md index 7a3dbff7b7..83ffc03bd8 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_L7Pool/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_L7Pool/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -50,7 +52,8 @@ The SoftLayer_Network_LBaaS_L7Pool type presents a structure containing attribut [createDate]: #createdate #### [createDate] Create date of the L7 pool instance -Type: **dateTime** +Type: **dateTime** + @@ -60,7 +63,8 @@ Create date of the L7 pool instance [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ Create date of the L7 pool instance [loadBalancingAlgorithm]: #loadbalancingalgorithm #### [loadBalancingAlgorithm] Load balancing algorithm: "ROUNDROBIN", "WEIGHTED_RR", "LEASTCONNECTION" -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ Load balancing algorithm: "ROUNDROBIN", "WEIGHTED_RR", "LEASTCONNECTION" [modifyDate]: #modifydate #### [modifyDate] Last updated date of the L7 pool -Type: **dateTime** +Type: **dateTime** + @@ -90,7 +96,8 @@ Last updated date of the L7 pool [name]: #name #### [name] Name of the L7 pool. -Type: **string** +Type: **string** + @@ -100,7 +107,8 @@ Name of the L7 pool. [protocol]: #protocol #### [protocol] Backends protocol, supported protocol is, "HTTP" -Type: **string** +Type: **string** + @@ -110,7 +118,8 @@ Backends protocol, supported protocol is, "HTTP" [provisioningStatus]: #provisioningstatus #### [provisioningStatus] Provisioning status of a load balancer's L7 pool. -Type: **string** +Type: **string** + @@ -120,7 +129,8 @@ Provisioning status of a load balancer's L7 pool. [uuid]: #uuid #### [uuid] Instance uuid of the L7 pool -Type: **string** +Type: **string** + @@ -136,7 +146,8 @@ Instance uuid of the L7 pool [l7HealthMonitor]: #l7healthmonitor #### [l7HealthMonitor] -Type: **SoftLayer_Network_LBaaS_L7HealthMonitor ** +Type: **SoftLayer_Network_LBaaS_L7HealthMonitor ** + @@ -146,7 +157,8 @@ Instance uuid of the L7 pool [l7Members]: #l7members #### [l7Members] -Type: **SoftLayer_Network_LBaaS_L7Member[] ** +Type: **SoftLayer_Network_LBaaS_L7Member[] ** + @@ -156,7 +168,8 @@ Instance uuid of the L7 pool [l7Policies]: #l7policies #### [l7Policies] -Type: **SoftLayer_Network_LBaaS_L7Policy[] ** +Type: **SoftLayer_Network_LBaaS_L7Policy[] ** + @@ -166,7 +179,8 @@ Instance uuid of the L7 pool [l7SessionAffinity]: #l7sessionaffinity #### [l7SessionAffinity] -Type: **SoftLayer_Network_LBaaS_L7SessionAffinity ** +Type: **SoftLayer_Network_LBaaS_L7SessionAffinity ** + @@ -178,7 +192,8 @@ Instance uuid of the L7 pool [l7MemberCount]: #l7membercount #### [l7MemberCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -188,7 +203,8 @@ A count of [l7PolicyCount]: #l7policycount #### [l7PolicyCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_L7PoolMembersHealth/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_L7PoolMembersHealth/_index.md index fbe5e3e738..51f693ce4d 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_L7PoolMembersHealth/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_L7PoolMembersHealth/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Network_LBaaS_L7PoolMembersHealth provides statistics of members belonging to a particular L7 pool. @@ -45,7 +47,8 @@ SoftLayer_Network_LBaaS_L7PoolMembersHealth provides statistics of members belon [l7PoolUuid]: #l7pooluuid #### [l7PoolUuid] Instance uuid of the L7 pool -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Instance uuid of the L7 pool [membersHealth]: #membershealth #### [membersHealth] Members statistics of the L7 pool -Type: **SoftLayer_Network_LBaaS_MemberHealth[] ** +Type: **SoftLayer_Network_LBaaS_MemberHealth[] ** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_L7Rule/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_L7Rule/_index.md index 7fcfe74332..e884faea7d 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_L7Rule/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_L7Rule/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_LBaaS_L7Rule represents the Rules that can be attached to a a L7 policy. @@ -45,7 +47,8 @@ The SoftLayer_Network_LBaaS_L7Rule represents the Rules that can be attached to [comparisonType]: #comparisontype #### [comparisonType] Comparision type for the Rule, It should any of the following values : REGEX, STARTS_WITH, ENDS_WITH, CONTAINS, EQUAL_TO. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Comparision type for the Rule, It should any of the following values : REGEX, ST [createDate]: #createdate #### [createDate] Specifies when a Rule was created -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ Specifies when a Rule was created [id]: #id #### [id] The ID of a Rule. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The ID of a Rule. [invert]: #invert #### [invert] Inverts the result of the value if set, i.e. True will be inverted to False and vice-versa -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Inverts the result of the value if set, i.e. True will be inverted to False and [key]: #key #### [key] Key for Rule type HEADER and COOKIE. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Key for Rule type HEADER and COOKIE. [modifyDate]: #modifydate #### [modifyDate] Specifies when a Rule was updated previously. -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ Specifies when a Rule was updated previously. [type]: #type #### [type] Type of the Rule. It should have any of the following values: HOST_NAME, FILE_TYPE, HEADER, COOKIE, PATH. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ Type of the Rule. It should have any of the following values: HOST_NAME, FILE_T [uuid]: #uuid #### [uuid] The UUID of a Rule. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The UUID of a Rule. [value]: #value #### [value] Value for Rule . For type HEADER and COOKIE, this value is compared against the value of the key from HEADER or COOKIE. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_L7SessionAffinity/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_L7SessionAffinity/_index.md index d4939c456f..87f6c3da77 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_L7SessionAffinity/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_L7SessionAffinity/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Network_LBaaS_L7SessionAffinity represents the session affinity, aka session persistence, configuration for a load balancer backend L7 pool. @@ -45,7 +47,8 @@ SoftLayer_Network_LBaaS_L7SessionAffinity represents the session affinity, aka s [type]: #type #### [type] Type of the session persistence -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ Type of the session persistence [l7Pool]: #l7pool #### [l7Pool] -Type: **SoftLayer_Network_LBaaS_L7Pool ** +Type: **SoftLayer_Network_LBaaS_L7Pool ** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_Listener/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_Listener/_index.md index 723d948cd8..207f75cc58 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_Listener/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_Listener/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_LBaaS_Listener type presents a data structure for a load balancers listener, also called frontend. @@ -45,7 +47,8 @@ The SoftLayer_Network_LBaaS_Listener type presents a data structure for a load b [clientTimeout]: #clienttimeout #### [clientTimeout] maximum idle time in seconds(Range: 1 to 7200), after which the load balancer brings down the -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ maximum idle time in seconds(Range: 1 to 7200), after which the load balancer br [connectionLimit]: #connectionlimit #### [connectionLimit] Limit of connections a listener can accept -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Limit of connections a listener can accept [createDate]: #createdate #### [createDate] Specifies when the listener was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ Specifies when the listener was created. [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Specifies when the listener was created. [modifyDate]: #modifydate #### [modifyDate] Specifies when the listener was updated previously. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ Specifies when the listener was updated previously. [protocol]: #protocol #### [protocol] Listeners protocol, one of "TCP", "HTTP", "HTTPS". -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ Listeners protocol, one of "TCP", "HTTP", "HTTPS". [protocolPort]: #protocolport #### [protocolPort] Listeners protocol port number. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ Listeners protocol port number. [provisioningStatus]: #provisioningstatus #### [provisioningStatus] The provisioning status of listener. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The provisioning status of listener. [serverTimeout]: #servertimeout #### [serverTimeout] maximum idle time in seconds(Range: 1 to 7200), after which the load balancer brings down the -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ maximum idle time in seconds(Range: 1 to 7200), after which the load balancer br [tlsCertificateId]: #tlscertificateid #### [tlsCertificateId] This references to SSL/TLS certificate (optional) for a listener -Type: **integer** +Type: **integer** + @@ -145,7 +157,8 @@ This references to SSL/TLS certificate (optional) for a listener [uuid]: #uuid #### [uuid] The UUID of a listener. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ The UUID of a listener. [defaultPool]: #defaultpool #### [defaultPool] -Type: **SoftLayer_Network_LBaaS_Pool ** +Type: **SoftLayer_Network_LBaaS_Pool ** + @@ -171,7 +185,8 @@ The UUID of a listener. [l7Policies]: #l7policies #### [l7Policies] -Type: **SoftLayer_Network_LBaaS_L7Policy[] ** +Type: **SoftLayer_Network_LBaaS_L7Policy[] ** + @@ -183,7 +198,8 @@ The UUID of a listener. [l7PolicyCount]: #l7policycount #### [l7PolicyCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancer/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancer/_index.md index dc49c5a0cf..8609d9e8f3 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancer/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancer/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_LBaaS_LoadBalancer type presents a structure containing attributes of a load balancer, and its related objects including listeners, pools and members. @@ -45,7 +47,8 @@ The SoftLayer_Network_LBaaS_LoadBalancer type presents a structure containing at [accountId]: #accountid #### [accountId] The account this load balancer belongs to. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The account this load balancer belongs to. [address]: #address #### [address] Address (Host name) of a load balancer. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Address (Host name) of a load balancer. [createDate]: #createdate #### [createDate] Specifies when a load balancer was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ Specifies when a load balancer was created. [description]: #description #### [description] Description of a load balancer. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ Description of a load balancer. [id]: #id #### [id] The unique identifier of a load balancer. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The unique identifier of a load balancer. [isDataLogEnabled]: #isdatalogenabled #### [isDataLogEnabled] Specifies whether the data log is enabled for the load balancer. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ Specifies whether the data log is enabled for the load balancer. [isPublic]: #ispublic #### [isPublic] Specifies whether the load balancer is a public or internal load balancer. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ Specifies whether the load balancer is a public or internal load balancer. [locationId]: #locationid #### [locationId] This references to location with type datacenter -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ This references to location with type datacenter [modifyDate]: #modifydate #### [modifyDate] Specifies when a load balancer was updated last. -Type: **dateTime** +Type: **dateTime** + @@ -135,7 +146,8 @@ Specifies when a load balancer was updated last. [name]: #name #### [name] The load balancer's name. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The load balancer's name. [operatingStatus]: #operatingstatus #### [operatingStatus] The operation status "ONLINE" or "OFFLINE" of a load balancer. -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ The operation status "ONLINE" or "OFFLINE" of a load balancer. [previousErrorText]: #previouserrortext #### [previousErrorText] Error message of previous API call in case of failure -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ Error message of previous API call in case of failure [provisioningStatus]: #provisioningstatus #### [provisioningStatus] The provisioning status of a load balancer. -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ The provisioning status of a load balancer. [type]: #type #### [type] Specifies the type of load balancer. -Type: **integer** +Type: **integer** + @@ -185,7 +201,8 @@ Specifies the type of load balancer. [useSystemPublicIpPool]: #usesystempublicippool #### [useSystemPublicIpPool] Applicable for public load balancer only. It specifies whether the public IP addresses are allocated from system public IP pool (1, default) or public subnet (null | 0) from the account ordering the load balancer. For internal load balancer, useSystemPublicIpPool will be ignored, and it always defaults to 1. -Type: **integer** +Type: **integer** + @@ -195,7 +212,8 @@ Applicable for public load balancer only. It specifies whether the public IP add [uuid]: #uuid #### [uuid] The UUID of a load balancer. -Type: **string** +Type: **string** + @@ -211,7 +229,8 @@ The UUID of a load balancer. [datacenter]: #datacenter #### [datacenter] Datacenter, where load balancer is located. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -221,7 +240,8 @@ Datacenter, where load balancer is located. [healthMonitors]: #healthmonitors #### [healthMonitors] Health monitors for the backend members. -Type: **SoftLayer_Network_LBaaS_HealthMonitor[] ** +Type: **SoftLayer_Network_LBaaS_HealthMonitor[] ** + @@ -231,7 +251,8 @@ Health monitors for the backend members. [l7Pools]: #l7pools #### [l7Pools] L7Pools for load balancer. -Type: **SoftLayer_Network_LBaaS_L7Pool[] ** +Type: **SoftLayer_Network_LBaaS_L7Pool[] ** + @@ -241,7 +262,8 @@ L7Pools for load balancer. [listeners]: #listeners #### [listeners] Listeners assigned to load balancer. -Type: **SoftLayer_Network_LBaaS_Listener[] ** +Type: **SoftLayer_Network_LBaaS_Listener[] ** + @@ -251,7 +273,8 @@ Listeners assigned to load balancer. [members]: #members #### [members] Members assigned to load balancer. -Type: **SoftLayer_Network_LBaaS_Member[] ** +Type: **SoftLayer_Network_LBaaS_Member[] ** + @@ -261,7 +284,8 @@ Members assigned to load balancer. [sslCiphers]: #sslciphers #### [sslCiphers] list of preferred custom ciphers configured for the load balancer. -Type: **SoftLayer_Network_LBaaS_SSLCipher[] ** +Type: **SoftLayer_Network_LBaaS_SSLCipher[] ** + @@ -273,7 +297,8 @@ list of preferred custom ciphers configured for the load balancer. [healthMonitorCount]: #healthmonitorcount #### [healthMonitorCount] A count of health monitors for the backend members. -Type: **unsigned long** +Type: **unsigned long** + @@ -283,7 +308,8 @@ A count of health monitors for the backend members. [l7PoolCount]: #l7poolcount #### [l7PoolCount] A count of l7Pools for load balancer. -Type: **unsigned long** +Type: **unsigned long** + @@ -293,7 +319,8 @@ A count of l7Pools for load balancer. [listenerCount]: #listenercount #### [listenerCount] A count of listeners assigned to load balancer. -Type: **unsigned long** +Type: **unsigned long** + @@ -303,7 +330,8 @@ A count of listeners assigned to load balancer. [memberCount]: #membercount #### [memberCount] A count of members assigned to load balancer. -Type: **unsigned long** +Type: **unsigned long** + @@ -313,7 +341,8 @@ A count of members assigned to load balancer. [sslCipherCount]: #sslciphercount #### [sslCipherCount] A count of list of preferred custom ciphers configured for the load balancer. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration/_index.md index 02cfb6b032..16d8e6f46d 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration specifies the check method to be used for health monitoring backend members. @@ -45,7 +47,8 @@ SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration specifies the che [backendPort]: #backendport #### [backendPort] Backends port -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Backends port [backendProtocol]: #backendprotocol #### [backendProtocol] Backends protocol. Valid values are "TCP", "HTTP" -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Backends protocol. Valid values are "TCP", "HTTP" [healthMonitorUuid]: #healthmonitoruuid #### [healthMonitorUuid] Health Monitor UUID, required for update only -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Health Monitor UUID, required for update only [interval]: #interval #### [interval] <<< EOT Interval in seconds to perform -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Health Monitor UUID, required for update only [maxRetries]: #maxretries #### [maxRetries] Max number of retries until the member is considered as DOWN -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ Max number of retries until the member is considered as DOWN [timeout]: #timeout #### [timeout] Health check methods timeout in -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ Health check methods timeout in [urlPath]: #urlpath #### [urlPath] If monitor is "HTTP", this specifies URL path -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerMonitoringMetricDataPoint/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerMonitoringMetricDataPoint/_index.md index 403fd006df..e56bb09fcf 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerMonitoringMetricDataPoint/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerMonitoringMetricDataPoint/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Network_LBaaS_LoadBalancerMonitoringMetricDataPoint is a collection of datapoints retrieved from a load balancer instance. The available metrics are:
      • The metric value
      • The timestamp when the metric value was obtained
      @@ -45,7 +47,8 @@ SoftLayer_Network_LBaaS_LoadBalancerMonitoringMetricDataPoint is a collection of [epochTimestamp]: #epochtimestamp #### [epochTimestamp] Epoch Time -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Epoch Time [value]: #value #### [value] a value -Type: **decimal** +Type: **decimal** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration/_index.md index 52db70e089..e6c49d71c6 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration specifies the protocol, port, maximum number of allowed connections and session stickiness for load balancer's front- and backend. @@ -45,7 +47,8 @@ SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration specifies the protocol [backendPort]: #backendport #### [backendPort] Backends port -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Backends port [backendProtocol]: #backendprotocol #### [backendProtocol] Backends protocol. Valid values are "TCP", "HTTP" -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Backends protocol. Valid values are "TCP", "HTTP" [clientTimeout]: #clienttimeout #### [clientTimeout] maximum idle time in seconds(Range: 1 to 7200), after which the load balancer brings down the client-side connection -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ maximum idle time in seconds(Range: 1 to 7200), after which the load balancer br [frontendPort]: #frontendport #### [frontendPort] Frontends port -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Frontends port [frontendProtocol]: #frontendprotocol #### [frontendProtocol] Frontends protocol. Valid values are "TCP", "HTTP" and "HTTPS" -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Frontends protocol. Valid values are "TCP", "HTTP" and "HTTPS" [listenerUuid]: #listeneruuid #### [listenerUuid] Listeners UUID, required for update only -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ Listeners UUID, required for update only [loadBalancingMethod]: #loadbalancingmethod #### [loadBalancingMethod] Load balancing method. Valid values are "ROUNDROBIN", "WEIGHTED_RR" and "LEASTCONNECTION" -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ Load balancing method. Valid values are "ROUNDROBIN", "WEIGHTED_RR" and "LEASTCO [maxConn]: #maxconn #### [maxConn] Maximum number of allowed connections -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ Maximum number of allowed connections [serverTimeout]: #servertimeout #### [serverTimeout] maximum idle time in seconds(Range: 1 to 7200), after which the load balancer brings down the server-side connection -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ maximum idle time in seconds(Range: 1 to 7200), after which the load balancer br [sessionCookieName]: #sessioncookiename #### [sessionCookieName] Sessions cookie name -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ Sessions cookie name [sessionType]: #sessiontype #### [sessionType] Session stickiness type. Valid values are "SOURCE_IP" "HTTP_COOKIE" -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ Session stickiness type. Valid values are "SOURCE_IP" "HTTP_COOKIE" [tlsCertificateId]: #tlscertificateid #### [tlsCertificateId] ssl/tls certificate id -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo/_index.md index 853ed2a889..b2cc06e113 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo specifies the application [privateIpAddress]: #privateipaddress #### [privateIpAddress] Servers private IP address -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Servers private IP address [publicIpAddress]: #publicipaddress #### [publicIpAddress] Servers public IP address -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Servers public IP address [weight]: #weight #### [weight] Load balancing weight for a server -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerStatistics/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerStatistics/_index.md index d365d6930e..f7cd3e8b34 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerStatistics/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancerStatistics/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Network_LBaaS_LoadBalancerStatistics is a collection of metrics retrieved from a load balancer instance. The available metrics are:
      • NUmber of members up
      • Number of members down
      • Total number of active connections
      • Throughput
      • Data processed by month
      • Connection rate
      @@ -45,7 +47,8 @@ SoftLayer_Network_LBaaS_LoadBalancerStatistics is a collection of metrics retrie [connectionRate]: #connectionrate #### [connectionRate] Number of connections seen at the -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Number of connections seen at the [dataProcessedByMonth]: #dataprocessedbymonth #### [dataProcessedByMonth] Data processed by month is the total of bin and bout -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Data processed by month is the total of bin and bout [numberOfMembersDown]: #numberofmembersdown #### [numberOfMembersDown] Number of members in DOWN health state -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ Number of members in DOWN health state [numberOfMembersUp]: #numberofmembersup #### [numberOfMembersUp] Number of members in UP health state -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Number of members in UP health state [throughput]: #throughput #### [throughput] Throughput measures the total number of bits -Type: **float** +Type: **float** + @@ -95,7 +102,8 @@ Throughput measures the total number of bits [totalConnections]: #totalconnections #### [totalConnections] Number of total active established connections -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_Member/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_Member/_index.md index ab854ec9c6..ad90302191 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_Member/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_Member/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_LBaaS_Member represents the backend member for a load bala [address]: #address #### [address] The IP address of a load balancer member. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The IP address of a load balancer member. [createDate]: #createdate #### [createDate] Specifies when a load balancers -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ Specifies when a load balancers [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ Specifies when a load balancers [modifyDate]: #modifydate #### [modifyDate] Specifies when a load balancers -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ Specifies when a load balancers [provisioningStatus]: #provisioningstatus #### [provisioningStatus] The provisioning status of a load balancer member. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The provisioning status of a load balancer member. [uuid]: #uuid #### [uuid] The UUID of a load balancer member. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The UUID of a load balancer member. [weight]: #weight #### [weight] The weight of a load balancer member. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_MemberHealth/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_MemberHealth/_index.md index 440477b061..1f945da27f 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_MemberHealth/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_MemberHealth/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Network_LBaaS_MemberHealth is a collection member metrics retrieved from a LBaaS VSI instance. The available metrics are:
      • Name of the member
      • Status of the member up or down
      • Uuid of the member
      @@ -45,7 +47,8 @@ SoftLayer_Network_LBaaS_MemberHealth is a collection member metrics retrieved fr [status]: #status #### [status] Members status (UP/DOWN). -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Members status (UP/DOWN). [uuid]: #uuid #### [uuid] Members UUID. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_PolicyRule/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_PolicyRule/_index.md index ab39a4a7b4..7c07dc2bce 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_PolicyRule/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_PolicyRule/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + 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.
      • The layer 7 policy object
      • An array of layer 7 rules
      @@ -49,7 +51,8 @@ This class contains layer 7 policy specifications and an array of associated rul [l7Policy]: #l7policy #### [l7Policy] L7 Policy -Type: **SoftLayer_Network_LBaaS_L7Policy ** +Type: **SoftLayer_Network_LBaaS_L7Policy ** + @@ -59,7 +62,8 @@ L7 Policy [l7Rules]: #l7rules #### [l7Rules] L7 Rules -Type: **SoftLayer_Network_LBaaS_L7Rule[] ** +Type: **SoftLayer_Network_LBaaS_L7Rule[] ** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_Pool/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_Pool/_index.md index 4c436997fd..fb4f3d22ee 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_Pool/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_Pool/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ The SoftLayer_Network_LBaaS_Pool type presents a structure containing attributes [createDate]: #createdate #### [createDate] Create date of the pool instance -Type: **dateTime** +Type: **dateTime** + @@ -60,7 +63,8 @@ Create date of the pool instance [loadBalancingAlgorithm]: #loadbalancingalgorithm #### [loadBalancingAlgorithm] Load balancing algorithm: "ROUNDROBIN", "WEIGHTED_RR", "LEASTCONNECTION" -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ Load balancing algorithm: "ROUNDROBIN", "WEIGHTED_RR", "LEASTCONNECTION" [modifyDate]: #modifydate #### [modifyDate] Last updated date of the pool -Type: **dateTime** +Type: **dateTime** + @@ -80,7 +85,8 @@ Last updated date of the pool [protocol]: #protocol #### [protocol] Backends protocol, supported protocols are "TCP", "HTTP" and "HTTPS" -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ Backends protocol, supported protocols are "TCP", "HTTP" and "HTTPS" [protocolPort]: #protocolport #### [protocolPort] Backends protocol port -Type: **integer** +Type: **integer** + @@ -100,7 +107,8 @@ Backends protocol port [provisioningStatus]: #provisioningstatus #### [provisioningStatus] Provisioning status of a load balancer pool. -Type: **string** +Type: **string** + @@ -110,7 +118,8 @@ Provisioning status of a load balancer pool. [uuid]: #uuid #### [uuid] Instance uuid of the pool -Type: **string** +Type: **string** + @@ -126,7 +135,8 @@ Instance uuid of the pool [healthMonitor]: #healthmonitor #### [healthMonitor] -Type: **SoftLayer_Network_LBaaS_HealthMonitor ** +Type: **SoftLayer_Network_LBaaS_HealthMonitor ** + @@ -136,7 +146,8 @@ Instance uuid of the pool [members]: #members #### [members] -Type: **SoftLayer_Network_LBaaS_Member[] ** +Type: **SoftLayer_Network_LBaaS_Member[] ** + @@ -146,7 +157,8 @@ Instance uuid of the pool [sessionAffinity]: #sessionaffinity #### [sessionAffinity] -Type: **SoftLayer_Network_LBaaS_SessionAffinity ** +Type: **SoftLayer_Network_LBaaS_SessionAffinity ** + @@ -158,7 +170,8 @@ Instance uuid of the pool [memberCount]: #membercount #### [memberCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_PoolMembersHealth/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_PoolMembersHealth/_index.md index 30196bcfdb..87a16c806c 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_PoolMembersHealth/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_PoolMembersHealth/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Network_LBaaS_PoolMembersHealth provides statistics of members belonging to a particular pool. @@ -45,7 +47,8 @@ SoftLayer_Network_LBaaS_PoolMembersHealth provides statistics of members belongi [membersHealth]: #membershealth #### [membersHealth] Members statistics of the pool -Type: **SoftLayer_Network_LBaaS_MemberHealth[] ** +Type: **SoftLayer_Network_LBaaS_MemberHealth[] ** + @@ -55,7 +58,8 @@ Members statistics of the pool [poolUuid]: #pooluuid #### [poolUuid] Instance uuid of the pool -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_SSLCipher/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_SSLCipher/_index.md index bad5749bc3..76f2647991 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_SSLCipher/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_SSLCipher/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_LBaaS_SSLCipher type presents a structure that contains attributes of load balancer cipher suites. @@ -47,7 +49,8 @@ The SoftLayer_Network_LBaaS_SSLCipher type presents a structure that contains at [id]: #id #### [id] Cipher identifier -Type: **integer** +Type: **integer** + @@ -57,7 +60,8 @@ Cipher identifier [name]: #name #### [name] Name of the cipher -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_LBaaS_SessionAffinity/_index.md b/content/reference/datatypes/SoftLayer_Network_LBaaS_SessionAffinity/_index.md index b285e20bc8..ddd5406348 100644 --- a/content/reference/datatypes/SoftLayer_Network_LBaaS_SessionAffinity/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LBaaS_SessionAffinity/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Network_LBaaS_SessionAffinity represents the session affinity, aka session persistence, configuration for a load balancer backend pool. @@ -45,7 +47,8 @@ SoftLayer_Network_LBaaS_SessionAffinity represents the session affinity, aka ses [type]: #type #### [type] Type of the session persistence -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ Type of the session persistence [pool]: #pool #### [pool] -Type: **SoftLayer_Network_LBaaS_Pool ** +Type: **SoftLayer_Network_LBaaS_Pool ** + diff --git a/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Account/_index.md b/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Account/_index.md index 1891984c52..7b2ce4ff18 100644 --- a/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Account/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Account/_index.md @@ -18,6 +18,9 @@ classes: ## Description + +
      Deprecated
      + The global load balancer service has been deprecated and is no longer available. @@ -51,7 +54,8 @@ The global load balancer service has been deprecated and is no longer available. [allowedNumberOfHosts]: #allowednumberofhosts #### [allowedNumberOfHosts] The maximum number of hosts that a global load balancer account is allowed to have. -Type: **integer** +Type: **integer** + @@ -61,7 +65,8 @@ The maximum number of hosts that a global load balancer account is allowed to ha [averageConnectionsPerSecond]: #averageconnectionspersecond #### [averageConnectionsPerSecond] The average amount of connections per second used within the current billing cycle. This number is updated daily. -Type: **float** +Type: **float** + @@ -71,7 +76,8 @@ The average amount of connections per second used within the current billing cyc [connectionsPerSecond]: #connectionspersecond #### [connectionsPerSecond] The amount of connections per second a global load balancer account may use within a billing cycle without being billed for an overage. -Type: **integer** +Type: **integer** + @@ -81,7 +87,8 @@ The amount of connections per second a global load balancer account may use with [fallbackIp]: #fallbackip #### [fallbackIp] The IP address that will be return to a DNS request when none of the hosts for a global load balancer account could be returned. -Type: **string** +Type: **string** + @@ -91,7 +98,8 @@ The IP address that will be return to a DNS request when none of the hosts for a [hostname]: #hostname #### [hostname] The hostname of a global load balancer account that is being load balanced. -Type: **string** +Type: **string** + @@ -101,7 +109,8 @@ The hostname of a global load balancer account that is being load balanced. [id]: #id #### [id] The unique identifier of a global load balancer account. -Type: **integer** +Type: **integer** + @@ -111,7 +120,8 @@ The unique identifier of a global load balancer account. [loadBalanceTypeId]: #loadbalancetypeid #### [loadBalanceTypeId] The identifier of the load balance method for a global load balancer account. -Type: **integer** +Type: **integer** + @@ -121,7 +131,8 @@ The identifier of the load balance method for a global load balancer account. [notes]: #notes #### [notes] Additional customer defined information for a global load balancer account. -Type: **string** +Type: **string** + @@ -137,7 +148,8 @@ Additional customer defined information for a global load balancer account. [account]: #account #### [account] Your SoftLayer customer account. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -147,7 +159,8 @@ Your SoftLayer customer account. [billingItem]: #billingitem #### [billingItem] The current billing item for a Global Load Balancer account. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -157,7 +170,8 @@ The current billing item for a Global Load Balancer account. [hosts]: #hosts #### [hosts] The hosts in the load balancing pool for a global load balancer account. -Type: **SoftLayer_Network_LoadBalancer_Global_Host[] ** +Type: **SoftLayer_Network_LoadBalancer_Global_Host[] ** + @@ -167,7 +181,8 @@ The hosts in the load balancing pool for a global load balancer account. [loadBalanceType]: #loadbalancetype #### [loadBalanceType] The load balance method of a global load balancer account -Type: **SoftLayer_Network_LoadBalancer_Global_Type ** +Type: **SoftLayer_Network_LoadBalancer_Global_Type ** + @@ -177,7 +192,8 @@ The load balance method of a global load balancer account [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the global load balancer is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -189,7 +205,8 @@ A flag indicating that the global load balancer is a managed resource. [hostCount]: #hostcount #### [hostCount] A count of the hosts in the load balancing pool for a global load balancer account. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Host/_index.md b/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Host/_index.md index 266d506e88..4d9c72d40d 100644 --- a/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Host/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Host/_index.md @@ -18,6 +18,9 @@ classes: ## Description + +
      Deprecated
      + The global load balancer service has been deprecated and is no longer available. @@ -51,7 +54,8 @@ The global load balancer service has been deprecated and is no longer available. [destinationIp]: #destinationip #### [destinationIp] The IP address of the host that will be returned by the global load balancers in response to a dns request. -Type: **string** +Type: **string** + @@ -61,7 +65,8 @@ The IP address of the host that will be returned by the global load balancers in [destinationPort]: #destinationport #### [destinationPort] The port of the host that will be used for health checks. -Type: **integer** +Type: **integer** + @@ -71,7 +76,8 @@ The port of the host that will be used for health checks. [enabled]: #enabled #### [enabled] Whether the host is enabled or not. The value can be '0' for disabled, or '1' for enabled. -Type: **integer** +Type: **integer** + @@ -81,7 +87,8 @@ Whether the host is enabled or not. The value can be '0' for disabled, or '1' f [healthCheck]: #healthcheck #### [healthCheck] The health check type of a host. Valid values include 'none', 'http', and 'tcp'. -Type: **string** +Type: **string** + @@ -91,7 +98,8 @@ The health check type of a host. Valid values include 'none', 'http', and 'tcp' [hits]: #hits #### [hits] The number of times the host was selected by the load balance method. -Type: **float** +Type: **float** + @@ -101,7 +109,8 @@ The number of times the host was selected by the load balance method. [id]: #id #### [id] The unique identifier of a global load balancer host. -Type: **integer** +Type: **integer** + @@ -111,7 +120,8 @@ The unique identifier of a global load balancer host. [loadBalanceOrder]: #loadbalanceorder #### [loadBalanceOrder] The order of this host within the load balance pool. This is only significant if the load balance method is set to failover. -Type: **integer** +Type: **integer** + @@ -121,7 +131,8 @@ The order of this host within the load balance pool. This is only significant i [location]: #location #### [location] The location of a host in a datacenter.serverRoom format. -Type: **string** +Type: **string** + @@ -131,7 +142,8 @@ The location of a host in a datacenter.serverRoom format. [status]: #status #### [status] The health status of a host. The status can be either 'UP', 'DOWN', or null which could mean that the health check type is set to 'none' or an update to the ip, port, or health check type was recently done and the host is waiting for the new status. -Type: **string** +Type: **string** + @@ -141,7 +153,8 @@ The health status of a host. The status can be either 'UP', 'DOWN', or null whi [weight]: #weight #### [weight] The load balance weight of a host. The total weight of all hosts in the load balancing pool must not exceed 100. -Type: **integer** +Type: **integer** + @@ -157,7 +170,8 @@ The load balance weight of a host. The total weight of all hosts in the load ba [loadBalancerAccount]: #loadbalanceraccount #### [loadBalancerAccount] The global load balancer account a host belongs to. -Type: **SoftLayer_Network_LoadBalancer_Global_Account ** +Type: **SoftLayer_Network_LoadBalancer_Global_Account ** + diff --git a/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Type/_index.md index 875a2b15a0..ba7fd5a290 100644 --- a/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Type/_index.md @@ -20,6 +20,9 @@ classes: ## Description + +
      Deprecated
      + The global load balancer service has been deprecated and is no longer available. The SoftLayer_Network_LoadBalancer_Global_Type data type represents a single load balance method that can be assigned to a global load balancer account. The load balance method determines how hosts in a load balancing pool are chosen by the global load balancers. @@ -49,7 +52,8 @@ The SoftLayer_Network_LoadBalancer_Global_Type data type represents a single loa [id]: #id #### [id] The unique identifier of a load balance method. -Type: **integer** +Type: **integer** + @@ -59,7 +63,8 @@ The unique identifier of a load balance method. [name]: #name #### [name] The name of a load balance method. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Service/_index.md b/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Service/_index.md index eae232b250..d61a3d3700 100644 --- a/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Service/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LoadBalancer_Service/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -52,7 +54,8 @@ Information retained on the object itself is the the source and destination of t [connectionLimit]: #connectionlimit #### [connectionLimit] Connection limit on this service. -Type: **integer** +Type: **integer** + @@ -62,7 +65,8 @@ Connection limit on this service. [createDate]: #createdate #### [createDate] Creation Date of this service -Type: **dateTime** +Type: **dateTime** + @@ -72,7 +76,8 @@ Creation Date of this service [destinationIpAddress]: #destinationipaddress #### [destinationIpAddress] The IP Address of the real server you wish to direct traffic to. Your account must own this IP -Type: **string** +Type: **string** + @@ -82,7 +87,8 @@ The IP Address of the real server you wish to direct traffic to. Your account m [destinationPort]: #destinationport #### [destinationPort] The port on the real server to direct the traffic. This can be different than the source port. If you wish to obfuscate your HTTP traffic, you can accept requests on port 80 on the load balancer, then redirect them to port 932 on your real server. -Type: **integer** +Type: **integer** + @@ -92,7 +98,8 @@ The port on the real server to direct the traffic. This can be different than t [enabled]: #enabled #### [enabled] A flag (either true or false) that determines if this particular service should be enabled on the load balancer. Set to false to bring the server out of rotation without losing your configuration -Type: **boolean** +Type: **boolean** + @@ -125,7 +132,8 @@ The health check type for this service. If one is supplied, the load balancer w |} -Type: **string** +Type: **string** + @@ -135,7 +143,8 @@ The health check type for this service. If one is supplied, the load balancer w [healthCheckURL]: #healthcheckurl #### [healthCheckURL] The URL provided here (starting with /) is what the load balancer will request in order to perform a custom HTTP health check. You must specify either "GET /location/of/file.html" or "HEAD /location/of/file.php" -Type: **string** +Type: **string** + @@ -145,7 +154,8 @@ The URL provided here (starting with /) is what the load balancer will request i [healthResponse]: #healthresponse #### [healthResponse] The expected response from the custom HTTP health check. If the requested page contains this response, the check succeeds. -Type: **string** +Type: **string** + @@ -155,7 +165,8 @@ The expected response from the custom HTTP health check. If the requested page [id]: #id #### [id] Unique ID for this object, used for the getObject method, and must be set if you are editing this object. -Type: **integer** +Type: **integer** + @@ -165,7 +176,8 @@ Unique ID for this object, used for the getObject method, and must be set if you [modifyDate]: #modifydate #### [modifyDate] Last modification date of this service -Type: **dateTime** +Type: **dateTime** + @@ -175,7 +187,8 @@ Last modification date of this service [name]: #name #### [name] Name of the load balancer service -Type: **string** +Type: **string** + @@ -185,7 +198,8 @@ Name of the load balancer service [notes]: #notes #### [notes] Holds whether this server is up or down. Does not affect load balancer configuration at all, just for the customer's informational purposes -Type: **string** +Type: **string** + @@ -195,7 +209,8 @@ Holds whether this server is up or down. Does not affect load balancer configur [peakConnections]: #peakconnections #### [peakConnections] Peak historical connections since the creation of this service. Is reset any time you make a configuration change -Type: **integer** +Type: **integer** + @@ -205,7 +220,8 @@ Peak historical connections since the creation of this service. Is reset any ti [sourcePort]: #sourceport #### [sourcePort] The port on the load balancer that this service maps to. This is the port for incoming traffic, it needs to be shared with other services to form a group. -Type: **integer** +Type: **integer** + @@ -215,7 +231,8 @@ The port on the load balancer that this service maps to. This is the port for i [type]: #type #### [type] The connection type of this service. Valid values are HTTP, FTP, TCP, UDP, and DNS. The value of this variable affects available values of healthCheck, listed in that variable's description -Type: **string** +Type: **string** + @@ -225,7 +242,8 @@ The connection type of this service. Valid values are HTTP, FTP, TCP, UDP, and [vipId]: #vipid #### [vipId] Unique ID for this object's parent. Probably not useful in the API, as this object will always be a child of a VirtualIpAddress anyway. -Type: **integer** +Type: **integer** + @@ -235,7 +253,8 @@ Unique ID for this object's parent. Probably not useful in the API, as this obj [weight]: #weight #### [weight] Weight affects the choices the load balancer makes between your services. The weight of each service is expressed as a percentage of the TOTAL CONNECTION LIMIT on the virtual IP Address. All services draw from the same pool of connections, so if you expect to have 4 times as much HTTP traffic as HTTPS, your weights for the above example routes would be 40%, 40%, 10%, 10% respectively. The weights should add up to 100% If you go over 100%, an exception will be thrown. Weights must be whole numbers, no fractions or decimals are accepted. -Type: **integer** +Type: **integer** + @@ -251,7 +270,8 @@ Weight affects the choices the load balancer makes between your services. The w [vip]: #vip #### [vip] The load balancer that this service belongs to. -Type: **SoftLayer_Network_LoadBalancer_VirtualIpAddress ** +Type: **SoftLayer_Network_LoadBalancer_VirtualIpAddress ** + diff --git a/content/reference/datatypes/SoftLayer_Network_LoadBalancer_VirtualIpAddress/_index.md b/content/reference/datatypes/SoftLayer_Network_LoadBalancer_VirtualIpAddress/_index.md index 14dfb69f40..50f16ac05e 100644 --- a/content/reference/datatypes/SoftLayer_Network_LoadBalancer_VirtualIpAddress/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_LoadBalancer_VirtualIpAddress/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -52,7 +54,8 @@ Information retained on the object itself is the virtual IP address, load balanc [connectionLimit]: #connectionlimit #### [connectionLimit] Connection limit on this VIP. Can be upgraded through the upgradeConnectionLimit() function -Type: **integer** +Type: **integer** + @@ -62,7 +65,8 @@ Connection limit on this VIP. Can be upgraded through the upgradeConnectionLimi [id]: #id #### [id] Unique ID for this object, used for the getObject method, and must be set if you are editing this object. -Type: **integer** +Type: **integer** + @@ -72,7 +76,8 @@ Unique ID for this object, used for the getObject method, and must be set if you [loadBalancingMethod]: #loadbalancingmethod #### [loadBalancingMethod] The load balancing method that determines which server is used "next" by the load balancer. The method is stored in an abbreviated form, represented in parentheses after the full name. Methods include: Round Robin (Value "rr"): Each server is used sequentially in a circular queue Shortest Response (Value "sr"): The server with the lowest ping at the last health check gets the next request Least Connections (Value "lc"): The server with the least current connections is given the next request Persistent IP - Round Robin (Value "pi"): The same server will be returned to a request during a users session. Servers are chosen through round robin. Persistent IP - Shortest Response (Value "pi-sr"): The same server will be returned to a request during a users session. Servers are chosen through shortest response. Persistent IP - Least Connections (Value "pi-lc"): The same server will be returned to a request during a users session. Servers are chosen through least connections. Insert Cookie - Round Robin (Value "ic"): Inserts a cookie into the HTTP stream that will tie that client to a particular balanced server. Servers are chosen through round robin. Insert Cookie - Shortest Response (Value "ic-sr"): Inserts a cookie into the HTTP stream that will tie that client to a particular balanced server. Servers are chosen through shortest response. Insert Cookie - Least Connections (Value "ic-lc"): Inserts a cookie into the HTTP stream that will tie that client to a particular balanced server. Servers are chosen through least connections. -Type: **string** +Type: **string** + @@ -82,7 +87,8 @@ The load balancing method that determines which server is used "next" by the loa [loadBalancingMethodFullName]: #loadbalancingmethodfullname #### [loadBalancingMethodFullName] A human readable version of loadBalancingMethod, intended mainly for API users. -Type: **string** +Type: **string** + @@ -92,7 +98,8 @@ A human readable version of loadBalancingMethod, intended mainly for API users. [modifyDate]: #modifydate #### [modifyDate] Date this load balancer was last modified -Type: **dateTime** +Type: **dateTime** + @@ -102,7 +109,8 @@ Date this load balancer was last modified [name]: #name #### [name] The name of the load balancer instance -Type: **string** +Type: **string** + @@ -112,7 +120,8 @@ The name of the load balancer instance [notes]: #notes #### [notes] User-created notes on this load balancer. -Type: **string** +Type: **string** + @@ -122,7 +131,8 @@ User-created notes on this load balancer. [securityCertificateId]: #securitycertificateid #### [securityCertificateId] The unique identifier of the Security Certificate to be utilized when SSL support is enabled. -Type: **integer** +Type: **integer** + @@ -132,7 +142,8 @@ The unique identifier of the Security Certificate to be utilized when SSL suppor [sourcePort]: #sourceport #### [sourcePort] This is the port for incoming traffic. -Type: **integer** +Type: **integer** + @@ -142,7 +153,8 @@ This is the port for incoming traffic. [type]: #type #### [type] The connection type of this VIP. Valid values are HTTP, FTP, TCP, UDP, and DNS. -Type: **string** +Type: **string** + @@ -152,7 +164,8 @@ The connection type of this VIP. Valid values are HTTP, FTP, TCP, UDP, and DNS. [virtualIpAddress]: #virtualipaddress #### [virtualIpAddress] The virtual, public-facing IP address for your load balancer. This is the address of all incoming traffic -Type: **string** +Type: **string** + @@ -168,7 +181,8 @@ The virtual, public-facing IP address for your load balancer. This is the addre [account]: #account #### [account] The account that owns this load balancer. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -178,7 +192,8 @@ The account that owns this load balancer. [billingItem]: #billingitem #### [billingItem] The current billing item for the Load Balancer. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -188,7 +203,8 @@ The current billing item for the Load Balancer. [customerManagedFlag]: #customermanagedflag #### [customerManagedFlag] If false, this VIP and associated services may be edited via the portal or the API. If true, you must configure this VIP manually on the device. -Type: **integer** +Type: **integer** + @@ -198,7 +214,8 @@ If false, this VIP and associated services may be edited via the portal or the A [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the load balancer is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -208,7 +225,8 @@ A flag indicating that the load balancer is a managed resource. [services]: #services #### [services] the services on this load balancer. -Type: **SoftLayer_Network_LoadBalancer_Service[] ** +Type: **SoftLayer_Network_LoadBalancer_Service[] ** + @@ -220,7 +238,8 @@ the services on this load balancer. [serviceCount]: #servicecount #### [serviceCount] A count of the services on this load balancer. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Logging_Syslog/_index.md b/content/reference/datatypes/SoftLayer_Network_Logging_Syslog/_index.md index fc1f78eb47..a9c7be6476 100644 --- a/content/reference/datatypes/SoftLayer_Network_Logging_Syslog/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Logging_Syslog/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The Syslog class holds a single line from the Networking Firewall "Syslog" record, for firewall detected and blocked attempts on a server. @@ -45,7 +47,8 @@ The Syslog class holds a single line from the Networking Firewall "Syslog" recor [createDate]: #createdate #### [createDate] Timestamp for when the connection was blocked by the firewall -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ Timestamp for when the connection was blocked by the firewall [destinationIpAddress]: #destinationipaddress #### [destinationIpAddress] The Destination IP Address of the blocked connection (your end) -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The Destination IP Address of the blocked connection (your end) [destinationPort]: #destinationport #### [destinationPort] The Destination Port of the blocked connection (your end) -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The Destination Port of the blocked connection (your end) [eventType]: #eventtype #### [eventType] This tells you what kind of firewall event this log line is for: accept or deny. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ This tells you what kind of firewall event this log line is for: accept or deny [message]: #message #### [message] Raw syslog message for the event -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Raw syslog message for the event [protocol]: #protocol #### [protocol] Connection protocol used to make the call that was blocked (tcp, udp, etc) -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ Connection protocol used to make the call that was blocked (tcp, udp, etc) [sourceIpAddress]: #sourceipaddress #### [sourceIpAddress] The Source IP Address of the call that was blocked (attacker's end) -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The Source IP Address of the call that was blocked (attacker's end) [sourcePort]: #sourceport #### [sourcePort] The Source Port where the blocked connection was established (attacker's end) -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ The Source Port where the blocked connection was established (attacker's end) [totalEvents]: #totalevents #### [totalEvents] If this is an aggregation of syslog events, this property shows the total events. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Network_Media_Transcode_Account/_index.md b/content/reference/datatypes/SoftLayer_Network_Media_Transcode_Account/_index.md index 3d8188228e..c8da1fba65 100644 --- a/content/reference/datatypes/SoftLayer_Network_Media_Transcode_Account/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Media_Transcode_Account/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Media_Transcode_Account contains information regarding a transcode account. @@ -45,7 +47,8 @@ The SoftLayer_Network_Media_Transcode_Account contains information regarding a t [accountId]: #accountid #### [accountId] The internal identifier of a SoftLayer account -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of a SoftLayer account [createDate]: #createdate #### [createDate] The created date -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The created date [id]: #id #### [id] The internal identifier of a transcode account -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The internal identifier of a transcode account [modifyDate]: #modifydate #### [modifyDate] The last modified date -Type: **dateTime** +Type: **dateTime** + @@ -91,7 +97,8 @@ The last modified date [account]: #account #### [account] The SoftLayer account information -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -101,7 +108,8 @@ The SoftLayer account information [transcodeJobs]: #transcodejobs #### [transcodeJobs] Transcode jobs -Type: **SoftLayer_Network_Media_Transcode_Job[] ** +Type: **SoftLayer_Network_Media_Transcode_Job[] ** + @@ -113,7 +121,8 @@ Transcode jobs [transcodeJobCount]: #transcodejobcount #### [transcodeJobCount] A count of transcode jobs -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Media_Transcode_Job/_index.md b/content/reference/datatypes/SoftLayer_Network_Media_Transcode_Job/_index.md index e9045a0711..375c7e8db4 100644 --- a/content/reference/datatypes/SoftLayer_Network_Media_Transcode_Job/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Media_Transcode_Job/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Media_Transcode_Job contains information regarding a transcode job such as input file, output format, user id and so on. @@ -45,7 +47,8 @@ The SoftLayer_Network_Media_Transcode_Job contains information regarding a trans [autoDeleteDuration]: #autodeleteduration #### [autoDeleteDuration] The auto-deletion duration in seconds. This value determines how long the input file will be kept on the storage. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The auto-deletion duration in seconds. This value determines how long the input [byteIn]: #bytein #### [byteIn] The size of an input file in byte -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The size of an input file in byte [createDate]: #createdate #### [createDate] The created date -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The created date [id]: #id #### [id] The internal identifier of a transcode job -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The internal identifier of a transcode job [inputFile]: #inputfile #### [inputFile] The input file name -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The input file name [modifyDate]: #modifydate #### [modifyDate] The last modified date -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ The last modified date [name]: #name #### [name] The name of a transcode job -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The name of a transcode job [outputFile]: #outputfile #### [outputFile] The output file name -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The output file name [transcodeAccountId]: #transcodeaccountid #### [transcodeAccountId] The internal identifier of SoftLayer account -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ The internal identifier of SoftLayer account [transcodeJobGuid]: #transcodejobguid #### [transcodeJobGuid] The unique id of a transcode job -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The unique id of a transcode job [transcodePresetGuid]: #transcodepresetguid #### [transcodePresetGuid] The unique id of a pre-defined output format -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ The unique id of a pre-defined output format [transcodePresetName]: #transcodepresetname #### [transcodePresetName] The name of a transcode output preset -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ The name of a transcode output preset [transcodeStatusId]: #transcodestatusid #### [transcodeStatusId] The internal identifier of a transcode status -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ The internal identifier of a transcode status [userId]: #userid #### [userId] The internal identifier of the user who created a transcode job -Type: **integer** +Type: **integer** + @@ -185,7 +201,8 @@ The internal identifier of the user who created a transcode job [watermark]: #watermark #### [watermark] Watermark to apply to job -Type: **SoftLayer_Container_Network_Media_Transcode_Job_Watermark ** +Type: **SoftLayer_Container_Network_Media_Transcode_Job_Watermark ** + @@ -201,7 +218,8 @@ Watermark to apply to job [history]: #history #### [history] -Type: **SoftLayer_Network_Media_Transcode_Job_History[] ** +Type: **SoftLayer_Network_Media_Transcode_Job_History[] ** + @@ -211,7 +229,8 @@ Watermark to apply to job [transcodeAccount]: #transcodeaccount #### [transcodeAccount] The transcode service account -Type: **SoftLayer_Network_Media_Transcode_Account ** +Type: **SoftLayer_Network_Media_Transcode_Account ** + @@ -221,7 +240,8 @@ The transcode service account [transcodeStatus]: #transcodestatus #### [transcodeStatus] The status information of a transcode job -Type: **SoftLayer_Network_Media_Transcode_Job_Status ** +Type: **SoftLayer_Network_Media_Transcode_Job_Status ** + @@ -231,7 +251,8 @@ The status information of a transcode job [transcodeStatusName]: #transcodestatusname #### [transcodeStatusName] The status of a transcode job -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ The status of a transcode job [user]: #user #### [user] The SoftLayer user that created the transcode job -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -253,7 +275,8 @@ The SoftLayer user that created the transcode job [historyCount]: #historycount #### [historyCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Media_Transcode_Job_History/_index.md b/content/reference/datatypes/SoftLayer_Network_Media_Transcode_Job_History/_index.md index 25da07118c..116684e0ca 100644 --- a/content/reference/datatypes/SoftLayer_Network_Media_Transcode_Job_History/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Media_Transcode_Job_History/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] The creation date -Type: **dateTime** +Type: **dateTime** +
      @@ -55,7 +58,8 @@ The creation date [publicNotes]: #publicnotes #### [publicNotes] The note created by system -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ The note created by system [transcodeJobId]: #transcodejobid #### [transcodeJobId] The internal identifier of a transcode job -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ The internal identifier of a transcode job [transcodeStatusName]: #transcodestatusname #### [transcodeStatusName] The status of a transcode job -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Media_Transcode_Job_Status/_index.md b/content/reference/datatypes/SoftLayer_Network_Media_Transcode_Job_Status/_index.md index 69df7370ac..788bfc126b 100644 --- a/content/reference/datatypes/SoftLayer_Network_Media_Transcode_Job_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Media_Transcode_Job_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Media_Transcode_Job_Status contains information on a transcode job status. @@ -45,7 +47,8 @@ The SoftLayer_Network_Media_Transcode_Job_Status contains information on a trans [description]: #description #### [description] The description of a transcode job status -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The description of a transcode job status [id]: #id #### [id] The internal identifier of a transcode job status -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The internal identifier of a transcode job status [name]: #name #### [name] The status name -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Message_Delivery/_index.md b/content/reference/datatypes/SoftLayer_Network_Message_Delivery/_index.md index 45aa5d53cc..4038790f73 100644 --- a/content/reference/datatypes/SoftLayer_Network_Message_Delivery/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Message_Delivery/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
      @@ -65,7 +69,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ classes: [password]: #password #### [password] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [typeId]: #typeid #### [typeId] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [username]: #username #### [username] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [vendorId]: #vendorid #### [vendorId] -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ classes: [account]: #account #### [account] The SoftLayer customer account that a network message delivery account belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -141,7 +152,8 @@ The SoftLayer customer account that a network message delivery account belongs t [billingItem]: #billingitem #### [billingItem] The billing item for a network message delivery account. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -151,7 +163,8 @@ The billing item for a network message delivery account. [type]: #type #### [type] The message delivery type of a network message delivery account. -Type: **SoftLayer_Network_Message_Delivery_Type ** +Type: **SoftLayer_Network_Message_Delivery_Type ** + @@ -161,7 +174,8 @@ The message delivery type of a network message delivery account. [vendor]: #vendor #### [vendor] The vendor for a network message delivery account. -Type: **SoftLayer_Network_Message_Delivery_Vendor ** +Type: **SoftLayer_Network_Message_Delivery_Vendor ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Message_Delivery_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Network_Message_Delivery_Attribute/_index.md index 727938be0a..96485e0f17 100644 --- a/content/reference/datatypes/SoftLayer_Network_Message_Delivery_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Message_Delivery_Attribute/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [value]: #value #### [value] -Type: **string** +Type: **string** +
      @@ -61,7 +64,8 @@ classes: [networkMessageDelivery]: #networkmessagedelivery #### [networkMessageDelivery] -Type: **SoftLayer_Network_Message_Delivery ** +Type: **SoftLayer_Network_Message_Delivery ** +
      diff --git a/content/reference/datatypes/SoftLayer_Network_Message_Delivery_Email_Sendgrid/_index.md b/content/reference/datatypes/SoftLayer_Network_Message_Delivery_Email_Sendgrid/_index.md index dda5600535..c3307addac 100644 --- a/content/reference/datatypes/SoftLayer_Network_Message_Delivery_Email_Sendgrid/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Message_Delivery_Email_Sendgrid/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
      @@ -65,7 +69,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ classes: [password]: #password #### [password] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [typeId]: #typeid #### [typeId] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [username]: #username #### [username] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ classes: [vendorId]: #vendorid #### [vendorId] -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ classes: [account]: #account #### [account] The SoftLayer customer account that a network message delivery account belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -141,7 +152,8 @@ The SoftLayer customer account that a network message delivery account belongs t [billingItem]: #billingitem #### [billingItem] The billing item for a network message delivery account. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -151,7 +163,8 @@ The billing item for a network message delivery account. [emailAddress]: #emailaddress #### [emailAddress] The contact e-mail address used by SendGrid. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ The contact e-mail address used by SendGrid. [smtpAccess]: #smtpaccess #### [smtpAccess] A flag that determines if a SendGrid e-mail delivery account has access to send mail through the SendGrid SMTP server. -Type: **string** +Type: **string** + @@ -171,7 +185,8 @@ A flag that determines if a SendGrid e-mail delivery account has access to send [type]: #type #### [type] The message delivery type of a network message delivery account. -Type: **SoftLayer_Network_Message_Delivery_Type ** +Type: **SoftLayer_Network_Message_Delivery_Type ** + @@ -181,7 +196,8 @@ The message delivery type of a network message delivery account. [vendor]: #vendor #### [vendor] The vendor for a network message delivery account. -Type: **SoftLayer_Network_Message_Delivery_Vendor ** +Type: **SoftLayer_Network_Message_Delivery_Vendor ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Message_Delivery_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Message_Delivery_Type/_index.md index f8d94d38fd..bf446aed1b 100644 --- a/content/reference/datatypes/SoftLayer_Network_Message_Delivery_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Message_Delivery_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Message_Delivery_Vendor/_index.md b/content/reference/datatypes/SoftLayer_Network_Message_Delivery_Vendor/_index.md index 9c185090a6..0fbe5fe3dc 100644 --- a/content/reference/datatypes/SoftLayer_Network_Message_Delivery_Vendor/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Message_Delivery_Vendor/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Incident/_index.md b/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Incident/_index.md index 0932a01faa..1ee3eda150 100644 --- a/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Incident/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Incident/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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". @@ -55,7 +57,8 @@ The SoftLayer_Network_Monitor_Version1_Incident data type models a single virtua [status]: #status #### [status] A network monitoring incident's status, either the string "SERVICE FAILURE" denoting an ongoing incident or "COMPLETE" meaning the incident has been resolved. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_Host/_index.md b/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_Host/_index.md index 90e5dd84e9..65a91591b5 100644 --- a/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_Host/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_Host/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ The Monitoring_Query_Host type represents a monitoring instance. It consists of [arg1Value]: #arg1value #### [arg1Value] The argument to be used for this monitor, if necessary. The lowest monitoring levels (like ping) ignore this setting, but higher levels like HTTP custom use it. -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ The argument to be used for this monitor, if necessary. The lowest monitoring l [guestId]: #guestid #### [guestId] Virtual Guest Identification Number for the guest being monitored. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ Virtual Guest Identification Number for the guest being monitored. [hardwareId]: #hardwareid #### [hardwareId] The ID of the hardware being monitored -Type: **integer** +Type: **integer** + @@ -80,7 +85,8 @@ The ID of the hardware being monitored [hostId]: #hostid #### [hostId] Identification Number for the host being monitored. -Type: **integer** +Type: **integer** + @@ -90,7 +96,8 @@ Identification Number for the host being monitored. [id]: #id #### [id] The unique identifier for this object -Type: **integer** +Type: **integer** + @@ -100,7 +107,8 @@ The unique identifier for this object [ipAddress]: #ipaddress #### [ipAddress] The IP address to be monitored. Must be attached to the hardware on this object -Type: **string** +Type: **string** + @@ -110,7 +118,8 @@ The IP address to be monitored. Must be attached to the hardware on this object [queryTypeId]: #querytypeid #### [queryTypeId] The ID of the query type to use. -Type: **integer** +Type: **integer** + @@ -120,7 +129,8 @@ The ID of the query type to use. [responseActionId]: #responseactionid #### [responseActionId] The ID of the response action to take when the monitor fails -Type: **integer** +Type: **integer** + @@ -130,7 +140,8 @@ The ID of the response action to take when the monitor fails [status]: #status #### [status] The status of this monitoring instance. Anything other than "ON" means that the monitor has been disabled -Type: **string** +Type: **string** + @@ -140,7 +151,8 @@ The status of this monitoring instance. Anything other than "ON" means that the [waitCycles]: #waitcycles #### [waitCycles] The number of 5-minute cycles to wait before the "responseAction" is taken. If set to 0, the response action will be taken immediately -Type: **integer** +Type: **integer** + @@ -156,7 +168,8 @@ The number of 5-minute cycles to wait before the "responseAction" is taken. If [hardware]: #hardware #### [hardware] The hardware that is being monitored by this monitoring instance -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -166,7 +179,8 @@ The hardware that is being monitored by this monitoring instance [lastResult]: #lastresult #### [lastResult] The most recent result for this particular monitoring instance. -Type: **SoftLayer_Network_Monitor_Version1_Query_Result ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Result ** + @@ -176,7 +190,8 @@ The most recent result for this particular monitoring instance. [queryType]: #querytype #### [queryType] The type of monitoring query that is executed when this hardware is monitored. -Type: **SoftLayer_Network_Monitor_Version1_Query_Type ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Type ** + @@ -186,7 +201,8 @@ The type of monitoring query that is executed when this hardware is monitored. [responseAction]: #responseaction #### [responseAction] The action taken when a monitor fails. -Type: **SoftLayer_Network_Monitor_Version1_Query_ResponseType ** +Type: **SoftLayer_Network_Monitor_Version1_Query_ResponseType ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/_index.md b/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/_index.md index 2cc480cd98..78ced3171f 100644 --- a/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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: @@ -52,7 +54,8 @@ Also note that the query type and response types are available through getAllQue [monitorLevel]: #monitorlevel #### [monitorLevel] The highest level of a monitoring query type allowed on this server -Type: **integer** +Type: **integer** + @@ -62,7 +65,8 @@ The highest level of a monitoring query type allowed on this server [responseLevel]: #responselevel #### [responseLevel] The highest level of a monitoring response type allowed on this server -Type: **integer** +Type: **integer** + @@ -78,7 +82,8 @@ The highest level of a monitoring response type allowed on this server [hardware]: #hardware #### [hardware] The hardware object that these monitoring permissions applies to. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_ResponseType/_index.md b/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_ResponseType/_index.md index 53c3fe2b72..9136d3db24 100644 --- a/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_ResponseType/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_ResponseType/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -52,7 +54,8 @@ The user can retrieve all available ResponseTypes with the getAllObjects method [actionDescription]: #actiondescription #### [actionDescription] The description of the action the monitoring system will take on failure -Type: **string** +Type: **string** + @@ -62,7 +65,8 @@ The description of the action the monitoring system will take on failure [id]: #id #### [id] The unique identifier for this object -Type: **integer** +Type: **integer** + @@ -72,7 +76,8 @@ The unique identifier for this object [level]: #level #### [level] The level of this response. The level the customer has access to is determined by values in SoftLayer_Network_Monitor_Version1_Query_Host_Stratum -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_Result/_index.md b/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_Result/_index.md index ddf4e603bc..5dd05e65cf 100644 --- a/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_Result/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_Result/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + 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. @@ -49,7 +51,8 @@ In general, only the responseStatus variable is needed, as it holds the informat [finishTime]: #finishtime #### [finishTime] The timestamp of when this monitor was co -Type: **dateTime** +Type: **dateTime** + @@ -59,7 +62,8 @@ The timestamp of when this monitor was co [responseStatus]: #responsestatus #### [responseStatus] The response status for this server. The response status meanings are: 0: Down/Critical: Server is down and/or has passed the critical response threshold (extremely long ping response, abnormal behavior, etc.) 1: Warning - Server may be recovering from a previous down state, or may have taken too long to respond 2: Up 3: Not used 4: Unknown - An unknown error has occurred. If the problem persists, contact support. 5: Unknown - An unknown error has occurred. If the problem persists, contact support. -Type: **integer** +Type: **integer** + @@ -69,7 +73,8 @@ The response status for this server. The response status meanings are: 0: Down [responseTime]: #responsetime #### [responseTime] The length of time it took the server to respond -Type: **float** +Type: **float** + @@ -85,7 +90,8 @@ The length of time it took the server to respond [queryHost]: #queryhost #### [queryHost] References the queryHost that this response relates to. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_Type/_index.md index 60310726a4..820b0e755c 100644 --- a/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Monitor_Version1_Query_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -52,7 +54,8 @@ The user can retrieve all available Query Types with the getAllObjects method on [argumentDescription]: #argumentdescription #### [argumentDescription] The type of parameter sent to the monitoring command. -Type: **string** +Type: **string** + @@ -62,7 +65,8 @@ The type of parameter sent to the monitoring command. [description]: #description #### [description] Long description of the monitoring type. -Type: **string** +Type: **string** + @@ -72,7 +76,8 @@ Long description of the monitoring type. [id]: #id #### [id] The unique identifier for this object -Type: **integer** +Type: **integer** + @@ -82,7 +87,8 @@ The unique identifier for this object [monitorLevel]: #monitorlevel #### [monitorLevel] The level of this monitoring type. The level the customer has access to is determined by values in SoftLayer_Network_Monitor_Version1_Query_Host_Stratum -Type: **integer** +Type: **integer** + @@ -92,7 +98,8 @@ The level of this monitoring type. The level the customer has access to is dete [name]: #name #### [name] Short name of the monitoring type -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Pod/_index.md b/content/reference/datatypes/SoftLayer_Network_Pod/_index.md index 8228e5a96c..827c256522 100644 --- a/content/reference/datatypes/SoftLayer_Network_Pod/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Pod/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [backendRouterId]: #backendrouterid #### [backendRouterId] Identifier for this Pod's Backend Customer Router (BCR) -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ Identifier for this Pod's Backend Customer Router (BCR) [backendRouterName]: #backendroutername #### [backendRouterName] Host name of Pod's Backend Customer Router (BCR), e.g. bcr01a.dal09 -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ Host name of Pod's Backend Customer Router (BCR), e.g. bcr01a.dal09 [capabilities]: #capabilities #### [capabilities] Property providing a means to filter Pods based on available capabitilies. See [SoftLayer_Network_Pod::getAllObjects]({{}}) to filter for Pods with specific capabilities. See [SoftLayer_Network_Pod::getCapabilities]({{}}) to retrieve capabilities of a specific Pod. -Type: **array of strings** +Type: **array of strings** + @@ -75,7 +80,8 @@ Property providing a means to filter Pods based on available capabitilies. See [ [datacenterId]: #datacenterid #### [datacenterId] Identifier for the Data Center the Pod resides within -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Identifier for the Data Center the Pod resides within [datacenterLongName]: #datacenterlongname #### [datacenterLongName] Long form name of the data center in which this Pod resides, e.g. Dallas 9 -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Long form name of the data center in which this Pod resides, e.g. Dallas 9 [datacenterName]: #datacentername #### [datacenterName] Name of data center in which this Pod resides, e.g. dal09 -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ Name of data center in which this Pod resides, e.g. dal09 [frontendRouterId]: #frontendrouterid #### [frontendRouterId] (optional) Identifier for this Pod's Frontend Customer Router (FCR) -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ Name of data center in which this Pod resides, e.g. dal09 [frontendRouterName]: #frontendroutername #### [frontendRouterName] (optional) Host name of Pod's Frontend Customer Router (FCR), e.g. fcr01a.dal09 -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ Name of data center in which this Pod resides, e.g. dal09 [name]: #name #### [name] The unique name of the Pod. See [SoftLayer_Network_Pod]({{}}) for details of the name's construction. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Protection_Address/_index.md b/content/reference/datatypes/SoftLayer_Network_Protection_Address/_index.md index cbaa96e024..5d323cb16f 100644 --- a/content/reference/datatypes/SoftLayer_Network_Protection_Address/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Protection_Address/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [departmentId]: #departmentid #### [departmentId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [ipAddress]: #ipaddress #### [ipAddress] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [managementMethodType]: #managementmethodtype #### [managementMethodType] -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ classes: [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -91,7 +97,8 @@ classes: [location]: #location #### [location] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -101,7 +108,8 @@ classes: [modifiedUser]: #modifieduser #### [modifiedUser] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -111,17 +119,20 @@ classes: [primaryRouter]: #primaryrouter #### [primaryRouter] -Type: **SoftLayer_Hardware_Router ** +Type: **SoftLayer_Hardware_Router ** + -
      +
      ----- [serviceProvider]: #serviceprovider #### [serviceProvider] DEPRECATED -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + +Deprecated
      @@ -131,7 +142,8 @@ DEPRECATED [subnet]: #subnet #### [subnet] -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** +
      @@ -141,7 +153,8 @@ DEPRECATED [subnetIpAddress]: #subnetipaddress #### [subnetIpAddress] -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -151,7 +164,8 @@ DEPRECATED [terminatedUser]: #terminateduser #### [terminatedUser] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -161,7 +175,8 @@ DEPRECATED [ticket]: #ticket #### [ticket] -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -171,7 +186,8 @@ DEPRECATED [transactions]: #transactions #### [transactions] -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + @@ -181,7 +197,8 @@ DEPRECATED [userDepartment]: #userdepartment #### [userDepartment] -Type: **SoftLayer_User_Employee_Department ** +Type: **SoftLayer_User_Employee_Department ** + @@ -191,7 +208,8 @@ DEPRECATED [userRecord]: #userrecord #### [userRecord] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -203,7 +221,8 @@ DEPRECATED [transactionCount]: #transactioncount #### [transactionCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Regional_Internet_Registry/_index.md b/content/reference/datatypes/SoftLayer_Network_Regional_Internet_Registry/_index.md index 6e9cbc5720..327ac4b272 100644 --- a/content/reference/datatypes/SoftLayer_Network_Regional_Internet_Registry/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Regional_Internet_Registry/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ Regional Internet Registries are the organizations who delegate IP address block [id]: #id #### [id] Unique ID of the object -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Unique ID of the object [keyName]: #keyname #### [keyName] The system-level name of the registry -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The system-level name of the registry [name]: #name #### [name] The friendly name of the registry -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_SecurityGroup/_index.md b/content/reference/datatypes/SoftLayer_Network_SecurityGroup/_index.md index ffb651456b..58e4d401ed 100644 --- a/content/reference/datatypes/SoftLayer_Network_SecurityGroup/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_SecurityGroup/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) to associate virtual guest network components with the security group. @@ -45,7 +47,8 @@ The SoftLayer_Network_SecurityGroup data type contains general information for a [createDate]: #createdate #### [createDate] The date a security group was created. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The date a security group was created. [description]: #description #### [description] The (optional) description for a security group. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The (optional) description for a security group. [id]: #id #### [id] The unique ID for a security group. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The unique ID for a security group. [metadata]: #metadata #### [metadata] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The unique ID for a security group. [modifyDate]: #modifydate #### [modifyDate] The date a security group was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date a security group was last modified. [name]: #name #### [name] The (optional) name for a security group. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ The (optional) name for a security group. [account]: #account #### [account] The account this security group belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -121,7 +130,8 @@ The account this security group belongs to. [networkComponentBindings]: #networkcomponentbindings #### [networkComponentBindings] The network component bindings for this security group. -Type: **SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding[] ** +Type: **SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding[] ** + @@ -131,7 +141,8 @@ The network component bindings for this security group. [orderBindings]: #orderbindings #### [orderBindings] The order bindings for this security group -Type: **SoftLayer_Network_SecurityGroup_OrderBinding[] ** +Type: **SoftLayer_Network_SecurityGroup_OrderBinding[] ** + @@ -141,7 +152,8 @@ The order bindings for this security group [rules]: #rules #### [rules] The rules for this security group. -Type: **SoftLayer_Network_SecurityGroup_Rule[] ** +Type: **SoftLayer_Network_SecurityGroup_Rule[] ** + @@ -153,7 +165,8 @@ The rules for this security group. [networkComponentBindingCount]: #networkcomponentbindingcount #### [networkComponentBindingCount] A count of the network component bindings for this security group. -Type: **unsigned long** +Type: **unsigned long** + @@ -163,7 +176,8 @@ A count of the network component bindings for this security group. [orderBindingCount]: #orderbindingcount #### [orderBindingCount] A count of the order bindings for this security group -Type: **unsigned long** +Type: **unsigned long** + @@ -173,7 +187,8 @@ A count of the order bindings for this security group [ruleCount]: #rulecount #### [ruleCount] A count of the rules for this security group. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_SecurityGroup_OrderBinding/_index.md b/content/reference/datatypes/SoftLayer_Network_SecurityGroup_OrderBinding/_index.md index 89ba695f30..dd35d86734 100644 --- a/content/reference/datatypes/SoftLayer_Network_SecurityGroup_OrderBinding/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_SecurityGroup_OrderBinding/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_SecurityGroup_OrderBinding data type contains links between security groups and product orders. @@ -45,7 +47,8 @@ The SoftLayer_Network_SecurityGroup_OrderBinding data type contains links betwee [guestId]: #guestid #### [guestId] The ID of the Virtual Guest associated with the security group. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The ID of the Virtual Guest associated with the security group. [id]: #id #### [id] The unique ID for a security group, order, binding -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The unique ID for a security group, order, binding [orderId]: #orderid #### [orderId] The ID of the order associated with the security group. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The ID of the order associated with the security group. [securityGroupId]: #securitygroupid #### [securityGroupId] The ID of the security group that is associated with the order. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The ID of the security group that is associated with the order. [guest]: #guest #### [guest] The virtual guest associated with the binding -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -101,7 +108,8 @@ The virtual guest associated with the binding [order]: #order #### [order] The order associated with the binding -Type: **SoftLayer_Billing_Order ** +Type: **SoftLayer_Billing_Order ** + @@ -111,7 +119,8 @@ The order associated with the binding [securityGroup]: #securitygroup #### [securityGroup] The security group associated with the order -Type: **SoftLayer_Network_SecurityGroup ** +Type: **SoftLayer_Network_SecurityGroup ** + diff --git a/content/reference/datatypes/SoftLayer_Network_SecurityGroup_Request/_index.md b/content/reference/datatypes/SoftLayer_Network_SecurityGroup_Request/_index.md index b4c91cd8db..8bec55a8fd 100644 --- a/content/reference/datatypes/SoftLayer_Network_SecurityGroup_Request/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_SecurityGroup_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_SecurityGroup_Request data type contains the ID of a speci [requestId]: #requestid #### [requestId] The unique ID for a request. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_SecurityGroup_RequestRules/_index.md b/content/reference/datatypes/SoftLayer_Network_SecurityGroup_RequestRules/_index.md index 5166075697..3c883021e9 100644 --- a/content/reference/datatypes/SoftLayer_Network_SecurityGroup_RequestRules/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_SecurityGroup_RequestRules/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_SecurityGroup_RequestRules data type contains the ID of a [requestId]: #requestid #### [requestId] The unique ID for a request. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The unique ID for a request. [rules]: #rules #### [rules] Whether the API call was valid or not. -Type: **SoftLayer_Network_SecurityGroup_Rule[] ** +Type: **SoftLayer_Network_SecurityGroup_Rule[] ** + diff --git a/content/reference/datatypes/SoftLayer_Network_SecurityGroup_Rule/_index.md b/content/reference/datatypes/SoftLayer_Network_SecurityGroup_Rule/_index.md index a80cd62912..15c4f676de 100644 --- a/content/reference/datatypes/SoftLayer_Network_SecurityGroup_Rule/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_SecurityGroup_Rule/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_SecurityGroup_Rule data type contains general information for a single rule that belongs to a [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. @@ -45,7 +47,8 @@ The SoftLayer_Network_SecurityGroup_Rule data type contains general information [createDate]: #createdate #### [createDate] The createDate field for a rule. It is essentially the date and time that the security group rule was created. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The createDate field for a rule. It is essentially the date and time that the se [direction]: #direction #### [direction] The direction of traffic (ingress or egress). -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The direction of traffic (ingress or egress). [ethertype]: #ethertype #### [ethertype] IPv4 or IPv6. If the remoteIp or ethertype properties are not specified, the default is IPv4. Otherwise ethertype will default based on the format of the specified remoteIp. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ IPv4 or IPv6. If the remoteIp or ethertype properties are not specified, the def [id]: #id #### [id] The unique ID for a rule. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The unique ID for a rule. [modifyDate]: #modifydate #### [modifyDate] The modifyDate field for a rule. It is essentially the date and time that the security group rule was last changed. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The modifyDate field for a rule. It is essentially the date and time that the se [portRangeMax]: #portrangemax #### [portRangeMax] The end of the port range for allowed traffic. When the protocol is icmp, this value specifies the icmp code to permit. When icmp code is specified, icmp type is required. When the protocol is vrrp, ports cannot be specified. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The end of the port range for allowed traffic. When the protocol is icmp, this [portRangeMin]: #portrangemin #### [portRangeMin] The start of the port range for allowed traffic. When the protocol is icmp, this value specifies the icmp type to permit. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ The start of the port range for allowed traffic. When the protocol is icmp, thi [protocol]: #protocol #### [protocol] The protocol of packets (icmp, tcp, udp, or vrrp). -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The protocol of packets (icmp, tcp, udp, or vrrp). [remoteGroupId]: #remotegroupid #### [remoteGroupId] The ID of the remote security group allowed as part of the rule. This property is mutually exclusive with the remoteIp property. -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ The ID of the remote security group allowed as part of the rule. This property i [remoteIp]: #remoteip #### [remoteIp] CIDR or IP address for allowed connections. This property is mutually exclusive with the remoteGroupId property. When the protocol is vrrp, ports cannot be specified. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ CIDR or IP address for allowed connections. This property is mutually exclusive [securityGroupId]: #securitygroupid #### [securityGroupId] The ID of the security group that owns the rule. -Type: **integer** +Type: **integer** + @@ -161,7 +174,8 @@ The ID of the security group that owns the rule. [remoteGroup]: #remotegroup #### [remoteGroup] The remote security group allowed as part of this rule. -Type: **SoftLayer_Network_SecurityGroup ** +Type: **SoftLayer_Network_SecurityGroup ** + @@ -171,7 +185,8 @@ The remote security group allowed as part of this rule. [securityGroup]: #securitygroup #### [securityGroup] The security group of this rule. -Type: **SoftLayer_Network_SecurityGroup ** +Type: **SoftLayer_Network_SecurityGroup ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Security_Scanner_Request/_index.md b/content/reference/datatypes/SoftLayer_Network_Security_Scanner_Request/_index.md index f428488184..4b738d470c 100644 --- a/content/reference/datatypes/SoftLayer_Network_Security_Scanner_Request/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Security_Scanner_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -61,7 +63,8 @@ The SoftLayer_Network_Security_Scanner_Request data type represents a single vul [accountId]: #accountid #### [accountId] A request's associated customer account identifier. -Type: **integer** +Type: **integer** + @@ -71,7 +74,8 @@ A request's associated customer account identifier. [createDate]: #createdate #### [createDate] The date and time that the request is created. -Type: **dateTime** +Type: **dateTime** + @@ -81,7 +85,8 @@ The date and time that the request is created. [guestId]: #guestid #### [guestId] Virtual Guest Identification Number for the guest this security scanner request belongs to. -Type: **integer** +Type: **integer** + @@ -91,7 +96,8 @@ Virtual Guest Identification Number for the guest this security scanner request [hardwareId]: #hardwareid #### [hardwareId] The identifier of the hardware item a scan is run on. -Type: **integer** +Type: **integer** + @@ -101,7 +107,8 @@ The identifier of the hardware item a scan is run on. [hostId]: #hostid #### [hostId] Identification Number for the host this security scanner request belongs to. -Type: **integer** +Type: **integer** + @@ -111,7 +118,8 @@ Identification Number for the host this security scanner request belongs to. [id]: #id #### [id] A security scan request's internal identifier. -Type: **integer** +Type: **integer** + @@ -121,7 +129,8 @@ A security scan request's internal identifier. [ipAddress]: #ipaddress #### [ipAddress] The IP address that a scan will be performed on. -Type: **string** +Type: **string** + @@ -131,7 +140,8 @@ The IP address that a scan will be performed on. [modifyDate]: #modifydate #### [modifyDate] The date and time that the request was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -141,7 +151,8 @@ The date and time that the request was last modified. [statusId]: #statusid #### [statusId] A request status identifier. -Type: **integer** +Type: **integer** + @@ -157,7 +168,8 @@ A request status identifier. [account]: #account #### [account] The account associated with a security scan request. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -167,7 +179,8 @@ The account associated with a security scan request. [guest]: #guest #### [guest] The virtual guest a security scan is run against. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -177,7 +190,8 @@ The virtual guest a security scan is run against. [hardware]: #hardware #### [hardware] The hardware a security scan is run against. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -187,7 +201,8 @@ The hardware a security scan is run against. [requestorOwnedFlag]: #requestorownedflag #### [requestorOwnedFlag] Flag whether the requestor owns the hardware the scan was run on. This flag will return for hardware servers only, virtual servers will result in a null return even if you have a request out for them. -Type: **boolean** +Type: **boolean** + @@ -197,7 +212,8 @@ Flag whether the requestor owns the hardware the scan was run on. This flag will [status]: #status #### [status] A security scan request's status. -Type: **SoftLayer_Network_Security_Scanner_Request_Status ** +Type: **SoftLayer_Network_Security_Scanner_Request_Status ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Security_Scanner_Request_Status/_index.md b/content/reference/datatypes/SoftLayer_Network_Security_Scanner_Request_Status/_index.md index 3fd20ab701..579340e779 100644 --- a/content/reference/datatypes/SoftLayer_Network_Security_Scanner_Request_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Security_Scanner_Request_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -63,7 +65,8 @@ The status of a vulnerability scan will change over the course of a scan's execu [id]: #id #### [id] The identifier of a vulnerability scan's status. -Type: **integer** +Type: **integer** + @@ -73,7 +76,8 @@ The identifier of a vulnerability scan's status. [name]: #name #### [name] The status message of a vulnerability scan. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Service_Health/_index.md b/content/reference/datatypes/SoftLayer_Network_Service_Health/_index.md index eef944dca5..8d4282e6e3 100644 --- a/content/reference/datatypes/SoftLayer_Network_Service_Health/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Service_Health/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Many general services that SoftLayer provides are tracked on the customer portal with a quick status message. These status message provide users with a quick reference to the health of a service, whether it's up or down. These services include SoftLayer's Internet backbone connections, VPN entry points, and router networks. The SoftLayer_Network_Service_Health data type provides the relationship between these services and their health status. @@ -50,7 +52,8 @@ Many general services that SoftLayer provides are tracked on the customer portal [createDate]: #createdate #### [createDate] The date that a service's status was created. -Type: **dateTime** +Type: **dateTime** + @@ -60,7 +63,8 @@ The date that a service's status was created. [locationId]: #locationid #### [locationId] A service's location identifier. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ A service's location identifier. [modifyDate]: #modifydate #### [modifyDate] The date that a service's status was last changed. -Type: **dateTime** +Type: **dateTime** + @@ -80,7 +85,8 @@ The date that a service's status was last changed. [statusId]: #statusid #### [statusId] A service's status identifier. -Type: **integer** +Type: **integer** + @@ -96,7 +102,8 @@ A service's status identifier. [location]: #location #### [location] A service's location. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -106,7 +113,8 @@ A service's location. [status]: #status #### [status] The status portion of a service/status relationship. -Type: **SoftLayer_Network_Service_Health_Status ** +Type: **SoftLayer_Network_Service_Health_Status ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Service_Health_Status/_index.md b/content/reference/datatypes/SoftLayer_Network_Service_Health_Status/_index.md index 5d51ed0c01..e37303cbcd 100644 --- a/content/reference/datatypes/SoftLayer_Network_Service_Health_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Service_Health_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Many general services that SoftLayer provides are marked by a status message. These health messages give portal users a quick way of determining the state of a SoftLayer service. Services range from backbones to VPN endpoints and routers. Generally a health status is either "Up" or "Down". @@ -45,7 +47,8 @@ Many general services that SoftLayer provides are marked by a status message. Th [name]: #name #### [name] The status of a SoftLayer service. This is typically "Up" or "Down". -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Service_Resource/_index.md b/content/reference/datatypes/SoftLayer_Network_Service_Resource/_index.md index 44ccf83c11..8c02e64f00 100644 --- a/content/reference/datatypes/SoftLayer_Network_Service_Resource/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Service_Resource/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Service_Resource is used to store information related to a [backendIpAddress]: #backendipaddress #### [backendIpAddress] The backend IP address for this resource -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The backend IP address for this resource [frontendIpAddress]: #frontendipaddress #### [frontendIpAddress] The frontend IP address for this resource -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The frontend IP address for this resource [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The frontend IP address for this resource [name]: #name #### [name] The name associated with this resource -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The name associated with this resource [apiHost]: #apihost #### [apiHost] -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The name associated with this resource [apiPassword]: #apipassword #### [apiPassword] -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ The name associated with this resource [apiPath]: #apipath #### [apiPath] -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The name associated with this resource [apiPort]: #apiport #### [apiPort] -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The name associated with this resource [apiProtocol]: #apiprotocol #### [apiProtocol] -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ The name associated with this resource [apiUsername]: #apiusername #### [apiUsername] -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ The name associated with this resource [apiVersion]: #apiversion #### [apiVersion] -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ The name associated with this resource [attributes]: #attributes #### [attributes] -Type: **SoftLayer_Network_Service_Resource_Attribute[] ** +Type: **SoftLayer_Network_Service_Resource_Attribute[] ** + @@ -171,7 +185,8 @@ The name associated with this resource [datacenter]: #datacenter #### [datacenter] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -181,7 +196,8 @@ The name associated with this resource [netappVolumeName]: #netappvolumename #### [netappVolumeName] -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ The name associated with this resource [networkDevice]: #networkdevice #### [networkDevice] The hardware information associated with this resource. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -201,7 +218,8 @@ The hardware information associated with this resource. [sshUsername]: #sshusername #### [sshUsername] -Type: **string** +Type: **string** + @@ -211,7 +229,8 @@ The hardware information associated with this resource. [type]: #type #### [type] The network information associated with this resource. -Type: **SoftLayer_Network_Service_Resource_Type ** +Type: **SoftLayer_Network_Service_Resource_Type ** + @@ -223,7 +242,8 @@ The network information associated with this resource. [attributeCount]: #attributecount #### [attributeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Service_Resource_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Network_Service_Resource_Attribute/_index.md index b7223b233d..424a49162b 100644 --- a/content/reference/datatypes/SoftLayer_Network_Service_Resource_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Service_Resource_Attribute/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [value]: #value #### [value] -Type: **string** +Type: **string** +
      @@ -61,7 +64,8 @@ classes: [attributeType]: #attributetype #### [attributeType] -Type: **SoftLayer_Network_Service_Resource_Attribute_Type ** +Type: **SoftLayer_Network_Service_Resource_Attribute_Type ** +
      @@ -71,7 +75,8 @@ classes: [serviceResource]: #serviceresource #### [serviceResource] -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Service_Resource_Attribute_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Service_Resource_Attribute_Type/_index.md index c57af41500..0b69350ade 100644 --- a/content/reference/datatypes/SoftLayer_Network_Service_Resource_Attribute_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Service_Resource_Attribute_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [keyname]: #keyname #### [keyname] -Type: **string** +Type: **string** +
      diff --git a/content/reference/datatypes/SoftLayer_Network_Service_Resource_CosStor/_index.md b/content/reference/datatypes/SoftLayer_Network_Service_Resource_CosStor/_index.md index 234d8c002c..e81245b907 100644 --- a/content/reference/datatypes/SoftLayer_Network_Service_Resource_CosStor/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Service_Resource_CosStor/_index.md @@ -18,6 +18,8 @@ classes:
      ## Description + + The SoftLayer_Network_Service_Resource_CosStor is used to store information related to COS service. @@ -45,7 +47,8 @@ The SoftLayer_Network_Service_Resource_CosStor is used to store information rela [backendIpAddress]: #backendipaddress #### [backendIpAddress] The backend IP address for this resource -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The backend IP address for this resource [frontendIpAddress]: #frontendipaddress #### [frontendIpAddress] The frontend IP address for this resource -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The frontend IP address for this resource [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The frontend IP address for this resource [name]: #name #### [name] The name associated with this resource -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The name associated with this resource [apiHost]: #apihost #### [apiHost] -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The name associated with this resource [apiPassword]: #apipassword #### [apiPassword] -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ The name associated with this resource [apiPath]: #apipath #### [apiPath] -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The name associated with this resource [apiPort]: #apiport #### [apiPort] -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The name associated with this resource [apiProtocol]: #apiprotocol #### [apiProtocol] -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ The name associated with this resource [apiUsername]: #apiusername #### [apiUsername] -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ The name associated with this resource [apiVersion]: #apiversion #### [apiVersion] -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ The name associated with this resource [attributes]: #attributes #### [attributes] -Type: **SoftLayer_Network_Service_Resource_Attribute[] ** +Type: **SoftLayer_Network_Service_Resource_Attribute[] ** + @@ -171,7 +185,8 @@ The name associated with this resource [datacenter]: #datacenter #### [datacenter] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -181,7 +196,8 @@ The name associated with this resource [netappVolumeName]: #netappvolumename #### [netappVolumeName] -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ The name associated with this resource [networkDevice]: #networkdevice #### [networkDevice] The hardware information associated with this resource. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -201,7 +218,8 @@ The hardware information associated with this resource. [sshUsername]: #sshusername #### [sshUsername] -Type: **string** +Type: **string** + @@ -211,7 +229,8 @@ The hardware information associated with this resource. [type]: #type #### [type] The network information associated with this resource. -Type: **SoftLayer_Network_Service_Resource_Type ** +Type: **SoftLayer_Network_Service_Resource_Type ** + @@ -223,7 +242,8 @@ The network information associated with this resource. [attributeCount]: #attributecount #### [attributeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Service_Resource_Hub/_index.md b/content/reference/datatypes/SoftLayer_Network_Service_Resource_Hub/_index.md index 34d5eb7e4c..a66c17951c 100644 --- a/content/reference/datatypes/SoftLayer_Network_Service_Resource_Hub/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Service_Resource_Hub/_index.md @@ -22,6 +22,8 @@ classes: + + ### seeAlso * [SoftLayer_Network_Service_Resource](/reference/datatypes/SoftLayer_Network_Service_Resource ) @@ -50,7 +52,8 @@ classes: [backendIpAddress]: #backendipaddress #### [backendIpAddress] The backend IP address for this resource -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ The backend IP address for this resource [frontendIpAddress]: #frontendipaddress #### [frontendIpAddress] The frontend IP address for this resource -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ The frontend IP address for this resource [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -80,7 +85,8 @@ The frontend IP address for this resource [name]: #name #### [name] The name associated with this resource -Type: **string** +Type: **string** + @@ -96,7 +102,8 @@ The name associated with this resource [apiHost]: #apihost #### [apiHost] -Type: **string** +Type: **string** + @@ -106,7 +113,8 @@ The name associated with this resource [apiPassword]: #apipassword #### [apiPassword] -Type: **string** +Type: **string** + @@ -116,7 +124,8 @@ The name associated with this resource [apiPath]: #apipath #### [apiPath] -Type: **string** +Type: **string** + @@ -126,7 +135,8 @@ The name associated with this resource [apiPort]: #apiport #### [apiPort] -Type: **string** +Type: **string** + @@ -136,7 +146,8 @@ The name associated with this resource [apiProtocol]: #apiprotocol #### [apiProtocol] -Type: **string** +Type: **string** + @@ -146,7 +157,8 @@ The name associated with this resource [apiUsername]: #apiusername #### [apiUsername] -Type: **string** +Type: **string** + @@ -156,7 +168,8 @@ The name associated with this resource [apiVersion]: #apiversion #### [apiVersion] -Type: **string** +Type: **string** + @@ -166,7 +179,8 @@ The name associated with this resource [attributes]: #attributes #### [attributes] -Type: **SoftLayer_Network_Service_Resource_Attribute[] ** +Type: **SoftLayer_Network_Service_Resource_Attribute[] ** + @@ -176,7 +190,8 @@ The name associated with this resource [datacenter]: #datacenter #### [datacenter] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -186,7 +201,8 @@ The name associated with this resource [netappVolumeName]: #netappvolumename #### [netappVolumeName] -Type: **string** +Type: **string** + @@ -196,7 +212,8 @@ The name associated with this resource [networkDevice]: #networkdevice #### [networkDevice] The hardware information associated with this resource. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -206,7 +223,8 @@ The hardware information associated with this resource. [sshUsername]: #sshusername #### [sshUsername] -Type: **string** +Type: **string** + @@ -216,7 +234,8 @@ The hardware information associated with this resource. [type]: #type #### [type] The network information associated with this resource. -Type: **SoftLayer_Network_Service_Resource_Type ** +Type: **SoftLayer_Network_Service_Resource_Type ** + @@ -228,7 +247,8 @@ The network information associated with this resource. [attributeCount]: #attributecount #### [attributeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Service_Resource_Hub_Swift/_index.md b/content/reference/datatypes/SoftLayer_Network_Service_Resource_Hub_Swift/_index.md index 1db70808df..7808bf0d6c 100644 --- a/content/reference/datatypes/SoftLayer_Network_Service_Resource_Hub_Swift/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Service_Resource_Hub_Swift/_index.md @@ -22,6 +22,8 @@ classes: + + ### seeAlso * [SoftLayer_Network_Service_Resource](/reference/datatypes/SoftLayer_Network_Service_Resource ) @@ -50,7 +52,8 @@ classes: [backendIpAddress]: #backendipaddress #### [backendIpAddress] The backend IP address for this resource -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ The backend IP address for this resource [frontendIpAddress]: #frontendipaddress #### [frontendIpAddress] The frontend IP address for this resource -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ The frontend IP address for this resource [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -80,7 +85,8 @@ The frontend IP address for this resource [name]: #name #### [name] The name associated with this resource -Type: **string** +Type: **string** + @@ -96,7 +102,8 @@ The name associated with this resource [apiHost]: #apihost #### [apiHost] -Type: **string** +Type: **string** + @@ -106,7 +113,8 @@ The name associated with this resource [apiPassword]: #apipassword #### [apiPassword] -Type: **string** +Type: **string** + @@ -116,7 +124,8 @@ The name associated with this resource [apiPath]: #apipath #### [apiPath] -Type: **string** +Type: **string** + @@ -126,7 +135,8 @@ The name associated with this resource [apiPort]: #apiport #### [apiPort] -Type: **string** +Type: **string** + @@ -136,7 +146,8 @@ The name associated with this resource [apiProtocol]: #apiprotocol #### [apiProtocol] -Type: **string** +Type: **string** + @@ -146,7 +157,8 @@ The name associated with this resource [apiUsername]: #apiusername #### [apiUsername] -Type: **string** +Type: **string** + @@ -156,7 +168,8 @@ The name associated with this resource [apiVersion]: #apiversion #### [apiVersion] -Type: **string** +Type: **string** + @@ -166,7 +179,8 @@ The name associated with this resource [attributes]: #attributes #### [attributes] -Type: **SoftLayer_Network_Service_Resource_Attribute[] ** +Type: **SoftLayer_Network_Service_Resource_Attribute[] ** + @@ -176,7 +190,8 @@ The name associated with this resource [datacenter]: #datacenter #### [datacenter] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -186,7 +201,8 @@ The name associated with this resource [netappVolumeName]: #netappvolumename #### [netappVolumeName] -Type: **string** +Type: **string** + @@ -196,7 +212,8 @@ The name associated with this resource [networkDevice]: #networkdevice #### [networkDevice] The hardware information associated with this resource. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -206,7 +223,8 @@ The hardware information associated with this resource. [sshUsername]: #sshusername #### [sshUsername] -Type: **string** +Type: **string** + @@ -216,7 +234,8 @@ The hardware information associated with this resource. [type]: #type #### [type] The network information associated with this resource. -Type: **SoftLayer_Network_Service_Resource_Type ** +Type: **SoftLayer_Network_Service_Resource_Type ** + @@ -228,7 +247,8 @@ The network information associated with this resource. [attributeCount]: #attributecount #### [attributeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Service_Resource_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Service_Resource_Type/_index.md index e50f2c1983..4258dc18e0 100644 --- a/content/reference/datatypes/SoftLayer_Network_Service_Resource_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Service_Resource_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [type]: #type #### [type] -Type: **string** +Type: **string** +
      @@ -61,7 +64,8 @@ classes: [serviceResources]: #serviceresources #### [serviceResources] -Type: **SoftLayer_Network_Service_Resource[] ** +Type: **SoftLayer_Network_Service_Resource[] ** +
      @@ -73,7 +77,8 @@ classes: [serviceResourceCount]: #serviceresourcecount #### [serviceResourceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Service_Vpn_Overrides/_index.md b/content/reference/datatypes/SoftLayer_Network_Service_Vpn_Overrides/_index.md index e2145c2cf5..f854fbd08b 100644 --- a/content/reference/datatypes/SoftLayer_Network_Service_Vpn_Overrides/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Service_Vpn_Overrides/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ The SoftLayer_Network_Service_Vpn_Overrides data type contains information relat [id]: #id #### [id] The internal identifier of the record. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ The internal identifier of the record. [subnetId]: #subnetid #### [subnetId] The identifier of a subnet accessible by the SoftLayer portal VPN user. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ The identifier of a subnet accessible by the SoftLayer portal VPN user. [userId]: #userid #### [userId] The identifier of the SoftLayer portal VPN user. -Type: **integer** +Type: **integer** + @@ -86,7 +91,8 @@ The identifier of the SoftLayer portal VPN user. [subnet]: #subnet #### [subnet] Subnet components accessible by a SoftLayer VPN portal user. -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + @@ -96,7 +102,8 @@ Subnet components accessible by a SoftLayer VPN portal user. [user]: #user #### [user] SoftLayer VPN portal user. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage/_index.md index c7c027fd13..fa7527ac97 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -72,7 +74,8 @@ The SoftLayer_Network_Storage data type contains general information regarding a [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account that a Storage account belongs to. -Type: **integer** +Type: **integer** + @@ -82,7 +85,8 @@ The internal identifier of the SoftLayer customer account that a Storage account [capacityGb]: #capacitygb #### [capacityGb] A Storage account's capacity, measured in gigabytes. -Type: **integer** +Type: **integer** + @@ -92,7 +96,8 @@ A Storage account's capacity, measured in gigabytes. [createDate]: #createdate #### [createDate] The date a network storage volume was created. -Type: **dateTime** +Type: **dateTime** + @@ -102,7 +107,8 @@ The date a network storage volume was created. [guestId]: #guestid #### [guestId] The unique identification number of the guest associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -112,7 +118,8 @@ The unique identification number of the guest associated with a Storage volume. [hardwareId]: #hardwareid #### [hardwareId] The server that is associated with a Storage service. -Type: **integer** +Type: **integer** + @@ -122,7 +129,8 @@ The server that is associated with a Storage service. [hostId]: #hostid #### [hostId] The unique identification number of the host associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -132,7 +140,8 @@ The unique identification number of the host associated with a Storage volume. [id]: #id #### [id] A Storage account's unique identifier. -Type: **integer** +Type: **integer** + @@ -142,7 +151,8 @@ A Storage account's unique identifier. [nasType]: #nastype #### [nasType] A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT", and "HUB". -Type: **string** +Type: **string** + @@ -152,7 +162,8 @@ A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT" [notes]: #notes #### [notes] Public notes related to a Storage volume. -Type: **string** +Type: **string** + @@ -162,7 +173,8 @@ Public notes related to a Storage volume. [password]: #password #### [password] The password used to access a non-EVault Storage volume. This password is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -172,7 +184,8 @@ The password used to access a non-EVault Storage volume. This password is used t [serviceProviderId]: #serviceproviderid #### [serviceProviderId] Service Provider ID -Type: **integer** +Type: **integer** + @@ -182,7 +195,8 @@ Service Provider ID [storageTypeId]: #storagetypeid #### [storageTypeId] A storage object's type. -Type: **string** +Type: **string** + @@ -192,7 +206,8 @@ A storage object's type. [upgradableFlag]: #upgradableflag #### [upgradableFlag] This flag indicates whether this storage type is upgradable or not. -Type: **boolean** +Type: **boolean** + @@ -202,7 +217,8 @@ This flag indicates whether this storage type is upgradable or not. [username]: #username #### [username] The username used to access a non-EVault Storage volume. This username is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -218,7 +234,8 @@ The username used to access a non-EVault Storage volume. This username is used t [account]: #account #### [account] The account that a Storage services belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -228,7 +245,8 @@ The account that a Storage services belongs to. [accountPassword]: #accountpassword #### [accountPassword] Other usernames and passwords associated with a Storage volume. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -238,7 +256,19 @@ Other usernames and passwords associated with a Storage volume. [activeTransactions]: #activetransactions #### [activeTransactions] The currently active transactions on a network storage volume. -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + + + + +
      + +----- +[allowDisasterRecoveryFailback]: #allowdisasterrecoveryfailback +#### [allowDisasterRecoveryFailback] + +Type: **string** +
      @@ -248,7 +278,8 @@ The currently active transactions on a network storage volume. [allowDisasterRecoveryFailover]: #allowdisasterrecoveryfailover #### [allowDisasterRecoveryFailover] -Type: **string** +Type: **string** + @@ -258,7 +289,8 @@ The currently active transactions on a network storage volume. [allowedHardware]: #allowedhardware #### [allowedHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -268,7 +300,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume. [allowedIpAddresses]: #allowedipaddresses #### [allowedIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -278,7 +311,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationHardware]: #allowedreplicationhardware #### [allowedReplicationHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -288,7 +322,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedReplicationIpAddresses]: #allowedreplicationipaddresses #### [allowedReplicationIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -298,7 +333,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationSubnets]: #allowedreplicationsubnets #### [allowedReplicationSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -308,7 +344,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedReplicationVirtualGuests]: #allowedreplicationvirtualguests #### [allowedReplicationVirtualGuests] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -318,7 +355,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedSubnets]: #allowedsubnets #### [allowedSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -328,7 +366,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedVirtualGuests]: #allowedvirtualguests #### [allowedVirtualGuests] The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -338,7 +377,8 @@ The SoftLayer_Virtual_Guest objects which are allowed access to this storage vol [billingItem]: #billingitem #### [billingItem] The current billing item for a Storage volume. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -348,7 +388,8 @@ The current billing item for a Storage volume. [billingItemCategory]: #billingitemcategory #### [billingItemCategory] -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -358,7 +399,8 @@ The current billing item for a Storage volume. [bytesUsed]: #bytesused #### [bytesUsed] The amount of space used by the volume, in bytes. -Type: **string** +Type: **string** + @@ -368,7 +410,8 @@ The amount of space used by the volume, in bytes. [creationScheduleId]: #creationscheduleid #### [creationScheduleId] The schedule id which was executed to create a snapshot. -Type: **string** +Type: **string** + @@ -378,7 +421,8 @@ The schedule id which was executed to create a snapshot. [credentials]: #credentials #### [credentials] -Type: **SoftLayer_Network_Storage_Credential[] ** +Type: **SoftLayer_Network_Storage_Credential[] ** + @@ -388,7 +432,8 @@ The schedule id which was executed to create a snapshot. [dailySchedule]: #dailyschedule #### [dailySchedule] The Daily Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -398,7 +443,8 @@ The Daily Schedule which is associated with this network storage volume. [dependentDuplicate]: #dependentduplicate #### [dependentDuplicate] Whether or not a network storage volume is a dependent duplicate. -Type: **string** +Type: **string** + @@ -408,7 +454,8 @@ Whether or not a network storage volume is a dependent duplicate. [dependentDuplicates]: #dependentduplicates #### [dependentDuplicates] The network storage volumes configured to be dependent duplicates of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -418,7 +465,8 @@ The network storage volumes configured to be dependent duplicates of a volume. [events]: #events #### [events] The events which have taken place on a network storage volume. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -428,7 +476,19 @@ The events which have taken place on a network storage volume. [failbackNotAllowed]: #failbacknotallowed #### [failbackNotAllowed] Determines whether the volume is allowed to failback -Type: **string** +Type: **string** + + + + +
      + +----- +[failoverNotAllowed]: #failovernotallowed +#### [failoverNotAllowed] +Determines whether the volume is allowed to failover +Type: **string** +
      @@ -438,7 +498,8 @@ Determines whether the volume is allowed to failback [fileNetworkMountAddress]: #filenetworkmountaddress #### [fileNetworkMountAddress] Retrieves the NFS Network Mount Address Name for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -448,7 +509,8 @@ Retrieves the NFS Network Mount Address Name for a given File Storage Volume. [hardware]: #hardware #### [hardware] When applicable, the hardware associated with a Storage service. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -458,7 +520,8 @@ When applicable, the hardware associated with a Storage service. [hasEncryptionAtRest]: #hasencryptionatrest #### [hasEncryptionAtRest] -Type: **boolean** +Type: **boolean** + @@ -468,7 +531,8 @@ When applicable, the hardware associated with a Storage service. [hourlySchedule]: #hourlyschedule #### [hourlySchedule] The Hourly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -478,7 +542,8 @@ The Hourly Schedule which is associated with this network storage volume. [intervalSchedule]: #intervalschedule #### [intervalSchedule] The Interval Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -488,7 +553,8 @@ The Interval Schedule which is associated with this network storage volume. [iops]: #iops #### [iops] The maximum number of IOPs selected for this volume. -Type: **string** +Type: **string** + @@ -498,7 +564,8 @@ The maximum number of IOPs selected for this volume. [isDependentDuplicateProvisionCompleted]: #isdependentduplicateprovisioncompleted #### [isDependentDuplicateProvisionCompleted] Determines whether dependent volume provision is completed on background. -Type: **boolean** +Type: **boolean** + @@ -508,7 +575,8 @@ Determines whether dependent volume provision is completed on background. [isInDedicatedServiceResource]: #isindedicatedserviceresource #### [isInDedicatedServiceResource] -Type: **boolean** +Type: **boolean** + @@ -518,7 +586,8 @@ Determines whether dependent volume provision is completed on background. [isMagneticStorage]: #ismagneticstorage #### [isMagneticStorage] -Type: **string** +Type: **string** + @@ -528,7 +597,8 @@ Determines whether dependent volume provision is completed on background. [isReadyForSnapshot]: #isreadyforsnapshot #### [isReadyForSnapshot] Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. -Type: **boolean** +Type: **boolean** + @@ -538,7 +608,8 @@ Determines whether a volume is ready to order snapshot space, or, if snapshot sp [isReadyToMount]: #isreadytomount #### [isReadyToMount] Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. -Type: **boolean** +Type: **boolean** + @@ -548,7 +619,8 @@ Determines whether a volume is ready to have Hosts authorized to access it. This [iscsiLuns]: #iscsiluns #### [iscsiLuns] Relationship between a container volume and iSCSI LUNs. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -558,7 +630,8 @@ Relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddresses]: #iscsitargetipaddresses #### [iscsiTargetIpAddresses] Returns the target IP addresses of an iSCSI volume. -Type: **array of strings** +Type: **array of strings** + @@ -568,7 +641,8 @@ Returns the target IP addresses of an iSCSI volume. [lunId]: #lunid #### [lunId] The ID of the LUN volume. -Type: **string** +Type: **string** + @@ -578,7 +652,8 @@ The ID of the LUN volume. [manualSnapshots]: #manualsnapshots #### [manualSnapshots] The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -588,7 +663,8 @@ The manually-created snapshots associated with this SoftLayer_Network_Storage vo [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A network storage volume's metric tracking object. This object records all periodic polled data available to this volume. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -598,7 +674,8 @@ A network storage volume's metric tracking object. This object records all perio [mountPath]: #mountpath #### [mountPath] Retrieves the NFS Network Mount Path for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -608,7 +685,8 @@ Retrieves the NFS Network Mount Path for a given File Storage Volume. [mountableFlag]: #mountableflag #### [mountableFlag] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -618,7 +696,8 @@ Whether or not a network storage volume may be mounted. [moveAndSplitStatus]: #moveandsplitstatus #### [moveAndSplitStatus] The current status of split or move operation as a part of volume duplication. -Type: **string** +Type: **string** + @@ -628,7 +707,8 @@ The current status of split or move operation as a part of volume duplication. [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] The subscribers that will be notified for usage amount warnings and overages. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -638,7 +718,8 @@ The subscribers that will be notified for usage amount warnings and overages. [originalSnapshotName]: #originalsnapshotname #### [originalSnapshotName] The name of the snapshot that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -648,7 +729,8 @@ The name of the snapshot that this volume was duplicated from. [originalVolumeName]: #originalvolumename #### [originalVolumeName] The name of the volume that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -658,7 +740,8 @@ The name of the volume that this volume was duplicated from. [originalVolumeSize]: #originalvolumesize #### [originalVolumeSize] The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. -Type: **string** +Type: **string** + @@ -668,7 +751,8 @@ The size (in GB) of the volume or LUN before any size expansion, or of the volum [osType]: #ostype #### [osType] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -678,7 +762,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. [osTypeId]: #ostypeid #### [osTypeId] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. -Type: **string** +Type: **string** + @@ -688,7 +773,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. [parentPartnerships]: #parentpartnerships #### [parentPartnerships] The volumes or snapshots partnered with a network storage volume in a parental role. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -698,7 +784,8 @@ The volumes or snapshots partnered with a network storage volume in a parental r [parentVolume]: #parentvolume #### [parentVolume] The parent volume of a volume in a complex storage relationship. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -708,7 +795,8 @@ The parent volume of a volume in a complex storage relationship. [partnerships]: #partnerships #### [partnerships] The volumes or snapshots partnered with a network storage volume. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -718,7 +806,8 @@ The volumes or snapshots partnered with a network storage volume. [permissionsGroups]: #permissionsgroups #### [permissionsGroups] All permissions group(s) this volume is in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -728,7 +817,8 @@ All permissions group(s) this volume is in. [properties]: #properties #### [properties] The properties used to provide additional details about a network storage volume. -Type: **SoftLayer_Network_Storage_Property[] ** +Type: **SoftLayer_Network_Storage_Property[] ** + @@ -738,7 +828,8 @@ The properties used to provide additional details about a network storage volume [provisionedIops]: #provisionediops #### [provisionedIops] The number of IOPs provisioned for this volume. -Type: **string** +Type: **string** + @@ -748,7 +839,8 @@ The number of IOPs provisioned for this volume. [replicatingLuns]: #replicatingluns #### [replicatingLuns] The iSCSI LUN volumes being replicated by this network storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -758,7 +850,8 @@ The iSCSI LUN volumes being replicated by this network storage volume. [replicatingVolume]: #replicatingvolume #### [replicatingVolume] The network storage volume being replicated by a volume. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -768,7 +861,8 @@ The network storage volume being replicated by a volume. [replicationEvents]: #replicationevents #### [replicationEvents] The volume replication events. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -778,7 +872,8 @@ The volume replication events. [replicationPartners]: #replicationpartners #### [replicationPartners] The network storage volumes configured to be replicants of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -788,7 +883,8 @@ The network storage volumes configured to be replicants of a volume. [replicationSchedule]: #replicationschedule #### [replicationSchedule] The Replication Schedule associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -798,7 +894,8 @@ The Replication Schedule associated with a network storage volume. [replicationStatus]: #replicationstatus #### [replicationStatus] The current replication status of a network storage volume. Indicates Failover or Failback status. -Type: **string** +Type: **string** + @@ -808,7 +905,8 @@ The current replication status of a network storage volume. Indicates Failover o [schedules]: #schedules #### [schedules] The schedules which are associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule[] ** +Type: **SoftLayer_Network_Storage_Schedule[] ** + @@ -818,7 +916,8 @@ The schedules which are associated with a network storage volume. [serviceResource]: #serviceresource #### [serviceResource] The network resource a Storage service is connected to. -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -828,7 +927,8 @@ The network resource a Storage service is connected to. [serviceResourceBackendIpAddress]: #serviceresourcebackendipaddress #### [serviceResourceBackendIpAddress] The IP address of a Storage resource. -Type: **string** +Type: **string** + @@ -838,7 +938,8 @@ The IP address of a Storage resource. [serviceResourceName]: #serviceresourcename #### [serviceResourceName] The name of a Storage's network resource. -Type: **string** +Type: **string** + @@ -848,7 +949,8 @@ The name of a Storage's network resource. [snapshotCapacityGb]: #snapshotcapacitygb #### [snapshotCapacityGb] A volume's configured snapshot space size. -Type: **string** +Type: **string** + @@ -858,7 +960,8 @@ A volume's configured snapshot space size. [snapshotCreationTimestamp]: #snapshotcreationtimestamp #### [snapshotCreationTimestamp] The creation timestamp of the snapshot on the storage platform. -Type: **string** +Type: **string** + @@ -868,7 +971,8 @@ The creation timestamp of the snapshot on the storage platform. [snapshotDeletionThresholdPercentage]: #snapshotdeletionthresholdpercentage #### [snapshotDeletionThresholdPercentage] The percentage of used snapshot space after which to delete automated snapshots. -Type: **string** +Type: **string** + @@ -878,7 +982,8 @@ The percentage of used snapshot space after which to delete automated snapshots. [snapshotNotificationStatus]: #snapshotnotificationstatus #### [snapshotNotificationStatus] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -888,7 +993,8 @@ Whether or not a network storage volume may be mounted. [snapshotSizeBytes]: #snapshotsizebytes #### [snapshotSizeBytes] The snapshot size in bytes. -Type: **string** +Type: **string** + @@ -898,7 +1004,8 @@ The snapshot size in bytes. [snapshotSpaceAvailable]: #snapshotspaceavailable #### [snapshotSpaceAvailable] A volume's available snapshot reservation space. -Type: **string** +Type: **string** + @@ -908,7 +1015,8 @@ A volume's available snapshot reservation space. [snapshots]: #snapshots #### [snapshots] The snapshots associated with this SoftLayer_Network_Storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -918,7 +1026,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [staasVersion]: #staasversion #### [staasVersion] -Type: **string** +Type: **string** + @@ -928,7 +1037,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [storageGroups]: #storagegroups #### [storageGroups] The network storage groups this volume is attached to. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -938,7 +1048,8 @@ The network storage groups this volume is attached to. [storageTierLevel]: #storagetierlevel #### [storageTierLevel] -Type: **string** +Type: **string** + @@ -948,7 +1059,8 @@ The network storage groups this volume is attached to. [storageType]: #storagetype #### [storageType] A description of the Storage object. -Type: **SoftLayer_Network_Storage_Type ** +Type: **SoftLayer_Network_Storage_Type ** + @@ -958,7 +1070,8 @@ A description of the Storage object. [totalBytesUsed]: #totalbytesused #### [totalBytesUsed] The amount of space used by the volume. -Type: **string** +Type: **string** + @@ -968,7 +1081,8 @@ The amount of space used by the volume. [totalScheduleSnapshotRetentionCount]: #totalschedulesnapshotretentioncount #### [totalScheduleSnapshotRetentionCount] The total snapshot retention count of all schedules on this network storage volume. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -978,7 +1092,8 @@ The total snapshot retention count of all schedules on this network storage volu [usageNotification]: #usagenotification #### [usageNotification] The usage notification for SL Storage services. -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -988,7 +1103,8 @@ The usage notification for SL Storage services. [vendorName]: #vendorname #### [vendorName] The type of network storage service. -Type: **string** +Type: **string** + @@ -998,7 +1114,8 @@ The type of network storage service. [virtualGuest]: #virtualguest #### [virtualGuest] When applicable, the virtual guest associated with a Storage service. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -1008,7 +1125,8 @@ When applicable, the virtual guest associated with a Storage service. [volumeHistory]: #volumehistory #### [volumeHistory] The username and password history for a Storage service. -Type: **SoftLayer_Network_Storage_History[] ** +Type: **SoftLayer_Network_Storage_History[] ** + @@ -1018,7 +1136,8 @@ The username and password history for a Storage service. [volumeStatus]: #volumestatus #### [volumeStatus] The current status of a network storage volume. -Type: **string** +Type: **string** + @@ -1028,7 +1147,8 @@ The current status of a network storage volume. [webccAccount]: #webccaccount #### [webccAccount] The account username and password for the EVault webCC interface. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -1038,7 +1158,8 @@ The account username and password for the EVault webCC interface. [weeklySchedule]: #weeklyschedule #### [weeklySchedule] The Weekly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -1050,7 +1171,8 @@ The Weekly Schedule which is associated with this network storage volume. [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of the currently active transactions on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1060,7 +1182,8 @@ A count of the currently active transactions on a network storage volume. [allowedHardwareCount]: #allowedhardwarecount #### [allowedHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1070,7 +1193,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedIpAddressCount]: #allowedipaddresscount #### [allowedIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1080,7 +1204,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationHardwareCount]: #allowedreplicationhardwarecount #### [allowedReplicationHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1090,7 +1215,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedReplicationIpAddressCount]: #allowedreplicationipaddresscount #### [allowedReplicationIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1100,7 +1226,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationSubnetCount]: #allowedreplicationsubnetcount #### [allowedReplicationSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1110,7 +1237,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedReplicationVirtualGuestCount]: #allowedreplicationvirtualguestcount #### [allowedReplicationVirtualGuestCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1120,7 +1248,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedSubnetCount]: #allowedsubnetcount #### [allowedSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1130,7 +1259,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedVirtualGuestCount]: #allowedvirtualguestcount #### [allowedVirtualGuestCount] A count of the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1140,7 +1270,8 @@ A count of the SoftLayer_Virtual_Guest objects which are allowed access to this [credentialCount]: #credentialcount #### [credentialCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1150,7 +1281,8 @@ A count of [dependentDuplicateCount]: #dependentduplicatecount #### [dependentDuplicateCount] A count of the network storage volumes configured to be dependent duplicates of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1160,7 +1292,8 @@ A count of the network storage volumes configured to be dependent duplicates of [eventCount]: #eventcount #### [eventCount] A count of the events which have taken place on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1170,7 +1303,8 @@ A count of the events which have taken place on a network storage volume. [iscsiLunCount]: #iscsiluncount #### [iscsiLunCount] A count of relationship between a container volume and iSCSI LUNs. -Type: **unsigned long** +Type: **unsigned long** + @@ -1180,7 +1314,8 @@ A count of relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddressCount]: #iscsitargetipaddresscount #### [iscsiTargetIpAddressCount] A count of returns the target IP addresses of an iSCSI volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1190,7 +1325,8 @@ A count of returns the target IP addresses of an iSCSI volume. [manualSnapshotCount]: #manualsnapshotcount #### [manualSnapshotCount] A count of the manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **unsigned long** +Type: **unsigned long** + @@ -1200,7 +1336,8 @@ A count of the manually-created snapshots associated with this SoftLayer_Network [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of the subscribers that will be notified for usage amount warnings and overages. -Type: **unsigned long** +Type: **unsigned long** + @@ -1210,7 +1347,8 @@ A count of the subscribers that will be notified for usage amount warnings and o [parentPartnershipCount]: #parentpartnershipcount #### [parentPartnershipCount] A count of the volumes or snapshots partnered with a network storage volume in a parental role. -Type: **unsigned long** +Type: **unsigned long** + @@ -1220,7 +1358,8 @@ A count of the volumes or snapshots partnered with a network storage volume in a [partnershipCount]: #partnershipcount #### [partnershipCount] A count of the volumes or snapshots partnered with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1230,7 +1369,8 @@ A count of the volumes or snapshots partnered with a network storage volume. [permissionsGroupCount]: #permissionsgroupcount #### [permissionsGroupCount] A count of all permissions group(s) this volume is in. -Type: **unsigned long** +Type: **unsigned long** + @@ -1240,7 +1380,8 @@ A count of all permissions group(s) this volume is in. [propertyCount]: #propertycount #### [propertyCount] A count of the properties used to provide additional details about a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1250,7 +1391,8 @@ A count of the properties used to provide additional details about a network sto [replicatingLunCount]: #replicatingluncount #### [replicatingLunCount] A count of the iSCSI LUN volumes being replicated by this network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1260,7 +1402,8 @@ A count of the iSCSI LUN volumes being replicated by this network storage volume [replicationEventCount]: #replicationeventcount #### [replicationEventCount] A count of the volume replication events. -Type: **unsigned long** +Type: **unsigned long** + @@ -1270,7 +1413,8 @@ A count of the volume replication events. [replicationPartnerCount]: #replicationpartnercount #### [replicationPartnerCount] A count of the network storage volumes configured to be replicants of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1280,7 +1424,8 @@ A count of the network storage volumes configured to be replicants of a volume. [scheduleCount]: #schedulecount #### [scheduleCount] A count of the schedules which are associated with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1290,7 +1435,8 @@ A count of the schedules which are associated with a network storage volume. [snapshotCount]: #snapshotcount #### [snapshotCount] A count of the snapshots associated with this SoftLayer_Network_Storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1300,7 +1446,8 @@ A count of the snapshots associated with this SoftLayer_Network_Storage volume. [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of the network storage groups this volume is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1310,7 +1457,8 @@ A count of the network storage groups this volume is attached to. [volumeHistoryCount]: #volumehistorycount #### [volumeHistoryCount] A count of the username and password history for a Storage service. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host/_index.md index 7bea30f0e8..5dc216215d 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The account to which this allowed host belongs to. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The account to which this allowed host belongs to. [credentialId]: #credentialid #### [credentialId] The credential this allowed host will use -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ The credential this allowed host will use [id]: #id #### [id] The internal identifier of the igroup -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The internal identifier of the igroup [name]: #name #### [name] The name of allowed host, usually an IQN or other identifier -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The name of allowed host, usually an IQN or other identifier [resourceTableId]: #resourcetableid #### [resourceTableId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The name of allowed host, usually an IQN or other identifier [resourceTableName]: #resourcetablename #### [resourceTableName] -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ The name of allowed host, usually an IQN or other identifier [assignedGroups]: #assignedgroups #### [assignedGroups] The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -121,7 +130,8 @@ The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allow [assignedIscsiVolumes]: #assignediscsivolumes #### [assignedIscsiVolumes] The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -131,7 +141,8 @@ The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Al [assignedNfsVolumes]: #assignednfsvolumes #### [assignedNfsVolumes] The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -141,7 +152,8 @@ The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Al [assignedReplicationVolumes]: #assignedreplicationvolumes #### [assignedReplicationVolumes] The SoftLayer_Network_Storage primary volumes whose replicas are allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -151,7 +163,8 @@ The SoftLayer_Network_Storage primary volumes whose replicas are allowed access. [assignedVolumes]: #assignedvolumes #### [assignedVolumes] The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -161,7 +174,8 @@ The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Al [credential]: #credential #### [credential] The SoftLayer_Network_Storage_Credential this allowed host uses. -Type: **SoftLayer_Network_Storage_Credential ** +Type: **SoftLayer_Network_Storage_Credential ** + @@ -171,7 +185,8 @@ The SoftLayer_Network_Storage_Credential this allowed host uses. [sourceSubnet]: #sourcesubnet #### [sourceSubnet] Connections to a target with a source IP in this subnet prefix are allowed. -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ Connections to a target with a source IP in this subnet prefix are allowed. [subnetsInAcl]: #subnetsinacl #### [subnetsInAcl] The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -193,7 +209,8 @@ The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. [assignedGroupCount]: #assignedgroupcount #### [assignedGroupCount] A count of the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. -Type: **unsigned long** +Type: **unsigned long** + @@ -203,7 +220,8 @@ A count of the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_St [assignedIscsiVolumeCount]: #assignediscsivolumecount #### [assignedIscsiVolumeCount] A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -213,7 +231,8 @@ A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network [assignedNfsVolumeCount]: #assignednfsvolumecount #### [assignedNfsVolumeCount] A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -223,7 +242,8 @@ A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network [assignedReplicationVolumeCount]: #assignedreplicationvolumecount #### [assignedReplicationVolumeCount] A count of the SoftLayer_Network_Storage primary volumes whose replicas are allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -233,7 +253,8 @@ A count of the SoftLayer_Network_Storage primary volumes whose replicas are allo [assignedVolumeCount]: #assignedvolumecount #### [assignedVolumeCount] A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -243,7 +264,8 @@ A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network [subnetsInAclCount]: #subnetsinaclcount #### [subnetsInAclCount] A count of the SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host_Hardware/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host_Hardware/_index.md index 56a2845f81..20328fa416 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host_Hardware/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host_Hardware/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The account to which this allowed host belongs to. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The account to which this allowed host belongs to. [credentialId]: #credentialid #### [credentialId] The credential this allowed host will use -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ The credential this allowed host will use [id]: #id #### [id] The internal identifier of the igroup -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The internal identifier of the igroup [name]: #name #### [name] The name of allowed host, usually an IQN or other identifier -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The name of allowed host, usually an IQN or other identifier [resourceTableId]: #resourcetableid #### [resourceTableId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The name of allowed host, usually an IQN or other identifier [resourceTableName]: #resourcetablename #### [resourceTableName] -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ The name of allowed host, usually an IQN or other identifier [account]: #account #### [account] The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -121,7 +130,8 @@ The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host b [assignedGroups]: #assignedgroups #### [assignedGroups] The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -131,7 +141,8 @@ The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allow [assignedIscsiVolumes]: #assignediscsivolumes #### [assignedIscsiVolumes] The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -141,7 +152,8 @@ The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Al [assignedNfsVolumes]: #assignednfsvolumes #### [assignedNfsVolumes] The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -151,7 +163,8 @@ The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Al [assignedReplicationVolumes]: #assignedreplicationvolumes #### [assignedReplicationVolumes] The SoftLayer_Network_Storage primary volumes whose replicas are allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -161,7 +174,8 @@ The SoftLayer_Network_Storage primary volumes whose replicas are allowed access. [assignedVolumes]: #assignedvolumes #### [assignedVolumes] The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -171,7 +185,8 @@ The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Al [credential]: #credential #### [credential] The SoftLayer_Network_Storage_Credential this allowed host uses. -Type: **SoftLayer_Network_Storage_Credential ** +Type: **SoftLayer_Network_Storage_Credential ** + @@ -181,7 +196,8 @@ The SoftLayer_Network_Storage_Credential this allowed host uses. [resource]: #resource #### [resource] The SoftLayer_Hardware object which this SoftLayer_Network_Storage_Allowed_Host is referencing. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -191,7 +207,8 @@ The SoftLayer_Hardware object which this SoftLayer_Network_Storage_Allowed_Host [sourceSubnet]: #sourcesubnet #### [sourceSubnet] Connections to a target with a source IP in this subnet prefix are allowed. -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ Connections to a target with a source IP in this subnet prefix are allowed. [subnetsInAcl]: #subnetsinacl #### [subnetsInAcl] The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -213,7 +231,8 @@ The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. [assignedGroupCount]: #assignedgroupcount #### [assignedGroupCount] A count of the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. -Type: **unsigned long** +Type: **unsigned long** + @@ -223,7 +242,8 @@ A count of the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_St [assignedIscsiVolumeCount]: #assignediscsivolumecount #### [assignedIscsiVolumeCount] A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -233,7 +253,8 @@ A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network [assignedNfsVolumeCount]: #assignednfsvolumecount #### [assignedNfsVolumeCount] A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -243,7 +264,8 @@ A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network [assignedReplicationVolumeCount]: #assignedreplicationvolumecount #### [assignedReplicationVolumeCount] A count of the SoftLayer_Network_Storage primary volumes whose replicas are allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -253,7 +275,8 @@ A count of the SoftLayer_Network_Storage primary volumes whose replicas are allo [assignedVolumeCount]: #assignedvolumecount #### [assignedVolumeCount] A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -263,7 +286,8 @@ A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network [subnetsInAclCount]: #subnetsinaclcount #### [subnetsInAclCount] A count of the SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host_IpAddress/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host_IpAddress/_index.md index 46db73b2f9..bb0f37daa3 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host_IpAddress/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host_IpAddress/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The account to which this allowed host belongs to. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The account to which this allowed host belongs to. [credentialId]: #credentialid #### [credentialId] The credential this allowed host will use -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ The credential this allowed host will use [id]: #id #### [id] The internal identifier of the igroup -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The internal identifier of the igroup [name]: #name #### [name] The name of allowed host, usually an IQN or other identifier -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The name of allowed host, usually an IQN or other identifier [resourceTableId]: #resourcetableid #### [resourceTableId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The name of allowed host, usually an IQN or other identifier [resourceTableName]: #resourcetablename #### [resourceTableName] -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ The name of allowed host, usually an IQN or other identifier [account]: #account #### [account] The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -121,7 +130,8 @@ The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host b [assignedGroups]: #assignedgroups #### [assignedGroups] The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -131,7 +141,8 @@ The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allow [assignedIscsiVolumes]: #assignediscsivolumes #### [assignedIscsiVolumes] The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -141,7 +152,8 @@ The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Al [assignedNfsVolumes]: #assignednfsvolumes #### [assignedNfsVolumes] The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -151,7 +163,8 @@ The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Al [assignedReplicationVolumes]: #assignedreplicationvolumes #### [assignedReplicationVolumes] The SoftLayer_Network_Storage primary volumes whose replicas are allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -161,7 +174,8 @@ The SoftLayer_Network_Storage primary volumes whose replicas are allowed access. [assignedVolumes]: #assignedvolumes #### [assignedVolumes] The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -171,7 +185,8 @@ The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Al [credential]: #credential #### [credential] The SoftLayer_Network_Storage_Credential this allowed host uses. -Type: **SoftLayer_Network_Storage_Credential ** +Type: **SoftLayer_Network_Storage_Credential ** + @@ -181,7 +196,8 @@ The SoftLayer_Network_Storage_Credential this allowed host uses. [resource]: #resource #### [resource] The SoftLayer_Network_Subnet_IpAddress object which this SoftLayer_Network_Storage_Allowed_Host is referencing. -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -191,7 +207,8 @@ The SoftLayer_Network_Subnet_IpAddress object which this SoftLayer_Network_Stora [sourceSubnet]: #sourcesubnet #### [sourceSubnet] Connections to a target with a source IP in this subnet prefix are allowed. -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ Connections to a target with a source IP in this subnet prefix are allowed. [subnetsInAcl]: #subnetsinacl #### [subnetsInAcl] The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -213,7 +231,8 @@ The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. [assignedGroupCount]: #assignedgroupcount #### [assignedGroupCount] A count of the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. -Type: **unsigned long** +Type: **unsigned long** + @@ -223,7 +242,8 @@ A count of the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_St [assignedIscsiVolumeCount]: #assignediscsivolumecount #### [assignedIscsiVolumeCount] A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -233,7 +253,8 @@ A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network [assignedNfsVolumeCount]: #assignednfsvolumecount #### [assignedNfsVolumeCount] A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -243,7 +264,8 @@ A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network [assignedReplicationVolumeCount]: #assignedreplicationvolumecount #### [assignedReplicationVolumeCount] A count of the SoftLayer_Network_Storage primary volumes whose replicas are allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -253,7 +275,8 @@ A count of the SoftLayer_Network_Storage primary volumes whose replicas are allo [assignedVolumeCount]: #assignedvolumecount #### [assignedVolumeCount] A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -263,7 +286,8 @@ A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network [subnetsInAclCount]: #subnetsinaclcount #### [subnetsInAclCount] A count of the SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host_Subnet/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host_Subnet/_index.md index ec9ae046fe..02bb47ddea 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host_Subnet/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host_Subnet/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The account to which this allowed host belongs to. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The account to which this allowed host belongs to. [credentialId]: #credentialid #### [credentialId] The credential this allowed host will use -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ The credential this allowed host will use [id]: #id #### [id] The internal identifier of the igroup -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The internal identifier of the igroup [name]: #name #### [name] The name of allowed host, usually an IQN or other identifier -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The name of allowed host, usually an IQN or other identifier [resourceTableId]: #resourcetableid #### [resourceTableId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The name of allowed host, usually an IQN or other identifier [resourceTableName]: #resourcetablename #### [resourceTableName] -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ The name of allowed host, usually an IQN or other identifier [account]: #account #### [account] The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -121,7 +130,8 @@ The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host b [assignedGroups]: #assignedgroups #### [assignedGroups] The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -131,7 +141,8 @@ The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allow [assignedIscsiVolumes]: #assignediscsivolumes #### [assignedIscsiVolumes] The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -141,7 +152,8 @@ The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Al [assignedNfsVolumes]: #assignednfsvolumes #### [assignedNfsVolumes] The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -151,7 +163,8 @@ The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Al [assignedReplicationVolumes]: #assignedreplicationvolumes #### [assignedReplicationVolumes] The SoftLayer_Network_Storage primary volumes whose replicas are allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -161,7 +174,8 @@ The SoftLayer_Network_Storage primary volumes whose replicas are allowed access. [assignedVolumes]: #assignedvolumes #### [assignedVolumes] The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -171,7 +185,8 @@ The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Al [credential]: #credential #### [credential] The SoftLayer_Network_Storage_Credential this allowed host uses. -Type: **SoftLayer_Network_Storage_Credential ** +Type: **SoftLayer_Network_Storage_Credential ** + @@ -181,7 +196,8 @@ The SoftLayer_Network_Storage_Credential this allowed host uses. [resource]: #resource #### [resource] The SoftLayer_Network_Subnet object which this SoftLayer_Network_Storage_Allowed_Host is referencing. -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + @@ -191,7 +207,8 @@ The SoftLayer_Network_Subnet object which this SoftLayer_Network_Storage_Allowed [sourceSubnet]: #sourcesubnet #### [sourceSubnet] Connections to a target with a source IP in this subnet prefix are allowed. -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ Connections to a target with a source IP in this subnet prefix are allowed. [subnetsInAcl]: #subnetsinacl #### [subnetsInAcl] The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -213,7 +231,8 @@ The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. [assignedGroupCount]: #assignedgroupcount #### [assignedGroupCount] A count of the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. -Type: **unsigned long** +Type: **unsigned long** + @@ -223,7 +242,8 @@ A count of the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_St [assignedIscsiVolumeCount]: #assignediscsivolumecount #### [assignedIscsiVolumeCount] A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -233,7 +253,8 @@ A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network [assignedNfsVolumeCount]: #assignednfsvolumecount #### [assignedNfsVolumeCount] A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -243,7 +264,8 @@ A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network [assignedReplicationVolumeCount]: #assignedreplicationvolumecount #### [assignedReplicationVolumeCount] A count of the SoftLayer_Network_Storage primary volumes whose replicas are allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -253,7 +275,8 @@ A count of the SoftLayer_Network_Storage primary volumes whose replicas are allo [assignedVolumeCount]: #assignedvolumecount #### [assignedVolumeCount] A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -263,7 +286,8 @@ A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network [subnetsInAclCount]: #subnetsinaclcount #### [subnetsInAclCount] A count of the SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/_index.md index 2106524ac0..9608ecc62a 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The account to which this allowed host belongs to. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The account to which this allowed host belongs to. [credentialId]: #credentialid #### [credentialId] The credential this allowed host will use -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ The credential this allowed host will use [id]: #id #### [id] The internal identifier of the igroup -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The internal identifier of the igroup [name]: #name #### [name] The name of allowed host, usually an IQN or other identifier -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The name of allowed host, usually an IQN or other identifier [resourceTableId]: #resourcetableid #### [resourceTableId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The name of allowed host, usually an IQN or other identifier [resourceTableName]: #resourcetablename #### [resourceTableName] -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ The name of allowed host, usually an IQN or other identifier [account]: #account #### [account] The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -121,7 +130,8 @@ The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host b [assignedGroups]: #assignedgroups #### [assignedGroups] The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -131,7 +141,8 @@ The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allow [assignedIscsiVolumes]: #assignediscsivolumes #### [assignedIscsiVolumes] The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -141,7 +152,8 @@ The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Al [assignedNfsVolumes]: #assignednfsvolumes #### [assignedNfsVolumes] The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -151,7 +163,8 @@ The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Al [assignedReplicationVolumes]: #assignedreplicationvolumes #### [assignedReplicationVolumes] The SoftLayer_Network_Storage primary volumes whose replicas are allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -161,7 +174,8 @@ The SoftLayer_Network_Storage primary volumes whose replicas are allowed access. [assignedVolumes]: #assignedvolumes #### [assignedVolumes] The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -171,7 +185,8 @@ The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Al [credential]: #credential #### [credential] The SoftLayer_Network_Storage_Credential this allowed host uses. -Type: **SoftLayer_Network_Storage_Credential ** +Type: **SoftLayer_Network_Storage_Credential ** + @@ -181,7 +196,8 @@ The SoftLayer_Network_Storage_Credential this allowed host uses. [resource]: #resource #### [resource] The SoftLayer_Virtual_Guest object which this SoftLayer_Network_Storage_Allowed_Host is referencing. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -191,7 +207,8 @@ The SoftLayer_Virtual_Guest object which this SoftLayer_Network_Storage_Allowed_ [sourceSubnet]: #sourcesubnet #### [sourceSubnet] Connections to a target with a source IP in this subnet prefix are allowed. -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ Connections to a target with a source IP in this subnet prefix are allowed. [subnetsInAcl]: #subnetsinacl #### [subnetsInAcl] The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -213,7 +231,8 @@ The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. [assignedGroupCount]: #assignedgroupcount #### [assignedGroupCount] A count of the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. -Type: **unsigned long** +Type: **unsigned long** + @@ -223,7 +242,8 @@ A count of the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_St [assignedIscsiVolumeCount]: #assignediscsivolumecount #### [assignedIscsiVolumeCount] A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -233,7 +253,8 @@ A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network [assignedNfsVolumeCount]: #assignednfsvolumecount #### [assignedNfsVolumeCount] A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -243,7 +264,8 @@ A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network [assignedReplicationVolumeCount]: #assignedreplicationvolumecount #### [assignedReplicationVolumeCount] A count of the SoftLayer_Network_Storage primary volumes whose replicas are allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -253,7 +275,8 @@ A count of the SoftLayer_Network_Storage primary volumes whose replicas are allo [assignedVolumeCount]: #assignedvolumecount #### [assignedVolumeCount] A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. -Type: **unsigned long** +Type: **unsigned long** + @@ -263,7 +286,8 @@ A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network [subnetsInAclCount]: #subnetsinaclcount #### [subnetsInAclCount] A count of the SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Backup/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Backup/_index.md index 31d6140b1c..3870bdee1d 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Backup/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Backup/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Storage_Backup contains general information regarding a St [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account that a Storage account belongs to. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of the SoftLayer customer account that a Storage account [capacityGb]: #capacitygb #### [capacityGb] A Storage account's capacity, measured in gigabytes. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A Storage account's capacity, measured in gigabytes. [createDate]: #createdate #### [createDate] The date a network storage volume was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date a network storage volume was created. [guestId]: #guestid #### [guestId] The unique identification number of the guest associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The unique identification number of the guest associated with a Storage volume. [hardwareId]: #hardwareid #### [hardwareId] The server that is associated with a Storage service. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The server that is associated with a Storage service. [hostId]: #hostid #### [hostId] The unique identification number of the host associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The unique identification number of the host associated with a Storage volume. [id]: #id #### [id] A Storage account's unique identifier. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A Storage account's unique identifier. [nasType]: #nastype #### [nasType] A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT", and "HUB". -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT" [notes]: #notes #### [notes] Public notes related to a Storage volume. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Public notes related to a Storage volume. [password]: #password #### [password] The password used to access a non-EVault Storage volume. This password is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The password used to access a non-EVault Storage volume. This password is used t [serviceProviderId]: #serviceproviderid #### [serviceProviderId] Service Provider ID -Type: **integer** +Type: **integer** + @@ -155,7 +168,8 @@ Service Provider ID [storageTypeId]: #storagetypeid #### [storageTypeId] A storage object's type. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ A storage object's type. [upgradableFlag]: #upgradableflag #### [upgradableFlag] This flag indicates whether this storage type is upgradable or not. -Type: **boolean** +Type: **boolean** + @@ -175,7 +190,8 @@ This flag indicates whether this storage type is upgradable or not. [username]: #username #### [username] The username used to access a non-EVault Storage volume. This username is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ The username used to access a non-EVault Storage volume. This username is used t [account]: #account #### [account] The account that a Storage services belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -201,7 +218,8 @@ The account that a Storage services belongs to. [accountPassword]: #accountpassword #### [accountPassword] Other usernames and passwords associated with a Storage volume. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -211,7 +229,19 @@ Other usernames and passwords associated with a Storage volume. [activeTransactions]: #activetransactions #### [activeTransactions] The currently active transactions on a network storage volume. -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + + + + +
      + +----- +[allowDisasterRecoveryFailback]: #allowdisasterrecoveryfailback +#### [allowDisasterRecoveryFailback] + +Type: **string** +
      @@ -221,7 +251,8 @@ The currently active transactions on a network storage volume. [allowDisasterRecoveryFailover]: #allowdisasterrecoveryfailover #### [allowDisasterRecoveryFailover] -Type: **string** +Type: **string** + @@ -231,7 +262,8 @@ The currently active transactions on a network storage volume. [allowedHardware]: #allowedhardware #### [allowedHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -241,7 +273,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume. [allowedIpAddresses]: #allowedipaddresses #### [allowedIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -251,7 +284,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationHardware]: #allowedreplicationhardware #### [allowedReplicationHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -261,7 +295,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedReplicationIpAddresses]: #allowedreplicationipaddresses #### [allowedReplicationIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -271,7 +306,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationSubnets]: #allowedreplicationsubnets #### [allowedReplicationSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -281,7 +317,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedReplicationVirtualGuests]: #allowedreplicationvirtualguests #### [allowedReplicationVirtualGuests] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -291,7 +328,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedSubnets]: #allowedsubnets #### [allowedSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -301,7 +339,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedVirtualGuests]: #allowedvirtualguests #### [allowedVirtualGuests] The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -311,7 +350,8 @@ The SoftLayer_Virtual_Guest objects which are allowed access to this storage vol [billingItem]: #billingitem #### [billingItem] The current billing item for a Storage volume. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -321,7 +361,8 @@ The current billing item for a Storage volume. [billingItemCategory]: #billingitemcategory #### [billingItemCategory] -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -331,7 +372,8 @@ The current billing item for a Storage volume. [bytesUsed]: #bytesused #### [bytesUsed] The amount of space used by the volume, in bytes. -Type: **string** +Type: **string** + @@ -341,7 +383,8 @@ The amount of space used by the volume, in bytes. [creationScheduleId]: #creationscheduleid #### [creationScheduleId] The schedule id which was executed to create a snapshot. -Type: **string** +Type: **string** + @@ -351,7 +394,8 @@ The schedule id which was executed to create a snapshot. [credentials]: #credentials #### [credentials] -Type: **SoftLayer_Network_Storage_Credential[] ** +Type: **SoftLayer_Network_Storage_Credential[] ** + @@ -361,7 +405,8 @@ The schedule id which was executed to create a snapshot. [currentCyclePeakUsage]: #currentcyclepeakusage #### [currentCyclePeakUsage] Peak number of bytes used in the vault for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -371,7 +416,8 @@ Peak number of bytes used in the vault for the current billing cycle. [dailySchedule]: #dailyschedule #### [dailySchedule] The Daily Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -381,7 +427,8 @@ The Daily Schedule which is associated with this network storage volume. [dependentDuplicate]: #dependentduplicate #### [dependentDuplicate] Whether or not a network storage volume is a dependent duplicate. -Type: **string** +Type: **string** + @@ -391,7 +438,8 @@ Whether or not a network storage volume is a dependent duplicate. [dependentDuplicates]: #dependentduplicates #### [dependentDuplicates] The network storage volumes configured to be dependent duplicates of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -401,7 +449,8 @@ The network storage volumes configured to be dependent duplicates of a volume. [events]: #events #### [events] The events which have taken place on a network storage volume. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -411,7 +460,19 @@ The events which have taken place on a network storage volume. [failbackNotAllowed]: #failbacknotallowed #### [failbackNotAllowed] Determines whether the volume is allowed to failback -Type: **string** +Type: **string** + + + + +
      + +----- +[failoverNotAllowed]: #failovernotallowed +#### [failoverNotAllowed] +Determines whether the volume is allowed to failover +Type: **string** +
      @@ -421,7 +482,8 @@ Determines whether the volume is allowed to failback [fileNetworkMountAddress]: #filenetworkmountaddress #### [fileNetworkMountAddress] Retrieves the NFS Network Mount Address Name for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -431,7 +493,8 @@ Retrieves the NFS Network Mount Address Name for a given File Storage Volume. [hardware]: #hardware #### [hardware] When applicable, the hardware associated with a Storage service. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -441,7 +504,8 @@ When applicable, the hardware associated with a Storage service. [hasEncryptionAtRest]: #hasencryptionatrest #### [hasEncryptionAtRest] -Type: **boolean** +Type: **boolean** + @@ -451,7 +515,8 @@ When applicable, the hardware associated with a Storage service. [hourlySchedule]: #hourlyschedule #### [hourlySchedule] The Hourly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -461,7 +526,8 @@ The Hourly Schedule which is associated with this network storage volume. [intervalSchedule]: #intervalschedule #### [intervalSchedule] The Interval Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -471,7 +537,8 @@ The Interval Schedule which is associated with this network storage volume. [iops]: #iops #### [iops] The maximum number of IOPs selected for this volume. -Type: **string** +Type: **string** + @@ -481,7 +548,8 @@ The maximum number of IOPs selected for this volume. [isDependentDuplicateProvisionCompleted]: #isdependentduplicateprovisioncompleted #### [isDependentDuplicateProvisionCompleted] Determines whether dependent volume provision is completed on background. -Type: **boolean** +Type: **boolean** + @@ -491,7 +559,8 @@ Determines whether dependent volume provision is completed on background. [isInDedicatedServiceResource]: #isindedicatedserviceresource #### [isInDedicatedServiceResource] -Type: **boolean** +Type: **boolean** + @@ -501,7 +570,8 @@ Determines whether dependent volume provision is completed on background. [isMagneticStorage]: #ismagneticstorage #### [isMagneticStorage] -Type: **string** +Type: **string** + @@ -511,7 +581,8 @@ Determines whether dependent volume provision is completed on background. [isReadyForSnapshot]: #isreadyforsnapshot #### [isReadyForSnapshot] Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. -Type: **boolean** +Type: **boolean** + @@ -521,7 +592,8 @@ Determines whether a volume is ready to order snapshot space, or, if snapshot sp [isReadyToMount]: #isreadytomount #### [isReadyToMount] Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. -Type: **boolean** +Type: **boolean** + @@ -531,7 +603,8 @@ Determines whether a volume is ready to have Hosts authorized to access it. This [iscsiLuns]: #iscsiluns #### [iscsiLuns] Relationship between a container volume and iSCSI LUNs. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -541,7 +614,8 @@ Relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddresses]: #iscsitargetipaddresses #### [iscsiTargetIpAddresses] Returns the target IP addresses of an iSCSI volume. -Type: **array of strings** +Type: **array of strings** + @@ -551,7 +625,8 @@ Returns the target IP addresses of an iSCSI volume. [lunId]: #lunid #### [lunId] The ID of the LUN volume. -Type: **string** +Type: **string** + @@ -561,7 +636,8 @@ The ID of the LUN volume. [manualSnapshots]: #manualsnapshots #### [manualSnapshots] The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -571,7 +647,8 @@ The manually-created snapshots associated with this SoftLayer_Network_Storage vo [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A network storage volume's metric tracking object. This object records all periodic polled data available to this volume. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -581,7 +658,8 @@ A network storage volume's metric tracking object. This object records all perio [mountPath]: #mountpath #### [mountPath] Retrieves the NFS Network Mount Path for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -591,7 +669,8 @@ Retrieves the NFS Network Mount Path for a given File Storage Volume. [mountableFlag]: #mountableflag #### [mountableFlag] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -601,7 +680,8 @@ Whether or not a network storage volume may be mounted. [moveAndSplitStatus]: #moveandsplitstatus #### [moveAndSplitStatus] The current status of split or move operation as a part of volume duplication. -Type: **string** +Type: **string** + @@ -611,7 +691,8 @@ The current status of split or move operation as a part of volume duplication. [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] The subscribers that will be notified for usage amount warnings and overages. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -621,7 +702,8 @@ The subscribers that will be notified for usage amount warnings and overages. [originalSnapshotName]: #originalsnapshotname #### [originalSnapshotName] The name of the snapshot that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -631,7 +713,8 @@ The name of the snapshot that this volume was duplicated from. [originalVolumeName]: #originalvolumename #### [originalVolumeName] The name of the volume that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -641,7 +724,8 @@ The name of the volume that this volume was duplicated from. [originalVolumeSize]: #originalvolumesize #### [originalVolumeSize] The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. -Type: **string** +Type: **string** + @@ -651,7 +735,8 @@ The size (in GB) of the volume or LUN before any size expansion, or of the volum [osType]: #ostype #### [osType] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -661,7 +746,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. [osTypeId]: #ostypeid #### [osTypeId] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. -Type: **string** +Type: **string** + @@ -671,7 +757,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. [parentPartnerships]: #parentpartnerships #### [parentPartnerships] The volumes or snapshots partnered with a network storage volume in a parental role. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -681,7 +768,8 @@ The volumes or snapshots partnered with a network storage volume in a parental r [parentVolume]: #parentvolume #### [parentVolume] The parent volume of a volume in a complex storage relationship. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -691,7 +779,8 @@ The parent volume of a volume in a complex storage relationship. [partnerships]: #partnerships #### [partnerships] The volumes or snapshots partnered with a network storage volume. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -701,7 +790,8 @@ The volumes or snapshots partnered with a network storage volume. [permissionsGroups]: #permissionsgroups #### [permissionsGroups] All permissions group(s) this volume is in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -711,7 +801,8 @@ All permissions group(s) this volume is in. [previousCyclePeakUsage]: #previouscyclepeakusage #### [previousCyclePeakUsage] Peak number of bytes used in the vault for the previous billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -721,7 +812,8 @@ Peak number of bytes used in the vault for the previous billing cycle. [properties]: #properties #### [properties] The properties used to provide additional details about a network storage volume. -Type: **SoftLayer_Network_Storage_Property[] ** +Type: **SoftLayer_Network_Storage_Property[] ** + @@ -731,7 +823,8 @@ The properties used to provide additional details about a network storage volume [provisionedIops]: #provisionediops #### [provisionedIops] The number of IOPs provisioned for this volume. -Type: **string** +Type: **string** + @@ -741,7 +834,8 @@ The number of IOPs provisioned for this volume. [replicatingLuns]: #replicatingluns #### [replicatingLuns] The iSCSI LUN volumes being replicated by this network storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -751,7 +845,8 @@ The iSCSI LUN volumes being replicated by this network storage volume. [replicatingVolume]: #replicatingvolume #### [replicatingVolume] The network storage volume being replicated by a volume. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -761,7 +856,8 @@ The network storage volume being replicated by a volume. [replicationEvents]: #replicationevents #### [replicationEvents] The volume replication events. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -771,7 +867,8 @@ The volume replication events. [replicationPartners]: #replicationpartners #### [replicationPartners] The network storage volumes configured to be replicants of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -781,7 +878,8 @@ The network storage volumes configured to be replicants of a volume. [replicationSchedule]: #replicationschedule #### [replicationSchedule] The Replication Schedule associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -791,7 +889,8 @@ The Replication Schedule associated with a network storage volume. [replicationStatus]: #replicationstatus #### [replicationStatus] The current replication status of a network storage volume. Indicates Failover or Failback status. -Type: **string** +Type: **string** + @@ -801,7 +900,8 @@ The current replication status of a network storage volume. Indicates Failover o [schedules]: #schedules #### [schedules] The schedules which are associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule[] ** +Type: **SoftLayer_Network_Storage_Schedule[] ** + @@ -811,7 +911,8 @@ The schedules which are associated with a network storage volume. [serviceResource]: #serviceresource #### [serviceResource] The network resource a Storage service is connected to. -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -821,7 +922,8 @@ The network resource a Storage service is connected to. [serviceResourceBackendIpAddress]: #serviceresourcebackendipaddress #### [serviceResourceBackendIpAddress] The IP address of a Storage resource. -Type: **string** +Type: **string** + @@ -831,7 +933,8 @@ The IP address of a Storage resource. [serviceResourceName]: #serviceresourcename #### [serviceResourceName] The name of a Storage's network resource. -Type: **string** +Type: **string** + @@ -841,7 +944,8 @@ The name of a Storage's network resource. [snapshotCapacityGb]: #snapshotcapacitygb #### [snapshotCapacityGb] A volume's configured snapshot space size. -Type: **string** +Type: **string** + @@ -851,7 +955,8 @@ A volume's configured snapshot space size. [snapshotCreationTimestamp]: #snapshotcreationtimestamp #### [snapshotCreationTimestamp] The creation timestamp of the snapshot on the storage platform. -Type: **string** +Type: **string** + @@ -861,7 +966,8 @@ The creation timestamp of the snapshot on the storage platform. [snapshotDeletionThresholdPercentage]: #snapshotdeletionthresholdpercentage #### [snapshotDeletionThresholdPercentage] The percentage of used snapshot space after which to delete automated snapshots. -Type: **string** +Type: **string** + @@ -871,7 +977,8 @@ The percentage of used snapshot space after which to delete automated snapshots. [snapshotNotificationStatus]: #snapshotnotificationstatus #### [snapshotNotificationStatus] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -881,7 +988,8 @@ Whether or not a network storage volume may be mounted. [snapshotSizeBytes]: #snapshotsizebytes #### [snapshotSizeBytes] The snapshot size in bytes. -Type: **string** +Type: **string** + @@ -891,7 +999,8 @@ The snapshot size in bytes. [snapshotSpaceAvailable]: #snapshotspaceavailable #### [snapshotSpaceAvailable] A volume's available snapshot reservation space. -Type: **string** +Type: **string** + @@ -901,7 +1010,8 @@ A volume's available snapshot reservation space. [snapshots]: #snapshots #### [snapshots] The snapshots associated with this SoftLayer_Network_Storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -911,7 +1021,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [staasVersion]: #staasversion #### [staasVersion] -Type: **string** +Type: **string** + @@ -921,7 +1032,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [storageGroups]: #storagegroups #### [storageGroups] The network storage groups this volume is attached to. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -931,7 +1043,8 @@ The network storage groups this volume is attached to. [storageTierLevel]: #storagetierlevel #### [storageTierLevel] -Type: **string** +Type: **string** + @@ -941,7 +1054,8 @@ The network storage groups this volume is attached to. [storageType]: #storagetype #### [storageType] A description of the Storage object. -Type: **SoftLayer_Network_Storage_Type ** +Type: **SoftLayer_Network_Storage_Type ** + @@ -951,7 +1065,8 @@ A description of the Storage object. [totalBytesUsed]: #totalbytesused #### [totalBytesUsed] The amount of space used by the volume. -Type: **string** +Type: **string** + @@ -961,7 +1076,8 @@ The amount of space used by the volume. [totalScheduleSnapshotRetentionCount]: #totalschedulesnapshotretentioncount #### [totalScheduleSnapshotRetentionCount] The total snapshot retention count of all schedules on this network storage volume. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -971,7 +1087,8 @@ The total snapshot retention count of all schedules on this network storage volu [usageNotification]: #usagenotification #### [usageNotification] The usage notification for SL Storage services. -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -981,7 +1098,8 @@ The usage notification for SL Storage services. [vendorName]: #vendorname #### [vendorName] The type of network storage service. -Type: **string** +Type: **string** + @@ -991,7 +1109,8 @@ The type of network storage service. [virtualGuest]: #virtualguest #### [virtualGuest] When applicable, the virtual guest associated with a Storage service. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -1001,7 +1120,8 @@ When applicable, the virtual guest associated with a Storage service. [volumeHistory]: #volumehistory #### [volumeHistory] The username and password history for a Storage service. -Type: **SoftLayer_Network_Storage_History[] ** +Type: **SoftLayer_Network_Storage_History[] ** + @@ -1011,7 +1131,8 @@ The username and password history for a Storage service. [volumeStatus]: #volumestatus #### [volumeStatus] The current status of a network storage volume. -Type: **string** +Type: **string** + @@ -1021,7 +1142,8 @@ The current status of a network storage volume. [webccAccount]: #webccaccount #### [webccAccount] The account username and password for the EVault webCC interface. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -1031,7 +1153,8 @@ The account username and password for the EVault webCC interface. [weeklySchedule]: #weeklyschedule #### [weeklySchedule] The Weekly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -1043,7 +1166,8 @@ The Weekly Schedule which is associated with this network storage volume. [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of the currently active transactions on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1177,8 @@ A count of the currently active transactions on a network storage volume. [allowedHardwareCount]: #allowedhardwarecount #### [allowedHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1188,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedIpAddressCount]: #allowedipaddresscount #### [allowedIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1199,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationHardwareCount]: #allowedreplicationhardwarecount #### [allowedReplicationHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1210,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedReplicationIpAddressCount]: #allowedreplicationipaddresscount #### [allowedReplicationIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1093,7 +1221,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationSubnetCount]: #allowedreplicationsubnetcount #### [allowedReplicationSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1103,7 +1232,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedReplicationVirtualGuestCount]: #allowedreplicationvirtualguestcount #### [allowedReplicationVirtualGuestCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1113,7 +1243,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedSubnetCount]: #allowedsubnetcount #### [allowedSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1123,7 +1254,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedVirtualGuestCount]: #allowedvirtualguestcount #### [allowedVirtualGuestCount] A count of the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1133,7 +1265,8 @@ A count of the SoftLayer_Virtual_Guest objects which are allowed access to this [credentialCount]: #credentialcount #### [credentialCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1143,7 +1276,8 @@ A count of [dependentDuplicateCount]: #dependentduplicatecount #### [dependentDuplicateCount] A count of the network storage volumes configured to be dependent duplicates of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1153,7 +1287,8 @@ A count of the network storage volumes configured to be dependent duplicates of [eventCount]: #eventcount #### [eventCount] A count of the events which have taken place on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1163,7 +1298,8 @@ A count of the events which have taken place on a network storage volume. [iscsiLunCount]: #iscsiluncount #### [iscsiLunCount] A count of relationship between a container volume and iSCSI LUNs. -Type: **unsigned long** +Type: **unsigned long** + @@ -1173,7 +1309,8 @@ A count of relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddressCount]: #iscsitargetipaddresscount #### [iscsiTargetIpAddressCount] A count of returns the target IP addresses of an iSCSI volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1183,7 +1320,8 @@ A count of returns the target IP addresses of an iSCSI volume. [manualSnapshotCount]: #manualsnapshotcount #### [manualSnapshotCount] A count of the manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **unsigned long** +Type: **unsigned long** + @@ -1193,7 +1331,8 @@ A count of the manually-created snapshots associated with this SoftLayer_Network [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of the subscribers that will be notified for usage amount warnings and overages. -Type: **unsigned long** +Type: **unsigned long** + @@ -1203,7 +1342,8 @@ A count of the subscribers that will be notified for usage amount warnings and o [parentPartnershipCount]: #parentpartnershipcount #### [parentPartnershipCount] A count of the volumes or snapshots partnered with a network storage volume in a parental role. -Type: **unsigned long** +Type: **unsigned long** + @@ -1213,7 +1353,8 @@ A count of the volumes or snapshots partnered with a network storage volume in a [partnershipCount]: #partnershipcount #### [partnershipCount] A count of the volumes or snapshots partnered with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1223,7 +1364,8 @@ A count of the volumes or snapshots partnered with a network storage volume. [permissionsGroupCount]: #permissionsgroupcount #### [permissionsGroupCount] A count of all permissions group(s) this volume is in. -Type: **unsigned long** +Type: **unsigned long** + @@ -1233,7 +1375,8 @@ A count of all permissions group(s) this volume is in. [propertyCount]: #propertycount #### [propertyCount] A count of the properties used to provide additional details about a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1243,7 +1386,8 @@ A count of the properties used to provide additional details about a network sto [replicatingLunCount]: #replicatingluncount #### [replicatingLunCount] A count of the iSCSI LUN volumes being replicated by this network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1253,7 +1397,8 @@ A count of the iSCSI LUN volumes being replicated by this network storage volume [replicationEventCount]: #replicationeventcount #### [replicationEventCount] A count of the volume replication events. -Type: **unsigned long** +Type: **unsigned long** + @@ -1263,7 +1408,8 @@ A count of the volume replication events. [replicationPartnerCount]: #replicationpartnercount #### [replicationPartnerCount] A count of the network storage volumes configured to be replicants of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1273,7 +1419,8 @@ A count of the network storage volumes configured to be replicants of a volume. [scheduleCount]: #schedulecount #### [scheduleCount] A count of the schedules which are associated with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1283,7 +1430,8 @@ A count of the schedules which are associated with a network storage volume. [snapshotCount]: #snapshotcount #### [snapshotCount] A count of the snapshots associated with this SoftLayer_Network_Storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1293,7 +1441,8 @@ A count of the snapshots associated with this SoftLayer_Network_Storage volume. [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of the network storage groups this volume is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1303,7 +1452,8 @@ A count of the network storage groups this volume is attached to. [volumeHistoryCount]: #volumehistorycount #### [volumeHistoryCount] A count of the username and password history for a Storage service. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Backup_Evault/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Backup_Evault/_index.md index d77916a80f..6dc80fa17b 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Backup_Evault/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Backup_Evault/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Storage_Backup_Evault contains general information regardi [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account that a Storage account belongs to. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of the SoftLayer customer account that a Storage account [capacityGb]: #capacitygb #### [capacityGb] A Storage account's capacity, measured in gigabytes. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A Storage account's capacity, measured in gigabytes. [createDate]: #createdate #### [createDate] The date a network storage volume was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date a network storage volume was created. [guestId]: #guestid #### [guestId] The unique identification number of the guest associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The unique identification number of the guest associated with a Storage volume. [hardwareId]: #hardwareid #### [hardwareId] The server that is associated with a Storage service. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The server that is associated with a Storage service. [hostId]: #hostid #### [hostId] The unique identification number of the host associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The unique identification number of the host associated with a Storage volume. [id]: #id #### [id] A Storage account's unique identifier. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A Storage account's unique identifier. [nasType]: #nastype #### [nasType] A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT", and "HUB". -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT" [notes]: #notes #### [notes] Public notes related to a Storage volume. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Public notes related to a Storage volume. [password]: #password #### [password] The password used to access a non-EVault Storage volume. This password is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The password used to access a non-EVault Storage volume. This password is used t [serviceProviderId]: #serviceproviderid #### [serviceProviderId] Service Provider ID -Type: **integer** +Type: **integer** + @@ -155,7 +168,8 @@ Service Provider ID [storageTypeId]: #storagetypeid #### [storageTypeId] A storage object's type. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ A storage object's type. [upgradableFlag]: #upgradableflag #### [upgradableFlag] This flag indicates whether this storage type is upgradable or not. -Type: **boolean** +Type: **boolean** + @@ -175,7 +190,8 @@ This flag indicates whether this storage type is upgradable or not. [username]: #username #### [username] The username used to access a non-EVault Storage volume. This username is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ The username used to access a non-EVault Storage volume. This username is used t [account]: #account #### [account] The account that a Storage services belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -201,7 +218,8 @@ The account that a Storage services belongs to. [accountPassword]: #accountpassword #### [accountPassword] Other usernames and passwords associated with a Storage volume. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -211,7 +229,19 @@ Other usernames and passwords associated with a Storage volume. [activeTransactions]: #activetransactions #### [activeTransactions] The currently active transactions on a network storage volume. -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + + + + +
      + +----- +[allowDisasterRecoveryFailback]: #allowdisasterrecoveryfailback +#### [allowDisasterRecoveryFailback] + +Type: **string** +
      @@ -221,7 +251,8 @@ The currently active transactions on a network storage volume. [allowDisasterRecoveryFailover]: #allowdisasterrecoveryfailover #### [allowDisasterRecoveryFailover] -Type: **string** +Type: **string** + @@ -231,7 +262,8 @@ The currently active transactions on a network storage volume. [allowedHardware]: #allowedhardware #### [allowedHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -241,7 +273,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume. [allowedIpAddresses]: #allowedipaddresses #### [allowedIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -251,7 +284,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationHardware]: #allowedreplicationhardware #### [allowedReplicationHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -261,7 +295,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedReplicationIpAddresses]: #allowedreplicationipaddresses #### [allowedReplicationIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -271,7 +306,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationSubnets]: #allowedreplicationsubnets #### [allowedReplicationSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -281,7 +317,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedReplicationVirtualGuests]: #allowedreplicationvirtualguests #### [allowedReplicationVirtualGuests] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -291,7 +328,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedSubnets]: #allowedsubnets #### [allowedSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -301,7 +339,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedVirtualGuests]: #allowedvirtualguests #### [allowedVirtualGuests] The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -311,7 +350,8 @@ The SoftLayer_Virtual_Guest objects which are allowed access to this storage vol [billingItem]: #billingitem #### [billingItem] The current billing item for the Storage volume. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -321,7 +361,8 @@ The current billing item for the Storage volume. [billingItemCategory]: #billingitemcategory #### [billingItemCategory] -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -331,7 +372,8 @@ The current billing item for the Storage volume. [bytesUsed]: #bytesused #### [bytesUsed] The amount of space used by the volume, in bytes. -Type: **string** +Type: **string** + @@ -341,7 +383,8 @@ The amount of space used by the volume, in bytes. [creationScheduleId]: #creationscheduleid #### [creationScheduleId] The schedule id which was executed to create a snapshot. -Type: **string** +Type: **string** + @@ -351,7 +394,8 @@ The schedule id which was executed to create a snapshot. [credentials]: #credentials #### [credentials] -Type: **SoftLayer_Network_Storage_Credential[] ** +Type: **SoftLayer_Network_Storage_Credential[] ** + @@ -361,7 +405,8 @@ The schedule id which was executed to create a snapshot. [currentCyclePeakUsage]: #currentcyclepeakusage #### [currentCyclePeakUsage] Peak number of bytes used in the vault for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -371,7 +416,8 @@ Peak number of bytes used in the vault for the current billing cycle. [dailySchedule]: #dailyschedule #### [dailySchedule] The Daily Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -381,7 +427,8 @@ The Daily Schedule which is associated with this network storage volume. [dependentDuplicate]: #dependentduplicate #### [dependentDuplicate] Whether or not a network storage volume is a dependent duplicate. -Type: **string** +Type: **string** + @@ -391,7 +438,8 @@ Whether or not a network storage volume is a dependent duplicate. [dependentDuplicates]: #dependentduplicates #### [dependentDuplicates] The network storage volumes configured to be dependent duplicates of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -401,7 +449,8 @@ The network storage volumes configured to be dependent duplicates of a volume. [events]: #events #### [events] The events which have taken place on a network storage volume. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -411,7 +460,19 @@ The events which have taken place on a network storage volume. [failbackNotAllowed]: #failbacknotallowed #### [failbackNotAllowed] Determines whether the volume is allowed to failback -Type: **string** +Type: **string** + + + + +
      + +----- +[failoverNotAllowed]: #failovernotallowed +#### [failoverNotAllowed] +Determines whether the volume is allowed to failover +Type: **string** +
      @@ -421,7 +482,8 @@ Determines whether the volume is allowed to failback [fileNetworkMountAddress]: #filenetworkmountaddress #### [fileNetworkMountAddress] Retrieves the NFS Network Mount Address Name for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -431,7 +493,8 @@ Retrieves the NFS Network Mount Address Name for a given File Storage Volume. [hardware]: #hardware #### [hardware] When applicable, the hardware associated with a Storage service. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -441,7 +504,8 @@ When applicable, the hardware associated with a Storage service. [hasEncryptionAtRest]: #hasencryptionatrest #### [hasEncryptionAtRest] -Type: **boolean** +Type: **boolean** + @@ -451,7 +515,8 @@ When applicable, the hardware associated with a Storage service. [hourlySchedule]: #hourlyschedule #### [hourlySchedule] The Hourly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -461,7 +526,8 @@ The Hourly Schedule which is associated with this network storage volume. [intervalSchedule]: #intervalschedule #### [intervalSchedule] The Interval Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -471,7 +537,8 @@ The Interval Schedule which is associated with this network storage volume. [iops]: #iops #### [iops] The maximum number of IOPs selected for this volume. -Type: **string** +Type: **string** + @@ -481,7 +548,8 @@ The maximum number of IOPs selected for this volume. [isDependentDuplicateProvisionCompleted]: #isdependentduplicateprovisioncompleted #### [isDependentDuplicateProvisionCompleted] Determines whether dependent volume provision is completed on background. -Type: **boolean** +Type: **boolean** + @@ -491,7 +559,8 @@ Determines whether dependent volume provision is completed on background. [isInDedicatedServiceResource]: #isindedicatedserviceresource #### [isInDedicatedServiceResource] -Type: **boolean** +Type: **boolean** + @@ -501,7 +570,8 @@ Determines whether dependent volume provision is completed on background. [isMagneticStorage]: #ismagneticstorage #### [isMagneticStorage] -Type: **string** +Type: **string** + @@ -511,7 +581,8 @@ Determines whether dependent volume provision is completed on background. [isReadyForSnapshot]: #isreadyforsnapshot #### [isReadyForSnapshot] Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. -Type: **boolean** +Type: **boolean** + @@ -521,7 +592,8 @@ Determines whether a volume is ready to order snapshot space, or, if snapshot sp [isReadyToMount]: #isreadytomount #### [isReadyToMount] Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. -Type: **boolean** +Type: **boolean** + @@ -531,7 +603,8 @@ Determines whether a volume is ready to have Hosts authorized to access it. This [iscsiLuns]: #iscsiluns #### [iscsiLuns] Relationship between a container volume and iSCSI LUNs. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -541,7 +614,8 @@ Relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddresses]: #iscsitargetipaddresses #### [iscsiTargetIpAddresses] Returns the target IP addresses of an iSCSI volume. -Type: **array of strings** +Type: **array of strings** + @@ -551,7 +625,8 @@ Returns the target IP addresses of an iSCSI volume. [lunId]: #lunid #### [lunId] The ID of the LUN volume. -Type: **string** +Type: **string** + @@ -561,7 +636,8 @@ The ID of the LUN volume. [manualSnapshots]: #manualsnapshots #### [manualSnapshots] The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -571,7 +647,8 @@ The manually-created snapshots associated with this SoftLayer_Network_Storage vo [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A network storage volume's metric tracking object. This object records all periodic polled data available to this volume. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -581,7 +658,8 @@ A network storage volume's metric tracking object. This object records all perio [mountPath]: #mountpath #### [mountPath] Retrieves the NFS Network Mount Path for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -591,7 +669,8 @@ Retrieves the NFS Network Mount Path for a given File Storage Volume. [mountableFlag]: #mountableflag #### [mountableFlag] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -601,7 +680,8 @@ Whether or not a network storage volume may be mounted. [moveAndSplitStatus]: #moveandsplitstatus #### [moveAndSplitStatus] The current status of split or move operation as a part of volume duplication. -Type: **string** +Type: **string** + @@ -611,7 +691,8 @@ The current status of split or move operation as a part of volume duplication. [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] The subscribers that will be notified for usage amount warnings and overages. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -621,7 +702,8 @@ The subscribers that will be notified for usage amount warnings and overages. [originalSnapshotName]: #originalsnapshotname #### [originalSnapshotName] The name of the snapshot that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -631,7 +713,8 @@ The name of the snapshot that this volume was duplicated from. [originalVolumeName]: #originalvolumename #### [originalVolumeName] The name of the volume that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -641,7 +724,8 @@ The name of the volume that this volume was duplicated from. [originalVolumeSize]: #originalvolumesize #### [originalVolumeSize] The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. -Type: **string** +Type: **string** + @@ -651,7 +735,8 @@ The size (in GB) of the volume or LUN before any size expansion, or of the volum [osType]: #ostype #### [osType] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -661,7 +746,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. [osTypeId]: #ostypeid #### [osTypeId] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. -Type: **string** +Type: **string** + @@ -671,7 +757,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. [parentPartnerships]: #parentpartnerships #### [parentPartnerships] The volumes or snapshots partnered with a network storage volume in a parental role. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -681,7 +768,8 @@ The volumes or snapshots partnered with a network storage volume in a parental r [parentVolume]: #parentvolume #### [parentVolume] The parent volume of a volume in a complex storage relationship. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -691,7 +779,8 @@ The parent volume of a volume in a complex storage relationship. [partnerships]: #partnerships #### [partnerships] The volumes or snapshots partnered with a network storage volume. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -701,7 +790,8 @@ The volumes or snapshots partnered with a network storage volume. [permissionsGroups]: #permissionsgroups #### [permissionsGroups] All permissions group(s) this volume is in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -711,7 +801,8 @@ All permissions group(s) this volume is in. [previousCyclePeakUsage]: #previouscyclepeakusage #### [previousCyclePeakUsage] Peak number of bytes used in the vault for the previous billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -721,7 +812,8 @@ Peak number of bytes used in the vault for the previous billing cycle. [properties]: #properties #### [properties] The properties used to provide additional details about a network storage volume. -Type: **SoftLayer_Network_Storage_Property[] ** +Type: **SoftLayer_Network_Storage_Property[] ** + @@ -731,7 +823,8 @@ The properties used to provide additional details about a network storage volume [provisionedIops]: #provisionediops #### [provisionedIops] The number of IOPs provisioned for this volume. -Type: **string** +Type: **string** + @@ -741,7 +834,8 @@ The number of IOPs provisioned for this volume. [replicatingLuns]: #replicatingluns #### [replicatingLuns] The iSCSI LUN volumes being replicated by this network storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -751,7 +845,8 @@ The iSCSI LUN volumes being replicated by this network storage volume. [replicatingVolume]: #replicatingvolume #### [replicatingVolume] The network storage volume being replicated by a volume. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -761,7 +856,8 @@ The network storage volume being replicated by a volume. [replicationEvents]: #replicationevents #### [replicationEvents] The volume replication events. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -771,7 +867,8 @@ The volume replication events. [replicationPartners]: #replicationpartners #### [replicationPartners] The network storage volumes configured to be replicants of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -781,7 +878,8 @@ The network storage volumes configured to be replicants of a volume. [replicationSchedule]: #replicationschedule #### [replicationSchedule] The Replication Schedule associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -791,7 +889,8 @@ The Replication Schedule associated with a network storage volume. [replicationStatus]: #replicationstatus #### [replicationStatus] The current replication status of a network storage volume. Indicates Failover or Failback status. -Type: **string** +Type: **string** + @@ -801,7 +900,8 @@ The current replication status of a network storage volume. Indicates Failover o [schedules]: #schedules #### [schedules] The schedules which are associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule[] ** +Type: **SoftLayer_Network_Storage_Schedule[] ** + @@ -811,7 +911,8 @@ The schedules which are associated with a network storage volume. [serviceResource]: #serviceresource #### [serviceResource] The network resource a Storage service is connected to. -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -821,7 +922,8 @@ The network resource a Storage service is connected to. [serviceResourceBackendIpAddress]: #serviceresourcebackendipaddress #### [serviceResourceBackendIpAddress] The IP address of a Storage resource. -Type: **string** +Type: **string** + @@ -831,7 +933,8 @@ The IP address of a Storage resource. [serviceResourceName]: #serviceresourcename #### [serviceResourceName] The name of a Storage's network resource. -Type: **string** +Type: **string** + @@ -841,7 +944,8 @@ The name of a Storage's network resource. [snapshotCapacityGb]: #snapshotcapacitygb #### [snapshotCapacityGb] A volume's configured snapshot space size. -Type: **string** +Type: **string** + @@ -851,7 +955,8 @@ A volume's configured snapshot space size. [snapshotCreationTimestamp]: #snapshotcreationtimestamp #### [snapshotCreationTimestamp] The creation timestamp of the snapshot on the storage platform. -Type: **string** +Type: **string** + @@ -861,7 +966,8 @@ The creation timestamp of the snapshot on the storage platform. [snapshotDeletionThresholdPercentage]: #snapshotdeletionthresholdpercentage #### [snapshotDeletionThresholdPercentage] The percentage of used snapshot space after which to delete automated snapshots. -Type: **string** +Type: **string** + @@ -871,7 +977,8 @@ The percentage of used snapshot space after which to delete automated snapshots. [snapshotNotificationStatus]: #snapshotnotificationstatus #### [snapshotNotificationStatus] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -881,7 +988,8 @@ Whether or not a network storage volume may be mounted. [snapshotSizeBytes]: #snapshotsizebytes #### [snapshotSizeBytes] The snapshot size in bytes. -Type: **string** +Type: **string** + @@ -891,7 +999,8 @@ The snapshot size in bytes. [snapshotSpaceAvailable]: #snapshotspaceavailable #### [snapshotSpaceAvailable] A volume's available snapshot reservation space. -Type: **string** +Type: **string** + @@ -901,7 +1010,8 @@ A volume's available snapshot reservation space. [snapshots]: #snapshots #### [snapshots] The snapshots associated with this SoftLayer_Network_Storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -911,7 +1021,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [staasVersion]: #staasversion #### [staasVersion] -Type: **string** +Type: **string** + @@ -921,7 +1032,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [storageGroups]: #storagegroups #### [storageGroups] The network storage groups this volume is attached to. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -931,7 +1043,8 @@ The network storage groups this volume is attached to. [storageTierLevel]: #storagetierlevel #### [storageTierLevel] -Type: **string** +Type: **string** + @@ -941,7 +1054,8 @@ The network storage groups this volume is attached to. [storageType]: #storagetype #### [storageType] A description of the Storage object. -Type: **SoftLayer_Network_Storage_Type ** +Type: **SoftLayer_Network_Storage_Type ** + @@ -951,7 +1065,8 @@ A description of the Storage object. [totalBytesUsed]: #totalbytesused #### [totalBytesUsed] The amount of space used by the volume. -Type: **string** +Type: **string** + @@ -961,7 +1076,8 @@ The amount of space used by the volume. [totalScheduleSnapshotRetentionCount]: #totalschedulesnapshotretentioncount #### [totalScheduleSnapshotRetentionCount] The total snapshot retention count of all schedules on this network storage volume. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -971,7 +1087,8 @@ The total snapshot retention count of all schedules on this network storage volu [usageNotification]: #usagenotification #### [usageNotification] The usage notification for SL Storage services. -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -981,7 +1098,8 @@ The usage notification for SL Storage services. [vendorName]: #vendorname #### [vendorName] The type of network storage service. -Type: **string** +Type: **string** + @@ -991,7 +1109,8 @@ The type of network storage service. [virtualGuest]: #virtualguest #### [virtualGuest] When applicable, the virtual guest associated with a Storage service. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -1001,7 +1120,8 @@ When applicable, the virtual guest associated with a Storage service. [volumeHistory]: #volumehistory #### [volumeHistory] The username and password history for a Storage service. -Type: **SoftLayer_Network_Storage_History[] ** +Type: **SoftLayer_Network_Storage_History[] ** + @@ -1011,7 +1131,8 @@ The username and password history for a Storage service. [volumeStatus]: #volumestatus #### [volumeStatus] The current status of a network storage volume. -Type: **string** +Type: **string** + @@ -1021,7 +1142,8 @@ The current status of a network storage volume. [webccAccount]: #webccaccount #### [webccAccount] The account username and password for the EVault webCC interface. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -1031,7 +1153,8 @@ The account username and password for the EVault webCC interface. [weeklySchedule]: #weeklyschedule #### [weeklySchedule] The Weekly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -1043,7 +1166,8 @@ The Weekly Schedule which is associated with this network storage volume. [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of the currently active transactions on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1177,8 @@ A count of the currently active transactions on a network storage volume. [allowedHardwareCount]: #allowedhardwarecount #### [allowedHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1188,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedIpAddressCount]: #allowedipaddresscount #### [allowedIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1199,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationHardwareCount]: #allowedreplicationhardwarecount #### [allowedReplicationHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1210,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedReplicationIpAddressCount]: #allowedreplicationipaddresscount #### [allowedReplicationIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1093,7 +1221,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationSubnetCount]: #allowedreplicationsubnetcount #### [allowedReplicationSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1103,7 +1232,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedReplicationVirtualGuestCount]: #allowedreplicationvirtualguestcount #### [allowedReplicationVirtualGuestCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1113,7 +1243,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedSubnetCount]: #allowedsubnetcount #### [allowedSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1123,7 +1254,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedVirtualGuestCount]: #allowedvirtualguestcount #### [allowedVirtualGuestCount] A count of the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1133,7 +1265,8 @@ A count of the SoftLayer_Virtual_Guest objects which are allowed access to this [credentialCount]: #credentialcount #### [credentialCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1143,7 +1276,8 @@ A count of [dependentDuplicateCount]: #dependentduplicatecount #### [dependentDuplicateCount] A count of the network storage volumes configured to be dependent duplicates of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1153,7 +1287,8 @@ A count of the network storage volumes configured to be dependent duplicates of [eventCount]: #eventcount #### [eventCount] A count of the events which have taken place on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1163,7 +1298,8 @@ A count of the events which have taken place on a network storage volume. [iscsiLunCount]: #iscsiluncount #### [iscsiLunCount] A count of relationship between a container volume and iSCSI LUNs. -Type: **unsigned long** +Type: **unsigned long** + @@ -1173,7 +1309,8 @@ A count of relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddressCount]: #iscsitargetipaddresscount #### [iscsiTargetIpAddressCount] A count of returns the target IP addresses of an iSCSI volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1183,7 +1320,8 @@ A count of returns the target IP addresses of an iSCSI volume. [manualSnapshotCount]: #manualsnapshotcount #### [manualSnapshotCount] A count of the manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **unsigned long** +Type: **unsigned long** + @@ -1193,7 +1331,8 @@ A count of the manually-created snapshots associated with this SoftLayer_Network [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of the subscribers that will be notified for usage amount warnings and overages. -Type: **unsigned long** +Type: **unsigned long** + @@ -1203,7 +1342,8 @@ A count of the subscribers that will be notified for usage amount warnings and o [parentPartnershipCount]: #parentpartnershipcount #### [parentPartnershipCount] A count of the volumes or snapshots partnered with a network storage volume in a parental role. -Type: **unsigned long** +Type: **unsigned long** + @@ -1213,7 +1353,8 @@ A count of the volumes or snapshots partnered with a network storage volume in a [partnershipCount]: #partnershipcount #### [partnershipCount] A count of the volumes or snapshots partnered with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1223,7 +1364,8 @@ A count of the volumes or snapshots partnered with a network storage volume. [permissionsGroupCount]: #permissionsgroupcount #### [permissionsGroupCount] A count of all permissions group(s) this volume is in. -Type: **unsigned long** +Type: **unsigned long** + @@ -1233,7 +1375,8 @@ A count of all permissions group(s) this volume is in. [propertyCount]: #propertycount #### [propertyCount] A count of the properties used to provide additional details about a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1243,7 +1386,8 @@ A count of the properties used to provide additional details about a network sto [replicatingLunCount]: #replicatingluncount #### [replicatingLunCount] A count of the iSCSI LUN volumes being replicated by this network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1253,7 +1397,8 @@ A count of the iSCSI LUN volumes being replicated by this network storage volume [replicationEventCount]: #replicationeventcount #### [replicationEventCount] A count of the volume replication events. -Type: **unsigned long** +Type: **unsigned long** + @@ -1263,7 +1408,8 @@ A count of the volume replication events. [replicationPartnerCount]: #replicationpartnercount #### [replicationPartnerCount] A count of the network storage volumes configured to be replicants of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1273,7 +1419,8 @@ A count of the network storage volumes configured to be replicants of a volume. [scheduleCount]: #schedulecount #### [scheduleCount] A count of the schedules which are associated with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1283,7 +1430,8 @@ A count of the schedules which are associated with a network storage volume. [snapshotCount]: #snapshotcount #### [snapshotCount] A count of the snapshots associated with this SoftLayer_Network_Storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1293,7 +1441,8 @@ A count of the snapshots associated with this SoftLayer_Network_Storage volume. [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of the network storage groups this volume is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1303,7 +1452,8 @@ A count of the network storage groups this volume is attached to. [volumeHistoryCount]: #volumehistorycount #### [volumeHistoryCount] A count of the username and password history for a Storage service. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Backup_Evault_Version6/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Backup_Evault_Version6/_index.md index 04f5c2a380..2988ccef27 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Backup_Evault_Version6/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Backup_Evault_Version6/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -50,7 +52,8 @@ The SoftLayer_Network_Storage_Backup_Evault_Version6 contains the same propertie [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account that a Storage account belongs to. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ The internal identifier of the SoftLayer customer account that a Storage account [capacityGb]: #capacitygb #### [capacityGb] A Storage account's capacity, measured in gigabytes. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ A Storage account's capacity, measured in gigabytes. [createDate]: #createdate #### [createDate] The date a network storage volume was created. -Type: **dateTime** +Type: **dateTime** + @@ -80,7 +85,8 @@ The date a network storage volume was created. [guestId]: #guestid #### [guestId] The unique identification number of the guest associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -90,7 +96,8 @@ The unique identification number of the guest associated with a Storage volume. [hardwareId]: #hardwareid #### [hardwareId] The server that is associated with a Storage service. -Type: **integer** +Type: **integer** + @@ -100,7 +107,8 @@ The server that is associated with a Storage service. [hostId]: #hostid #### [hostId] The unique identification number of the host associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -110,7 +118,8 @@ The unique identification number of the host associated with a Storage volume. [id]: #id #### [id] A Storage account's unique identifier. -Type: **integer** +Type: **integer** + @@ -120,7 +129,8 @@ A Storage account's unique identifier. [notes]: #notes #### [notes] Public notes related to a Storage volume. -Type: **string** +Type: **string** + @@ -130,7 +140,8 @@ Public notes related to a Storage volume. [password]: #password #### [password] The password used to access a non-EVault Storage volume. This password is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -140,7 +151,8 @@ The password used to access a non-EVault Storage volume. This password is used t [serviceProviderId]: #serviceproviderid #### [serviceProviderId] Service Provider ID -Type: **integer** +Type: **integer** + @@ -150,7 +162,8 @@ Service Provider ID [storageTypeId]: #storagetypeid #### [storageTypeId] A storage object's type. -Type: **string** +Type: **string** + @@ -160,7 +173,8 @@ A storage object's type. [upgradableFlag]: #upgradableflag #### [upgradableFlag] This flag indicates whether this storage type is upgradable or not. -Type: **boolean** +Type: **boolean** + @@ -170,7 +184,8 @@ This flag indicates whether this storage type is upgradable or not. [username]: #username #### [username] The username used to access a non-EVault Storage volume. This username is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -186,7 +201,8 @@ The username used to access a non-EVault Storage volume. This username is used t [account]: #account #### [account] The account that a Storage services belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -196,7 +212,8 @@ The account that a Storage services belongs to. [accountPassword]: #accountpassword #### [accountPassword] Other usernames and passwords associated with a Storage volume. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -206,7 +223,8 @@ Other usernames and passwords associated with a Storage volume. [activeTransactions]: #activetransactions #### [activeTransactions] The currently active transactions on a network storage volume. -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + @@ -216,7 +234,19 @@ The currently active transactions on a network storage volume. [agentStatuses]: #agentstatuses #### [agentStatuses] Statuses (most of the time will be one status) for the agent tied to the EVault Storage services. -Type: **SoftLayer_Container_Network_Storage_Evault_WebCc_AgentStatus[] ** +Type: **SoftLayer_Container_Network_Storage_Evault_WebCc_AgentStatus[] ** + + + + +
      + +----- +[allowDisasterRecoveryFailback]: #allowdisasterrecoveryfailback +#### [allowDisasterRecoveryFailback] + +Type: **string** +
      @@ -226,7 +256,8 @@ Statuses (most of the time will be one status) for the agent tied to the EVault [allowDisasterRecoveryFailover]: #allowdisasterrecoveryfailover #### [allowDisasterRecoveryFailover] -Type: **string** +Type: **string** + @@ -236,7 +267,8 @@ Statuses (most of the time will be one status) for the agent tied to the EVault [allowedHardware]: #allowedhardware #### [allowedHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -246,7 +278,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume. [allowedIpAddresses]: #allowedipaddresses #### [allowedIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -256,7 +289,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationHardware]: #allowedreplicationhardware #### [allowedReplicationHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -266,7 +300,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedReplicationIpAddresses]: #allowedreplicationipaddresses #### [allowedReplicationIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -276,7 +311,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationSubnets]: #allowedreplicationsubnets #### [allowedReplicationSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -286,7 +322,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedReplicationVirtualGuests]: #allowedreplicationvirtualguests #### [allowedReplicationVirtualGuests] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -296,7 +333,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedSubnets]: #allowedsubnets #### [allowedSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -306,7 +344,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedVirtualGuests]: #allowedvirtualguests #### [allowedVirtualGuests] The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -316,7 +355,8 @@ The SoftLayer_Virtual_Guest objects which are allowed access to this storage vol [backupJobDetails]: #backupjobdetails #### [backupJobDetails] All the of the backup jobs for the EVault Storage account. -Type: **SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails[] ** +Type: **SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails[] ** + @@ -326,7 +366,8 @@ All the of the backup jobs for the EVault Storage account. [billingItem]: #billingitem #### [billingItem] The current billing item for the Storage volume. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -336,7 +377,8 @@ The current billing item for the Storage volume. [billingItemCategory]: #billingitemcategory #### [billingItemCategory] -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -346,7 +388,8 @@ The current billing item for the Storage volume. [bytesUsed]: #bytesused #### [bytesUsed] The amount of space used by the volume, in bytes. -Type: **string** +Type: **string** + @@ -356,7 +399,8 @@ The amount of space used by the volume, in bytes. [creationScheduleId]: #creationscheduleid #### [creationScheduleId] The schedule id which was executed to create a snapshot. -Type: **string** +Type: **string** + @@ -366,7 +410,8 @@ The schedule id which was executed to create a snapshot. [credentials]: #credentials #### [credentials] -Type: **SoftLayer_Network_Storage_Credential[] ** +Type: **SoftLayer_Network_Storage_Credential[] ** + @@ -376,7 +421,8 @@ The schedule id which was executed to create a snapshot. [currentCyclePeakUsage]: #currentcyclepeakusage #### [currentCyclePeakUsage] Peak number of bytes used in the vault for the current billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -386,7 +432,8 @@ Peak number of bytes used in the vault for the current billing cycle. [dailySchedule]: #dailyschedule #### [dailySchedule] The Daily Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -396,7 +443,8 @@ The Daily Schedule which is associated with this network storage volume. [dependentDuplicate]: #dependentduplicate #### [dependentDuplicate] Whether or not a network storage volume is a dependent duplicate. -Type: **string** +Type: **string** + @@ -406,7 +454,8 @@ Whether or not a network storage volume is a dependent duplicate. [dependentDuplicates]: #dependentduplicates #### [dependentDuplicates] The network storage volumes configured to be dependent duplicates of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -416,7 +465,8 @@ The network storage volumes configured to be dependent duplicates of a volume. [events]: #events #### [events] The events which have taken place on a network storage volume. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -426,7 +476,19 @@ The events which have taken place on a network storage volume. [failbackNotAllowed]: #failbacknotallowed #### [failbackNotAllowed] Determines whether the volume is allowed to failback -Type: **string** +Type: **string** + + + + +
      + +----- +[failoverNotAllowed]: #failovernotallowed +#### [failoverNotAllowed] +Determines whether the volume is allowed to failover +Type: **string** +
      @@ -436,7 +498,8 @@ Determines whether the volume is allowed to failback [fileNetworkMountAddress]: #filenetworkmountaddress #### [fileNetworkMountAddress] Retrieves the NFS Network Mount Address Name for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -446,7 +509,8 @@ Retrieves the NFS Network Mount Address Name for a given File Storage Volume. [hardware]: #hardware #### [hardware] When applicable, the hardware associated with a Storage service. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -456,7 +520,8 @@ When applicable, the hardware associated with a Storage service. [hasEncryptionAtRest]: #hasencryptionatrest #### [hasEncryptionAtRest] -Type: **boolean** +Type: **boolean** + @@ -466,7 +531,8 @@ When applicable, the hardware associated with a Storage service. [hourlySchedule]: #hourlyschedule #### [hourlySchedule] The Hourly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -476,7 +542,8 @@ The Hourly Schedule which is associated with this network storage volume. [intervalSchedule]: #intervalschedule #### [intervalSchedule] The Interval Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -486,7 +553,8 @@ The Interval Schedule which is associated with this network storage volume. [iops]: #iops #### [iops] The maximum number of IOPs selected for this volume. -Type: **string** +Type: **string** + @@ -496,7 +564,8 @@ The maximum number of IOPs selected for this volume. [isDependentDuplicateProvisionCompleted]: #isdependentduplicateprovisioncompleted #### [isDependentDuplicateProvisionCompleted] Determines whether dependent volume provision is completed on background. -Type: **boolean** +Type: **boolean** + @@ -506,7 +575,8 @@ Determines whether dependent volume provision is completed on background. [isInDedicatedServiceResource]: #isindedicatedserviceresource #### [isInDedicatedServiceResource] -Type: **boolean** +Type: **boolean** + @@ -516,7 +586,8 @@ Determines whether dependent volume provision is completed on background. [isMagneticStorage]: #ismagneticstorage #### [isMagneticStorage] -Type: **string** +Type: **string** + @@ -526,7 +597,8 @@ Determines whether dependent volume provision is completed on background. [isReadyForSnapshot]: #isreadyforsnapshot #### [isReadyForSnapshot] Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. -Type: **boolean** +Type: **boolean** + @@ -536,7 +608,8 @@ Determines whether a volume is ready to order snapshot space, or, if snapshot sp [isReadyToMount]: #isreadytomount #### [isReadyToMount] Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. -Type: **boolean** +Type: **boolean** + @@ -546,7 +619,8 @@ Determines whether a volume is ready to have Hosts authorized to access it. This [iscsiLuns]: #iscsiluns #### [iscsiLuns] Relationship between a container volume and iSCSI LUNs. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -556,7 +630,8 @@ Relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddresses]: #iscsitargetipaddresses #### [iscsiTargetIpAddresses] Returns the target IP addresses of an iSCSI volume. -Type: **array of strings** +Type: **array of strings** + @@ -566,7 +641,8 @@ Returns the target IP addresses of an iSCSI volume. [lunId]: #lunid #### [lunId] The ID of the LUN volume. -Type: **string** +Type: **string** + @@ -576,7 +652,8 @@ The ID of the LUN volume. [manualSnapshots]: #manualsnapshots #### [manualSnapshots] The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -586,7 +663,8 @@ The manually-created snapshots associated with this SoftLayer_Network_Storage vo [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A network storage volume's metric tracking object. This object records all periodic polled data available to this volume. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -596,7 +674,8 @@ A network storage volume's metric tracking object. This object records all perio [mountPath]: #mountpath #### [mountPath] Retrieves the NFS Network Mount Path for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -606,7 +685,8 @@ Retrieves the NFS Network Mount Path for a given File Storage Volume. [mountableFlag]: #mountableflag #### [mountableFlag] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -616,7 +696,8 @@ Whether or not a network storage volume may be mounted. [moveAndSplitStatus]: #moveandsplitstatus #### [moveAndSplitStatus] The current status of split or move operation as a part of volume duplication. -Type: **string** +Type: **string** + @@ -626,7 +707,8 @@ The current status of split or move operation as a part of volume duplication. [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] The subscribers that will be notified for usage amount warnings and overages. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -636,7 +718,8 @@ The subscribers that will be notified for usage amount warnings and overages. [originalSnapshotName]: #originalsnapshotname #### [originalSnapshotName] The name of the snapshot that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -646,7 +729,8 @@ The name of the snapshot that this volume was duplicated from. [originalVolumeName]: #originalvolumename #### [originalVolumeName] The name of the volume that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -656,7 +740,8 @@ The name of the volume that this volume was duplicated from. [originalVolumeSize]: #originalvolumesize #### [originalVolumeSize] The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. -Type: **string** +Type: **string** + @@ -666,7 +751,8 @@ The size (in GB) of the volume or LUN before any size expansion, or of the volum [osType]: #ostype #### [osType] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -676,7 +762,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. [osTypeId]: #ostypeid #### [osTypeId] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. -Type: **string** +Type: **string** + @@ -686,7 +773,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. [parentPartnerships]: #parentpartnerships #### [parentPartnerships] The volumes or snapshots partnered with a network storage volume in a parental role. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -696,7 +784,8 @@ The volumes or snapshots partnered with a network storage volume in a parental r [parentVolume]: #parentvolume #### [parentVolume] The parent volume of a volume in a complex storage relationship. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -706,7 +795,8 @@ The parent volume of a volume in a complex storage relationship. [partnerships]: #partnerships #### [partnerships] The volumes or snapshots partnered with a network storage volume. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -716,7 +806,8 @@ The volumes or snapshots partnered with a network storage volume. [permissionsGroups]: #permissionsgroups #### [permissionsGroups] All permissions group(s) this volume is in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -726,7 +817,8 @@ All permissions group(s) this volume is in. [pluginBillingItems]: #pluginbillingitems #### [pluginBillingItems] The billing items for plugins tied to the EVault Storage service. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -736,7 +828,8 @@ The billing items for plugins tied to the EVault Storage service. [previousCyclePeakUsage]: #previouscyclepeakusage #### [previousCyclePeakUsage] Peak number of bytes used in the vault for the previous billing cycle. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -746,7 +839,8 @@ Peak number of bytes used in the vault for the previous billing cycle. [properties]: #properties #### [properties] The properties used to provide additional details about a network storage volume. -Type: **SoftLayer_Network_Storage_Property[] ** +Type: **SoftLayer_Network_Storage_Property[] ** + @@ -756,7 +850,8 @@ The properties used to provide additional details about a network storage volume [provisionedIops]: #provisionediops #### [provisionedIops] The number of IOPs provisioned for this volume. -Type: **string** +Type: **string** + @@ -766,7 +861,8 @@ The number of IOPs provisioned for this volume. [replicatingLuns]: #replicatingluns #### [replicatingLuns] The iSCSI LUN volumes being replicated by this network storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -776,7 +872,8 @@ The iSCSI LUN volumes being replicated by this network storage volume. [replicatingVolume]: #replicatingvolume #### [replicatingVolume] The network storage volume being replicated by a volume. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -786,7 +883,8 @@ The network storage volume being replicated by a volume. [replicationEvents]: #replicationevents #### [replicationEvents] The volume replication events. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -796,7 +894,8 @@ The volume replication events. [replicationPartners]: #replicationpartners #### [replicationPartners] The network storage volumes configured to be replicants of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -806,7 +905,8 @@ The network storage volumes configured to be replicants of a volume. [replicationSchedule]: #replicationschedule #### [replicationSchedule] The Replication Schedule associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -816,7 +916,8 @@ The Replication Schedule associated with a network storage volume. [replicationStatus]: #replicationstatus #### [replicationStatus] The current replication status of a network storage volume. Indicates Failover or Failback status. -Type: **string** +Type: **string** + @@ -826,7 +927,8 @@ The current replication status of a network storage volume. Indicates Failover o [restoreJobDetails]: #restorejobdetails #### [restoreJobDetails] All the of the restore jobs for the EVault Storage account. -Type: **SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails[] ** +Type: **SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails[] ** + @@ -836,7 +938,8 @@ All the of the restore jobs for the EVault Storage account. [schedules]: #schedules #### [schedules] The schedules which are associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule[] ** +Type: **SoftLayer_Network_Storage_Schedule[] ** + @@ -846,7 +949,8 @@ The schedules which are associated with a network storage volume. [serviceResource]: #serviceresource #### [serviceResource] The network resource a Storage service is connected to. -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -856,7 +960,8 @@ The network resource a Storage service is connected to. [serviceResourceBackendIpAddress]: #serviceresourcebackendipaddress #### [serviceResourceBackendIpAddress] The IP address of a Storage resource. -Type: **string** +Type: **string** + @@ -866,7 +971,8 @@ The IP address of a Storage resource. [serviceResourceName]: #serviceresourcename #### [serviceResourceName] The name of a Storage's network resource. -Type: **string** +Type: **string** + @@ -876,7 +982,8 @@ The name of a Storage's network resource. [snapshotCapacityGb]: #snapshotcapacitygb #### [snapshotCapacityGb] A volume's configured snapshot space size. -Type: **string** +Type: **string** + @@ -886,7 +993,8 @@ A volume's configured snapshot space size. [snapshotCreationTimestamp]: #snapshotcreationtimestamp #### [snapshotCreationTimestamp] The creation timestamp of the snapshot on the storage platform. -Type: **string** +Type: **string** + @@ -896,7 +1004,8 @@ The creation timestamp of the snapshot on the storage platform. [snapshotDeletionThresholdPercentage]: #snapshotdeletionthresholdpercentage #### [snapshotDeletionThresholdPercentage] The percentage of used snapshot space after which to delete automated snapshots. -Type: **string** +Type: **string** + @@ -906,7 +1015,8 @@ The percentage of used snapshot space after which to delete automated snapshots. [snapshotNotificationStatus]: #snapshotnotificationstatus #### [snapshotNotificationStatus] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -916,7 +1026,8 @@ Whether or not a network storage volume may be mounted. [snapshotSizeBytes]: #snapshotsizebytes #### [snapshotSizeBytes] The snapshot size in bytes. -Type: **string** +Type: **string** + @@ -926,7 +1037,8 @@ The snapshot size in bytes. [snapshotSpaceAvailable]: #snapshotspaceavailable #### [snapshotSpaceAvailable] A volume's available snapshot reservation space. -Type: **string** +Type: **string** + @@ -936,7 +1048,8 @@ A volume's available snapshot reservation space. [snapshots]: #snapshots #### [snapshots] The snapshots associated with this SoftLayer_Network_Storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -946,7 +1059,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [softwareComponent]: #softwarecomponent #### [softwareComponent] The software component for the EVault base client. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -956,7 +1070,8 @@ The software component for the EVault base client. [staasVersion]: #staasversion #### [staasVersion] -Type: **string** +Type: **string** + @@ -966,7 +1081,8 @@ The software component for the EVault base client. [storageGroups]: #storagegroups #### [storageGroups] The network storage groups this volume is attached to. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -976,7 +1092,8 @@ The network storage groups this volume is attached to. [storageTierLevel]: #storagetierlevel #### [storageTierLevel] -Type: **string** +Type: **string** + @@ -986,7 +1103,8 @@ The network storage groups this volume is attached to. [storageType]: #storagetype #### [storageType] A description of the Storage object. -Type: **SoftLayer_Network_Storage_Type ** +Type: **SoftLayer_Network_Storage_Type ** + @@ -996,7 +1114,8 @@ A description of the Storage object. [tasks]: #tasks #### [tasks] Retrieve the task information for the EVault Storage service. -Type: **SoftLayer_Container_Network_Storage_Evault_Vault_Task[] ** +Type: **SoftLayer_Container_Network_Storage_Evault_Vault_Task[] ** + @@ -1006,7 +1125,8 @@ Retrieve the task information for the EVault Storage service. [totalBytesUsed]: #totalbytesused #### [totalBytesUsed] Number of bytes used in the vault. -Type: **unsigned long** +Type: **unsigned long** + @@ -1016,7 +1136,8 @@ Number of bytes used in the vault. [totalScheduleSnapshotRetentionCount]: #totalschedulesnapshotretentioncount #### [totalScheduleSnapshotRetentionCount] The total snapshot retention count of all schedules on this network storage volume. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -1026,7 +1147,8 @@ The total snapshot retention count of all schedules on this network storage volu [usageNotification]: #usagenotification #### [usageNotification] The usage notification for SL Storage services. -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -1036,7 +1158,8 @@ The usage notification for SL Storage services. [vendorName]: #vendorname #### [vendorName] The type of network storage service. -Type: **string** +Type: **string** + @@ -1046,7 +1169,8 @@ The type of network storage service. [virtualGuest]: #virtualguest #### [virtualGuest] When applicable, the virtual guest associated with a Storage service. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -1056,7 +1180,8 @@ When applicable, the virtual guest associated with a Storage service. [volumeHistory]: #volumehistory #### [volumeHistory] The username and password history for a Storage service. -Type: **SoftLayer_Network_Storage_History[] ** +Type: **SoftLayer_Network_Storage_History[] ** + @@ -1066,7 +1191,8 @@ The username and password history for a Storage service. [volumeStatus]: #volumestatus #### [volumeStatus] The current status of a network storage volume. -Type: **string** +Type: **string** + @@ -1076,7 +1202,8 @@ The current status of a network storage volume. [webccAccount]: #webccaccount #### [webccAccount] The account username and password for the EVault webCC interface. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -1086,7 +1213,8 @@ The account username and password for the EVault webCC interface. [weeklySchedule]: #weeklyschedule #### [weeklySchedule] The Weekly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -1098,7 +1226,8 @@ The Weekly Schedule which is associated with this network storage volume. [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of the currently active transactions on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1108,7 +1237,8 @@ A count of the currently active transactions on a network storage volume. [agentStatusCount]: #agentstatuscount #### [agentStatusCount] A count of statuses (most of the time will be one status) for the agent tied to the EVault Storage services. -Type: **unsigned long** +Type: **unsigned long** + @@ -1118,7 +1248,8 @@ A count of statuses (most of the time will be one status) for the agent tied to [allowedHardwareCount]: #allowedhardwarecount #### [allowedHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1128,7 +1259,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedIpAddressCount]: #allowedipaddresscount #### [allowedIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1138,7 +1270,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationHardwareCount]: #allowedreplicationhardwarecount #### [allowedReplicationHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1148,7 +1281,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedReplicationIpAddressCount]: #allowedreplicationipaddresscount #### [allowedReplicationIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1158,7 +1292,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationSubnetCount]: #allowedreplicationsubnetcount #### [allowedReplicationSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1168,7 +1303,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedReplicationVirtualGuestCount]: #allowedreplicationvirtualguestcount #### [allowedReplicationVirtualGuestCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1178,7 +1314,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedSubnetCount]: #allowedsubnetcount #### [allowedSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1188,7 +1325,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedVirtualGuestCount]: #allowedvirtualguestcount #### [allowedVirtualGuestCount] A count of the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1198,7 +1336,8 @@ A count of the SoftLayer_Virtual_Guest objects which are allowed access to this [backupJobDetailCount]: #backupjobdetailcount #### [backupJobDetailCount] A count of all the of the backup jobs for the EVault Storage account. -Type: **unsigned long** +Type: **unsigned long** + @@ -1208,7 +1347,8 @@ A count of all the of the backup jobs for the EVault Storage account. [credentialCount]: #credentialcount #### [credentialCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1218,7 +1358,8 @@ A count of [dependentDuplicateCount]: #dependentduplicatecount #### [dependentDuplicateCount] A count of the network storage volumes configured to be dependent duplicates of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1228,7 +1369,8 @@ A count of the network storage volumes configured to be dependent duplicates of [eventCount]: #eventcount #### [eventCount] A count of the events which have taken place on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1238,7 +1380,8 @@ A count of the events which have taken place on a network storage volume. [iscsiLunCount]: #iscsiluncount #### [iscsiLunCount] A count of relationship between a container volume and iSCSI LUNs. -Type: **unsigned long** +Type: **unsigned long** + @@ -1248,7 +1391,8 @@ A count of relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddressCount]: #iscsitargetipaddresscount #### [iscsiTargetIpAddressCount] A count of returns the target IP addresses of an iSCSI volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1258,7 +1402,8 @@ A count of returns the target IP addresses of an iSCSI volume. [manualSnapshotCount]: #manualsnapshotcount #### [manualSnapshotCount] A count of the manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **unsigned long** +Type: **unsigned long** + @@ -1268,7 +1413,8 @@ A count of the manually-created snapshots associated with this SoftLayer_Network [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of the subscribers that will be notified for usage amount warnings and overages. -Type: **unsigned long** +Type: **unsigned long** + @@ -1278,7 +1424,8 @@ A count of the subscribers that will be notified for usage amount warnings and o [parentPartnershipCount]: #parentpartnershipcount #### [parentPartnershipCount] A count of the volumes or snapshots partnered with a network storage volume in a parental role. -Type: **unsigned long** +Type: **unsigned long** + @@ -1288,7 +1435,8 @@ A count of the volumes or snapshots partnered with a network storage volume in a [partnershipCount]: #partnershipcount #### [partnershipCount] A count of the volumes or snapshots partnered with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1298,7 +1446,8 @@ A count of the volumes or snapshots partnered with a network storage volume. [permissionsGroupCount]: #permissionsgroupcount #### [permissionsGroupCount] A count of all permissions group(s) this volume is in. -Type: **unsigned long** +Type: **unsigned long** + @@ -1308,7 +1457,8 @@ A count of all permissions group(s) this volume is in. [pluginBillingItemCount]: #pluginbillingitemcount #### [pluginBillingItemCount] A count of the billing items for plugins tied to the EVault Storage service. -Type: **unsigned long** +Type: **unsigned long** + @@ -1318,7 +1468,8 @@ A count of the billing items for plugins tied to the EVault Storage service. [propertyCount]: #propertycount #### [propertyCount] A count of the properties used to provide additional details about a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1328,7 +1479,8 @@ A count of the properties used to provide additional details about a network sto [replicatingLunCount]: #replicatingluncount #### [replicatingLunCount] A count of the iSCSI LUN volumes being replicated by this network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1338,7 +1490,8 @@ A count of the iSCSI LUN volumes being replicated by this network storage volume [replicationEventCount]: #replicationeventcount #### [replicationEventCount] A count of the volume replication events. -Type: **unsigned long** +Type: **unsigned long** + @@ -1348,7 +1501,8 @@ A count of the volume replication events. [replicationPartnerCount]: #replicationpartnercount #### [replicationPartnerCount] A count of the network storage volumes configured to be replicants of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1358,7 +1512,8 @@ A count of the network storage volumes configured to be replicants of a volume. [restoreJobDetailCount]: #restorejobdetailcount #### [restoreJobDetailCount] A count of all the of the restore jobs for the EVault Storage account. -Type: **unsigned long** +Type: **unsigned long** + @@ -1368,7 +1523,8 @@ A count of all the of the restore jobs for the EVault Storage account. [scheduleCount]: #schedulecount #### [scheduleCount] A count of the schedules which are associated with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1378,7 +1534,8 @@ A count of the schedules which are associated with a network storage volume. [snapshotCount]: #snapshotcount #### [snapshotCount] A count of the snapshots associated with this SoftLayer_Network_Storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1388,7 +1545,8 @@ A count of the snapshots associated with this SoftLayer_Network_Storage volume. [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of the network storage groups this volume is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1398,7 +1556,8 @@ A count of the network storage groups this volume is attached to. [taskCount]: #taskcount #### [taskCount] A count of retrieve the task information for the EVault Storage service. -Type: **unsigned long** +Type: **unsigned long** + @@ -1408,7 +1567,8 @@ A count of retrieve the task information for the EVault Storage service. [volumeHistoryCount]: #volumehistorycount #### [volumeHistoryCount] A count of the username and password history for a Storage service. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Credential/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Credential/_index.md index a0cebcb6f8..9cbbda2341 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Credential/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Credential/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Storage_Credential data type will give you an overview of the usernames that are currently attached to your storage device. @@ -45,7 +47,8 @@ The SoftLayer_Network_Storage_Credential data type will give you an overview of [accountId]: #accountid #### [accountId] This is the account id associated with the volume. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ This is the account id associated with the volume. [createDate]: #createdate #### [createDate] This is the data that the record was created in the table. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ This is the data that the record was created in the table. [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ This is the data that the record was created in the table. [modifyDate]: #modifydate #### [modifyDate] This is the date that the record was last updated in the table. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ This is the date that the record was last updated in the table. [nasCredentialTypeId]: #nascredentialtypeid #### [nasCredentialTypeId] This is the id of the type of credential that this object represents. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ This is the id of the type of credential that this object represents. [password]: #password #### [password] This is the password associated with the volume. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This is the password associated with the volume. [username]: #username #### [username] This is the username associated with the volume. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ This is the username associated with the volume. [account]: #account #### [account] This is the account that the storage credential is tied to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -131,7 +141,8 @@ This is the account that the storage credential is tied to. [networkStorageAllowedHosts]: #networkstorageallowedhosts #### [networkStorageAllowedHosts] These are the SoftLayer_Network_Storage_Allowed_Host entries that this credential is assigned to. -Type: **SoftLayer_Network_Storage_Allowed_Host ** +Type: **SoftLayer_Network_Storage_Allowed_Host ** + @@ -141,7 +152,8 @@ These are the SoftLayer_Network_Storage_Allowed_Host entries that this credentia [type]: #type #### [type] These are the types of storage that the credential can be assigned to. -Type: **SoftLayer_Network_Storage_Credential_Type ** +Type: **SoftLayer_Network_Storage_Credential_Type ** + @@ -151,7 +163,8 @@ These are the types of storage that the credential can be assigned to. [volumes]: #volumes #### [volumes] These are the SoftLayer_Network_Storage volumes that this credential is assigned to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -163,7 +176,8 @@ These are the SoftLayer_Network_Storage volumes that this credential is assigned [volumeCount]: #volumecount #### [volumeCount] A count of these are the SoftLayer_Network_Storage volumes that this credential is assigned to. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Credential_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Credential_Type/_index.md index 67b7a68b0c..0979461ab2 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Credential_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Credential_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + <<< @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] The date a credential type was created. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The date a credential type was created. [description]: #description #### [description] A short description of the credential type -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ A short description of the credential type [keyName]: #keyname #### [keyName] The key name of the credential type. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The key name of the credential type. [modifyDate]: #modifydate #### [modifyDate] The date a credential was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The date a credential was last modified. [name]: #name #### [name] The human readable name of the credential type. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Daily_Usage/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Daily_Usage/_index.md index 6d516e44f3..bd6c774d3b 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Daily_Usage/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Daily_Usage/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [bytesUsed]: #bytesused #### [bytesUsed] -Type: **unsigned long** +Type: **unsigned long** +
      @@ -55,7 +58,8 @@ classes: [cdnHttpBandwidth]: #cdnhttpbandwidth #### [cdnHttpBandwidth] -Type: **unsigned long** +Type: **unsigned long** +
      @@ -65,7 +69,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ classes: [nasVolumeId]: #nasvolumeid #### [nasVolumeId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [publicBandwidthOut]: #publicbandwidthout #### [publicBandwidthOut] -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ classes: [nasVolume]: #nasvolume #### [nasVolume] -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_DedicatedCluster/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_DedicatedCluster/_index.md index 1160c9b21b..d2d78d5507 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_DedicatedCluster/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_DedicatedCluster/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The SoftLayer_Account->id of the customer account -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The SoftLayer_Account->id of the customer account [createDate]: #createdate #### [createDate] The date when Dedicated service resource entry was created. -Type: **dateTime** +Type: **dateTime** +
      @@ -65,7 +69,8 @@ The date when Dedicated service resource entry was created. [id]: #id #### [id] The unique identifier for Dedicated service resource record. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The unique identifier for Dedicated service resource record. [serviceResourceId]: #serviceresourceid #### [serviceResourceId] The cluster Id that is setup as dedicated for the customer. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The cluster Id that is setup as dedicated for the customer. [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -101,7 +108,8 @@ The cluster Id that is setup as dedicated for the customer. [serviceResource]: #serviceresource #### [serviceResource] -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Event/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Event/_index.md index a45fabd99d..2a5ceeda73 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Event/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Event/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ Storage volumes can create various events to keep track of what has occurred to [createDate]: #createdate #### [createDate] The date an event was created. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The date an event was created. [message]: #message #### [message] The message text for an event. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The message text for an event. [scheduleId]: #scheduleid #### [scheduleId] An identifier for the schedule which is associated with an event. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ An identifier for the schedule which is associated with an event. [typeId]: #typeid #### [typeId] An identifier for the type of an event. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ An identifier for the type of an event. [volumeId]: #volumeid #### [volumeId] The volume id which an event is associated with. -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ The volume id which an event is associated with. [schedule]: #schedule #### [schedule] A schedule that is associated with an event. Not all events will have a schedule. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -111,7 +119,8 @@ A schedule that is associated with an event. Not all events will have a schedule [type]: #type #### [type] A Storage volume's event type. The type provides a standardized definition for an event. -Type: **SoftLayer_Network_Storage_Event_Type ** +Type: **SoftLayer_Network_Storage_Event_Type ** + @@ -121,7 +130,8 @@ A Storage volume's event type. The type provides a standardized definition for a [volume]: #volume #### [volume] The associated volume for an event. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Event_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Event_Type/_index.md index 16892c3f0c..2dc11978f8 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Event_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Event_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [keyname]: #keyname #### [keyname] -Type: **string** +Type: **string** +
      @@ -55,7 +58,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
      diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Group/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Group/_index.md index 4d346c9930..78a417cc33 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Group/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The account ID which owns this group -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The account ID which owns this group [alias]: #alias #### [alias] The friendly name of this group -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ The friendly name of this group [createDate]: #createdate #### [createDate] The date this group was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date this group was created. [groupTypeId]: #grouptypeid #### [groupTypeId] The SoftLayer_Network_Storage_Group_Type which describes this group. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The SoftLayer_Network_Storage_Group_Type which describes this group. [id]: #id #### [id] The internal identifier of the group -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The internal identifier of the group [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ The internal identifier of the group [osTypeId]: #ostypeid #### [osTypeId] A SoftLayer_Network_Storage_OS_Type Operating System designation that this group was created for. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A SoftLayer_Network_Storage_OS_Type Operating System designation that this group [serviceResourceId]: #serviceresourceid #### [serviceResourceId] A SoftLayer_Network_Service_Resource that this group was created on. -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ A SoftLayer_Network_Service_Resource that this group was created on. [account]: #account #### [account] The SoftLayer_Account which owns this group. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -141,7 +152,8 @@ The SoftLayer_Account which owns this group. [allowedHosts]: #allowedhosts #### [allowedHosts] The allowed hosts list for this group. -Type: **SoftLayer_Network_Storage_Allowed_Host[] ** +Type: **SoftLayer_Network_Storage_Allowed_Host[] ** + @@ -151,7 +163,8 @@ The allowed hosts list for this group. [attachedVolumes]: #attachedvolumes #### [attachedVolumes] The network storage volumes this group is attached to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -161,7 +174,8 @@ The network storage volumes this group is attached to. [groupType]: #grouptype #### [groupType] The type which defines this group. -Type: **SoftLayer_Network_Storage_Group_Type ** +Type: **SoftLayer_Network_Storage_Group_Type ** + @@ -171,7 +185,8 @@ The type which defines this group. [osType]: #ostype #### [osType] The OS Type this group is configured for. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -181,7 +196,8 @@ The OS Type this group is configured for. [serviceResource]: #serviceresource #### [serviceResource] The network resource this group is created on. -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -193,7 +209,8 @@ The network resource this group is created on. [allowedHostCount]: #allowedhostcount #### [allowedHostCount] A count of the allowed hosts list for this group. -Type: **unsigned long** +Type: **unsigned long** + @@ -203,7 +220,8 @@ A count of the allowed hosts list for this group. [attachedVolumeCount]: #attachedvolumecount #### [attachedVolumeCount] A count of the network storage volumes this group is attached to. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Group_Iscsi/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Group_Iscsi/_index.md index 08d7eda92f..4f3e062bfa 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Group_Iscsi/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Group_Iscsi/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The account ID which owns this group -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The account ID which owns this group [alias]: #alias #### [alias] The friendly name of this group -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ The friendly name of this group [createDate]: #createdate #### [createDate] The date this group was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date this group was created. [groupTypeId]: #grouptypeid #### [groupTypeId] The SoftLayer_Network_Storage_Group_Type which describes this group. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The SoftLayer_Network_Storage_Group_Type which describes this group. [id]: #id #### [id] The internal identifier of the group -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The internal identifier of the group [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ The internal identifier of the group [osTypeId]: #ostypeid #### [osTypeId] A SoftLayer_Network_Storage_OS_Type Operating System designation that this group was created for. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A SoftLayer_Network_Storage_OS_Type Operating System designation that this group [serviceResourceId]: #serviceresourceid #### [serviceResourceId] A SoftLayer_Network_Service_Resource that this group was created on. -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ A SoftLayer_Network_Service_Resource that this group was created on. [account]: #account #### [account] The SoftLayer_Account which owns this group. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -141,7 +152,8 @@ The SoftLayer_Account which owns this group. [allowedHosts]: #allowedhosts #### [allowedHosts] The allowed hosts list for this group. -Type: **SoftLayer_Network_Storage_Allowed_Host[] ** +Type: **SoftLayer_Network_Storage_Allowed_Host[] ** + @@ -151,7 +163,8 @@ The allowed hosts list for this group. [attachedVolumes]: #attachedvolumes #### [attachedVolumes] The network storage volumes this group is attached to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -161,7 +174,8 @@ The network storage volumes this group is attached to. [groupType]: #grouptype #### [groupType] The type which defines this group. -Type: **SoftLayer_Network_Storage_Group_Type ** +Type: **SoftLayer_Network_Storage_Group_Type ** + @@ -171,7 +185,8 @@ The type which defines this group. [osType]: #ostype #### [osType] The OS Type this group is configured for. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -181,7 +196,8 @@ The OS Type this group is configured for. [serviceResource]: #serviceresource #### [serviceResource] The network resource this group is created on. -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -193,7 +209,8 @@ The network resource this group is created on. [allowedHostCount]: #allowedhostcount #### [allowedHostCount] A count of the allowed hosts list for this group. -Type: **unsigned long** +Type: **unsigned long** + @@ -203,7 +220,8 @@ A count of the allowed hosts list for this group. [attachedVolumeCount]: #attachedvolumecount #### [attachedVolumeCount] A count of the network storage volumes this group is attached to. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Group_Nfs/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Group_Nfs/_index.md index 6e978abe82..076e123d27 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Group_Nfs/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Group_Nfs/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The account ID which owns this group -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The account ID which owns this group [alias]: #alias #### [alias] The friendly name of this group -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ The friendly name of this group [createDate]: #createdate #### [createDate] The date this group was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date this group was created. [groupTypeId]: #grouptypeid #### [groupTypeId] The SoftLayer_Network_Storage_Group_Type which describes this group. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The SoftLayer_Network_Storage_Group_Type which describes this group. [id]: #id #### [id] The internal identifier of the group -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The internal identifier of the group [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ The internal identifier of the group [osTypeId]: #ostypeid #### [osTypeId] A SoftLayer_Network_Storage_OS_Type Operating System designation that this group was created for. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A SoftLayer_Network_Storage_OS_Type Operating System designation that this group [serviceResourceId]: #serviceresourceid #### [serviceResourceId] A SoftLayer_Network_Service_Resource that this group was created on. -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ A SoftLayer_Network_Service_Resource that this group was created on. [account]: #account #### [account] The SoftLayer_Account which owns this group. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -141,7 +152,8 @@ The SoftLayer_Account which owns this group. [allowedHosts]: #allowedhosts #### [allowedHosts] The allowed hosts list for this group. -Type: **SoftLayer_Network_Storage_Allowed_Host[] ** +Type: **SoftLayer_Network_Storage_Allowed_Host[] ** + @@ -151,7 +163,8 @@ The allowed hosts list for this group. [attachedVolumes]: #attachedvolumes #### [attachedVolumes] The network storage volumes this group is attached to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -161,7 +174,8 @@ The network storage volumes this group is attached to. [groupType]: #grouptype #### [groupType] The type which defines this group. -Type: **SoftLayer_Network_Storage_Group_Type ** +Type: **SoftLayer_Network_Storage_Group_Type ** + @@ -171,7 +185,8 @@ The type which defines this group. [osType]: #ostype #### [osType] The OS Type this group is configured for. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -181,7 +196,8 @@ The OS Type this group is configured for. [serviceResource]: #serviceresource #### [serviceResource] The network resource this group is created on. -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -193,7 +209,8 @@ The network resource this group is created on. [allowedHostCount]: #allowedhostcount #### [allowedHostCount] A count of the allowed hosts list for this group. -Type: **unsigned long** +Type: **unsigned long** + @@ -203,7 +220,8 @@ A count of the allowed hosts list for this group. [attachedVolumeCount]: #attachedvolumecount #### [attachedVolumeCount] A count of the network storage volumes this group is attached to. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Group_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Group_Type/_index.md index 701803a4cc..6e97913844 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Group_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Group_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_History/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_History/_index.md index 2172a12196..c0a3fdc9cc 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_History/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_History/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Storage_History contains the username/password past histor [createDate]: #createdate #### [createDate] Date the password was changed. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ Date the password was changed. [notes]: #notes #### [notes] Past notes for the Storage service. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Past notes for the Storage service. [password]: #password #### [password] Password for the Storage service that was used in the past. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Password for the Storage service that was used in the past. [username]: #username #### [username] Username for the Storage service. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ Username for the Storage service. [account]: #account #### [account] The account that the Storage services belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -101,7 +108,8 @@ The account that the Storage services belongs to. [nasVolume]: #nasvolume #### [nasVolume] The Storage service that the password history belongs to. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Hub/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Hub/_index.md index 929fb63a30..cc51ea6575 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Hub/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Hub/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Storage_Hub data type models Virtual Server type Storage storage offerings. @@ -59,7 +61,8 @@ The SoftLayer_Network_Storage_Hub data type models Virtual Server type Storage s [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account that a Storage account belongs to. -Type: **integer** +Type: **integer** + @@ -69,7 +72,8 @@ The internal identifier of the SoftLayer customer account that a Storage account [capacityGb]: #capacitygb #### [capacityGb] A Storage account's capacity, measured in gigabytes. -Type: **integer** +Type: **integer** + @@ -79,7 +83,8 @@ A Storage account's capacity, measured in gigabytes. [createDate]: #createdate #### [createDate] The date a network storage volume was created. -Type: **dateTime** +Type: **dateTime** + @@ -89,7 +94,8 @@ The date a network storage volume was created. [guestId]: #guestid #### [guestId] The unique identification number of the guest associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -99,7 +105,8 @@ The unique identification number of the guest associated with a Storage volume. [hardwareId]: #hardwareid #### [hardwareId] The server that is associated with a Storage service. -Type: **integer** +Type: **integer** + @@ -109,7 +116,8 @@ The server that is associated with a Storage service. [hostId]: #hostid #### [hostId] The unique identification number of the host associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -119,7 +127,8 @@ The unique identification number of the host associated with a Storage volume. [id]: #id #### [id] A Storage account's unique identifier. -Type: **integer** +Type: **integer** + @@ -129,7 +138,8 @@ A Storage account's unique identifier. [nasType]: #nastype #### [nasType] A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT", and "HUB". -Type: **string** +Type: **string** + @@ -139,7 +149,8 @@ A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT" [notes]: #notes #### [notes] Public notes related to a Storage volume. -Type: **string** +Type: **string** + @@ -149,7 +160,8 @@ Public notes related to a Storage volume. [password]: #password #### [password] The password used to access a non-EVault Storage volume. This password is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -159,7 +171,8 @@ The password used to access a non-EVault Storage volume. This password is used t [serviceProviderId]: #serviceproviderid #### [serviceProviderId] Service Provider ID -Type: **integer** +Type: **integer** + @@ -169,7 +182,8 @@ Service Provider ID [storageTypeId]: #storagetypeid #### [storageTypeId] A storage object's type. -Type: **string** +Type: **string** + @@ -179,7 +193,8 @@ A storage object's type. [upgradableFlag]: #upgradableflag #### [upgradableFlag] This flag indicates whether this storage type is upgradable or not. -Type: **boolean** +Type: **boolean** + @@ -189,7 +204,8 @@ This flag indicates whether this storage type is upgradable or not. [username]: #username #### [username] The username used to access a non-EVault Storage volume. This username is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -205,7 +221,8 @@ The username used to access a non-EVault Storage volume. This username is used t [account]: #account #### [account] The account that a Storage services belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -215,7 +232,8 @@ The account that a Storage services belongs to. [accountPassword]: #accountpassword #### [accountPassword] Other usernames and passwords associated with a Storage volume. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -225,7 +243,19 @@ Other usernames and passwords associated with a Storage volume. [activeTransactions]: #activetransactions #### [activeTransactions] The currently active transactions on a network storage volume. -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + + + + +
      + +----- +[allowDisasterRecoveryFailback]: #allowdisasterrecoveryfailback +#### [allowDisasterRecoveryFailback] + +Type: **string** +
      @@ -235,7 +265,8 @@ The currently active transactions on a network storage volume. [allowDisasterRecoveryFailover]: #allowdisasterrecoveryfailover #### [allowDisasterRecoveryFailover] -Type: **string** +Type: **string** + @@ -245,7 +276,8 @@ The currently active transactions on a network storage volume. [allowedHardware]: #allowedhardware #### [allowedHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -255,7 +287,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume. [allowedIpAddresses]: #allowedipaddresses #### [allowedIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -265,7 +298,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationHardware]: #allowedreplicationhardware #### [allowedReplicationHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -275,7 +309,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedReplicationIpAddresses]: #allowedreplicationipaddresses #### [allowedReplicationIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -285,7 +320,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationSubnets]: #allowedreplicationsubnets #### [allowedReplicationSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -295,7 +331,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedReplicationVirtualGuests]: #allowedreplicationvirtualguests #### [allowedReplicationVirtualGuests] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -305,7 +342,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedSubnets]: #allowedsubnets #### [allowedSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -315,7 +353,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedVirtualGuests]: #allowedvirtualguests #### [allowedVirtualGuests] The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -325,7 +364,8 @@ The SoftLayer_Virtual_Guest objects which are allowed access to this storage vol [bandwidthBillingItems]: #bandwidthbillingitems #### [bandwidthBillingItems] The billing items tied to a Storage service's bandwidth usage. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -335,7 +375,8 @@ The billing items tied to a Storage service's bandwidth usage. [billingItem]: #billingitem #### [billingItem] The current billing item for a Storage volume. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -345,7 +386,8 @@ The current billing item for a Storage volume. [billingItemCategory]: #billingitemcategory #### [billingItemCategory] -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -355,7 +397,8 @@ The current billing item for a Storage volume. [bytesUsed]: #bytesused #### [bytesUsed] The amount of space used by the volume, in bytes. -Type: **string** +Type: **string** + @@ -365,7 +408,8 @@ The amount of space used by the volume, in bytes. [creationScheduleId]: #creationscheduleid #### [creationScheduleId] The schedule id which was executed to create a snapshot. -Type: **string** +Type: **string** + @@ -375,7 +419,8 @@ The schedule id which was executed to create a snapshot. [credentials]: #credentials #### [credentials] -Type: **SoftLayer_Network_Storage_Credential[] ** +Type: **SoftLayer_Network_Storage_Credential[] ** + @@ -385,7 +430,8 @@ The schedule id which was executed to create a snapshot. [dailySchedule]: #dailyschedule #### [dailySchedule] The Daily Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -395,7 +441,8 @@ The Daily Schedule which is associated with this network storage volume. [dependentDuplicate]: #dependentduplicate #### [dependentDuplicate] Whether or not a network storage volume is a dependent duplicate. -Type: **string** +Type: **string** + @@ -405,7 +452,8 @@ Whether or not a network storage volume is a dependent duplicate. [dependentDuplicates]: #dependentduplicates #### [dependentDuplicates] The network storage volumes configured to be dependent duplicates of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -415,7 +463,8 @@ The network storage volumes configured to be dependent duplicates of a volume. [events]: #events #### [events] The events which have taken place on a network storage volume. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -425,7 +474,19 @@ The events which have taken place on a network storage volume. [failbackNotAllowed]: #failbacknotallowed #### [failbackNotAllowed] Determines whether the volume is allowed to failback -Type: **string** +Type: **string** + + + + +
      + +----- +[failoverNotAllowed]: #failovernotallowed +#### [failoverNotAllowed] +Determines whether the volume is allowed to failover +Type: **string** +
      @@ -435,7 +496,8 @@ Determines whether the volume is allowed to failback [fileNetworkMountAddress]: #filenetworkmountaddress #### [fileNetworkMountAddress] Retrieves the NFS Network Mount Address Name for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -445,7 +507,8 @@ Retrieves the NFS Network Mount Address Name for a given File Storage Volume. [hardware]: #hardware #### [hardware] When applicable, the hardware associated with a Storage service. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -455,7 +518,8 @@ When applicable, the hardware associated with a Storage service. [hasEncryptionAtRest]: #hasencryptionatrest #### [hasEncryptionAtRest] -Type: **boolean** +Type: **boolean** + @@ -465,7 +529,8 @@ When applicable, the hardware associated with a Storage service. [hourlySchedule]: #hourlyschedule #### [hourlySchedule] The Hourly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -475,7 +540,8 @@ The Hourly Schedule which is associated with this network storage volume. [intervalSchedule]: #intervalschedule #### [intervalSchedule] The Interval Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -485,7 +551,8 @@ The Interval Schedule which is associated with this network storage volume. [iops]: #iops #### [iops] The maximum number of IOPs selected for this volume. -Type: **string** +Type: **string** + @@ -495,7 +562,8 @@ The maximum number of IOPs selected for this volume. [isDependentDuplicateProvisionCompleted]: #isdependentduplicateprovisioncompleted #### [isDependentDuplicateProvisionCompleted] Determines whether dependent volume provision is completed on background. -Type: **boolean** +Type: **boolean** + @@ -505,7 +573,8 @@ Determines whether dependent volume provision is completed on background. [isInDedicatedServiceResource]: #isindedicatedserviceresource #### [isInDedicatedServiceResource] -Type: **boolean** +Type: **boolean** + @@ -515,7 +584,8 @@ Determines whether dependent volume provision is completed on background. [isMagneticStorage]: #ismagneticstorage #### [isMagneticStorage] -Type: **string** +Type: **string** + @@ -525,7 +595,8 @@ Determines whether dependent volume provision is completed on background. [isReadyForSnapshot]: #isreadyforsnapshot #### [isReadyForSnapshot] Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. -Type: **boolean** +Type: **boolean** + @@ -535,7 +606,8 @@ Determines whether a volume is ready to order snapshot space, or, if snapshot sp [isReadyToMount]: #isreadytomount #### [isReadyToMount] Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. -Type: **boolean** +Type: **boolean** + @@ -545,7 +617,8 @@ Determines whether a volume is ready to have Hosts authorized to access it. This [iscsiLuns]: #iscsiluns #### [iscsiLuns] Relationship between a container volume and iSCSI LUNs. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -555,7 +628,8 @@ Relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddresses]: #iscsitargetipaddresses #### [iscsiTargetIpAddresses] Returns the target IP addresses of an iSCSI volume. -Type: **array of strings** +Type: **array of strings** + @@ -565,7 +639,8 @@ Returns the target IP addresses of an iSCSI volume. [lunId]: #lunid #### [lunId] The ID of the LUN volume. -Type: **string** +Type: **string** + @@ -575,7 +650,8 @@ The ID of the LUN volume. [manualSnapshots]: #manualsnapshots #### [manualSnapshots] The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -585,7 +661,8 @@ The manually-created snapshots associated with this SoftLayer_Network_Storage vo [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A network storage volume's metric tracking object. This object records all periodic polled data available to this volume. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -595,7 +672,8 @@ A network storage volume's metric tracking object. This object records all perio [mountPath]: #mountpath #### [mountPath] Retrieves the NFS Network Mount Path for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -605,7 +683,8 @@ Retrieves the NFS Network Mount Path for a given File Storage Volume. [mountableFlag]: #mountableflag #### [mountableFlag] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -615,7 +694,8 @@ Whether or not a network storage volume may be mounted. [moveAndSplitStatus]: #moveandsplitstatus #### [moveAndSplitStatus] The current status of split or move operation as a part of volume duplication. -Type: **string** +Type: **string** + @@ -625,7 +705,8 @@ The current status of split or move operation as a part of volume duplication. [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] The subscribers that will be notified for usage amount warnings and overages. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -635,7 +716,8 @@ The subscribers that will be notified for usage amount warnings and overages. [originalSnapshotName]: #originalsnapshotname #### [originalSnapshotName] The name of the snapshot that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -645,7 +727,8 @@ The name of the snapshot that this volume was duplicated from. [originalVolumeName]: #originalvolumename #### [originalVolumeName] The name of the volume that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -655,7 +738,8 @@ The name of the volume that this volume was duplicated from. [originalVolumeSize]: #originalvolumesize #### [originalVolumeSize] The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. -Type: **string** +Type: **string** + @@ -665,7 +749,8 @@ The size (in GB) of the volume or LUN before any size expansion, or of the volum [osType]: #ostype #### [osType] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -675,7 +760,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. [osTypeId]: #ostypeid #### [osTypeId] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. -Type: **string** +Type: **string** + @@ -685,7 +771,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. [parentPartnerships]: #parentpartnerships #### [parentPartnerships] The volumes or snapshots partnered with a network storage volume in a parental role. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -695,7 +782,8 @@ The volumes or snapshots partnered with a network storage volume in a parental r [parentVolume]: #parentvolume #### [parentVolume] The parent volume of a volume in a complex storage relationship. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -705,7 +793,8 @@ The parent volume of a volume in a complex storage relationship. [partnerships]: #partnerships #### [partnerships] The volumes or snapshots partnered with a network storage volume. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -715,7 +804,8 @@ The volumes or snapshots partnered with a network storage volume. [permissionsGroups]: #permissionsgroups #### [permissionsGroups] All permissions group(s) this volume is in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -725,7 +815,8 @@ All permissions group(s) this volume is in. [properties]: #properties #### [properties] The properties used to provide additional details about a network storage volume. -Type: **SoftLayer_Network_Storage_Property[] ** +Type: **SoftLayer_Network_Storage_Property[] ** + @@ -735,7 +826,8 @@ The properties used to provide additional details about a network storage volume [provisionedIops]: #provisionediops #### [provisionedIops] The number of IOPs provisioned for this volume. -Type: **string** +Type: **string** + @@ -745,7 +837,8 @@ The number of IOPs provisioned for this volume. [replicatingLuns]: #replicatingluns #### [replicatingLuns] The iSCSI LUN volumes being replicated by this network storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -755,7 +848,8 @@ The iSCSI LUN volumes being replicated by this network storage volume. [replicatingVolume]: #replicatingvolume #### [replicatingVolume] The network storage volume being replicated by a volume. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -765,7 +859,8 @@ The network storage volume being replicated by a volume. [replicationEvents]: #replicationevents #### [replicationEvents] The volume replication events. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -775,7 +870,8 @@ The volume replication events. [replicationPartners]: #replicationpartners #### [replicationPartners] The network storage volumes configured to be replicants of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -785,7 +881,8 @@ The network storage volumes configured to be replicants of a volume. [replicationSchedule]: #replicationschedule #### [replicationSchedule] The Replication Schedule associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -795,7 +892,8 @@ The Replication Schedule associated with a network storage volume. [replicationStatus]: #replicationstatus #### [replicationStatus] The current replication status of a network storage volume. Indicates Failover or Failback status. -Type: **string** +Type: **string** + @@ -805,7 +903,8 @@ The current replication status of a network storage volume. Indicates Failover o [schedules]: #schedules #### [schedules] The schedules which are associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule[] ** +Type: **SoftLayer_Network_Storage_Schedule[] ** + @@ -815,7 +914,8 @@ The schedules which are associated with a network storage volume. [serviceResource]: #serviceresource #### [serviceResource] The network resource a Storage service is connected to. -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -825,7 +925,8 @@ The network resource a Storage service is connected to. [serviceResourceBackendIpAddress]: #serviceresourcebackendipaddress #### [serviceResourceBackendIpAddress] The IP address of a Storage resource. -Type: **string** +Type: **string** + @@ -835,7 +936,8 @@ The IP address of a Storage resource. [serviceResourceName]: #serviceresourcename #### [serviceResourceName] The name of a Storage's network resource. -Type: **string** +Type: **string** + @@ -845,7 +947,8 @@ The name of a Storage's network resource. [snapshotCapacityGb]: #snapshotcapacitygb #### [snapshotCapacityGb] A volume's configured snapshot space size. -Type: **string** +Type: **string** + @@ -855,7 +958,8 @@ A volume's configured snapshot space size. [snapshotCreationTimestamp]: #snapshotcreationtimestamp #### [snapshotCreationTimestamp] The creation timestamp of the snapshot on the storage platform. -Type: **string** +Type: **string** + @@ -865,7 +969,8 @@ The creation timestamp of the snapshot on the storage platform. [snapshotDeletionThresholdPercentage]: #snapshotdeletionthresholdpercentage #### [snapshotDeletionThresholdPercentage] The percentage of used snapshot space after which to delete automated snapshots. -Type: **string** +Type: **string** + @@ -875,7 +980,8 @@ The percentage of used snapshot space after which to delete automated snapshots. [snapshotNotificationStatus]: #snapshotnotificationstatus #### [snapshotNotificationStatus] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -885,7 +991,8 @@ Whether or not a network storage volume may be mounted. [snapshotSizeBytes]: #snapshotsizebytes #### [snapshotSizeBytes] The snapshot size in bytes. -Type: **string** +Type: **string** + @@ -895,7 +1002,8 @@ The snapshot size in bytes. [snapshotSpaceAvailable]: #snapshotspaceavailable #### [snapshotSpaceAvailable] A volume's available snapshot reservation space. -Type: **string** +Type: **string** + @@ -905,7 +1013,8 @@ A volume's available snapshot reservation space. [snapshots]: #snapshots #### [snapshots] The snapshots associated with this SoftLayer_Network_Storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -915,7 +1024,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [staasVersion]: #staasversion #### [staasVersion] -Type: **string** +Type: **string** + @@ -925,7 +1035,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [storageGroups]: #storagegroups #### [storageGroups] The network storage groups this volume is attached to. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -935,7 +1046,8 @@ The network storage groups this volume is attached to. [storageTierLevel]: #storagetierlevel #### [storageTierLevel] -Type: **string** +Type: **string** + @@ -945,7 +1057,8 @@ The network storage groups this volume is attached to. [storageType]: #storagetype #### [storageType] A description of the Storage object. -Type: **SoftLayer_Network_Storage_Type ** +Type: **SoftLayer_Network_Storage_Type ** + @@ -955,7 +1068,8 @@ A description of the Storage object. [totalBytesUsed]: #totalbytesused #### [totalBytesUsed] The amount of space used by the volume. -Type: **string** +Type: **string** + @@ -965,7 +1079,8 @@ The amount of space used by the volume. [totalScheduleSnapshotRetentionCount]: #totalschedulesnapshotretentioncount #### [totalScheduleSnapshotRetentionCount] The total snapshot retention count of all schedules on this network storage volume. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -975,7 +1090,8 @@ The total snapshot retention count of all schedules on this network storage volu [usageNotification]: #usagenotification #### [usageNotification] The usage notification for SL Storage services. -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -985,7 +1101,8 @@ The usage notification for SL Storage services. [vendorName]: #vendorname #### [vendorName] The type of network storage service. -Type: **string** +Type: **string** + @@ -995,7 +1112,8 @@ The type of network storage service. [virtualGuest]: #virtualguest #### [virtualGuest] When applicable, the virtual guest associated with a Storage service. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -1005,7 +1123,8 @@ When applicable, the virtual guest associated with a Storage service. [volumeHistory]: #volumehistory #### [volumeHistory] The username and password history for a Storage service. -Type: **SoftLayer_Network_Storage_History[] ** +Type: **SoftLayer_Network_Storage_History[] ** + @@ -1015,7 +1134,8 @@ The username and password history for a Storage service. [volumeStatus]: #volumestatus #### [volumeStatus] The current status of a network storage volume. -Type: **string** +Type: **string** + @@ -1025,7 +1145,8 @@ The current status of a network storage volume. [webccAccount]: #webccaccount #### [webccAccount] The account username and password for the EVault webCC interface. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -1035,7 +1156,8 @@ The account username and password for the EVault webCC interface. [weeklySchedule]: #weeklyschedule #### [weeklySchedule] The Weekly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -1047,7 +1169,8 @@ The Weekly Schedule which is associated with this network storage volume. [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of the currently active transactions on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1057,7 +1180,8 @@ A count of the currently active transactions on a network storage volume. [allowedHardwareCount]: #allowedhardwarecount #### [allowedHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1067,7 +1191,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedIpAddressCount]: #allowedipaddresscount #### [allowedIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1077,7 +1202,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationHardwareCount]: #allowedreplicationhardwarecount #### [allowedReplicationHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1087,7 +1213,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedReplicationIpAddressCount]: #allowedreplicationipaddresscount #### [allowedReplicationIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1097,7 +1224,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationSubnetCount]: #allowedreplicationsubnetcount #### [allowedReplicationSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1107,7 +1235,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedReplicationVirtualGuestCount]: #allowedreplicationvirtualguestcount #### [allowedReplicationVirtualGuestCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1117,7 +1246,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedSubnetCount]: #allowedsubnetcount #### [allowedSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1127,7 +1257,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedVirtualGuestCount]: #allowedvirtualguestcount #### [allowedVirtualGuestCount] A count of the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1137,7 +1268,8 @@ A count of the SoftLayer_Virtual_Guest objects which are allowed access to this [bandwidthBillingItemCount]: #bandwidthbillingitemcount #### [bandwidthBillingItemCount] A count of the billing items tied to a Storage service's bandwidth usage. -Type: **unsigned long** +Type: **unsigned long** + @@ -1147,7 +1279,8 @@ A count of the billing items tied to a Storage service's bandwidth usage. [credentialCount]: #credentialcount #### [credentialCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1157,7 +1290,8 @@ A count of [dependentDuplicateCount]: #dependentduplicatecount #### [dependentDuplicateCount] A count of the network storage volumes configured to be dependent duplicates of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1167,7 +1301,8 @@ A count of the network storage volumes configured to be dependent duplicates of [eventCount]: #eventcount #### [eventCount] A count of the events which have taken place on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1177,7 +1312,8 @@ A count of the events which have taken place on a network storage volume. [iscsiLunCount]: #iscsiluncount #### [iscsiLunCount] A count of relationship between a container volume and iSCSI LUNs. -Type: **unsigned long** +Type: **unsigned long** + @@ -1187,7 +1323,8 @@ A count of relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddressCount]: #iscsitargetipaddresscount #### [iscsiTargetIpAddressCount] A count of returns the target IP addresses of an iSCSI volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1197,7 +1334,8 @@ A count of returns the target IP addresses of an iSCSI volume. [manualSnapshotCount]: #manualsnapshotcount #### [manualSnapshotCount] A count of the manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **unsigned long** +Type: **unsigned long** + @@ -1207,7 +1345,8 @@ A count of the manually-created snapshots associated with this SoftLayer_Network [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of the subscribers that will be notified for usage amount warnings and overages. -Type: **unsigned long** +Type: **unsigned long** + @@ -1217,7 +1356,8 @@ A count of the subscribers that will be notified for usage amount warnings and o [parentPartnershipCount]: #parentpartnershipcount #### [parentPartnershipCount] A count of the volumes or snapshots partnered with a network storage volume in a parental role. -Type: **unsigned long** +Type: **unsigned long** + @@ -1227,7 +1367,8 @@ A count of the volumes or snapshots partnered with a network storage volume in a [partnershipCount]: #partnershipcount #### [partnershipCount] A count of the volumes or snapshots partnered with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1237,7 +1378,8 @@ A count of the volumes or snapshots partnered with a network storage volume. [permissionsGroupCount]: #permissionsgroupcount #### [permissionsGroupCount] A count of all permissions group(s) this volume is in. -Type: **unsigned long** +Type: **unsigned long** + @@ -1247,7 +1389,8 @@ A count of all permissions group(s) this volume is in. [propertyCount]: #propertycount #### [propertyCount] A count of the properties used to provide additional details about a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1257,7 +1400,8 @@ A count of the properties used to provide additional details about a network sto [replicatingLunCount]: #replicatingluncount #### [replicatingLunCount] A count of the iSCSI LUN volumes being replicated by this network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1267,7 +1411,8 @@ A count of the iSCSI LUN volumes being replicated by this network storage volume [replicationEventCount]: #replicationeventcount #### [replicationEventCount] A count of the volume replication events. -Type: **unsigned long** +Type: **unsigned long** + @@ -1277,7 +1422,8 @@ A count of the volume replication events. [replicationPartnerCount]: #replicationpartnercount #### [replicationPartnerCount] A count of the network storage volumes configured to be replicants of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1287,7 +1433,8 @@ A count of the network storage volumes configured to be replicants of a volume. [scheduleCount]: #schedulecount #### [scheduleCount] A count of the schedules which are associated with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1297,7 +1444,8 @@ A count of the schedules which are associated with a network storage volume. [snapshotCount]: #snapshotcount #### [snapshotCount] A count of the snapshots associated with this SoftLayer_Network_Storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1307,7 +1455,8 @@ A count of the snapshots associated with this SoftLayer_Network_Storage volume. [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of the network storage groups this volume is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1317,7 +1466,8 @@ A count of the network storage groups this volume is attached to. [volumeHistoryCount]: #volumehistorycount #### [volumeHistoryCount] A count of the username and password history for a Storage service. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Cleversafe_Account/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Cleversafe_Account/_index.md index b20cfdbf8b..7626921914 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Cleversafe_Account/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Cleversafe_Account/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The ID of the SoftLayer_Account which this IBM Cloud Object Storage account is associated with. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The ID of the SoftLayer_Account which this IBM Cloud Object Storage account is a [id]: #id #### [id] The IMS ID of an IBM Cloud Object Storage account. -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ The IMS ID of an IBM Cloud Object Storage account. [notes]: #notes #### [notes] A user-defined field of notes. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A user-defined field of notes. [username]: #username #### [username] Human readable identifier of IBM Cloud Object Storage accounts. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ Human readable identifier of IBM Cloud Object Storage accounts. [account]: #account #### [account] SoftLayer account to which an IBM Cloud Object Storage account belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -101,7 +108,8 @@ SoftLayer account to which an IBM Cloud Object Storage account belongs to. [billingItem]: #billingitem #### [billingItem] An associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ An associated parent billing item which is active. Includes billing items which [cancelledBillingItem]: #cancelledbillingitem #### [cancelledBillingItem] An associated parent billing item which has been cancelled. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -121,7 +130,8 @@ An associated parent billing item which has been cancelled. [credentials]: #credentials #### [credentials] Credentials used for generating an AWS signature. Max of 2. -Type: **SoftLayer_Network_Storage_Credential[] ** +Type: **SoftLayer_Network_Storage_Credential[] ** + @@ -131,7 +141,8 @@ Credentials used for generating an AWS signature. Max of 2. [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] Provides an interface to various metrics relating to the usage of an IBM Cloud Object Storage account. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -141,7 +152,8 @@ Provides an interface to various metrics relating to the usage of an IBM Cloud O [uuid]: #uuid #### [uuid] Unique identifier for an IBM Cloud Object Storage account. -Type: **string** +Type: **string** + @@ -153,7 +165,8 @@ Unique identifier for an IBM Cloud Object Storage account. [credentialCount]: #credentialcount #### [credentialCount] A count of credentials used for generating an AWS signature. Max of 2. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Swift/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Swift/_index.md index a6f089c077..cb2c8b441e 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Swift/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Swift/_index.md @@ -22,6 +22,8 @@ classes: + + ### seeAlso * [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage ) @@ -50,7 +52,8 @@ classes: [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account that a Storage account belongs to. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ The internal identifier of the SoftLayer customer account that a Storage account [capacityGb]: #capacitygb #### [capacityGb] A Storage account's capacity, measured in gigabytes. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ A Storage account's capacity, measured in gigabytes. [createDate]: #createdate #### [createDate] The date a network storage volume was created. -Type: **dateTime** +Type: **dateTime** + @@ -80,7 +85,8 @@ The date a network storage volume was created. [guestId]: #guestid #### [guestId] The unique identification number of the guest associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -90,7 +96,8 @@ The unique identification number of the guest associated with a Storage volume. [hardwareId]: #hardwareid #### [hardwareId] The server that is associated with a Storage service. -Type: **integer** +Type: **integer** + @@ -100,7 +107,8 @@ The server that is associated with a Storage service. [hostId]: #hostid #### [hostId] The unique identification number of the host associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -110,7 +118,8 @@ The unique identification number of the host associated with a Storage volume. [id]: #id #### [id] A Storage account's unique identifier. -Type: **integer** +Type: **integer** + @@ -120,7 +129,8 @@ A Storage account's unique identifier. [nasType]: #nastype #### [nasType] A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT", and "HUB". -Type: **string** +Type: **string** + @@ -130,7 +140,8 @@ A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT" [notes]: #notes #### [notes] Public notes related to a Storage volume. -Type: **string** +Type: **string** + @@ -140,7 +151,8 @@ Public notes related to a Storage volume. [password]: #password #### [password] The password used to access a non-EVault Storage volume. This password is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -150,7 +162,8 @@ The password used to access a non-EVault Storage volume. This password is used t [serviceProviderId]: #serviceproviderid #### [serviceProviderId] Service Provider ID -Type: **integer** +Type: **integer** + @@ -160,7 +173,8 @@ Service Provider ID [storageTypeId]: #storagetypeid #### [storageTypeId] A storage object's type. -Type: **string** +Type: **string** + @@ -170,7 +184,8 @@ A storage object's type. [upgradableFlag]: #upgradableflag #### [upgradableFlag] This flag indicates whether this storage type is upgradable or not. -Type: **boolean** +Type: **boolean** + @@ -180,7 +195,8 @@ This flag indicates whether this storage type is upgradable or not. [username]: #username #### [username] The username used to access a non-EVault Storage volume. This username is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -196,7 +212,8 @@ The username used to access a non-EVault Storage volume. This username is used t [account]: #account #### [account] The account that a Storage services belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -206,7 +223,8 @@ The account that a Storage services belongs to. [accountPassword]: #accountpassword #### [accountPassword] Other usernames and passwords associated with a Storage volume. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -216,7 +234,19 @@ Other usernames and passwords associated with a Storage volume. [activeTransactions]: #activetransactions #### [activeTransactions] The currently active transactions on a network storage volume. -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + + + + +
      + +----- +[allowDisasterRecoveryFailback]: #allowdisasterrecoveryfailback +#### [allowDisasterRecoveryFailback] + +Type: **string** +
      @@ -226,7 +256,8 @@ The currently active transactions on a network storage volume. [allowDisasterRecoveryFailover]: #allowdisasterrecoveryfailover #### [allowDisasterRecoveryFailover] -Type: **string** +Type: **string** + @@ -236,7 +267,8 @@ The currently active transactions on a network storage volume. [allowedHardware]: #allowedhardware #### [allowedHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -246,7 +278,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume. [allowedIpAddresses]: #allowedipaddresses #### [allowedIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -256,7 +289,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationHardware]: #allowedreplicationhardware #### [allowedReplicationHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -266,7 +300,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedReplicationIpAddresses]: #allowedreplicationipaddresses #### [allowedReplicationIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -276,7 +311,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationSubnets]: #allowedreplicationsubnets #### [allowedReplicationSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -286,7 +322,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedReplicationVirtualGuests]: #allowedreplicationvirtualguests #### [allowedReplicationVirtualGuests] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -296,7 +333,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedSubnets]: #allowedsubnets #### [allowedSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -306,7 +344,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedVirtualGuests]: #allowedvirtualguests #### [allowedVirtualGuests] The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -316,7 +355,8 @@ The SoftLayer_Virtual_Guest objects which are allowed access to this storage vol [bandwidthBillingItems]: #bandwidthbillingitems #### [bandwidthBillingItems] The billing items tied to a Storage service's bandwidth usage. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -326,7 +366,8 @@ The billing items tied to a Storage service's bandwidth usage. [billingItem]: #billingitem #### [billingItem] The current billing item for a Storage volume. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -336,7 +377,8 @@ The current billing item for a Storage volume. [billingItemCategory]: #billingitemcategory #### [billingItemCategory] -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -346,7 +388,8 @@ The current billing item for a Storage volume. [bytesUsed]: #bytesused #### [bytesUsed] The amount of space used by the volume, in bytes. -Type: **string** +Type: **string** + @@ -356,7 +399,8 @@ The amount of space used by the volume, in bytes. [creationScheduleId]: #creationscheduleid #### [creationScheduleId] The schedule id which was executed to create a snapshot. -Type: **string** +Type: **string** + @@ -366,7 +410,8 @@ The schedule id which was executed to create a snapshot. [credentials]: #credentials #### [credentials] -Type: **SoftLayer_Network_Storage_Credential[] ** +Type: **SoftLayer_Network_Storage_Credential[] ** + @@ -376,7 +421,8 @@ The schedule id which was executed to create a snapshot. [dailySchedule]: #dailyschedule #### [dailySchedule] The Daily Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -386,7 +432,8 @@ The Daily Schedule which is associated with this network storage volume. [dependentDuplicate]: #dependentduplicate #### [dependentDuplicate] Whether or not a network storage volume is a dependent duplicate. -Type: **string** +Type: **string** + @@ -396,7 +443,8 @@ Whether or not a network storage volume is a dependent duplicate. [dependentDuplicates]: #dependentduplicates #### [dependentDuplicates] The network storage volumes configured to be dependent duplicates of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -406,7 +454,8 @@ The network storage volumes configured to be dependent duplicates of a volume. [events]: #events #### [events] The events which have taken place on a network storage volume. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -416,7 +465,19 @@ The events which have taken place on a network storage volume. [failbackNotAllowed]: #failbacknotallowed #### [failbackNotAllowed] Determines whether the volume is allowed to failback -Type: **string** +Type: **string** + + + + +
      + +----- +[failoverNotAllowed]: #failovernotallowed +#### [failoverNotAllowed] +Determines whether the volume is allowed to failover +Type: **string** +
      @@ -426,7 +487,8 @@ Determines whether the volume is allowed to failback [fileNetworkMountAddress]: #filenetworkmountaddress #### [fileNetworkMountAddress] Retrieves the NFS Network Mount Address Name for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -436,7 +498,8 @@ Retrieves the NFS Network Mount Address Name for a given File Storage Volume. [hardware]: #hardware #### [hardware] When applicable, the hardware associated with a Storage service. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -446,7 +509,8 @@ When applicable, the hardware associated with a Storage service. [hasEncryptionAtRest]: #hasencryptionatrest #### [hasEncryptionAtRest] -Type: **boolean** +Type: **boolean** + @@ -456,7 +520,8 @@ When applicable, the hardware associated with a Storage service. [hourlySchedule]: #hourlyschedule #### [hourlySchedule] The Hourly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -466,7 +531,8 @@ The Hourly Schedule which is associated with this network storage volume. [intervalSchedule]: #intervalschedule #### [intervalSchedule] The Interval Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -476,7 +542,8 @@ The Interval Schedule which is associated with this network storage volume. [iops]: #iops #### [iops] The maximum number of IOPs selected for this volume. -Type: **string** +Type: **string** + @@ -486,7 +553,8 @@ The maximum number of IOPs selected for this volume. [isDependentDuplicateProvisionCompleted]: #isdependentduplicateprovisioncompleted #### [isDependentDuplicateProvisionCompleted] Determines whether dependent volume provision is completed on background. -Type: **boolean** +Type: **boolean** + @@ -496,7 +564,8 @@ Determines whether dependent volume provision is completed on background. [isInDedicatedServiceResource]: #isindedicatedserviceresource #### [isInDedicatedServiceResource] -Type: **boolean** +Type: **boolean** + @@ -506,7 +575,8 @@ Determines whether dependent volume provision is completed on background. [isMagneticStorage]: #ismagneticstorage #### [isMagneticStorage] -Type: **string** +Type: **string** + @@ -516,7 +586,8 @@ Determines whether dependent volume provision is completed on background. [isReadyForSnapshot]: #isreadyforsnapshot #### [isReadyForSnapshot] Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. -Type: **boolean** +Type: **boolean** + @@ -526,7 +597,8 @@ Determines whether a volume is ready to order snapshot space, or, if snapshot sp [isReadyToMount]: #isreadytomount #### [isReadyToMount] Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. -Type: **boolean** +Type: **boolean** + @@ -536,7 +608,8 @@ Determines whether a volume is ready to have Hosts authorized to access it. This [iscsiLuns]: #iscsiluns #### [iscsiLuns] Relationship between a container volume and iSCSI LUNs. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -546,7 +619,8 @@ Relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddresses]: #iscsitargetipaddresses #### [iscsiTargetIpAddresses] Returns the target IP addresses of an iSCSI volume. -Type: **array of strings** +Type: **array of strings** + @@ -556,7 +630,8 @@ Returns the target IP addresses of an iSCSI volume. [lunId]: #lunid #### [lunId] The ID of the LUN volume. -Type: **string** +Type: **string** + @@ -566,7 +641,8 @@ The ID of the LUN volume. [manualSnapshots]: #manualsnapshots #### [manualSnapshots] The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -576,7 +652,8 @@ The manually-created snapshots associated with this SoftLayer_Network_Storage vo [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A network storage volume's metric tracking object. This object records all periodic polled data available to this volume. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -586,7 +663,8 @@ A network storage volume's metric tracking object. This object records all perio [mountPath]: #mountpath #### [mountPath] Retrieves the NFS Network Mount Path for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -596,7 +674,8 @@ Retrieves the NFS Network Mount Path for a given File Storage Volume. [mountableFlag]: #mountableflag #### [mountableFlag] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -606,7 +685,8 @@ Whether or not a network storage volume may be mounted. [moveAndSplitStatus]: #moveandsplitstatus #### [moveAndSplitStatus] The current status of split or move operation as a part of volume duplication. -Type: **string** +Type: **string** + @@ -616,7 +696,8 @@ The current status of split or move operation as a part of volume duplication. [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] The subscribers that will be notified for usage amount warnings and overages. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -626,7 +707,8 @@ The subscribers that will be notified for usage amount warnings and overages. [originalSnapshotName]: #originalsnapshotname #### [originalSnapshotName] The name of the snapshot that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -636,7 +718,8 @@ The name of the snapshot that this volume was duplicated from. [originalVolumeName]: #originalvolumename #### [originalVolumeName] The name of the volume that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -646,7 +729,8 @@ The name of the volume that this volume was duplicated from. [originalVolumeSize]: #originalvolumesize #### [originalVolumeSize] The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. -Type: **string** +Type: **string** + @@ -656,7 +740,8 @@ The size (in GB) of the volume or LUN before any size expansion, or of the volum [osType]: #ostype #### [osType] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -666,7 +751,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. [osTypeId]: #ostypeid #### [osTypeId] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. -Type: **string** +Type: **string** + @@ -676,7 +762,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. [parentPartnerships]: #parentpartnerships #### [parentPartnerships] The volumes or snapshots partnered with a network storage volume in a parental role. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -686,7 +773,8 @@ The volumes or snapshots partnered with a network storage volume in a parental r [parentVolume]: #parentvolume #### [parentVolume] The parent volume of a volume in a complex storage relationship. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -696,7 +784,8 @@ The parent volume of a volume in a complex storage relationship. [partnerships]: #partnerships #### [partnerships] The volumes or snapshots partnered with a network storage volume. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -706,7 +795,8 @@ The volumes or snapshots partnered with a network storage volume. [permissionsGroups]: #permissionsgroups #### [permissionsGroups] All permissions group(s) this volume is in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -716,7 +806,8 @@ All permissions group(s) this volume is in. [properties]: #properties #### [properties] The properties used to provide additional details about a network storage volume. -Type: **SoftLayer_Network_Storage_Property[] ** +Type: **SoftLayer_Network_Storage_Property[] ** + @@ -726,7 +817,8 @@ The properties used to provide additional details about a network storage volume [provisionedIops]: #provisionediops #### [provisionedIops] The number of IOPs provisioned for this volume. -Type: **string** +Type: **string** + @@ -736,7 +828,8 @@ The number of IOPs provisioned for this volume. [replicatingLuns]: #replicatingluns #### [replicatingLuns] The iSCSI LUN volumes being replicated by this network storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -746,7 +839,8 @@ The iSCSI LUN volumes being replicated by this network storage volume. [replicatingVolume]: #replicatingvolume #### [replicatingVolume] The network storage volume being replicated by a volume. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -756,7 +850,8 @@ The network storage volume being replicated by a volume. [replicationEvents]: #replicationevents #### [replicationEvents] The volume replication events. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -766,7 +861,8 @@ The volume replication events. [replicationPartners]: #replicationpartners #### [replicationPartners] The network storage volumes configured to be replicants of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -776,7 +872,8 @@ The network storage volumes configured to be replicants of a volume. [replicationSchedule]: #replicationschedule #### [replicationSchedule] The Replication Schedule associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -786,7 +883,8 @@ The Replication Schedule associated with a network storage volume. [replicationStatus]: #replicationstatus #### [replicationStatus] The current replication status of a network storage volume. Indicates Failover or Failback status. -Type: **string** +Type: **string** + @@ -796,7 +894,8 @@ The current replication status of a network storage volume. Indicates Failover o [schedules]: #schedules #### [schedules] The schedules which are associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule[] ** +Type: **SoftLayer_Network_Storage_Schedule[] ** + @@ -806,7 +905,8 @@ The schedules which are associated with a network storage volume. [serviceResource]: #serviceresource #### [serviceResource] The network resource a Storage service is connected to. -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -816,7 +916,8 @@ The network resource a Storage service is connected to. [serviceResourceBackendIpAddress]: #serviceresourcebackendipaddress #### [serviceResourceBackendIpAddress] The IP address of a Storage resource. -Type: **string** +Type: **string** + @@ -826,7 +927,8 @@ The IP address of a Storage resource. [serviceResourceName]: #serviceresourcename #### [serviceResourceName] The name of a Storage's network resource. -Type: **string** +Type: **string** + @@ -836,7 +938,8 @@ The name of a Storage's network resource. [snapshotCapacityGb]: #snapshotcapacitygb #### [snapshotCapacityGb] A volume's configured snapshot space size. -Type: **string** +Type: **string** + @@ -846,7 +949,8 @@ A volume's configured snapshot space size. [snapshotCreationTimestamp]: #snapshotcreationtimestamp #### [snapshotCreationTimestamp] The creation timestamp of the snapshot on the storage platform. -Type: **string** +Type: **string** + @@ -856,7 +960,8 @@ The creation timestamp of the snapshot on the storage platform. [snapshotDeletionThresholdPercentage]: #snapshotdeletionthresholdpercentage #### [snapshotDeletionThresholdPercentage] The percentage of used snapshot space after which to delete automated snapshots. -Type: **string** +Type: **string** + @@ -866,7 +971,8 @@ The percentage of used snapshot space after which to delete automated snapshots. [snapshotNotificationStatus]: #snapshotnotificationstatus #### [snapshotNotificationStatus] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -876,7 +982,8 @@ Whether or not a network storage volume may be mounted. [snapshotSizeBytes]: #snapshotsizebytes #### [snapshotSizeBytes] The snapshot size in bytes. -Type: **string** +Type: **string** + @@ -886,7 +993,8 @@ The snapshot size in bytes. [snapshotSpaceAvailable]: #snapshotspaceavailable #### [snapshotSpaceAvailable] A volume's available snapshot reservation space. -Type: **string** +Type: **string** + @@ -896,7 +1004,8 @@ A volume's available snapshot reservation space. [snapshots]: #snapshots #### [snapshots] The snapshots associated with this SoftLayer_Network_Storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -906,7 +1015,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [staasVersion]: #staasversion #### [staasVersion] -Type: **string** +Type: **string** + @@ -916,7 +1026,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [storageGroups]: #storagegroups #### [storageGroups] The network storage groups this volume is attached to. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -926,7 +1037,8 @@ The network storage groups this volume is attached to. [storageNodes]: #storagenodes #### [storageNodes] -Type: **SoftLayer_Network_Service_Resource[] ** +Type: **SoftLayer_Network_Service_Resource[] ** + @@ -936,7 +1048,8 @@ The network storage groups this volume is attached to. [storageTierLevel]: #storagetierlevel #### [storageTierLevel] -Type: **string** +Type: **string** + @@ -946,7 +1059,8 @@ The network storage groups this volume is attached to. [storageType]: #storagetype #### [storageType] A description of the Storage object. -Type: **SoftLayer_Network_Storage_Type ** +Type: **SoftLayer_Network_Storage_Type ** + @@ -956,7 +1070,8 @@ A description of the Storage object. [totalBytesUsed]: #totalbytesused #### [totalBytesUsed] The amount of space used by the volume. -Type: **string** +Type: **string** + @@ -966,7 +1081,8 @@ The amount of space used by the volume. [totalScheduleSnapshotRetentionCount]: #totalschedulesnapshotretentioncount #### [totalScheduleSnapshotRetentionCount] The total snapshot retention count of all schedules on this network storage volume. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -976,7 +1092,8 @@ The total snapshot retention count of all schedules on this network storage volu [usageNotification]: #usagenotification #### [usageNotification] The usage notification for SL Storage services. -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -986,7 +1103,8 @@ The usage notification for SL Storage services. [vendorName]: #vendorname #### [vendorName] The type of network storage service. -Type: **string** +Type: **string** + @@ -996,7 +1114,8 @@ The type of network storage service. [virtualGuest]: #virtualguest #### [virtualGuest] When applicable, the virtual guest associated with a Storage service. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -1006,7 +1125,8 @@ When applicable, the virtual guest associated with a Storage service. [volumeHistory]: #volumehistory #### [volumeHistory] The username and password history for a Storage service. -Type: **SoftLayer_Network_Storage_History[] ** +Type: **SoftLayer_Network_Storage_History[] ** + @@ -1016,7 +1136,8 @@ The username and password history for a Storage service. [volumeStatus]: #volumestatus #### [volumeStatus] The current status of a network storage volume. -Type: **string** +Type: **string** + @@ -1026,7 +1147,8 @@ The current status of a network storage volume. [webccAccount]: #webccaccount #### [webccAccount] The account username and password for the EVault webCC interface. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -1036,7 +1158,8 @@ The account username and password for the EVault webCC interface. [weeklySchedule]: #weeklyschedule #### [weeklySchedule] The Weekly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -1048,7 +1171,8 @@ The Weekly Schedule which is associated with this network storage volume. [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of the currently active transactions on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1058,7 +1182,8 @@ A count of the currently active transactions on a network storage volume. [allowedHardwareCount]: #allowedhardwarecount #### [allowedHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1068,7 +1193,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedIpAddressCount]: #allowedipaddresscount #### [allowedIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1078,7 +1204,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationHardwareCount]: #allowedreplicationhardwarecount #### [allowedReplicationHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1088,7 +1215,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedReplicationIpAddressCount]: #allowedreplicationipaddresscount #### [allowedReplicationIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1098,7 +1226,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationSubnetCount]: #allowedreplicationsubnetcount #### [allowedReplicationSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1108,7 +1237,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedReplicationVirtualGuestCount]: #allowedreplicationvirtualguestcount #### [allowedReplicationVirtualGuestCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1118,7 +1248,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedSubnetCount]: #allowedsubnetcount #### [allowedSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1128,7 +1259,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedVirtualGuestCount]: #allowedvirtualguestcount #### [allowedVirtualGuestCount] A count of the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1138,7 +1270,8 @@ A count of the SoftLayer_Virtual_Guest objects which are allowed access to this [bandwidthBillingItemCount]: #bandwidthbillingitemcount #### [bandwidthBillingItemCount] A count of the billing items tied to a Storage service's bandwidth usage. -Type: **unsigned long** +Type: **unsigned long** + @@ -1148,7 +1281,8 @@ A count of the billing items tied to a Storage service's bandwidth usage. [credentialCount]: #credentialcount #### [credentialCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1158,7 +1292,8 @@ A count of [dependentDuplicateCount]: #dependentduplicatecount #### [dependentDuplicateCount] A count of the network storage volumes configured to be dependent duplicates of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1168,7 +1303,8 @@ A count of the network storage volumes configured to be dependent duplicates of [eventCount]: #eventcount #### [eventCount] A count of the events which have taken place on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1178,7 +1314,8 @@ A count of the events which have taken place on a network storage volume. [iscsiLunCount]: #iscsiluncount #### [iscsiLunCount] A count of relationship between a container volume and iSCSI LUNs. -Type: **unsigned long** +Type: **unsigned long** + @@ -1188,7 +1325,8 @@ A count of relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddressCount]: #iscsitargetipaddresscount #### [iscsiTargetIpAddressCount] A count of returns the target IP addresses of an iSCSI volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1198,7 +1336,8 @@ A count of returns the target IP addresses of an iSCSI volume. [manualSnapshotCount]: #manualsnapshotcount #### [manualSnapshotCount] A count of the manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **unsigned long** +Type: **unsigned long** + @@ -1208,7 +1347,8 @@ A count of the manually-created snapshots associated with this SoftLayer_Network [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of the subscribers that will be notified for usage amount warnings and overages. -Type: **unsigned long** +Type: **unsigned long** + @@ -1218,7 +1358,8 @@ A count of the subscribers that will be notified for usage amount warnings and o [parentPartnershipCount]: #parentpartnershipcount #### [parentPartnershipCount] A count of the volumes or snapshots partnered with a network storage volume in a parental role. -Type: **unsigned long** +Type: **unsigned long** + @@ -1228,7 +1369,8 @@ A count of the volumes or snapshots partnered with a network storage volume in a [partnershipCount]: #partnershipcount #### [partnershipCount] A count of the volumes or snapshots partnered with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1238,7 +1380,8 @@ A count of the volumes or snapshots partnered with a network storage volume. [permissionsGroupCount]: #permissionsgroupcount #### [permissionsGroupCount] A count of all permissions group(s) this volume is in. -Type: **unsigned long** +Type: **unsigned long** + @@ -1248,7 +1391,8 @@ A count of all permissions group(s) this volume is in. [propertyCount]: #propertycount #### [propertyCount] A count of the properties used to provide additional details about a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1258,7 +1402,8 @@ A count of the properties used to provide additional details about a network sto [replicatingLunCount]: #replicatingluncount #### [replicatingLunCount] A count of the iSCSI LUN volumes being replicated by this network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1268,7 +1413,8 @@ A count of the iSCSI LUN volumes being replicated by this network storage volume [replicationEventCount]: #replicationeventcount #### [replicationEventCount] A count of the volume replication events. -Type: **unsigned long** +Type: **unsigned long** + @@ -1278,7 +1424,8 @@ A count of the volume replication events. [replicationPartnerCount]: #replicationpartnercount #### [replicationPartnerCount] A count of the network storage volumes configured to be replicants of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1288,7 +1435,8 @@ A count of the network storage volumes configured to be replicants of a volume. [scheduleCount]: #schedulecount #### [scheduleCount] A count of the schedules which are associated with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1298,7 +1446,8 @@ A count of the schedules which are associated with a network storage volume. [snapshotCount]: #snapshotcount #### [snapshotCount] A count of the snapshots associated with this SoftLayer_Network_Storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1308,7 +1457,8 @@ A count of the snapshots associated with this SoftLayer_Network_Storage volume. [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of the network storage groups this volume is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1318,7 +1468,8 @@ A count of the network storage groups this volume is attached to. [storageNodeCount]: #storagenodecount #### [storageNodeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1328,7 +1479,8 @@ A count of [volumeHistoryCount]: #volumehistorycount #### [volumeHistoryCount] A count of the username and password history for a Storage service. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Swift_Container/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Swift_Container/_index.md index 48685d037b..890f1786b8 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Swift_Container/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Swift_Container/_index.md @@ -22,6 +22,8 @@ classes: + + ### seeAlso * [SoftLayer_Network_Storage_Hub_Swift_Version1](/reference/datatypes/SoftLayer_Network_Storage_Hub_Swift_Version1 ) @@ -50,7 +52,8 @@ classes: [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account that a Storage account belongs to. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ The internal identifier of the SoftLayer customer account that a Storage account [capacityGb]: #capacitygb #### [capacityGb] A Storage account's capacity, measured in gigabytes. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ A Storage account's capacity, measured in gigabytes. [createDate]: #createdate #### [createDate] The date a network storage volume was created. -Type: **dateTime** +Type: **dateTime** + @@ -80,7 +85,8 @@ The date a network storage volume was created. [guestId]: #guestid #### [guestId] The unique identification number of the guest associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -90,7 +96,8 @@ The unique identification number of the guest associated with a Storage volume. [hardwareId]: #hardwareid #### [hardwareId] The server that is associated with a Storage service. -Type: **integer** +Type: **integer** + @@ -100,7 +107,8 @@ The server that is associated with a Storage service. [hostId]: #hostid #### [hostId] The unique identification number of the host associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -110,7 +118,8 @@ The unique identification number of the host associated with a Storage volume. [id]: #id #### [id] A Storage account's unique identifier. -Type: **integer** +Type: **integer** + @@ -120,7 +129,8 @@ A Storage account's unique identifier. [nasType]: #nastype #### [nasType] A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT", and "HUB". -Type: **string** +Type: **string** + @@ -130,7 +140,8 @@ A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT" [notes]: #notes #### [notes] Public notes related to a Storage volume. -Type: **string** +Type: **string** + @@ -140,7 +151,8 @@ Public notes related to a Storage volume. [password]: #password #### [password] The password used to access a non-EVault Storage volume. This password is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -150,7 +162,8 @@ The password used to access a non-EVault Storage volume. This password is used t [serviceProviderId]: #serviceproviderid #### [serviceProviderId] Service Provider ID -Type: **integer** +Type: **integer** + @@ -160,7 +173,8 @@ Service Provider ID [storageTypeId]: #storagetypeid #### [storageTypeId] A storage object's type. -Type: **string** +Type: **string** + @@ -170,7 +184,8 @@ A storage object's type. [upgradableFlag]: #upgradableflag #### [upgradableFlag] This flag indicates whether this storage type is upgradable or not. -Type: **boolean** +Type: **boolean** + @@ -180,7 +195,8 @@ This flag indicates whether this storage type is upgradable or not. [username]: #username #### [username] The username used to access a non-EVault Storage volume. This username is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -196,7 +212,8 @@ The username used to access a non-EVault Storage volume. This username is used t [account]: #account #### [account] The account that a Storage services belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -206,7 +223,8 @@ The account that a Storage services belongs to. [accountPassword]: #accountpassword #### [accountPassword] Other usernames and passwords associated with a Storage volume. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -216,7 +234,19 @@ Other usernames and passwords associated with a Storage volume. [activeTransactions]: #activetransactions #### [activeTransactions] The currently active transactions on a network storage volume. -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + + + + +
      + +----- +[allowDisasterRecoveryFailback]: #allowdisasterrecoveryfailback +#### [allowDisasterRecoveryFailback] + +Type: **string** +
      @@ -226,7 +256,8 @@ The currently active transactions on a network storage volume. [allowDisasterRecoveryFailover]: #allowdisasterrecoveryfailover #### [allowDisasterRecoveryFailover] -Type: **string** +Type: **string** + @@ -236,7 +267,8 @@ The currently active transactions on a network storage volume. [allowedHardware]: #allowedhardware #### [allowedHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -246,7 +278,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume. [allowedIpAddresses]: #allowedipaddresses #### [allowedIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -256,7 +289,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationHardware]: #allowedreplicationhardware #### [allowedReplicationHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -266,7 +300,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedReplicationIpAddresses]: #allowedreplicationipaddresses #### [allowedReplicationIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -276,7 +311,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationSubnets]: #allowedreplicationsubnets #### [allowedReplicationSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -286,7 +322,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedReplicationVirtualGuests]: #allowedreplicationvirtualguests #### [allowedReplicationVirtualGuests] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -296,7 +333,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedSubnets]: #allowedsubnets #### [allowedSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -306,7 +344,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedVirtualGuests]: #allowedvirtualguests #### [allowedVirtualGuests] The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -316,7 +355,8 @@ The SoftLayer_Virtual_Guest objects which are allowed access to this storage vol [bandwidthBillingItems]: #bandwidthbillingitems #### [bandwidthBillingItems] The billing items tied to a Storage service's bandwidth usage. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -326,7 +366,8 @@ The billing items tied to a Storage service's bandwidth usage. [billingItem]: #billingitem #### [billingItem] The current billing item for a Storage volume. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -336,7 +377,8 @@ The current billing item for a Storage volume. [billingItemCategory]: #billingitemcategory #### [billingItemCategory] -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -346,7 +388,8 @@ The current billing item for a Storage volume. [bytesUsed]: #bytesused #### [bytesUsed] The amount of space used by the volume, in bytes. -Type: **string** +Type: **string** + @@ -356,7 +399,8 @@ The amount of space used by the volume, in bytes. [creationScheduleId]: #creationscheduleid #### [creationScheduleId] The schedule id which was executed to create a snapshot. -Type: **string** +Type: **string** + @@ -366,7 +410,8 @@ The schedule id which was executed to create a snapshot. [credentials]: #credentials #### [credentials] -Type: **SoftLayer_Network_Storage_Credential[] ** +Type: **SoftLayer_Network_Storage_Credential[] ** + @@ -376,7 +421,8 @@ The schedule id which was executed to create a snapshot. [dailySchedule]: #dailyschedule #### [dailySchedule] The Daily Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -386,7 +432,8 @@ The Daily Schedule which is associated with this network storage volume. [dependentDuplicate]: #dependentduplicate #### [dependentDuplicate] Whether or not a network storage volume is a dependent duplicate. -Type: **string** +Type: **string** + @@ -396,7 +443,8 @@ Whether or not a network storage volume is a dependent duplicate. [dependentDuplicates]: #dependentduplicates #### [dependentDuplicates] The network storage volumes configured to be dependent duplicates of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -406,7 +454,8 @@ The network storage volumes configured to be dependent duplicates of a volume. [events]: #events #### [events] The events which have taken place on a network storage volume. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -416,7 +465,19 @@ The events which have taken place on a network storage volume. [failbackNotAllowed]: #failbacknotallowed #### [failbackNotAllowed] Determines whether the volume is allowed to failback -Type: **string** +Type: **string** + + + + +
      + +----- +[failoverNotAllowed]: #failovernotallowed +#### [failoverNotAllowed] +Determines whether the volume is allowed to failover +Type: **string** +
      @@ -426,7 +487,8 @@ Determines whether the volume is allowed to failback [fileNetworkMountAddress]: #filenetworkmountaddress #### [fileNetworkMountAddress] Retrieves the NFS Network Mount Address Name for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -436,7 +498,8 @@ Retrieves the NFS Network Mount Address Name for a given File Storage Volume. [hardware]: #hardware #### [hardware] When applicable, the hardware associated with a Storage service. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -446,7 +509,8 @@ When applicable, the hardware associated with a Storage service. [hasEncryptionAtRest]: #hasencryptionatrest #### [hasEncryptionAtRest] -Type: **boolean** +Type: **boolean** + @@ -456,7 +520,8 @@ When applicable, the hardware associated with a Storage service. [hourlySchedule]: #hourlyschedule #### [hourlySchedule] The Hourly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -466,7 +531,8 @@ The Hourly Schedule which is associated with this network storage volume. [intervalSchedule]: #intervalschedule #### [intervalSchedule] The Interval Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -476,7 +542,8 @@ The Interval Schedule which is associated with this network storage volume. [iops]: #iops #### [iops] The maximum number of IOPs selected for this volume. -Type: **string** +Type: **string** + @@ -486,7 +553,8 @@ The maximum number of IOPs selected for this volume. [isDependentDuplicateProvisionCompleted]: #isdependentduplicateprovisioncompleted #### [isDependentDuplicateProvisionCompleted] Determines whether dependent volume provision is completed on background. -Type: **boolean** +Type: **boolean** + @@ -496,7 +564,8 @@ Determines whether dependent volume provision is completed on background. [isInDedicatedServiceResource]: #isindedicatedserviceresource #### [isInDedicatedServiceResource] -Type: **boolean** +Type: **boolean** + @@ -506,7 +575,8 @@ Determines whether dependent volume provision is completed on background. [isMagneticStorage]: #ismagneticstorage #### [isMagneticStorage] -Type: **string** +Type: **string** + @@ -516,7 +586,8 @@ Determines whether dependent volume provision is completed on background. [isReadyForSnapshot]: #isreadyforsnapshot #### [isReadyForSnapshot] Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. -Type: **boolean** +Type: **boolean** + @@ -526,7 +597,8 @@ Determines whether a volume is ready to order snapshot space, or, if snapshot sp [isReadyToMount]: #isreadytomount #### [isReadyToMount] Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. -Type: **boolean** +Type: **boolean** + @@ -536,7 +608,8 @@ Determines whether a volume is ready to have Hosts authorized to access it. This [iscsiLuns]: #iscsiluns #### [iscsiLuns] Relationship between a container volume and iSCSI LUNs. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -546,7 +619,8 @@ Relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddresses]: #iscsitargetipaddresses #### [iscsiTargetIpAddresses] Returns the target IP addresses of an iSCSI volume. -Type: **array of strings** +Type: **array of strings** + @@ -556,7 +630,8 @@ Returns the target IP addresses of an iSCSI volume. [lunId]: #lunid #### [lunId] The ID of the LUN volume. -Type: **string** +Type: **string** + @@ -566,7 +641,8 @@ The ID of the LUN volume. [manualSnapshots]: #manualsnapshots #### [manualSnapshots] The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -576,7 +652,8 @@ The manually-created snapshots associated with this SoftLayer_Network_Storage vo [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A network storage volume's metric tracking object. This object records all periodic polled data available to this volume. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -586,7 +663,8 @@ A network storage volume's metric tracking object. This object records all perio [mountPath]: #mountpath #### [mountPath] Retrieves the NFS Network Mount Path for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -596,7 +674,8 @@ Retrieves the NFS Network Mount Path for a given File Storage Volume. [mountableFlag]: #mountableflag #### [mountableFlag] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -606,7 +685,8 @@ Whether or not a network storage volume may be mounted. [moveAndSplitStatus]: #moveandsplitstatus #### [moveAndSplitStatus] The current status of split or move operation as a part of volume duplication. -Type: **string** +Type: **string** + @@ -616,7 +696,8 @@ The current status of split or move operation as a part of volume duplication. [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] The subscribers that will be notified for usage amount warnings and overages. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -626,7 +707,8 @@ The subscribers that will be notified for usage amount warnings and overages. [originalSnapshotName]: #originalsnapshotname #### [originalSnapshotName] The name of the snapshot that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -636,7 +718,8 @@ The name of the snapshot that this volume was duplicated from. [originalVolumeName]: #originalvolumename #### [originalVolumeName] The name of the volume that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -646,7 +729,8 @@ The name of the volume that this volume was duplicated from. [originalVolumeSize]: #originalvolumesize #### [originalVolumeSize] The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. -Type: **string** +Type: **string** + @@ -656,7 +740,8 @@ The size (in GB) of the volume or LUN before any size expansion, or of the volum [osType]: #ostype #### [osType] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -666,7 +751,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. [osTypeId]: #ostypeid #### [osTypeId] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. -Type: **string** +Type: **string** + @@ -676,7 +762,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. [parentPartnerships]: #parentpartnerships #### [parentPartnerships] The volumes or snapshots partnered with a network storage volume in a parental role. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -686,7 +773,8 @@ The volumes or snapshots partnered with a network storage volume in a parental r [parentVolume]: #parentvolume #### [parentVolume] The parent volume of a volume in a complex storage relationship. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -696,7 +784,8 @@ The parent volume of a volume in a complex storage relationship. [partnerships]: #partnerships #### [partnerships] The volumes or snapshots partnered with a network storage volume. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -706,7 +795,8 @@ The volumes or snapshots partnered with a network storage volume. [permissionsGroups]: #permissionsgroups #### [permissionsGroups] All permissions group(s) this volume is in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -716,7 +806,8 @@ All permissions group(s) this volume is in. [properties]: #properties #### [properties] The properties used to provide additional details about a network storage volume. -Type: **SoftLayer_Network_Storage_Property[] ** +Type: **SoftLayer_Network_Storage_Property[] ** + @@ -726,7 +817,8 @@ The properties used to provide additional details about a network storage volume [provisionedIops]: #provisionediops #### [provisionedIops] The number of IOPs provisioned for this volume. -Type: **string** +Type: **string** + @@ -736,7 +828,8 @@ The number of IOPs provisioned for this volume. [replicatingLuns]: #replicatingluns #### [replicatingLuns] The iSCSI LUN volumes being replicated by this network storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -746,7 +839,8 @@ The iSCSI LUN volumes being replicated by this network storage volume. [replicatingVolume]: #replicatingvolume #### [replicatingVolume] The network storage volume being replicated by a volume. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -756,7 +850,8 @@ The network storage volume being replicated by a volume. [replicationEvents]: #replicationevents #### [replicationEvents] The volume replication events. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -766,7 +861,8 @@ The volume replication events. [replicationPartners]: #replicationpartners #### [replicationPartners] The network storage volumes configured to be replicants of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -776,7 +872,8 @@ The network storage volumes configured to be replicants of a volume. [replicationSchedule]: #replicationschedule #### [replicationSchedule] The Replication Schedule associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -786,7 +883,8 @@ The Replication Schedule associated with a network storage volume. [replicationStatus]: #replicationstatus #### [replicationStatus] The current replication status of a network storage volume. Indicates Failover or Failback status. -Type: **string** +Type: **string** + @@ -796,7 +894,8 @@ The current replication status of a network storage volume. Indicates Failover o [schedules]: #schedules #### [schedules] The schedules which are associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule[] ** +Type: **SoftLayer_Network_Storage_Schedule[] ** + @@ -806,7 +905,8 @@ The schedules which are associated with a network storage volume. [serviceResource]: #serviceresource #### [serviceResource] The network resource a Storage service is connected to. -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -816,7 +916,8 @@ The network resource a Storage service is connected to. [serviceResourceBackendIpAddress]: #serviceresourcebackendipaddress #### [serviceResourceBackendIpAddress] The IP address of a Storage resource. -Type: **string** +Type: **string** + @@ -826,7 +927,8 @@ The IP address of a Storage resource. [serviceResourceName]: #serviceresourcename #### [serviceResourceName] The name of a Storage's network resource. -Type: **string** +Type: **string** + @@ -836,7 +938,8 @@ The name of a Storage's network resource. [snapshotCapacityGb]: #snapshotcapacitygb #### [snapshotCapacityGb] A volume's configured snapshot space size. -Type: **string** +Type: **string** + @@ -846,7 +949,8 @@ A volume's configured snapshot space size. [snapshotCreationTimestamp]: #snapshotcreationtimestamp #### [snapshotCreationTimestamp] The creation timestamp of the snapshot on the storage platform. -Type: **string** +Type: **string** + @@ -856,7 +960,8 @@ The creation timestamp of the snapshot on the storage platform. [snapshotDeletionThresholdPercentage]: #snapshotdeletionthresholdpercentage #### [snapshotDeletionThresholdPercentage] The percentage of used snapshot space after which to delete automated snapshots. -Type: **string** +Type: **string** + @@ -866,7 +971,8 @@ The percentage of used snapshot space after which to delete automated snapshots. [snapshotNotificationStatus]: #snapshotnotificationstatus #### [snapshotNotificationStatus] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -876,7 +982,8 @@ Whether or not a network storage volume may be mounted. [snapshotSizeBytes]: #snapshotsizebytes #### [snapshotSizeBytes] The snapshot size in bytes. -Type: **string** +Type: **string** + @@ -886,7 +993,8 @@ The snapshot size in bytes. [snapshotSpaceAvailable]: #snapshotspaceavailable #### [snapshotSpaceAvailable] A volume's available snapshot reservation space. -Type: **string** +Type: **string** + @@ -896,7 +1004,8 @@ A volume's available snapshot reservation space. [snapshots]: #snapshots #### [snapshots] The snapshots associated with this SoftLayer_Network_Storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -906,7 +1015,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [staasVersion]: #staasversion #### [staasVersion] -Type: **string** +Type: **string** + @@ -916,7 +1026,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [storageGroups]: #storagegroups #### [storageGroups] The network storage groups this volume is attached to. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -926,7 +1037,8 @@ The network storage groups this volume is attached to. [storageNodes]: #storagenodes #### [storageNodes] -Type: **SoftLayer_Network_Service_Resource[] ** +Type: **SoftLayer_Network_Service_Resource[] ** + @@ -936,7 +1048,8 @@ The network storage groups this volume is attached to. [storageTierLevel]: #storagetierlevel #### [storageTierLevel] -Type: **string** +Type: **string** + @@ -946,7 +1059,8 @@ The network storage groups this volume is attached to. [storageType]: #storagetype #### [storageType] A description of the Storage object. -Type: **SoftLayer_Network_Storage_Type ** +Type: **SoftLayer_Network_Storage_Type ** + @@ -956,7 +1070,8 @@ A description of the Storage object. [totalBytesUsed]: #totalbytesused #### [totalBytesUsed] The amount of space used by the volume. -Type: **string** +Type: **string** + @@ -966,7 +1081,8 @@ The amount of space used by the volume. [totalScheduleSnapshotRetentionCount]: #totalschedulesnapshotretentioncount #### [totalScheduleSnapshotRetentionCount] The total snapshot retention count of all schedules on this network storage volume. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -976,7 +1092,8 @@ The total snapshot retention count of all schedules on this network storage volu [usageNotification]: #usagenotification #### [usageNotification] The usage notification for SL Storage services. -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -986,7 +1103,8 @@ The usage notification for SL Storage services. [vendorName]: #vendorname #### [vendorName] The type of network storage service. -Type: **string** +Type: **string** + @@ -996,7 +1114,8 @@ The type of network storage service. [virtualGuest]: #virtualguest #### [virtualGuest] When applicable, the virtual guest associated with a Storage service. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -1006,7 +1125,8 @@ When applicable, the virtual guest associated with a Storage service. [volumeHistory]: #volumehistory #### [volumeHistory] The username and password history for a Storage service. -Type: **SoftLayer_Network_Storage_History[] ** +Type: **SoftLayer_Network_Storage_History[] ** + @@ -1016,7 +1136,8 @@ The username and password history for a Storage service. [volumeStatus]: #volumestatus #### [volumeStatus] The current status of a network storage volume. -Type: **string** +Type: **string** + @@ -1026,7 +1147,8 @@ The current status of a network storage volume. [webccAccount]: #webccaccount #### [webccAccount] The account username and password for the EVault webCC interface. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -1036,7 +1158,8 @@ The account username and password for the EVault webCC interface. [weeklySchedule]: #weeklyschedule #### [weeklySchedule] The Weekly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -1048,7 +1171,8 @@ The Weekly Schedule which is associated with this network storage volume. [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of the currently active transactions on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1058,7 +1182,8 @@ A count of the currently active transactions on a network storage volume. [allowedHardwareCount]: #allowedhardwarecount #### [allowedHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1068,7 +1193,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedIpAddressCount]: #allowedipaddresscount #### [allowedIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1078,7 +1204,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationHardwareCount]: #allowedreplicationhardwarecount #### [allowedReplicationHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1088,7 +1215,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedReplicationIpAddressCount]: #allowedreplicationipaddresscount #### [allowedReplicationIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1098,7 +1226,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationSubnetCount]: #allowedreplicationsubnetcount #### [allowedReplicationSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1108,7 +1237,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedReplicationVirtualGuestCount]: #allowedreplicationvirtualguestcount #### [allowedReplicationVirtualGuestCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1118,7 +1248,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedSubnetCount]: #allowedsubnetcount #### [allowedSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1128,7 +1259,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedVirtualGuestCount]: #allowedvirtualguestcount #### [allowedVirtualGuestCount] A count of the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1138,7 +1270,8 @@ A count of the SoftLayer_Virtual_Guest objects which are allowed access to this [bandwidthBillingItemCount]: #bandwidthbillingitemcount #### [bandwidthBillingItemCount] A count of the billing items tied to a Storage service's bandwidth usage. -Type: **unsigned long** +Type: **unsigned long** + @@ -1148,7 +1281,8 @@ A count of the billing items tied to a Storage service's bandwidth usage. [credentialCount]: #credentialcount #### [credentialCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1158,7 +1292,8 @@ A count of [dependentDuplicateCount]: #dependentduplicatecount #### [dependentDuplicateCount] A count of the network storage volumes configured to be dependent duplicates of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1168,7 +1303,8 @@ A count of the network storage volumes configured to be dependent duplicates of [eventCount]: #eventcount #### [eventCount] A count of the events which have taken place on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1178,7 +1314,8 @@ A count of the events which have taken place on a network storage volume. [iscsiLunCount]: #iscsiluncount #### [iscsiLunCount] A count of relationship between a container volume and iSCSI LUNs. -Type: **unsigned long** +Type: **unsigned long** + @@ -1188,7 +1325,8 @@ A count of relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddressCount]: #iscsitargetipaddresscount #### [iscsiTargetIpAddressCount] A count of returns the target IP addresses of an iSCSI volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1198,7 +1336,8 @@ A count of returns the target IP addresses of an iSCSI volume. [manualSnapshotCount]: #manualsnapshotcount #### [manualSnapshotCount] A count of the manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **unsigned long** +Type: **unsigned long** + @@ -1208,7 +1347,8 @@ A count of the manually-created snapshots associated with this SoftLayer_Network [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of the subscribers that will be notified for usage amount warnings and overages. -Type: **unsigned long** +Type: **unsigned long** + @@ -1218,7 +1358,8 @@ A count of the subscribers that will be notified for usage amount warnings and o [parentPartnershipCount]: #parentpartnershipcount #### [parentPartnershipCount] A count of the volumes or snapshots partnered with a network storage volume in a parental role. -Type: **unsigned long** +Type: **unsigned long** + @@ -1228,7 +1369,8 @@ A count of the volumes or snapshots partnered with a network storage volume in a [partnershipCount]: #partnershipcount #### [partnershipCount] A count of the volumes or snapshots partnered with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1238,7 +1380,8 @@ A count of the volumes or snapshots partnered with a network storage volume. [permissionsGroupCount]: #permissionsgroupcount #### [permissionsGroupCount] A count of all permissions group(s) this volume is in. -Type: **unsigned long** +Type: **unsigned long** + @@ -1248,7 +1391,8 @@ A count of all permissions group(s) this volume is in. [propertyCount]: #propertycount #### [propertyCount] A count of the properties used to provide additional details about a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1258,7 +1402,8 @@ A count of the properties used to provide additional details about a network sto [replicatingLunCount]: #replicatingluncount #### [replicatingLunCount] A count of the iSCSI LUN volumes being replicated by this network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1268,7 +1413,8 @@ A count of the iSCSI LUN volumes being replicated by this network storage volume [replicationEventCount]: #replicationeventcount #### [replicationEventCount] A count of the volume replication events. -Type: **unsigned long** +Type: **unsigned long** + @@ -1278,7 +1424,8 @@ A count of the volume replication events. [replicationPartnerCount]: #replicationpartnercount #### [replicationPartnerCount] A count of the network storage volumes configured to be replicants of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1288,7 +1435,8 @@ A count of the network storage volumes configured to be replicants of a volume. [scheduleCount]: #schedulecount #### [scheduleCount] A count of the schedules which are associated with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1298,7 +1446,8 @@ A count of the schedules which are associated with a network storage volume. [snapshotCount]: #snapshotcount #### [snapshotCount] A count of the snapshots associated with this SoftLayer_Network_Storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1308,7 +1457,8 @@ A count of the snapshots associated with this SoftLayer_Network_Storage volume. [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of the network storage groups this volume is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1318,7 +1468,8 @@ A count of the network storage groups this volume is attached to. [storageNodeCount]: #storagenodecount #### [storageNodeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1328,7 +1479,8 @@ A count of [volumeHistoryCount]: #volumehistorycount #### [volumeHistoryCount] A count of the username and password history for a Storage service. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Swift_Metrics/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Swift_Metrics/_index.md index 7f0d4ba16c..575df79288 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Swift_Metrics/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Swift_Metrics/_index.md @@ -24,6 +24,8 @@ classes: + +
      diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Swift_Version1/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Swift_Version1/_index.md index 6bbfecd26b..b25b909421 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Swift_Version1/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Hub_Swift_Version1/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account that a Storage account belongs to. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The internal identifier of the SoftLayer customer account that a Storage account [capacityGb]: #capacitygb #### [capacityGb] A Storage account's capacity, measured in gigabytes. -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ A Storage account's capacity, measured in gigabytes. [createDate]: #createdate #### [createDate] The date a network storage volume was created. -Type: **dateTime** +Type: **dateTime** +
      @@ -75,7 +80,8 @@ The date a network storage volume was created. [guestId]: #guestid #### [guestId] The unique identification number of the guest associated with a Storage volume. -Type: **integer** +Type: **integer** +
      @@ -85,7 +91,8 @@ The unique identification number of the guest associated with a Storage volume. [hardwareId]: #hardwareid #### [hardwareId] The server that is associated with a Storage service. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The server that is associated with a Storage service. [hostId]: #hostid #### [hostId] The unique identification number of the host associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The unique identification number of the host associated with a Storage volume. [id]: #id #### [id] A Storage account's unique identifier. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A Storage account's unique identifier. [nasType]: #nastype #### [nasType] A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT", and "HUB". -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT" [notes]: #notes #### [notes] Public notes related to a Storage volume. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Public notes related to a Storage volume. [password]: #password #### [password] The password used to access a non-EVault Storage volume. This password is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The password used to access a non-EVault Storage volume. This password is used t [serviceProviderId]: #serviceproviderid #### [serviceProviderId] Service Provider ID -Type: **integer** +Type: **integer** + @@ -155,7 +168,8 @@ Service Provider ID [storageTypeId]: #storagetypeid #### [storageTypeId] A storage object's type. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ A storage object's type. [upgradableFlag]: #upgradableflag #### [upgradableFlag] This flag indicates whether this storage type is upgradable or not. -Type: **boolean** +Type: **boolean** + @@ -175,7 +190,8 @@ This flag indicates whether this storage type is upgradable or not. [username]: #username #### [username] The username used to access a non-EVault Storage volume. This username is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ The username used to access a non-EVault Storage volume. This username is used t [account]: #account #### [account] The account that a Storage services belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -201,7 +218,8 @@ The account that a Storage services belongs to. [accountPassword]: #accountpassword #### [accountPassword] Other usernames and passwords associated with a Storage volume. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -211,7 +229,19 @@ Other usernames and passwords associated with a Storage volume. [activeTransactions]: #activetransactions #### [activeTransactions] The currently active transactions on a network storage volume. -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + + + + +
      + +----- +[allowDisasterRecoveryFailback]: #allowdisasterrecoveryfailback +#### [allowDisasterRecoveryFailback] + +Type: **string** +
      @@ -221,7 +251,8 @@ The currently active transactions on a network storage volume. [allowDisasterRecoveryFailover]: #allowdisasterrecoveryfailover #### [allowDisasterRecoveryFailover] -Type: **string** +Type: **string** + @@ -231,7 +262,8 @@ The currently active transactions on a network storage volume. [allowedHardware]: #allowedhardware #### [allowedHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -241,7 +273,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume. [allowedIpAddresses]: #allowedipaddresses #### [allowedIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -251,7 +284,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationHardware]: #allowedreplicationhardware #### [allowedReplicationHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -261,7 +295,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedReplicationIpAddresses]: #allowedreplicationipaddresses #### [allowedReplicationIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -271,7 +306,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationSubnets]: #allowedreplicationsubnets #### [allowedReplicationSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -281,7 +317,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedReplicationVirtualGuests]: #allowedreplicationvirtualguests #### [allowedReplicationVirtualGuests] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -291,7 +328,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedSubnets]: #allowedsubnets #### [allowedSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -301,7 +339,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedVirtualGuests]: #allowedvirtualguests #### [allowedVirtualGuests] The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -311,7 +350,8 @@ The SoftLayer_Virtual_Guest objects which are allowed access to this storage vol [bandwidthBillingItems]: #bandwidthbillingitems #### [bandwidthBillingItems] The billing items tied to a Storage service's bandwidth usage. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -321,7 +361,8 @@ The billing items tied to a Storage service's bandwidth usage. [billingItem]: #billingitem #### [billingItem] The current billing item for a Storage volume. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -331,7 +372,8 @@ The current billing item for a Storage volume. [billingItemCategory]: #billingitemcategory #### [billingItemCategory] -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -341,7 +383,8 @@ The current billing item for a Storage volume. [bytesUsed]: #bytesused #### [bytesUsed] The amount of space used by the volume, in bytes. -Type: **string** +Type: **string** + @@ -351,7 +394,8 @@ The amount of space used by the volume, in bytes. [creationScheduleId]: #creationscheduleid #### [creationScheduleId] The schedule id which was executed to create a snapshot. -Type: **string** +Type: **string** + @@ -361,7 +405,8 @@ The schedule id which was executed to create a snapshot. [credentials]: #credentials #### [credentials] -Type: **SoftLayer_Network_Storage_Credential[] ** +Type: **SoftLayer_Network_Storage_Credential[] ** + @@ -371,7 +416,8 @@ The schedule id which was executed to create a snapshot. [dailySchedule]: #dailyschedule #### [dailySchedule] The Daily Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -381,7 +427,8 @@ The Daily Schedule which is associated with this network storage volume. [dependentDuplicate]: #dependentduplicate #### [dependentDuplicate] Whether or not a network storage volume is a dependent duplicate. -Type: **string** +Type: **string** + @@ -391,7 +438,8 @@ Whether or not a network storage volume is a dependent duplicate. [dependentDuplicates]: #dependentduplicates #### [dependentDuplicates] The network storage volumes configured to be dependent duplicates of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -401,7 +449,8 @@ The network storage volumes configured to be dependent duplicates of a volume. [events]: #events #### [events] The events which have taken place on a network storage volume. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -411,7 +460,19 @@ The events which have taken place on a network storage volume. [failbackNotAllowed]: #failbacknotallowed #### [failbackNotAllowed] Determines whether the volume is allowed to failback -Type: **string** +Type: **string** + + + + +
      + +----- +[failoverNotAllowed]: #failovernotallowed +#### [failoverNotAllowed] +Determines whether the volume is allowed to failover +Type: **string** +
      @@ -421,7 +482,8 @@ Determines whether the volume is allowed to failback [fileNetworkMountAddress]: #filenetworkmountaddress #### [fileNetworkMountAddress] Retrieves the NFS Network Mount Address Name for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -431,7 +493,8 @@ Retrieves the NFS Network Mount Address Name for a given File Storage Volume. [hardware]: #hardware #### [hardware] When applicable, the hardware associated with a Storage service. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -441,7 +504,8 @@ When applicable, the hardware associated with a Storage service. [hasEncryptionAtRest]: #hasencryptionatrest #### [hasEncryptionAtRest] -Type: **boolean** +Type: **boolean** + @@ -451,7 +515,8 @@ When applicable, the hardware associated with a Storage service. [hourlySchedule]: #hourlyschedule #### [hourlySchedule] The Hourly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -461,7 +526,8 @@ The Hourly Schedule which is associated with this network storage volume. [intervalSchedule]: #intervalschedule #### [intervalSchedule] The Interval Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -471,7 +537,8 @@ The Interval Schedule which is associated with this network storage volume. [iops]: #iops #### [iops] The maximum number of IOPs selected for this volume. -Type: **string** +Type: **string** + @@ -481,7 +548,8 @@ The maximum number of IOPs selected for this volume. [isDependentDuplicateProvisionCompleted]: #isdependentduplicateprovisioncompleted #### [isDependentDuplicateProvisionCompleted] Determines whether dependent volume provision is completed on background. -Type: **boolean** +Type: **boolean** + @@ -491,7 +559,8 @@ Determines whether dependent volume provision is completed on background. [isInDedicatedServiceResource]: #isindedicatedserviceresource #### [isInDedicatedServiceResource] -Type: **boolean** +Type: **boolean** + @@ -501,7 +570,8 @@ Determines whether dependent volume provision is completed on background. [isMagneticStorage]: #ismagneticstorage #### [isMagneticStorage] -Type: **string** +Type: **string** + @@ -511,7 +581,8 @@ Determines whether dependent volume provision is completed on background. [isReadyForSnapshot]: #isreadyforsnapshot #### [isReadyForSnapshot] Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. -Type: **boolean** +Type: **boolean** + @@ -521,7 +592,8 @@ Determines whether a volume is ready to order snapshot space, or, if snapshot sp [isReadyToMount]: #isreadytomount #### [isReadyToMount] Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. -Type: **boolean** +Type: **boolean** + @@ -531,7 +603,8 @@ Determines whether a volume is ready to have Hosts authorized to access it. This [iscsiLuns]: #iscsiluns #### [iscsiLuns] Relationship between a container volume and iSCSI LUNs. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -541,7 +614,8 @@ Relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddresses]: #iscsitargetipaddresses #### [iscsiTargetIpAddresses] Returns the target IP addresses of an iSCSI volume. -Type: **array of strings** +Type: **array of strings** + @@ -551,7 +625,8 @@ Returns the target IP addresses of an iSCSI volume. [lunId]: #lunid #### [lunId] The ID of the LUN volume. -Type: **string** +Type: **string** + @@ -561,7 +636,8 @@ The ID of the LUN volume. [manualSnapshots]: #manualsnapshots #### [manualSnapshots] The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -571,7 +647,8 @@ The manually-created snapshots associated with this SoftLayer_Network_Storage vo [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A network storage volume's metric tracking object. This object records all periodic polled data available to this volume. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -581,7 +658,8 @@ A network storage volume's metric tracking object. This object records all perio [mountPath]: #mountpath #### [mountPath] Retrieves the NFS Network Mount Path for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -591,7 +669,8 @@ Retrieves the NFS Network Mount Path for a given File Storage Volume. [mountableFlag]: #mountableflag #### [mountableFlag] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -601,7 +680,8 @@ Whether or not a network storage volume may be mounted. [moveAndSplitStatus]: #moveandsplitstatus #### [moveAndSplitStatus] The current status of split or move operation as a part of volume duplication. -Type: **string** +Type: **string** + @@ -611,7 +691,8 @@ The current status of split or move operation as a part of volume duplication. [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] The subscribers that will be notified for usage amount warnings and overages. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -621,7 +702,8 @@ The subscribers that will be notified for usage amount warnings and overages. [originalSnapshotName]: #originalsnapshotname #### [originalSnapshotName] The name of the snapshot that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -631,7 +713,8 @@ The name of the snapshot that this volume was duplicated from. [originalVolumeName]: #originalvolumename #### [originalVolumeName] The name of the volume that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -641,7 +724,8 @@ The name of the volume that this volume was duplicated from. [originalVolumeSize]: #originalvolumesize #### [originalVolumeSize] The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. -Type: **string** +Type: **string** + @@ -651,7 +735,8 @@ The size (in GB) of the volume or LUN before any size expansion, or of the volum [osType]: #ostype #### [osType] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -661,7 +746,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. [osTypeId]: #ostypeid #### [osTypeId] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. -Type: **string** +Type: **string** + @@ -671,7 +757,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. [parentPartnerships]: #parentpartnerships #### [parentPartnerships] The volumes or snapshots partnered with a network storage volume in a parental role. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -681,7 +768,8 @@ The volumes or snapshots partnered with a network storage volume in a parental r [parentVolume]: #parentvolume #### [parentVolume] The parent volume of a volume in a complex storage relationship. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -691,7 +779,8 @@ The parent volume of a volume in a complex storage relationship. [partnerships]: #partnerships #### [partnerships] The volumes or snapshots partnered with a network storage volume. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -701,7 +790,8 @@ The volumes or snapshots partnered with a network storage volume. [permissionsGroups]: #permissionsgroups #### [permissionsGroups] All permissions group(s) this volume is in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -711,7 +801,8 @@ All permissions group(s) this volume is in. [properties]: #properties #### [properties] The properties used to provide additional details about a network storage volume. -Type: **SoftLayer_Network_Storage_Property[] ** +Type: **SoftLayer_Network_Storage_Property[] ** + @@ -721,7 +812,8 @@ The properties used to provide additional details about a network storage volume [provisionedIops]: #provisionediops #### [provisionedIops] The number of IOPs provisioned for this volume. -Type: **string** +Type: **string** + @@ -731,7 +823,8 @@ The number of IOPs provisioned for this volume. [replicatingLuns]: #replicatingluns #### [replicatingLuns] The iSCSI LUN volumes being replicated by this network storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -741,7 +834,8 @@ The iSCSI LUN volumes being replicated by this network storage volume. [replicatingVolume]: #replicatingvolume #### [replicatingVolume] The network storage volume being replicated by a volume. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -751,7 +845,8 @@ The network storage volume being replicated by a volume. [replicationEvents]: #replicationevents #### [replicationEvents] The volume replication events. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -761,7 +856,8 @@ The volume replication events. [replicationPartners]: #replicationpartners #### [replicationPartners] The network storage volumes configured to be replicants of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -771,7 +867,8 @@ The network storage volumes configured to be replicants of a volume. [replicationSchedule]: #replicationschedule #### [replicationSchedule] The Replication Schedule associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -781,7 +878,8 @@ The Replication Schedule associated with a network storage volume. [replicationStatus]: #replicationstatus #### [replicationStatus] The current replication status of a network storage volume. Indicates Failover or Failback status. -Type: **string** +Type: **string** + @@ -791,7 +889,8 @@ The current replication status of a network storage volume. Indicates Failover o [schedules]: #schedules #### [schedules] The schedules which are associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule[] ** +Type: **SoftLayer_Network_Storage_Schedule[] ** + @@ -801,7 +900,8 @@ The schedules which are associated with a network storage volume. [serviceResource]: #serviceresource #### [serviceResource] The network resource a Storage service is connected to. -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -811,7 +911,8 @@ The network resource a Storage service is connected to. [serviceResourceBackendIpAddress]: #serviceresourcebackendipaddress #### [serviceResourceBackendIpAddress] The IP address of a Storage resource. -Type: **string** +Type: **string** + @@ -821,7 +922,8 @@ The IP address of a Storage resource. [serviceResourceName]: #serviceresourcename #### [serviceResourceName] The name of a Storage's network resource. -Type: **string** +Type: **string** + @@ -831,7 +933,8 @@ The name of a Storage's network resource. [snapshotCapacityGb]: #snapshotcapacitygb #### [snapshotCapacityGb] A volume's configured snapshot space size. -Type: **string** +Type: **string** + @@ -841,7 +944,8 @@ A volume's configured snapshot space size. [snapshotCreationTimestamp]: #snapshotcreationtimestamp #### [snapshotCreationTimestamp] The creation timestamp of the snapshot on the storage platform. -Type: **string** +Type: **string** + @@ -851,7 +955,8 @@ The creation timestamp of the snapshot on the storage platform. [snapshotDeletionThresholdPercentage]: #snapshotdeletionthresholdpercentage #### [snapshotDeletionThresholdPercentage] The percentage of used snapshot space after which to delete automated snapshots. -Type: **string** +Type: **string** + @@ -861,7 +966,8 @@ The percentage of used snapshot space after which to delete automated snapshots. [snapshotNotificationStatus]: #snapshotnotificationstatus #### [snapshotNotificationStatus] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -871,7 +977,8 @@ Whether or not a network storage volume may be mounted. [snapshotSizeBytes]: #snapshotsizebytes #### [snapshotSizeBytes] The snapshot size in bytes. -Type: **string** +Type: **string** + @@ -881,7 +988,8 @@ The snapshot size in bytes. [snapshotSpaceAvailable]: #snapshotspaceavailable #### [snapshotSpaceAvailable] A volume's available snapshot reservation space. -Type: **string** +Type: **string** + @@ -891,7 +999,8 @@ A volume's available snapshot reservation space. [snapshots]: #snapshots #### [snapshots] The snapshots associated with this SoftLayer_Network_Storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -901,7 +1010,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [staasVersion]: #staasversion #### [staasVersion] -Type: **string** +Type: **string** + @@ -911,7 +1021,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [storageGroups]: #storagegroups #### [storageGroups] The network storage groups this volume is attached to. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -921,7 +1032,8 @@ The network storage groups this volume is attached to. [storageNodes]: #storagenodes #### [storageNodes] -Type: **SoftLayer_Network_Service_Resource[] ** +Type: **SoftLayer_Network_Service_Resource[] ** + @@ -931,7 +1043,8 @@ The network storage groups this volume is attached to. [storageTierLevel]: #storagetierlevel #### [storageTierLevel] -Type: **string** +Type: **string** + @@ -941,7 +1054,8 @@ The network storage groups this volume is attached to. [storageType]: #storagetype #### [storageType] A description of the Storage object. -Type: **SoftLayer_Network_Storage_Type ** +Type: **SoftLayer_Network_Storage_Type ** + @@ -951,7 +1065,8 @@ A description of the Storage object. [totalBytesUsed]: #totalbytesused #### [totalBytesUsed] The amount of space used by the volume. -Type: **string** +Type: **string** + @@ -961,7 +1076,8 @@ The amount of space used by the volume. [totalScheduleSnapshotRetentionCount]: #totalschedulesnapshotretentioncount #### [totalScheduleSnapshotRetentionCount] The total snapshot retention count of all schedules on this network storage volume. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -971,7 +1087,8 @@ The total snapshot retention count of all schedules on this network storage volu [usageNotification]: #usagenotification #### [usageNotification] The usage notification for SL Storage services. -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -981,7 +1098,8 @@ The usage notification for SL Storage services. [vendorName]: #vendorname #### [vendorName] The type of network storage service. -Type: **string** +Type: **string** + @@ -991,7 +1109,8 @@ The type of network storage service. [virtualGuest]: #virtualguest #### [virtualGuest] When applicable, the virtual guest associated with a Storage service. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -1001,7 +1120,8 @@ When applicable, the virtual guest associated with a Storage service. [volumeHistory]: #volumehistory #### [volumeHistory] The username and password history for a Storage service. -Type: **SoftLayer_Network_Storage_History[] ** +Type: **SoftLayer_Network_Storage_History[] ** + @@ -1011,7 +1131,8 @@ The username and password history for a Storage service. [volumeStatus]: #volumestatus #### [volumeStatus] The current status of a network storage volume. -Type: **string** +Type: **string** + @@ -1021,7 +1142,8 @@ The current status of a network storage volume. [webccAccount]: #webccaccount #### [webccAccount] The account username and password for the EVault webCC interface. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -1031,7 +1153,8 @@ The account username and password for the EVault webCC interface. [weeklySchedule]: #weeklyschedule #### [weeklySchedule] The Weekly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -1043,7 +1166,8 @@ The Weekly Schedule which is associated with this network storage volume. [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of the currently active transactions on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1177,8 @@ A count of the currently active transactions on a network storage volume. [allowedHardwareCount]: #allowedhardwarecount #### [allowedHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1188,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedIpAddressCount]: #allowedipaddresscount #### [allowedIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1199,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationHardwareCount]: #allowedreplicationhardwarecount #### [allowedReplicationHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1210,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedReplicationIpAddressCount]: #allowedreplicationipaddresscount #### [allowedReplicationIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1093,7 +1221,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationSubnetCount]: #allowedreplicationsubnetcount #### [allowedReplicationSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1103,7 +1232,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedReplicationVirtualGuestCount]: #allowedreplicationvirtualguestcount #### [allowedReplicationVirtualGuestCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1113,7 +1243,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedSubnetCount]: #allowedsubnetcount #### [allowedSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1123,7 +1254,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedVirtualGuestCount]: #allowedvirtualguestcount #### [allowedVirtualGuestCount] A count of the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1133,7 +1265,8 @@ A count of the SoftLayer_Virtual_Guest objects which are allowed access to this [bandwidthBillingItemCount]: #bandwidthbillingitemcount #### [bandwidthBillingItemCount] A count of the billing items tied to a Storage service's bandwidth usage. -Type: **unsigned long** +Type: **unsigned long** + @@ -1143,7 +1276,8 @@ A count of the billing items tied to a Storage service's bandwidth usage. [credentialCount]: #credentialcount #### [credentialCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1153,7 +1287,8 @@ A count of [dependentDuplicateCount]: #dependentduplicatecount #### [dependentDuplicateCount] A count of the network storage volumes configured to be dependent duplicates of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1163,7 +1298,8 @@ A count of the network storage volumes configured to be dependent duplicates of [eventCount]: #eventcount #### [eventCount] A count of the events which have taken place on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1173,7 +1309,8 @@ A count of the events which have taken place on a network storage volume. [iscsiLunCount]: #iscsiluncount #### [iscsiLunCount] A count of relationship between a container volume and iSCSI LUNs. -Type: **unsigned long** +Type: **unsigned long** + @@ -1183,7 +1320,8 @@ A count of relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddressCount]: #iscsitargetipaddresscount #### [iscsiTargetIpAddressCount] A count of returns the target IP addresses of an iSCSI volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1193,7 +1331,8 @@ A count of returns the target IP addresses of an iSCSI volume. [manualSnapshotCount]: #manualsnapshotcount #### [manualSnapshotCount] A count of the manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **unsigned long** +Type: **unsigned long** + @@ -1203,7 +1342,8 @@ A count of the manually-created snapshots associated with this SoftLayer_Network [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of the subscribers that will be notified for usage amount warnings and overages. -Type: **unsigned long** +Type: **unsigned long** + @@ -1213,7 +1353,8 @@ A count of the subscribers that will be notified for usage amount warnings and o [parentPartnershipCount]: #parentpartnershipcount #### [parentPartnershipCount] A count of the volumes or snapshots partnered with a network storage volume in a parental role. -Type: **unsigned long** +Type: **unsigned long** + @@ -1223,7 +1364,8 @@ A count of the volumes or snapshots partnered with a network storage volume in a [partnershipCount]: #partnershipcount #### [partnershipCount] A count of the volumes or snapshots partnered with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1233,7 +1375,8 @@ A count of the volumes or snapshots partnered with a network storage volume. [permissionsGroupCount]: #permissionsgroupcount #### [permissionsGroupCount] A count of all permissions group(s) this volume is in. -Type: **unsigned long** +Type: **unsigned long** + @@ -1243,7 +1386,8 @@ A count of all permissions group(s) this volume is in. [propertyCount]: #propertycount #### [propertyCount] A count of the properties used to provide additional details about a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1253,7 +1397,8 @@ A count of the properties used to provide additional details about a network sto [replicatingLunCount]: #replicatingluncount #### [replicatingLunCount] A count of the iSCSI LUN volumes being replicated by this network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1263,7 +1408,8 @@ A count of the iSCSI LUN volumes being replicated by this network storage volume [replicationEventCount]: #replicationeventcount #### [replicationEventCount] A count of the volume replication events. -Type: **unsigned long** +Type: **unsigned long** + @@ -1273,7 +1419,8 @@ A count of the volume replication events. [replicationPartnerCount]: #replicationpartnercount #### [replicationPartnerCount] A count of the network storage volumes configured to be replicants of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1283,7 +1430,8 @@ A count of the network storage volumes configured to be replicants of a volume. [scheduleCount]: #schedulecount #### [scheduleCount] A count of the schedules which are associated with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1293,7 +1441,8 @@ A count of the schedules which are associated with a network storage volume. [snapshotCount]: #snapshotcount #### [snapshotCount] A count of the snapshots associated with this SoftLayer_Network_Storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1303,7 +1452,8 @@ A count of the snapshots associated with this SoftLayer_Network_Storage volume. [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of the network storage groups this volume is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1313,7 +1463,8 @@ A count of the network storage groups this volume is attached to. [storageNodeCount]: #storagenodecount #### [storageNodeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1323,7 +1474,8 @@ A count of [volumeHistoryCount]: #volumehistorycount #### [volumeHistoryCount] A count of the username and password history for a Storage service. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi/_index.md index 81ee6c6080..51871086b0 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The iscsi data type provides access to additional information about an iscsi volume such as the snapshot capacity limit and replication partners. @@ -45,7 +47,8 @@ The iscsi data type provides access to additional information about an iscsi vol [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account that a Storage account belongs to. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of the SoftLayer customer account that a Storage account [capacityGb]: #capacitygb #### [capacityGb] A Storage account's capacity, measured in gigabytes. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A Storage account's capacity, measured in gigabytes. [createDate]: #createdate #### [createDate] The date a network storage volume was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date a network storage volume was created. [guestId]: #guestid #### [guestId] The unique identification number of the guest associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The unique identification number of the guest associated with a Storage volume. [hardwareId]: #hardwareid #### [hardwareId] The server that is associated with a Storage service. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The server that is associated with a Storage service. [hostId]: #hostid #### [hostId] The unique identification number of the host associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The unique identification number of the host associated with a Storage volume. [id]: #id #### [id] A Storage account's unique identifier. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A Storage account's unique identifier. [nasType]: #nastype #### [nasType] A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT", and "HUB". -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT" [notes]: #notes #### [notes] Public notes related to a Storage volume. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Public notes related to a Storage volume. [password]: #password #### [password] The password used to access a non-EVault Storage volume. This password is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The password used to access a non-EVault Storage volume. This password is used t [serviceProviderId]: #serviceproviderid #### [serviceProviderId] Service Provider ID -Type: **integer** +Type: **integer** + @@ -155,7 +168,8 @@ Service Provider ID [storageTypeId]: #storagetypeid #### [storageTypeId] A storage object's type. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ A storage object's type. [upgradableFlag]: #upgradableflag #### [upgradableFlag] This flag indicates whether this storage type is upgradable or not. -Type: **boolean** +Type: **boolean** + @@ -175,7 +190,8 @@ This flag indicates whether this storage type is upgradable or not. [username]: #username #### [username] The username used to access a non-EVault Storage volume. This username is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ The username used to access a non-EVault Storage volume. This username is used t [account]: #account #### [account] The account that a Storage services belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -201,7 +218,8 @@ The account that a Storage services belongs to. [accountPassword]: #accountpassword #### [accountPassword] Other usernames and passwords associated with a Storage volume. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -211,7 +229,19 @@ Other usernames and passwords associated with a Storage volume. [activeTransactions]: #activetransactions #### [activeTransactions] The currently active transactions on a network storage volume. -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + + + + +
      + +----- +[allowDisasterRecoveryFailback]: #allowdisasterrecoveryfailback +#### [allowDisasterRecoveryFailback] + +Type: **string** +
      @@ -221,7 +251,8 @@ The currently active transactions on a network storage volume. [allowDisasterRecoveryFailover]: #allowdisasterrecoveryfailover #### [allowDisasterRecoveryFailover] -Type: **string** +Type: **string** + @@ -231,7 +262,8 @@ The currently active transactions on a network storage volume. [allowedHardware]: #allowedhardware #### [allowedHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -241,7 +273,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume. [allowedIpAddresses]: #allowedipaddresses #### [allowedIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -251,7 +284,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationHardware]: #allowedreplicationhardware #### [allowedReplicationHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -261,7 +295,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedReplicationIpAddresses]: #allowedreplicationipaddresses #### [allowedReplicationIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -271,7 +306,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationSubnets]: #allowedreplicationsubnets #### [allowedReplicationSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -281,7 +317,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedReplicationVirtualGuests]: #allowedreplicationvirtualguests #### [allowedReplicationVirtualGuests] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -291,7 +328,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedSubnets]: #allowedsubnets #### [allowedSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -301,7 +339,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedVirtualGuests]: #allowedvirtualguests #### [allowedVirtualGuests] The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -311,7 +350,8 @@ The SoftLayer_Virtual_Guest objects which are allowed access to this storage vol [billingItem]: #billingitem #### [billingItem] The current billing item for a Storage volume. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -321,7 +361,8 @@ The current billing item for a Storage volume. [billingItemCategory]: #billingitemcategory #### [billingItemCategory] -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -331,7 +372,8 @@ The current billing item for a Storage volume. [bytesUsed]: #bytesused #### [bytesUsed] The amount of space used by the volume, in bytes. -Type: **string** +Type: **string** + @@ -341,7 +383,8 @@ The amount of space used by the volume, in bytes. [creationScheduleId]: #creationscheduleid #### [creationScheduleId] The schedule id which was executed to create a snapshot. -Type: **string** +Type: **string** + @@ -351,7 +394,8 @@ The schedule id which was executed to create a snapshot. [credentials]: #credentials #### [credentials] -Type: **SoftLayer_Network_Storage_Credential[] ** +Type: **SoftLayer_Network_Storage_Credential[] ** + @@ -361,7 +405,8 @@ The schedule id which was executed to create a snapshot. [dailySchedule]: #dailyschedule #### [dailySchedule] The Daily Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -371,7 +416,8 @@ The Daily Schedule which is associated with this network storage volume. [dependentDuplicate]: #dependentduplicate #### [dependentDuplicate] Whether or not a network storage volume is a dependent duplicate. -Type: **string** +Type: **string** + @@ -381,7 +427,8 @@ Whether or not a network storage volume is a dependent duplicate. [dependentDuplicates]: #dependentduplicates #### [dependentDuplicates] The network storage volumes configured to be dependent duplicates of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -391,7 +438,8 @@ The network storage volumes configured to be dependent duplicates of a volume. [events]: #events #### [events] The events which have taken place on a network storage volume. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -401,7 +449,19 @@ The events which have taken place on a network storage volume. [failbackNotAllowed]: #failbacknotallowed #### [failbackNotAllowed] Determines whether the volume is allowed to failback -Type: **string** +Type: **string** + + + + +
      + +----- +[failoverNotAllowed]: #failovernotallowed +#### [failoverNotAllowed] +Determines whether the volume is allowed to failover +Type: **string** +
      @@ -411,7 +471,8 @@ Determines whether the volume is allowed to failback [fileNetworkMountAddress]: #filenetworkmountaddress #### [fileNetworkMountAddress] Retrieves the NFS Network Mount Address Name for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -421,7 +482,8 @@ Retrieves the NFS Network Mount Address Name for a given File Storage Volume. [hardware]: #hardware #### [hardware] When applicable, the hardware associated with a Storage service. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -431,7 +493,8 @@ When applicable, the hardware associated with a Storage service. [hasEncryptionAtRest]: #hasencryptionatrest #### [hasEncryptionAtRest] -Type: **boolean** +Type: **boolean** + @@ -441,7 +504,8 @@ When applicable, the hardware associated with a Storage service. [hourlySchedule]: #hourlyschedule #### [hourlySchedule] The Hourly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -451,7 +515,8 @@ The Hourly Schedule which is associated with this network storage volume. [intervalSchedule]: #intervalschedule #### [intervalSchedule] The Interval Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -461,7 +526,8 @@ The Interval Schedule which is associated with this network storage volume. [iops]: #iops #### [iops] The maximum number of IOPs guaranteed for this LUN. -Type: **string** +Type: **string** + @@ -471,7 +537,8 @@ The maximum number of IOPs guaranteed for this LUN. [isDependentDuplicateProvisionCompleted]: #isdependentduplicateprovisioncompleted #### [isDependentDuplicateProvisionCompleted] Determines whether dependent volume provision is completed on background. -Type: **boolean** +Type: **boolean** + @@ -481,7 +548,8 @@ Determines whether dependent volume provision is completed on background. [isInDedicatedServiceResource]: #isindedicatedserviceresource #### [isInDedicatedServiceResource] -Type: **boolean** +Type: **boolean** + @@ -491,7 +559,8 @@ Determines whether dependent volume provision is completed on background. [isMagneticStorage]: #ismagneticstorage #### [isMagneticStorage] -Type: **string** +Type: **string** + @@ -501,7 +570,8 @@ Determines whether dependent volume provision is completed on background. [isReadyForSnapshot]: #isreadyforsnapshot #### [isReadyForSnapshot] Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. -Type: **boolean** +Type: **boolean** + @@ -511,7 +581,8 @@ Determines whether a volume is ready to order snapshot space, or, if snapshot sp [isReadyToMount]: #isreadytomount #### [isReadyToMount] Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. -Type: **boolean** +Type: **boolean** + @@ -521,7 +592,8 @@ Determines whether a volume is ready to have Hosts authorized to access it. This [iscsiLuns]: #iscsiluns #### [iscsiLuns] Relationship between a container volume and iSCSI LUNs. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -531,7 +603,8 @@ Relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddresses]: #iscsitargetipaddresses #### [iscsiTargetIpAddresses] Returns the target IP addresses of an iSCSI volume. -Type: **array of strings** +Type: **array of strings** + @@ -541,7 +614,8 @@ Returns the target IP addresses of an iSCSI volume. [lunId]: #lunid #### [lunId] The ID of the LUN volume. -Type: **string** +Type: **string** + @@ -551,7 +625,8 @@ The ID of the LUN volume. [manualSnapshots]: #manualsnapshots #### [manualSnapshots] The snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -561,7 +636,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. Does not su [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A network storage volume's metric tracking object. This object records all periodic polled data available to this volume. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -571,7 +647,8 @@ A network storage volume's metric tracking object. This object records all perio [mountPath]: #mountpath #### [mountPath] Retrieves the NFS Network Mount Path for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -581,7 +658,8 @@ Retrieves the NFS Network Mount Path for a given File Storage Volume. [mountableFlag]: #mountableflag #### [mountableFlag] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -591,7 +669,8 @@ Whether or not a network storage volume may be mounted. [moveAndSplitStatus]: #moveandsplitstatus #### [moveAndSplitStatus] The current status of split or move operation as a part of volume duplication. -Type: **string** +Type: **string** + @@ -601,7 +680,8 @@ The current status of split or move operation as a part of volume duplication. [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] The subscribers that will be notified for usage amount warnings and overages. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -611,7 +691,8 @@ The subscribers that will be notified for usage amount warnings and overages. [originalSnapshotName]: #originalsnapshotname #### [originalSnapshotName] The name of the snapshot that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -621,7 +702,8 @@ The name of the snapshot that this volume was duplicated from. [originalVolumeName]: #originalvolumename #### [originalVolumeName] The name of the volume that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -631,7 +713,8 @@ The name of the volume that this volume was duplicated from. [originalVolumeSize]: #originalvolumesize #### [originalVolumeSize] The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. -Type: **string** +Type: **string** + @@ -641,7 +724,8 @@ The size (in GB) of the volume or LUN before any size expansion, or of the volum [osType]: #ostype #### [osType] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -651,7 +735,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. [osTypeId]: #ostypeid #### [osTypeId] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. -Type: **string** +Type: **string** + @@ -661,7 +746,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. [parentPartnerships]: #parentpartnerships #### [parentPartnerships] The volumes or snapshots partnered with a network storage volume in a parental role. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -671,7 +757,8 @@ The volumes or snapshots partnered with a network storage volume in a parental r [parentVolume]: #parentvolume #### [parentVolume] The volume on which this iSCSI LUN is provisioned. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -681,7 +768,8 @@ The volume on which this iSCSI LUN is provisioned. [partnerships]: #partnerships #### [partnerships] The volumes or snapshots partnered with a network storage volume. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -691,7 +779,8 @@ The volumes or snapshots partnered with a network storage volume. [permissionsGroups]: #permissionsgroups #### [permissionsGroups] All permissions group(s) this volume is in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -701,7 +790,8 @@ All permissions group(s) this volume is in. [properties]: #properties #### [properties] The properties used to provide additional details about a network storage volume. -Type: **SoftLayer_Network_Storage_Property[] ** +Type: **SoftLayer_Network_Storage_Property[] ** + @@ -711,7 +801,8 @@ The properties used to provide additional details about a network storage volume [provisionedIops]: #provisionediops #### [provisionedIops] The number of IOPs provisioned for this volume. -Type: **string** +Type: **string** + @@ -721,7 +812,8 @@ The number of IOPs provisioned for this volume. [replicatingLuns]: #replicatingluns #### [replicatingLuns] The iSCSI LUN volumes being replicated by this network storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -731,7 +823,8 @@ The iSCSI LUN volumes being replicated by this network storage volume. [replicatingVolume]: #replicatingvolume #### [replicatingVolume] The network storage volume being replicated by a volume. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -741,7 +834,8 @@ The network storage volume being replicated by a volume. [replicationEvents]: #replicationevents #### [replicationEvents] The volume replication events. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -751,7 +845,8 @@ The volume replication events. [replicationPartners]: #replicationpartners #### [replicationPartners] The network storage volumes configured to be replicants of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -761,7 +856,8 @@ The network storage volumes configured to be replicants of a volume. [replicationSchedule]: #replicationschedule #### [replicationSchedule] The Replication Schedule associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -771,7 +867,8 @@ The Replication Schedule associated with a network storage volume. [replicationStatus]: #replicationstatus #### [replicationStatus] The current replication status of a network storage volume. Indicates Failover or Failback status. -Type: **string** +Type: **string** + @@ -781,7 +878,8 @@ The current replication status of a network storage volume. Indicates Failover o [schedules]: #schedules #### [schedules] The schedules which are associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule[] ** +Type: **SoftLayer_Network_Storage_Schedule[] ** + @@ -791,7 +889,8 @@ The schedules which are associated with a network storage volume. [serviceResource]: #serviceresource #### [serviceResource] The network resource a Storage service is connected to. -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -801,7 +900,8 @@ The network resource a Storage service is connected to. [serviceResourceBackendIpAddress]: #serviceresourcebackendipaddress #### [serviceResourceBackendIpAddress] The IP address of a Storage resource. -Type: **string** +Type: **string** + @@ -811,7 +911,8 @@ The IP address of a Storage resource. [serviceResourceName]: #serviceresourcename #### [serviceResourceName] The name of a Storage's network resource. -Type: **string** +Type: **string** + @@ -821,7 +922,8 @@ The name of a Storage's network resource. [snapshotCapacityGb]: #snapshotcapacitygb #### [snapshotCapacityGb] A volume's configured snapshot space size. -Type: **string** +Type: **string** + @@ -831,7 +933,8 @@ A volume's configured snapshot space size. [snapshotCreationTimestamp]: #snapshotcreationtimestamp #### [snapshotCreationTimestamp] The creation timestamp of the snapshot on the storage platform. -Type: **string** +Type: **string** + @@ -841,7 +944,8 @@ The creation timestamp of the snapshot on the storage platform. [snapshotDeletionThresholdPercentage]: #snapshotdeletionthresholdpercentage #### [snapshotDeletionThresholdPercentage] The percentage of used snapshot space after which to delete automated snapshots. -Type: **string** +Type: **string** + @@ -851,7 +955,8 @@ The percentage of used snapshot space after which to delete automated snapshots. [snapshotNotificationStatus]: #snapshotnotificationstatus #### [snapshotNotificationStatus] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -861,7 +966,8 @@ Whether or not a network storage volume may be mounted. [snapshotSizeBytes]: #snapshotsizebytes #### [snapshotSizeBytes] The snapshot size in bytes. -Type: **string** +Type: **string** + @@ -871,7 +977,8 @@ The snapshot size in bytes. [snapshotSpaceAvailable]: #snapshotspaceavailable #### [snapshotSpaceAvailable] An volume's available snapshot reservation space. -Type: **string** +Type: **string** + @@ -881,7 +988,8 @@ An volume's available snapshot reservation space. [snapshots]: #snapshots #### [snapshots] The snapshots associated with this iSCSI LUN's container volume, if applicable -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -891,7 +999,8 @@ The snapshots associated with this iSCSI LUN's container volume, if applicable [staasVersion]: #staasversion #### [staasVersion] -Type: **string** +Type: **string** + @@ -901,7 +1010,8 @@ The snapshots associated with this iSCSI LUN's container volume, if applicable [storageGroups]: #storagegroups #### [storageGroups] The network storage groups this volume is attached to. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -911,7 +1021,8 @@ The network storage groups this volume is attached to. [storageTierLevel]: #storagetierlevel #### [storageTierLevel] -Type: **string** +Type: **string** + @@ -921,7 +1032,8 @@ The network storage groups this volume is attached to. [storageType]: #storagetype #### [storageType] A description of the Storage object. -Type: **SoftLayer_Network_Storage_Type ** +Type: **SoftLayer_Network_Storage_Type ** + @@ -931,7 +1043,8 @@ A description of the Storage object. [totalBytesUsed]: #totalbytesused #### [totalBytesUsed] The amount of space used by the volume. -Type: **string** +Type: **string** + @@ -941,7 +1054,8 @@ The amount of space used by the volume. [totalScheduleSnapshotRetentionCount]: #totalschedulesnapshotretentioncount #### [totalScheduleSnapshotRetentionCount] The total snapshot retention count of all schedules on this network storage volume. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -951,7 +1065,8 @@ The total snapshot retention count of all schedules on this network storage volu [usageNotification]: #usagenotification #### [usageNotification] The usage notification for SL Storage services. -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -961,7 +1076,8 @@ The usage notification for SL Storage services. [vendorName]: #vendorname #### [vendorName] The type of network storage service. -Type: **string** +Type: **string** + @@ -971,7 +1087,8 @@ The type of network storage service. [virtualGuest]: #virtualguest #### [virtualGuest] When applicable, the virtual guest associated with a Storage service. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -981,7 +1098,8 @@ When applicable, the virtual guest associated with a Storage service. [volumeHistory]: #volumehistory #### [volumeHistory] The username and password history for a Storage service. -Type: **SoftLayer_Network_Storage_History[] ** +Type: **SoftLayer_Network_Storage_History[] ** + @@ -991,7 +1109,8 @@ The username and password history for a Storage service. [volumeStatus]: #volumestatus #### [volumeStatus] The current status of a network storage volume. -Type: **string** +Type: **string** + @@ -1001,7 +1120,8 @@ The current status of a network storage volume. [webccAccount]: #webccaccount #### [webccAccount] The account username and password for the EVault webCC interface. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -1011,7 +1131,8 @@ The account username and password for the EVault webCC interface. [weeklySchedule]: #weeklyschedule #### [weeklySchedule] The Weekly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -1023,7 +1144,8 @@ The Weekly Schedule which is associated with this network storage volume. [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of the currently active transactions on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1155,8 @@ A count of the currently active transactions on a network storage volume. [allowedHardwareCount]: #allowedhardwarecount #### [allowedHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1166,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedIpAddressCount]: #allowedipaddresscount #### [allowedIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1177,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationHardwareCount]: #allowedreplicationhardwarecount #### [allowedReplicationHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1188,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedReplicationIpAddressCount]: #allowedreplicationipaddresscount #### [allowedReplicationIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1199,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationSubnetCount]: #allowedreplicationsubnetcount #### [allowedReplicationSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1210,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedReplicationVirtualGuestCount]: #allowedreplicationvirtualguestcount #### [allowedReplicationVirtualGuestCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1093,7 +1221,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedSubnetCount]: #allowedsubnetcount #### [allowedSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1103,7 +1232,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedVirtualGuestCount]: #allowedvirtualguestcount #### [allowedVirtualGuestCount] A count of the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1113,7 +1243,8 @@ A count of the SoftLayer_Virtual_Guest objects which are allowed access to this [credentialCount]: #credentialcount #### [credentialCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1123,7 +1254,8 @@ A count of [dependentDuplicateCount]: #dependentduplicatecount #### [dependentDuplicateCount] A count of the network storage volumes configured to be dependent duplicates of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1133,7 +1265,8 @@ A count of the network storage volumes configured to be dependent duplicates of [eventCount]: #eventcount #### [eventCount] A count of the events which have taken place on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1143,7 +1276,8 @@ A count of the events which have taken place on a network storage volume. [iscsiLunCount]: #iscsiluncount #### [iscsiLunCount] A count of relationship between a container volume and iSCSI LUNs. -Type: **unsigned long** +Type: **unsigned long** + @@ -1153,7 +1287,8 @@ A count of relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddressCount]: #iscsitargetipaddresscount #### [iscsiTargetIpAddressCount] A count of returns the target IP addresses of an iSCSI volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1163,7 +1298,8 @@ A count of returns the target IP addresses of an iSCSI volume. [manualSnapshotCount]: #manualsnapshotcount #### [manualSnapshotCount] A count of the snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **unsigned long** +Type: **unsigned long** + @@ -1173,7 +1309,8 @@ A count of the snapshots associated with this SoftLayer_Network_Storage volume. [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of the subscribers that will be notified for usage amount warnings and overages. -Type: **unsigned long** +Type: **unsigned long** + @@ -1183,7 +1320,8 @@ A count of the subscribers that will be notified for usage amount warnings and o [parentPartnershipCount]: #parentpartnershipcount #### [parentPartnershipCount] A count of the volumes or snapshots partnered with a network storage volume in a parental role. -Type: **unsigned long** +Type: **unsigned long** + @@ -1193,7 +1331,8 @@ A count of the volumes or snapshots partnered with a network storage volume in a [partnershipCount]: #partnershipcount #### [partnershipCount] A count of the volumes or snapshots partnered with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1203,7 +1342,8 @@ A count of the volumes or snapshots partnered with a network storage volume. [permissionsGroupCount]: #permissionsgroupcount #### [permissionsGroupCount] A count of all permissions group(s) this volume is in. -Type: **unsigned long** +Type: **unsigned long** + @@ -1213,7 +1353,8 @@ A count of all permissions group(s) this volume is in. [propertyCount]: #propertycount #### [propertyCount] A count of the properties used to provide additional details about a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1223,7 +1364,8 @@ A count of the properties used to provide additional details about a network sto [replicatingLunCount]: #replicatingluncount #### [replicatingLunCount] A count of the iSCSI LUN volumes being replicated by this network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1233,7 +1375,8 @@ A count of the iSCSI LUN volumes being replicated by this network storage volume [replicationEventCount]: #replicationeventcount #### [replicationEventCount] A count of the volume replication events. -Type: **unsigned long** +Type: **unsigned long** + @@ -1243,7 +1386,8 @@ A count of the volume replication events. [replicationPartnerCount]: #replicationpartnercount #### [replicationPartnerCount] A count of the network storage volumes configured to be replicants of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1253,7 +1397,8 @@ A count of the network storage volumes configured to be replicants of a volume. [scheduleCount]: #schedulecount #### [scheduleCount] A count of the schedules which are associated with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1263,7 +1408,8 @@ A count of the schedules which are associated with a network storage volume. [snapshotCount]: #snapshotcount #### [snapshotCount] A count of the snapshots associated with this iSCSI LUN's container volume, if applicable -Type: **unsigned long** +Type: **unsigned long** + @@ -1273,7 +1419,8 @@ A count of the snapshots associated with this iSCSI LUN's container volume, if a [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of the network storage groups this volume is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1283,7 +1430,8 @@ A count of the network storage groups this volume is attached to. [volumeHistoryCount]: #volumehistorycount #### [volumeHistoryCount] A count of the username and password history for a Storage service. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi_EqualLogic_Version3/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi_EqualLogic_Version3/_index.md index aa84de53c8..512a9aaffa 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi_EqualLogic_Version3/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi_EqualLogic_Version3/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The iscsi EqualLogic Version 3 data type provides access to additional information about an iscsi volume such as the available snapshot reserve space. @@ -45,7 +47,8 @@ The iscsi EqualLogic Version 3 data type provides access to additional informati [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account that a Storage account belongs to. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of the SoftLayer customer account that a Storage account [capacityGb]: #capacitygb #### [capacityGb] A Storage account's capacity, measured in gigabytes. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A Storage account's capacity, measured in gigabytes. [createDate]: #createdate #### [createDate] The date a network storage volume was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date a network storage volume was created. [guestId]: #guestid #### [guestId] The unique identification number of the guest associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The unique identification number of the guest associated with a Storage volume. [hardwareId]: #hardwareid #### [hardwareId] The server that is associated with a Storage service. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The server that is associated with a Storage service. [hostId]: #hostid #### [hostId] The unique identification number of the host associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The unique identification number of the host associated with a Storage volume. [id]: #id #### [id] A Storage account's unique identifier. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A Storage account's unique identifier. [nasType]: #nastype #### [nasType] The StorageLayer account's type (NAS, LOCKBOX, ISCSI, EVAULT). -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The StorageLayer account's type (NAS, LOCKBOX, ISCSI, EVAULT). [notes]: #notes #### [notes] Public notes related to a Storage volume. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Public notes related to a Storage volume. [password]: #password #### [password] The password used to access a non-EVault Storage volume. This password is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The password used to access a non-EVault Storage volume. This password is used t [serviceProviderId]: #serviceproviderid #### [serviceProviderId] Service Provider ID -Type: **integer** +Type: **integer** + @@ -155,7 +168,8 @@ Service Provider ID [storageTypeId]: #storagetypeid #### [storageTypeId] A storage object's type. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ A storage object's type. [upgradableFlag]: #upgradableflag #### [upgradableFlag] This flag indicates whether this storage type is upgradable or not. -Type: **boolean** +Type: **boolean** + @@ -175,7 +190,8 @@ This flag indicates whether this storage type is upgradable or not. [username]: #username #### [username] The username used to access a non-EVault Storage volume. This username is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ The username used to access a non-EVault Storage volume. This username is used t [account]: #account #### [account] The account that a Storage services belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -201,7 +218,8 @@ The account that a Storage services belongs to. [accountPassword]: #accountpassword #### [accountPassword] Other usernames and passwords associated with a Storage volume. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -211,7 +229,19 @@ Other usernames and passwords associated with a Storage volume. [activeTransactions]: #activetransactions #### [activeTransactions] The currently active transactions on a network storage volume. -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + + + + +
      + +----- +[allowDisasterRecoveryFailback]: #allowdisasterrecoveryfailback +#### [allowDisasterRecoveryFailback] + +Type: **string** +
      @@ -221,7 +251,8 @@ The currently active transactions on a network storage volume. [allowDisasterRecoveryFailover]: #allowdisasterrecoveryfailover #### [allowDisasterRecoveryFailover] -Type: **string** +Type: **string** + @@ -231,7 +262,8 @@ The currently active transactions on a network storage volume. [allowedHardware]: #allowedhardware #### [allowedHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -241,7 +273,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume. [allowedIpAddresses]: #allowedipaddresses #### [allowedIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -251,7 +284,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationHardware]: #allowedreplicationhardware #### [allowedReplicationHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -261,7 +295,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedReplicationIpAddresses]: #allowedreplicationipaddresses #### [allowedReplicationIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -271,7 +306,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationSubnets]: #allowedreplicationsubnets #### [allowedReplicationSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -281,7 +317,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedReplicationVirtualGuests]: #allowedreplicationvirtualguests #### [allowedReplicationVirtualGuests] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -291,7 +328,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedSubnets]: #allowedsubnets #### [allowedSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -301,7 +339,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedVirtualGuests]: #allowedvirtualguests #### [allowedVirtualGuests] The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -311,7 +350,8 @@ The SoftLayer_Virtual_Guest objects which are allowed access to this storage vol [billingItem]: #billingitem #### [billingItem] The current billing item for a Storage volume. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -321,7 +361,8 @@ The current billing item for a Storage volume. [billingItemCategory]: #billingitemcategory #### [billingItemCategory] -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -331,7 +372,8 @@ The current billing item for a Storage volume. [bytesUsed]: #bytesused #### [bytesUsed] The amount of space used by the volume, in bytes. -Type: **string** +Type: **string** + @@ -341,7 +383,8 @@ The amount of space used by the volume, in bytes. [creationScheduleId]: #creationscheduleid #### [creationScheduleId] The schedule id which was executed to create a snapshot. -Type: **string** +Type: **string** + @@ -351,7 +394,8 @@ The schedule id which was executed to create a snapshot. [credentials]: #credentials #### [credentials] -Type: **SoftLayer_Network_Storage_Credential[] ** +Type: **SoftLayer_Network_Storage_Credential[] ** + @@ -361,7 +405,8 @@ The schedule id which was executed to create a snapshot. [dailySchedule]: #dailyschedule #### [dailySchedule] The Daily Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -371,7 +416,8 @@ The Daily Schedule which is associated with this network storage volume. [dependentDuplicate]: #dependentduplicate #### [dependentDuplicate] Whether or not a network storage volume is a dependent duplicate. -Type: **string** +Type: **string** + @@ -381,7 +427,8 @@ Whether or not a network storage volume is a dependent duplicate. [dependentDuplicates]: #dependentduplicates #### [dependentDuplicates] The network storage volumes configured to be dependent duplicates of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -391,7 +438,8 @@ The network storage volumes configured to be dependent duplicates of a volume. [events]: #events #### [events] The events which have taken place on a network storage volume. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -401,7 +449,19 @@ The events which have taken place on a network storage volume. [failbackNotAllowed]: #failbacknotallowed #### [failbackNotAllowed] Determines whether the volume is allowed to failback -Type: **string** +Type: **string** + + + + +
      + +----- +[failoverNotAllowed]: #failovernotallowed +#### [failoverNotAllowed] +Determines whether the volume is allowed to failover +Type: **string** +
      @@ -411,7 +471,8 @@ Determines whether the volume is allowed to failback [fileNetworkMountAddress]: #filenetworkmountaddress #### [fileNetworkMountAddress] Retrieves the NFS Network Mount Address Name for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -421,7 +482,8 @@ Retrieves the NFS Network Mount Address Name for a given File Storage Volume. [hardware]: #hardware #### [hardware] When applicable, the hardware associated with a Storage service. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -431,7 +493,8 @@ When applicable, the hardware associated with a Storage service. [hasEncryptionAtRest]: #hasencryptionatrest #### [hasEncryptionAtRest] -Type: **boolean** +Type: **boolean** + @@ -441,7 +504,8 @@ When applicable, the hardware associated with a Storage service. [hourlySchedule]: #hourlyschedule #### [hourlySchedule] The Hourly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -451,7 +515,8 @@ The Hourly Schedule which is associated with this network storage volume. [intervalSchedule]: #intervalschedule #### [intervalSchedule] The Interval Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -461,7 +526,8 @@ The Interval Schedule which is associated with this network storage volume. [iops]: #iops #### [iops] The maximum number of IOPs guaranteed for this LUN. -Type: **string** +Type: **string** + @@ -471,7 +537,8 @@ The maximum number of IOPs guaranteed for this LUN. [isDependentDuplicateProvisionCompleted]: #isdependentduplicateprovisioncompleted #### [isDependentDuplicateProvisionCompleted] Determines whether dependent volume provision is completed on background. -Type: **boolean** +Type: **boolean** + @@ -481,7 +548,8 @@ Determines whether dependent volume provision is completed on background. [isInDedicatedServiceResource]: #isindedicatedserviceresource #### [isInDedicatedServiceResource] -Type: **boolean** +Type: **boolean** + @@ -491,7 +559,8 @@ Determines whether dependent volume provision is completed on background. [isMagneticStorage]: #ismagneticstorage #### [isMagneticStorage] -Type: **string** +Type: **string** + @@ -501,7 +570,8 @@ Determines whether dependent volume provision is completed on background. [isReadyForSnapshot]: #isreadyforsnapshot #### [isReadyForSnapshot] Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. -Type: **boolean** +Type: **boolean** + @@ -511,7 +581,8 @@ Determines whether a volume is ready to order snapshot space, or, if snapshot sp [isReadyToMount]: #isreadytomount #### [isReadyToMount] Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. -Type: **boolean** +Type: **boolean** + @@ -521,7 +592,8 @@ Determines whether a volume is ready to have Hosts authorized to access it. This [iscsiLuns]: #iscsiluns #### [iscsiLuns] Relationship between a container volume and iSCSI LUNs. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -531,7 +603,8 @@ Relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddresses]: #iscsitargetipaddresses #### [iscsiTargetIpAddresses] Returns the target IP addresses of an iSCSI volume. -Type: **array of strings** +Type: **array of strings** + @@ -541,7 +614,8 @@ Returns the target IP addresses of an iSCSI volume. [lunId]: #lunid #### [lunId] The ID of the LUN volume. -Type: **string** +Type: **string** + @@ -551,7 +625,8 @@ The ID of the LUN volume. [manualSnapshots]: #manualsnapshots #### [manualSnapshots] The snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -561,7 +636,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. Does not su [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A network storage volume's metric tracking object. This object records all periodic polled data available to this volume. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -571,7 +647,8 @@ A network storage volume's metric tracking object. This object records all perio [mountPath]: #mountpath #### [mountPath] Retrieves the NFS Network Mount Path for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -581,7 +658,8 @@ Retrieves the NFS Network Mount Path for a given File Storage Volume. [mountableFlag]: #mountableflag #### [mountableFlag] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -591,7 +669,8 @@ Whether or not a network storage volume may be mounted. [moveAndSplitStatus]: #moveandsplitstatus #### [moveAndSplitStatus] The current status of split or move operation as a part of volume duplication. -Type: **string** +Type: **string** + @@ -601,7 +680,8 @@ The current status of split or move operation as a part of volume duplication. [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] The subscribers that will be notified for usage amount warnings and overages. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -611,7 +691,8 @@ The subscribers that will be notified for usage amount warnings and overages. [originalSnapshotName]: #originalsnapshotname #### [originalSnapshotName] The name of the snapshot that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -621,7 +702,8 @@ The name of the snapshot that this volume was duplicated from. [originalVolumeName]: #originalvolumename #### [originalVolumeName] The name of the volume that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -631,7 +713,8 @@ The name of the volume that this volume was duplicated from. [originalVolumeSize]: #originalvolumesize #### [originalVolumeSize] The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. -Type: **string** +Type: **string** + @@ -641,7 +724,8 @@ The size (in GB) of the volume or LUN before any size expansion, or of the volum [osType]: #ostype #### [osType] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -651,7 +735,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. [osTypeId]: #ostypeid #### [osTypeId] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. -Type: **string** +Type: **string** + @@ -661,7 +746,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. [parentPartnerships]: #parentpartnerships #### [parentPartnerships] The volumes or snapshots partnered with a network storage volume in a parental role. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -671,7 +757,8 @@ The volumes or snapshots partnered with a network storage volume in a parental r [parentVolume]: #parentvolume #### [parentVolume] The volume on which this iSCSI LUN is provisioned. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -681,7 +768,8 @@ The volume on which this iSCSI LUN is provisioned. [partnerships]: #partnerships #### [partnerships] The volumes or snapshots partnered with a network storage volume. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -691,7 +779,8 @@ The volumes or snapshots partnered with a network storage volume. [permissionsGroups]: #permissionsgroups #### [permissionsGroups] All permissions group(s) this volume is in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -701,7 +790,8 @@ All permissions group(s) this volume is in. [properties]: #properties #### [properties] The properties used to provide additional details about a network storage volume. -Type: **SoftLayer_Network_Storage_Property[] ** +Type: **SoftLayer_Network_Storage_Property[] ** + @@ -711,7 +801,8 @@ The properties used to provide additional details about a network storage volume [provisionedIops]: #provisionediops #### [provisionedIops] The number of IOPs provisioned for this volume. -Type: **string** +Type: **string** + @@ -721,7 +812,8 @@ The number of IOPs provisioned for this volume. [replicatingLuns]: #replicatingluns #### [replicatingLuns] The iSCSI LUN volumes being replicated by this network storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -731,7 +823,8 @@ The iSCSI LUN volumes being replicated by this network storage volume. [replicatingVolume]: #replicatingvolume #### [replicatingVolume] The network storage volume being replicated by a volume. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -741,7 +834,8 @@ The network storage volume being replicated by a volume. [replicationEvents]: #replicationevents #### [replicationEvents] The volume replication events. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -751,7 +845,8 @@ The volume replication events. [replicationPartners]: #replicationpartners #### [replicationPartners] The network storage volumes configured to be replicants of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -761,7 +856,8 @@ The network storage volumes configured to be replicants of a volume. [replicationSchedule]: #replicationschedule #### [replicationSchedule] The Replication Schedule associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -771,7 +867,8 @@ The Replication Schedule associated with a network storage volume. [replicationStatus]: #replicationstatus #### [replicationStatus] The current replication status of a network storage volume. Indicates Failover or Failback status. -Type: **string** +Type: **string** + @@ -781,7 +878,8 @@ The current replication status of a network storage volume. Indicates Failover o [schedules]: #schedules #### [schedules] The schedules which are associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule[] ** +Type: **SoftLayer_Network_Storage_Schedule[] ** + @@ -791,7 +889,8 @@ The schedules which are associated with a network storage volume. [serviceResource]: #serviceresource #### [serviceResource] The network resource a Storage service is connected to. -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -801,7 +900,8 @@ The network resource a Storage service is connected to. [serviceResourceBackendIpAddress]: #serviceresourcebackendipaddress #### [serviceResourceBackendIpAddress] The IP address of a Storage resource. -Type: **string** +Type: **string** + @@ -811,7 +911,8 @@ The IP address of a Storage resource. [serviceResourceName]: #serviceresourcename #### [serviceResourceName] The name of a Storage's network resource. -Type: **string** +Type: **string** + @@ -821,7 +922,8 @@ The name of a Storage's network resource. [snapshotCapacityGb]: #snapshotcapacitygb #### [snapshotCapacityGb] A volume's configured snapshot space size. -Type: **string** +Type: **string** + @@ -831,7 +933,8 @@ A volume's configured snapshot space size. [snapshotCreationTimestamp]: #snapshotcreationtimestamp #### [snapshotCreationTimestamp] The creation timestamp of the snapshot on the storage platform. -Type: **string** +Type: **string** + @@ -841,7 +944,8 @@ The creation timestamp of the snapshot on the storage platform. [snapshotDeletionThresholdPercentage]: #snapshotdeletionthresholdpercentage #### [snapshotDeletionThresholdPercentage] The percentage of used snapshot space after which to delete automated snapshots. -Type: **string** +Type: **string** + @@ -851,7 +955,8 @@ The percentage of used snapshot space after which to delete automated snapshots. [snapshotNotificationStatus]: #snapshotnotificationstatus #### [snapshotNotificationStatus] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -861,7 +966,8 @@ Whether or not a network storage volume may be mounted. [snapshotSizeBytes]: #snapshotsizebytes #### [snapshotSizeBytes] The snapshot size in bytes. -Type: **string** +Type: **string** + @@ -871,7 +977,8 @@ The snapshot size in bytes. [snapshotSpaceAvailable]: #snapshotspaceavailable #### [snapshotSpaceAvailable] An iscsi volume's available snapshot reservation space. -Type: **string** +Type: **string** + @@ -881,7 +988,8 @@ An iscsi volume's available snapshot reservation space. [snapshots]: #snapshots #### [snapshots] The snapshots associated with this SoftLayer_Network_Storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -891,7 +999,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [staasVersion]: #staasversion #### [staasVersion] -Type: **string** +Type: **string** + @@ -901,7 +1010,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [storageGroups]: #storagegroups #### [storageGroups] The network storage groups this volume is attached to. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -911,7 +1021,8 @@ The network storage groups this volume is attached to. [storageTierLevel]: #storagetierlevel #### [storageTierLevel] -Type: **string** +Type: **string** + @@ -921,7 +1032,8 @@ The network storage groups this volume is attached to. [storageType]: #storagetype #### [storageType] A description of the Storage object. -Type: **SoftLayer_Network_Storage_Type ** +Type: **SoftLayer_Network_Storage_Type ** + @@ -931,7 +1043,8 @@ A description of the Storage object. [totalBytesUsed]: #totalbytesused #### [totalBytesUsed] The amount of space used by the volume. -Type: **string** +Type: **string** + @@ -941,7 +1054,8 @@ The amount of space used by the volume. [totalScheduleSnapshotRetentionCount]: #totalschedulesnapshotretentioncount #### [totalScheduleSnapshotRetentionCount] The total snapshot retention count of all schedules on this network storage volume. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -951,7 +1065,8 @@ The total snapshot retention count of all schedules on this network storage volu [usageNotification]: #usagenotification #### [usageNotification] The usage notification for SL Storage services. -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -961,7 +1076,8 @@ The usage notification for SL Storage services. [vendorName]: #vendorname #### [vendorName] The type of network storage service. -Type: **string** +Type: **string** + @@ -971,7 +1087,8 @@ The type of network storage service. [virtualGuest]: #virtualguest #### [virtualGuest] When applicable, the virtual guest associated with a Storage service. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -981,7 +1098,8 @@ When applicable, the virtual guest associated with a Storage service. [volumeHistory]: #volumehistory #### [volumeHistory] The username and password history for a Storage service. -Type: **SoftLayer_Network_Storage_History[] ** +Type: **SoftLayer_Network_Storage_History[] ** + @@ -991,7 +1109,8 @@ The username and password history for a Storage service. [volumeStatus]: #volumestatus #### [volumeStatus] The current status of a network storage volume. -Type: **string** +Type: **string** + @@ -1001,7 +1120,8 @@ The current status of a network storage volume. [webccAccount]: #webccaccount #### [webccAccount] The account username and password for the EVault webCC interface. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -1011,7 +1131,8 @@ The account username and password for the EVault webCC interface. [weeklySchedule]: #weeklyschedule #### [weeklySchedule] The Weekly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -1023,7 +1144,8 @@ The Weekly Schedule which is associated with this network storage volume. [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of the currently active transactions on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1155,8 @@ A count of the currently active transactions on a network storage volume. [allowedHardwareCount]: #allowedhardwarecount #### [allowedHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1166,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedIpAddressCount]: #allowedipaddresscount #### [allowedIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1177,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationHardwareCount]: #allowedreplicationhardwarecount #### [allowedReplicationHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1188,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedReplicationIpAddressCount]: #allowedreplicationipaddresscount #### [allowedReplicationIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1199,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationSubnetCount]: #allowedreplicationsubnetcount #### [allowedReplicationSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1210,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedReplicationVirtualGuestCount]: #allowedreplicationvirtualguestcount #### [allowedReplicationVirtualGuestCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1093,7 +1221,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedSubnetCount]: #allowedsubnetcount #### [allowedSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1103,7 +1232,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedVirtualGuestCount]: #allowedvirtualguestcount #### [allowedVirtualGuestCount] A count of the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1113,7 +1243,8 @@ A count of the SoftLayer_Virtual_Guest objects which are allowed access to this [credentialCount]: #credentialcount #### [credentialCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1123,7 +1254,8 @@ A count of [dependentDuplicateCount]: #dependentduplicatecount #### [dependentDuplicateCount] A count of the network storage volumes configured to be dependent duplicates of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1133,7 +1265,8 @@ A count of the network storage volumes configured to be dependent duplicates of [eventCount]: #eventcount #### [eventCount] A count of the events which have taken place on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1143,7 +1276,8 @@ A count of the events which have taken place on a network storage volume. [iscsiLunCount]: #iscsiluncount #### [iscsiLunCount] A count of relationship between a container volume and iSCSI LUNs. -Type: **unsigned long** +Type: **unsigned long** + @@ -1153,7 +1287,8 @@ A count of relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddressCount]: #iscsitargetipaddresscount #### [iscsiTargetIpAddressCount] A count of returns the target IP addresses of an iSCSI volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1163,7 +1298,8 @@ A count of returns the target IP addresses of an iSCSI volume. [manualSnapshotCount]: #manualsnapshotcount #### [manualSnapshotCount] A count of the snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **unsigned long** +Type: **unsigned long** + @@ -1173,7 +1309,8 @@ A count of the snapshots associated with this SoftLayer_Network_Storage volume. [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of the subscribers that will be notified for usage amount warnings and overages. -Type: **unsigned long** +Type: **unsigned long** + @@ -1183,7 +1320,8 @@ A count of the subscribers that will be notified for usage amount warnings and o [parentPartnershipCount]: #parentpartnershipcount #### [parentPartnershipCount] A count of the volumes or snapshots partnered with a network storage volume in a parental role. -Type: **unsigned long** +Type: **unsigned long** + @@ -1193,7 +1331,8 @@ A count of the volumes or snapshots partnered with a network storage volume in a [partnershipCount]: #partnershipcount #### [partnershipCount] A count of the volumes or snapshots partnered with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1203,7 +1342,8 @@ A count of the volumes or snapshots partnered with a network storage volume. [permissionsGroupCount]: #permissionsgroupcount #### [permissionsGroupCount] A count of all permissions group(s) this volume is in. -Type: **unsigned long** +Type: **unsigned long** + @@ -1213,7 +1353,8 @@ A count of all permissions group(s) this volume is in. [propertyCount]: #propertycount #### [propertyCount] A count of the properties used to provide additional details about a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1223,7 +1364,8 @@ A count of the properties used to provide additional details about a network sto [replicatingLunCount]: #replicatingluncount #### [replicatingLunCount] A count of the iSCSI LUN volumes being replicated by this network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1233,7 +1375,8 @@ A count of the iSCSI LUN volumes being replicated by this network storage volume [replicationEventCount]: #replicationeventcount #### [replicationEventCount] A count of the volume replication events. -Type: **unsigned long** +Type: **unsigned long** + @@ -1243,7 +1386,8 @@ A count of the volume replication events. [replicationPartnerCount]: #replicationpartnercount #### [replicationPartnerCount] A count of the network storage volumes configured to be replicants of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1253,7 +1397,8 @@ A count of the network storage volumes configured to be replicants of a volume. [scheduleCount]: #schedulecount #### [scheduleCount] A count of the schedules which are associated with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1263,7 +1408,8 @@ A count of the schedules which are associated with a network storage volume. [snapshotCount]: #snapshotcount #### [snapshotCount] A count of the snapshots associated with this SoftLayer_Network_Storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1273,7 +1419,8 @@ A count of the snapshots associated with this SoftLayer_Network_Storage volume. [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of the network storage groups this volume is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1283,7 +1430,8 @@ A count of the network storage groups this volume is attached to. [volumeHistoryCount]: #volumehistorycount #### [volumeHistoryCount] A count of the username and password history for a Storage service. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi_EqualLogic_Version3_Replicant/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi_EqualLogic_Version3_Replicant/_index.md index 1f53c830eb..f8694a8101 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi_EqualLogic_Version3_Replicant/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi_EqualLogic_Version3_Replicant/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + An iscsi replicant receives incoming data from an associated iscsi volume. While the replicant is not in failover mode it will not be mountable. Upon failover the replicant can be mounted and used as a normal volume. It is suggested to only do this as part of a disaster recovery plan. @@ -45,7 +47,8 @@ An iscsi replicant receives incoming data from an associated iscsi volume. Whil [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account that a Storage account belongs to. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of the SoftLayer customer account that a Storage account [capacityGb]: #capacitygb #### [capacityGb] A Storage account's capacity, measured in gigabytes. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A Storage account's capacity, measured in gigabytes. [createDate]: #createdate #### [createDate] The date a network storage volume was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date a network storage volume was created. [guestId]: #guestid #### [guestId] The unique identification number of the guest associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The unique identification number of the guest associated with a Storage volume. [hardwareId]: #hardwareid #### [hardwareId] The server that is associated with a Storage service. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The server that is associated with a Storage service. [hostId]: #hostid #### [hostId] The unique identification number of the host associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The unique identification number of the host associated with a Storage volume. [id]: #id #### [id] A Storage account's unique identifier. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A Storage account's unique identifier. [nasType]: #nastype #### [nasType] The StorageLayer account's type (NAS, LOCKBOX, ISCSI, EVAULT). -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The StorageLayer account's type (NAS, LOCKBOX, ISCSI, EVAULT). [notes]: #notes #### [notes] Public notes related to a Storage volume. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Public notes related to a Storage volume. [password]: #password #### [password] The password used to access a non-EVault Storage volume. This password is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The password used to access a non-EVault Storage volume. This password is used t [serviceProviderId]: #serviceproviderid #### [serviceProviderId] Service Provider ID -Type: **integer** +Type: **integer** + @@ -155,7 +168,8 @@ Service Provider ID [storageTypeId]: #storagetypeid #### [storageTypeId] A storage object's type. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ A storage object's type. [upgradableFlag]: #upgradableflag #### [upgradableFlag] This flag indicates whether this storage type is upgradable or not. -Type: **boolean** +Type: **boolean** + @@ -175,7 +190,8 @@ This flag indicates whether this storage type is upgradable or not. [username]: #username #### [username] The username used to access a non-EVault Storage volume. This username is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ The username used to access a non-EVault Storage volume. This username is used t [account]: #account #### [account] The account that a Storage services belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -201,7 +218,8 @@ The account that a Storage services belongs to. [accountPassword]: #accountpassword #### [accountPassword] Other usernames and passwords associated with a Storage volume. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -211,7 +229,19 @@ Other usernames and passwords associated with a Storage volume. [activeTransactions]: #activetransactions #### [activeTransactions] The currently active transactions on a network storage volume. -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + + + + +
      + +----- +[allowDisasterRecoveryFailback]: #allowdisasterrecoveryfailback +#### [allowDisasterRecoveryFailback] + +Type: **string** +
      @@ -221,7 +251,8 @@ The currently active transactions on a network storage volume. [allowDisasterRecoveryFailover]: #allowdisasterrecoveryfailover #### [allowDisasterRecoveryFailover] -Type: **string** +Type: **string** + @@ -231,7 +262,8 @@ The currently active transactions on a network storage volume. [allowedHardware]: #allowedhardware #### [allowedHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -241,7 +273,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume. [allowedIpAddresses]: #allowedipaddresses #### [allowedIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -251,7 +284,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationHardware]: #allowedreplicationhardware #### [allowedReplicationHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -261,7 +295,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedReplicationIpAddresses]: #allowedreplicationipaddresses #### [allowedReplicationIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -271,7 +306,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationSubnets]: #allowedreplicationsubnets #### [allowedReplicationSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -281,7 +317,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedReplicationVirtualGuests]: #allowedreplicationvirtualguests #### [allowedReplicationVirtualGuests] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -291,7 +328,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedSubnets]: #allowedsubnets #### [allowedSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -301,7 +339,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedVirtualGuests]: #allowedvirtualguests #### [allowedVirtualGuests] The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -311,7 +350,8 @@ The SoftLayer_Virtual_Guest objects which are allowed access to this storage vol [billingItem]: #billingitem #### [billingItem] The current billing item for this network storage iscsi replicant volume. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -321,7 +361,8 @@ The current billing item for this network storage iscsi replicant volume. [billingItemCategory]: #billingitemcategory #### [billingItemCategory] -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -331,7 +372,8 @@ The current billing item for this network storage iscsi replicant volume. [bytesUsed]: #bytesused #### [bytesUsed] The amount of space used by the volume, in bytes. -Type: **string** +Type: **string** + @@ -341,7 +383,8 @@ The amount of space used by the volume, in bytes. [creationScheduleId]: #creationscheduleid #### [creationScheduleId] The schedule id which was executed to create a snapshot. -Type: **string** +Type: **string** + @@ -351,7 +394,8 @@ The schedule id which was executed to create a snapshot. [credentials]: #credentials #### [credentials] -Type: **SoftLayer_Network_Storage_Credential[] ** +Type: **SoftLayer_Network_Storage_Credential[] ** + @@ -361,7 +405,8 @@ The schedule id which was executed to create a snapshot. [dailySchedule]: #dailyschedule #### [dailySchedule] The Daily Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -371,7 +416,8 @@ The Daily Schedule which is associated with this network storage volume. [dependentDuplicate]: #dependentduplicate #### [dependentDuplicate] Whether or not a network storage volume is a dependent duplicate. -Type: **string** +Type: **string** + @@ -381,7 +427,8 @@ Whether or not a network storage volume is a dependent duplicate. [dependentDuplicates]: #dependentduplicates #### [dependentDuplicates] The network storage volumes configured to be dependent duplicates of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -391,7 +438,8 @@ The network storage volumes configured to be dependent duplicates of a volume. [events]: #events #### [events] The events which have taken place on a network storage volume. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -401,7 +449,8 @@ The events which have taken place on a network storage volume. [failbackInProgressFlag]: #failbackinprogressflag #### [failbackInProgressFlag] When a replicant is in the process of synchronizing with the parent volume this flag will be true. -Type: **boolean** +Type: **boolean** + @@ -411,7 +460,19 @@ When a replicant is in the process of synchronizing with the parent volume this [failbackNotAllowed]: #failbacknotallowed #### [failbackNotAllowed] Determines whether the volume is allowed to failback -Type: **string** +Type: **string** + + + + +
      + +----- +[failoverNotAllowed]: #failovernotallowed +#### [failoverNotAllowed] +Determines whether the volume is allowed to failover +Type: **string** +
      @@ -421,7 +482,8 @@ Determines whether the volume is allowed to failback [fileNetworkMountAddress]: #filenetworkmountaddress #### [fileNetworkMountAddress] Retrieves the NFS Network Mount Address Name for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -431,7 +493,8 @@ Retrieves the NFS Network Mount Address Name for a given File Storage Volume. [hardware]: #hardware #### [hardware] When applicable, the hardware associated with a Storage service. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -441,7 +504,8 @@ When applicable, the hardware associated with a Storage service. [hasEncryptionAtRest]: #hasencryptionatrest #### [hasEncryptionAtRest] -Type: **boolean** +Type: **boolean** + @@ -451,7 +515,8 @@ When applicable, the hardware associated with a Storage service. [hourlySchedule]: #hourlyschedule #### [hourlySchedule] The Hourly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -461,7 +526,8 @@ The Hourly Schedule which is associated with this network storage volume. [intervalSchedule]: #intervalschedule #### [intervalSchedule] The Interval Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -471,7 +537,8 @@ The Interval Schedule which is associated with this network storage volume. [iops]: #iops #### [iops] The maximum number of IOPs guaranteed for this LUN. -Type: **string** +Type: **string** + @@ -481,7 +548,8 @@ The maximum number of IOPs guaranteed for this LUN. [isDependentDuplicateProvisionCompleted]: #isdependentduplicateprovisioncompleted #### [isDependentDuplicateProvisionCompleted] Determines whether dependent volume provision is completed on background. -Type: **boolean** +Type: **boolean** + @@ -491,7 +559,8 @@ Determines whether dependent volume provision is completed on background. [isInDedicatedServiceResource]: #isindedicatedserviceresource #### [isInDedicatedServiceResource] -Type: **boolean** +Type: **boolean** + @@ -501,7 +570,8 @@ Determines whether dependent volume provision is completed on background. [isMagneticStorage]: #ismagneticstorage #### [isMagneticStorage] -Type: **string** +Type: **string** + @@ -511,7 +581,8 @@ Determines whether dependent volume provision is completed on background. [isReadyForSnapshot]: #isreadyforsnapshot #### [isReadyForSnapshot] Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. -Type: **boolean** +Type: **boolean** + @@ -521,7 +592,8 @@ Determines whether a volume is ready to order snapshot space, or, if snapshot sp [isReadyToMount]: #isreadytomount #### [isReadyToMount] Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. -Type: **boolean** +Type: **boolean** + @@ -531,7 +603,8 @@ Determines whether a volume is ready to have Hosts authorized to access it. This [iscsiLuns]: #iscsiluns #### [iscsiLuns] Relationship between a container volume and iSCSI LUNs. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -541,7 +614,8 @@ Relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddresses]: #iscsitargetipaddresses #### [iscsiTargetIpAddresses] Returns the target IP addresses of an iSCSI volume. -Type: **array of strings** +Type: **array of strings** + @@ -551,7 +625,8 @@ Returns the target IP addresses of an iSCSI volume. [lunId]: #lunid #### [lunId] The ID of the LUN volume. -Type: **string** +Type: **string** + @@ -561,7 +636,8 @@ The ID of the LUN volume. [manualSnapshots]: #manualsnapshots #### [manualSnapshots] The snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -571,7 +647,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. Does not su [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A network storage volume's metric tracking object. This object records all periodic polled data available to this volume. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -581,7 +658,8 @@ A network storage volume's metric tracking object. This object records all perio [mountPath]: #mountpath #### [mountPath] Retrieves the NFS Network Mount Path for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -591,7 +669,8 @@ Retrieves the NFS Network Mount Path for a given File Storage Volume. [mountableFlag]: #mountableflag #### [mountableFlag] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -601,7 +680,8 @@ Whether or not a network storage volume may be mounted. [moveAndSplitStatus]: #moveandsplitstatus #### [moveAndSplitStatus] The current status of split or move operation as a part of volume duplication. -Type: **string** +Type: **string** + @@ -611,7 +691,8 @@ The current status of split or move operation as a part of volume duplication. [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] The subscribers that will be notified for usage amount warnings and overages. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -621,7 +702,8 @@ The subscribers that will be notified for usage amount warnings and overages. [originalSnapshotName]: #originalsnapshotname #### [originalSnapshotName] The name of the snapshot that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -631,7 +713,8 @@ The name of the snapshot that this volume was duplicated from. [originalVolumeName]: #originalvolumename #### [originalVolumeName] The name of the volume that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -641,7 +724,8 @@ The name of the volume that this volume was duplicated from. [originalVolumeSize]: #originalvolumesize #### [originalVolumeSize] The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. -Type: **string** +Type: **string** + @@ -651,7 +735,8 @@ The size (in GB) of the volume or LUN before any size expansion, or of the volum [osType]: #ostype #### [osType] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -661,7 +746,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. [osTypeId]: #ostypeid #### [osTypeId] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. -Type: **string** +Type: **string** + @@ -671,7 +757,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. [parentPartnerships]: #parentpartnerships #### [parentPartnerships] The volumes or snapshots partnered with a network storage volume in a parental role. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -681,7 +768,8 @@ The volumes or snapshots partnered with a network storage volume in a parental r [parentVolume]: #parentvolume #### [parentVolume] The volume for which a replicant is receiving incoming data for. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -691,7 +779,8 @@ The volume for which a replicant is receiving incoming data for. [partnerships]: #partnerships #### [partnerships] The volumes or snapshots partnered with a network storage volume. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -701,7 +790,8 @@ The volumes or snapshots partnered with a network storage volume. [permissionsGroups]: #permissionsgroups #### [permissionsGroups] All permissions group(s) this volume is in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -711,7 +801,8 @@ All permissions group(s) this volume is in. [properties]: #properties #### [properties] The properties used to provide additional details about a network storage volume. -Type: **SoftLayer_Network_Storage_Property[] ** +Type: **SoftLayer_Network_Storage_Property[] ** + @@ -721,7 +812,8 @@ The properties used to provide additional details about a network storage volume [provisionedIops]: #provisionediops #### [provisionedIops] The number of IOPs provisioned for this volume. -Type: **string** +Type: **string** + @@ -731,7 +823,8 @@ The number of IOPs provisioned for this volume. [replicatingLuns]: #replicatingluns #### [replicatingLuns] The iSCSI LUN volumes being replicated by this network storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -741,7 +834,8 @@ The iSCSI LUN volumes being replicated by this network storage volume. [replicatingVolume]: #replicatingvolume #### [replicatingVolume] The network storage volume being replicated by a volume. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -751,7 +845,8 @@ The network storage volume being replicated by a volume. [replicationEvents]: #replicationevents #### [replicationEvents] The volume replication events. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -761,7 +856,8 @@ The volume replication events. [replicationPartners]: #replicationpartners #### [replicationPartners] The network storage volumes configured to be replicants of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -771,7 +867,8 @@ The network storage volumes configured to be replicants of a volume. [replicationSchedule]: #replicationschedule #### [replicationSchedule] The Replication Schedule associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -781,7 +878,8 @@ The Replication Schedule associated with a network storage volume. [replicationStatus]: #replicationstatus #### [replicationStatus] The current replication status of a network storage volume. Indicates Failover or Failback status. -Type: **string** +Type: **string** + @@ -791,7 +889,8 @@ The current replication status of a network storage volume. Indicates Failover o [schedules]: #schedules #### [schedules] The schedules which are associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule[] ** +Type: **SoftLayer_Network_Storage_Schedule[] ** + @@ -801,7 +900,8 @@ The schedules which are associated with a network storage volume. [serviceResource]: #serviceresource #### [serviceResource] The network resource a Storage service is connected to. -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -811,7 +911,8 @@ The network resource a Storage service is connected to. [serviceResourceBackendIpAddress]: #serviceresourcebackendipaddress #### [serviceResourceBackendIpAddress] The IP address of a Storage resource. -Type: **string** +Type: **string** + @@ -821,7 +922,8 @@ The IP address of a Storage resource. [serviceResourceName]: #serviceresourcename #### [serviceResourceName] The name of a Storage's network resource. -Type: **string** +Type: **string** + @@ -831,7 +933,8 @@ The name of a Storage's network resource. [snapshotCapacityGb]: #snapshotcapacitygb #### [snapshotCapacityGb] The maximum capacity available to use for volume snapshots. -Type: **decimal** +Type: **decimal** + @@ -841,7 +944,8 @@ The maximum capacity available to use for volume snapshots. [snapshotCreationTimestamp]: #snapshotcreationtimestamp #### [snapshotCreationTimestamp] The creation timestamp of the snapshot on the storage platform. -Type: **string** +Type: **string** + @@ -851,7 +955,8 @@ The creation timestamp of the snapshot on the storage platform. [snapshotDeletionThresholdPercentage]: #snapshotdeletionthresholdpercentage #### [snapshotDeletionThresholdPercentage] The percentage of used snapshot space after which to delete automated snapshots. -Type: **string** +Type: **string** + @@ -861,7 +966,8 @@ The percentage of used snapshot space after which to delete automated snapshots. [snapshotNotificationStatus]: #snapshotnotificationstatus #### [snapshotNotificationStatus] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -871,7 +977,8 @@ Whether or not a network storage volume may be mounted. [snapshotSizeBytes]: #snapshotsizebytes #### [snapshotSizeBytes] The snapshot size in bytes. -Type: **string** +Type: **string** + @@ -881,7 +988,8 @@ The snapshot size in bytes. [snapshotSpaceAvailable]: #snapshotspaceavailable #### [snapshotSpaceAvailable] An iscsi volume's available snapshot reservation space. -Type: **string** +Type: **string** + @@ -891,7 +999,8 @@ An iscsi volume's available snapshot reservation space. [snapshots]: #snapshots #### [snapshots] The snapshots associated with this SoftLayer_Network_Storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -901,7 +1010,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [staasVersion]: #staasversion #### [staasVersion] -Type: **string** +Type: **string** + @@ -911,7 +1021,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [storageGroups]: #storagegroups #### [storageGroups] The network storage groups this volume is attached to. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -921,7 +1032,8 @@ The network storage groups this volume is attached to. [storageTierLevel]: #storagetierlevel #### [storageTierLevel] -Type: **string** +Type: **string** + @@ -931,7 +1043,8 @@ The network storage groups this volume is attached to. [storageType]: #storagetype #### [storageType] A description of the Storage object. -Type: **SoftLayer_Network_Storage_Type ** +Type: **SoftLayer_Network_Storage_Type ** + @@ -941,7 +1054,8 @@ A description of the Storage object. [totalBytesUsed]: #totalbytesused #### [totalBytesUsed] The amount of space used by the volume. -Type: **string** +Type: **string** + @@ -951,7 +1065,8 @@ The amount of space used by the volume. [totalScheduleSnapshotRetentionCount]: #totalschedulesnapshotretentioncount #### [totalScheduleSnapshotRetentionCount] The total snapshot retention count of all schedules on this network storage volume. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -961,7 +1076,8 @@ The total snapshot retention count of all schedules on this network storage volu [usageNotification]: #usagenotification #### [usageNotification] The usage notification for SL Storage services. -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -971,7 +1087,8 @@ The usage notification for SL Storage services. [vendorName]: #vendorname #### [vendorName] The type of network storage service. -Type: **string** +Type: **string** + @@ -981,7 +1098,8 @@ The type of network storage service. [virtualGuest]: #virtualguest #### [virtualGuest] When applicable, the virtual guest associated with a Storage service. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -991,7 +1109,8 @@ When applicable, the virtual guest associated with a Storage service. [volumeHistory]: #volumehistory #### [volumeHistory] The username and password history for a Storage service. -Type: **SoftLayer_Network_Storage_History[] ** +Type: **SoftLayer_Network_Storage_History[] ** + @@ -1001,7 +1120,8 @@ The username and password history for a Storage service. [volumeName]: #volumename #### [volumeName] The volume name for an iscsi replicant. -Type: **string** +Type: **string** + @@ -1011,7 +1131,8 @@ The volume name for an iscsi replicant. [volumeStatus]: #volumestatus #### [volumeStatus] The current status of a network storage volume. -Type: **string** +Type: **string** + @@ -1021,7 +1142,8 @@ The current status of a network storage volume. [webccAccount]: #webccaccount #### [webccAccount] The account username and password for the EVault webCC interface. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -1031,7 +1153,8 @@ The account username and password for the EVault webCC interface. [weeklySchedule]: #weeklyschedule #### [weeklySchedule] The Weekly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -1043,7 +1166,8 @@ The Weekly Schedule which is associated with this network storage volume. [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of the currently active transactions on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1177,8 @@ A count of the currently active transactions on a network storage volume. [allowedHardwareCount]: #allowedhardwarecount #### [allowedHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1188,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedIpAddressCount]: #allowedipaddresscount #### [allowedIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1199,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationHardwareCount]: #allowedreplicationhardwarecount #### [allowedReplicationHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1210,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedReplicationIpAddressCount]: #allowedreplicationipaddresscount #### [allowedReplicationIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1093,7 +1221,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationSubnetCount]: #allowedreplicationsubnetcount #### [allowedReplicationSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1103,7 +1232,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedReplicationVirtualGuestCount]: #allowedreplicationvirtualguestcount #### [allowedReplicationVirtualGuestCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1113,7 +1243,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedSubnetCount]: #allowedsubnetcount #### [allowedSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1123,7 +1254,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedVirtualGuestCount]: #allowedvirtualguestcount #### [allowedVirtualGuestCount] A count of the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1133,7 +1265,8 @@ A count of the SoftLayer_Virtual_Guest objects which are allowed access to this [credentialCount]: #credentialcount #### [credentialCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1143,7 +1276,8 @@ A count of [dependentDuplicateCount]: #dependentduplicatecount #### [dependentDuplicateCount] A count of the network storage volumes configured to be dependent duplicates of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1153,7 +1287,8 @@ A count of the network storage volumes configured to be dependent duplicates of [eventCount]: #eventcount #### [eventCount] A count of the events which have taken place on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1163,7 +1298,8 @@ A count of the events which have taken place on a network storage volume. [iscsiLunCount]: #iscsiluncount #### [iscsiLunCount] A count of relationship between a container volume and iSCSI LUNs. -Type: **unsigned long** +Type: **unsigned long** + @@ -1173,7 +1309,8 @@ A count of relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddressCount]: #iscsitargetipaddresscount #### [iscsiTargetIpAddressCount] A count of returns the target IP addresses of an iSCSI volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1183,7 +1320,8 @@ A count of returns the target IP addresses of an iSCSI volume. [manualSnapshotCount]: #manualsnapshotcount #### [manualSnapshotCount] A count of the snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **unsigned long** +Type: **unsigned long** + @@ -1193,7 +1331,8 @@ A count of the snapshots associated with this SoftLayer_Network_Storage volume. [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of the subscribers that will be notified for usage amount warnings and overages. -Type: **unsigned long** +Type: **unsigned long** + @@ -1203,7 +1342,8 @@ A count of the subscribers that will be notified for usage amount warnings and o [parentPartnershipCount]: #parentpartnershipcount #### [parentPartnershipCount] A count of the volumes or snapshots partnered with a network storage volume in a parental role. -Type: **unsigned long** +Type: **unsigned long** + @@ -1213,7 +1353,8 @@ A count of the volumes or snapshots partnered with a network storage volume in a [partnershipCount]: #partnershipcount #### [partnershipCount] A count of the volumes or snapshots partnered with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1223,7 +1364,8 @@ A count of the volumes or snapshots partnered with a network storage volume. [permissionsGroupCount]: #permissionsgroupcount #### [permissionsGroupCount] A count of all permissions group(s) this volume is in. -Type: **unsigned long** +Type: **unsigned long** + @@ -1233,7 +1375,8 @@ A count of all permissions group(s) this volume is in. [propertyCount]: #propertycount #### [propertyCount] A count of the properties used to provide additional details about a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1243,7 +1386,8 @@ A count of the properties used to provide additional details about a network sto [replicatingLunCount]: #replicatingluncount #### [replicatingLunCount] A count of the iSCSI LUN volumes being replicated by this network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1253,7 +1397,8 @@ A count of the iSCSI LUN volumes being replicated by this network storage volume [replicationEventCount]: #replicationeventcount #### [replicationEventCount] A count of the volume replication events. -Type: **unsigned long** +Type: **unsigned long** + @@ -1263,7 +1408,8 @@ A count of the volume replication events. [replicationPartnerCount]: #replicationpartnercount #### [replicationPartnerCount] A count of the network storage volumes configured to be replicants of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1273,7 +1419,8 @@ A count of the network storage volumes configured to be replicants of a volume. [scheduleCount]: #schedulecount #### [scheduleCount] A count of the schedules which are associated with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1283,7 +1430,8 @@ A count of the schedules which are associated with a network storage volume. [snapshotCount]: #snapshotcount #### [snapshotCount] A count of the snapshots associated with this SoftLayer_Network_Storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1293,7 +1441,8 @@ A count of the snapshots associated with this SoftLayer_Network_Storage volume. [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of the network storage groups this volume is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1303,7 +1452,8 @@ A count of the network storage groups this volume is attached to. [volumeHistoryCount]: #volumehistorycount #### [volumeHistoryCount] A count of the username and password history for a Storage service. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi_EqualLogic_Version3_Snapshot/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi_EqualLogic_Version3_Snapshot/_index.md index 3bd8cfdae4..28f6098acf 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi_EqualLogic_Version3_Snapshot/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi_EqualLogic_Version3_Snapshot/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + An iscsi snapshot is a point-in-time view of the data on an associated iscsi volume. Iscsi snapshots use a copy-on-write technology to minimize the amount of snapshot space used. When a snapshot is initially created it will use no snapshot space. At the time data changes on a volume which existed when a snapshot was created the original data will be saved in the associated volume's snapshot reserve space. As a snapshot is created offline it must be set mountable in order to mount it via an iscsi initiator service. @@ -47,7 +49,8 @@ As a snapshot is created offline it must be set mountable in order to mount it v [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account that a Storage account belongs to. -Type: **integer** +Type: **integer** + @@ -57,7 +60,8 @@ The internal identifier of the SoftLayer customer account that a Storage account [capacityGb]: #capacitygb #### [capacityGb] A Storage account's capacity, measured in gigabytes. -Type: **integer** +Type: **integer** + @@ -67,7 +71,8 @@ A Storage account's capacity, measured in gigabytes. [createDate]: #createdate #### [createDate] The date a network storage volume was created. -Type: **dateTime** +Type: **dateTime** + @@ -77,7 +82,8 @@ The date a network storage volume was created. [guestId]: #guestid #### [guestId] The unique identification number of the guest associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -87,7 +93,8 @@ The unique identification number of the guest associated with a Storage volume. [hardwareId]: #hardwareid #### [hardwareId] The server that is associated with a Storage service. -Type: **integer** +Type: **integer** + @@ -97,7 +104,8 @@ The server that is associated with a Storage service. [hostId]: #hostid #### [hostId] The unique identification number of the host associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -107,7 +115,8 @@ The unique identification number of the host associated with a Storage volume. [id]: #id #### [id] A Storage account's unique identifier. -Type: **integer** +Type: **integer** + @@ -117,7 +126,8 @@ A Storage account's unique identifier. [nasType]: #nastype #### [nasType] The StorageLayer account's type (NAS, LOCKBOX, ISCSI, EVAULT). -Type: **string** +Type: **string** + @@ -127,7 +137,8 @@ The StorageLayer account's type (NAS, LOCKBOX, ISCSI, EVAULT). [notes]: #notes #### [notes] Public notes related to a Storage volume. -Type: **string** +Type: **string** + @@ -137,7 +148,8 @@ Public notes related to a Storage volume. [password]: #password #### [password] The password used to access a non-EVault Storage volume. This password is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -147,7 +159,8 @@ The password used to access a non-EVault Storage volume. This password is used t [serviceProviderId]: #serviceproviderid #### [serviceProviderId] Service Provider ID -Type: **integer** +Type: **integer** + @@ -157,7 +170,8 @@ Service Provider ID [storageTypeId]: #storagetypeid #### [storageTypeId] A storage object's type. -Type: **string** +Type: **string** + @@ -167,7 +181,8 @@ A storage object's type. [upgradableFlag]: #upgradableflag #### [upgradableFlag] This flag indicates whether this storage type is upgradable or not. -Type: **boolean** +Type: **boolean** + @@ -177,7 +192,8 @@ This flag indicates whether this storage type is upgradable or not. [username]: #username #### [username] The username used to access a non-EVault Storage volume. This username is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -193,7 +209,8 @@ The username used to access a non-EVault Storage volume. This username is used t [account]: #account #### [account] The account that a Storage services belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -203,7 +220,8 @@ The account that a Storage services belongs to. [accountPassword]: #accountpassword #### [accountPassword] Other usernames and passwords associated with a Storage volume. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -213,7 +231,19 @@ Other usernames and passwords associated with a Storage volume. [activeTransactions]: #activetransactions #### [activeTransactions] The currently active transactions on a network storage volume. -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + + + + +
      + +----- +[allowDisasterRecoveryFailback]: #allowdisasterrecoveryfailback +#### [allowDisasterRecoveryFailback] + +Type: **string** +
      @@ -223,7 +253,8 @@ The currently active transactions on a network storage volume. [allowDisasterRecoveryFailover]: #allowdisasterrecoveryfailover #### [allowDisasterRecoveryFailover] -Type: **string** +Type: **string** + @@ -233,7 +264,8 @@ The currently active transactions on a network storage volume. [allowedHardware]: #allowedhardware #### [allowedHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -243,7 +275,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume. [allowedIpAddresses]: #allowedipaddresses #### [allowedIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -253,7 +286,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationHardware]: #allowedreplicationhardware #### [allowedReplicationHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -263,7 +297,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedReplicationIpAddresses]: #allowedreplicationipaddresses #### [allowedReplicationIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -273,7 +308,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationSubnets]: #allowedreplicationsubnets #### [allowedReplicationSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -283,7 +319,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedReplicationVirtualGuests]: #allowedreplicationvirtualguests #### [allowedReplicationVirtualGuests] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -293,7 +330,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedSubnets]: #allowedsubnets #### [allowedSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -303,7 +341,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedVirtualGuests]: #allowedvirtualguests #### [allowedVirtualGuests] The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -313,7 +352,8 @@ The SoftLayer_Virtual_Guest objects which are allowed access to this storage vol [billingItem]: #billingitem #### [billingItem] The current billing item for this network storage iscsi volume. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -323,7 +363,8 @@ The current billing item for this network storage iscsi volume. [billingItemCategory]: #billingitemcategory #### [billingItemCategory] -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -333,7 +374,8 @@ The current billing item for this network storage iscsi volume. [bytesUsed]: #bytesused #### [bytesUsed] The amount of space used by the volume, in bytes. -Type: **string** +Type: **string** + @@ -343,7 +385,8 @@ The amount of space used by the volume, in bytes. [creationSchedule]: #creationschedule #### [creationSchedule] If applicable, the schedule which was executed to create a snapshot. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -353,7 +396,8 @@ If applicable, the schedule which was executed to create a snapshot. [creationScheduleId]: #creationscheduleid #### [creationScheduleId] The schedule id which was executed to create a snapshot. -Type: **string** +Type: **string** + @@ -363,7 +407,8 @@ The schedule id which was executed to create a snapshot. [credentials]: #credentials #### [credentials] -Type: **SoftLayer_Network_Storage_Credential[] ** +Type: **SoftLayer_Network_Storage_Credential[] ** + @@ -373,7 +418,8 @@ The schedule id which was executed to create a snapshot. [dailySchedule]: #dailyschedule #### [dailySchedule] The Daily Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -383,7 +429,8 @@ The Daily Schedule which is associated with this network storage volume. [dependentDuplicate]: #dependentduplicate #### [dependentDuplicate] Whether or not a network storage volume is a dependent duplicate. -Type: **string** +Type: **string** + @@ -393,7 +440,8 @@ Whether or not a network storage volume is a dependent duplicate. [dependentDuplicates]: #dependentduplicates #### [dependentDuplicates] The network storage volumes configured to be dependent duplicates of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -403,7 +451,8 @@ The network storage volumes configured to be dependent duplicates of a volume. [events]: #events #### [events] The events which have taken place on a network storage volume. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -413,7 +462,19 @@ The events which have taken place on a network storage volume. [failbackNotAllowed]: #failbacknotallowed #### [failbackNotAllowed] Determines whether the volume is allowed to failback -Type: **string** +Type: **string** + + + + +
      + +----- +[failoverNotAllowed]: #failovernotallowed +#### [failoverNotAllowed] +Determines whether the volume is allowed to failover +Type: **string** +
      @@ -423,7 +484,8 @@ Determines whether the volume is allowed to failback [fileNetworkMountAddress]: #filenetworkmountaddress #### [fileNetworkMountAddress] Retrieves the NFS Network Mount Address Name for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -433,7 +495,8 @@ Retrieves the NFS Network Mount Address Name for a given File Storage Volume. [hardware]: #hardware #### [hardware] When applicable, the hardware associated with a Storage service. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -443,7 +506,8 @@ When applicable, the hardware associated with a Storage service. [hasEncryptionAtRest]: #hasencryptionatrest #### [hasEncryptionAtRest] -Type: **boolean** +Type: **boolean** + @@ -453,7 +517,8 @@ When applicable, the hardware associated with a Storage service. [hourlySchedule]: #hourlyschedule #### [hourlySchedule] The Hourly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -463,7 +528,8 @@ The Hourly Schedule which is associated with this network storage volume. [intervalSchedule]: #intervalschedule #### [intervalSchedule] The Interval Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -473,7 +539,8 @@ The Interval Schedule which is associated with this network storage volume. [iops]: #iops #### [iops] The maximum number of IOPs guaranteed for this LUN. -Type: **string** +Type: **string** + @@ -483,7 +550,8 @@ The maximum number of IOPs guaranteed for this LUN. [isDependentDuplicateProvisionCompleted]: #isdependentduplicateprovisioncompleted #### [isDependentDuplicateProvisionCompleted] Determines whether dependent volume provision is completed on background. -Type: **boolean** +Type: **boolean** + @@ -493,7 +561,8 @@ Determines whether dependent volume provision is completed on background. [isInDedicatedServiceResource]: #isindedicatedserviceresource #### [isInDedicatedServiceResource] -Type: **boolean** +Type: **boolean** + @@ -503,7 +572,8 @@ Determines whether dependent volume provision is completed on background. [isMagneticStorage]: #ismagneticstorage #### [isMagneticStorage] -Type: **string** +Type: **string** + @@ -513,7 +583,8 @@ Determines whether dependent volume provision is completed on background. [isReadyForSnapshot]: #isreadyforsnapshot #### [isReadyForSnapshot] Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. -Type: **boolean** +Type: **boolean** + @@ -523,7 +594,8 @@ Determines whether a volume is ready to order snapshot space, or, if snapshot sp [isReadyToMount]: #isreadytomount #### [isReadyToMount] Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. -Type: **boolean** +Type: **boolean** + @@ -533,7 +605,8 @@ Determines whether a volume is ready to have Hosts authorized to access it. This [iscsiLuns]: #iscsiluns #### [iscsiLuns] Relationship between a container volume and iSCSI LUNs. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -543,7 +616,8 @@ Relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddresses]: #iscsitargetipaddresses #### [iscsiTargetIpAddresses] Returns the target IP addresses of an iSCSI volume. -Type: **array of strings** +Type: **array of strings** + @@ -553,7 +627,8 @@ Returns the target IP addresses of an iSCSI volume. [lunId]: #lunid #### [lunId] The ID of the LUN volume. -Type: **string** +Type: **string** + @@ -563,7 +638,8 @@ The ID of the LUN volume. [manualSnapshots]: #manualsnapshots #### [manualSnapshots] The snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -573,7 +649,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. Does not su [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A network storage volume's metric tracking object. This object records all periodic polled data available to this volume. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -583,7 +660,8 @@ A network storage volume's metric tracking object. This object records all perio [mountPath]: #mountpath #### [mountPath] Retrieves the NFS Network Mount Path for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -593,7 +671,8 @@ Retrieves the NFS Network Mount Path for a given File Storage Volume. [mountableFlag]: #mountableflag #### [mountableFlag] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -603,7 +682,8 @@ Whether or not a network storage volume may be mounted. [moveAndSplitStatus]: #moveandsplitstatus #### [moveAndSplitStatus] The current status of split or move operation as a part of volume duplication. -Type: **string** +Type: **string** + @@ -613,7 +693,8 @@ The current status of split or move operation as a part of volume duplication. [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] The subscribers that will be notified for usage amount warnings and overages. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -623,7 +704,8 @@ The subscribers that will be notified for usage amount warnings and overages. [originalSnapshotName]: #originalsnapshotname #### [originalSnapshotName] The name of the snapshot that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -633,7 +715,8 @@ The name of the snapshot that this volume was duplicated from. [originalVolumeName]: #originalvolumename #### [originalVolumeName] The name of the volume that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -643,7 +726,8 @@ The name of the volume that this volume was duplicated from. [originalVolumeSize]: #originalvolumesize #### [originalVolumeSize] The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. -Type: **string** +Type: **string** + @@ -653,7 +737,8 @@ The size (in GB) of the volume or LUN before any size expansion, or of the volum [osType]: #ostype #### [osType] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -663,7 +748,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. [osTypeId]: #ostypeid #### [osTypeId] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. -Type: **string** +Type: **string** + @@ -673,7 +759,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. [parentPartnerships]: #parentpartnerships #### [parentPartnerships] The volumes or snapshots partnered with a network storage volume in a parental role. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -683,7 +770,8 @@ The volumes or snapshots partnered with a network storage volume in a parental r [parentVolume]: #parentvolume #### [parentVolume] The volume for which a snapshot is associated with. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -693,7 +781,8 @@ The volume for which a snapshot is associated with. [partnerships]: #partnerships #### [partnerships] The volumes or snapshots partnered with a network storage volume. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -703,7 +792,8 @@ The volumes or snapshots partnered with a network storage volume. [permissionsGroups]: #permissionsgroups #### [permissionsGroups] All permissions group(s) this volume is in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -713,7 +803,8 @@ All permissions group(s) this volume is in. [properties]: #properties #### [properties] The properties used to provide additional details about a network storage volume. -Type: **SoftLayer_Network_Storage_Property[] ** +Type: **SoftLayer_Network_Storage_Property[] ** + @@ -723,7 +814,8 @@ The properties used to provide additional details about a network storage volume [provisionedIops]: #provisionediops #### [provisionedIops] The number of IOPs provisioned for this volume. -Type: **string** +Type: **string** + @@ -733,7 +825,8 @@ The number of IOPs provisioned for this volume. [replicatingLuns]: #replicatingluns #### [replicatingLuns] The iSCSI LUN volumes being replicated by this network storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -743,7 +836,8 @@ The iSCSI LUN volumes being replicated by this network storage volume. [replicatingVolume]: #replicatingvolume #### [replicatingVolume] The network storage volume being replicated by a volume. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -753,7 +847,8 @@ The network storage volume being replicated by a volume. [replicationEvents]: #replicationevents #### [replicationEvents] The volume replication events. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -763,7 +858,8 @@ The volume replication events. [replicationPartners]: #replicationpartners #### [replicationPartners] The network storage volumes configured to be replicants of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -773,7 +869,8 @@ The network storage volumes configured to be replicants of a volume. [replicationSchedule]: #replicationschedule #### [replicationSchedule] The Replication Schedule associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -783,7 +880,8 @@ The Replication Schedule associated with a network storage volume. [replicationStatus]: #replicationstatus #### [replicationStatus] The current replication status of a network storage volume. Indicates Failover or Failback status. -Type: **string** +Type: **string** + @@ -793,7 +891,8 @@ The current replication status of a network storage volume. Indicates Failover o [schedules]: #schedules #### [schedules] The schedules which are associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule[] ** +Type: **SoftLayer_Network_Storage_Schedule[] ** + @@ -803,7 +902,8 @@ The schedules which are associated with a network storage volume. [serviceResource]: #serviceresource #### [serviceResource] The network resource a Storage service is connected to. -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -813,7 +913,8 @@ The network resource a Storage service is connected to. [serviceResourceBackendIpAddress]: #serviceresourcebackendipaddress #### [serviceResourceBackendIpAddress] The IP address of a Storage resource. -Type: **string** +Type: **string** + @@ -823,7 +924,8 @@ The IP address of a Storage resource. [serviceResourceName]: #serviceresourcename #### [serviceResourceName] The name of a Storage's network resource. -Type: **string** +Type: **string** + @@ -833,7 +935,8 @@ The name of a Storage's network resource. [snapshotCapacityGb]: #snapshotcapacitygb #### [snapshotCapacityGb] The maximum capacity available to use for volume snapshots. -Type: **decimal** +Type: **decimal** + @@ -843,7 +946,8 @@ The maximum capacity available to use for volume snapshots. [snapshotCreationTimestamp]: #snapshotcreationtimestamp #### [snapshotCreationTimestamp] The creation timestamp of the snapshot on the storage platform. -Type: **string** +Type: **string** + @@ -853,7 +957,8 @@ The creation timestamp of the snapshot on the storage platform. [snapshotDeletionThresholdPercentage]: #snapshotdeletionthresholdpercentage #### [snapshotDeletionThresholdPercentage] The percentage of used snapshot space after which to delete automated snapshots. -Type: **string** +Type: **string** + @@ -863,7 +968,8 @@ The percentage of used snapshot space after which to delete automated snapshots. [snapshotNotificationStatus]: #snapshotnotificationstatus #### [snapshotNotificationStatus] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -873,7 +979,8 @@ Whether or not a network storage volume may be mounted. [snapshotSizeBytes]: #snapshotsizebytes #### [snapshotSizeBytes] The snapshot size in bytes. -Type: **string** +Type: **string** + @@ -883,7 +990,8 @@ The snapshot size in bytes. [snapshotSpaceAvailable]: #snapshotspaceavailable #### [snapshotSpaceAvailable] An iscsi volume's available snapshot reservation space. -Type: **string** +Type: **string** + @@ -893,7 +1001,8 @@ An iscsi volume's available snapshot reservation space. [snapshots]: #snapshots #### [snapshots] The snapshots associated with this SoftLayer_Network_Storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -903,7 +1012,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [staasVersion]: #staasversion #### [staasVersion] -Type: **string** +Type: **string** + @@ -913,7 +1023,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [storageGroups]: #storagegroups #### [storageGroups] The network storage groups this volume is attached to. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -923,7 +1034,8 @@ The network storage groups this volume is attached to. [storageTierLevel]: #storagetierlevel #### [storageTierLevel] -Type: **string** +Type: **string** + @@ -933,7 +1045,8 @@ The network storage groups this volume is attached to. [storageType]: #storagetype #### [storageType] A description of the Storage object. -Type: **SoftLayer_Network_Storage_Type ** +Type: **SoftLayer_Network_Storage_Type ** + @@ -943,7 +1056,8 @@ A description of the Storage object. [totalBytesUsed]: #totalbytesused #### [totalBytesUsed] The amount of space used by the volume. -Type: **string** +Type: **string** + @@ -953,7 +1067,8 @@ The amount of space used by the volume. [totalScheduleSnapshotRetentionCount]: #totalschedulesnapshotretentioncount #### [totalScheduleSnapshotRetentionCount] The total snapshot retention count of all schedules on this network storage volume. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -963,7 +1078,8 @@ The total snapshot retention count of all schedules on this network storage volu [usageNotification]: #usagenotification #### [usageNotification] The usage notification for SL Storage services. -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -973,7 +1089,8 @@ The usage notification for SL Storage services. [vendorName]: #vendorname #### [vendorName] The type of network storage service. -Type: **string** +Type: **string** + @@ -983,7 +1100,8 @@ The type of network storage service. [virtualGuest]: #virtualguest #### [virtualGuest] When applicable, the virtual guest associated with a Storage service. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -993,7 +1111,8 @@ When applicable, the virtual guest associated with a Storage service. [volumeHistory]: #volumehistory #### [volumeHistory] The username and password history for a Storage service. -Type: **SoftLayer_Network_Storage_History[] ** +Type: **SoftLayer_Network_Storage_History[] ** + @@ -1003,7 +1122,8 @@ The username and password history for a Storage service. [volumeName]: #volumename #### [volumeName] The volume name for an iscsi snapshot. -Type: **string** +Type: **string** + @@ -1013,7 +1133,8 @@ The volume name for an iscsi snapshot. [volumeStatus]: #volumestatus #### [volumeStatus] The current status of a network storage volume. -Type: **string** +Type: **string** + @@ -1023,7 +1144,8 @@ The current status of a network storage volume. [webccAccount]: #webccaccount #### [webccAccount] The account username and password for the EVault webCC interface. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -1033,7 +1155,8 @@ The account username and password for the EVault webCC interface. [weeklySchedule]: #weeklyschedule #### [weeklySchedule] The Weekly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -1045,7 +1168,8 @@ The Weekly Schedule which is associated with this network storage volume. [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of the currently active transactions on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1055,7 +1179,8 @@ A count of the currently active transactions on a network storage volume. [allowedHardwareCount]: #allowedhardwarecount #### [allowedHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1065,7 +1190,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedIpAddressCount]: #allowedipaddresscount #### [allowedIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1075,7 +1201,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationHardwareCount]: #allowedreplicationhardwarecount #### [allowedReplicationHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1085,7 +1212,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedReplicationIpAddressCount]: #allowedreplicationipaddresscount #### [allowedReplicationIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1095,7 +1223,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationSubnetCount]: #allowedreplicationsubnetcount #### [allowedReplicationSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1105,7 +1234,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedReplicationVirtualGuestCount]: #allowedreplicationvirtualguestcount #### [allowedReplicationVirtualGuestCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1115,7 +1245,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedSubnetCount]: #allowedsubnetcount #### [allowedSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1125,7 +1256,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedVirtualGuestCount]: #allowedvirtualguestcount #### [allowedVirtualGuestCount] A count of the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1135,7 +1267,8 @@ A count of the SoftLayer_Virtual_Guest objects which are allowed access to this [credentialCount]: #credentialcount #### [credentialCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1145,7 +1278,8 @@ A count of [dependentDuplicateCount]: #dependentduplicatecount #### [dependentDuplicateCount] A count of the network storage volumes configured to be dependent duplicates of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1155,7 +1289,8 @@ A count of the network storage volumes configured to be dependent duplicates of [eventCount]: #eventcount #### [eventCount] A count of the events which have taken place on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1165,7 +1300,8 @@ A count of the events which have taken place on a network storage volume. [iscsiLunCount]: #iscsiluncount #### [iscsiLunCount] A count of relationship between a container volume and iSCSI LUNs. -Type: **unsigned long** +Type: **unsigned long** + @@ -1175,7 +1311,8 @@ A count of relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddressCount]: #iscsitargetipaddresscount #### [iscsiTargetIpAddressCount] A count of returns the target IP addresses of an iSCSI volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1185,7 +1322,8 @@ A count of returns the target IP addresses of an iSCSI volume. [manualSnapshotCount]: #manualsnapshotcount #### [manualSnapshotCount] A count of the snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **unsigned long** +Type: **unsigned long** + @@ -1195,7 +1333,8 @@ A count of the snapshots associated with this SoftLayer_Network_Storage volume. [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of the subscribers that will be notified for usage amount warnings and overages. -Type: **unsigned long** +Type: **unsigned long** + @@ -1205,7 +1344,8 @@ A count of the subscribers that will be notified for usage amount warnings and o [parentPartnershipCount]: #parentpartnershipcount #### [parentPartnershipCount] A count of the volumes or snapshots partnered with a network storage volume in a parental role. -Type: **unsigned long** +Type: **unsigned long** + @@ -1215,7 +1355,8 @@ A count of the volumes or snapshots partnered with a network storage volume in a [partnershipCount]: #partnershipcount #### [partnershipCount] A count of the volumes or snapshots partnered with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1225,7 +1366,8 @@ A count of the volumes or snapshots partnered with a network storage volume. [permissionsGroupCount]: #permissionsgroupcount #### [permissionsGroupCount] A count of all permissions group(s) this volume is in. -Type: **unsigned long** +Type: **unsigned long** + @@ -1235,7 +1377,8 @@ A count of all permissions group(s) this volume is in. [propertyCount]: #propertycount #### [propertyCount] A count of the properties used to provide additional details about a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1245,7 +1388,8 @@ A count of the properties used to provide additional details about a network sto [replicatingLunCount]: #replicatingluncount #### [replicatingLunCount] A count of the iSCSI LUN volumes being replicated by this network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1255,7 +1399,8 @@ A count of the iSCSI LUN volumes being replicated by this network storage volume [replicationEventCount]: #replicationeventcount #### [replicationEventCount] A count of the volume replication events. -Type: **unsigned long** +Type: **unsigned long** + @@ -1265,7 +1410,8 @@ A count of the volume replication events. [replicationPartnerCount]: #replicationpartnercount #### [replicationPartnerCount] A count of the network storage volumes configured to be replicants of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1275,7 +1421,8 @@ A count of the network storage volumes configured to be replicants of a volume. [scheduleCount]: #schedulecount #### [scheduleCount] A count of the schedules which are associated with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1285,7 +1432,8 @@ A count of the schedules which are associated with a network storage volume. [snapshotCount]: #snapshotcount #### [snapshotCount] A count of the snapshots associated with this SoftLayer_Network_Storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1295,7 +1443,8 @@ A count of the snapshots associated with this SoftLayer_Network_Storage volume. [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of the network storage groups this volume is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1305,7 +1454,8 @@ A count of the network storage groups this volume is attached to. [volumeHistoryCount]: #volumehistorycount #### [volumeHistoryCount] A count of the username and password history for a Storage service. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi_OS_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi_OS_Type/_index.md index 05e25125c5..763970de09 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi_OS_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Iscsi_OS_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] The date this OS type record was created. -Type: **dateTime** +Type: **dateTime** +
      @@ -55,7 +58,8 @@ The date this OS type record was created. [description]: #description #### [description] The description of this OS type -Type: **string** +Type: **string** +
      @@ -65,7 +69,8 @@ The description of this OS type [id]: #id #### [id] The internal identifier of the OS type selection -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The internal identifier of the OS type selection [keyName]: #keyname #### [keyName] The key name of this OS type -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The key name of this OS type [name]: #name #### [name] The name of this OS type -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/_index.md index 5df132d7db..0248e8b75f 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [countryId]: #countryid #### [countryId] -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ classes: [locationGroupId]: #locationgroupid #### [locationGroupId] -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ classes: [country]: #country #### [country] SoftLayer_Locale_Country Id. -Type: **SoftLayer_Locale_Country ** +Type: **SoftLayer_Locale_Country ** + @@ -91,7 +97,8 @@ SoftLayer_Locale_Country Id. [locationGroup]: #locationgroup #### [locationGroup] Location Group ID of CleverSafe cross region. -Type: **SoftLayer_Location_Group ** +Type: **SoftLayer_Location_Group ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request/_index.md index 78f306b105..70d901a092 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Storage_MassDataMigration_Request data type contains infor [accountId]: #accountid #### [accountId] The account id of the request. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The account id of the request. [addressId]: #addressid #### [addressId] The address id of address assigned to this request. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The address id of address assigned to this request. [createUserId]: #createuserid #### [createUserId] The create user id of the request. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The create user id of the request. [endDate]: #enddate #### [endDate] The end date of the request. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The end date of the request. [id]: #id #### [id] The unique id of the request. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The unique id of the request. [modifyUserId]: #modifyuserid #### [modifyUserId] The modify user id of the request. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The modify user id of the request. [name]: #name #### [name] The unique id of the request. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The unique id of the request. [startDate]: #startdate #### [startDate] The start date of the request. -Type: **dateTime** +Type: **dateTime** + @@ -125,7 +135,8 @@ The start date of the request. [statusId]: #statusid #### [statusId] The status id of the request. -Type: **integer** +Type: **integer** + @@ -141,7 +152,8 @@ The status id of the request. [account]: #account #### [account] The account to which the request belongs. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -151,7 +163,8 @@ The account to which the request belongs. [activeTickets]: #activetickets #### [activeTickets] The active tickets that are attached to the MDMS request. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -161,7 +174,8 @@ The active tickets that are attached to the MDMS request. [address]: #address #### [address] The customer address where the device is shipped to. -Type: **SoftLayer_Account_Address ** +Type: **SoftLayer_Account_Address ** + @@ -171,7 +185,8 @@ The customer address where the device is shipped to. [billingItem]: #billingitem #### [billingItem] An associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -181,7 +196,8 @@ An associated parent billing item which is active. Includes billing items which [createEmployee]: #createemployee #### [createEmployee] The employee user who created the request. -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -191,7 +207,8 @@ The employee user who created the request. [createUser]: #createuser #### [createUser] The customer user who created the request. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -201,7 +218,8 @@ The customer user who created the request. [deviceConfiguration]: #deviceconfiguration #### [deviceConfiguration] The device configurations. -Type: **SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration ** +Type: **SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration ** + @@ -211,7 +229,8 @@ The device configurations. [deviceModel]: #devicemodel #### [deviceModel] The model of device assigned to this request. -Type: **string** +Type: **string** + @@ -221,7 +240,8 @@ The model of device assigned to this request. [keyContacts]: #keycontacts #### [keyContacts] The key contacts for this requests. -Type: **SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact[] ** +Type: **SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact[] ** + @@ -231,7 +251,8 @@ The key contacts for this requests. [modifyEmployee]: #modifyemployee #### [modifyEmployee] The employee who last modified the request. -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -241,7 +262,8 @@ The employee who last modified the request. [modifyUser]: #modifyuser #### [modifyUser] The customer user who last modified the request. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -251,7 +273,8 @@ The customer user who last modified the request. [shipments]: #shipments #### [shipments] The shipments of the request. -Type: **SoftLayer_Account_Shipment[] ** +Type: **SoftLayer_Account_Shipment[] ** + @@ -261,7 +284,8 @@ The shipments of the request. [status]: #status #### [status] The status of the request. -Type: **SoftLayer_Network_Storage_MassDataMigration_Request_Status ** +Type: **SoftLayer_Network_Storage_MassDataMigration_Request_Status ** + @@ -271,7 +295,8 @@ The status of the request. [ticket]: #ticket #### [ticket] Ticket that is attached to this mass data migration request. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -281,7 +306,8 @@ Ticket that is attached to this mass data migration request. [tickets]: #tickets #### [tickets] All tickets that are attached to the mass data migration request. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -293,7 +319,8 @@ All tickets that are attached to the mass data migration request. [activeTicketCount]: #activeticketcount #### [activeTicketCount] A count of the active tickets that are attached to the MDMS request. -Type: **unsigned long** +Type: **unsigned long** + @@ -303,7 +330,8 @@ A count of the active tickets that are attached to the MDMS request. [keyContactCount]: #keycontactcount #### [keyContactCount] A count of the key contacts for this requests. -Type: **unsigned long** +Type: **unsigned long** + @@ -313,7 +341,8 @@ A count of the key contacts for this requests. [shipmentCount]: #shipmentcount #### [shipmentCount] A count of the shipments of the request. -Type: **unsigned long** +Type: **unsigned long** + @@ -323,7 +352,8 @@ A count of the shipments of the request. [ticketCount]: #ticketcount #### [ticketCount] A count of all tickets that are attached to the mass data migration request. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration/_index.md index 547e82041c..396e6fbcc0 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration data [cosAccountId]: #cosaccountid #### [cosAccountId] The account id. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The account id. [cosBucket]: #cosbucket #### [cosBucket] The Cloud Object Storage bucket. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The Cloud Object Storage bucket. [eth1Gateway]: #eth1gateway #### [eth1Gateway] The eth1 gateway for connecting to private network in datacenter. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The eth1 gateway for connecting to private network in datacenter. [eth1IpAddress]: #eth1ipaddress #### [eth1IpAddress] The eth1 IP address for connecting to private network in datacenter. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The eth1 IP address for connecting to private network in datacenter. [eth1Netmask]: #eth1netmask #### [eth1Netmask] The eth1 netmask for connecting to private network in datacenter. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The eth1 netmask for connecting to private network in datacenter. [eth3Gateway]: #eth3gateway #### [eth3Gateway] The eth3 gateway for connecting to private network at customer's location. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The eth3 gateway for connecting to private network at customer's location. [eth3IpAddress]: #eth3ipaddress #### [eth3IpAddress] The eth3 IP address for connecting to private network at customer location. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The eth3 IP address for connecting to private network at customer location. [eth3Netmask]: #eth3netmask #### [eth3Netmask] The eth3 netmask for connecting to private network in at customer's location. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The eth3 netmask for connecting to private network in at customer's location. [id]: #id #### [id] The unique id of the request status. -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ The unique id of the request status. [password]: #password #### [password] The password for configuring network share. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The password for configuring network share. [poolLockPassword]: #poollockpassword #### [poolLockPassword] The pool lock password for configuring network share. -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ The pool lock password for configuring network share. [requestId]: #requestid #### [requestId] The request id. -Type: **integer** +Type: **integer** + @@ -165,7 +179,8 @@ The request id. [s3Url]: #s3url #### [s3Url] The Cloud Object Storage bucket URL. -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ The Cloud Object Storage bucket URL. [shareName]: #sharename #### [shareName] The name of network share. -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ The name of network share. [username]: #username #### [username] The username for configuring network share. -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ The username for configuring network share. [request]: #request #### [request] The request this device configurations belongs to. -Type: **SoftLayer_Network_Storage_MassDataMigration_Request ** +Type: **SoftLayer_Network_Storage_MassDataMigration_Request ** + @@ -211,7 +229,8 @@ The request this device configurations belongs to. [storageAccount]: #storageaccount #### [storageAccount] The storage account to use for this request. -Type: **SoftLayer_Network_Storage_Hub_Cleversafe_Account ** +Type: **SoftLayer_Network_Storage_Hub_Cleversafe_Account ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/_index.md index 8838fc603e..1f0990c839 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact data type con [accountId]: #accountid #### [accountId] An account number that is linked to a KeyContact. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ An account number that is linked to a KeyContact. [createDate]: #createdate #### [createDate] The date a KeyContact was created. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The date a KeyContact was created. [email]: #email #### [email] KeyContact's Email Id. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ KeyContact's Email Id. [id]: #id #### [id] The unique id of the key contact. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The unique id of the key contact. [modifyDate]: #modifydate #### [modifyDate] The date a KeyContact was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date a KeyContact was last modified. [name]: #name #### [name] KeyContact's Name. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ KeyContact's Name. [phone]: #phone #### [phone] A phone number assigned to a KeyContact. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ A phone number assigned to a KeyContact. [requestId]: #requestid #### [requestId] A request id that is linked to a KeyContact. -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ A request id that is linked to a KeyContact. [account]: #account #### [account] The request this key contact belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -141,7 +152,8 @@ The request this key contact belongs to. [request]: #request #### [request] The request this key contact belongs to. -Type: **SoftLayer_Network_Storage_MassDataMigration_Request ** +Type: **SoftLayer_Network_Storage_MassDataMigration_Request ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_Status/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_Status/_index.md index 01fb36b90a..ff115fa257 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Storage_MassDataMigration_Request_Status data type contain [description]: #description #### [description] The description of the request status. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The description of the request status. [id]: #id #### [id] The unique id of the request status. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The unique id of the request status. [keyName]: #keyname #### [keyName] The unique keyname of the request status. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The unique keyname of the request status. [name]: #name #### [name] The name of the request status. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Nas/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Nas/_index.md index a44b94b613..1c41ae2125 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Nas/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Nas/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Storage_Nas contains general information regarding a NAS S [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account that a Storage account belongs to. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of the SoftLayer customer account that a Storage account [capacityGb]: #capacitygb #### [capacityGb] A Storage account's capacity, measured in gigabytes. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A Storage account's capacity, measured in gigabytes. [createDate]: #createdate #### [createDate] The date a network storage volume was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date a network storage volume was created. [guestId]: #guestid #### [guestId] The unique identification number of the guest associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The unique identification number of the guest associated with a Storage volume. [hardwareId]: #hardwareid #### [hardwareId] The server that is associated with a Storage service. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The server that is associated with a Storage service. [hostId]: #hostid #### [hostId] The unique identification number of the host associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The unique identification number of the host associated with a Storage volume. [id]: #id #### [id] A Storage account's unique identifier. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A Storage account's unique identifier. [notes]: #notes #### [notes] Public notes related to a Storage volume. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ Public notes related to a Storage volume. [password]: #password #### [password] The password used to access a non-EVault Storage volume. This password is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The password used to access a non-EVault Storage volume. This password is used t [serviceProviderId]: #serviceproviderid #### [serviceProviderId] Service Provider ID -Type: **integer** +Type: **integer** + @@ -145,7 +157,8 @@ Service Provider ID [storageTypeId]: #storagetypeid #### [storageTypeId] A storage object's type. -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ A storage object's type. [upgradableFlag]: #upgradableflag #### [upgradableFlag] This flag indicates whether this storage type is upgradable or not. -Type: **boolean** +Type: **boolean** + @@ -165,7 +179,8 @@ This flag indicates whether this storage type is upgradable or not. [username]: #username #### [username] The username used to access a non-EVault Storage volume. This username is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ The username used to access a non-EVault Storage volume. This username is used t [account]: #account #### [account] The account that a Storage services belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -191,7 +207,8 @@ The account that a Storage services belongs to. [accountPassword]: #accountpassword #### [accountPassword] Other usernames and passwords associated with a Storage volume. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -201,7 +218,19 @@ Other usernames and passwords associated with a Storage volume. [activeTransactions]: #activetransactions #### [activeTransactions] The currently active transactions on a network storage volume. -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + + + + +
      + +----- +[allowDisasterRecoveryFailback]: #allowdisasterrecoveryfailback +#### [allowDisasterRecoveryFailback] + +Type: **string** +
      @@ -211,7 +240,8 @@ The currently active transactions on a network storage volume. [allowDisasterRecoveryFailover]: #allowdisasterrecoveryfailover #### [allowDisasterRecoveryFailover] -Type: **string** +Type: **string** + @@ -221,7 +251,8 @@ The currently active transactions on a network storage volume. [allowedHardware]: #allowedhardware #### [allowedHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -231,7 +262,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume. [allowedIpAddresses]: #allowedipaddresses #### [allowedIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -241,7 +273,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationHardware]: #allowedreplicationhardware #### [allowedReplicationHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -251,7 +284,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedReplicationIpAddresses]: #allowedreplicationipaddresses #### [allowedReplicationIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -261,7 +295,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationSubnets]: #allowedreplicationsubnets #### [allowedReplicationSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -271,7 +306,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedReplicationVirtualGuests]: #allowedreplicationvirtualguests #### [allowedReplicationVirtualGuests] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -281,7 +317,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedSubnets]: #allowedsubnets #### [allowedSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -291,7 +328,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedVirtualGuests]: #allowedvirtualguests #### [allowedVirtualGuests] The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -301,7 +339,8 @@ The SoftLayer_Virtual_Guest objects which are allowed access to this storage vol [billingItem]: #billingitem #### [billingItem] The current billing item for a Storage volume. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -311,7 +350,8 @@ The current billing item for a Storage volume. [billingItemCategory]: #billingitemcategory #### [billingItemCategory] -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -321,7 +361,8 @@ The current billing item for a Storage volume. [bytesUsed]: #bytesused #### [bytesUsed] The current amount of bytes used by a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -331,7 +372,8 @@ The current amount of bytes used by a volume. [creationScheduleId]: #creationscheduleid #### [creationScheduleId] The schedule id which was executed to create a snapshot. -Type: **string** +Type: **string** + @@ -341,7 +383,8 @@ The schedule id which was executed to create a snapshot. [credentials]: #credentials #### [credentials] -Type: **SoftLayer_Network_Storage_Credential[] ** +Type: **SoftLayer_Network_Storage_Credential[] ** + @@ -351,7 +394,8 @@ The schedule id which was executed to create a snapshot. [dailySchedule]: #dailyschedule #### [dailySchedule] The Daily Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -361,7 +405,8 @@ The Daily Schedule which is associated with this network storage volume. [dependentDuplicate]: #dependentduplicate #### [dependentDuplicate] Whether or not a network storage volume is a dependent duplicate. -Type: **string** +Type: **string** + @@ -371,7 +416,8 @@ Whether or not a network storage volume is a dependent duplicate. [dependentDuplicates]: #dependentduplicates #### [dependentDuplicates] The network storage volumes configured to be dependent duplicates of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -381,7 +427,8 @@ The network storage volumes configured to be dependent duplicates of a volume. [events]: #events #### [events] The events which have taken place on a network storage volume. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -391,7 +438,19 @@ The events which have taken place on a network storage volume. [failbackNotAllowed]: #failbacknotallowed #### [failbackNotAllowed] Determines whether the volume is allowed to failback -Type: **string** +Type: **string** + + + + +
      + +----- +[failoverNotAllowed]: #failovernotallowed +#### [failoverNotAllowed] +Determines whether the volume is allowed to failover +Type: **string** +
      @@ -401,7 +460,8 @@ Determines whether the volume is allowed to failback [fileNetworkMountAddress]: #filenetworkmountaddress #### [fileNetworkMountAddress] Retrieves the NFS Network Mount Address Name for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -411,7 +471,8 @@ Retrieves the NFS Network Mount Address Name for a given File Storage Volume. [hardware]: #hardware #### [hardware] When applicable, the hardware associated with a Storage service. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -421,7 +482,8 @@ When applicable, the hardware associated with a Storage service. [hasEncryptionAtRest]: #hasencryptionatrest #### [hasEncryptionAtRest] -Type: **boolean** +Type: **boolean** + @@ -431,7 +493,8 @@ When applicable, the hardware associated with a Storage service. [hourlySchedule]: #hourlyschedule #### [hourlySchedule] The Hourly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -441,7 +504,8 @@ The Hourly Schedule which is associated with this network storage volume. [intervalSchedule]: #intervalschedule #### [intervalSchedule] The Interval Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -451,7 +515,8 @@ The Interval Schedule which is associated with this network storage volume. [iops]: #iops #### [iops] The maximum number of IOPs selected for this volume. -Type: **string** +Type: **string** + @@ -461,7 +526,8 @@ The maximum number of IOPs selected for this volume. [isDependentDuplicateProvisionCompleted]: #isdependentduplicateprovisioncompleted #### [isDependentDuplicateProvisionCompleted] Determines whether dependent volume provision is completed on background. -Type: **boolean** +Type: **boolean** + @@ -471,7 +537,8 @@ Determines whether dependent volume provision is completed on background. [isInDedicatedServiceResource]: #isindedicatedserviceresource #### [isInDedicatedServiceResource] -Type: **boolean** +Type: **boolean** + @@ -481,7 +548,8 @@ Determines whether dependent volume provision is completed on background. [isMagneticStorage]: #ismagneticstorage #### [isMagneticStorage] -Type: **string** +Type: **string** + @@ -491,7 +559,8 @@ Determines whether dependent volume provision is completed on background. [isReadyForSnapshot]: #isreadyforsnapshot #### [isReadyForSnapshot] Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. -Type: **boolean** +Type: **boolean** + @@ -501,7 +570,8 @@ Determines whether a volume is ready to order snapshot space, or, if snapshot sp [isReadyToMount]: #isreadytomount #### [isReadyToMount] Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. -Type: **boolean** +Type: **boolean** + @@ -511,7 +581,8 @@ Determines whether a volume is ready to have Hosts authorized to access it. This [iscsiLuns]: #iscsiluns #### [iscsiLuns] Relationship between a container volume and iSCSI LUNs. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -521,7 +592,8 @@ Relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddresses]: #iscsitargetipaddresses #### [iscsiTargetIpAddresses] Returns the target IP addresses of an iSCSI volume. -Type: **array of strings** +Type: **array of strings** + @@ -531,7 +603,8 @@ Returns the target IP addresses of an iSCSI volume. [lunId]: #lunid #### [lunId] The ID of the LUN volume. -Type: **string** +Type: **string** + @@ -541,7 +614,8 @@ The ID of the LUN volume. [manualSnapshots]: #manualsnapshots #### [manualSnapshots] The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -551,7 +625,8 @@ The manually-created snapshots associated with this SoftLayer_Network_Storage vo [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A network storage volume's metric tracking object. This object records all periodic polled data available to this volume. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -561,7 +636,8 @@ A network storage volume's metric tracking object. This object records all perio [mountPath]: #mountpath #### [mountPath] Retrieves the NFS Network Mount Path for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -571,7 +647,8 @@ Retrieves the NFS Network Mount Path for a given File Storage Volume. [mountableFlag]: #mountableflag #### [mountableFlag] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -581,7 +658,8 @@ Whether or not a network storage volume may be mounted. [moveAndSplitStatus]: #moveandsplitstatus #### [moveAndSplitStatus] The current status of split or move operation as a part of volume duplication. -Type: **string** +Type: **string** + @@ -591,7 +669,8 @@ The current status of split or move operation as a part of volume duplication. [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] The subscribers that will be notified for usage amount warnings and overages. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -601,7 +680,8 @@ The subscribers that will be notified for usage amount warnings and overages. [originalSnapshotName]: #originalsnapshotname #### [originalSnapshotName] The name of the snapshot that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -611,7 +691,8 @@ The name of the snapshot that this volume was duplicated from. [originalVolumeName]: #originalvolumename #### [originalVolumeName] The name of the volume that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -621,7 +702,8 @@ The name of the volume that this volume was duplicated from. [originalVolumeSize]: #originalvolumesize #### [originalVolumeSize] The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. -Type: **string** +Type: **string** + @@ -631,7 +713,8 @@ The size (in GB) of the volume or LUN before any size expansion, or of the volum [osType]: #ostype #### [osType] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -641,7 +724,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. [osTypeId]: #ostypeid #### [osTypeId] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. -Type: **string** +Type: **string** + @@ -651,7 +735,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. [parentPartnerships]: #parentpartnerships #### [parentPartnerships] The volumes or snapshots partnered with a network storage volume in a parental role. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -661,7 +746,8 @@ The volumes or snapshots partnered with a network storage volume in a parental r [parentVolume]: #parentvolume #### [parentVolume] The parent volume of a volume in a complex storage relationship. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -671,7 +757,8 @@ The parent volume of a volume in a complex storage relationship. [partnerships]: #partnerships #### [partnerships] The volumes or snapshots partnered with a network storage volume. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -681,7 +768,8 @@ The volumes or snapshots partnered with a network storage volume. [permissionsGroups]: #permissionsgroups #### [permissionsGroups] All permissions group(s) this volume is in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -691,7 +779,8 @@ All permissions group(s) this volume is in. [properties]: #properties #### [properties] The properties used to provide additional details about a network storage volume. -Type: **SoftLayer_Network_Storage_Property[] ** +Type: **SoftLayer_Network_Storage_Property[] ** + @@ -701,7 +790,8 @@ The properties used to provide additional details about a network storage volume [provisionedIops]: #provisionediops #### [provisionedIops] The number of IOPs provisioned for this volume. -Type: **string** +Type: **string** + @@ -711,7 +801,8 @@ The number of IOPs provisioned for this volume. [recentBytesUsed]: #recentbytesused #### [recentBytesUsed] -Type: **SoftLayer_Network_Storage_Daily_Usage ** +Type: **SoftLayer_Network_Storage_Daily_Usage ** + @@ -721,7 +812,8 @@ The number of IOPs provisioned for this volume. [replicatingLuns]: #replicatingluns #### [replicatingLuns] The iSCSI LUN volumes being replicated by this network storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -731,7 +823,8 @@ The iSCSI LUN volumes being replicated by this network storage volume. [replicatingVolume]: #replicatingvolume #### [replicatingVolume] The network storage volume being replicated by a volume. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -741,7 +834,8 @@ The network storage volume being replicated by a volume. [replicationEvents]: #replicationevents #### [replicationEvents] The volume replication events. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -751,7 +845,8 @@ The volume replication events. [replicationPartners]: #replicationpartners #### [replicationPartners] The network storage volumes configured to be replicants of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -761,7 +856,8 @@ The network storage volumes configured to be replicants of a volume. [replicationSchedule]: #replicationschedule #### [replicationSchedule] The Replication Schedule associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -771,7 +867,8 @@ The Replication Schedule associated with a network storage volume. [replicationStatus]: #replicationstatus #### [replicationStatus] The current replication status of a network storage volume. Indicates Failover or Failback status. -Type: **string** +Type: **string** + @@ -781,7 +878,8 @@ The current replication status of a network storage volume. Indicates Failover o [schedules]: #schedules #### [schedules] The schedules which are associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule[] ** +Type: **SoftLayer_Network_Storage_Schedule[] ** + @@ -791,7 +889,8 @@ The schedules which are associated with a network storage volume. [serviceResource]: #serviceresource #### [serviceResource] The network resource a Storage service is connected to. -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -801,7 +900,8 @@ The network resource a Storage service is connected to. [serviceResourceBackendIpAddress]: #serviceresourcebackendipaddress #### [serviceResourceBackendIpAddress] The IP address of a Storage resource. -Type: **string** +Type: **string** + @@ -811,7 +911,8 @@ The IP address of a Storage resource. [serviceResourceName]: #serviceresourcename #### [serviceResourceName] The name of a Storage's network resource. -Type: **string** +Type: **string** + @@ -821,7 +922,8 @@ The name of a Storage's network resource. [snapshotCapacityGb]: #snapshotcapacitygb #### [snapshotCapacityGb] A volume's configured snapshot space size. -Type: **string** +Type: **string** + @@ -831,7 +933,8 @@ A volume's configured snapshot space size. [snapshotCreationTimestamp]: #snapshotcreationtimestamp #### [snapshotCreationTimestamp] The creation timestamp of the snapshot on the storage platform. -Type: **string** +Type: **string** + @@ -841,7 +944,8 @@ The creation timestamp of the snapshot on the storage platform. [snapshotDeletionThresholdPercentage]: #snapshotdeletionthresholdpercentage #### [snapshotDeletionThresholdPercentage] The percentage of used snapshot space after which to delete automated snapshots. -Type: **string** +Type: **string** + @@ -851,7 +955,8 @@ The percentage of used snapshot space after which to delete automated snapshots. [snapshotNotificationStatus]: #snapshotnotificationstatus #### [snapshotNotificationStatus] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -861,7 +966,8 @@ Whether or not a network storage volume may be mounted. [snapshotSizeBytes]: #snapshotsizebytes #### [snapshotSizeBytes] The snapshot size in bytes. -Type: **string** +Type: **string** + @@ -871,7 +977,8 @@ The snapshot size in bytes. [snapshotSpaceAvailable]: #snapshotspaceavailable #### [snapshotSpaceAvailable] A volume's available snapshot reservation space. -Type: **string** +Type: **string** + @@ -881,7 +988,8 @@ A volume's available snapshot reservation space. [snapshots]: #snapshots #### [snapshots] The snapshots associated with this SoftLayer_Network_Storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -891,7 +999,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [staasVersion]: #staasversion #### [staasVersion] -Type: **string** +Type: **string** + @@ -901,7 +1010,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [storageGroups]: #storagegroups #### [storageGroups] The network storage groups this volume is attached to. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -911,7 +1021,8 @@ The network storage groups this volume is attached to. [storageTierLevel]: #storagetierlevel #### [storageTierLevel] -Type: **string** +Type: **string** + @@ -921,7 +1032,8 @@ The network storage groups this volume is attached to. [storageType]: #storagetype #### [storageType] A description of the Storage object. -Type: **SoftLayer_Network_Storage_Type ** +Type: **SoftLayer_Network_Storage_Type ** + @@ -931,7 +1043,8 @@ A description of the Storage object. [totalBytesUsed]: #totalbytesused #### [totalBytesUsed] The amount of space used by the volume. -Type: **string** +Type: **string** + @@ -941,7 +1054,8 @@ The amount of space used by the volume. [totalScheduleSnapshotRetentionCount]: #totalschedulesnapshotretentioncount #### [totalScheduleSnapshotRetentionCount] The total snapshot retention count of all schedules on this network storage volume. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -951,7 +1065,8 @@ The total snapshot retention count of all schedules on this network storage volu [usageNotification]: #usagenotification #### [usageNotification] The usage notification for SL Storage services. -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -961,7 +1076,8 @@ The usage notification for SL Storage services. [vendorName]: #vendorname #### [vendorName] The type of network storage service. -Type: **string** +Type: **string** + @@ -971,7 +1087,8 @@ The type of network storage service. [virtualGuest]: #virtualguest #### [virtualGuest] When applicable, the virtual guest associated with a Storage service. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -981,7 +1098,8 @@ When applicable, the virtual guest associated with a Storage service. [volumeHistory]: #volumehistory #### [volumeHistory] The username and password history for a Storage service. -Type: **SoftLayer_Network_Storage_History[] ** +Type: **SoftLayer_Network_Storage_History[] ** + @@ -991,7 +1109,8 @@ The username and password history for a Storage service. [volumeStatus]: #volumestatus #### [volumeStatus] The current status of a network storage volume. -Type: **string** +Type: **string** + @@ -1001,7 +1120,8 @@ The current status of a network storage volume. [webccAccount]: #webccaccount #### [webccAccount] The account username and password for the EVault webCC interface. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -1011,7 +1131,8 @@ The account username and password for the EVault webCC interface. [weeklySchedule]: #weeklyschedule #### [weeklySchedule] The Weekly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -1023,7 +1144,8 @@ The Weekly Schedule which is associated with this network storage volume. [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of the currently active transactions on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1155,8 @@ A count of the currently active transactions on a network storage volume. [allowedHardwareCount]: #allowedhardwarecount #### [allowedHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1166,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedIpAddressCount]: #allowedipaddresscount #### [allowedIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1177,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationHardwareCount]: #allowedreplicationhardwarecount #### [allowedReplicationHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1188,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedReplicationIpAddressCount]: #allowedreplicationipaddresscount #### [allowedReplicationIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1199,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationSubnetCount]: #allowedreplicationsubnetcount #### [allowedReplicationSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1210,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedReplicationVirtualGuestCount]: #allowedreplicationvirtualguestcount #### [allowedReplicationVirtualGuestCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1093,7 +1221,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedSubnetCount]: #allowedsubnetcount #### [allowedSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1103,7 +1232,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedVirtualGuestCount]: #allowedvirtualguestcount #### [allowedVirtualGuestCount] A count of the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1113,7 +1243,8 @@ A count of the SoftLayer_Virtual_Guest objects which are allowed access to this [credentialCount]: #credentialcount #### [credentialCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1123,7 +1254,8 @@ A count of [dependentDuplicateCount]: #dependentduplicatecount #### [dependentDuplicateCount] A count of the network storage volumes configured to be dependent duplicates of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1133,7 +1265,8 @@ A count of the network storage volumes configured to be dependent duplicates of [eventCount]: #eventcount #### [eventCount] A count of the events which have taken place on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1143,7 +1276,8 @@ A count of the events which have taken place on a network storage volume. [iscsiLunCount]: #iscsiluncount #### [iscsiLunCount] A count of relationship between a container volume and iSCSI LUNs. -Type: **unsigned long** +Type: **unsigned long** + @@ -1153,7 +1287,8 @@ A count of relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddressCount]: #iscsitargetipaddresscount #### [iscsiTargetIpAddressCount] A count of returns the target IP addresses of an iSCSI volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1163,7 +1298,8 @@ A count of returns the target IP addresses of an iSCSI volume. [manualSnapshotCount]: #manualsnapshotcount #### [manualSnapshotCount] A count of the manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **unsigned long** +Type: **unsigned long** + @@ -1173,7 +1309,8 @@ A count of the manually-created snapshots associated with this SoftLayer_Network [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of the subscribers that will be notified for usage amount warnings and overages. -Type: **unsigned long** +Type: **unsigned long** + @@ -1183,7 +1320,8 @@ A count of the subscribers that will be notified for usage amount warnings and o [parentPartnershipCount]: #parentpartnershipcount #### [parentPartnershipCount] A count of the volumes or snapshots partnered with a network storage volume in a parental role. -Type: **unsigned long** +Type: **unsigned long** + @@ -1193,7 +1331,8 @@ A count of the volumes or snapshots partnered with a network storage volume in a [partnershipCount]: #partnershipcount #### [partnershipCount] A count of the volumes or snapshots partnered with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1203,7 +1342,8 @@ A count of the volumes or snapshots partnered with a network storage volume. [permissionsGroupCount]: #permissionsgroupcount #### [permissionsGroupCount] A count of all permissions group(s) this volume is in. -Type: **unsigned long** +Type: **unsigned long** + @@ -1213,7 +1353,8 @@ A count of all permissions group(s) this volume is in. [propertyCount]: #propertycount #### [propertyCount] A count of the properties used to provide additional details about a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1223,7 +1364,8 @@ A count of the properties used to provide additional details about a network sto [replicatingLunCount]: #replicatingluncount #### [replicatingLunCount] A count of the iSCSI LUN volumes being replicated by this network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1233,7 +1375,8 @@ A count of the iSCSI LUN volumes being replicated by this network storage volume [replicationEventCount]: #replicationeventcount #### [replicationEventCount] A count of the volume replication events. -Type: **unsigned long** +Type: **unsigned long** + @@ -1243,7 +1386,8 @@ A count of the volume replication events. [replicationPartnerCount]: #replicationpartnercount #### [replicationPartnerCount] A count of the network storage volumes configured to be replicants of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1253,7 +1397,8 @@ A count of the network storage volumes configured to be replicants of a volume. [scheduleCount]: #schedulecount #### [scheduleCount] A count of the schedules which are associated with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1263,7 +1408,8 @@ A count of the schedules which are associated with a network storage volume. [snapshotCount]: #snapshotcount #### [snapshotCount] A count of the snapshots associated with this SoftLayer_Network_Storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1273,7 +1419,8 @@ A count of the snapshots associated with this SoftLayer_Network_Storage volume. [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of the network storage groups this volume is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1283,7 +1430,8 @@ A count of the network storage groups this volume is attached to. [volumeHistoryCount]: #volumehistorycount #### [volumeHistoryCount] A count of the username and password history for a Storage service. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Partnership/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Partnership/_index.md index 8d6d390c0d..abd8a39003 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Partnership/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Partnership/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ A network storage partnership is used to link multiple volumes to each other. Th [createDate]: #createdate #### [createDate] The date a partnership was created. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The date a partnership was created. [modifyDate]: #modifydate #### [modifyDate] The date a partnership was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The date a partnership was last modified. [partnerVolumeId]: #partnervolumeid #### [partnerVolumeId] The child volume id which a partnership is associated with. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The child volume id which a partnership is associated with. [volumeId]: #volumeid #### [volumeId] The volume id which a partnership is associated with. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The volume id which a partnership is associated with. [partnerVolume]: #partnervolume #### [partnerVolume] The associated child volume for a partnership. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -101,7 +108,8 @@ The associated child volume for a partnership. [type]: #type #### [type] The type provides a standardized definition for a partnership. -Type: **SoftLayer_Network_Storage_Partnership_Type ** +Type: **SoftLayer_Network_Storage_Partnership_Type ** + @@ -111,7 +119,8 @@ The type provides a standardized definition for a partnership. [volume]: #volume #### [volume] The associated parent volume for a partnership. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Partnership_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Partnership_Type/_index.md index 093ec421fe..8eca8e8888 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Partnership_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Partnership_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A network storage partnership type is used to define the link between two volumes. @@ -45,7 +47,8 @@ A network storage partnership type is used to define the link between two volume [description]: #description #### [description] A type's description, for example 'ISCSI snapshot partnership'. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ A type's description, for example 'ISCSI snapshot partnership'. [keyname]: #keyname #### [keyname] A type's key name, for example 'ISCSI_SNAPSHOT'. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ A type's key name, for example 'ISCSI_SNAPSHOT'. [name]: #name #### [name] A type's name, for example 'ISCSI Snapshot'. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Property/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Property/_index.md index 1f80734f40..c47696cf67 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Property/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Property/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A property provides additional information about a volume which it is assigned to. This information can range from "Mountable" flags to utilized snapshot space. @@ -45,7 +47,8 @@ A property provides additional information about a volume which it is assigned t [createDate]: #createdate #### [createDate] The date a property was created. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The date a property was created. [modifyDate]: #modifydate #### [modifyDate] The date a property was last modified; -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The date a property was last modified; [value]: #value #### [value] The value of a property. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The value of a property. [volumeId]: #volumeid #### [volumeId] The volume id which a property is associated with. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The volume id which a property is associated with. [type]: #type #### [type] The type provides a standardized definition for a property. -Type: **SoftLayer_Network_Storage_Property_Type ** +Type: **SoftLayer_Network_Storage_Property_Type ** + @@ -101,7 +108,8 @@ The type provides a standardized definition for a property. [volume]: #volume #### [volume] The associated volume for a property. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Property_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Property_Type/_index.md index 3152e43af4..fa856133e5 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Property_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Property_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The storage property types provide standard definitions for properties which can [description]: #description #### [description] A type's description, for example 'Determines whether the volume is currently mountable'. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ A type's description, for example 'Determines whether the volume is currently mo [keyname]: #keyname #### [keyname] A type's keyname, for example 'MOUNTABLE'. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ A type's keyname, for example 'MOUNTABLE'. [name]: #name #### [name] A type's name, for example 'Mountable'. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Replicant/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Replicant/_index.md index 9dfba50b11..8cc104b7d2 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Replicant/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Replicant/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account that a Storage account belongs to. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The internal identifier of the SoftLayer customer account that a Storage account [capacityGb]: #capacitygb #### [capacityGb] A Storage account's capacity, measured in gigabytes. -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ A Storage account's capacity, measured in gigabytes. [createDate]: #createdate #### [createDate] The date a network storage volume was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date a network storage volume was created. [guestId]: #guestid #### [guestId] The unique identification number of the guest associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The unique identification number of the guest associated with a Storage volume. [hardwareId]: #hardwareid #### [hardwareId] The server that is associated with a Storage service. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The server that is associated with a Storage service. [hostId]: #hostid #### [hostId] The unique identification number of the host associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The unique identification number of the host associated with a Storage volume. [id]: #id #### [id] A Storage account's unique identifier. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A Storage account's unique identifier. [nasType]: #nastype #### [nasType] A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT", and "HUB". -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT" [notes]: #notes #### [notes] Public notes related to a Storage volume. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Public notes related to a Storage volume. [password]: #password #### [password] The password used to access a non-EVault Storage volume. This password is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The password used to access a non-EVault Storage volume. This password is used t [serviceProviderId]: #serviceproviderid #### [serviceProviderId] Service Provider ID -Type: **integer** +Type: **integer** + @@ -155,7 +168,8 @@ Service Provider ID [storageTypeId]: #storagetypeid #### [storageTypeId] A storage object's type. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ A storage object's type. [upgradableFlag]: #upgradableflag #### [upgradableFlag] This flag indicates whether this storage type is upgradable or not. -Type: **boolean** +Type: **boolean** + @@ -175,7 +190,8 @@ This flag indicates whether this storage type is upgradable or not. [username]: #username #### [username] The username used to access a non-EVault Storage volume. This username is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ The username used to access a non-EVault Storage volume. This username is used t [account]: #account #### [account] The account that a Storage services belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -201,7 +218,8 @@ The account that a Storage services belongs to. [accountPassword]: #accountpassword #### [accountPassword] Other usernames and passwords associated with a Storage volume. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -211,7 +229,8 @@ Other usernames and passwords associated with a Storage volume. [activeTransactions]: #activetransactions #### [activeTransactions] The currently active transactions on a network storage volume. -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + @@ -221,7 +240,8 @@ The currently active transactions on a network storage volume. [allowDisasterRecoveryFailback]: #allowdisasterrecoveryfailback #### [allowDisasterRecoveryFailback] -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The currently active transactions on a network storage volume. [allowDisasterRecoveryFailover]: #allowdisasterrecoveryfailover #### [allowDisasterRecoveryFailover] -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ The currently active transactions on a network storage volume. [allowedHardware]: #allowedhardware #### [allowedHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -251,7 +273,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume. [allowedIpAddresses]: #allowedipaddresses #### [allowedIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -261,7 +284,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationHardware]: #allowedreplicationhardware #### [allowedReplicationHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -271,7 +295,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedReplicationIpAddresses]: #allowedreplicationipaddresses #### [allowedReplicationIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -281,7 +306,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationSubnets]: #allowedreplicationsubnets #### [allowedReplicationSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -291,7 +317,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedReplicationVirtualGuests]: #allowedreplicationvirtualguests #### [allowedReplicationVirtualGuests] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -301,7 +328,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedSubnets]: #allowedsubnets #### [allowedSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -311,7 +339,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedVirtualGuests]: #allowedvirtualguests #### [allowedVirtualGuests] The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -321,7 +350,8 @@ The SoftLayer_Virtual_Guest objects which are allowed access to this storage vol [billingItem]: #billingitem #### [billingItem] The current billing item for this network storage replicant volume. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -331,7 +361,8 @@ The current billing item for this network storage replicant volume. [billingItemCategory]: #billingitemcategory #### [billingItemCategory] -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -341,7 +372,8 @@ The current billing item for this network storage replicant volume. [bytesUsed]: #bytesused #### [bytesUsed] The amount of space used by the volume, in bytes. -Type: **string** +Type: **string** + @@ -351,7 +383,8 @@ The amount of space used by the volume, in bytes. [creationScheduleId]: #creationscheduleid #### [creationScheduleId] The schedule id which was executed to create a snapshot. -Type: **string** +Type: **string** + @@ -361,7 +394,8 @@ The schedule id which was executed to create a snapshot. [credentials]: #credentials #### [credentials] -Type: **SoftLayer_Network_Storage_Credential[] ** +Type: **SoftLayer_Network_Storage_Credential[] ** + @@ -371,7 +405,8 @@ The schedule id which was executed to create a snapshot. [dailySchedule]: #dailyschedule #### [dailySchedule] The Daily Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -381,7 +416,8 @@ The Daily Schedule which is associated with this network storage volume. [dependentDuplicate]: #dependentduplicate #### [dependentDuplicate] Whether or not a network storage volume is a dependent duplicate. -Type: **string** +Type: **string** + @@ -391,7 +427,8 @@ Whether or not a network storage volume is a dependent duplicate. [dependentDuplicates]: #dependentduplicates #### [dependentDuplicates] The network storage volumes configured to be dependent duplicates of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -401,7 +438,8 @@ The network storage volumes configured to be dependent duplicates of a volume. [events]: #events #### [events] The events which have taken place on a network storage volume. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -411,7 +449,8 @@ The events which have taken place on a network storage volume. [failbackInProgressFlag]: #failbackinprogressflag #### [failbackInProgressFlag] When a replicant is in the process of synchronizing with the parent volume this flag will be true. -Type: **string** +Type: **string** + @@ -421,7 +460,8 @@ When a replicant is in the process of synchronizing with the parent volume this [failbackNotAllowed]: #failbacknotallowed #### [failbackNotAllowed] Determines whether the volume is allowed to failback -Type: **string** +Type: **string** + @@ -431,7 +471,8 @@ Determines whether the volume is allowed to failback [failoverNotAllowed]: #failovernotallowed #### [failoverNotAllowed] Determines whether the volume is allowed to failover -Type: **string** +Type: **string** + @@ -441,7 +482,8 @@ Determines whether the volume is allowed to failover [fileNetworkMountAddress]: #filenetworkmountaddress #### [fileNetworkMountAddress] Retrieves the NFS Network Mount Address Name for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -451,7 +493,8 @@ Retrieves the NFS Network Mount Address Name for a given File Storage Volume. [hardware]: #hardware #### [hardware] When applicable, the hardware associated with a Storage service. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -461,7 +504,8 @@ When applicable, the hardware associated with a Storage service. [hasEncryptionAtRest]: #hasencryptionatrest #### [hasEncryptionAtRest] -Type: **boolean** +Type: **boolean** + @@ -471,7 +515,8 @@ When applicable, the hardware associated with a Storage service. [hourlySchedule]: #hourlyschedule #### [hourlySchedule] The Hourly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -481,7 +526,8 @@ The Hourly Schedule which is associated with this network storage volume. [intervalSchedule]: #intervalschedule #### [intervalSchedule] The Interval Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -491,7 +537,8 @@ The Interval Schedule which is associated with this network storage volume. [iops]: #iops #### [iops] The maximum number of IOPs selected for this volume. -Type: **string** +Type: **string** + @@ -501,7 +548,8 @@ The maximum number of IOPs selected for this volume. [isDependentDuplicateProvisionCompleted]: #isdependentduplicateprovisioncompleted #### [isDependentDuplicateProvisionCompleted] Determines whether dependent volume provision is completed on background. -Type: **boolean** +Type: **boolean** + @@ -511,7 +559,8 @@ Determines whether dependent volume provision is completed on background. [isInDedicatedServiceResource]: #isindedicatedserviceresource #### [isInDedicatedServiceResource] -Type: **boolean** +Type: **boolean** + @@ -521,7 +570,8 @@ Determines whether dependent volume provision is completed on background. [isMagneticStorage]: #ismagneticstorage #### [isMagneticStorage] -Type: **string** +Type: **string** + @@ -531,7 +581,8 @@ Determines whether dependent volume provision is completed on background. [isReadyForSnapshot]: #isreadyforsnapshot #### [isReadyForSnapshot] Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. -Type: **boolean** +Type: **boolean** + @@ -541,7 +592,8 @@ Determines whether a volume is ready to order snapshot space, or, if snapshot sp [isReadyToMount]: #isreadytomount #### [isReadyToMount] Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. -Type: **boolean** +Type: **boolean** + @@ -551,7 +603,8 @@ Determines whether a volume is ready to have Hosts authorized to access it. This [iscsiLuns]: #iscsiluns #### [iscsiLuns] Relationship between a container volume and iSCSI LUNs. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -561,7 +614,8 @@ Relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddresses]: #iscsitargetipaddresses #### [iscsiTargetIpAddresses] Returns the target IP addresses of an iSCSI volume. -Type: **array of strings** +Type: **array of strings** + @@ -571,7 +625,8 @@ Returns the target IP addresses of an iSCSI volume. [lunId]: #lunid #### [lunId] The ID of the LUN volume. -Type: **string** +Type: **string** + @@ -581,7 +636,8 @@ The ID of the LUN volume. [manualSnapshots]: #manualsnapshots #### [manualSnapshots] The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -591,7 +647,8 @@ The manually-created snapshots associated with this SoftLayer_Network_Storage vo [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A network storage volume's metric tracking object. This object records all periodic polled data available to this volume. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -601,7 +658,8 @@ A network storage volume's metric tracking object. This object records all perio [mountPath]: #mountpath #### [mountPath] Retrieves the NFS Network Mount Path for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -611,7 +669,8 @@ Retrieves the NFS Network Mount Path for a given File Storage Volume. [mountableFlag]: #mountableflag #### [mountableFlag] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -621,7 +680,8 @@ Whether or not a network storage volume may be mounted. [moveAndSplitStatus]: #moveandsplitstatus #### [moveAndSplitStatus] The current status of split or move operation as a part of volume duplication. -Type: **string** +Type: **string** + @@ -631,7 +691,8 @@ The current status of split or move operation as a part of volume duplication. [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] The subscribers that will be notified for usage amount warnings and overages. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -641,7 +702,8 @@ The subscribers that will be notified for usage amount warnings and overages. [originalSnapshotName]: #originalsnapshotname #### [originalSnapshotName] The name of the snapshot that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -651,7 +713,8 @@ The name of the snapshot that this volume was duplicated from. [originalVolumeName]: #originalvolumename #### [originalVolumeName] The name of the volume that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -661,7 +724,8 @@ The name of the volume that this volume was duplicated from. [originalVolumeSize]: #originalvolumesize #### [originalVolumeSize] The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. -Type: **string** +Type: **string** + @@ -671,7 +735,8 @@ The size (in GB) of the volume or LUN before any size expansion, or of the volum [osType]: #ostype #### [osType] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -681,7 +746,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. [osTypeId]: #ostypeid #### [osTypeId] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. -Type: **string** +Type: **string** + @@ -691,7 +757,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. [parentPartnerships]: #parentpartnerships #### [parentPartnerships] The volumes or snapshots partnered with a network storage volume in a parental role. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -701,7 +768,8 @@ The volumes or snapshots partnered with a network storage volume in a parental r [parentVolume]: #parentvolume #### [parentVolume] The volume for which a replicant is receiving incoming data for. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -711,7 +779,8 @@ The volume for which a replicant is receiving incoming data for. [partnerships]: #partnerships #### [partnerships] The volumes or snapshots partnered with a network storage volume. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -721,7 +790,8 @@ The volumes or snapshots partnered with a network storage volume. [permissionsGroups]: #permissionsgroups #### [permissionsGroups] The permissions groups this replicant volume is in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -731,7 +801,8 @@ The permissions groups this replicant volume is in. [properties]: #properties #### [properties] The properties used to provide additional details about a network storage volume. -Type: **SoftLayer_Network_Storage_Property[] ** +Type: **SoftLayer_Network_Storage_Property[] ** + @@ -741,7 +812,8 @@ The properties used to provide additional details about a network storage volume [provisionedIops]: #provisionediops #### [provisionedIops] The number of IOPs provisioned for this volume. -Type: **string** +Type: **string** + @@ -751,7 +823,8 @@ The number of IOPs provisioned for this volume. [replicatingLuns]: #replicatingluns #### [replicatingLuns] The iSCSI LUN volumes being replicated by this network storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -761,7 +834,8 @@ The iSCSI LUN volumes being replicated by this network storage volume. [replicatingVolume]: #replicatingvolume #### [replicatingVolume] The network storage volume being replicated by a volume. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -771,7 +845,8 @@ The network storage volume being replicated by a volume. [replicationEvents]: #replicationevents #### [replicationEvents] The volume replication events. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -781,7 +856,8 @@ The volume replication events. [replicationPartners]: #replicationpartners #### [replicationPartners] The network storage volumes configured to be replicants of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -791,7 +867,8 @@ The network storage volumes configured to be replicants of a volume. [replicationSchedule]: #replicationschedule #### [replicationSchedule] The Replication Schedule associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -801,7 +878,8 @@ The Replication Schedule associated with a network storage volume. [replicationStatus]: #replicationstatus #### [replicationStatus] The current replication status of a network storage volume. Indicates Failover or Failback status. -Type: **string** +Type: **string** + @@ -811,7 +889,8 @@ The current replication status of a network storage volume. Indicates Failover o [schedules]: #schedules #### [schedules] The schedules which are associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule[] ** +Type: **SoftLayer_Network_Storage_Schedule[] ** + @@ -821,7 +900,8 @@ The schedules which are associated with a network storage volume. [serviceResource]: #serviceresource #### [serviceResource] The network resource a Storage service is connected to. -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -831,7 +911,8 @@ The network resource a Storage service is connected to. [serviceResourceBackendIpAddress]: #serviceresourcebackendipaddress #### [serviceResourceBackendIpAddress] The IP address of a Storage resource. -Type: **string** +Type: **string** + @@ -841,7 +922,8 @@ The IP address of a Storage resource. [serviceResourceName]: #serviceresourcename #### [serviceResourceName] The name of a Storage's network resource. -Type: **string** +Type: **string** + @@ -851,7 +933,8 @@ The name of a Storage's network resource. [snapshotCapacityGb]: #snapshotcapacitygb #### [snapshotCapacityGb] A volume's configured snapshot space size. -Type: **string** +Type: **string** + @@ -861,7 +944,8 @@ A volume's configured snapshot space size. [snapshotCreationTimestamp]: #snapshotcreationtimestamp #### [snapshotCreationTimestamp] The creation timestamp of the snapshot on the storage platform. -Type: **string** +Type: **string** + @@ -871,7 +955,8 @@ The creation timestamp of the snapshot on the storage platform. [snapshotDeletionThresholdPercentage]: #snapshotdeletionthresholdpercentage #### [snapshotDeletionThresholdPercentage] The percentage of used snapshot space after which to delete automated snapshots. -Type: **string** +Type: **string** + @@ -881,7 +966,8 @@ The percentage of used snapshot space after which to delete automated snapshots. [snapshotNotificationStatus]: #snapshotnotificationstatus #### [snapshotNotificationStatus] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -891,7 +977,8 @@ Whether or not a network storage volume may be mounted. [snapshotSizeBytes]: #snapshotsizebytes #### [snapshotSizeBytes] The snapshot size in bytes. -Type: **string** +Type: **string** + @@ -901,7 +988,8 @@ The snapshot size in bytes. [snapshotSpaceAvailable]: #snapshotspaceavailable #### [snapshotSpaceAvailable] A volume's available snapshot reservation space. -Type: **string** +Type: **string** + @@ -911,7 +999,8 @@ A volume's available snapshot reservation space. [snapshots]: #snapshots #### [snapshots] The snapshots associated with this SoftLayer_Network_Storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -921,7 +1010,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [staasVersion]: #staasversion #### [staasVersion] -Type: **string** +Type: **string** + @@ -931,7 +1021,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [storageGroups]: #storagegroups #### [storageGroups] The network storage groups this volume is attached to. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -941,7 +1032,8 @@ The network storage groups this volume is attached to. [storageTierLevel]: #storagetierlevel #### [storageTierLevel] -Type: **string** +Type: **string** + @@ -951,7 +1043,8 @@ The network storage groups this volume is attached to. [storageType]: #storagetype #### [storageType] A description of the Storage object. -Type: **SoftLayer_Network_Storage_Type ** +Type: **SoftLayer_Network_Storage_Type ** + @@ -961,7 +1054,8 @@ A description of the Storage object. [totalBytesUsed]: #totalbytesused #### [totalBytesUsed] The amount of space used by the volume. -Type: **string** +Type: **string** + @@ -971,7 +1065,8 @@ The amount of space used by the volume. [totalScheduleSnapshotRetentionCount]: #totalschedulesnapshotretentioncount #### [totalScheduleSnapshotRetentionCount] The total snapshot retention count of all schedules on this network storage volume. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -981,7 +1076,8 @@ The total snapshot retention count of all schedules on this network storage volu [usageNotification]: #usagenotification #### [usageNotification] The usage notification for SL Storage services. -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -991,7 +1087,8 @@ The usage notification for SL Storage services. [vendorName]: #vendorname #### [vendorName] The type of network storage service. -Type: **string** +Type: **string** + @@ -1001,7 +1098,8 @@ The type of network storage service. [virtualGuest]: #virtualguest #### [virtualGuest] When applicable, the virtual guest associated with a Storage service. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -1011,7 +1109,8 @@ When applicable, the virtual guest associated with a Storage service. [volumeHistory]: #volumehistory #### [volumeHistory] The username and password history for a Storage service. -Type: **SoftLayer_Network_Storage_History[] ** +Type: **SoftLayer_Network_Storage_History[] ** + @@ -1021,7 +1120,8 @@ The username and password history for a Storage service. [volumeName]: #volumename #### [volumeName] The volume name for a replicant. -Type: **string** +Type: **string** + @@ -1031,7 +1131,8 @@ The volume name for a replicant. [volumeStatus]: #volumestatus #### [volumeStatus] The current status of a network storage volume. -Type: **string** +Type: **string** + @@ -1041,7 +1142,8 @@ The current status of a network storage volume. [webccAccount]: #webccaccount #### [webccAccount] The account username and password for the EVault webCC interface. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -1051,7 +1153,8 @@ The account username and password for the EVault webCC interface. [weeklySchedule]: #weeklyschedule #### [weeklySchedule] The Weekly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -1063,7 +1166,8 @@ The Weekly Schedule which is associated with this network storage volume. [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of the currently active transactions on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of the currently active transactions on a network storage volume. [allowedHardwareCount]: #allowedhardwarecount #### [allowedHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1188,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedIpAddressCount]: #allowedipaddresscount #### [allowedIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1093,7 +1199,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationHardwareCount]: #allowedreplicationhardwarecount #### [allowedReplicationHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1103,7 +1210,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedReplicationIpAddressCount]: #allowedreplicationipaddresscount #### [allowedReplicationIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1113,7 +1221,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationSubnetCount]: #allowedreplicationsubnetcount #### [allowedReplicationSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1123,7 +1232,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedReplicationVirtualGuestCount]: #allowedreplicationvirtualguestcount #### [allowedReplicationVirtualGuestCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1133,7 +1243,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedSubnetCount]: #allowedsubnetcount #### [allowedSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1143,7 +1254,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedVirtualGuestCount]: #allowedvirtualguestcount #### [allowedVirtualGuestCount] A count of the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1153,7 +1265,8 @@ A count of the SoftLayer_Virtual_Guest objects which are allowed access to this [credentialCount]: #credentialcount #### [credentialCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1163,7 +1276,8 @@ A count of [dependentDuplicateCount]: #dependentduplicatecount #### [dependentDuplicateCount] A count of the network storage volumes configured to be dependent duplicates of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1173,7 +1287,8 @@ A count of the network storage volumes configured to be dependent duplicates of [eventCount]: #eventcount #### [eventCount] A count of the events which have taken place on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1183,7 +1298,8 @@ A count of the events which have taken place on a network storage volume. [iscsiLunCount]: #iscsiluncount #### [iscsiLunCount] A count of relationship between a container volume and iSCSI LUNs. -Type: **unsigned long** +Type: **unsigned long** + @@ -1193,7 +1309,8 @@ A count of relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddressCount]: #iscsitargetipaddresscount #### [iscsiTargetIpAddressCount] A count of returns the target IP addresses of an iSCSI volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1203,7 +1320,8 @@ A count of returns the target IP addresses of an iSCSI volume. [manualSnapshotCount]: #manualsnapshotcount #### [manualSnapshotCount] A count of the manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **unsigned long** +Type: **unsigned long** + @@ -1213,7 +1331,8 @@ A count of the manually-created snapshots associated with this SoftLayer_Network [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of the subscribers that will be notified for usage amount warnings and overages. -Type: **unsigned long** +Type: **unsigned long** + @@ -1223,7 +1342,8 @@ A count of the subscribers that will be notified for usage amount warnings and o [parentPartnershipCount]: #parentpartnershipcount #### [parentPartnershipCount] A count of the volumes or snapshots partnered with a network storage volume in a parental role. -Type: **unsigned long** +Type: **unsigned long** + @@ -1233,7 +1353,8 @@ A count of the volumes or snapshots partnered with a network storage volume in a [partnershipCount]: #partnershipcount #### [partnershipCount] A count of the volumes or snapshots partnered with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1243,7 +1364,8 @@ A count of the volumes or snapshots partnered with a network storage volume. [permissionsGroupCount]: #permissionsgroupcount #### [permissionsGroupCount] A count of the permissions groups this replicant volume is in. -Type: **unsigned long** +Type: **unsigned long** + @@ -1253,7 +1375,8 @@ A count of the permissions groups this replicant volume is in. [propertyCount]: #propertycount #### [propertyCount] A count of the properties used to provide additional details about a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1263,7 +1386,8 @@ A count of the properties used to provide additional details about a network sto [replicatingLunCount]: #replicatingluncount #### [replicatingLunCount] A count of the iSCSI LUN volumes being replicated by this network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1273,7 +1397,8 @@ A count of the iSCSI LUN volumes being replicated by this network storage volume [replicationEventCount]: #replicationeventcount #### [replicationEventCount] A count of the volume replication events. -Type: **unsigned long** +Type: **unsigned long** + @@ -1283,7 +1408,8 @@ A count of the volume replication events. [replicationPartnerCount]: #replicationpartnercount #### [replicationPartnerCount] A count of the network storage volumes configured to be replicants of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1293,7 +1419,8 @@ A count of the network storage volumes configured to be replicants of a volume. [scheduleCount]: #schedulecount #### [scheduleCount] A count of the schedules which are associated with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1303,7 +1430,8 @@ A count of the schedules which are associated with a network storage volume. [snapshotCount]: #snapshotcount #### [snapshotCount] A count of the snapshots associated with this SoftLayer_Network_Storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1313,7 +1441,8 @@ A count of the snapshots associated with this SoftLayer_Network_Storage volume. [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of the network storage groups this volume is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1323,7 +1452,8 @@ A count of the network storage groups this volume is attached to. [volumeHistoryCount]: #volumehistorycount #### [volumeHistoryCount] A count of the username and password history for a Storage service. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Schedule/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Schedule/_index.md index d667abadda..70d50b5680 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Schedule/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Schedule/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ Schedules can be created for select Storage services, such as iscsi. These sched [active]: #active #### [active] A flag which determines if a schedule is active. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ A flag which determines if a schedule is active. [createDate]: #createdate #### [createDate] The date a schedule was created. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The date a schedule was created. [id]: #id #### [id] A schedule's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A schedule's internal identifier. [modifyDate]: #modifydate #### [modifyDate] The date a schedule was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The date a schedule was last modified. [name]: #name #### [name] A schedule's name, for example 'Daily'. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ A schedule's name, for example 'Daily'. [partnershipId]: #partnershipid #### [partnershipId] The partnership id which a schedule is associated with. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The partnership id which a schedule is associated with. [typeId]: #typeid #### [typeId] The type id which a schedule is associated with. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ The type id which a schedule is associated with. [volumeId]: #volumeid #### [volumeId] The volume id which a schedule is associated with. -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ The volume id which a schedule is associated with. [day]: #day #### [day] The hour parameter of this schedule. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ The hour parameter of this schedule. [dayOfMonth]: #dayofmonth #### [dayOfMonth] The day of the month parameter of this schedule. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ The day of the month parameter of this schedule. [dayOfWeek]: #dayofweek #### [dayOfWeek] The day of the week parameter of this schedule. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ The day of the week parameter of this schedule. [events]: #events #### [events] Events which have been created as the result of a schedule execution. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -171,7 +185,8 @@ Events which have been created as the result of a schedule execution. [hour]: #hour #### [hour] The hour parameter of this schedule. -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ The hour parameter of this schedule. [minute]: #minute #### [minute] The minute parameter of this schedule. -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ The minute parameter of this schedule. [monthOfYear]: #monthofyear #### [monthOfYear] The month of the year parameter of this schedule. -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ The month of the year parameter of this schedule. [partnership]: #partnership #### [partnership] The associated partnership for a schedule. -Type: **SoftLayer_Network_Storage_Partnership ** +Type: **SoftLayer_Network_Storage_Partnership ** + @@ -211,7 +229,8 @@ The associated partnership for a schedule. [properties]: #properties #### [properties] Properties used for configuration of a schedule. -Type: **SoftLayer_Network_Storage_Schedule_Property[] ** +Type: **SoftLayer_Network_Storage_Schedule_Property[] ** + @@ -221,7 +240,8 @@ Properties used for configuration of a schedule. [replicaSnapshots]: #replicasnapshots #### [replicaSnapshots] Replica snapshots which have been created as the result of this schedule's execution. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -231,7 +251,8 @@ Replica snapshots which have been created as the result of this schedule's execu [retentionCount]: #retentioncount #### [retentionCount] The number of snapshots this schedule is configured to retain. -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ The number of snapshots this schedule is configured to retain. [second]: #second #### [second] The minute parameter of this schedule. -Type: **string** +Type: **string** + @@ -251,7 +273,8 @@ The minute parameter of this schedule. [snapshots]: #snapshots #### [snapshots] Snapshots which have been created as the result of this schedule's execution. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -261,7 +284,8 @@ Snapshots which have been created as the result of this schedule's execution. [type]: #type #### [type] The type provides a standardized definition for a schedule. -Type: **SoftLayer_Network_Storage_Schedule_Type ** +Type: **SoftLayer_Network_Storage_Schedule_Type ** + @@ -271,7 +295,8 @@ The type provides a standardized definition for a schedule. [volume]: #volume #### [volume] The associated volume for a schedule. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -283,7 +308,8 @@ The associated volume for a schedule. [eventCount]: #eventcount #### [eventCount] A count of events which have been created as the result of a schedule execution. -Type: **unsigned long** +Type: **unsigned long** + @@ -293,7 +319,8 @@ A count of events which have been created as the result of a schedule execution. [propertyCount]: #propertycount #### [propertyCount] A count of properties used for configuration of a schedule. -Type: **unsigned long** +Type: **unsigned long** + @@ -303,7 +330,8 @@ A count of properties used for configuration of a schedule. [replicaSnapshotCount]: #replicasnapshotcount #### [replicaSnapshotCount] A count of replica snapshots which have been created as the result of this schedule's execution. -Type: **unsigned long** +Type: **unsigned long** + @@ -313,7 +341,8 @@ A count of replica snapshots which have been created as the result of this sched [snapshotCount]: #snapshotcount #### [snapshotCount] A count of snapshots which have been created as the result of this schedule's execution. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Schedule_Property/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Schedule_Property/_index.md index e6c17eb08b..7e33922549 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Schedule_Property/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Schedule_Property/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Schedule properties provide attributes such as start date, end date, interval, and other properties to a storage schedule. @@ -45,7 +47,8 @@ Schedule properties provide attributes such as start date, end date, interval, a [createDate]: #createdate #### [createDate] The date a schedule property was created. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The date a schedule property was created. [id]: #id #### [id] A schedule property's internal identifier. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A schedule property's internal identifier. [modifyDate]: #modifydate #### [modifyDate] The date a schedule property was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date a schedule property was last modified. [typeId]: #typeid #### [typeId] An identifier for the type of a property. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ An identifier for the type of a property. [value]: #value #### [value] The value of a property. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The value of a property. [schedule]: #schedule #### [schedule] The associated schedule for a property. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -111,7 +119,8 @@ The associated schedule for a property. [type]: #type #### [type] The type provides a standardized definition for a property. -Type: **SoftLayer_Network_Storage_Schedule_Property_Type ** +Type: **SoftLayer_Network_Storage_Schedule_Property_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Schedule_Property_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Schedule_Property_Type/_index.md index 33fa028f1b..4284d1d719 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Schedule_Property_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Schedule_Property_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A schedule property type is used to allow for a standardized method of defining network storage schedules. @@ -45,7 +47,8 @@ A schedule property type is used to allow for a standardized method of defining [description]: #description #### [description] A type's description, for example 'Date for the schedule to start.'. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ A type's description, for example 'Date for the schedule to start.'. [id]: #id #### [id] A schedule property type's internal identifier. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A schedule property type's internal identifier. [keyname]: #keyname #### [keyname] A schedule property type's key name, for example 'START_DATE'. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A schedule property type's key name, for example 'START_DATE'. [name]: #name #### [name] A schedule property type's name, for example 'Start Date'. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ A schedule property type's name, for example 'Start Date'. [nasType]: #nastype #### [nasType] The type of Storage volume type which a property type may be associated with. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Schedule_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Schedule_Type/_index.md index f133c7f420..6739ae01fc 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Schedule_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Schedule_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ A schedule type is used to define what a schedule was created to do. When creati [id]: #id #### [id] A schedule type's internal identifier. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ A schedule type's internal identifier. [keyname]: #keyname #### [keyname] A schedule type's key name, for example 'SNAPSHOT'. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ A schedule type's key name, for example 'SNAPSHOT'. [name]: #name #### [name] A schedule type's name, for example 'Snapshot'. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Snapshot/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Snapshot/_index.md index 19cbd188f9..9a776ffae4 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Snapshot/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Snapshot/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account that a Storage account belongs to. -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ The internal identifier of the SoftLayer customer account that a Storage account [capacityGb]: #capacitygb #### [capacityGb] A Storage account's capacity, measured in gigabytes. -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ A Storage account's capacity, measured in gigabytes. [createDate]: #createdate #### [createDate] The date a network storage volume was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date a network storage volume was created. [guestId]: #guestid #### [guestId] The unique identification number of the guest associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The unique identification number of the guest associated with a Storage volume. [hardwareId]: #hardwareid #### [hardwareId] The server that is associated with a Storage service. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The server that is associated with a Storage service. [hostId]: #hostid #### [hostId] The unique identification number of the host associated with a Storage volume. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The unique identification number of the host associated with a Storage volume. [id]: #id #### [id] A Storage account's unique identifier. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ A Storage account's unique identifier. [nasType]: #nastype #### [nasType] A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT", and "HUB". -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT" [notes]: #notes #### [notes] Public notes related to a Storage volume. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Public notes related to a Storage volume. [password]: #password #### [password] The password used to access a non-EVault Storage volume. This password is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ The password used to access a non-EVault Storage volume. This password is used t [serviceProviderId]: #serviceproviderid #### [serviceProviderId] Service Provider ID -Type: **integer** +Type: **integer** + @@ -155,7 +168,8 @@ Service Provider ID [storageTypeId]: #storagetypeid #### [storageTypeId] A storage object's type. -Type: **string** +Type: **string** + @@ -165,7 +179,8 @@ A storage object's type. [upgradableFlag]: #upgradableflag #### [upgradableFlag] This flag indicates whether this storage type is upgradable or not. -Type: **boolean** +Type: **boolean** + @@ -175,7 +190,8 @@ This flag indicates whether this storage type is upgradable or not. [username]: #username #### [username] The username used to access a non-EVault Storage volume. This username is used to register the EVault server agent with the vault backup system. -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ The username used to access a non-EVault Storage volume. This username is used t [account]: #account #### [account] The account that a Storage services belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -201,7 +218,8 @@ The account that a Storage services belongs to. [accountPassword]: #accountpassword #### [accountPassword] Other usernames and passwords associated with a Storage volume. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -211,7 +229,19 @@ Other usernames and passwords associated with a Storage volume. [activeTransactions]: #activetransactions #### [activeTransactions] The currently active transactions on a network storage volume. -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + + + + +
      + +----- +[allowDisasterRecoveryFailback]: #allowdisasterrecoveryfailback +#### [allowDisasterRecoveryFailback] + +Type: **string** +
      @@ -221,7 +251,8 @@ The currently active transactions on a network storage volume. [allowDisasterRecoveryFailover]: #allowdisasterrecoveryfailover #### [allowDisasterRecoveryFailover] -Type: **string** +Type: **string** + @@ -231,7 +262,8 @@ The currently active transactions on a network storage volume. [allowedHardware]: #allowedhardware #### [allowedHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -241,7 +273,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume. [allowedIpAddresses]: #allowedipaddresses #### [allowedIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -251,7 +284,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationHardware]: #allowedreplicationhardware #### [allowedReplicationHardware] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -261,7 +295,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedReplicationIpAddresses]: #allowedreplicationipaddresses #### [allowedReplicationIpAddresses] The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -271,7 +306,8 @@ The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this [allowedReplicationSubnets]: #allowedreplicationsubnets #### [allowedReplicationSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -281,7 +317,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedReplicationVirtualGuests]: #allowedreplicationvirtualguests #### [allowedReplicationVirtualGuests] The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -291,7 +328,8 @@ The SoftLayer_Hardware objects which are allowed access to this storage volume's [allowedSubnets]: #allowedsubnets #### [allowedSubnets] The SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -301,7 +339,8 @@ The SoftLayer_Network_Subnet objects which are allowed access to this storage vo [allowedVirtualGuests]: #allowedvirtualguests #### [allowedVirtualGuests] The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -311,7 +350,8 @@ The SoftLayer_Virtual_Guest objects which are allowed access to this storage vol [billingItem]: #billingitem #### [billingItem] The current billing item for a Storage volume. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -321,7 +361,8 @@ The current billing item for a Storage volume. [billingItemCategory]: #billingitemcategory #### [billingItemCategory] -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -331,7 +372,8 @@ The current billing item for a Storage volume. [bytesUsed]: #bytesused #### [bytesUsed] The amount of space used by the volume, in bytes. -Type: **string** +Type: **string** + @@ -341,7 +383,8 @@ The amount of space used by the volume, in bytes. [creationSchedule]: #creationschedule #### [creationSchedule] If applicable, the schedule which was executed to create a snapshot. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -351,7 +394,8 @@ If applicable, the schedule which was executed to create a snapshot. [creationScheduleId]: #creationscheduleid #### [creationScheduleId] The schedule id which was executed to create a snapshot. -Type: **string** +Type: **string** + @@ -361,7 +405,8 @@ The schedule id which was executed to create a snapshot. [credentials]: #credentials #### [credentials] -Type: **SoftLayer_Network_Storage_Credential[] ** +Type: **SoftLayer_Network_Storage_Credential[] ** + @@ -371,7 +416,8 @@ The schedule id which was executed to create a snapshot. [dailySchedule]: #dailyschedule #### [dailySchedule] The Daily Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -381,7 +427,8 @@ The Daily Schedule which is associated with this network storage volume. [dependentDuplicate]: #dependentduplicate #### [dependentDuplicate] Whether or not a network storage volume is a dependent duplicate. -Type: **string** +Type: **string** + @@ -391,7 +438,8 @@ Whether or not a network storage volume is a dependent duplicate. [dependentDuplicates]: #dependentduplicates #### [dependentDuplicates] The network storage volumes configured to be dependent duplicates of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -401,7 +449,8 @@ The network storage volumes configured to be dependent duplicates of a volume. [events]: #events #### [events] The events which have taken place on a network storage volume. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -411,7 +460,19 @@ The events which have taken place on a network storage volume. [failbackNotAllowed]: #failbacknotallowed #### [failbackNotAllowed] Determines whether the volume is allowed to failback -Type: **string** +Type: **string** + + + + +
      + +----- +[failoverNotAllowed]: #failovernotallowed +#### [failoverNotAllowed] +Determines whether the volume is allowed to failover +Type: **string** +
      @@ -421,7 +482,8 @@ Determines whether the volume is allowed to failback [fileNetworkMountAddress]: #filenetworkmountaddress #### [fileNetworkMountAddress] Retrieves the NFS Network Mount Address Name for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -431,7 +493,8 @@ Retrieves the NFS Network Mount Address Name for a given File Storage Volume. [hardware]: #hardware #### [hardware] When applicable, the hardware associated with a Storage service. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -441,7 +504,8 @@ When applicable, the hardware associated with a Storage service. [hasEncryptionAtRest]: #hasencryptionatrest #### [hasEncryptionAtRest] -Type: **boolean** +Type: **boolean** + @@ -451,7 +515,8 @@ When applicable, the hardware associated with a Storage service. [hourlySchedule]: #hourlyschedule #### [hourlySchedule] The Hourly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -461,7 +526,8 @@ The Hourly Schedule which is associated with this network storage volume. [intervalSchedule]: #intervalschedule #### [intervalSchedule] The Interval Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -471,7 +537,8 @@ The Interval Schedule which is associated with this network storage volume. [iops]: #iops #### [iops] The maximum number of IOPs selected for this volume. -Type: **string** +Type: **string** + @@ -481,7 +548,8 @@ The maximum number of IOPs selected for this volume. [isDependentDuplicateProvisionCompleted]: #isdependentduplicateprovisioncompleted #### [isDependentDuplicateProvisionCompleted] Determines whether dependent volume provision is completed on background. -Type: **boolean** +Type: **boolean** + @@ -491,7 +559,8 @@ Determines whether dependent volume provision is completed on background. [isInDedicatedServiceResource]: #isindedicatedserviceresource #### [isInDedicatedServiceResource] -Type: **boolean** +Type: **boolean** + @@ -501,7 +570,8 @@ Determines whether dependent volume provision is completed on background. [isMagneticStorage]: #ismagneticstorage #### [isMagneticStorage] -Type: **string** +Type: **string** + @@ -511,7 +581,8 @@ Determines whether dependent volume provision is completed on background. [isReadyForSnapshot]: #isreadyforsnapshot #### [isReadyForSnapshot] Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. -Type: **boolean** +Type: **boolean** + @@ -521,7 +592,8 @@ Determines whether a volume is ready to order snapshot space, or, if snapshot sp [isReadyToMount]: #isreadytomount #### [isReadyToMount] Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. -Type: **boolean** +Type: **boolean** + @@ -531,7 +603,8 @@ Determines whether a volume is ready to have Hosts authorized to access it. This [iscsiLuns]: #iscsiluns #### [iscsiLuns] Relationship between a container volume and iSCSI LUNs. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -541,7 +614,8 @@ Relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddresses]: #iscsitargetipaddresses #### [iscsiTargetIpAddresses] Returns the target IP addresses of an iSCSI volume. -Type: **array of strings** +Type: **array of strings** + @@ -551,7 +625,8 @@ Returns the target IP addresses of an iSCSI volume. [lunId]: #lunid #### [lunId] The ID of the LUN volume. -Type: **string** +Type: **string** + @@ -561,7 +636,8 @@ The ID of the LUN volume. [manualSnapshots]: #manualsnapshots #### [manualSnapshots] The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -571,7 +647,8 @@ The manually-created snapshots associated with this SoftLayer_Network_Storage vo [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A network storage volume's metric tracking object. This object records all periodic polled data available to this volume. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -581,7 +658,8 @@ A network storage volume's metric tracking object. This object records all perio [mountPath]: #mountpath #### [mountPath] Retrieves the NFS Network Mount Path for a given File Storage Volume. -Type: **string** +Type: **string** + @@ -591,7 +669,8 @@ Retrieves the NFS Network Mount Path for a given File Storage Volume. [mountableFlag]: #mountableflag #### [mountableFlag] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -601,7 +680,8 @@ Whether or not a network storage volume may be mounted. [moveAndSplitStatus]: #moveandsplitstatus #### [moveAndSplitStatus] The current status of split or move operation as a part of volume duplication. -Type: **string** +Type: **string** + @@ -611,7 +691,8 @@ The current status of split or move operation as a part of volume duplication. [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] The subscribers that will be notified for usage amount warnings and overages. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -621,7 +702,8 @@ The subscribers that will be notified for usage amount warnings and overages. [originalSnapshotName]: #originalsnapshotname #### [originalSnapshotName] The name of the snapshot that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -631,7 +713,8 @@ The name of the snapshot that this volume was duplicated from. [originalVolumeName]: #originalvolumename #### [originalVolumeName] The name of the volume that this volume was duplicated from. -Type: **string** +Type: **string** + @@ -641,7 +724,8 @@ The name of the volume that this volume was duplicated from. [originalVolumeSize]: #originalvolumesize #### [originalVolumeSize] The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. -Type: **string** +Type: **string** + @@ -651,7 +735,8 @@ The size (in GB) of the volume or LUN before any size expansion, or of the volum [osType]: #ostype #### [osType] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. -Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** +Type: **SoftLayer_Network_Storage_Iscsi_OS_Type ** + @@ -661,7 +746,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. [osTypeId]: #ostypeid #### [osTypeId] A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. -Type: **string** +Type: **string** + @@ -671,7 +757,8 @@ A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. [parentPartnerships]: #parentpartnerships #### [parentPartnerships] The volumes or snapshots partnered with a network storage volume in a parental role. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -681,7 +768,8 @@ The volumes or snapshots partnered with a network storage volume in a parental r [parentVolume]: #parentvolume #### [parentVolume] The volume for which a snapshot is associated with. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -691,7 +779,8 @@ The volume for which a snapshot is associated with. [partnerships]: #partnerships #### [partnerships] The volumes or snapshots partnered with a network storage volume. -Type: **SoftLayer_Network_Storage_Partnership[] ** +Type: **SoftLayer_Network_Storage_Partnership[] ** + @@ -701,7 +790,8 @@ The volumes or snapshots partnered with a network storage volume. [permissionsGroups]: #permissionsgroups #### [permissionsGroups] All permissions group(s) this volume is in. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -711,7 +801,8 @@ All permissions group(s) this volume is in. [properties]: #properties #### [properties] The properties used to provide additional details about a network storage volume. -Type: **SoftLayer_Network_Storage_Property[] ** +Type: **SoftLayer_Network_Storage_Property[] ** + @@ -721,7 +812,8 @@ The properties used to provide additional details about a network storage volume [provisionedIops]: #provisionediops #### [provisionedIops] The number of IOPs provisioned for this volume. -Type: **string** +Type: **string** + @@ -731,7 +823,8 @@ The number of IOPs provisioned for this volume. [replicatingLuns]: #replicatingluns #### [replicatingLuns] The iSCSI LUN volumes being replicated by this network storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -741,7 +834,8 @@ The iSCSI LUN volumes being replicated by this network storage volume. [replicatingVolume]: #replicatingvolume #### [replicatingVolume] The network storage volume being replicated by a volume. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -751,7 +845,8 @@ The network storage volume being replicated by a volume. [replicationEvents]: #replicationevents #### [replicationEvents] The volume replication events. -Type: **SoftLayer_Network_Storage_Event[] ** +Type: **SoftLayer_Network_Storage_Event[] ** + @@ -761,7 +856,8 @@ The volume replication events. [replicationPartners]: #replicationpartners #### [replicationPartners] The network storage volumes configured to be replicants of a volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -771,7 +867,8 @@ The network storage volumes configured to be replicants of a volume. [replicationSchedule]: #replicationschedule #### [replicationSchedule] The Replication Schedule associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -781,7 +878,8 @@ The Replication Schedule associated with a network storage volume. [replicationStatus]: #replicationstatus #### [replicationStatus] The current replication status of a network storage volume. Indicates Failover or Failback status. -Type: **string** +Type: **string** + @@ -791,7 +889,8 @@ The current replication status of a network storage volume. Indicates Failover o [schedules]: #schedules #### [schedules] The schedules which are associated with a network storage volume. -Type: **SoftLayer_Network_Storage_Schedule[] ** +Type: **SoftLayer_Network_Storage_Schedule[] ** + @@ -801,7 +900,8 @@ The schedules which are associated with a network storage volume. [serviceResource]: #serviceresource #### [serviceResource] The network resource a Storage service is connected to. -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -811,7 +911,8 @@ The network resource a Storage service is connected to. [serviceResourceBackendIpAddress]: #serviceresourcebackendipaddress #### [serviceResourceBackendIpAddress] The IP address of a Storage resource. -Type: **string** +Type: **string** + @@ -821,7 +922,8 @@ The IP address of a Storage resource. [serviceResourceName]: #serviceresourcename #### [serviceResourceName] The name of a Storage's network resource. -Type: **string** +Type: **string** + @@ -831,7 +933,8 @@ The name of a Storage's network resource. [snapshotCapacityGb]: #snapshotcapacitygb #### [snapshotCapacityGb] A volume's configured snapshot space size. -Type: **string** +Type: **string** + @@ -841,7 +944,8 @@ A volume's configured snapshot space size. [snapshotCreationTimestamp]: #snapshotcreationtimestamp #### [snapshotCreationTimestamp] The creation timestamp of the snapshot on the storage platform. -Type: **string** +Type: **string** + @@ -851,7 +955,8 @@ The creation timestamp of the snapshot on the storage platform. [snapshotDeletionThresholdPercentage]: #snapshotdeletionthresholdpercentage #### [snapshotDeletionThresholdPercentage] The percentage of used snapshot space after which to delete automated snapshots. -Type: **string** +Type: **string** + @@ -861,7 +966,8 @@ The percentage of used snapshot space after which to delete automated snapshots. [snapshotNotificationStatus]: #snapshotnotificationstatus #### [snapshotNotificationStatus] Whether or not a network storage volume may be mounted. -Type: **string** +Type: **string** + @@ -871,7 +977,8 @@ Whether or not a network storage volume may be mounted. [snapshotSizeBytes]: #snapshotsizebytes #### [snapshotSizeBytes] The snapshot size in bytes. -Type: **string** +Type: **string** + @@ -881,7 +988,8 @@ The snapshot size in bytes. [snapshotSpaceAvailable]: #snapshotspaceavailable #### [snapshotSpaceAvailable] A volume's available snapshot reservation space. -Type: **string** +Type: **string** + @@ -891,7 +999,8 @@ A volume's available snapshot reservation space. [snapshots]: #snapshots #### [snapshots] The snapshots associated with this SoftLayer_Network_Storage volume. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -901,7 +1010,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [staasVersion]: #staasversion #### [staasVersion] -Type: **string** +Type: **string** + @@ -911,7 +1021,8 @@ The snapshots associated with this SoftLayer_Network_Storage volume. [storageGroups]: #storagegroups #### [storageGroups] The network storage groups this volume is attached to. -Type: **SoftLayer_Network_Storage_Group[] ** +Type: **SoftLayer_Network_Storage_Group[] ** + @@ -921,7 +1032,8 @@ The network storage groups this volume is attached to. [storageTierLevel]: #storagetierlevel #### [storageTierLevel] -Type: **string** +Type: **string** + @@ -931,7 +1043,8 @@ The network storage groups this volume is attached to. [storageType]: #storagetype #### [storageType] A description of the Storage object. -Type: **SoftLayer_Network_Storage_Type ** +Type: **SoftLayer_Network_Storage_Type ** + @@ -941,7 +1054,8 @@ A description of the Storage object. [totalBytesUsed]: #totalbytesused #### [totalBytesUsed] The amount of space used by the volume. -Type: **string** +Type: **string** + @@ -951,7 +1065,8 @@ The amount of space used by the volume. [totalScheduleSnapshotRetentionCount]: #totalschedulesnapshotretentioncount #### [totalScheduleSnapshotRetentionCount] The total snapshot retention count of all schedules on this network storage volume. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -961,7 +1076,8 @@ The total snapshot retention count of all schedules on this network storage volu [usageNotification]: #usagenotification #### [usageNotification] The usage notification for SL Storage services. -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -971,7 +1087,8 @@ The usage notification for SL Storage services. [vendorName]: #vendorname #### [vendorName] The type of network storage service. -Type: **string** +Type: **string** + @@ -981,7 +1098,8 @@ The type of network storage service. [virtualGuest]: #virtualguest #### [virtualGuest] When applicable, the virtual guest associated with a Storage service. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -991,7 +1109,8 @@ When applicable, the virtual guest associated with a Storage service. [volumeHistory]: #volumehistory #### [volumeHistory] The username and password history for a Storage service. -Type: **SoftLayer_Network_Storage_History[] ** +Type: **SoftLayer_Network_Storage_History[] ** + @@ -1001,7 +1120,8 @@ The username and password history for a Storage service. [volumeName]: #volumename #### [volumeName] The volume name for the snapshot. -Type: **string** +Type: **string** + @@ -1011,7 +1131,8 @@ The volume name for the snapshot. [volumeStatus]: #volumestatus #### [volumeStatus] The current status of a network storage volume. -Type: **string** +Type: **string** + @@ -1021,7 +1142,8 @@ The current status of a network storage volume. [webccAccount]: #webccaccount #### [webccAccount] The account username and password for the EVault webCC interface. -Type: **SoftLayer_Account_Password ** +Type: **SoftLayer_Account_Password ** + @@ -1031,7 +1153,8 @@ The account username and password for the EVault webCC interface. [weeklySchedule]: #weeklyschedule #### [weeklySchedule] The Weekly Schedule which is associated with this network storage volume. -Type: **SoftLayer_Network_Storage_Schedule ** +Type: **SoftLayer_Network_Storage_Schedule ** + @@ -1043,7 +1166,8 @@ The Weekly Schedule which is associated with this network storage volume. [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of the currently active transactions on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1177,8 @@ A count of the currently active transactions on a network storage volume. [allowedHardwareCount]: #allowedhardwarecount #### [allowedHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1188,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedIpAddressCount]: #allowedipaddresscount #### [allowedIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1199,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationHardwareCount]: #allowedreplicationhardwarecount #### [allowedReplicationHardwareCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1210,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedReplicationIpAddressCount]: #allowedreplicationipaddresscount #### [allowedReplicationIpAddressCount] A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1093,7 +1221,8 @@ A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed acce [allowedReplicationSubnetCount]: #allowedreplicationsubnetcount #### [allowedReplicationSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1103,7 +1232,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedReplicationVirtualGuestCount]: #allowedreplicationvirtualguestcount #### [allowedReplicationVirtualGuestCount] A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. -Type: **unsigned long** +Type: **unsigned long** + @@ -1113,7 +1243,8 @@ A count of the SoftLayer_Hardware objects which are allowed access to this stora [allowedSubnetCount]: #allowedsubnetcount #### [allowedSubnetCount] A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1123,7 +1254,8 @@ A count of the SoftLayer_Network_Subnet objects which are allowed access to this [allowedVirtualGuestCount]: #allowedvirtualguestcount #### [allowedVirtualGuestCount] A count of the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1133,7 +1265,8 @@ A count of the SoftLayer_Virtual_Guest objects which are allowed access to this [credentialCount]: #credentialcount #### [credentialCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1143,7 +1276,8 @@ A count of [dependentDuplicateCount]: #dependentduplicatecount #### [dependentDuplicateCount] A count of the network storage volumes configured to be dependent duplicates of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1153,7 +1287,8 @@ A count of the network storage volumes configured to be dependent duplicates of [eventCount]: #eventcount #### [eventCount] A count of the events which have taken place on a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1163,7 +1298,8 @@ A count of the events which have taken place on a network storage volume. [iscsiLunCount]: #iscsiluncount #### [iscsiLunCount] A count of relationship between a container volume and iSCSI LUNs. -Type: **unsigned long** +Type: **unsigned long** + @@ -1173,7 +1309,8 @@ A count of relationship between a container volume and iSCSI LUNs. [iscsiTargetIpAddressCount]: #iscsitargetipaddresscount #### [iscsiTargetIpAddressCount] A count of returns the target IP addresses of an iSCSI volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1183,7 +1320,8 @@ A count of returns the target IP addresses of an iSCSI volume. [manualSnapshotCount]: #manualsnapshotcount #### [manualSnapshotCount] A count of the manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -Type: **unsigned long** +Type: **unsigned long** + @@ -1193,7 +1331,8 @@ A count of the manually-created snapshots associated with this SoftLayer_Network [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of the subscribers that will be notified for usage amount warnings and overages. -Type: **unsigned long** +Type: **unsigned long** + @@ -1203,7 +1342,8 @@ A count of the subscribers that will be notified for usage amount warnings and o [parentPartnershipCount]: #parentpartnershipcount #### [parentPartnershipCount] A count of the volumes or snapshots partnered with a network storage volume in a parental role. -Type: **unsigned long** +Type: **unsigned long** + @@ -1213,7 +1353,8 @@ A count of the volumes or snapshots partnered with a network storage volume in a [partnershipCount]: #partnershipcount #### [partnershipCount] A count of the volumes or snapshots partnered with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1223,7 +1364,8 @@ A count of the volumes or snapshots partnered with a network storage volume. [permissionsGroupCount]: #permissionsgroupcount #### [permissionsGroupCount] A count of all permissions group(s) this volume is in. -Type: **unsigned long** +Type: **unsigned long** + @@ -1233,7 +1375,8 @@ A count of all permissions group(s) this volume is in. [propertyCount]: #propertycount #### [propertyCount] A count of the properties used to provide additional details about a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1243,7 +1386,8 @@ A count of the properties used to provide additional details about a network sto [replicatingLunCount]: #replicatingluncount #### [replicatingLunCount] A count of the iSCSI LUN volumes being replicated by this network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1253,7 +1397,8 @@ A count of the iSCSI LUN volumes being replicated by this network storage volume [replicationEventCount]: #replicationeventcount #### [replicationEventCount] A count of the volume replication events. -Type: **unsigned long** +Type: **unsigned long** + @@ -1263,7 +1408,8 @@ A count of the volume replication events. [replicationPartnerCount]: #replicationpartnercount #### [replicationPartnerCount] A count of the network storage volumes configured to be replicants of a volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1273,7 +1419,8 @@ A count of the network storage volumes configured to be replicants of a volume. [scheduleCount]: #schedulecount #### [scheduleCount] A count of the schedules which are associated with a network storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1283,7 +1430,8 @@ A count of the schedules which are associated with a network storage volume. [snapshotCount]: #snapshotcount #### [snapshotCount] A count of the snapshots associated with this SoftLayer_Network_Storage volume. -Type: **unsigned long** +Type: **unsigned long** + @@ -1293,7 +1441,8 @@ A count of the snapshots associated with this SoftLayer_Network_Storage volume. [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of the network storage groups this volume is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1303,7 +1452,8 @@ A count of the network storage groups this volume is attached to. [volumeHistoryCount]: #volumehistorycount #### [volumeHistoryCount] A count of the username and password history for a Storage service. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Storage_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Storage_Type/_index.md index 4b79db4346..737d1b61d2 100644 --- a/content/reference/datatypes/SoftLayer_Network_Storage_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Storage_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Storage_Type contains a description of the associated SoftLayer_Network_Storage object. @@ -45,7 +47,8 @@ The SoftLayer_Network_Storage_Type contains a description of the associated Soft [description]: #description #### [description] Human readable description for the associated SoftLayer_Network_Storage object. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Human readable description for the associated SoftLayer_Network_Storage object. [id]: #id #### [id] ID which corresponds with storageTypeId on storage objects. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ ID which corresponds with storageTypeId on storage objects. [keyName]: #keyname #### [keyName] Machine readable description code for the associated SoftLayer_Network_Storage object. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ Machine readable description code for the associated SoftLayer_Network_Storage o [volumes]: #volumes #### [volumes] The SoftLayer_Network_Storage object that uses this type. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -93,7 +99,8 @@ The SoftLayer_Network_Storage object that uses this type. [volumeCount]: #volumecount #### [volumeCount] A count of the SoftLayer_Network_Storage object that uses this type. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet/_index.md b/content/reference/datatypes/SoftLayer_Network_Subnet/_index.md index 6756ce7151..2e0bbe8e6d 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Subnet data type contains general information relating to a single SoftLayer subnet. 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. ### External Links @@ -65,7 +67,8 @@ The SoftLayer_Network_Subnet data type contains general information relating to [broadcastAddress]: #broadcastaddress #### [broadcastAddress] The last IP address in a subnet is the subnet's broadcast address. This is an IP address that will broadcast network requests to the entire subnet and may not be assigned to a network interface. -Type: **string** +Type: **string** + @@ -75,7 +78,8 @@ The last IP address in a subnet is the subnet's broadcast address. This is an IP [cidr]: #cidr #### [cidr] A subnet's Classless Inter-Domain Routing prefix. This is a number between 0 and 32 signifying the number of bits in a subnet's netmask. These bits separate a subnet's network address from it's host addresses. It performs the same function as the ''netmask'' property, but is represented as an integer. -Type: **integer** +Type: **integer** + @@ -85,7 +89,8 @@ A subnet's Classless Inter-Domain Routing prefix. This is a number between 0 and [gateway]: #gateway #### [gateway] A subnet's gateway address. This is an IP address that belongs to the router on the subnet and may not be assigned to a network interface. -Type: **string** +Type: **string** + @@ -95,7 +100,8 @@ A subnet's gateway address. This is an IP address that belongs to the router on [id]: #id #### [id] A subnet's internal identifier. -Type: **integer** +Type: **integer** + @@ -105,7 +111,8 @@ A subnet's internal identifier. [isCustomerOwned]: #iscustomerowned #### [isCustomerOwned] -Type: **boolean** +Type: **boolean** + @@ -115,7 +122,8 @@ A subnet's internal identifier. [isCustomerRoutable]: #iscustomerroutable #### [isCustomerRoutable] -Type: **boolean** +Type: **boolean** + @@ -125,7 +133,8 @@ A subnet's internal identifier. [modifyDate]: #modifydate #### [modifyDate] The last time this subnet was last modified -Type: **dateTime** +Type: **dateTime** + @@ -135,7 +144,8 @@ The last time this subnet was last modified [netmask]: #netmask #### [netmask] A bitmask in dotted-quad format that is used to separate a subnet's network address from it's host addresses. This performs the same function as the ''cidr'' property, but is expressed in a string format. -Type: **string** +Type: **string** + @@ -145,7 +155,8 @@ A bitmask in dotted-quad format that is used to separate a subnet's network addr [networkIdentifier]: #networkidentifier #### [networkIdentifier] A subnet's network identifier. This is the first IP address of a subnet and may not be assigned to a network interface. -Type: **string** +Type: **string** + @@ -155,7 +166,8 @@ A subnet's network identifier. This is the first IP address of a subnet and may [networkVlanId]: #networkvlanid #### [networkVlanId] A subnet's associated VLAN's internal identifier. -Type: **integer** +Type: **integer** + @@ -165,7 +177,8 @@ A subnet's associated VLAN's internal identifier. [note]: #note #### [note] This is the note field. -Type: **string** +Type: **string** + @@ -175,7 +188,8 @@ This is the note field. [sortOrder]: #sortorder #### [sortOrder] Used to sort subnets and group subnets of similar type together for use on customer facing portals. -Type: **string** +Type: **string** + @@ -194,7 +208,8 @@ A subnet type can be any of the following: * STATIC_IP_ROUTED_6 * GLOBAL_IP A "PRIMARY" subnet is the primary network bound to a VLAN within the softlayer network. An "ADDITIONAL_PRIMARY" subnet is bound to a network VLAN to augment the pool of available primary IP addresses that may be assigned to a server. A "SECONDARY_ON_VLAN" subnet is a secondary portable subnet whose IP addresses are managed by the end user. "STATIC_IP_ROUTED" subnets are subnets that are statically routed to a single endpoint IP address. A "PRIMARY_6" subnet is the primary IPv6 network bound to a VLAN. A "SUBNET_ON_VLAN" subnet is the secondary portable IPv6 subnet whose IP addresses are managed by the end user. A "STATIC_IP_ROUTED_6" subnet is statically routed to a single IPv6 endpoint IP address. A "GLOBAL_IP" subnet is a subnet that is routable to a single endpoint IP address. The "GLOBAL_IP" type is used for both IPv4 and IPv6 subnets. -Type: **string** +Type: **string** + @@ -204,7 +219,8 @@ A "PRIMARY" subnet is the primary network bound to a VLAN within the softlayer n [totalIpAddresses]: #totalipaddresses #### [totalIpAddresses] The number of IP addresses contained within this subnet. -Type: **decimal** +Type: **decimal** + @@ -214,7 +230,8 @@ The number of IP addresses contained within this subnet. [usableIpAddressCount]: #usableipaddresscount #### [usableIpAddressCount] The number of IP addresses that can be addressed within this subnet. For IPv4 subnets with a CIDR value of at most 30, a discount of 3 is taken from the total number of IP addresses for the subnet's unusable network, gateway and broadcast IP addresses. For IPv6 subnets with a CIDR value of at most 126, a discount of 2 is taken for the subnet's network and gateway IP addresses. -Type: **decimal** +Type: **decimal** + @@ -224,7 +241,8 @@ The number of IP addresses that can be addressed within this subnet. For IPv4 su [version]: #version #### [version] This is the Internet Protocol version. Current values may be either 4 or 6. -Type: **integer** +Type: **integer** + @@ -240,7 +258,8 @@ This is the Internet Protocol version. Current values may be either 4 or 6. [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -250,27 +269,32 @@ This is the Internet Protocol version. Current values may be either 4 or 6. [activeRegistration]: #activeregistration #### [activeRegistration] If present, the active registration for this subnet. -Type: **SoftLayer_Network_Subnet_Registration ** +Type: **SoftLayer_Network_Subnet_Registration ** + -
      +
      ----- [activeSwipTransaction]: #activeswiptransaction #### [activeSwipTransaction] DEPRECATED -Type: **SoftLayer_Network_Subnet_Swip_Transaction ** +Type: **SoftLayer_Network_Subnet_Swip_Transaction ** + +Deprecated
      -
      +
      ----- [activeTransaction]: #activetransaction #### [activeTransaction] DEPRECATED -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + +Deprecated
      @@ -280,7 +304,8 @@ DEPRECATED [addressSpace]: #addressspace #### [addressSpace] Identifier which distinguishes what classification of addresses the subnet represents. -Type: **string** +Type: **string** +
      @@ -290,7 +315,8 @@ Identifier which distinguishes what classification of addresses the subnet repre [allowedHost]: #allowedhost #### [allowedHost] The SoftLayer_Network_Storage_Allowed_Host information to connect this Subnet to Network Storage supporting access control lists. -Type: **SoftLayer_Network_Storage_Allowed_Host ** +Type: **SoftLayer_Network_Storage_Allowed_Host ** +
      @@ -300,7 +326,8 @@ The SoftLayer_Network_Storage_Allowed_Host information to connect this Subnet to [allowedNetworkStorage]: #allowednetworkstorage #### [allowedNetworkStorage] The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -310,7 +337,8 @@ The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to [allowedNetworkStorageReplicas]: #allowednetworkstoragereplicas #### [allowedNetworkStorageReplicas] The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -320,7 +348,8 @@ The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware [billingItem]: #billingitem #### [billingItem] The billing item for a subnet. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -330,7 +359,8 @@ The billing item for a subnet. [boundDescendants]: #bounddescendants #### [boundDescendants] -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -340,7 +370,8 @@ The billing item for a subnet. [boundRouterFlag]: #boundrouterflag #### [boundRouterFlag] Whether or not this subnet is associated with a router. Subnets that are not associated with a router cannot be routed. -Type: **boolean** +Type: **boolean** + @@ -350,7 +381,8 @@ Whether or not this subnet is associated with a router. Subnets that are not ass [boundRouters]: #boundrouters #### [boundRouters] -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -360,7 +392,8 @@ Whether or not this subnet is associated with a router. Subnets that are not ass [children]: #children #### [children] -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -370,7 +403,8 @@ Whether or not this subnet is associated with a router. Subnets that are not ass [datacenter]: #datacenter #### [datacenter] The data center this subnet may be routed within. -Type: **SoftLayer_Location_Datacenter ** +Type: **SoftLayer_Location_Datacenter ** + @@ -380,7 +414,8 @@ The data center this subnet may be routed within. [descendants]: #descendants #### [descendants] -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -390,7 +425,8 @@ The data center this subnet may be routed within. [displayLabel]: #displaylabel #### [displayLabel] -Type: **string** +Type: **string** + @@ -400,7 +436,8 @@ The data center this subnet may be routed within. [endPointIpAddress]: #endpointipaddress #### [endPointIpAddress] A static routed ip address -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -410,7 +447,8 @@ A static routed ip address [globalIpRecord]: #globaliprecord #### [globalIpRecord] -Type: **SoftLayer_Network_Subnet_IpAddress_Global ** +Type: **SoftLayer_Network_Subnet_IpAddress_Global ** + @@ -420,7 +458,8 @@ A static routed ip address [hardware]: #hardware #### [hardware] The hardware using IP addresses on this subnet. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -430,7 +469,8 @@ The hardware using IP addresses on this subnet. [ipAddresses]: #ipaddresses #### [ipAddresses] All the ip addresses associated with a subnet. -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -440,7 +480,8 @@ All the ip addresses associated with a subnet. [networkComponentFirewall]: #networkcomponentfirewall #### [networkComponentFirewall] The upstream network component firewall. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -450,7 +491,8 @@ The upstream network component firewall. [networkProtectionAddresses]: #networkprotectionaddresses #### [networkProtectionAddresses] -Type: **SoftLayer_Network_Protection_Address[] ** +Type: **SoftLayer_Network_Protection_Address[] ** + @@ -460,7 +502,8 @@ The upstream network component firewall. [networkTunnelContexts]: #networktunnelcontexts #### [networkTunnelContexts] IPSec network tunnels that have access to a private subnet. -Type: **SoftLayer_Network_Tunnel_Module_Context[] ** +Type: **SoftLayer_Network_Tunnel_Module_Context[] ** + @@ -470,7 +513,8 @@ IPSec network tunnels that have access to a private subnet. [networkVlan]: #networkvlan #### [networkVlan] The VLAN object that a subnet is associated with. -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + @@ -480,7 +524,8 @@ The VLAN object that a subnet is associated with. [podName]: #podname #### [podName] The pod in which this subnet resides. -Type: **string** +Type: **string** + @@ -490,7 +535,8 @@ The pod in which this subnet resides. [protectedIpAddresses]: #protectedipaddresses #### [protectedIpAddresses] -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -500,7 +546,8 @@ The pod in which this subnet resides. [regionalInternetRegistry]: #regionalinternetregistry #### [regionalInternetRegistry] -Type: **SoftLayer_Network_Regional_Internet_Registry ** +Type: **SoftLayer_Network_Regional_Internet_Registry ** + @@ -510,7 +557,8 @@ The pod in which this subnet resides. [registrations]: #registrations #### [registrations] All registrations that have been created for this subnet. -Type: **SoftLayer_Network_Subnet_Registration[] ** +Type: **SoftLayer_Network_Subnet_Registration[] ** + @@ -520,7 +568,8 @@ All registrations that have been created for this subnet. [reverseDomain]: #reversedomain #### [reverseDomain] The reverse DNS domain associated with this subnet. -Type: **SoftLayer_Dns_Domain ** +Type: **SoftLayer_Dns_Domain ** + @@ -530,7 +579,8 @@ The reverse DNS domain associated with this subnet. [roleKeyName]: #rolekeyname #### [roleKeyName] An identifier of the role the subnet is within. Roles dictate how a subnet may be used. -Type: **string** +Type: **string** + @@ -540,7 +590,8 @@ An identifier of the role the subnet is within. Roles dictate how a subnet may b [roleName]: #rolename #### [roleName] The name of the role the subnet is within. Roles dictate how a subnet may be used. -Type: **string** +Type: **string** + @@ -550,7 +601,8 @@ The name of the role the subnet is within. Roles dictate how a subnet may be use [routingTypeKeyName]: #routingtypekeyname #### [routingTypeKeyName] The identifier for the type of route then subnet is currently configured for. -Type: **string** +Type: **string** + @@ -560,17 +612,20 @@ The identifier for the type of route then subnet is currently configured for. [routingTypeName]: #routingtypename #### [routingTypeName] The name for the type of route then subnet is currently configured for. -Type: **string** +Type: **string** + -
      +
      ----- [swipTransaction]: #swiptransaction #### [swipTransaction] DEPRECATED -Type: **SoftLayer_Network_Subnet_Swip_Transaction[] ** +Type: **SoftLayer_Network_Subnet_Swip_Transaction[] ** + +Deprecated
      @@ -580,7 +635,8 @@ DEPRECATED [tagReferences]: #tagreferences #### [tagReferences] References to all tags for this subnet. -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** +
      @@ -590,7 +646,8 @@ References to all tags for this subnet. [unboundDescendants]: #unbounddescendants #### [unboundDescendants] -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -600,7 +657,8 @@ References to all tags for this subnet. [utilizedIpAddressCount]: #utilizedipaddresscount #### [utilizedIpAddressCount] Provides the total number of utilized IP addresses on this subnet. The primary consumer of IP addresses are compute resources, which can consume more than one address. This value is only supported for primary subnet types. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -610,7 +668,8 @@ Provides the total number of utilized IP addresses on this subnet. The primary c [virtualGuests]: #virtualguests #### [virtualGuests] The Virtual Servers using IP addresses on this subnet. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -622,7 +681,8 @@ The Virtual Servers using IP addresses on this subnet. [allowedNetworkStorageCount]: #allowednetworkstoragecount #### [allowedNetworkStorageCount] A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -632,7 +692,8 @@ A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware ha [allowedNetworkStorageReplicaCount]: #allowednetworkstoragereplicacount #### [allowedNetworkStorageReplicaCount] A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -642,7 +703,8 @@ A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLay [boundDescendantCount]: #bounddescendantcount #### [boundDescendantCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -652,7 +714,8 @@ A count of [boundRouterCount]: #boundroutercount #### [boundRouterCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -662,7 +725,8 @@ A count of [childrenCount]: #childrencount #### [childrenCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -672,7 +736,8 @@ A count of [descendantCount]: #descendantcount #### [descendantCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -682,7 +747,8 @@ A count of [hardwareCount]: #hardwarecount #### [hardwareCount] A count of the hardware using IP addresses on this subnet. -Type: **unsigned long** +Type: **unsigned long** + @@ -692,7 +758,8 @@ A count of the hardware using IP addresses on this subnet. [ipAddressCount]: #ipaddresscount #### [ipAddressCount] A count of all the ip addresses associated with a subnet. -Type: **unsigned long** +Type: **unsigned long** + @@ -702,7 +769,8 @@ A count of all the ip addresses associated with a subnet. [networkProtectionAddressCount]: #networkprotectionaddresscount #### [networkProtectionAddressCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -712,7 +780,8 @@ A count of [networkTunnelContextCount]: #networktunnelcontextcount #### [networkTunnelContextCount] A count of iPSec network tunnels that have access to a private subnet. -Type: **unsigned long** +Type: **unsigned long** + @@ -722,7 +791,8 @@ A count of iPSec network tunnels that have access to a private subnet. [protectedIpAddressCount]: #protectedipaddresscount #### [protectedIpAddressCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -732,7 +802,8 @@ A count of [registrationCount]: #registrationcount #### [registrationCount] A count of all registrations that have been created for this subnet. -Type: **unsigned long** +Type: **unsigned long** + @@ -742,7 +813,8 @@ A count of all registrations that have been created for this subnet. [swipTransactionCount]: #swiptransactioncount #### [swipTransactionCount] A count of dEPRECATED -Type: **unsigned long** +Type: **unsigned long** + @@ -752,7 +824,8 @@ A count of dEPRECATED [tagReferenceCount]: #tagreferencecount #### [tagReferenceCount] A count of references to all tags for this subnet. -Type: **unsigned long** +Type: **unsigned long** + @@ -762,7 +835,8 @@ A count of references to all tags for this subnet. [unboundDescendantCount]: #unbounddescendantcount #### [unboundDescendantCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -772,7 +846,8 @@ A count of [virtualGuestCount]: #virtualguestcount #### [virtualGuestCount] A count of the Virtual Servers using IP addresses on this subnet. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_IpAddress/_index.md b/content/reference/datatypes/SoftLayer_Network_Subnet_IpAddress/_index.md index 797ba5629e..dff4861ce2 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_IpAddress/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_IpAddress/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Subnet_IpAddress data type contains general information relating to a single SoftLayer IPv4 address. ### External Links @@ -71,7 +73,8 @@ The SoftLayer_Network_Subnet_IpAddress data type contains general information re [id]: #id #### [id] An IP's internal identifier. -Type: **integer** +Type: **integer** + @@ -81,7 +84,8 @@ An IP's internal identifier. [ipAddress]: #ipaddress #### [ipAddress] An IP address expressed in dotted quad format. -Type: **string** +Type: **string** + @@ -91,7 +95,8 @@ An IP address expressed in dotted quad format. [isBroadcast]: #isbroadcast #### [isBroadcast] Indicates if an IP address is reserved to be used as the network broadcast address and cannot be assigned to a network interface -Type: **boolean** +Type: **boolean** + @@ -101,7 +106,8 @@ Indicates if an IP address is reserved to be used as the network broadcast addre [isGateway]: #isgateway #### [isGateway] Indicates if an IP address is reserved to a gateway and cannot be assigned to a network interface -Type: **boolean** +Type: **boolean** + @@ -111,7 +117,8 @@ Indicates if an IP address is reserved to a gateway and cannot be assigned to a [isNetwork]: #isnetwork #### [isNetwork] Indicates if an IP address is reserved to a network address and cannot be assigned to a network interface -Type: **boolean** +Type: **boolean** + @@ -121,7 +128,8 @@ Indicates if an IP address is reserved to a network address and cannot be assign [isReserved]: #isreserved #### [isReserved] Indicates if an IP address is reserved and cannot be assigned to a network interface -Type: **boolean** +Type: **boolean** + @@ -131,7 +139,8 @@ Indicates if an IP address is reserved and cannot be assigned to a network inter [note]: #note #### [note] An IP address' user defined note. -Type: **string** +Type: **string** + @@ -141,7 +150,8 @@ An IP address' user defined note. [subnetId]: #subnetid #### [subnetId] An IP address' subnet id. -Type: **integer** +Type: **integer** + @@ -157,7 +167,8 @@ An IP address' subnet id. [allowedHost]: #allowedhost #### [allowedHost] The SoftLayer_Network_Storage_Allowed_Host information to connect this IP Address to Network Storage supporting access control lists. -Type: **SoftLayer_Network_Storage_Allowed_Host ** +Type: **SoftLayer_Network_Storage_Allowed_Host ** + @@ -167,7 +178,8 @@ The SoftLayer_Network_Storage_Allowed_Host information to connect this IP Addres [allowedNetworkStorage]: #allowednetworkstorage #### [allowedNetworkStorage] The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -177,7 +189,8 @@ The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to [allowedNetworkStorageReplicas]: #allowednetworkstoragereplicas #### [allowedNetworkStorageReplicas] The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -187,7 +200,8 @@ The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware [applicationDeliveryController]: #applicationdeliverycontroller #### [applicationDeliveryController] The application delivery controller using this address. -Type: **SoftLayer_Network_Application_Delivery_Controller ** +Type: **SoftLayer_Network_Application_Delivery_Controller ** + @@ -197,7 +211,8 @@ The application delivery controller using this address. [contextTunnelTranslations]: #contexttunneltranslations #### [contextTunnelTranslations] An IPSec network tunnel's address translations. These translations use a SoftLayer ip address from an assigned static NAT subnet to deliver the packets to the remote (customer) destination. -Type: **SoftLayer_Network_Tunnel_Module_Context_Address_Translation[] ** +Type: **SoftLayer_Network_Tunnel_Module_Context_Address_Translation[] ** + @@ -207,7 +222,8 @@ An IPSec network tunnel's address translations. These translations use a SoftLay [endpointSubnets]: #endpointsubnets #### [endpointSubnets] All the subnets routed to an IP address. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -217,7 +233,8 @@ All the subnets routed to an IP address. [guestNetworkComponent]: #guestnetworkcomponent #### [guestNetworkComponent] A network component that is statically routed to an IP address. -Type: **SoftLayer_Virtual_Guest_Network_Component ** +Type: **SoftLayer_Virtual_Guest_Network_Component ** + @@ -227,7 +244,8 @@ A network component that is statically routed to an IP address. [guestNetworkComponentBinding]: #guestnetworkcomponentbinding #### [guestNetworkComponentBinding] A network component that is statically routed to an IP address. -Type: **SoftLayer_Virtual_Guest_Network_Component_IpAddress ** +Type: **SoftLayer_Virtual_Guest_Network_Component_IpAddress ** + @@ -237,7 +255,8 @@ A network component that is statically routed to an IP address. [hardware]: #hardware #### [hardware] A server that this IP address is routed to. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -247,7 +266,8 @@ A server that this IP address is routed to. [networkComponent]: #networkcomponent #### [networkComponent] A network component that is statically routed to an IP address. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -257,7 +277,8 @@ A network component that is statically routed to an IP address. [privateNetworkGateway]: #privatenetworkgateway #### [privateNetworkGateway] The network gateway appliance using this address as the private IP address. -Type: **SoftLayer_Network_Gateway ** +Type: **SoftLayer_Network_Gateway ** + @@ -267,7 +288,8 @@ The network gateway appliance using this address as the private IP address. [protectionAddress]: #protectionaddress #### [protectionAddress] -Type: **SoftLayer_Network_Protection_Address[] ** +Type: **SoftLayer_Network_Protection_Address[] ** + @@ -277,7 +299,8 @@ The network gateway appliance using this address as the private IP address. [publicNetworkGateway]: #publicnetworkgateway #### [publicNetworkGateway] The network gateway appliance using this address as the public IP address. -Type: **SoftLayer_Network_Gateway ** +Type: **SoftLayer_Network_Gateway ** + @@ -287,7 +310,8 @@ The network gateway appliance using this address as the public IP address. [remoteManagementNetworkComponent]: #remotemanagementnetworkcomponent #### [remoteManagementNetworkComponent] An IPMI-based management network component of the IP address. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -297,7 +321,8 @@ An IPMI-based management network component of the IP address. [subnet]: #subnet #### [subnet] An IP address' associated subnet. -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + @@ -307,7 +332,8 @@ An IP address' associated subnet. [syslogEventsOneDay]: #syslogeventsoneday #### [syslogEventsOneDay] All events for this IP address stored in the datacenter syslogs from the last 24 hours -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -317,7 +343,8 @@ All events for this IP address stored in the datacenter syslogs from the last 24 [syslogEventsSevenDays]: #syslogeventssevendays #### [syslogEventsSevenDays] All events for this IP address stored in the datacenter syslogs from the last 7 days -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -327,7 +354,8 @@ All events for this IP address stored in the datacenter syslogs from the last 7 [topTenSyslogEventsByDestinationPortOneDay]: #toptensyslogeventsbydestinationportoneday #### [topTenSyslogEventsByDestinationPortOneDay] Top Ten network datacenter syslog events, grouped by destination port, for the last 24 hours -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -337,7 +365,8 @@ Top Ten network datacenter syslog events, grouped by destination port, for the l [topTenSyslogEventsByDestinationPortSevenDays]: #toptensyslogeventsbydestinationportsevendays #### [topTenSyslogEventsByDestinationPortSevenDays] Top Ten network datacenter syslog events, grouped by destination port, for the last 7 days -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -347,7 +376,8 @@ Top Ten network datacenter syslog events, grouped by destination port, for the l [topTenSyslogEventsByProtocolsOneDay]: #toptensyslogeventsbyprotocolsoneday #### [topTenSyslogEventsByProtocolsOneDay] Top Ten network datacenter syslog events, grouped by source port, for the last 24 hours -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -357,7 +387,8 @@ Top Ten network datacenter syslog events, grouped by source port, for the last 2 [topTenSyslogEventsByProtocolsSevenDays]: #toptensyslogeventsbyprotocolssevendays #### [topTenSyslogEventsByProtocolsSevenDays] Top Ten network datacenter syslog events, grouped by source port, for the last 7 days -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -367,7 +398,8 @@ Top Ten network datacenter syslog events, grouped by source port, for the last 7 [topTenSyslogEventsBySourceIpOneDay]: #toptensyslogeventsbysourceiponeday #### [topTenSyslogEventsBySourceIpOneDay] Top Ten network datacenter syslog events, grouped by source ip address, for the last 24 hours -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -377,7 +409,8 @@ Top Ten network datacenter syslog events, grouped by source ip address, for the [topTenSyslogEventsBySourceIpSevenDays]: #toptensyslogeventsbysourceipsevendays #### [topTenSyslogEventsBySourceIpSevenDays] Top Ten network datacenter syslog events, grouped by source ip address, for the last 7 days -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -387,7 +420,8 @@ Top Ten network datacenter syslog events, grouped by source ip address, for the [topTenSyslogEventsBySourcePortOneDay]: #toptensyslogeventsbysourceportoneday #### [topTenSyslogEventsBySourcePortOneDay] Top Ten network datacenter syslog events, grouped by source port, for the last 24 hours -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -397,7 +431,8 @@ Top Ten network datacenter syslog events, grouped by source port, for the last 2 [topTenSyslogEventsBySourcePortSevenDays]: #toptensyslogeventsbysourceportsevendays #### [topTenSyslogEventsBySourcePortSevenDays] Top Ten network datacenter syslog events, grouped by source port, for the last 7 days -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -407,7 +442,8 @@ Top Ten network datacenter syslog events, grouped by source port, for the last 7 [virtualGuest]: #virtualguest #### [virtualGuest] A virtual guest that this IP address is routed to. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -417,7 +453,8 @@ A virtual guest that this IP address is routed to. [virtualLicenses]: #virtuallicenses #### [virtualLicenses] Virtual licenses allocated for an IP Address. -Type: **SoftLayer_Software_VirtualLicense[] ** +Type: **SoftLayer_Software_VirtualLicense[] ** + @@ -429,7 +466,8 @@ Virtual licenses allocated for an IP Address. [allowedNetworkStorageCount]: #allowednetworkstoragecount #### [allowedNetworkStorageCount] A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -439,7 +477,8 @@ A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware ha [allowedNetworkStorageReplicaCount]: #allowednetworkstoragereplicacount #### [allowedNetworkStorageReplicaCount] A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -449,7 +488,8 @@ A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLay [contextTunnelTranslationCount]: #contexttunneltranslationcount #### [contextTunnelTranslationCount] A count of an IPSec network tunnel's address translations. These translations use a SoftLayer ip address from an assigned static NAT subnet to deliver the packets to the remote (customer) destination. -Type: **unsigned long** +Type: **unsigned long** + @@ -459,7 +499,8 @@ A count of an IPSec network tunnel's address translations. These translations us [endpointSubnetCount]: #endpointsubnetcount #### [endpointSubnetCount] A count of all the subnets routed to an IP address. -Type: **unsigned long** +Type: **unsigned long** + @@ -469,7 +510,8 @@ A count of all the subnets routed to an IP address. [protectionAddressCount]: #protectionaddresscount #### [protectionAddressCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -479,7 +521,8 @@ A count of [syslogEventsOneDayCount]: #syslogeventsonedaycount #### [syslogEventsOneDayCount] A count of all events for this IP address stored in the datacenter syslogs from the last 24 hours -Type: **unsigned long** +Type: **unsigned long** + @@ -489,7 +532,8 @@ A count of all events for this IP address stored in the datacenter syslogs from [syslogEventsSevenDayCount]: #syslogeventssevendaycount #### [syslogEventsSevenDayCount] A count of all events for this IP address stored in the datacenter syslogs from the last 7 days -Type: **unsigned long** +Type: **unsigned long** + @@ -499,7 +543,8 @@ A count of all events for this IP address stored in the datacenter syslogs from [topTenSyslogEventsByDestinationPortOneDayCount]: #toptensyslogeventsbydestinationportonedaycount #### [topTenSyslogEventsByDestinationPortOneDayCount] A count of top Ten network datacenter syslog events, grouped by destination port, for the last 24 hours -Type: **unsigned long** +Type: **unsigned long** + @@ -509,7 +554,8 @@ A count of top Ten network datacenter syslog events, grouped by destination port [topTenSyslogEventsByDestinationPortSevenDayCount]: #toptensyslogeventsbydestinationportsevendaycount #### [topTenSyslogEventsByDestinationPortSevenDayCount] A count of top Ten network datacenter syslog events, grouped by destination port, for the last 7 days -Type: **unsigned long** +Type: **unsigned long** + @@ -519,7 +565,8 @@ A count of top Ten network datacenter syslog events, grouped by destination port [topTenSyslogEventsByProtocolsOneDayCount]: #toptensyslogeventsbyprotocolsonedaycount #### [topTenSyslogEventsByProtocolsOneDayCount] A count of top Ten network datacenter syslog events, grouped by source port, for the last 24 hours -Type: **unsigned long** +Type: **unsigned long** + @@ -529,7 +576,8 @@ A count of top Ten network datacenter syslog events, grouped by source port, for [topTenSyslogEventsByProtocolsSevenDayCount]: #toptensyslogeventsbyprotocolssevendaycount #### [topTenSyslogEventsByProtocolsSevenDayCount] A count of top Ten network datacenter syslog events, grouped by source port, for the last 7 days -Type: **unsigned long** +Type: **unsigned long** + @@ -539,7 +587,8 @@ A count of top Ten network datacenter syslog events, grouped by source port, for [topTenSyslogEventsBySourceIpOneDayCount]: #toptensyslogeventsbysourceiponedaycount #### [topTenSyslogEventsBySourceIpOneDayCount] A count of top Ten network datacenter syslog events, grouped by source ip address, for the last 24 hours -Type: **unsigned long** +Type: **unsigned long** + @@ -549,7 +598,8 @@ A count of top Ten network datacenter syslog events, grouped by source ip addres [topTenSyslogEventsBySourceIpSevenDayCount]: #toptensyslogeventsbysourceipsevendaycount #### [topTenSyslogEventsBySourceIpSevenDayCount] A count of top Ten network datacenter syslog events, grouped by source ip address, for the last 7 days -Type: **unsigned long** +Type: **unsigned long** + @@ -559,7 +609,8 @@ A count of top Ten network datacenter syslog events, grouped by source ip addres [topTenSyslogEventsBySourcePortOneDayCount]: #toptensyslogeventsbysourceportonedaycount #### [topTenSyslogEventsBySourcePortOneDayCount] A count of top Ten network datacenter syslog events, grouped by source port, for the last 24 hours -Type: **unsigned long** +Type: **unsigned long** + @@ -569,7 +620,8 @@ A count of top Ten network datacenter syslog events, grouped by source port, for [topTenSyslogEventsBySourcePortSevenDayCount]: #toptensyslogeventsbysourceportsevendaycount #### [topTenSyslogEventsBySourcePortSevenDayCount] A count of top Ten network datacenter syslog events, grouped by source port, for the last 7 days -Type: **unsigned long** +Type: **unsigned long** + @@ -579,7 +631,8 @@ A count of top Ten network datacenter syslog events, grouped by source port, for [virtualLicenseCount]: #virtuallicensecount #### [virtualLicenseCount] A count of virtual licenses allocated for an IP Address. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_IpAddress_Global/_index.md b/content/reference/datatypes/SoftLayer_Network_Subnet_IpAddress_Global/_index.md index a302560c53..52d53d84c1 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_IpAddress_Global/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_IpAddress_Global/_index.md @@ -24,6 +24,8 @@ classes: + +
      @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] A Global IP Address' associated description -Type: **integer** +Type: **integer** +
      @@ -55,7 +58,8 @@ A Global IP Address' associated description [destinationIpAddressId]: #destinationipaddressid #### [destinationIpAddressId] A Global IP Address' associated [SoftLayer_Network_Subnet_IpAddress]({{}}) ID -Type: **integer** +Type: **integer** +
      @@ -65,7 +69,8 @@ A Global IP Address' associated [SoftLayer_Network_Subnet_IpAddress]({{Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A Global IP Address' unique identifier [ipAddressId]: #ipaddressid #### [ipAddressId] A Global IP Address' associated [SoftLayer_Account]({{}}) ID -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ A Global IP Address' associated [SoftLayer_Account]({{}}) ID -Type: **integer** +Type: **integer** + @@ -101,17 +108,20 @@ A Global IP Address' associated type [SoftLayer_Network_Subnet_IpAddress_Global_ [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + -
      +
      ----- [activeTransaction]: #activetransaction #### [activeTransaction] DEPRECATED -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + +Deprecated
      @@ -121,7 +131,8 @@ DEPRECATED [billingItem]: #billingitem #### [billingItem] The billing item for this Global IP. -Type: **SoftLayer_Billing_Item_Network_Subnet_IpAddress_Global ** +Type: **SoftLayer_Billing_Item_Network_Subnet_IpAddress_Global ** +
      @@ -131,7 +142,8 @@ The billing item for this Global IP. [destinationIpAddress]: #destinationipaddress #### [destinationIpAddress] -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -141,7 +153,8 @@ The billing item for this Global IP. [ipAddress]: #ipaddress #### [ipAddress] -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_IpAddress_Version6/_index.md b/content/reference/datatypes/SoftLayer_Network_Subnet_IpAddress_Version6/_index.md index 4b170b5448..ce26197f00 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_IpAddress_Version6/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_IpAddress_Version6/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Subnet_IpAddress data type contains general information relating to a single SoftLayer IPv6 address. ### External Links @@ -71,7 +73,8 @@ The SoftLayer_Network_Subnet_IpAddress data type contains general information re [id]: #id #### [id] An IP's internal identifier. -Type: **integer** +Type: **integer** + @@ -81,7 +84,8 @@ An IP's internal identifier. [ipAddress]: #ipaddress #### [ipAddress] An IP address expressed in dotted quad format. -Type: **string** +Type: **string** + @@ -91,7 +95,8 @@ An IP address expressed in dotted quad format. [isBroadcast]: #isbroadcast #### [isBroadcast] Indicates if an IP address is reserved to be used as the network broadcast address and cannot be assigned to a network interface -Type: **boolean** +Type: **boolean** + @@ -101,7 +106,8 @@ Indicates if an IP address is reserved to be used as the network broadcast addre [isGateway]: #isgateway #### [isGateway] Indicates if an IP address is reserved to a gateway and cannot be assigned to a network interface -Type: **boolean** +Type: **boolean** + @@ -111,7 +117,8 @@ Indicates if an IP address is reserved to a gateway and cannot be assigned to a [isNetwork]: #isnetwork #### [isNetwork] Indicates if an IP address is reserved to a network address and cannot be assigned to a network interface -Type: **boolean** +Type: **boolean** + @@ -121,7 +128,8 @@ Indicates if an IP address is reserved to a network address and cannot be assign [isReserved]: #isreserved #### [isReserved] Indicates if an IP address is reserved and cannot be assigned to a network interface -Type: **boolean** +Type: **boolean** + @@ -131,7 +139,8 @@ Indicates if an IP address is reserved and cannot be assigned to a network inter [note]: #note #### [note] An IP address' user defined note. -Type: **string** +Type: **string** + @@ -141,7 +150,8 @@ An IP address' user defined note. [subnetId]: #subnetid #### [subnetId] An IP address' subnet id. -Type: **integer** +Type: **integer** + @@ -157,7 +167,8 @@ An IP address' subnet id. [allowedHost]: #allowedhost #### [allowedHost] The SoftLayer_Network_Storage_Allowed_Host information to connect this IP Address to Network Storage supporting access control lists. -Type: **SoftLayer_Network_Storage_Allowed_Host ** +Type: **SoftLayer_Network_Storage_Allowed_Host ** + @@ -167,7 +178,8 @@ The SoftLayer_Network_Storage_Allowed_Host information to connect this IP Addres [allowedNetworkStorage]: #allowednetworkstorage #### [allowedNetworkStorage] The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -177,7 +189,8 @@ The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to [allowedNetworkStorageReplicas]: #allowednetworkstoragereplicas #### [allowedNetworkStorageReplicas] The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -187,7 +200,8 @@ The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware [applicationDeliveryController]: #applicationdeliverycontroller #### [applicationDeliveryController] The application delivery controller using this address. -Type: **SoftLayer_Network_Application_Delivery_Controller ** +Type: **SoftLayer_Network_Application_Delivery_Controller ** + @@ -197,7 +211,8 @@ The application delivery controller using this address. [contextTunnelTranslations]: #contexttunneltranslations #### [contextTunnelTranslations] An IPSec network tunnel's address translations. These translations use a SoftLayer ip address from an assigned static NAT subnet to deliver the packets to the remote (customer) destination. -Type: **SoftLayer_Network_Tunnel_Module_Context_Address_Translation[] ** +Type: **SoftLayer_Network_Tunnel_Module_Context_Address_Translation[] ** + @@ -207,7 +222,8 @@ An IPSec network tunnel's address translations. These translations use a SoftLay [endpointSubnets]: #endpointsubnets #### [endpointSubnets] All the subnets routed to an IP address. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -217,7 +233,8 @@ All the subnets routed to an IP address. [guestNetworkComponent]: #guestnetworkcomponent #### [guestNetworkComponent] A network component that is statically routed to an IP address. -Type: **SoftLayer_Virtual_Guest_Network_Component ** +Type: **SoftLayer_Virtual_Guest_Network_Component ** + @@ -227,7 +244,8 @@ A network component that is statically routed to an IP address. [guestNetworkComponentBinding]: #guestnetworkcomponentbinding #### [guestNetworkComponentBinding] A network component that is statically routed to an IP address. -Type: **SoftLayer_Virtual_Guest_Network_Component_IpAddress ** +Type: **SoftLayer_Virtual_Guest_Network_Component_IpAddress ** + @@ -237,7 +255,8 @@ A network component that is statically routed to an IP address. [hardware]: #hardware #### [hardware] The hardware that this IP address is routed to. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -247,7 +266,8 @@ The hardware that this IP address is routed to. [networkComponent]: #networkcomponent #### [networkComponent] A network component that is statically routed to an IP address. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -257,7 +277,8 @@ A network component that is statically routed to an IP address. [privateNetworkGateway]: #privatenetworkgateway #### [privateNetworkGateway] The network gateway appliance using this address as the private IP address. -Type: **SoftLayer_Network_Gateway ** +Type: **SoftLayer_Network_Gateway ** + @@ -267,7 +288,8 @@ The network gateway appliance using this address as the private IP address. [protectionAddress]: #protectionaddress #### [protectionAddress] -Type: **SoftLayer_Network_Protection_Address[] ** +Type: **SoftLayer_Network_Protection_Address[] ** + @@ -277,7 +299,8 @@ The network gateway appliance using this address as the private IP address. [publicNetworkGateway]: #publicnetworkgateway #### [publicNetworkGateway] The network gateway appliance using this address as the public IP address. -Type: **SoftLayer_Network_Gateway ** +Type: **SoftLayer_Network_Gateway ** + @@ -287,7 +310,8 @@ The network gateway appliance using this address as the public IP address. [publicVersion6NetworkGateway]: #publicversion6networkgateway #### [publicVersion6NetworkGateway] The network gateway appliance using this address as the public IPv6 address. -Type: **SoftLayer_Network_Gateway ** +Type: **SoftLayer_Network_Gateway ** + @@ -297,7 +321,8 @@ The network gateway appliance using this address as the public IPv6 address. [remoteManagementNetworkComponent]: #remotemanagementnetworkcomponent #### [remoteManagementNetworkComponent] An IPMI-based management network component of the IP address. -Type: **SoftLayer_Network_Component ** +Type: **SoftLayer_Network_Component ** + @@ -307,7 +332,8 @@ An IPMI-based management network component of the IP address. [subnet]: #subnet #### [subnet] An IP address' associated subnet. -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + @@ -317,7 +343,8 @@ An IP address' associated subnet. [syslogEventsOneDay]: #syslogeventsoneday #### [syslogEventsOneDay] All events for this IP address stored in the datacenter syslogs from the last 24 hours -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -327,7 +354,8 @@ All events for this IP address stored in the datacenter syslogs from the last 24 [syslogEventsSevenDays]: #syslogeventssevendays #### [syslogEventsSevenDays] All events for this IP address stored in the datacenter syslogs from the last 7 days -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -337,7 +365,8 @@ All events for this IP address stored in the datacenter syslogs from the last 7 [topTenSyslogEventsByDestinationPortOneDay]: #toptensyslogeventsbydestinationportoneday #### [topTenSyslogEventsByDestinationPortOneDay] Top Ten network datacenter syslog events, grouped by destination port, for the last 24 hours -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -347,7 +376,8 @@ Top Ten network datacenter syslog events, grouped by destination port, for the l [topTenSyslogEventsByDestinationPortSevenDays]: #toptensyslogeventsbydestinationportsevendays #### [topTenSyslogEventsByDestinationPortSevenDays] Top Ten network datacenter syslog events, grouped by destination port, for the last 7 days -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -357,7 +387,8 @@ Top Ten network datacenter syslog events, grouped by destination port, for the l [topTenSyslogEventsByProtocolsOneDay]: #toptensyslogeventsbyprotocolsoneday #### [topTenSyslogEventsByProtocolsOneDay] Top Ten network datacenter syslog events, grouped by source port, for the last 24 hours -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -367,7 +398,8 @@ Top Ten network datacenter syslog events, grouped by source port, for the last 2 [topTenSyslogEventsByProtocolsSevenDays]: #toptensyslogeventsbyprotocolssevendays #### [topTenSyslogEventsByProtocolsSevenDays] Top Ten network datacenter syslog events, grouped by source port, for the last 7 days -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -377,7 +409,8 @@ Top Ten network datacenter syslog events, grouped by source port, for the last 7 [topTenSyslogEventsBySourceIpOneDay]: #toptensyslogeventsbysourceiponeday #### [topTenSyslogEventsBySourceIpOneDay] Top Ten network datacenter syslog events, grouped by source ip address, for the last 24 hours -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -387,7 +420,8 @@ Top Ten network datacenter syslog events, grouped by source ip address, for the [topTenSyslogEventsBySourceIpSevenDays]: #toptensyslogeventsbysourceipsevendays #### [topTenSyslogEventsBySourceIpSevenDays] Top Ten network datacenter syslog events, grouped by source ip address, for the last 7 days -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -397,7 +431,8 @@ Top Ten network datacenter syslog events, grouped by source ip address, for the [topTenSyslogEventsBySourcePortOneDay]: #toptensyslogeventsbysourceportoneday #### [topTenSyslogEventsBySourcePortOneDay] Top Ten network datacenter syslog events, grouped by source port, for the last 24 hours -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -407,7 +442,8 @@ Top Ten network datacenter syslog events, grouped by source port, for the last 2 [topTenSyslogEventsBySourcePortSevenDays]: #toptensyslogeventsbysourceportsevendays #### [topTenSyslogEventsBySourcePortSevenDays] Top Ten network datacenter syslog events, grouped by source port, for the last 7 days -Type: **SoftLayer_Network_Logging_Syslog[] ** +Type: **SoftLayer_Network_Logging_Syslog[] ** + @@ -417,7 +453,8 @@ Top Ten network datacenter syslog events, grouped by source port, for the last 7 [virtualGuest]: #virtualguest #### [virtualGuest] A virtual guest that this IP address is routed to. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -427,7 +464,8 @@ A virtual guest that this IP address is routed to. [virtualLicenses]: #virtuallicenses #### [virtualLicenses] Virtual licenses allocated for an IP Address. -Type: **SoftLayer_Software_VirtualLicense[] ** +Type: **SoftLayer_Software_VirtualLicense[] ** + @@ -439,7 +477,8 @@ Virtual licenses allocated for an IP Address. [allowedNetworkStorageCount]: #allowednetworkstoragecount #### [allowedNetworkStorageCount] A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -449,7 +488,8 @@ A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware ha [allowedNetworkStorageReplicaCount]: #allowednetworkstoragereplicacount #### [allowedNetworkStorageReplicaCount] A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -459,7 +499,8 @@ A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLay [contextTunnelTranslationCount]: #contexttunneltranslationcount #### [contextTunnelTranslationCount] A count of an IPSec network tunnel's address translations. These translations use a SoftLayer ip address from an assigned static NAT subnet to deliver the packets to the remote (customer) destination. -Type: **unsigned long** +Type: **unsigned long** + @@ -469,7 +510,8 @@ A count of an IPSec network tunnel's address translations. These translations us [endpointSubnetCount]: #endpointsubnetcount #### [endpointSubnetCount] A count of all the subnets routed to an IP address. -Type: **unsigned long** +Type: **unsigned long** + @@ -479,7 +521,8 @@ A count of all the subnets routed to an IP address. [protectionAddressCount]: #protectionaddresscount #### [protectionAddressCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -489,7 +532,8 @@ A count of [syslogEventsOneDayCount]: #syslogeventsonedaycount #### [syslogEventsOneDayCount] A count of all events for this IP address stored in the datacenter syslogs from the last 24 hours -Type: **unsigned long** +Type: **unsigned long** + @@ -499,7 +543,8 @@ A count of all events for this IP address stored in the datacenter syslogs from [syslogEventsSevenDayCount]: #syslogeventssevendaycount #### [syslogEventsSevenDayCount] A count of all events for this IP address stored in the datacenter syslogs from the last 7 days -Type: **unsigned long** +Type: **unsigned long** + @@ -509,7 +554,8 @@ A count of all events for this IP address stored in the datacenter syslogs from [topTenSyslogEventsByDestinationPortOneDayCount]: #toptensyslogeventsbydestinationportonedaycount #### [topTenSyslogEventsByDestinationPortOneDayCount] A count of top Ten network datacenter syslog events, grouped by destination port, for the last 24 hours -Type: **unsigned long** +Type: **unsigned long** + @@ -519,7 +565,8 @@ A count of top Ten network datacenter syslog events, grouped by destination port [topTenSyslogEventsByDestinationPortSevenDayCount]: #toptensyslogeventsbydestinationportsevendaycount #### [topTenSyslogEventsByDestinationPortSevenDayCount] A count of top Ten network datacenter syslog events, grouped by destination port, for the last 7 days -Type: **unsigned long** +Type: **unsigned long** + @@ -529,7 +576,8 @@ A count of top Ten network datacenter syslog events, grouped by destination port [topTenSyslogEventsByProtocolsOneDayCount]: #toptensyslogeventsbyprotocolsonedaycount #### [topTenSyslogEventsByProtocolsOneDayCount] A count of top Ten network datacenter syslog events, grouped by source port, for the last 24 hours -Type: **unsigned long** +Type: **unsigned long** + @@ -539,7 +587,8 @@ A count of top Ten network datacenter syslog events, grouped by source port, for [topTenSyslogEventsByProtocolsSevenDayCount]: #toptensyslogeventsbyprotocolssevendaycount #### [topTenSyslogEventsByProtocolsSevenDayCount] A count of top Ten network datacenter syslog events, grouped by source port, for the last 7 days -Type: **unsigned long** +Type: **unsigned long** + @@ -549,7 +598,8 @@ A count of top Ten network datacenter syslog events, grouped by source port, for [topTenSyslogEventsBySourceIpOneDayCount]: #toptensyslogeventsbysourceiponedaycount #### [topTenSyslogEventsBySourceIpOneDayCount] A count of top Ten network datacenter syslog events, grouped by source ip address, for the last 24 hours -Type: **unsigned long** +Type: **unsigned long** + @@ -559,7 +609,8 @@ A count of top Ten network datacenter syslog events, grouped by source ip addres [topTenSyslogEventsBySourceIpSevenDayCount]: #toptensyslogeventsbysourceipsevendaycount #### [topTenSyslogEventsBySourceIpSevenDayCount] A count of top Ten network datacenter syslog events, grouped by source ip address, for the last 7 days -Type: **unsigned long** +Type: **unsigned long** + @@ -569,7 +620,8 @@ A count of top Ten network datacenter syslog events, grouped by source ip addres [topTenSyslogEventsBySourcePortOneDayCount]: #toptensyslogeventsbysourceportonedaycount #### [topTenSyslogEventsBySourcePortOneDayCount] A count of top Ten network datacenter syslog events, grouped by source port, for the last 24 hours -Type: **unsigned long** +Type: **unsigned long** + @@ -579,7 +631,8 @@ A count of top Ten network datacenter syslog events, grouped by source port, for [topTenSyslogEventsBySourcePortSevenDayCount]: #toptensyslogeventsbysourceportsevendaycount #### [topTenSyslogEventsBySourcePortSevenDayCount] A count of top Ten network datacenter syslog events, grouped by source port, for the last 7 days -Type: **unsigned long** +Type: **unsigned long** + @@ -589,7 +642,8 @@ A count of top Ten network datacenter syslog events, grouped by source port, for [virtualLicenseCount]: #virtuallicensecount #### [virtualLicenseCount] A count of virtual licenses allocated for an IP Address. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration/_index.md b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration/_index.md index f601e8b597..84b8f57ad4 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}). @@ -45,7 +47,8 @@ The subnet registration data type contains general information relating to a sin [accountId]: #accountid #### [accountId] The registration object's associated [SoftLayer_Account]({{}}) id -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The registration object's associated [SoftLayer_Account]({{Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The CIDR prefix for the registered subnet [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The CIDR prefix for the registered subnet [id]: #id #### [id] Unique ID of the registration object -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Unique ID of the registration object [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ Unique ID of the registration object [networkHandle]: #networkhandle #### [networkHandle] The RIR-specific handle or name of the registered subnet. This field is read-only. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The RIR-specific handle or name of the registered subnet. This field is read-onl [networkIdentifier]: #networkidentifier #### [networkIdentifier] The base IP address of the registered subnet -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The base IP address of the registered subnet [regionalInternetRegistryHandleId]: #regionalinternetregistryhandleid #### [regionalInternetRegistryHandleId] The registration object's associated [SoftLayer_Account_Rwhois_Handle]({{}}) id -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ The registration object's associated [SoftLayer_Account_Rwhois_Handle]({{}}) id -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ The registration object's associated [SoftLayer_Network_Regional_Internet_Regist [statusId]: #statusid #### [statusId] The registration object's associated [SoftLayer_Network_Subnet_Registration_Status]({{}}) id -Type: **integer** +Type: **integer** + @@ -151,7 +163,8 @@ The registration object's associated [SoftLayer_Network_Subnet_Registration_Stat [account]: #account #### [account] The account that this registration belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -161,7 +174,8 @@ The account that this registration belongs to. [detailReferences]: #detailreferences #### [detailReferences] The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail]({{}}) objects to the registration object. -Type: **SoftLayer_Network_Subnet_Registration_Details[] ** +Type: **SoftLayer_Network_Subnet_Registration_Details[] ** + @@ -171,7 +185,8 @@ The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_De [events]: #events #### [events] The related registration events. -Type: **SoftLayer_Network_Subnet_Registration_Event[] ** +Type: **SoftLayer_Network_Subnet_Registration_Event[] ** + @@ -181,7 +196,8 @@ The related registration events. [networkDetail]: #networkdetail #### [networkDetail] The "network" detail object. -Type: **SoftLayer_Account_Regional_Registry_Detail ** +Type: **SoftLayer_Account_Regional_Registry_Detail ** + @@ -191,7 +207,8 @@ The "network" detail object. [personDetail]: #persondetail #### [personDetail] The "person" detail object. -Type: **SoftLayer_Account_Regional_Registry_Detail ** +Type: **SoftLayer_Account_Regional_Registry_Detail ** + @@ -201,7 +218,8 @@ The "person" detail object. [regionalInternetRegistry]: #regionalinternetregistry #### [regionalInternetRegistry] The related Regional Internet Registry. -Type: **SoftLayer_Network_Regional_Internet_Registry ** +Type: **SoftLayer_Network_Regional_Internet_Registry ** + @@ -211,7 +229,8 @@ The related Regional Internet Registry. [regionalInternetRegistryHandle]: #regionalinternetregistryhandle #### [regionalInternetRegistryHandle] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete. -Type: **SoftLayer_Account_Rwhois_Handle ** +Type: **SoftLayer_Account_Rwhois_Handle ** + @@ -221,7 +240,8 @@ The RIR handle that this registration object belongs to. This field may not be p [status]: #status #### [status] The status of this registration. -Type: **SoftLayer_Network_Subnet_Registration_Status ** +Type: **SoftLayer_Network_Subnet_Registration_Status ** + @@ -231,7 +251,8 @@ The status of this registration. [subnet]: #subnet #### [subnet] The subnet that this registration pertains to. -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + @@ -243,7 +264,8 @@ The subnet that this registration pertains to. [detailReferenceCount]: #detailreferencecount #### [detailReferenceCount] A count of the cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail]({{}}) objects to the registration object. -Type: **unsigned long** +Type: **unsigned long** + @@ -253,7 +275,8 @@ A count of the cross-reference records that tie the [SoftLayer_Account_Regional_ [eventCount]: #eventcount #### [eventCount] A count of the related registration events. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Apnic/_index.md b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Apnic/_index.md index 74e2b8d284..669ed3f011 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Apnic/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Apnic/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + APNIC-specific registration object. For more detail see [SoftLayer_Network_Subnet_Registration]({{}}). @@ -45,7 +47,8 @@ APNIC-specific registration object. For more detail see [SoftLayer_Network_Subne [accountId]: #accountid #### [accountId] The registration object's associated [SoftLayer_Account]({{}}) id -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The registration object's associated [SoftLayer_Account]({{Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The CIDR prefix for the registered subnet [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The CIDR prefix for the registered subnet [id]: #id #### [id] Unique ID of the registration object -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Unique ID of the registration object [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ Unique ID of the registration object [networkHandle]: #networkhandle #### [networkHandle] The RIR-specific handle or name of the registered subnet. This field is read-only. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The RIR-specific handle or name of the registered subnet. This field is read-onl [networkIdentifier]: #networkidentifier #### [networkIdentifier] The base IP address of the registered subnet -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The base IP address of the registered subnet [regionalInternetRegistryHandleId]: #regionalinternetregistryhandleid #### [regionalInternetRegistryHandleId] The registration object's associated [SoftLayer_Account_Rwhois_Handle]({{}}) id -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ The registration object's associated [SoftLayer_Account_Rwhois_Handle]({{}}) id -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ The registration object's associated [SoftLayer_Network_Regional_Internet_Regist [statusId]: #statusid #### [statusId] The registration object's associated [SoftLayer_Network_Subnet_Registration_Status]({{}}) id -Type: **integer** +Type: **integer** + @@ -151,7 +163,8 @@ The registration object's associated [SoftLayer_Network_Subnet_Registration_Stat [account]: #account #### [account] The account that this registration belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -161,7 +174,8 @@ The account that this registration belongs to. [detailReferences]: #detailreferences #### [detailReferences] The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail]({{}}) objects to the registration object. -Type: **SoftLayer_Network_Subnet_Registration_Details[] ** +Type: **SoftLayer_Network_Subnet_Registration_Details[] ** + @@ -171,7 +185,8 @@ The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_De [events]: #events #### [events] The related registration events. -Type: **SoftLayer_Network_Subnet_Registration_Event[] ** +Type: **SoftLayer_Network_Subnet_Registration_Event[] ** + @@ -181,7 +196,8 @@ The related registration events. [networkDetail]: #networkdetail #### [networkDetail] The "network" detail object. -Type: **SoftLayer_Account_Regional_Registry_Detail ** +Type: **SoftLayer_Account_Regional_Registry_Detail ** + @@ -191,7 +207,8 @@ The "network" detail object. [personDetail]: #persondetail #### [personDetail] The "person" detail object. -Type: **SoftLayer_Account_Regional_Registry_Detail ** +Type: **SoftLayer_Account_Regional_Registry_Detail ** + @@ -201,7 +218,8 @@ The "person" detail object. [regionalInternetRegistry]: #regionalinternetregistry #### [regionalInternetRegistry] The related Regional Internet Registry. -Type: **SoftLayer_Network_Regional_Internet_Registry ** +Type: **SoftLayer_Network_Regional_Internet_Registry ** + @@ -211,7 +229,8 @@ The related Regional Internet Registry. [regionalInternetRegistryHandle]: #regionalinternetregistryhandle #### [regionalInternetRegistryHandle] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete. -Type: **SoftLayer_Account_Rwhois_Handle ** +Type: **SoftLayer_Account_Rwhois_Handle ** + @@ -221,7 +240,8 @@ The RIR handle that this registration object belongs to. This field may not be p [status]: #status #### [status] The status of this registration. -Type: **SoftLayer_Network_Subnet_Registration_Status ** +Type: **SoftLayer_Network_Subnet_Registration_Status ** + @@ -231,7 +251,8 @@ The status of this registration. [subnet]: #subnet #### [subnet] The subnet that this registration pertains to. -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + @@ -243,7 +264,8 @@ The subnet that this registration pertains to. [detailReferenceCount]: #detailreferencecount #### [detailReferenceCount] A count of the cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail]({{}}) objects to the registration object. -Type: **unsigned long** +Type: **unsigned long** + @@ -253,7 +275,8 @@ A count of the cross-reference records that tie the [SoftLayer_Account_Regional_ [eventCount]: #eventcount #### [eventCount] A count of the related registration events. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Arin/_index.md b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Arin/_index.md index 78a613498a..747267aeac 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Arin/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Arin/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + ARIN-specific registration object. For more detail see [SoftLayer_Network_Subnet_Registration]({{}}). @@ -45,7 +47,8 @@ ARIN-specific registration object. For more detail see [SoftLayer_Network_Subnet [accountId]: #accountid #### [accountId] The registration object's associated [SoftLayer_Account]({{}}) id -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The registration object's associated [SoftLayer_Account]({{Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The CIDR prefix for the registered subnet [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The CIDR prefix for the registered subnet [id]: #id #### [id] Unique ID of the registration object -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Unique ID of the registration object [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ Unique ID of the registration object [networkHandle]: #networkhandle #### [networkHandle] The RIR-specific handle or name of the registered subnet. This field is read-only. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The RIR-specific handle or name of the registered subnet. This field is read-onl [networkIdentifier]: #networkidentifier #### [networkIdentifier] The base IP address of the registered subnet -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The base IP address of the registered subnet [regionalInternetRegistryHandleId]: #regionalinternetregistryhandleid #### [regionalInternetRegistryHandleId] The registration object's associated [SoftLayer_Account_Rwhois_Handle]({{}}) id -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ The registration object's associated [SoftLayer_Account_Rwhois_Handle]({{}}) id -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ The registration object's associated [SoftLayer_Network_Regional_Internet_Regist [statusId]: #statusid #### [statusId] The registration object's associated [SoftLayer_Network_Subnet_Registration_Status]({{}}) id -Type: **integer** +Type: **integer** + @@ -151,7 +163,8 @@ The registration object's associated [SoftLayer_Network_Subnet_Registration_Stat [account]: #account #### [account] The account that this registration belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -161,7 +174,8 @@ The account that this registration belongs to. [detailReferences]: #detailreferences #### [detailReferences] The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail]({{}}) objects to the registration object. -Type: **SoftLayer_Network_Subnet_Registration_Details[] ** +Type: **SoftLayer_Network_Subnet_Registration_Details[] ** + @@ -171,7 +185,8 @@ The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_De [events]: #events #### [events] The related registration events. -Type: **SoftLayer_Network_Subnet_Registration_Event[] ** +Type: **SoftLayer_Network_Subnet_Registration_Event[] ** + @@ -181,7 +196,8 @@ The related registration events. [networkDetail]: #networkdetail #### [networkDetail] The "network" detail object. -Type: **SoftLayer_Account_Regional_Registry_Detail ** +Type: **SoftLayer_Account_Regional_Registry_Detail ** + @@ -191,7 +207,8 @@ The "network" detail object. [personDetail]: #persondetail #### [personDetail] The "person" detail object. -Type: **SoftLayer_Account_Regional_Registry_Detail ** +Type: **SoftLayer_Account_Regional_Registry_Detail ** + @@ -201,7 +218,8 @@ The "person" detail object. [regionalInternetRegistry]: #regionalinternetregistry #### [regionalInternetRegistry] The related Regional Internet Registry. -Type: **SoftLayer_Network_Regional_Internet_Registry ** +Type: **SoftLayer_Network_Regional_Internet_Registry ** + @@ -211,7 +229,8 @@ The related Regional Internet Registry. [regionalInternetRegistryHandle]: #regionalinternetregistryhandle #### [regionalInternetRegistryHandle] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete. -Type: **SoftLayer_Account_Rwhois_Handle ** +Type: **SoftLayer_Account_Rwhois_Handle ** + @@ -221,7 +240,8 @@ The RIR handle that this registration object belongs to. This field may not be p [status]: #status #### [status] The status of this registration. -Type: **SoftLayer_Network_Subnet_Registration_Status ** +Type: **SoftLayer_Network_Subnet_Registration_Status ** + @@ -231,7 +251,8 @@ The status of this registration. [subnet]: #subnet #### [subnet] The subnet that this registration pertains to. -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + @@ -243,7 +264,8 @@ The subnet that this registration pertains to. [detailReferenceCount]: #detailreferencecount #### [detailReferenceCount] A count of the cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail]({{}}) objects to the registration object. -Type: **unsigned long** +Type: **unsigned long** + @@ -253,7 +275,8 @@ A count of the cross-reference records that tie the [SoftLayer_Account_Regional_ [eventCount]: #eventcount #### [eventCount] A count of the related registration events. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details/_index.md b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details/_index.md index c5800e528d..ed514716bd 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Subnet_Registration_Details objects are used to relate [SoftLayer_Account_Regional_Registry_Detail]({{}}) objects to a [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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Subnet_Registration_Details objects are used to relate [So [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The SoftLayer_Network_Subnet_Registration_Details objects are used to relate [So [detailId]: #detailid #### [detailId] Numeric ID of the related [SoftLayer_Account_Regional_Registry_Detail]({{}}) object -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Numeric ID of the related [SoftLayer_Account_Regional_Registry_Detail]({{Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ Unique numeric ID of the object [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ Unique numeric ID of the object [registrationId]: #registrationid #### [registrationId] Numeric ID of the related [SoftLayer_Network_Subnet_Registration]({{}}) object -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ Numeric ID of the related [SoftLayer_Network_Subnet_Registration]({{}}). -Type: **SoftLayer_Account_Regional_Registry_Detail ** +Type: **SoftLayer_Account_Regional_Registry_Detail ** + @@ -111,7 +119,8 @@ The related [SoftLayer_Account_Regional_Registry_Detail]({{}}). -Type: **SoftLayer_Network_Subnet_Registration ** +Type: **SoftLayer_Network_Subnet_Registration ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event/_index.md b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event/_index.md index ea71b1744a..c9cafc30c1 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Each time a [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. * @@ -45,7 +47,8 @@ Each time a [SoftLayer_Network_Subnet_Registration]({{Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ Each time a [SoftLayer_Network_Subnet_Registration]({{Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Unique numeric ID of the event object [message]: #message #### [message] A string message indicating what took place during this event -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A string message indicating what took place during this event [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ A string message indicating what took place during this event [registrationId]: #registrationid #### [registrationId] The numeric ID of the related [SoftLayer_Network_Subnet_Registration]({{}}) object -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The numeric ID of the related [SoftLayer_Network_Subnet_Registration]({{}}) object -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The numeric ID of the associated [SoftLayer_Network_Subnet_Registration_Event_Ty [registration]: #registration #### [registration] The registration this event pertains to. -Type: **SoftLayer_Network_Subnet_Registration ** +Type: **SoftLayer_Network_Subnet_Registration ** + @@ -121,7 +130,8 @@ The registration this event pertains to. [type]: #type #### [type] The type of this event. -Type: **SoftLayer_Network_Subnet_Registration_Event_Type ** +Type: **SoftLayer_Network_Subnet_Registration_Event_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event_Type/_index.md index 1566c096fa..07f2504b0f 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Subnet Registration Event Type objects describe the nature of a [SoftLayer_Network_Subnet_Registration_Event]({{}}) The standard values for these objects are as follows:
      • REGISTRATION_CREATED - Indicates that the registration has been created
      • REGISTRATION_UPDATED - Indicates that the registration has been updated
      • REGISTRATION_CANCELLED - Indicates that the registration has been cancelled
      • RIR_RESPONSE - Indicates that an action taken against the RIR has produced a response. More details will be provided in the event message.
      • ERROR - Indicates that an error has been encountered. More details will be provided in the event message.
      • NOTE - An employee or other system has entered a note regarding the registration. The note content will be provided in the event message.
      @@ -47,7 +49,8 @@ The standard values for these objects are as follows:
      • REGISTRAT [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -57,7 +60,8 @@ The standard values for these objects are as follows:
        • REGISTRAT [id]: #id #### [id] Unique numeric ID of the event type object -Type: **integer** +Type: **integer** + @@ -67,7 +71,8 @@ Unique numeric ID of the event type object [keyName]: #keyname #### [keyName] Code-friendly string name of the event type -Type: **string** +Type: **string** + @@ -77,7 +82,8 @@ Code-friendly string name of the event type [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -87,7 +93,8 @@ Code-friendly string name of the event type [name]: #name #### [name] Human-readable name of the event type -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Ripe/_index.md b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Ripe/_index.md index d1e9f5b531..934a70b258 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Ripe/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Ripe/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + RIPE-specific registration object. For more detail see [SoftLayer_Network_Subnet_Registration]({{}}). @@ -45,7 +47,8 @@ RIPE-specific registration object. For more detail see [SoftLayer_Network_Subnet [accountId]: #accountid #### [accountId] The registration object's associated [SoftLayer_Account]({{}}) id -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The registration object's associated [SoftLayer_Account]({{Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The CIDR prefix for the registered subnet [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The CIDR prefix for the registered subnet [id]: #id #### [id] Unique ID of the registration object -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Unique ID of the registration object [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ Unique ID of the registration object [networkHandle]: #networkhandle #### [networkHandle] The RIR-specific handle or name of the registered subnet. This field is read-only. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The RIR-specific handle or name of the registered subnet. This field is read-onl [networkIdentifier]: #networkidentifier #### [networkIdentifier] The base IP address of the registered subnet -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The base IP address of the registered subnet [regionalInternetRegistryHandleId]: #regionalinternetregistryhandleid #### [regionalInternetRegistryHandleId] The registration object's associated [SoftLayer_Account_Rwhois_Handle]({{}}) id -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ The registration object's associated [SoftLayer_Account_Rwhois_Handle]({{}}) id -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ The registration object's associated [SoftLayer_Network_Regional_Internet_Regist [statusId]: #statusid #### [statusId] The registration object's associated [SoftLayer_Network_Subnet_Registration_Status]({{}}) id -Type: **integer** +Type: **integer** + @@ -151,7 +163,8 @@ The registration object's associated [SoftLayer_Network_Subnet_Registration_Stat [account]: #account #### [account] The account that this registration belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -161,7 +174,8 @@ The account that this registration belongs to. [detailReferences]: #detailreferences #### [detailReferences] The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail]({{}}) objects to the registration object. -Type: **SoftLayer_Network_Subnet_Registration_Details[] ** +Type: **SoftLayer_Network_Subnet_Registration_Details[] ** + @@ -171,7 +185,8 @@ The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_De [events]: #events #### [events] The related registration events. -Type: **SoftLayer_Network_Subnet_Registration_Event[] ** +Type: **SoftLayer_Network_Subnet_Registration_Event[] ** + @@ -181,7 +196,8 @@ The related registration events. [networkDetail]: #networkdetail #### [networkDetail] The "network" detail object. -Type: **SoftLayer_Account_Regional_Registry_Detail ** +Type: **SoftLayer_Account_Regional_Registry_Detail ** + @@ -191,7 +207,8 @@ The "network" detail object. [personDetail]: #persondetail #### [personDetail] The "person" detail object. -Type: **SoftLayer_Account_Regional_Registry_Detail ** +Type: **SoftLayer_Account_Regional_Registry_Detail ** + @@ -201,7 +218,8 @@ The "person" detail object. [regionalInternetRegistry]: #regionalinternetregistry #### [regionalInternetRegistry] The related Regional Internet Registry. -Type: **SoftLayer_Network_Regional_Internet_Registry ** +Type: **SoftLayer_Network_Regional_Internet_Registry ** + @@ -211,7 +229,8 @@ The related Regional Internet Registry. [regionalInternetRegistryHandle]: #regionalinternetregistryhandle #### [regionalInternetRegistryHandle] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete. -Type: **SoftLayer_Account_Rwhois_Handle ** +Type: **SoftLayer_Account_Rwhois_Handle ** + @@ -221,7 +240,8 @@ The RIR handle that this registration object belongs to. This field may not be p [status]: #status #### [status] The status of this registration. -Type: **SoftLayer_Network_Subnet_Registration_Status ** +Type: **SoftLayer_Network_Subnet_Registration_Status ** + @@ -231,7 +251,8 @@ The status of this registration. [subnet]: #subnet #### [subnet] The subnet that this registration pertains to. -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + @@ -243,7 +264,8 @@ The subnet that this registration pertains to. [detailReferenceCount]: #detailreferencecount #### [detailReferenceCount] A count of the cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail]({{}}) objects to the registration object. -Type: **unsigned long** +Type: **unsigned long** + @@ -253,7 +275,8 @@ A count of the cross-reference records that tie the [SoftLayer_Account_Regional_ [eventCount]: #eventcount #### [eventCount] A count of the related registration events. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Status/_index.md b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Status/_index.md index ff747c6b17..5a6c9ca62e 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_Registration_Status/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + Subnet Registration Status objects describe the current status of a subnet registration. The standard values for these objects are as follows:
          • OPEN - Indicates that the registration object is new and has yet to be submitted to the RIR
          • PENDING - Indicates that the registration object has been submitted to the RIR and is awaiting response
          • COMPLETE - Indicates that the RIR action has completed
          • DELETED - Indicates that the registration object has been gracefully removed is no longer valid
          • CANCELLED - Indicates that the registration object has been abruptly removed is no longer valid
          @@ -49,7 +51,8 @@ The standard values for these objects are as follows:
          • OPENType: **dateTime** +Type: **dateTime** + @@ -59,7 +62,8 @@ The standard values for these objects are as follows:
            • OPENType: **integer** +Type: **integer** + @@ -69,7 +73,8 @@ Unique numeric ID of the status object [keyName]: #keyname #### [keyName] Code-friendly string name of the status -Type: **string** +Type: **string** + @@ -79,7 +84,8 @@ Code-friendly string name of the status [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -89,7 +95,8 @@ Code-friendly string name of the status [name]: #name #### [name] Human-readable name of the status -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_Rwhois_Data/_index.md b/content/reference/datatypes/SoftLayer_Network_Subnet_Rwhois_Data/_index.md index 555e14171a..13f468a0f6 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_Rwhois_Data/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_Rwhois_Data/_index.md @@ -18,6 +18,9 @@ classes: ## Description + +
              Deprecated
              + 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. @@ -70,7 +73,8 @@ A SoftLayer customer's RWHOIS data may not necessarily match their account or po [abuseEmail]: #abuseemail #### [abuseEmail] An email address associated with an account's RWHOIS data that is responsible for responding to network abuse queries about malicious traffic coming from your servers' IP addresses. -Type: **string** +Type: **string** + @@ -80,7 +84,8 @@ An email address associated with an account's RWHOIS data that is responsible fo [accountId]: #accountid #### [accountId] An account's RWHOIS data's associated account identifier. -Type: **integer** +Type: **integer** + @@ -90,7 +95,8 @@ An account's RWHOIS data's associated account identifier. [address1]: #address1 #### [address1] The first line of the mailing address associated with an account's RWHOIS data. -Type: **string** +Type: **string** + @@ -100,7 +106,8 @@ The first line of the mailing address associated with an account's RWHOIS data. [address2]: #address2 #### [address2] The second line of the mailing address associated with an account's RWHOIS data. -Type: **string** +Type: **string** + @@ -110,7 +117,8 @@ The second line of the mailing address associated with an account's RWHOIS data. [city]: #city #### [city] The city of the mailing address associated with an account's RWHOIS data. -Type: **string** +Type: **string** + @@ -120,7 +128,8 @@ The city of the mailing address associated with an account's RWHOIS data. [companyName]: #companyname #### [companyName] The company name associated with an account's RWHOIS data. -Type: **string** +Type: **string** + @@ -130,7 +139,8 @@ The company name associated with an account's RWHOIS data. [country]: #country #### [country] A two-letter abbreviation of the country of the mailing address associated with an account's RWHOIS data. -Type: **string** +Type: **string** + @@ -140,7 +150,8 @@ A two-letter abbreviation of the country of the mailing address associated with [createDate]: #createdate #### [createDate] The date an account's RWHOIS data was created. -Type: **dateTime** +Type: **dateTime** + @@ -150,7 +161,8 @@ The date an account's RWHOIS data was created. [firstName]: #firstname #### [firstName] The first name associated with an account's RWHOIS data. -Type: **string** +Type: **string** + @@ -160,7 +172,8 @@ The first name associated with an account's RWHOIS data. [id]: #id #### [id] An account's RWHOIS data's internal identifier. -Type: **integer** +Type: **integer** + @@ -170,7 +183,8 @@ An account's RWHOIS data's internal identifier. [lastName]: #lastname #### [lastName] The last name associated with an account's RWHOIS data. -Type: **string** +Type: **string** + @@ -180,7 +194,8 @@ The last name associated with an account's RWHOIS data. [modifyDate]: #modifydate #### [modifyDate] The date an account's RWHOIS data was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -190,7 +205,8 @@ The date an account's RWHOIS data was last modified. [postalCode]: #postalcode #### [postalCode] The postal code of the mailing address associated with an account's RWHOIS data. -Type: **string** +Type: **string** + @@ -200,7 +216,8 @@ The postal code of the mailing address associated with an account's RWHOIS data. [privateResidenceFlag]: #privateresidenceflag #### [privateResidenceFlag] Whether an account's RWHOIS data refers to a private residence or not. -Type: **boolean** +Type: **boolean** + @@ -210,7 +227,8 @@ Whether an account's RWHOIS data refers to a private residence or not. [state]: #state #### [state] A two-letter abbreviation of the state of the mailing address associated with an account's RWHOIS data. If an account does not reside in a province then this is typically blank. -Type: **string** +Type: **string** + @@ -226,7 +244,8 @@ A two-letter abbreviation of the state of the mailing address associated with an [account]: #account #### [account] The SoftLayer customer account associated with this reverse WHOIS data. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Subnet_Swip_Transaction/_index.md b/content/reference/datatypes/SoftLayer_Network_Subnet_Swip_Transaction/_index.md index 17197bbcaa..2d831b4550 100644 --- a/content/reference/datatypes/SoftLayer_Network_Subnet_Swip_Transaction/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Subnet_Swip_Transaction/_index.md @@ -20,6 +20,9 @@ classes: ## Description +
              Deprecated
              + + **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: @@ -70,7 +73,8 @@ The SoftLayer_Network_Subnet_Swip_Transaction data type contains basic informati [id]: #id #### [id] A SWIP transaction's unique identifier. -Type: **integer** +Type: **integer** + @@ -80,7 +84,8 @@ A SWIP transaction's unique identifier. [statusName]: #statusname #### [statusName] A Name describing which state a SWIP transaction is in. -Type: **string** +Type: **string** + @@ -90,7 +95,8 @@ A Name describing which state a SWIP transaction is in. [subnetId]: #subnetid #### [subnetId] ID Number of the Subnet for this SWIP transaction. -Type: **integer** +Type: **integer** + @@ -106,7 +112,8 @@ ID Number of the Subnet for this SWIP transaction. [account]: #account #### [account] The Account whose RWHOIS data was used to SWIP this subnet -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -116,7 +123,8 @@ The Account whose RWHOIS data was used to SWIP this subnet [subnet]: #subnet #### [subnet] The subnet that this SWIP transaction was created for. -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Tunnel_Module_Context/_index.md b/content/reference/datatypes/SoftLayer_Network_Tunnel_Module_Context/_index.md index 8d7088b361..82af6566ad 100644 --- a/content/reference/datatypes/SoftLayer_Network_Tunnel_Module_Context/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Tunnel_Module_Context/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -51,7 +53,8 @@ The SoftLayer_Network_Tunnel_Module_Context data type contains general informati [accountId]: #accountid #### [accountId] A network tunnel's account identifier. -Type: **integer** +Type: **integer** + @@ -61,7 +64,8 @@ A network tunnel's account identifier. [advancedConfigurationFlag]: #advancedconfigurationflag #### [advancedConfigurationFlag] A flag used to specify when advanced configurations, complex configurations that require manual setup, are being applied to network devices for a network tunnel. When the flag is set to true (1), a network tunnel cannot be configured through the management portal nor the API. -Type: **integer** +Type: **integer** + @@ -71,7 +75,8 @@ A flag used to specify when advanced configurations, complex configurations that [createDate]: #createdate #### [createDate] The date a network tunnel was created. -Type: **dateTime** +Type: **dateTime** + @@ -81,7 +86,8 @@ The date a network tunnel was created. [customerPeerIpAddress]: #customerpeeripaddress #### [customerPeerIpAddress] The remote end of a network tunnel. This end of the network tunnel resides on an outside network and will be sending and receiving the IPSec packets. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The remote end of a network tunnel. This end of the network tunnel resides on an [friendlyName]: #friendlyname #### [friendlyName] The name giving to a network tunnel by a user. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The name giving to a network tunnel by a user. [id]: #id #### [id] A network tunnel's unique identifier. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ A network tunnel's unique identifier. [internalPeerIpAddress]: #internalpeeripaddress #### [internalPeerIpAddress] The local end of a network tunnel. This end of the network tunnel resides on the SoftLayer networks and allows access to remote end of the tunnel to subnets on SoftLayer networks. -Type: **string** +Type: **string** + @@ -123,7 +132,8 @@ The local end of a network tunnel. This end of the network tunnel resides on th The date a network tunnel was last modified. NOTE: This date should NOT be used to determine when the network tunnel configurations were last applied to the network device. -Type: **dateTime** +Type: **dateTime** + @@ -133,7 +143,8 @@ NOTE: This date should NOT be used to determine when the network tunnel configu [name]: #name #### [name] A network tunnel's unique name used on the network device. -Type: **string** +Type: **string** + @@ -143,7 +154,8 @@ A network tunnel's unique name used on the network device. [phaseOneAuthentication]: #phaseoneauthentication #### [phaseOneAuthentication] Authentication used to generate keys for protecting the negotiations for a network tunnel. -Type: **string** +Type: **string** + @@ -153,7 +165,8 @@ Authentication used to generate keys for protecting the negotiations for a netwo [phaseOneDiffieHellmanGroup]: #phaseonediffiehellmangroup #### [phaseOneDiffieHellmanGroup] Determines the strength of the key used in the key exchange process. The higher the group number the stronger the key is and the more secure it is. However, processing time will increase as the strength of the key increases. Both peers in the must use the Diffie-Hellman Group. -Type: **integer** +Type: **integer** + @@ -163,7 +176,8 @@ Determines the strength of the key used in the key exchange process. The higher [phaseOneEncryption]: #phaseoneencryption #### [phaseOneEncryption] Encryption used to generate keys for protecting the negotiations for a network tunnel. -Type: **string** +Type: **string** + @@ -173,7 +187,8 @@ Encryption used to generate keys for protecting the negotiations for a network t [phaseOneKeylife]: #phaseonekeylife #### [phaseOneKeylife] Amount of time (in seconds) allowed to pass before the encryption key expires. A new key is generated without interrupting service. Valid times are from 120 to 172800 seconds. -Type: **integer** +Type: **integer** + @@ -183,7 +198,8 @@ Amount of time (in seconds) allowed to pass before the encryption key expires. [phaseTwoAuthentication]: #phasetwoauthentication #### [phaseTwoAuthentication] The authentication used in phase 2 proposal negotiation process. -Type: **string** +Type: **string** + @@ -193,7 +209,8 @@ The authentication used in phase 2 proposal negotiation process. [phaseTwoDiffieHellmanGroup]: #phasetwodiffiehellmangroup #### [phaseTwoDiffieHellmanGroup] Determines the strength of the key used in the key exchange process. The higher the group number the stronger the key is and the more secure it is. However, processing time will increase as the strength of the key increases. Both peers must use the Diffie-Hellman Group. -Type: **integer** +Type: **integer** + @@ -203,7 +220,8 @@ Determines the strength of the key used in the key exchange process. The higher [phaseTwoEncryption]: #phasetwoencryption #### [phaseTwoEncryption] The encryption used in phase 2 proposal negotiation process. -Type: **string** +Type: **string** + @@ -213,7 +231,8 @@ The encryption used in phase 2 proposal negotiation process. [phaseTwoKeylife]: #phasetwokeylife #### [phaseTwoKeylife] Amount of time (in seconds) allowed to pass before the encryption key expires. A new key is generated without interrupting service. Valid times are from 120 to 172800 seconds. -Type: **integer** +Type: **integer** + @@ -223,7 +242,8 @@ Amount of time (in seconds) allowed to pass before the encryption key expires. [phaseTwoPerfectForwardSecrecy]: #phasetwoperfectforwardsecrecy #### [phaseTwoPerfectForwardSecrecy] Determines if the generated keys are made from previous keys. When PFS is specified, a Diffie-Hellman exchange occurs each time a new security association is negotiated. -Type: **integer** +Type: **integer** + @@ -233,7 +253,8 @@ Determines if the generated keys are made from previous keys. When PFS is speci [presharedKey]: #presharedkey #### [presharedKey] A key used so that peers authenticate each other. This key is hashed by using the phase one encryption and phase one authentication. -Type: **string** +Type: **string** + @@ -249,17 +270,20 @@ A key used so that peers authenticate each other. This key is hashed by using t [account]: #account #### [account] The account that a network tunnel belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + -
              +
              ----- [activeTransaction]: #activetransaction #### [activeTransaction] DEPRECATED -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + +Deprecated
              @@ -269,7 +293,8 @@ DEPRECATED [addressTranslations]: #addresstranslations #### [addressTranslations] A network tunnel's address translations. -Type: **SoftLayer_Network_Tunnel_Module_Context_Address_Translation[] ** +Type: **SoftLayer_Network_Tunnel_Module_Context_Address_Translation[] ** +
              @@ -279,7 +304,8 @@ A network tunnel's address translations. [allAvailableServiceSubnets]: #allavailableservicesubnets #### [allAvailableServiceSubnets] Subnets that provide access to SoftLayer services such as the management portal and the SoftLayer API. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -289,7 +315,8 @@ Subnets that provide access to SoftLayer services such as the management portal [billingItem]: #billingitem #### [billingItem] The current billing item for network tunnel. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -299,7 +326,8 @@ The current billing item for network tunnel. [customerSubnets]: #customersubnets #### [customerSubnets] Remote subnets that are allowed access through a network tunnel. -Type: **SoftLayer_Network_Customer_Subnet[] ** +Type: **SoftLayer_Network_Customer_Subnet[] ** + @@ -309,7 +337,8 @@ Remote subnets that are allowed access through a network tunnel. [datacenter]: #datacenter #### [datacenter] The datacenter location for one end of the network tunnel that allows access to account's private subnets. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -319,7 +348,8 @@ The datacenter location for one end of the network tunnel that allows access to [internalSubnets]: #internalsubnets #### [internalSubnets] Private subnets that can be accessed through the network tunnel. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -329,7 +359,8 @@ Private subnets that can be accessed through the network tunnel. [serviceSubnets]: #servicesubnets #### [serviceSubnets] Service subnets that can be access through the network tunnel. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -339,17 +370,20 @@ Service subnets that can be access through the network tunnel. [staticRouteSubnets]: #staticroutesubnets #### [staticRouteSubnets] Subnets used for a network tunnel's address translations. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + -
              +
              ----- [transactionHistory]: #transactionhistory #### [transactionHistory] DEPRECATED -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + +Deprecated
              @@ -361,7 +395,8 @@ DEPRECATED [addressTranslationCount]: #addresstranslationcount #### [addressTranslationCount] A count of a network tunnel's address translations. -Type: **unsigned long** +Type: **unsigned long** +
              @@ -371,7 +406,8 @@ A count of a network tunnel's address translations. [allAvailableServiceSubnetCount]: #allavailableservicesubnetcount #### [allAvailableServiceSubnetCount] A count of subnets that provide access to SoftLayer services such as the management portal and the SoftLayer API. -Type: **unsigned long** +Type: **unsigned long** + @@ -381,7 +417,8 @@ A count of subnets that provide access to SoftLayer services such as the managem [customerSubnetCount]: #customersubnetcount #### [customerSubnetCount] A count of remote subnets that are allowed access through a network tunnel. -Type: **unsigned long** +Type: **unsigned long** + @@ -391,7 +428,8 @@ A count of remote subnets that are allowed access through a network tunnel. [internalSubnetCount]: #internalsubnetcount #### [internalSubnetCount] A count of private subnets that can be accessed through the network tunnel. -Type: **unsigned long** +Type: **unsigned long** + @@ -401,7 +439,8 @@ A count of private subnets that can be accessed through the network tunnel. [serviceSubnetCount]: #servicesubnetcount #### [serviceSubnetCount] A count of service subnets that can be access through the network tunnel. -Type: **unsigned long** +Type: **unsigned long** + @@ -411,7 +450,8 @@ A count of service subnets that can be access through the network tunnel. [staticRouteSubnetCount]: #staticroutesubnetcount #### [staticRouteSubnetCount] A count of subnets used for a network tunnel's address translations. -Type: **unsigned long** +Type: **unsigned long** + @@ -421,7 +461,8 @@ A count of subnets used for a network tunnel's address translations. [transactionHistoryCount]: #transactionhistorycount #### [transactionHistoryCount] A count of dEPRECATED -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Tunnel_Module_Context_Address_Translation/_index.md b/content/reference/datatypes/SoftLayer_Network_Tunnel_Module_Context_Address_Translation/_index.md index 962a20b03b..5bcb771d1e 100644 --- a/content/reference/datatypes/SoftLayer_Network_Tunnel_Module_Context_Address_Translation/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Tunnel_Module_Context_Address_Translation/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Network_Tunnel_Module_Context_Address_Translation data type contai [customerIpAddress]: #customeripaddress #### [customerIpAddress] The ip address record that will receive the encrypted traffic. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The ip address record that will receive the encrypted traffic. [customerIpAddressId]: #customeripaddressid #### [customerIpAddressId] The unique identifier for the ip address record that will receive the encrypted traffic. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The unique identifier for the ip address record that will receive the encrypted [id]: #id #### [id] An address translation's unique identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ An address translation's unique identifier. [internalIpAddress]: #internalipaddress #### [internalIpAddress] The ip address record that will deliver the encrypted traffic. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The ip address record that will deliver the encrypted traffic. [internalIpAddressId]: #internalipaddressid #### [internalIpAddressId] The unique identifier for the ip address record that will deliver the encrypted traffic. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The unique identifier for the ip address record that will deliver the encrypted [networkTunnelContextId]: #networktunnelcontextid #### [networkTunnelContextId] An address translation's network tunnel identifier. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ An address translation's network tunnel identifier. [notes]: #notes #### [notes] A name or description given to an address translation to help identify the address translation. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ A name or description given to an address translation to help identify the addre [customerIpAddressRecord]: #customeripaddressrecord #### [customerIpAddressRecord] The ip address record for the ip that will receive the encrypted traffic from the IPSec network tunnel. -Type: **SoftLayer_Network_Customer_Subnet_IpAddress ** +Type: **SoftLayer_Network_Customer_Subnet_IpAddress ** + @@ -131,7 +141,8 @@ The ip address record for the ip that will receive the encrypted traffic from th [internalIpAddressRecord]: #internalipaddressrecord #### [internalIpAddressRecord] The ip address record for the ip that will deliver the encrypted traffic from the IPSec network tunnel. -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -141,7 +152,8 @@ The ip address record for the ip that will deliver the encrypted traffic from th [networkTunnelContext]: #networktunnelcontext #### [networkTunnelContext] The IPSec network tunnel an address translation belongs to. -Type: **SoftLayer_Network_Tunnel_Module_Context ** +Type: **SoftLayer_Network_Tunnel_Module_Context ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Vlan/_index.md b/content/reference/datatypes/SoftLayer_Network_Vlan/_index.md index 6e33690d05..0a793a9cd5 100644 --- a/content/reference/datatypes/SoftLayer_Network_Vlan/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Vlan/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_Vlan data type models a single VLAN within SoftLayer's public and private networks. a Virtual LAN is a structure that associates network interfaces on routers, switches, and servers in different locations to act as if they were on the same local network broadcast domain. VLANs are a central part of the SoftLayer network. They can determine how new IP subnets are routed and how individual servers communicate to each other. ### External Links @@ -61,7 +63,8 @@ The SoftLayer_Network_Vlan data type models a single VLAN within SoftLayer's pub [accountId]: #accountid #### [accountId] The internal identifier of the SoftLayer customer account that a VLAN is associated with. -Type: **integer** +Type: **integer** + @@ -71,7 +74,8 @@ The internal identifier of the SoftLayer customer account that a VLAN is associa [fullyQualifiedName]: #fullyqualifiedname #### [fullyQualifiedName] A human readable, unique identifier for a VLAN. -Type: **string** +Type: **string** + @@ -81,7 +85,8 @@ A human readable, unique identifier for a VLAN. [id]: #id #### [id] A VLAN's internal identifier. This should not be confused with the ''vlanNumber'' property, which is used in network configuration. -Type: **integer** +Type: **integer** + @@ -91,7 +96,8 @@ A VLAN's internal identifier. This should not be confused with the ''vlanNumber' [modifyDate]: #modifydate #### [modifyDate] The date a VLAN was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -101,7 +107,8 @@ The date a VLAN was last modified. [name]: #name #### [name] The optional name for this VLAN -Type: **string** +Type: **string** + @@ -111,7 +118,8 @@ The optional name for this VLAN [note]: #note #### [note] The note for this vlan. -Type: **string** +Type: **string** + @@ -121,7 +129,8 @@ The note for this vlan. [primarySubnetId]: #primarysubnetid #### [primarySubnetId] The internal identifier of the primary subnet addressed on a VLAN. -Type: **integer** +Type: **integer** + @@ -131,7 +140,8 @@ The internal identifier of the primary subnet addressed on a VLAN. [vlanNumber]: #vlannumber #### [vlanNumber] A VLAN's number as recorded within the SoftLayer network. This is configured directly on SoftLayer's networking equipment and should not be confused with a VLAN's ''id'' property. -Type: **integer** +Type: **integer** + @@ -147,7 +157,8 @@ A VLAN's number as recorded within the SoftLayer network. This is configured dir [account]: #account #### [account] The SoftLayer customer account associated with a VLAN. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -157,7 +168,8 @@ The SoftLayer customer account associated with a VLAN. [additionalPrimarySubnets]: #additionalprimarysubnets #### [additionalPrimarySubnets] A VLAN's additional primary subnets. These are used to extend the number of servers attached to the VLAN by adding more ip addresses to the primary IP address pool. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -167,7 +179,8 @@ A VLAN's additional primary subnets. These are used to extend the number of serv [attachedNetworkGateway]: #attachednetworkgateway #### [attachedNetworkGateway] The gateway this VLAN is inside of. -Type: **SoftLayer_Network_Gateway ** +Type: **SoftLayer_Network_Gateway ** + @@ -177,7 +190,8 @@ The gateway this VLAN is inside of. [attachedNetworkGatewayFlag]: #attachednetworkgatewayflag #### [attachedNetworkGatewayFlag] Whether or not this VLAN is inside a gateway. -Type: **boolean** +Type: **boolean** + @@ -187,7 +201,8 @@ Whether or not this VLAN is inside a gateway. [attachedNetworkGatewayVlan]: #attachednetworkgatewayvlan #### [attachedNetworkGatewayVlan] The inside VLAN record if this VLAN is inside a network gateway. -Type: **SoftLayer_Network_Gateway_Vlan ** +Type: **SoftLayer_Network_Gateway_Vlan ** + @@ -197,7 +212,8 @@ The inside VLAN record if this VLAN is inside a network gateway. [billingItem]: #billingitem #### [billingItem] The billing item for a network vlan. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -207,7 +223,8 @@ The billing item for a network vlan. [dedicatedFirewallFlag]: #dedicatedfirewallflag #### [dedicatedFirewallFlag] A flag indicating that a network vlan is on a Hardware Firewall (Dedicated). -Type: **integer** +Type: **integer** + @@ -217,7 +234,8 @@ A flag indicating that a network vlan is on a Hardware Firewall (Dedicated). [extensionRouter]: #extensionrouter #### [extensionRouter] The extension router that a VLAN is associated with. -Type: **SoftLayer_Hardware_Router ** +Type: **SoftLayer_Hardware_Router ** + @@ -227,7 +245,8 @@ The extension router that a VLAN is associated with. [firewallGuestNetworkComponents]: #firewallguestnetworkcomponents #### [firewallGuestNetworkComponents] A firewalled Vlan's network components. -Type: **SoftLayer_Network_Component_Firewall[] ** +Type: **SoftLayer_Network_Component_Firewall[] ** + @@ -237,7 +256,8 @@ A firewalled Vlan's network components. [firewallInterfaces]: #firewallinterfaces #### [firewallInterfaces] A firewalled vlan's inbound/outbound interfaces. -Type: **SoftLayer_Network_Firewall_Module_Context_Interface[] ** +Type: **SoftLayer_Network_Firewall_Module_Context_Interface[] ** + @@ -247,7 +267,8 @@ A firewalled vlan's inbound/outbound interfaces. [firewallNetworkComponents]: #firewallnetworkcomponents #### [firewallNetworkComponents] A firewalled Vlan's network components. -Type: **SoftLayer_Network_Component_Firewall[] ** +Type: **SoftLayer_Network_Component_Firewall[] ** + @@ -257,7 +278,8 @@ A firewalled Vlan's network components. [firewallRules]: #firewallrules #### [firewallRules] The currently running rule set of a firewalled VLAN. -Type: **SoftLayer_Network_Vlan_Firewall_Rule[] ** +Type: **SoftLayer_Network_Vlan_Firewall_Rule[] ** + @@ -267,7 +289,8 @@ The currently running rule set of a firewalled VLAN. [guestNetworkComponents]: #guestnetworkcomponents #### [guestNetworkComponents] The networking components that are connected to a VLAN. -Type: **SoftLayer_Virtual_Guest_Network_Component[] ** +Type: **SoftLayer_Virtual_Guest_Network_Component[] ** + @@ -277,7 +300,8 @@ The networking components that are connected to a VLAN. [hardware]: #hardware #### [hardware] All of the hardware that exists on a VLAN. Hardware is associated with a VLAN by its networking components. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -287,7 +311,8 @@ All of the hardware that exists on a VLAN. Hardware is associated with a VLAN by [highAvailabilityFirewallFlag]: #highavailabilityfirewallflag #### [highAvailabilityFirewallFlag] -Type: **boolean** +Type: **boolean** + @@ -297,7 +322,8 @@ All of the hardware that exists on a VLAN. Hardware is associated with a VLAN by [localDiskStorageCapabilityFlag]: #localdiskstoragecapabilityflag #### [localDiskStorageCapabilityFlag] A flag indicating that a vlan can be assigned to a host that has local disk functionality. -Type: **boolean** +Type: **boolean** + @@ -307,7 +333,8 @@ A flag indicating that a vlan can be assigned to a host that has local disk func [network]: #network #### [network] The network in which this VLAN resides. -Type: **SoftLayer_Network ** +Type: **SoftLayer_Network ** + @@ -317,7 +344,8 @@ The network in which this VLAN resides. [networkComponentTrunks]: #networkcomponenttrunks #### [networkComponentTrunks] The network components that are connected to this VLAN through a trunk. -Type: **SoftLayer_Network_Component_Network_Vlan_Trunk[] ** +Type: **SoftLayer_Network_Component_Network_Vlan_Trunk[] ** + @@ -327,7 +355,8 @@ The network components that are connected to this VLAN through a trunk. [networkComponents]: #networkcomponents #### [networkComponents] The networking components that are connected to a VLAN. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -337,7 +366,8 @@ The networking components that are connected to a VLAN. [networkComponentsTrunkable]: #networkcomponentstrunkable #### [networkComponentsTrunkable] The viable trunking targets of this VLAN. Viable targets include accessible components of assigned hardware in the same pod and network as this VLAN, which are not already natively attached nor trunked. -Type: **SoftLayer_Network_Component[] ** +Type: **SoftLayer_Network_Component[] ** + @@ -347,7 +377,8 @@ The viable trunking targets of this VLAN. Viable targets include accessible comp [networkSpace]: #networkspace #### [networkSpace] Identifier to denote whether a VLAN is used for public or private connectivity. -Type: **string** +Type: **string** + @@ -357,7 +388,8 @@ Identifier to denote whether a VLAN is used for public or private connectivity. [networkVlanFirewall]: #networkvlanfirewall #### [networkVlanFirewall] The Hardware Firewall (Dedicated) for a network vlan. -Type: **SoftLayer_Network_Vlan_Firewall ** +Type: **SoftLayer_Network_Vlan_Firewall ** + @@ -367,7 +399,8 @@ The Hardware Firewall (Dedicated) for a network vlan. [primaryRouter]: #primaryrouter #### [primaryRouter] The primary router that a VLAN is associated with. Every SoftLayer VLAN is connected to more than one router for greater network redundancy. -Type: **SoftLayer_Hardware_Router ** +Type: **SoftLayer_Hardware_Router ** + @@ -377,7 +410,8 @@ The primary router that a VLAN is associated with. Every SoftLayer VLAN is conne [primarySubnet]: #primarysubnet #### [primarySubnet] A VLAN's primary subnet. Each VLAN has at least one subnet, usually the subnet that is assigned to a server or new IP address block when it's purchased. -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + @@ -387,7 +421,8 @@ A VLAN's primary subnet. Each VLAN has at least one subnet, usually the subnet t [primarySubnetVersion6]: #primarysubnetversion6 #### [primarySubnetVersion6] A VLAN's primary IPv6 subnet. Some VLAN's may not have a primary IPv6 subnet. -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + @@ -397,7 +432,8 @@ A VLAN's primary IPv6 subnet. Some VLAN's may not have a primary IPv6 subnet. [primarySubnets]: #primarysubnets #### [primarySubnets] -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -407,7 +443,8 @@ A VLAN's primary IPv6 subnet. Some VLAN's may not have a primary IPv6 subnet. [privateNetworkGateways]: #privatenetworkgateways #### [privateNetworkGateways] The gateways this VLAN is the private VLAN of. -Type: **SoftLayer_Network_Gateway[] ** +Type: **SoftLayer_Network_Gateway[] ** + @@ -417,7 +454,8 @@ The gateways this VLAN is the private VLAN of. [protectedIpAddresses]: #protectedipaddresses #### [protectedIpAddresses] -Type: **SoftLayer_Network_Subnet_IpAddress[] ** +Type: **SoftLayer_Network_Subnet_IpAddress[] ** + @@ -427,7 +465,8 @@ The gateways this VLAN is the private VLAN of. [publicNetworkGateways]: #publicnetworkgateways #### [publicNetworkGateways] The gateways this VLAN is the public VLAN of. -Type: **SoftLayer_Network_Gateway[] ** +Type: **SoftLayer_Network_Gateway[] ** + @@ -437,7 +476,8 @@ The gateways this VLAN is the public VLAN of. [sanStorageCapabilityFlag]: #sanstoragecapabilityflag #### [sanStorageCapabilityFlag] A flag indicating that a vlan can be assigned to a host that has SAN disk functionality. -Type: **boolean** +Type: **boolean** + @@ -447,7 +487,8 @@ A flag indicating that a vlan can be assigned to a host that has SAN disk functi [scaleVlans]: #scalevlans #### [scaleVlans] Collection of scale VLANs this VLAN applies to. -Type: **SoftLayer_Scale_Network_Vlan[] ** +Type: **SoftLayer_Scale_Network_Vlan[] ** + @@ -457,7 +498,8 @@ Collection of scale VLANs this VLAN applies to. [secondaryRouter]: #secondaryrouter #### [secondaryRouter] The secondary router that a VLAN is associated with. Every SoftLayer VLAN is connected to more than one router for greater network redundancy. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -467,7 +509,8 @@ The secondary router that a VLAN is associated with. Every SoftLayer VLAN is con [secondarySubnets]: #secondarysubnets #### [secondarySubnets] The subnets that exist as secondary interfaces on a VLAN -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -477,7 +520,8 @@ The subnets that exist as secondary interfaces on a VLAN [subnets]: #subnets #### [subnets] All of the subnets that exist as VLAN interfaces. -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -487,7 +531,8 @@ All of the subnets that exist as VLAN interfaces. [tagReferences]: #tagreferences #### [tagReferences] References to all tags for this VLAN. -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** + @@ -497,7 +542,8 @@ References to all tags for this VLAN. [totalPrimaryIpAddressCount]: #totalprimaryipaddresscount #### [totalPrimaryIpAddressCount] The number of primary IP addresses in a VLAN. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -507,7 +553,8 @@ The number of primary IP addresses in a VLAN. [type]: #type #### [type] The type of this VLAN. -Type: **SoftLayer_Network_Vlan_Type ** +Type: **SoftLayer_Network_Vlan_Type ** + @@ -517,7 +564,8 @@ The type of this VLAN. [virtualGuests]: #virtualguests #### [virtualGuests] All of the Virtual Servers that are connected to a VLAN. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -529,7 +577,8 @@ All of the Virtual Servers that are connected to a VLAN. [additionalPrimarySubnetCount]: #additionalprimarysubnetcount #### [additionalPrimarySubnetCount] A count of a VLAN's additional primary subnets. These are used to extend the number of servers attached to the VLAN by adding more ip addresses to the primary IP address pool. -Type: **unsigned long** +Type: **unsigned long** + @@ -539,7 +588,8 @@ A count of a VLAN's additional primary subnets. These are used to extend the num [firewallGuestNetworkComponentCount]: #firewallguestnetworkcomponentcount #### [firewallGuestNetworkComponentCount] A count of a firewalled Vlan's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -549,7 +599,8 @@ A count of a firewalled Vlan's network components. [firewallInterfaceCount]: #firewallinterfacecount #### [firewallInterfaceCount] A count of a firewalled vlan's inbound/outbound interfaces. -Type: **unsigned long** +Type: **unsigned long** + @@ -559,7 +610,8 @@ A count of a firewalled vlan's inbound/outbound interfaces. [firewallNetworkComponentCount]: #firewallnetworkcomponentcount #### [firewallNetworkComponentCount] A count of a firewalled Vlan's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -569,7 +621,8 @@ A count of a firewalled Vlan's network components. [firewallRuleCount]: #firewallrulecount #### [firewallRuleCount] A count of the currently running rule set of a firewalled VLAN. -Type: **unsigned long** +Type: **unsigned long** + @@ -579,7 +632,8 @@ A count of the currently running rule set of a firewalled VLAN. [guestNetworkComponentCount]: #guestnetworkcomponentcount #### [guestNetworkComponentCount] A count of the networking components that are connected to a VLAN. -Type: **unsigned long** +Type: **unsigned long** + @@ -589,7 +643,8 @@ A count of the networking components that are connected to a VLAN. [hardwareCount]: #hardwarecount #### [hardwareCount] A count of all of the hardware that exists on a VLAN. Hardware is associated with a VLAN by its networking components. -Type: **unsigned long** +Type: **unsigned long** + @@ -599,7 +654,8 @@ A count of all of the hardware that exists on a VLAN. Hardware is associated wit [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of the networking components that are connected to a VLAN. -Type: **unsigned long** +Type: **unsigned long** + @@ -609,7 +665,8 @@ A count of the networking components that are connected to a VLAN. [networkComponentTrunkCount]: #networkcomponenttrunkcount #### [networkComponentTrunkCount] A count of the network components that are connected to this VLAN through a trunk. -Type: **unsigned long** +Type: **unsigned long** + @@ -619,7 +676,8 @@ A count of the network components that are connected to this VLAN through a trun [primarySubnetCount]: #primarysubnetcount #### [primarySubnetCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -629,7 +687,8 @@ A count of [privateNetworkGatewayCount]: #privatenetworkgatewaycount #### [privateNetworkGatewayCount] A count of the gateways this VLAN is the private VLAN of. -Type: **unsigned long** +Type: **unsigned long** + @@ -639,7 +698,8 @@ A count of the gateways this VLAN is the private VLAN of. [protectedIpAddressCount]: #protectedipaddresscount #### [protectedIpAddressCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -649,7 +709,8 @@ A count of [publicNetworkGatewayCount]: #publicnetworkgatewaycount #### [publicNetworkGatewayCount] A count of the gateways this VLAN is the public VLAN of. -Type: **unsigned long** +Type: **unsigned long** + @@ -659,7 +720,8 @@ A count of the gateways this VLAN is the public VLAN of. [scaleVlanCount]: #scalevlancount #### [scaleVlanCount] A count of collection of scale VLANs this VLAN applies to. -Type: **unsigned long** +Type: **unsigned long** + @@ -669,7 +731,8 @@ A count of collection of scale VLANs this VLAN applies to. [secondarySubnetCount]: #secondarysubnetcount #### [secondarySubnetCount] A count of the subnets that exist as secondary interfaces on a VLAN -Type: **unsigned long** +Type: **unsigned long** + @@ -679,7 +742,8 @@ A count of the subnets that exist as secondary interfaces on a VLAN [subnetCount]: #subnetcount #### [subnetCount] A count of all of the subnets that exist as VLAN interfaces. -Type: **unsigned long** +Type: **unsigned long** + @@ -689,7 +753,8 @@ A count of all of the subnets that exist as VLAN interfaces. [tagReferenceCount]: #tagreferencecount #### [tagReferenceCount] A count of references to all tags for this VLAN. -Type: **unsigned long** +Type: **unsigned long** + @@ -699,7 +764,8 @@ A count of references to all tags for this VLAN. [virtualGuestCount]: #virtualguestcount #### [virtualGuestCount] A count of all of the Virtual Servers that are connected to a VLAN. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Vlan_Firewall/_index.md b/content/reference/datatypes/SoftLayer_Network_Vlan_Firewall/_index.md index e6f0185820..060c93699b 100644 --- a/content/reference/datatypes/SoftLayer_Network_Vlan_Firewall/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Vlan_Firewall/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -59,7 +61,8 @@ The SoftLayer_Network_Vlan_Firewall data type contains general information relat [administrativeBypassFlag]: #administrativebypassflag #### [administrativeBypassFlag] A flag to indicate if the firewall is in administrative bypass mode. In other words, no rules are being applied to the traffic coming through. -Type: **string** +Type: **string** + @@ -69,7 +72,8 @@ A flag to indicate if the firewall is in administrative bypass mode. In other wo [customerManagedFlag]: #customermanagedflag #### [customerManagedFlag] Whether or not this firewall can be directly logged in to. -Type: **boolean** +Type: **boolean** + @@ -79,7 +83,8 @@ Whether or not this firewall can be directly logged in to. [id]: #id #### [id] A firewall's unique identifier. -Type: **integer** +Type: **integer** + @@ -89,7 +94,8 @@ A firewall's unique identifier. [primaryIpAddress]: #primaryipaddress #### [primaryIpAddress] A firewall's primary IP address. This field will be the IP shown when doing network traces and reverse DNS and is a read-only property. -Type: **string** +Type: **string** + @@ -105,7 +111,8 @@ A firewall's primary IP address. This field will be the IP shown when doing netw [accountId]: #accountid #### [accountId] -Type: **integer** +Type: **integer** + @@ -115,7 +122,8 @@ A firewall's primary IP address. This field will be the IP shown when doing netw [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] A firewall's allotted bandwidth (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -125,7 +133,8 @@ A firewall's allotted bandwidth (measured in GB). [billingCycleBandwidthUsage]: #billingcyclebandwidthusage #### [billingCycleBandwidthUsage] The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this firewall is attached to. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -135,7 +144,8 @@ The raw bandwidth usage data for the current billing cycle. One object will be r [billingCyclePrivateBandwidthUsage]: #billingcycleprivatebandwidthusage #### [billingCyclePrivateBandwidthUsage] The raw private bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage ** +Type: **SoftLayer_Network_Bandwidth_Usage ** + @@ -145,7 +155,8 @@ The raw private bandwidth usage data for the current billing cycle. [billingCyclePublicBandwidthUsage]: #billingcyclepublicbandwidthusage #### [billingCyclePublicBandwidthUsage] The raw public bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage ** +Type: **SoftLayer_Network_Bandwidth_Usage ** + @@ -155,7 +166,8 @@ The raw public bandwidth usage data for the current billing cycle. [billingItem]: #billingitem #### [billingItem] The billing item for a Hardware Firewall (Dedicated). -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -165,7 +177,8 @@ The billing item for a Hardware Firewall (Dedicated). [bypassRequestStatus]: #bypassrequeststatus #### [bypassRequestStatus] Administrative bypass request status. -Type: **string** +Type: **string** + @@ -175,7 +188,8 @@ Administrative bypass request status. [datacenter]: #datacenter #### [datacenter] The datacenter that the firewall resides in. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -185,7 +199,8 @@ The datacenter that the firewall resides in. [firewallType]: #firewalltype #### [firewallType] The firewall device type. -Type: **string** +Type: **string** + @@ -195,7 +210,8 @@ The firewall device type. [fullyQualifiedDomainName]: #fullyqualifieddomainname #### [fullyQualifiedDomainName] A name reflecting the hostname and domain of the firewall. This is created from the combined values of the firewall's logical name and vlan number automatically, and thus can not be edited directly. -Type: **string** +Type: **string** + @@ -205,7 +221,8 @@ A name reflecting the hostname and domain of the firewall. This is created from [managementCredentials]: #managementcredentials #### [managementCredentials] The credentials to log in to a firewall device. This is only present for dedicated appliances. -Type: **SoftLayer_Software_Component_Password ** +Type: **SoftLayer_Software_Component_Password ** + @@ -215,7 +232,8 @@ The credentials to log in to a firewall device. This is only present for dedicat [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A firewall's metric tracking object. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -225,7 +243,8 @@ A firewall's metric tracking object. [metricTrackingObjectId]: #metrictrackingobjectid #### [metricTrackingObjectId] The metric tracking object ID for this firewall. -Type: **integer** +Type: **integer** + @@ -235,7 +254,8 @@ The metric tracking object ID for this firewall. [networkFirewallUpdateRequests]: #networkfirewallupdaterequests #### [networkFirewallUpdateRequests] The update requests made for this firewall. -Type: **SoftLayer_Network_Firewall_Update_Request[] ** +Type: **SoftLayer_Network_Firewall_Update_Request[] ** + @@ -245,7 +265,8 @@ The update requests made for this firewall. [networkGateway]: #networkgateway #### [networkGateway] The gateway associated with this firewall, if any. -Type: **SoftLayer_Network_Gateway ** +Type: **SoftLayer_Network_Gateway ** + @@ -255,7 +276,8 @@ The gateway associated with this firewall, if any. [networkVlan]: #networkvlan #### [networkVlan] The VLAN object that a firewall is associated with and protecting. -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + @@ -265,7 +287,8 @@ The VLAN object that a firewall is associated with and protecting. [networkVlans]: #networkvlans #### [networkVlans] The VLAN objects that a firewall is associated with and protecting. -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -275,7 +298,8 @@ The VLAN objects that a firewall is associated with and protecting. [rules]: #rules #### [rules] The currently running rule set of this network component firewall. -Type: **SoftLayer_Network_Vlan_Firewall_Rule[] ** +Type: **SoftLayer_Network_Vlan_Firewall_Rule[] ** + @@ -285,7 +309,8 @@ The currently running rule set of this network component firewall. [tagReferences]: #tagreferences #### [tagReferences] -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** + @@ -295,7 +320,8 @@ The currently running rule set of this network component firewall. [upgradeRequest]: #upgraderequest #### [upgradeRequest] A firewall's associated upgrade request object, if any. -Type: **SoftLayer_Product_Upgrade_Request ** +Type: **SoftLayer_Product_Upgrade_Request ** + @@ -307,7 +333,8 @@ A firewall's associated upgrade request object, if any. [billingCycleBandwidthUsageCount]: #billingcyclebandwidthusagecount #### [billingCycleBandwidthUsageCount] A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this firewall is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -317,7 +344,8 @@ A count of the raw bandwidth usage data for the current billing cycle. One objec [networkFirewallUpdateRequestCount]: #networkfirewallupdaterequestcount #### [networkFirewallUpdateRequestCount] A count of the update requests made for this firewall. -Type: **unsigned long** +Type: **unsigned long** + @@ -327,7 +355,8 @@ A count of the update requests made for this firewall. [networkVlanCount]: #networkvlancount #### [networkVlanCount] A count of the VLAN objects that a firewall is associated with and protecting. -Type: **unsigned long** +Type: **unsigned long** + @@ -337,7 +366,8 @@ A count of the VLAN objects that a firewall is associated with and protecting. [ruleCount]: #rulecount #### [ruleCount] A count of the currently running rule set of this network component firewall. -Type: **unsigned long** +Type: **unsigned long** + @@ -347,7 +377,8 @@ A count of the currently running rule set of this network component firewall. [tagReferenceCount]: #tagreferencecount #### [tagReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Network_Vlan_Firewall_Rule/_index.md b/content/reference/datatypes/SoftLayer_Network_Vlan_Firewall_Rule/_index.md index 7e277bf206..d86bf38b30 100644 --- a/content/reference/datatypes/SoftLayer_Network_Vlan_Firewall_Rule/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Vlan_Firewall_Rule/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -51,7 +53,8 @@ A SoftLayer_Network_Component_Firewall_Rule object type represents a currently r [action]: #action #### [action] The action that the rule is to take [permit or deny]. -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ The action that the rule is to take [permit or deny]. [destinationIpAddress]: #destinationipaddress #### [destinationIpAddress] The destination IP address considered for determining rule application. -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ The destination IP address considered for determining rule application. [destinationIpCidr]: #destinationipcidr #### [destinationIpCidr] The CIDR is used for determining rule application. This value will -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ The CIDR is used for determining rule application. This value will [destinationIpSubnetMask]: #destinationipsubnetmask #### [destinationIpSubnetMask] The destination IP subnet mask considered for determining rule application. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The destination IP subnet mask considered for determining rule application. [destinationPortRangeEnd]: #destinationportrangeend #### [destinationPortRangeEnd] The ending (upper end of range) destination port considered for determining rule application. -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ The ending (upper end of range) destination port considered for determining rule [destinationPortRangeStart]: #destinationportrangestart #### [destinationPortRangeStart] The starting (lower end of range) destination port considered for determining rule application. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The starting (lower end of range) destination port considered for determining ru [id]: #id #### [id] The rule's internal identifier. -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ The rule's internal identifier. [notes]: #notes #### [notes] The notes field for the rule. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The notes field for the rule. [orderValue]: #ordervalue #### [orderValue] The numeric value describing the order in which the rule should be applied. -Type: **integer** +Type: **integer** + @@ -141,7 +152,8 @@ The numeric value describing the order in which the rule should be applied. [protocol]: #protocol #### [protocol] The protocol considered for determining rule application. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ The protocol considered for determining rule application. [sourceIpAddress]: #sourceipaddress #### [sourceIpAddress] The source IP address considered for determining rule application. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ The source IP address considered for determining rule application. [sourceIpCidr]: #sourceipcidr #### [sourceIpCidr] The CIDR is used for determining rule application. This value will -Type: **integer** +Type: **integer** + @@ -171,7 +185,8 @@ The CIDR is used for determining rule application. This value will [sourceIpSubnetMask]: #sourceipsubnetmask #### [sourceIpSubnetMask] The source IP subnet mask considered for determining rule application. -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ The source IP subnet mask considered for determining rule application. [status]: #status #### [status] Current status of the network component firewall. -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ Current status of the network component firewall. [version]: #version #### [version] Whether this rule is an IPv4 rule or an IPv6 rule. If -Type: **integer** +Type: **integer** + @@ -207,7 +224,8 @@ Whether this rule is an IPv4 rule or an IPv6 rule. If [networkComponentFirewall]: #networkcomponentfirewall #### [networkComponentFirewall] The network component firewall that this rule belongs to. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + diff --git a/content/reference/datatypes/SoftLayer_Network_Vlan_Type/_index.md b/content/reference/datatypes/SoftLayer_Network_Vlan_Type/_index.md index b9af84e16e..8fa0c62a10 100644 --- a/content/reference/datatypes/SoftLayer_Network_Vlan_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Network_Vlan_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Notification/_index.md b/content/reference/datatypes/SoftLayer_Notification/_index.md index 15d898d5bb..b833b63fa7 100644 --- a/content/reference/datatypes/SoftLayer_Notification/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ Details provided for the notification are basic. Details such as the related pr [id]: #id #### [id] Unique identifier for the notification. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Unique identifier for the notification. [keyName]: #keyname #### [keyName] Name that can be used by external systems to refer to a notification. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Name that can be used by external systems to refer to a notification. [name]: #name #### [name] Friendly name for the notification. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ Friendly name for the notification. [preferences]: #preferences #### [preferences] The preferences related to the notification. These are preferences are configurable and optional for subscribers to use. -Type: **SoftLayer_Notification_Preference[] ** +Type: **SoftLayer_Notification_Preference[] ** + @@ -91,7 +97,8 @@ The preferences related to the notification. These are preferences are configura [requiredPreferences]: #requiredpreferences #### [requiredPreferences] The required preferences related to the notification. While configurable, the subscriber does not have the option whether to use the preference. -Type: **SoftLayer_Notification_Preference[] ** +Type: **SoftLayer_Notification_Preference[] ** + @@ -103,7 +110,8 @@ The required preferences related to the notification. While configurable, the su [preferenceCount]: #preferencecount #### [preferenceCount] A count of the preferences related to the notification. These are preferences are configurable and optional for subscribers to use. -Type: **unsigned long** +Type: **unsigned long** + @@ -113,7 +121,8 @@ A count of the preferences related to the notification. These are preferences ar [requiredPreferenceCount]: #requiredpreferencecount #### [requiredPreferenceCount] A count of the required preferences related to the notification. While configurable, the subscriber does not have the option whether to use the preference. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Delivery_Method/_index.md b/content/reference/datatypes/SoftLayer_Notification_Delivery_Method/_index.md index 90d69493b2..58f5b3d74d 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Delivery_Method/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Delivery_Method/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Provides details for the delivery methods available. @@ -45,7 +47,8 @@ Provides details for the delivery methods available. [active]: #active #### [active] Determines if the delivery method is still used by the system. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Determines if the delivery method is still used by the system. [description]: #description #### [description] Description used for the delivery method. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Description used for the delivery method. [id]: #id #### [id] Unique identifier for the various notification delivery methods. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ Unique identifier for the various notification delivery methods. [keyName]: #keyname #### [keyName] Name that can be used by external systems to refer to delivery method. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ Name that can be used by external systems to refer to delivery method. [name]: #name #### [name] Friendly name used for the delivery method. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Mobile/_index.md b/content/reference/datatypes/SoftLayer_Notification_Mobile/_index.md index 4dc755d4a6..0e0ee62505 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Mobile/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Mobile/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ This is an extension of the SoftLayer_Notification class. These are implementat [id]: #id #### [id] Unique identifier for the notification. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Unique identifier for the notification. [keyName]: #keyname #### [keyName] Name that can be used by external systems to refer to a notification. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Name that can be used by external systems to refer to a notification. [name]: #name #### [name] Friendly name for the notification. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ Friendly name for the notification. [preferences]: #preferences #### [preferences] The preferences related to the notification. These are preferences are configurable and optional for subscribers to use. -Type: **SoftLayer_Notification_Preference[] ** +Type: **SoftLayer_Notification_Preference[] ** + @@ -91,7 +97,8 @@ The preferences related to the notification. These are preferences are configura [requiredPreferences]: #requiredpreferences #### [requiredPreferences] The required preferences related to the notification. While configurable, the subscriber does not have the option whether to use the preference. -Type: **SoftLayer_Notification_Preference[] ** +Type: **SoftLayer_Notification_Preference[] ** + @@ -103,7 +110,8 @@ The required preferences related to the notification. While configurable, the su [preferenceCount]: #preferencecount #### [preferenceCount] A count of the preferences related to the notification. These are preferences are configurable and optional for subscribers to use. -Type: **unsigned long** +Type: **unsigned long** + @@ -113,7 +121,8 @@ A count of the preferences related to the notification. These are preferences ar [requiredPreferenceCount]: #requiredpreferencecount #### [requiredPreferenceCount] A count of the required preferences related to the notification. While configurable, the subscriber does not have the option whether to use the preference. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Account/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Account/_index.md index 9582f90f4b..2eb8618bc4 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Account/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Account/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [active]: #active #### [active] -Type: **integer** +Type: **integer** +
              @@ -61,7 +64,8 @@ classes: [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** +
              @@ -71,7 +75,8 @@ classes: [lastNotificationUpdate]: #lastnotificationupdate #### [lastNotificationUpdate] -Type: **SoftLayer_Notification_Occurrence_Update ** +Type: **SoftLayer_Notification_Occurrence_Update ** + @@ -81,7 +86,8 @@ classes: [notificationOccurrenceEvent]: #notificationoccurrenceevent #### [notificationOccurrenceEvent] -Type: **SoftLayer_Notification_Occurrence_Event ** +Type: **SoftLayer_Notification_Occurrence_Event ** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Event/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Event/_index.md index 9d491f8c91..6dd9409c5c 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Event/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Event/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [endDate]: #enddate #### [endDate] When this event will end. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ When this event will end. [id]: #id #### [id] Unique identifier for this event. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ Unique identifier for this event. [lastImpactedUserCount]: #lastimpactedusercount #### [lastImpactedUserCount] Latest count of users impacted by this event. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ Latest count of users impacted by this event. [modifyDate]: #modifydate #### [modifyDate] When this event was last updated. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ When this event was last updated. [recoveryTime]: #recoverytime #### [recoveryTime] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ When this event was last updated. [startDate]: #startdate #### [startDate] When this event started. -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ When this event started. [subject]: #subject #### [subject] Brief description of this event. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ Brief description of this event. [summary]: #summary #### [summary] Details of this event. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ Details of this event. [systemTicketId]: #systemticketid #### [systemTicketId] Unique identifier for the [SoftLayer_Ticket]({{}}) associated with this event. -Type: **integer** +Type: **integer** + @@ -141,7 +152,8 @@ Unique identifier for the [SoftLayer_Ticket]({{Type: **boolean** +Type: **boolean** + @@ -151,7 +163,8 @@ Indicates whether or not this event has been acknowledged by the user. [attachments]: #attachments #### [attachments] A collection of attachments for this event which provide supplementary information to impacted users some examples are RFO (Reason For Outage) and root cause analysis documents. -Type: **SoftLayer_Notification_Occurrence_Event_Attachment[] ** +Type: **SoftLayer_Notification_Occurrence_Event_Attachment[] ** + @@ -161,7 +174,8 @@ A collection of attachments for this event which provide supplementary informati [firstUpdate]: #firstupdate #### [firstUpdate] The first update for this event. -Type: **SoftLayer_Notification_Occurrence_Update ** +Type: **SoftLayer_Notification_Occurrence_Update ** + @@ -171,7 +185,8 @@ The first update for this event. [impactedAccounts]: #impactedaccounts #### [impactedAccounts] A collection of accounts impacted by this event. Each impacted account record relates directly to a [SoftLayer_Account]({{}}). -Type: **SoftLayer_Notification_Occurrence_Account[] ** +Type: **SoftLayer_Notification_Occurrence_Account[] ** + @@ -181,7 +196,8 @@ A collection of accounts impacted by this event. Each impacted account record re [impactedResources]: #impactedresources #### [impactedResources] A collection of resources impacted by this event. Each record will relate to some physical resource that the user has access to such as [SoftLayer_Hardware]({{}}) or [SoftLayer_Virtual_Guest]({{}}). -Type: **SoftLayer_Notification_Occurrence_Resource[] ** +Type: **SoftLayer_Notification_Occurrence_Resource[] ** + @@ -191,7 +207,8 @@ A collection of resources impacted by this event. Each record will relate to som [impactedUsers]: #impactedusers #### [impactedUsers] A collection of users impacted by this event. Each impacted user record relates directly to a [SoftLayer_User_Customer]({{}}). -Type: **SoftLayer_Notification_Occurrence_User[] ** +Type: **SoftLayer_Notification_Occurrence_User[] ** + @@ -201,7 +218,8 @@ A collection of users impacted by this event. Each impacted user record relates [lastUpdate]: #lastupdate #### [lastUpdate] The last update for this event. -Type: **SoftLayer_Notification_Occurrence_Update ** +Type: **SoftLayer_Notification_Occurrence_Update ** + @@ -211,7 +229,8 @@ The last update for this event. [notificationOccurrenceEventType]: #notificationoccurrenceeventtype #### [notificationOccurrenceEventType] The type of event such as planned or unplanned maintenance. -Type: **SoftLayer_Notification_Occurrence_Event_Type ** +Type: **SoftLayer_Notification_Occurrence_Event_Type ** + @@ -221,7 +240,8 @@ The type of event such as planned or unplanned maintenance. [statusCode]: #statuscode #### [statusCode] -Type: **SoftLayer_Notification_Occurrence_Status_Code ** +Type: **SoftLayer_Notification_Occurrence_Status_Code ** + @@ -231,7 +251,8 @@ The type of event such as planned or unplanned maintenance. [updates]: #updates #### [updates] All updates for this event. -Type: **SoftLayer_Notification_Occurrence_Update[] ** +Type: **SoftLayer_Notification_Occurrence_Update[] ** + @@ -243,7 +264,8 @@ All updates for this event. [attachmentCount]: #attachmentcount #### [attachmentCount] A count of a collection of attachments for this event which provide supplementary information to impacted users some examples are RFO (Reason For Outage) and root cause analysis documents. -Type: **unsigned long** +Type: **unsigned long** + @@ -253,7 +275,8 @@ A count of a collection of attachments for this event which provide supplementar [impactedAccountCount]: #impactedaccountcount #### [impactedAccountCount] A count of a collection of accounts impacted by this event. Each impacted account record relates directly to a [SoftLayer_Account]({{}}). -Type: **unsigned long** +Type: **unsigned long** + @@ -263,7 +286,8 @@ A count of a collection of accounts impacted by this event. Each impacted accoun [impactedResourceCount]: #impactedresourcecount #### [impactedResourceCount] A count of a collection of resources impacted by this event. Each record will relate to some physical resource that the user has access to such as [SoftLayer_Hardware]({{}}) or [SoftLayer_Virtual_Guest]({{}}). -Type: **unsigned long** +Type: **unsigned long** + @@ -273,7 +297,8 @@ A count of a collection of resources impacted by this event. Each record will re [impactedUserCount]: #impactedusercount #### [impactedUserCount] A count of a collection of users impacted by this event. Each impacted user record relates directly to a [SoftLayer_User_Customer]({{}}). -Type: **unsigned long** +Type: **unsigned long** + @@ -283,7 +308,8 @@ A count of a collection of users impacted by this event. Each impacted user reco [updateCount]: #updatecount #### [updateCount] A count of all updates for this event. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Event_Attachment/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Event_Attachment/_index.md index 62f067ad8b..620ae55055 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Event_Attachment/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Event_Attachment/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -55,7 +57,8 @@ SoftLayer events can have have files attached to them by a SoftLayer employee. A [createDate]: #createdate #### [createDate] The date the file was attached to the event. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +68,8 @@ The date the file was attached to the event. [fileName]: #filename #### [fileName] The name of the file attached to the event. -Type: **string** +Type: **string** + @@ -75,7 +79,8 @@ The name of the file attached to the event. [fileSize]: #filesize #### [fileSize] The size of the file, measured in bytes. -Type: **string** +Type: **string** + @@ -85,7 +90,8 @@ The size of the file, measured in bytes. [id]: #id #### [id] A event attachments' unique identifier. -Type: **integer** +Type: **integer** + @@ -95,7 +101,8 @@ A event attachments' unique identifier. [notificationOccurrenceEventId]: #notificationoccurrenceeventid #### [notificationOccurrenceEventId] The unique event identifier that the file is attached to. -Type: **integer** +Type: **integer** + @@ -111,7 +118,8 @@ The unique event identifier that the file is attached to. [notificationOccurrenceEvent]: #notificationoccurrenceevent #### [notificationOccurrenceEvent] -Type: **SoftLayer_Notification_Occurrence_Event ** +Type: **SoftLayer_Notification_Occurrence_Event ** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Event_Type/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Event_Type/_index.md index 53658f5e16..625c1cdced 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Event_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Event_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This represents the type of SoftLayer_Notification_Occurrence_Event. @@ -45,7 +47,8 @@ This represents the type of SoftLayer_Notification_Occurrence_Event. [keyName]: #keyname #### [keyName] The friendly unique identifier for this event type. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource/_index.md index 0a84133c2c..f5bdae9b3b 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This type contains general information relating to any hardware or services that may be impacted by a SoftLayer_Notification_Occurrence_Event. @@ -45,7 +47,8 @@ This type contains general information relating to any hardware or services that [active]: #active #### [active] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ This type contains general information relating to any hardware or services that [filterLabel]: #filterlabel #### [filterLabel] <<< EOT A label which gives some background as to what piece of -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This type contains general information relating to any hardware or services that [notificationOccurrenceEventId]: #notificationoccurrenceeventid #### [notificationOccurrenceEventId] <<< EOT The unique identifier for the associated -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ This type contains general information relating to any hardware or services that [resourceAccountId]: #resourceaccountid #### [resourceAccountId] <<< EOT The unique identifier for the [SoftLayer_Account]({{}}) associated with -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ This type contains general information relating to any hardware or services that [resourceName]: #resourcename #### [resourceName] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ This type contains general information relating to any hardware or services that [resourceTableId]: #resourcetableid #### [resourceTableId] <<< EOT The unique identifier for the physical resource that is associated -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ This type contains general information relating to any hardware or services that [notificationOccurrenceEvent]: #notificationoccurrenceevent #### [notificationOccurrenceEvent] The associated event. -Type: **SoftLayer_Notification_Occurrence_Event ** +Type: **SoftLayer_Notification_Occurrence_Event ** + @@ -121,7 +130,8 @@ The associated event. [resource]: #resource #### [resource] The physical resource. -Type: **SoftLayer_Entity ** +Type: **SoftLayer_Entity ** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Hardware/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Hardware/_index.md index 8f574a54d8..d743d7bcfa 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Hardware/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Hardware/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This type contains general information related to a [SoftLayer_Hardware]({{}}) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event]({{}}). @@ -45,7 +47,8 @@ This type contains general information related to a [SoftLayer_Hardware]({{Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ This type contains general information related to a [SoftLayer_Hardware]({{Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This type contains general information related to a [SoftLayer_Hardware]({{Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ This type contains general information related to a [SoftLayer_Hardware]({{Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ This type contains general information related to a [SoftLayer_Hardware]({{Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ This type contains general information related to a [SoftLayer_Hardware]({{Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This type contains general information related to a [SoftLayer_Hardware]({{}}) associated with -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ This type contains general information related to a [SoftLayer_Hardware]({{Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ This type contains general information related to a [SoftLayer_Hardware]({{Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ This type contains general information related to a [SoftLayer_Hardware]({{Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This type contains general information related to a [SoftLayer_Hardware]({{Type: **SoftLayer_Notification_Occurrence_Event ** +Type: **SoftLayer_Notification_Occurrence_Event ** + @@ -161,7 +174,8 @@ The associated event. [resource]: #resource #### [resource] The physical resource. -Type: **SoftLayer_Entity ** +Type: **SoftLayer_Entity ** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Application_Delivery_Controller/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Application_Delivery_Controller/_index.md index 9537dfb480..a873d2a0f1 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Application_Delivery_Controller/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Application_Delivery_Controller/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This type contains general information related to a [SoftLayer_Network_Application_Delivery_Controller]({{}}) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event]({{}}). @@ -45,7 +47,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [active]: #active #### [active] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [filterLabel]: #filterlabel #### [filterLabel] <<< EOT A label which gives some background as to what piece of -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [hostname]: #hostname #### [hostname] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [notificationOccurrenceEventId]: #notificationoccurrenceeventid #### [notificationOccurrenceEventId] <<< EOT The unique identifier for the associated -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [privateIp]: #privateip #### [privateIp] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [publicIp]: #publicip #### [publicIp] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [resourceAccountId]: #resourceaccountid #### [resourceAccountId] <<< EOT The unique identifier for the [SoftLayer_Account]({{}}) associated with -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [resourceName]: #resourcename #### [resourceName] -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [resourceTableId]: #resourcetableid #### [resourceTableId] <<< EOT The unique identifier for the physical resource that is associated -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [resourceType]: #resourcetype #### [resourceType] -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [notificationOccurrenceEvent]: #notificationoccurrenceevent #### [notificationOccurrenceEvent] The associated event. -Type: **SoftLayer_Notification_Occurrence_Event ** +Type: **SoftLayer_Notification_Occurrence_Event ** + @@ -161,7 +174,8 @@ The associated event. [resource]: #resource #### [resource] The physical resource. -Type: **SoftLayer_Entity ** +Type: **SoftLayer_Entity ** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/_index.md index a96d8ff3f0..641ca954c1 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This type contains general information related to a [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress]({{}}) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event]({{}}). @@ -45,7 +47,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [active]: #active #### [active] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [filterLabel]: #filterlabel #### [filterLabel] <<< EOT A label which gives some background as to what piece of -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [hostname]: #hostname #### [hostname] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [notificationOccurrenceEventId]: #notificationoccurrenceeventid #### [notificationOccurrenceEventId] <<< EOT The unique identifier for the associated -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [publicIp]: #publicip #### [publicIp] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [resourceAccountId]: #resourceaccountid #### [resourceAccountId] <<< EOT The unique identifier for the [SoftLayer_Account]({{}}) associated with -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [resourceName]: #resourcename #### [resourceName] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [resourceTableId]: #resourcetableid #### [resourceTableId] <<< EOT The unique identifier for the physical resource that is associated -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [resourceType]: #resourcetype #### [resourceType] -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This type contains general information related to a [SoftLayer_Network_Applicati [notificationOccurrenceEvent]: #notificationoccurrenceevent #### [notificationOccurrenceEvent] The associated event. -Type: **SoftLayer_Notification_Occurrence_Event ** +Type: **SoftLayer_Notification_Occurrence_Event ** + @@ -151,7 +163,8 @@ The associated event. [resource]: #resource #### [resource] The physical resource. -Type: **SoftLayer_Entity ** +Type: **SoftLayer_Entity ** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_Iscsi_EqualLogic/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_Iscsi_EqualLogic/_index.md index 81267c818b..deeba920c1 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_Iscsi_EqualLogic/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_Iscsi_EqualLogic/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This type contains general information related to a [SoftLayer_Network_Storage_Iscsi]({{}}) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event]({{}}). @@ -45,7 +47,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [active]: #active #### [active] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [filterLabel]: #filterlabel #### [filterLabel] <<< EOT A label which gives some background as to what piece of -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [hostname]: #hostname #### [hostname] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [notificationOccurrenceEventId]: #notificationoccurrenceeventid #### [notificationOccurrenceEventId] <<< EOT The unique identifier for the associated -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [privateIp]: #privateip #### [privateIp] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [resourceAccountId]: #resourceaccountid #### [resourceAccountId] <<< EOT The unique identifier for the [SoftLayer_Account]({{}}) associated with -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [resourceName]: #resourcename #### [resourceName] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [resourceTableId]: #resourcetableid #### [resourceTableId] <<< EOT The unique identifier for the physical resource that is associated -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [resourceType]: #resourcetype #### [resourceType] -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [notificationOccurrenceEvent]: #notificationoccurrenceevent #### [notificationOccurrenceEvent] The associated event. -Type: **SoftLayer_Notification_Occurrence_Event ** +Type: **SoftLayer_Notification_Occurrence_Event ** + @@ -151,7 +163,8 @@ The associated event. [resource]: #resource #### [resource] The physical resource. -Type: **SoftLayer_Entity ** +Type: **SoftLayer_Entity ** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_Iscsi_NetApp/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_Iscsi_NetApp/_index.md index 09eb666ca5..0f1284620f 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_Iscsi_NetApp/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_Iscsi_NetApp/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This type contains general information related to a [SoftLayer_Network_Storage_Iscsi_NetApp]({{}}) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event]({{}}). @@ -45,7 +47,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [active]: #active #### [active] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [filterLabel]: #filterlabel #### [filterLabel] <<< EOT A label which gives some background as to what piece of -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [hostname]: #hostname #### [hostname] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [notificationOccurrenceEventId]: #notificationoccurrenceeventid #### [notificationOccurrenceEventId] <<< EOT The unique identifier for the associated -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [privateIp]: #privateip #### [privateIp] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [resourceAccountId]: #resourceaccountid #### [resourceAccountId] <<< EOT The unique identifier for the [SoftLayer_Account]({{}}) associated with -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [resourceName]: #resourcename #### [resourceName] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [resourceTableId]: #resourcetableid #### [resourceTableId] <<< EOT The unique identifier for the physical resource that is associated -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [resourceType]: #resourcetype #### [resourceType] -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [notificationOccurrenceEvent]: #notificationoccurrenceevent #### [notificationOccurrenceEvent] The associated event. -Type: **SoftLayer_Notification_Occurrence_Event ** +Type: **SoftLayer_Notification_Occurrence_Event ** + @@ -151,7 +163,8 @@ The associated event. [resource]: #resource #### [resource] The physical resource. -Type: **SoftLayer_Entity ** +Type: **SoftLayer_Entity ** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_Lockbox/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_Lockbox/_index.md index 8045418592..b8d406433f 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_Lockbox/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_Lockbox/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This type contains general information related to a [SoftLayer_Network_Storage_Lockbox]({{}}) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event]({{}}). @@ -45,7 +47,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_L [active]: #active #### [active] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_L [filterLabel]: #filterlabel #### [filterLabel] <<< EOT A label which gives some background as to what piece of -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_L [hostname]: #hostname #### [hostname] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_L [notificationOccurrenceEventId]: #notificationoccurrenceeventid #### [notificationOccurrenceEventId] <<< EOT The unique identifier for the associated -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_L [privateIp]: #privateip #### [privateIp] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_L [resourceAccountId]: #resourceaccountid #### [resourceAccountId] <<< EOT The unique identifier for the [SoftLayer_Account]({{}}) associated with -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_L [resourceName]: #resourcename #### [resourceName] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_L [resourceTableId]: #resourcetableid #### [resourceTableId] <<< EOT The unique identifier for the physical resource that is associated -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_L [resourceType]: #resourcetype #### [resourceType] -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_L [notificationOccurrenceEvent]: #notificationoccurrenceevent #### [notificationOccurrenceEvent] The associated event. -Type: **SoftLayer_Notification_Occurrence_Event ** +Type: **SoftLayer_Notification_Occurrence_Event ** + @@ -151,7 +163,8 @@ The associated event. [resource]: #resource #### [resource] The physical resource. -Type: **SoftLayer_Entity ** +Type: **SoftLayer_Entity ** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_Nas/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_Nas/_index.md index d49bfa1bbb..2f83418926 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_Nas/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_Nas/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This type contains general information related to a [SoftLayer_Network_Storage_Nas]({{}}) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event]({{}}). @@ -45,7 +47,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [active]: #active #### [active] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [filterLabel]: #filterlabel #### [filterLabel] <<< EOT A label which gives some background as to what piece of -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [hostname]: #hostname #### [hostname] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [notificationOccurrenceEventId]: #notificationoccurrenceeventid #### [notificationOccurrenceEventId] <<< EOT The unique identifier for the associated -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [privateIp]: #privateip #### [privateIp] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [resourceAccountId]: #resourceaccountid #### [resourceAccountId] <<< EOT The unique identifier for the [SoftLayer_Account]({{}}) associated with -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [resourceName]: #resourcename #### [resourceName] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [resourceTableId]: #resourcetableid #### [resourceTableId] <<< EOT The unique identifier for the physical resource that is associated -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [resourceType]: #resourcetype #### [resourceType] -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [notificationOccurrenceEvent]: #notificationoccurrenceevent #### [notificationOccurrenceEvent] The associated event. -Type: **SoftLayer_Notification_Occurrence_Event ** +Type: **SoftLayer_Notification_Occurrence_Event ** + @@ -151,7 +163,8 @@ The associated event. [resource]: #resource #### [resource] The physical resource. -Type: **SoftLayer_Entity ** +Type: **SoftLayer_Entity ** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_NetApp_Volume/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_NetApp_Volume/_index.md index 7d29586b19..e89a0b383e 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_NetApp_Volume/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_NetApp_Volume/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This type contains general information related to a [SoftLayer_Network_Storage]({{}}) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event]({{}}). @@ -45,7 +47,8 @@ This type contains general information related to a [SoftLayer_Network_Storage]( [active]: #active #### [active] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ This type contains general information related to a [SoftLayer_Network_Storage]( [filterLabel]: #filterlabel #### [filterLabel] <<< EOT A label which gives some background as to what piece of -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This type contains general information related to a [SoftLayer_Network_Storage]( [hostname]: #hostname #### [hostname] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ This type contains general information related to a [SoftLayer_Network_Storage]( [notificationOccurrenceEventId]: #notificationoccurrenceeventid #### [notificationOccurrenceEventId] <<< EOT The unique identifier for the associated -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ This type contains general information related to a [SoftLayer_Network_Storage]( [privateIp]: #privateip #### [privateIp] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ This type contains general information related to a [SoftLayer_Network_Storage]( [resourceAccountId]: #resourceaccountid #### [resourceAccountId] <<< EOT The unique identifier for the [SoftLayer_Account]({{}}) associated with -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ This type contains general information related to a [SoftLayer_Network_Storage]( [resourceName]: #resourcename #### [resourceName] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ This type contains general information related to a [SoftLayer_Network_Storage]( [resourceTableId]: #resourcetableid #### [resourceTableId] <<< EOT The unique identifier for the physical resource that is associated -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ This type contains general information related to a [SoftLayer_Network_Storage]( [resourceType]: #resourcetype #### [resourceType] -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This type contains general information related to a [SoftLayer_Network_Storage]( [notificationOccurrenceEvent]: #notificationoccurrenceevent #### [notificationOccurrenceEvent] The associated event. -Type: **SoftLayer_Notification_Occurrence_Event ** +Type: **SoftLayer_Notification_Occurrence_Event ** + @@ -151,7 +163,8 @@ The associated event. [resource]: #resource #### [resource] The physical resource. -Type: **SoftLayer_Entity ** +Type: **SoftLayer_Entity ** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_NetApp_Volume_Replicant_Iscsi/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_NetApp_Volume_Replicant_Iscsi/_index.md index f2f2d08e9e..8f758b2c4f 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_NetApp_Volume_Replicant_Iscsi/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_NetApp_Volume_Replicant_Iscsi/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This type contains general information related to a [SoftLayer_Network_Storage_Iscsi]({{}}) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event]({{}}). @@ -45,7 +47,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [active]: #active #### [active] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [filterLabel]: #filterlabel #### [filterLabel] <<< EOT A label which gives some background as to what piece of -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [hostname]: #hostname #### [hostname] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [notificationOccurrenceEventId]: #notificationoccurrenceeventid #### [notificationOccurrenceEventId] <<< EOT The unique identifier for the associated -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [privateIp]: #privateip #### [privateIp] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [resourceAccountId]: #resourceaccountid #### [resourceAccountId] <<< EOT The unique identifier for the [SoftLayer_Account]({{}}) associated with -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [resourceName]: #resourcename #### [resourceName] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [resourceTableId]: #resourcetableid #### [resourceTableId] <<< EOT The unique identifier for the physical resource that is associated -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [resourceType]: #resourcetype #### [resourceType] -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_I [notificationOccurrenceEvent]: #notificationoccurrenceevent #### [notificationOccurrenceEvent] The associated event. -Type: **SoftLayer_Notification_Occurrence_Event ** +Type: **SoftLayer_Notification_Occurrence_Event ** + @@ -151,7 +163,8 @@ The associated event. [resource]: #resource #### [resource] The physical resource. -Type: **SoftLayer_Entity ** +Type: **SoftLayer_Entity ** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_NetApp_Volume_Replicant_Nas/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_NetApp_Volume_Replicant_Nas/_index.md index db0f271061..e8c775beba 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_NetApp_Volume_Replicant_Nas/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Network_Storage_NetApp_Volume_Replicant_Nas/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This type contains general information related to a [SoftLayer_Network_Storage_NetApp_Volume_Replicant_Nas]({{}}) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event]({{}}). @@ -45,7 +47,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [active]: #active #### [active] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [filterLabel]: #filterlabel #### [filterLabel] <<< EOT A label which gives some background as to what piece of -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [hostname]: #hostname #### [hostname] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [notificationOccurrenceEventId]: #notificationoccurrenceeventid #### [notificationOccurrenceEventId] <<< EOT The unique identifier for the associated -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [privateIp]: #privateip #### [privateIp] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [resourceAccountId]: #resourceaccountid #### [resourceAccountId] <<< EOT The unique identifier for the [SoftLayer_Account]({{}}) associated with -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [resourceName]: #resourcename #### [resourceName] -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [resourceTableId]: #resourcetableid #### [resourceTableId] <<< EOT The unique identifier for the physical resource that is associated -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [resourceType]: #resourcetype #### [resourceType] -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ This type contains general information related to a [SoftLayer_Network_Storage_N [notificationOccurrenceEvent]: #notificationoccurrenceevent #### [notificationOccurrenceEvent] The associated event. -Type: **SoftLayer_Notification_Occurrence_Event ** +Type: **SoftLayer_Notification_Occurrence_Event ** + @@ -151,7 +163,8 @@ The associated event. [resource]: #resource #### [resource] The physical resource. -Type: **SoftLayer_Entity ** +Type: **SoftLayer_Entity ** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Virtual/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Virtual/_index.md index 12532992b0..0113ec1ae3 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Virtual/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Resource_Virtual/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This type contains general information related to a [SoftLayer_Virtual_Guest]({{}}) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event]({{}}). @@ -45,7 +47,8 @@ This type contains general information related to a [SoftLayer_Virtual_Guest]({{ [active]: #active #### [active] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ This type contains general information related to a [SoftLayer_Virtual_Guest]({{ [filterLabel]: #filterlabel #### [filterLabel] <<< EOT A label which gives some background as to what piece of -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This type contains general information related to a [SoftLayer_Virtual_Guest]({{ [hostname]: #hostname #### [hostname] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ This type contains general information related to a [SoftLayer_Virtual_Guest]({{ [notificationOccurrenceEventId]: #notificationoccurrenceeventid #### [notificationOccurrenceEventId] <<< EOT The unique identifier for the associated -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ This type contains general information related to a [SoftLayer_Virtual_Guest]({{ [privateIp]: #privateip #### [privateIp] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ This type contains general information related to a [SoftLayer_Virtual_Guest]({{ [publicIp]: #publicip #### [publicIp] -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ This type contains general information related to a [SoftLayer_Virtual_Guest]({{ [resourceAccountId]: #resourceaccountid #### [resourceAccountId] <<< EOT The unique identifier for the [SoftLayer_Account]({{}}) associated with -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ This type contains general information related to a [SoftLayer_Virtual_Guest]({{ [resourceName]: #resourcename #### [resourceName] -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ This type contains general information related to a [SoftLayer_Virtual_Guest]({{ [resourceTableId]: #resourcetableid #### [resourceTableId] <<< EOT The unique identifier for the physical resource that is associated -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ This type contains general information related to a [SoftLayer_Virtual_Guest]({{ [resourceType]: #resourcetype #### [resourceType] -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ This type contains general information related to a [SoftLayer_Virtual_Guest]({{ [notificationOccurrenceEvent]: #notificationoccurrenceevent #### [notificationOccurrenceEvent] The associated event. -Type: **SoftLayer_Notification_Occurrence_Event ** +Type: **SoftLayer_Notification_Occurrence_Event ** + @@ -161,7 +174,8 @@ The associated event. [resource]: #resource #### [resource] The physical resource. -Type: **SoftLayer_Entity ** +Type: **SoftLayer_Entity ** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Status_Code/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Status_Code/_index.md index 4d984fdcbd..b0beda79d5 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Status_Code/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Status_Code/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Update/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Update/_index.md index 8893b894d3..667e77d5c3 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_Update/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_Update/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [contents]: #contents #### [contents] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
              @@ -65,7 +69,8 @@ classes: [endDate]: #enddate #### [endDate] -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ classes: [startDate]: #startdate #### [startDate] -Type: **dateTime** +Type: **dateTime** + @@ -91,7 +97,8 @@ classes: [employee]: #employee #### [employee] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -101,7 +108,8 @@ classes: [notificationOccurrenceEvent]: #notificationoccurrenceevent #### [notificationOccurrenceEvent] -Type: **SoftLayer_Notification_Occurrence_Event ** +Type: **SoftLayer_Notification_Occurrence_Event ** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Occurrence_User/_index.md b/content/reference/datatypes/SoftLayer_Notification_Occurrence_User/_index.md index 6cd72496b9..c0a04ede56 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Occurrence_User/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Occurrence_User/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This type contains general information relating to a user that may be impacted by a [SoftLayer_Notification_Occurrence_Event]({{}}). @@ -45,7 +47,8 @@ This type contains general information relating to a user that may be impacted b [acknowledgedFlag]: #acknowledgedflag #### [acknowledgedFlag] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ This type contains general information relating to a user that may be impacted b [active]: #active #### [active] -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ This type contains general information relating to a user that may be impacted b [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ This type contains general information relating to a user that may be impacted b [usrRecordId]: #usrrecordid #### [usrRecordId] -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ This type contains general information relating to a user that may be impacted b [impactedResources]: #impactedresources #### [impactedResources] A collection of resources impacted by the associated event. -Type: **SoftLayer_Notification_Occurrence_Resource[] ** +Type: **SoftLayer_Notification_Occurrence_Resource[] ** + @@ -101,7 +108,8 @@ A collection of resources impacted by the associated event. [notificationOccurrenceEvent]: #notificationoccurrenceevent #### [notificationOccurrenceEvent] The associated event. -Type: **SoftLayer_Notification_Occurrence_Event ** +Type: **SoftLayer_Notification_Occurrence_Event ** + @@ -111,7 +119,8 @@ The associated event. [user]: #user #### [user] The impacted user. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -123,7 +132,8 @@ The impacted user. [impactedResourceCount]: #impactedresourcecount #### [impactedResourceCount] A count of a collection of resources impacted by the associated event. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Preference/_index.md b/content/reference/datatypes/SoftLayer_Notification_Preference/_index.md index 4c9b0bc647..e27240fadf 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Preference/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Preference/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ Retrieve details for preferences. Preferences are used to allow the subscriber [description]: #description #### [description] A description of what the preference is used for. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ A description of what the preference is used for. [id]: #id #### [id] Unique identifier for the notification preference. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Unique identifier for the notification preference. [keyName]: #keyname #### [keyName] Name that can be used by external systems to refer to preference. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Name that can be used by external systems to refer to preference. [maximumValue]: #maximumvalue #### [maximumValue] Largest value allowed for the preference. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ Largest value allowed for the preference. [minimumValue]: #minimumvalue #### [minimumValue] Smallest value allowed for the preference. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Smallest value allowed for the preference. [name]: #name #### [name] Friendly name for the notification. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ Friendly name for the notification. [units]: #units #### [units] The unit of measure used for the preference's value, minimum and maximum as well. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The unit of measure used for the preference's value, minimum and maximum as well [value]: #value #### [value] Default value used when setting up preferences for a new subscriber. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Subscriber/_index.md b/content/reference/datatypes/SoftLayer_Notification_Subscriber/_index.md index 4561c066a3..40d3a5479c 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Subscriber/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Subscriber/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [active]: #active #### [active] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
              @@ -65,7 +69,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ classes: [notificationId]: #notificationid #### [notificationId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [notificationSubscriberTypeId]: #notificationsubscribertypeid #### [notificationSubscriberTypeId] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [notificationSubscriberTypeResourceId]: #notificationsubscribertyperesourceid #### [notificationSubscriberTypeResourceId] -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ classes: [deliveryMethods]: #deliverymethods #### [deliveryMethods] -Type: **SoftLayer_Notification_Subscriber_Delivery_Method[] ** +Type: **SoftLayer_Notification_Subscriber_Delivery_Method[] ** + @@ -131,7 +141,8 @@ classes: [notification]: #notification #### [notification] -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -143,7 +154,8 @@ classes: [deliveryMethodCount]: #deliverymethodcount #### [deliveryMethodCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Subscriber_Customer/_index.md b/content/reference/datatypes/SoftLayer_Notification_Subscriber_Customer/_index.md index 87009ed566..58ea24fad7 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Subscriber_Customer/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Subscriber_Customer/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [active]: #active #### [active] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
              @@ -65,7 +69,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ classes: [notificationId]: #notificationid #### [notificationId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [notificationSubscriberTypeId]: #notificationsubscribertypeid #### [notificationSubscriberTypeId] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [notificationSubscriberTypeResourceId]: #notificationsubscribertyperesourceid #### [notificationSubscriberTypeResourceId] -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ classes: [deliveryMethods]: #deliverymethods #### [deliveryMethods] -Type: **SoftLayer_Notification_Subscriber_Delivery_Method[] ** +Type: **SoftLayer_Notification_Subscriber_Delivery_Method[] ** + @@ -131,7 +141,8 @@ classes: [notification]: #notification #### [notification] -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -141,7 +152,8 @@ classes: [subscriberRecord]: #subscriberrecord #### [subscriberRecord] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -153,7 +165,8 @@ classes: [deliveryMethodCount]: #deliverymethodcount #### [deliveryMethodCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Notification_Subscriber_Delivery_Method/_index.md b/content/reference/datatypes/SoftLayer_Notification_Subscriber_Delivery_Method/_index.md index bb4fd51cd8..7cb161e359 100644 --- a/content/reference/datatypes/SoftLayer_Notification_Subscriber_Delivery_Method/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_Subscriber_Delivery_Method/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Provides details for the subscriber's delivery methods. @@ -45,7 +47,8 @@ Provides details for the subscriber's delivery methods. [active]: #active #### [active] Indicates the subscriber's delivery method availability for notifications. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Indicates the subscriber's delivery method availability for notifications. [createDate]: #createdate #### [createDate] Date the subscriber's delivery method was created. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ Date the subscriber's delivery method was created. [modifyDate]: #modifydate #### [modifyDate] Date the subscriber's delivery method was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ Date the subscriber's delivery method was last modified. [notificationDeliveryMethodId]: #notificationdeliverymethodid #### [notificationDeliveryMethodId] Identifier for the notification delivery method. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Identifier for the notification delivery method. [notificationSubscriberId]: #notificationsubscriberid #### [notificationSubscriberId] Identifier for the subscriber. -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ Identifier for the subscriber. [notificationDeliveryMethod]: #notificationdeliverymethod #### [notificationDeliveryMethod] -Type: **SoftLayer_Notification_Delivery_Method ** +Type: **SoftLayer_Notification_Delivery_Method ** + @@ -111,7 +119,8 @@ Identifier for the subscriber. [notificationSubscriber]: #notificationsubscriber #### [notificationSubscriber] -Type: **SoftLayer_Notification_Subscriber ** +Type: **SoftLayer_Notification_Subscriber ** + diff --git a/content/reference/datatypes/SoftLayer_Notification_User_Subscriber/_index.md b/content/reference/datatypes/SoftLayer_Notification_User_Subscriber/_index.md index ba16114bca..04122b8c22 100644 --- a/content/reference/datatypes/SoftLayer_Notification_User_Subscriber/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_User_Subscriber/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -52,7 +54,8 @@ NOTE: There are preferences and delivery methods that cannot be modified. Also, [active]: #active #### [active] The current status of the subscription. -Type: **integer** +Type: **integer** + @@ -62,7 +65,8 @@ The current status of the subscription. [id]: #id #### [id] Unique identifier of the subscriber that will receive the alerts. -Type: **integer** +Type: **integer** + @@ -72,7 +76,8 @@ Unique identifier of the subscriber that will receive the alerts. [notificationId]: #notificationid #### [notificationId] Unique identifier of the notification subscribed to. -Type: **integer** +Type: **integer** + @@ -82,7 +87,8 @@ Unique identifier of the notification subscribed to. [userRecordId]: #userrecordid #### [userRecordId] Unique identifier of the user the subscription is for. -Type: **integer** +Type: **integer** + @@ -98,7 +104,8 @@ Unique identifier of the user the subscription is for. [deliveryMethods]: #deliverymethods #### [deliveryMethods] The delivery methods used to send the subscribed notification. -Type: **SoftLayer_Notification_Delivery_Method[] ** +Type: **SoftLayer_Notification_Delivery_Method[] ** + @@ -108,7 +115,8 @@ The delivery methods used to send the subscribed notification. [notification]: #notification #### [notification] Notification subscribed to. -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -118,7 +126,8 @@ Notification subscribed to. [preferences]: #preferences #### [preferences] Associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold. -Type: **SoftLayer_Notification_User_Subscriber_Preference[] ** +Type: **SoftLayer_Notification_User_Subscriber_Preference[] ** + @@ -128,7 +137,8 @@ Associated subscriber preferences used for the notification subscription. For ex [preferencesDetails]: #preferencesdetails #### [preferencesDetails] Preference details such as description, minimum and maximum limits, default value and unit of measure. -Type: **SoftLayer_Notification_Preference[] ** +Type: **SoftLayer_Notification_Preference[] ** + @@ -138,7 +148,8 @@ Preference details such as description, minimum and maximum limits, default valu [resourceRecord]: #resourcerecord #### [resourceRecord] The subscriber id to resource id mapping. -Type: **SoftLayer_Notification_User_Subscriber_Resource ** +Type: **SoftLayer_Notification_User_Subscriber_Resource ** + @@ -148,7 +159,8 @@ The subscriber id to resource id mapping. [userRecord]: #userrecord #### [userRecord] User record for the subscription. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -160,7 +172,8 @@ User record for the subscription. [deliveryMethodCount]: #deliverymethodcount #### [deliveryMethodCount] A count of the delivery methods used to send the subscribed notification. -Type: **unsigned long** +Type: **unsigned long** + @@ -170,7 +183,8 @@ A count of the delivery methods used to send the subscribed notification. [preferenceCount]: #preferencecount #### [preferenceCount] A count of associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold. -Type: **unsigned long** +Type: **unsigned long** + @@ -180,7 +194,8 @@ A count of associated subscriber preferences used for the notification subscript [preferencesDetailCount]: #preferencesdetailcount #### [preferencesDetailCount] A count of preference details such as description, minimum and maximum limits, default value and unit of measure. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Billing/_index.md b/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Billing/_index.md index 33f3a88015..df4ee62313 100644 --- a/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Billing/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Billing/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -52,7 +54,8 @@ NOTE: There are preferences and delivery methods that cannot be modified. Also, [active]: #active #### [active] The current status of the subscription. -Type: **integer** +Type: **integer** + @@ -62,7 +65,8 @@ The current status of the subscription. [id]: #id #### [id] Unique identifier of the subscriber that will receive the alerts. -Type: **integer** +Type: **integer** + @@ -72,7 +76,8 @@ Unique identifier of the subscriber that will receive the alerts. [notificationId]: #notificationid #### [notificationId] Unique identifier of the notification subscribed to. -Type: **integer** +Type: **integer** + @@ -82,7 +87,8 @@ Unique identifier of the notification subscribed to. [userRecordId]: #userrecordid #### [userRecordId] Unique identifier of the user the subscription is for. -Type: **integer** +Type: **integer** + @@ -98,7 +104,8 @@ Unique identifier of the user the subscription is for. [deliveryMethods]: #deliverymethods #### [deliveryMethods] The delivery methods used to send the subscribed notification. -Type: **SoftLayer_Notification_Delivery_Method[] ** +Type: **SoftLayer_Notification_Delivery_Method[] ** + @@ -108,7 +115,8 @@ The delivery methods used to send the subscribed notification. [notification]: #notification #### [notification] Notification subscribed to. -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -118,7 +126,8 @@ Notification subscribed to. [preferences]: #preferences #### [preferences] Associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold. -Type: **SoftLayer_Notification_User_Subscriber_Preference[] ** +Type: **SoftLayer_Notification_User_Subscriber_Preference[] ** + @@ -128,7 +137,8 @@ Associated subscriber preferences used for the notification subscription. For ex [preferencesDetails]: #preferencesdetails #### [preferencesDetails] Preference details such as description, minimum and maximum limits, default value and unit of measure. -Type: **SoftLayer_Notification_Preference[] ** +Type: **SoftLayer_Notification_Preference[] ** + @@ -138,7 +148,8 @@ Preference details such as description, minimum and maximum limits, default valu [resourceRecord]: #resourcerecord #### [resourceRecord] The subscriber id to resource id mapping. -Type: **SoftLayer_Notification_User_Subscriber_Resource ** +Type: **SoftLayer_Notification_User_Subscriber_Resource ** + @@ -148,7 +159,8 @@ The subscriber id to resource id mapping. [userRecord]: #userrecord #### [userRecord] User record for the subscription. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -160,7 +172,8 @@ User record for the subscription. [deliveryMethodCount]: #deliverymethodcount #### [deliveryMethodCount] A count of the delivery methods used to send the subscribed notification. -Type: **unsigned long** +Type: **unsigned long** + @@ -170,7 +183,8 @@ A count of the delivery methods used to send the subscribed notification. [preferenceCount]: #preferencecount #### [preferenceCount] A count of associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold. -Type: **unsigned long** +Type: **unsigned long** + @@ -180,7 +194,8 @@ A count of associated subscriber preferences used for the notification subscript [preferencesDetailCount]: #preferencesdetailcount #### [preferencesDetailCount] A count of preference details such as description, minimum and maximum limits, default value and unit of measure. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Delivery_Method/_index.md b/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Delivery_Method/_index.md index 3ef5d040c7..18d6563292 100644 --- a/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Delivery_Method/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Delivery_Method/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ Provides mapping details of how the subscriber's notification will be delivered. [active]: #active #### [active] Determines if the delivery method is active for the user. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Determines if the delivery method is active for the user. [notificationMethodId]: #notificationmethodid #### [notificationMethodId] Unique identifier of the method used to deliver notification. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Unique identifier of the method used to deliver notification. [notificationUserSubscriberId]: #notificationusersubscriberid #### [notificationUserSubscriberId] Unique identifier of the subscriber tied to the delivery method. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ Unique identifier of the subscriber tied to the delivery method. [deliveryMethod]: #deliverymethod #### [deliveryMethod] Provides details for the method used to deliver the notification (email, sms, ticket). -Type: **SoftLayer_Notification_Delivery_Method ** +Type: **SoftLayer_Notification_Delivery_Method ** + @@ -91,7 +97,8 @@ Provides details for the method used to deliver the notification (email, sms, ti [notificationUserSubscriber]: #notificationusersubscriber #### [notificationUserSubscriber] The Subscriber information tied to the delivery method. -Type: **SoftLayer_Notification_User_Subscriber ** +Type: **SoftLayer_Notification_User_Subscriber ** + diff --git a/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Mobile/_index.md b/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Mobile/_index.md index 9d91e5a9fb..f19b93b67d 100644 --- a/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Mobile/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Mobile/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -52,7 +54,8 @@ NOTE: There are preferences and delivery methods that cannot be modified. Also, [active]: #active #### [active] The current status of the subscription. -Type: **integer** +Type: **integer** + @@ -62,7 +65,8 @@ The current status of the subscription. [id]: #id #### [id] Unique identifier of the subscriber that will receive the alerts. -Type: **integer** +Type: **integer** + @@ -72,7 +76,8 @@ Unique identifier of the subscriber that will receive the alerts. [notificationId]: #notificationid #### [notificationId] Unique identifier of the notification subscribed to. -Type: **integer** +Type: **integer** + @@ -82,7 +87,8 @@ Unique identifier of the notification subscribed to. [userRecordId]: #userrecordid #### [userRecordId] Unique identifier of the user the subscription is for. -Type: **integer** +Type: **integer** + @@ -98,7 +104,8 @@ Unique identifier of the user the subscription is for. [deliveryMethods]: #deliverymethods #### [deliveryMethods] The delivery methods used to send the subscribed notification. -Type: **SoftLayer_Notification_Delivery_Method[] ** +Type: **SoftLayer_Notification_Delivery_Method[] ** + @@ -108,7 +115,8 @@ The delivery methods used to send the subscribed notification. [notification]: #notification #### [notification] Notification subscribed to. -Type: **SoftLayer_Notification ** +Type: **SoftLayer_Notification ** + @@ -118,7 +126,8 @@ Notification subscribed to. [preferences]: #preferences #### [preferences] Associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold. -Type: **SoftLayer_Notification_User_Subscriber_Preference[] ** +Type: **SoftLayer_Notification_User_Subscriber_Preference[] ** + @@ -128,7 +137,8 @@ Associated subscriber preferences used for the notification subscription. For ex [preferencesDetails]: #preferencesdetails #### [preferencesDetails] Preference details such as description, minimum and maximum limits, default value and unit of measure. -Type: **SoftLayer_Notification_Preference[] ** +Type: **SoftLayer_Notification_Preference[] ** + @@ -138,7 +148,8 @@ Preference details such as description, minimum and maximum limits, default valu [resourceRecord]: #resourcerecord #### [resourceRecord] The subscriber id to resource id mapping. -Type: **SoftLayer_Notification_User_Subscriber_Resource ** +Type: **SoftLayer_Notification_User_Subscriber_Resource ** + @@ -148,7 +159,8 @@ The subscriber id to resource id mapping. [userRecord]: #userrecord #### [userRecord] User record for the subscription. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -160,7 +172,8 @@ User record for the subscription. [deliveryMethodCount]: #deliverymethodcount #### [deliveryMethodCount] A count of the delivery methods used to send the subscribed notification. -Type: **unsigned long** +Type: **unsigned long** + @@ -170,7 +183,8 @@ A count of the delivery methods used to send the subscribed notification. [preferenceCount]: #preferencecount #### [preferenceCount] A count of associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold. -Type: **unsigned long** +Type: **unsigned long** + @@ -180,7 +194,8 @@ A count of associated subscriber preferences used for the notification subscript [preferencesDetailCount]: #preferencesdetailcount #### [preferencesDetailCount] A count of preference details such as description, minimum and maximum limits, default value and unit of measure. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Preference/_index.md b/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Preference/_index.md index 21a2cfea00..cbf09417c9 100644 --- a/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Preference/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Preference/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -52,7 +54,8 @@ NOTE: Some preferences have certain restrictions on values that can be set. [id]: #id #### [id] Unique identifier for the subscriber's preferences. -Type: **integer** +Type: **integer** + @@ -62,7 +65,8 @@ Unique identifier for the subscriber's preferences. [notificationPreferenceId]: #notificationpreferenceid #### [notificationPreferenceId] Unique identifier of the default preference for which the subscriber preference is based on. For example, if no preferences are supplied during the creation of a subscriber. The default values are pulled using this property. -Type: **integer** +Type: **integer** + @@ -72,7 +76,8 @@ Unique identifier of the default preference for which the subscriber preference [notificationUserSubscriberId]: #notificationusersubscriberid #### [notificationUserSubscriberId] Unique identifier of the subscriber tied to the subscriber preference. -Type: **integer** +Type: **integer** + @@ -82,7 +87,8 @@ Unique identifier of the subscriber tied to the subscriber preference. [value]: #value #### [value] The user supplied value to "override" the "default" preference's value. -Type: **string** +Type: **string** + @@ -98,7 +104,8 @@ The user supplied value to "override" the "default" preference's value. [defaultPreference]: #defaultpreference #### [defaultPreference] Details such name, keyname, minimum and maximum values for the preference. -Type: **SoftLayer_Notification_Preference ** +Type: **SoftLayer_Notification_Preference ** + @@ -108,7 +115,8 @@ Details such name, keyname, minimum and maximum values for the preference. [notificationUserSubscriber]: #notificationusersubscriber #### [notificationUserSubscriber] Details of the subscriber tied to the preference. -Type: **SoftLayer_Notification_User_Subscriber ** +Type: **SoftLayer_Notification_User_Subscriber ** + diff --git a/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Resource/_index.md b/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Resource/_index.md index e85980f349..3b2f7bccb1 100644 --- a/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Resource/_index.md +++ b/content/reference/datatypes/SoftLayer_Notification_User_Subscriber_Resource/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ Retrieve identifier cross-reference information. SoftLayer_Notification_User_Su [notificationUserSubscriberId]: #notificationusersubscriberid #### [notificationUserSubscriberId] Unique identifier of the subscriber that will receive the alerts for the resource subscribed to a notification. -Type: **integer** +Type: **integer** + @@ -59,7 +62,8 @@ Unique identifier for a SoftLayer service that is subscribed to a notification. Storage EVault CDN -Type: **integer** +Type: **integer** + @@ -75,7 +79,8 @@ Storage EVault CDN [notificationUserSubscriber]: #notificationusersubscriber #### [notificationUserSubscriber] The Subscriber information tied to the resource service. -Type: **SoftLayer_Notification_User_Subscriber ** +Type: **SoftLayer_Notification_User_Subscriber ** + diff --git a/content/reference/datatypes/SoftLayer_Policy_Document_Acceptance_Quote/_index.md b/content/reference/datatypes/SoftLayer_Policy_Document_Acceptance_Quote/_index.md index 306b88b78e..c45fc9d149 100644 --- a/content/reference/datatypes/SoftLayer_Policy_Document_Acceptance_Quote/_index.md +++ b/content/reference/datatypes/SoftLayer_Policy_Document_Acceptance_Quote/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Oder_Quote data type records acceptance of policy documents for a quote. @@ -51,7 +53,8 @@ The SoftLayer_Billing_Oder_Quote data type records acceptance of policy document [resource]: #resource #### [resource] -Type: **SoftLayer_Billing_Order_Quote ** +Type: **SoftLayer_Billing_Order_Quote ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Catalog/_index.md b/content/reference/datatypes/SoftLayer_Product_Catalog/_index.md index c1845a398f..b2cf462d11 100644 --- a/content/reference/datatypes/SoftLayer_Product_Catalog/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Catalog/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ A Catalog is defined as a set of prices for products that SoftLayer offers for s [keyName]: #keyname #### [keyName] The Key Name of the Catalog, used for direct references -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ The Key Name of the Catalog, used for direct references [brands]: #brands #### [brands] Brands using this Catalog -Type: **SoftLayer_Brand[] ** +Type: **SoftLayer_Brand[] ** + @@ -71,7 +75,8 @@ Brands using this Catalog [packages]: #packages #### [packages] Packages available in this catalog -Type: **SoftLayer_Product_Package[] ** +Type: **SoftLayer_Product_Package[] ** + @@ -81,7 +86,8 @@ Packages available in this catalog [prices]: #prices #### [prices] Prices available in this catalog -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -91,7 +97,8 @@ Prices available in this catalog [products]: #products #### [products] Products available in catalog -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -103,7 +110,8 @@ Products available in catalog [brandCount]: #brandcount #### [brandCount] A count of brands using this Catalog -Type: **unsigned long** +Type: **unsigned long** + @@ -113,7 +121,8 @@ A count of brands using this Catalog [packageCount]: #packagecount #### [packageCount] A count of packages available in this catalog -Type: **unsigned long** +Type: **unsigned long** + @@ -123,7 +132,8 @@ A count of packages available in this catalog [priceCount]: #pricecount #### [priceCount] A count of prices available in this catalog -Type: **unsigned long** +Type: **unsigned long** + @@ -133,7 +143,8 @@ A count of prices available in this catalog [productCount]: #productcount #### [productCount] A count of products available in catalog -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Product_Catalog_Item_Price/_index.md b/content/reference/datatypes/SoftLayer_Product_Catalog_Item_Price/_index.md index 040e96afc9..60284ce02b 100644 --- a/content/reference/datatypes/SoftLayer_Product_Catalog_Item_Price/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Catalog_Item_Price/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Product_Catalog_Item_Price type assigns an Item Price to a Catalog [catalogId]: #catalogid #### [catalogId] The id of the Catalog the Item Price is part of. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The id of the Catalog the Item Price is part of. [createDate]: #createdate #### [createDate] The time the Item Price was defined in the Catalog -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The time the Item Price was defined in the Catalog [modifyDate]: #modifydate #### [modifyDate] The time the Item Price was changed for the Catalog -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The time the Item Price was changed for the Catalog [priceId]: #priceid #### [priceId] The id of the Item Price that is part of the Catalog. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The id of the Item Price that is part of the Catalog. [catalog]: #catalog #### [catalog] Catalog being assigned -Type: **SoftLayer_Product_Catalog ** +Type: **SoftLayer_Product_Catalog ** + @@ -101,7 +108,8 @@ Catalog being assigned [price]: #price #### [price] Price being assigned -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Group/_index.md b/content/reference/datatypes/SoftLayer_Product_Group/_index.md index 1c7a9577fb..7f33624e37 100644 --- a/content/reference/datatypes/SoftLayer_Product_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Group/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Product_Group data type contains product group relationship. @@ -45,7 +47,8 @@ The SoftLayer_Product_Group data type contains product group relationship. [name]: #name #### [name] The name of the product group. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item/_index.md b/content/reference/datatypes/SoftLayer_Product_Item/_index.md index 03f05c368e..75268083bd 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Product_Item data type contains general information relating to a single SoftLayer product. @@ -45,7 +47,8 @@ The SoftLayer_Product_Item data type contains general information relating to a [capacity]: #capacity #### [capacity] Some Product Items have capacity information such as RAM and bandwidth, and others. This provides the numerical representation of the capacity given in the description of this product item. -Type: **decimal** +Type: **decimal** + @@ -55,7 +58,8 @@ Some Product Items have capacity information such as RAM and bandwidth, and othe [description]: #description #### [description] A product's description -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ A product's description [hardwareGenericComponentId]: #hardwaregenericcomponentid #### [hardwareGenericComponentId] The hardware generic component model ID of the product. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The hardware generic component model ID of the product. [id]: #id #### [id] A product's internal identification number -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ A product's internal identification number [itemTaxCategoryId]: #itemtaxcategoryid #### [itemTaxCategoryId] A products tax category internal identification number -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ A products tax category internal identification number [keyName]: #keyname #### [keyName] A unique key name for the product. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ A unique key name for the product. [longDescription]: #longdescription #### [longDescription] Detailed product description -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ Detailed product description [softwareDescriptionId]: #softwaredescriptionid #### [softwareDescriptionId] The unique identifier of the SoftLayer_Software_Description tied to this item. -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ The unique identifier of the SoftLayer_Software_Description tied to this item. [units]: #units #### [units] The unit of measurement that a product item is measured in. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The unit of measurement that a product item is measured in. [upgradeItemId]: #upgradeitemid #### [upgradeItemId] A products upgrade item's internal identification number -Type: **integer** +Type: **integer** + @@ -151,7 +163,8 @@ A products upgrade item's internal identification number [activePresaleEvents]: #activepresaleevents #### [activePresaleEvents] -Type: **SoftLayer_Sales_Presale_Event[] ** +Type: **SoftLayer_Sales_Presale_Event[] ** + @@ -161,7 +174,8 @@ A products upgrade item's internal identification number [activeUsagePrices]: #activeusageprices #### [activeUsagePrices] Active usage based prices. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -171,7 +185,8 @@ Active usage based prices. [attributes]: #attributes #### [attributes] The attribute values for a product item. These are additional properties that give extra information about the product being sold. -Type: **SoftLayer_Product_Item_Attribute[] ** +Type: **SoftLayer_Product_Item_Attribute[] ** + @@ -181,7 +196,8 @@ The attribute values for a product item. These are additional properties that gi [availabilityAttributes]: #availabilityattributes #### [availabilityAttributes] Attributes that govern when an item may no longer be available. -Type: **SoftLayer_Product_Item_Attribute[] ** +Type: **SoftLayer_Product_Item_Attribute[] ** + @@ -191,7 +207,8 @@ Attributes that govern when an item may no longer be available. [billingType]: #billingtype #### [billingType] An item's special billing type, if applicable. -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ An item's special billing type, if applicable. [bundle]: #bundle #### [bundle] An item's included product item references. Some items have other items included in them that we specifically detail. They are here called Bundled Items. An example is Plesk unlimited. It as a bundled item labeled 'SiteBuilder'. These are the SoftLayer_Product_Item_Bundles objects. See the SoftLayer_Product_Item::bundleItems property for bundle of SoftLayer_Product_Item of objects. -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -211,7 +229,8 @@ An item's included product item references. Some items have other items included [bundleItems]: #bundleitems #### [bundleItems] An item's included products. Some items have other items included in them that we specifically detail. They are here called Bundled Items. An example is Plesk unlimited. It as a bundled item labeled 'SiteBuilder'. These are the SoftLayer_Product_Item objects. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -221,7 +240,8 @@ An item's included products. Some items have other items included in them that w [capacityMaximum]: #capacitymaximum #### [capacityMaximum] When the product capacity is best described as a range, this holds the ceiling of the range. -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ When the product capacity is best described as a range, this holds the ceiling o [capacityMinimum]: #capacityminimum #### [capacityMinimum] When the product capacity is best described as a range, this holds the floor of the range. -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ When the product capacity is best described as a range, this holds the floor of [capacityRestrictedProductFlag]: #capacityrestrictedproductflag #### [capacityRestrictedProductFlag] This flag indicates that this product is restricted by a capacity on a related product. -Type: **boolean** +Type: **boolean** + @@ -251,7 +273,8 @@ This flag indicates that this product is restricted by a capacity on a related p [categories]: #categories #### [categories] An item's associated item categories. -Type: **SoftLayer_Product_Item_Category[] ** +Type: **SoftLayer_Product_Item_Category[] ** + @@ -261,7 +284,8 @@ An item's associated item categories. [configurationTemplates]: #configurationtemplates #### [configurationTemplates] Some product items have configuration templates which can be used to during provisioning of that product. -Type: **SoftLayer_Configuration_Template[] ** +Type: **SoftLayer_Configuration_Template[] ** + @@ -271,7 +295,8 @@ Some product items have configuration templates which can be used to during prov [conflicts]: #conflicts #### [conflicts] An item's conflicts. For example, McAfee LinuxShield cannot be ordered with Windows. It was not meant for that operating system and as such is a conflict. -Type: **SoftLayer_Product_Item_Resource_Conflict[] ** +Type: **SoftLayer_Product_Item_Resource_Conflict[] ** + @@ -281,7 +306,8 @@ An item's conflicts. For example, McAfee LinuxShield cannot be ordered with Wind [coreRestrictedItemFlag]: #corerestricteditemflag #### [coreRestrictedItemFlag] This flag indicates that this product is restricted by the number of cores on the compute instance. This is deprecated. Use [SoftLayer_Product_Item::getCapacityRestrictedProductFlag]({{}}) -Type: **boolean** +Type: **boolean** + @@ -291,7 +317,8 @@ This flag indicates that this product is restricted by the number of cores on th [downgradeItem]: #downgradeitem #### [downgradeItem] Some product items have a downgrade path. This is the first product item in the downgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -301,7 +328,8 @@ Some product items have a downgrade path. This is the first product item in the [downgradeItems]: #downgradeitems #### [downgradeItems] Some product items have a downgrade path. These are those product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -311,7 +339,8 @@ Some product items have a downgrade path. These are those product items. [globalCategoryConflicts]: #globalcategoryconflicts #### [globalCategoryConflicts] An item's category conflicts. For example, 10 Gbps redundant network functionality cannot be ordered with a secondary GPU and as such is a conflict. -Type: **SoftLayer_Product_Item_Resource_Conflict[] ** +Type: **SoftLayer_Product_Item_Resource_Conflict[] ** + @@ -321,7 +350,8 @@ An item's category conflicts. For example, 10 Gbps redundant network functionali [hardwareGenericComponentModel]: #hardwaregenericcomponentmodel #### [hardwareGenericComponentModel] The generic hardware component that this item represents. -Type: **SoftLayer_Hardware_Component_Model_Generic ** +Type: **SoftLayer_Hardware_Component_Model_Generic ** + @@ -331,7 +361,8 @@ The generic hardware component that this item represents. [hideFromPortalFlag]: #hidefromportalflag #### [hideFromPortalFlag] -Type: **boolean** +Type: **boolean** + @@ -341,7 +372,8 @@ The generic hardware component that this item represents. [ineligibleForAccountDiscountFlag]: #ineligibleforaccountdiscountflag #### [ineligibleForAccountDiscountFlag] -Type: **boolean** +Type: **boolean** + @@ -351,7 +383,8 @@ The generic hardware component that this item represents. [inventory]: #inventory #### [inventory] DEPRECATED. An item's inventory status per datacenter. -Type: **SoftLayer_Product_Package_Inventory[] ** +Type: **SoftLayer_Product_Package_Inventory[] ** + @@ -361,7 +394,8 @@ DEPRECATED. An item's inventory status per datacenter. [isEngineeredServerProduct]: #isengineeredserverproduct #### [isEngineeredServerProduct] Flag to indicate the server product is engineered for a multi-server solution. (Deprecated) -Type: **boolean** +Type: **boolean** + @@ -371,7 +405,8 @@ Flag to indicate the server product is engineered for a multi-server solution. ( [itemCategory]: #itemcategory #### [itemCategory] An item's primary item category. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -381,7 +416,8 @@ An item's primary item category. [localDiskFlag]: #localdiskflag #### [localDiskFlag] -Type: **boolean** +Type: **boolean** + @@ -391,7 +427,8 @@ An item's primary item category. [locationConflicts]: #locationconflicts #### [locationConflicts] An item's location conflicts. For example, Dual Path network functionality cannot be ordered in WDC and as such is a conflict. -Type: **SoftLayer_Product_Item_Resource_Conflict[] ** +Type: **SoftLayer_Product_Item_Resource_Conflict[] ** + @@ -401,7 +438,8 @@ An item's location conflicts. For example, Dual Path network functionality canno [minimumNvmeBays]: #minimumnvmebays #### [minimumNvmeBays] The minimum number of bays that support NVMe SSDs. -Type: **integer** +Type: **integer** + @@ -411,7 +449,8 @@ The minimum number of bays that support NVMe SSDs. [nvmeDiskFlag]: #nvmediskflag #### [nvmeDiskFlag] Indicates whether an item is a NVMe SSD. -Type: **boolean** +Type: **boolean** + @@ -421,7 +460,8 @@ Indicates whether an item is a NVMe SSD. [objectStorageClusterGeolocationType]: #objectstorageclustergeolocationtype #### [objectStorageClusterGeolocationType] -Type: **string** +Type: **string** + @@ -431,7 +471,8 @@ Indicates whether an item is a NVMe SSD. [objectStorageItemFlag]: #objectstorageitemflag #### [objectStorageItemFlag] -Type: **boolean** +Type: **boolean** + @@ -441,7 +482,8 @@ Indicates whether an item is a NVMe SSD. [objectStorageServiceClass]: #objectstorageserviceclass #### [objectStorageServiceClass] -Type: **string** +Type: **string** + @@ -451,7 +493,8 @@ Indicates whether an item is a NVMe SSD. [packages]: #packages #### [packages] A collection of all the SoftLayer_Product_Package(s) in which this item exists. -Type: **SoftLayer_Product_Package[] ** +Type: **SoftLayer_Product_Package[] ** + @@ -461,7 +504,8 @@ A collection of all the SoftLayer_Product_Package(s) in which this item exists. [physicalCoreCapacity]: #physicalcorecapacity #### [physicalCoreCapacity] The number of cores that a processor has. -Type: **string** +Type: **string** + @@ -471,7 +515,8 @@ The number of cores that a processor has. [presaleEvents]: #presaleevents #### [presaleEvents] -Type: **SoftLayer_Sales_Presale_Event[] ** +Type: **SoftLayer_Sales_Presale_Event[] ** + @@ -481,7 +526,8 @@ The number of cores that a processor has. [prices]: #prices #### [prices] A product item's prices. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -491,7 +537,8 @@ A product item's prices. [requirements]: #requirements #### [requirements] If an item must be ordered with another item, it will have a requirement item here. -Type: **SoftLayer_Product_Item_Requirement[] ** +Type: **SoftLayer_Product_Item_Requirement[] ** + @@ -501,7 +548,8 @@ If an item must be ordered with another item, it will have a requirement item he [rules]: #rules #### [rules] An item's rules. This includes the requirements and conflicts to resources that an item has. -Type: **SoftLayer_Product_Item_Rule[] ** +Type: **SoftLayer_Product_Item_Rule[] ** + @@ -511,7 +559,8 @@ An item's rules. This includes the requirements and conflicts to resources that [softwareDescription]: #softwaredescription #### [softwareDescription] The SoftLayer_Software_Description tied to this item. This will only be populated for software items. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -521,7 +570,8 @@ The SoftLayer_Software_Description tied to this item. This will only be populate [taxCategory]: #taxcategory #### [taxCategory] An item's tax category, if applicable. -Type: **SoftLayer_Product_Item_Tax_Category ** +Type: **SoftLayer_Product_Item_Tax_Category ** + @@ -531,7 +581,8 @@ An item's tax category, if applicable. [thirdPartyPolicyAssignments]: #thirdpartypolicyassignments #### [thirdPartyPolicyAssignments] Third-party policy assignments for this product. -Type: **SoftLayer_Product_Item_Policy_Assignment[] ** +Type: **SoftLayer_Product_Item_Policy_Assignment[] ** + @@ -541,7 +592,8 @@ Third-party policy assignments for this product. [thirdPartySupportVendor]: #thirdpartysupportvendor #### [thirdPartySupportVendor] The 3rd party vendor for a support subscription item. (Deprecated) -Type: **string** +Type: **string** + @@ -551,7 +603,8 @@ The 3rd party vendor for a support subscription item. (Deprecated) [totalPhysicalCoreCapacity]: #totalphysicalcorecapacity #### [totalPhysicalCoreCapacity] The total number of physical processing cores (excluding virtual cores / hyperthreads) for this server. -Type: **integer** +Type: **integer** + @@ -561,7 +614,8 @@ The total number of physical processing cores (excluding virtual cores / hyperth [totalPhysicalCoreCount]: #totalphysicalcorecount #### [totalPhysicalCoreCount] Shows the total number of cores. This is deprecated. Use [SoftLayer_Product_Item::getCapacity]({{}}) for server products -Type: **integer** +Type: **integer** + @@ -571,7 +625,8 @@ Shows the total number of cores. This is deprecated. Use [SoftLayer_Product_Item [totalProcessorCapacity]: #totalprocessorcapacity #### [totalProcessorCapacity] The total number of processors for this server. -Type: **integer** +Type: **integer** + @@ -581,7 +636,8 @@ The total number of processors for this server. [upgradeItem]: #upgradeitem #### [upgradeItem] Some product items have an upgrade path. This is the next product item in the upgrade path. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -591,7 +647,8 @@ Some product items have an upgrade path. This is the next product item in the up [upgradeItems]: #upgradeitems #### [upgradeItems] Some product items have an upgrade path. These are those upgrade product items. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -603,7 +660,8 @@ Some product items have an upgrade path. These are those upgrade product items. [activePresaleEventCount]: #activepresaleeventcount #### [activePresaleEventCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -613,7 +671,8 @@ A count of [activeUsagePriceCount]: #activeusagepricecount #### [activeUsagePriceCount] A count of active usage based prices. -Type: **unsigned long** +Type: **unsigned long** + @@ -623,7 +682,8 @@ A count of active usage based prices. [attributeCount]: #attributecount #### [attributeCount] A count of the attribute values for a product item. These are additional properties that give extra information about the product being sold. -Type: **unsigned long** +Type: **unsigned long** + @@ -633,7 +693,8 @@ A count of the attribute values for a product item. These are additional propert [availabilityAttributeCount]: #availabilityattributecount #### [availabilityAttributeCount] A count of attributes that govern when an item may no longer be available. -Type: **unsigned long** +Type: **unsigned long** + @@ -643,7 +704,8 @@ A count of attributes that govern when an item may no longer be available. [bundleCount]: #bundlecount #### [bundleCount] A count of an item's included product item references. Some items have other items included in them that we specifically detail. They are here called Bundled Items. An example is Plesk unlimited. It as a bundled item labeled 'SiteBuilder'. These are the SoftLayer_Product_Item_Bundles objects. See the SoftLayer_Product_Item::bundleItems property for bundle of SoftLayer_Product_Item of objects. -Type: **unsigned long** +Type: **unsigned long** + @@ -653,7 +715,8 @@ A count of an item's included product item references. Some items have other ite [bundleItemCount]: #bundleitemcount #### [bundleItemCount] A count of an item's included products. Some items have other items included in them that we specifically detail. They are here called Bundled Items. An example is Plesk unlimited. It as a bundled item labeled 'SiteBuilder'. These are the SoftLayer_Product_Item objects. -Type: **unsigned long** +Type: **unsigned long** + @@ -663,7 +726,8 @@ A count of an item's included products. Some items have other items included in [categoryCount]: #categorycount #### [categoryCount] A count of an item's associated item categories. -Type: **unsigned long** +Type: **unsigned long** + @@ -673,7 +737,8 @@ A count of an item's associated item categories. [configurationTemplateCount]: #configurationtemplatecount #### [configurationTemplateCount] A count of some product items have configuration templates which can be used to during provisioning of that product. -Type: **unsigned long** +Type: **unsigned long** + @@ -683,7 +748,8 @@ A count of some product items have configuration templates which can be used to [downgradeItemCount]: #downgradeitemcount #### [downgradeItemCount] A count of some product items have a downgrade path. These are those product items. -Type: **unsigned long** +Type: **unsigned long** + @@ -693,7 +759,8 @@ A count of some product items have a downgrade path. These are those product ite [inventoryCount]: #inventorycount #### [inventoryCount] A count of dEPRECATED. An item's inventory status per datacenter. -Type: **unsigned long** +Type: **unsigned long** + @@ -703,7 +770,8 @@ A count of dEPRECATED. An item's inventory status per datacenter. [packageCount]: #packagecount #### [packageCount] A count of a collection of all the SoftLayer_Product_Package(s) in which this item exists. -Type: **unsigned long** +Type: **unsigned long** + @@ -713,7 +781,8 @@ A count of a collection of all the SoftLayer_Product_Package(s) in which this it [presaleEventCount]: #presaleeventcount #### [presaleEventCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -723,7 +792,8 @@ A count of [priceCount]: #pricecount #### [priceCount] A count of a product item's prices. -Type: **unsigned long** +Type: **unsigned long** + @@ -733,7 +803,8 @@ A count of a product item's prices. [ruleCount]: #rulecount #### [ruleCount] A count of an item's rules. This includes the requirements and conflicts to resources that an item has. -Type: **unsigned long** +Type: **unsigned long** + @@ -743,7 +814,8 @@ A count of an item's rules. This includes the requirements and conflicts to reso [thirdPartyPolicyAssignmentCount]: #thirdpartypolicyassignmentcount #### [thirdPartyPolicyAssignmentCount] A count of third-party policy assignments for this product. -Type: **unsigned long** +Type: **unsigned long** + @@ -753,7 +825,8 @@ A count of third-party policy assignments for this product. [upgradeItemCount]: #upgradeitemcount #### [upgradeItemCount] A count of some product items have an upgrade path. These are those upgrade product items. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Attribute/_index.md index 52598d1f0c..4fb3c9378f 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Attribute/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The [SoftLayer_Product_Item_Attribute]({{}}) data type allows us to describe a [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. @@ -45,7 +47,8 @@ The [SoftLayer_Product_Item_Attribute]({{Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ This is the primary key value for the product attribute. [itemAttributeTypeId]: #itemattributetypeid #### [itemAttributeTypeId] This is a foreign key value for the [SoftLayer_Product_Item_Attribute_Type]({{}}). -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ This is a foreign key value for the [SoftLayer_Product_Item_Attribute_Type]({{}}). -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ This is a foreign key value for the [SoftLayer_Product_Item]({{Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ This is the value for the attribute. [attributeType]: #attributetype #### [attributeType] This represents the attribute type of this product attribute. -Type: **SoftLayer_Product_Item_Attribute_Type ** +Type: **SoftLayer_Product_Item_Attribute_Type ** + @@ -101,7 +108,8 @@ This represents the attribute type of this product attribute. [attributeTypeKeyName]: #attributetypekeyname #### [attributeTypeKeyName] This represents the attribute type's key name of this product attribute. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ This represents the attribute type's key name of this product attribute. [item]: #item #### [item] This represents the product that an attribute is tied to. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Attribute_Type/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Attribute_Type/_index.md index 5b0b00296d..059282a313 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Attribute_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Attribute_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The [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]({{}}) by a unique key name value. @@ -45,7 +47,8 @@ The [SoftLayer_Product_Item_Attribute_Type]({{Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ This is the unique identifier of the attribute type. [name]: #name #### [name] This is the user-friendly readable name of the attribute type. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Billing_Type/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Billing_Type/_index.md index ef60cbcb3d..29033f9d4a 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Billing_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Billing_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Product_Item_Billing_Type data type models special billing types for non-monthly billed items in the SoftLayer product catalog. @@ -50,7 +52,8 @@ The SoftLayer_Product_Item_Billing_Type data type models special billing types f [name]: #name #### [name] A keyword describing a SoftLayer product item billing type. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Bundles/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Bundles/_index.md index 29fee7914a..2969e29293 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Bundles/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Bundles/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -56,7 +58,8 @@ The SoftLayer_Product_Item_Bundles contains item to price cross references Relat [bundleItemId]: #bundleitemid #### [bundleItemId] Identifier for bundle. -Type: **integer** +Type: **integer** + @@ -66,7 +69,8 @@ Identifier for bundle. [id]: #id #### [id] Identifier for record. -Type: **integer** +Type: **integer** + @@ -76,7 +80,8 @@ Identifier for record. [itemPriceId]: #itempriceid #### [itemPriceId] Identifier for price. -Type: **integer** +Type: **integer** + @@ -92,7 +97,8 @@ Identifier for price. [bundleItem]: #bundleitem #### [bundleItem] Item in bundle. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -102,7 +108,8 @@ Item in bundle. [category]: #category #### [category] Category bundle falls in. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -112,7 +119,8 @@ Category bundle falls in. [itemPrice]: #itemprice #### [itemPrice] Price of item in bundle -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Category/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Category/_index.md index 367f30d856..cbc10098f7 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Category/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Category/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Product_Item_Category data type contains general category information for prices. @@ -45,7 +47,8 @@ The SoftLayer_Product_Item_Category data type contains general category informat [categoryCode]: #categorycode #### [categoryCode] The code used to identify this category. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The code used to identify this category. [id]: #id #### [id] identifier for category. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ identifier for category. [name]: #name #### [name] The friendly, descriptive name of the category as seen on the order forms and on invoices. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The friendly, descriptive name of the category as seen on the order forms and on [quantityLimit]: #quantitylimit #### [quantityLimit] Quantity that can be ordered. If 0, it will inherit the quantity from the server quantity ordered. Otherwise it can be specified with the order separately -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Quantity that can be ordered. If 0, it will inherit the quantity from the server [sortOrder]: #sortorder #### [sortOrder] The sort order of the category. It may be used to affect the order in which the category may appear in lists (on order forms and invoices). -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ The sort order of the category. It may be used to affect the order in which the [billingItems]: #billingitems #### [billingItems] The billing items associated with an account that share a category code with an item category's category code. -Type: **SoftLayer_Billing_Item[] ** +Type: **SoftLayer_Billing_Item[] ** + @@ -111,7 +119,8 @@ The billing items associated with an account that share a category code with an [group]: #group #### [group] This invoice item's "item category group". -Type: **SoftLayer_Product_Item_Category_Group ** +Type: **SoftLayer_Product_Item_Category_Group ** + @@ -121,7 +130,8 @@ This invoice item's "item category group". [groups]: #groups #### [groups] A collection of service offering category groups. Each group contains a collection of items associated with this category. -Type: **SoftLayer_Product_Package_Item_Category_Group[] ** +Type: **SoftLayer_Product_Package_Item_Category_Group[] ** + @@ -131,7 +141,8 @@ A collection of service offering category groups. Each group contains a collecti [orderOptions]: #orderoptions #### [orderOptions] Any unique options associated with an item category. -Type: **SoftLayer_Product_Item_Category_Order_Option_Type[] ** +Type: **SoftLayer_Product_Item_Category_Order_Option_Type[] ** + @@ -141,7 +152,8 @@ Any unique options associated with an item category. [packageConfigurations]: #packageconfigurations #### [packageConfigurations] A list of configuration available in this category.' -Type: **SoftLayer_Product_Package_Order_Configuration[] ** +Type: **SoftLayer_Product_Package_Order_Configuration[] ** + @@ -151,7 +163,8 @@ A list of configuration available in this category.' [presetConfigurations]: #presetconfigurations #### [presetConfigurations] A list of preset configurations this category is used in.' -Type: **SoftLayer_Product_Package_Preset_Configuration[] ** +Type: **SoftLayer_Product_Package_Preset_Configuration[] ** + @@ -161,7 +174,8 @@ A list of preset configurations this category is used in.' [questionReferences]: #questionreferences #### [questionReferences] The question references that are associated with an item category. -Type: **SoftLayer_Product_Item_Category_Question_Xref[] ** +Type: **SoftLayer_Product_Item_Category_Question_Xref[] ** + @@ -171,7 +185,8 @@ The question references that are associated with an item category. [questions]: #questions #### [questions] The questions that are associated with an item category. -Type: **SoftLayer_Product_Item_Category_Question[] ** +Type: **SoftLayer_Product_Item_Category_Question[] ** + @@ -183,7 +198,8 @@ The questions that are associated with an item category. [billingItemCount]: #billingitemcount #### [billingItemCount] A count of the billing items associated with an account that share a category code with an item category's category code. -Type: **unsigned long** +Type: **unsigned long** + @@ -193,7 +209,8 @@ A count of the billing items associated with an account that share a category co [groupCount]: #groupcount #### [groupCount] A count of a collection of service offering category groups. Each group contains a collection of items associated with this category. -Type: **unsigned long** +Type: **unsigned long** + @@ -203,7 +220,8 @@ A count of a collection of service offering category groups. Each group contains [orderOptionCount]: #orderoptioncount #### [orderOptionCount] A count of any unique options associated with an item category. -Type: **unsigned long** +Type: **unsigned long** + @@ -213,7 +231,8 @@ A count of any unique options associated with an item category. [packageConfigurationCount]: #packageconfigurationcount #### [packageConfigurationCount] A count of a list of configuration available in this category.' -Type: **unsigned long** +Type: **unsigned long** + @@ -223,7 +242,8 @@ A count of a list of configuration available in this category.' [presetConfigurationCount]: #presetconfigurationcount #### [presetConfigurationCount] A count of a list of preset configurations this category is used in.' -Type: **unsigned long** +Type: **unsigned long** + @@ -233,7 +253,8 @@ A count of a list of preset configurations this category is used in.' [questionCount]: #questioncount #### [questionCount] A count of the questions that are associated with an item category. -Type: **unsigned long** +Type: **unsigned long** + @@ -243,7 +264,8 @@ A count of the questions that are associated with an item category. [questionReferenceCount]: #questionreferencecount #### [questionReferenceCount] A count of the question references that are associated with an item category. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Category_Group/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Category_Group/_index.md index 477d63e463..3e584982d9 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Category_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Category_Group/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Product_Item_Category_Group data type contains general category group information. @@ -45,7 +47,8 @@ The SoftLayer_Product_Item_Category_Group data type contains general category gr [id]: #id #### [id] identifier for category group. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ identifier for category group. [name]: #name #### [name] The friendly, descriptive name of the category group as seen on the order forms and on invoices. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Category_Order_Option_Type/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Category_Order_Option_Type/_index.md index 9c5a9d949b..dce0196141 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Category_Order_Option_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Category_Order_Option_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Product_Item_Category_Order_Option_Type data type contains options that can be applied to orders for prices. @@ -45,7 +47,8 @@ The SoftLayer_Product_Item_Category_Order_Option_Type data type contains options [description]: #description #### [description] An item category order type's description. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ An item category order type's description. [id]: #id #### [id] An item category order type's unique identifier. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An item category order type's unique identifier. [keyname]: #keyname #### [keyname] A simple description for an item category order type. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A simple description for an item category order type. [name]: #name #### [name] An item category order type's name. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ An item category order type's name. [value]: #value #### [value] The value of the item category type's option. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Category_Question/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Category_Question/_index.md index 17fd996491..6edfcff2d5 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Category_Question/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Category_Question/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Product_Item_Category_Question data type represents a single quest [answerValueExpression]: #answervalueexpression #### [answerValueExpression] The type of answer expected. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The type of answer expected. [description]: #description #### [description] The description for the question. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The description for the question. [fieldTypeId]: #fieldtypeid #### [fieldTypeId] The type of field to use. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The type of field to use. [id]: #id #### [id] identifier for category. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ identifier for category. [keyName]: #keyname #### [keyName] The keyname for the question. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The keyname for the question. [question]: #question #### [question] The question for the category. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The question for the category. [valueExample]: #valueexample #### [valueExample] An example and/or explanation of what the answer for the question is expected to look like. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ An example and/or explanation of what the answer for the question is expected to [fieldType]: #fieldtype #### [fieldType] The type of field that should be used in an HTML form to accept an answer from an end user. -Type: **SoftLayer_Product_Item_Category_Question_Field_Type ** +Type: **SoftLayer_Product_Item_Category_Question_Field_Type ** + @@ -131,7 +141,8 @@ The type of field that should be used in an HTML form to accept an answer from a [itemCategoryReferences]: #itemcategoryreferences #### [itemCategoryReferences] The link between an item category and an item category question. -Type: **SoftLayer_Product_Item_Category_Question_Xref[] ** +Type: **SoftLayer_Product_Item_Category_Question_Xref[] ** + @@ -143,7 +154,8 @@ The link between an item category and an item category question. [itemCategoryReferenceCount]: #itemcategoryreferencecount #### [itemCategoryReferenceCount] A count of the link between an item category and an item category question. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Category_Question_Field_Type/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Category_Question_Field_Type/_index.md index 8147b6836a..4419b23db4 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Category_Question_Field_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Category_Question_Field_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Product_Item_Category_Question_Field_Type data type represents the recommended type of field that should be rendered on an HTML form. @@ -45,7 +47,8 @@ The SoftLayer_Product_Item_Category_Question_Field_Type data type represents the [id]: #id #### [id] Identifier for the question type. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Identifier for the question type. [keyName]: #keyname #### [keyName] Keyname for the question field type. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Keyname for the question field type. [name]: #name #### [name] Short name for the question field type. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Category_Question_Xref/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Category_Question_Xref/_index.md index 6d92f96bc5..cab0894324 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Category_Question_Xref/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Category_Question_Xref/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Product_Item_Category_Question_Xref data type represents a link be [id]: #id #### [id] Identifier for category question xref record. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Identifier for category question xref record. [itemCategoryId]: #itemcategoryid #### [itemCategoryId] Identifier for item category. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Identifier for item category. [locationId]: #locationid #### [locationId] Identifier for the question. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ Identifier for the question. [questionId]: #questionid #### [questionId] Identifier for the question. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Identifier for the question. [required]: #required #### [required] Flag to indicate whether an answer is required for the question.. -Type: **boolean** +Type: **boolean** + @@ -101,7 +108,8 @@ Flag to indicate whether an answer is required for the question.. [itemCategory]: #itemcategory #### [itemCategory] The product item category that this reference points to. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -111,7 +119,8 @@ The product item category that this reference points to. [question]: #question #### [question] The item category question that this reference points to. -Type: **SoftLayer_Product_Item_Category_Question ** +Type: **SoftLayer_Product_Item_Category_Question ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Overage_Price/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Overage_Price/_index.md index 438e040e18..dd865431e1 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Overage_Price/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Overage_Price/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -51,7 +53,8 @@ classes: [defaultOverageItem]: #defaultoverageitem #### [defaultOverageItem] -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** +
              @@ -61,7 +64,8 @@ classes: [item]: #item #### [item] -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** +
              diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Policy_Assignment/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Policy_Assignment/_index.md index 8ca803b094..14a32e53ca 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Policy_Assignment/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Policy_Assignment/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ Represents the assignment of a policy to a product. The existence of a record me [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Represents the assignment of a policy to a product. The existence of a record me [productId]: #productid #### [productId] -Type: **integer** +Type: **integer** + @@ -71,7 +75,8 @@ Represents the assignment of a policy to a product. The existence of a record me [policyName]: #policyname #### [policyName] The name of the assigned policy. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ The name of the assigned policy. [product]: #product #### [product] The [SoftLayer_Product_Item]({{}}) for this policy assignment. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Price/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Price/_index.md index 3353656b5d..fc8578a9f6 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Price/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Price/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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). @@ -53,7 +55,8 @@ The SoftLayer_Product_Item_Price data type contains general information relating [currentPriceFlag]: #currentpriceflag #### [currentPriceFlag] This flag is used by the getUpgradeItemPrices methods available on various resources to indicate if a product price is used for the current billing item. -Type: **boolean** +Type: **boolean** + @@ -63,7 +66,8 @@ This flag is used by the getUpgradeItemPrices methods available on various resou [hourlyRecurringFee]: #hourlyrecurringfee #### [hourlyRecurringFee] The hourly price for this item, should this item be part of an hourly pricing package. -Type: **decimal** +Type: **decimal** + @@ -73,7 +77,8 @@ The hourly price for this item, should this item be part of an hourly pricing pa [id]: #id #### [id] The unique identifier of a Product Item Price. -Type: **integer** +Type: **integer** + @@ -83,7 +88,8 @@ The unique identifier of a Product Item Price. [itemId]: #itemid #### [itemId] The unique identifier for a product Item -Type: **integer** +Type: **integer** + @@ -93,7 +99,8 @@ The unique identifier for a product Item [laborFee]: #laborfee #### [laborFee] The labor fee for a product item price. -Type: **decimal** +Type: **decimal** + @@ -105,7 +112,8 @@ The labor fee for a product item price. The id of the [SoftLayer_Location_Group_Pricing]({{}}) that this price is part of. If set to null, the price is considered a standard price, which can be used with any location when ordering. During order [SoftLayer_Product_Order::verifyOrder]({{}}), if a standard price is used, that price may be replaced with a location based price, which does not have this property set to null. The location based price must be part of a [SoftLayer_Location_Group_Pricing]({{}}) that has the location being ordered in order for this to happen. -Type: **integer** +Type: **integer** + @@ -115,7 +123,8 @@ During order [SoftLayer_Product_Order::verifyOrder]({{Type: **boolean** +Type: **boolean** + @@ -125,7 +134,8 @@ On sale flag. [oneTimeFee]: #onetimefee #### [oneTimeFee] The one time fee for a product item price. -Type: **decimal** +Type: **decimal** + @@ -135,7 +145,8 @@ The one time fee for a product item price. [oneTimeFeeTax]: #onetimefeetax #### [oneTimeFeeTax] A price's total tax amount of the one time fees (oneTimeFee, laborFee, and setupFee). This is only populated after the order is verified via SoftLayer_Product_Order::verifyOrder() -Type: **decimal** +Type: **decimal** + @@ -145,7 +156,8 @@ A price's total tax amount of the one time fees (oneTimeFee, laborFee, and setup [orderOptions]: #orderoptions #### [orderOptions] Order options for the category that this price is associated with. -Type: **SoftLayer_Product_Item_Category_Order_Option_Type[] ** +Type: **SoftLayer_Product_Item_Category_Order_Option_Type[] ** + @@ -155,7 +167,8 @@ Order options for the category that this price is associated with. [proratedRecurringFee]: #proratedrecurringfee #### [proratedRecurringFee] A recurring fee is a fee that happens every billing period. This fee is represented as a floating point decimal in US dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -165,7 +178,8 @@ A recurring fee is a fee that happens every billing period. This fee is represen [proratedRecurringFeeTax]: #proratedrecurringfeetax #### [proratedRecurringFeeTax] A price's tax amount of the recurring fee. This is only populated after the order is verified via SoftLayer_Product_Order::verifyOrder() -Type: **decimal** +Type: **decimal** + @@ -175,7 +189,8 @@ A price's tax amount of the recurring fee. This is only populated after the orde [quantity]: #quantity #### [quantity] -Type: **integer** +Type: **integer** + @@ -185,7 +200,8 @@ A price's tax amount of the recurring fee. This is only populated after the orde [recurringFee]: #recurringfee #### [recurringFee] A recurring fee is a fee that happens every billing period. This fee is represented as a floating point decimal in US dollars ($USD). -Type: **decimal** +Type: **decimal** + @@ -195,7 +211,8 @@ A recurring fee is a fee that happens every billing period. This fee is represen [recurringFeeTax]: #recurringfeetax #### [recurringFeeTax] A price's tax amount of the recurring fee. This is only populated after the order is verified via SoftLayer_Product_Order::verifyOrder() -Type: **decimal** +Type: **decimal** + @@ -205,7 +222,8 @@ A price's tax amount of the recurring fee. This is only populated after the orde [setupFee]: #setupfee #### [setupFee] The setup fee associated with a product item price. -Type: **decimal** +Type: **decimal** + @@ -215,7 +233,8 @@ The setup fee associated with a product item price. [sort]: #sort #### [sort] Used for ordering items on sales orders. -Type: **integer** +Type: **integer** + @@ -225,7 +244,8 @@ Used for ordering items on sales orders. [termLength]: #termlength #### [termLength] The number of months a term lasts for a term-based price -Type: **integer** +Type: **integer** + @@ -235,7 +255,8 @@ The number of months a term lasts for a term-based price [tierMinimumThreshold]: #tierminimumthreshold #### [tierMinimumThreshold] The minimum threshold for which this tiered usage price begins to apply. The unit for the price is defined by the item to which this belongs, see [[SoftLayer_Product_Item::$units]]. -Type: **integer** +Type: **integer** + @@ -245,7 +266,8 @@ The minimum threshold for which this tiered usage price begins to apply. The un [usageRate]: #usagerate #### [usageRate] The rate for a usage based item -Type: **decimal** +Type: **decimal** + @@ -261,7 +283,8 @@ The rate for a usage based item [accountRestrictions]: #accountrestrictions #### [accountRestrictions] The account that the item price is restricted to. -Type: **SoftLayer_Product_Item_Price_Account_Restriction[] ** +Type: **SoftLayer_Product_Item_Price_Account_Restriction[] ** + @@ -271,7 +294,8 @@ The account that the item price is restricted to. [attributes]: #attributes #### [attributes] -Type: **SoftLayer_Product_Item_Price_Attribute[] ** +Type: **SoftLayer_Product_Item_Price_Attribute[] ** + @@ -281,7 +305,8 @@ The account that the item price is restricted to. [bareMetalReservedCapacityFlag]: #baremetalreservedcapacityflag #### [bareMetalReservedCapacityFlag] Signifies pricing that is only available on a bare metal reserved capacity order. -Type: **boolean** +Type: **boolean** + @@ -291,7 +316,8 @@ Signifies pricing that is only available on a bare metal reserved capacity order [bigDataOsJournalDiskFlag]: #bigdataosjournaldiskflag #### [bigDataOsJournalDiskFlag] Whether the price is for Big Data OS/Journal disks only. (Deprecated) -Type: **boolean** +Type: **boolean** + @@ -301,7 +327,8 @@ Whether the price is for Big Data OS/Journal disks only. (Deprecated) [bundleReferences]: #bundlereferences #### [bundleReferences] cross reference for bundles -Type: **SoftLayer_Product_Item_Bundles[] ** +Type: **SoftLayer_Product_Item_Bundles[] ** + @@ -311,7 +338,8 @@ cross reference for bundles [capacityRestrictionMaximum]: #capacityrestrictionmaximum #### [capacityRestrictionMaximum] The maximum capacity value for which this price is suitable. -Type: **string** +Type: **string** + @@ -321,7 +349,8 @@ The maximum capacity value for which this price is suitable. [capacityRestrictionMinimum]: #capacityrestrictionminimum #### [capacityRestrictionMinimum] The minimum capacity value for which this price is suitable. -Type: **string** +Type: **string** + @@ -331,7 +360,8 @@ The minimum capacity value for which this price is suitable. [capacityRestrictionType]: #capacityrestrictiontype #### [capacityRestrictionType] The type of capacity restriction by which this price must abide. -Type: **string** +Type: **string** + @@ -341,7 +371,8 @@ The type of capacity restriction by which this price must abide. [categories]: #categories #### [categories] All categories which this item is a member. -Type: **SoftLayer_Product_Item_Category[] ** +Type: **SoftLayer_Product_Item_Category[] ** + @@ -351,7 +382,8 @@ All categories which this item is a member. [dedicatedHostInstanceFlag]: #dedicatedhostinstanceflag #### [dedicatedHostInstanceFlag] Signifies pricing that is only available on a dedicated host virtual server order. -Type: **boolean** +Type: **boolean** + @@ -361,7 +393,8 @@ Signifies pricing that is only available on a dedicated host virtual server orde [definedSoftwareLicenseFlag]: #definedsoftwarelicenseflag #### [definedSoftwareLicenseFlag] Whether this price defines a software license for its product item. -Type: **boolean** +Type: **boolean** + @@ -371,7 +404,8 @@ Whether this price defines a software license for its product item. [eligibilityStrategy]: #eligibilitystrategy #### [eligibilityStrategy] Eligibility strategy to assess if a customer can order using this price. -Type: **string** +Type: **string** + @@ -381,7 +415,8 @@ Eligibility strategy to assess if a customer can order using this price. [item]: #item #### [item] The product item a price is tied to. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -391,7 +426,8 @@ The product item a price is tied to. [orderPremiums]: #orderpremiums #### [orderPremiums] -Type: **SoftLayer_Product_Item_Price_Premium[] ** +Type: **SoftLayer_Product_Item_Price_Premium[] ** + @@ -401,7 +437,8 @@ The product item a price is tied to. [packageReferences]: #packagereferences #### [packageReferences] cross reference for packages -Type: **SoftLayer_Product_Package_Item_Prices[] ** +Type: **SoftLayer_Product_Package_Item_Prices[] ** + @@ -411,7 +448,8 @@ cross reference for packages [packages]: #packages #### [packages] A price's packages under which this item is sold. -Type: **SoftLayer_Product_Package[] ** +Type: **SoftLayer_Product_Package[] ** + @@ -421,7 +459,8 @@ A price's packages under which this item is sold. [presetConfigurations]: #presetconfigurations #### [presetConfigurations] A list of preset configurations this price is used in.' -Type: **SoftLayer_Product_Package_Preset_Configuration[] ** +Type: **SoftLayer_Product_Package_Preset_Configuration[] ** + @@ -431,7 +470,8 @@ A list of preset configurations this price is used in.' [priceType]: #pricetype #### [priceType] The type keyname of this price which can be STANDARD, TIERED, or TERM. -Type: **string** +Type: **string** + @@ -441,7 +481,8 @@ The type keyname of this price which can be STANDARD, TIERED, or TERM. [pricingLocationGroup]: #pricinglocationgroup #### [pricingLocationGroup] The pricing location group that this price is applicable for. Prices that have a pricing location group will only be available for ordering with the locations specified on the location group. -Type: **SoftLayer_Location_Group_Pricing ** +Type: **SoftLayer_Location_Group_Pricing ** + @@ -451,7 +492,8 @@ The pricing location group that this price is applicable for. Prices that have a [requiredCoreCount]: #requiredcorecount #### [requiredCoreCount] The number of server cores required to order this item. This is deprecated. Use [SoftLayer_Product_Item_Price::getCapacityRestrictionMinimum]({{}}) -Type: **integer** +Type: **integer** + @@ -461,7 +503,8 @@ The number of server cores required to order this item. This is deprecated. Use [reservedCapacityInstanceFlag]: #reservedcapacityinstanceflag #### [reservedCapacityInstanceFlag] Signifies pricing that is only available on a reserved capacity virtual server order. -Type: **boolean** +Type: **boolean** + @@ -473,7 +516,8 @@ Signifies pricing that is only available on a reserved capacity virtual server o [accountRestrictionCount]: #accountrestrictioncount #### [accountRestrictionCount] A count of the account that the item price is restricted to. -Type: **unsigned long** +Type: **unsigned long** + @@ -483,7 +527,8 @@ A count of the account that the item price is restricted to. [attributeCount]: #attributecount #### [attributeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -493,7 +538,8 @@ A count of [bundleReferenceCount]: #bundlereferencecount #### [bundleReferenceCount] A count of cross reference for bundles -Type: **unsigned long** +Type: **unsigned long** + @@ -503,7 +549,8 @@ A count of cross reference for bundles [categoryCount]: #categorycount #### [categoryCount] A count of all categories which this item is a member. -Type: **unsigned long** +Type: **unsigned long** + @@ -513,7 +560,8 @@ A count of all categories which this item is a member. [orderPremiumCount]: #orderpremiumcount #### [orderPremiumCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -523,7 +571,8 @@ A count of [packageCount]: #packagecount #### [packageCount] A count of a price's packages under which this item is sold. -Type: **unsigned long** +Type: **unsigned long** + @@ -533,7 +582,8 @@ A count of a price's packages under which this item is sold. [packageReferenceCount]: #packagereferencecount #### [packageReferenceCount] A count of cross reference for packages -Type: **unsigned long** +Type: **unsigned long** + @@ -543,7 +593,8 @@ A count of cross reference for packages [presetConfigurationCount]: #presetconfigurationcount #### [presetConfigurationCount] A count of a list of preset configurations this price is used in.' -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Price_Account_Restriction/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Price_Account_Restriction/_index.md index 9fbe772135..1332845ea6 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Price_Account_Restriction/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Price_Account_Restriction/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Product_Item_Price data type gives more information about the item [accountId]: #accountid #### [accountId] The account id for the item price account restriction. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The account id for the item price account restriction. [id]: #id #### [id] The unique identifier for the item price account restriction. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The unique identifier for the item price account restriction. [itemPriceId]: #itempriceid #### [itemPriceId] The item price id for the item price account restriction. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ The item price id for the item price account restriction. [account]: #account #### [account] The account the item price is restricted to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -91,7 +97,8 @@ The account the item price is restricted to. [itemPrice]: #itemprice #### [itemPrice] The item price that has the account restriction. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Price_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Price_Attribute/_index.md index ea760bbd6a..05b37abe59 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Price_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Price_Attribute/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [itemPriceAttributeTypeId]: #itempriceattributetypeid #### [itemPriceAttributeTypeId] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [itemPriceId]: #itempriceid #### [itemPriceId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [value]: #value #### [value] -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ classes: [itemPrice]: #itemprice #### [itemPrice] -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -101,7 +108,8 @@ classes: [itemPriceAttributeType]: #itempriceattributetype #### [itemPriceAttributeType] -Type: **SoftLayer_Product_Item_Price_Attribute_Type ** +Type: **SoftLayer_Product_Item_Price_Attribute_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Price_Attribute_Type/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Price_Attribute_Type/_index.md index f903057bb9..b3b303d6da 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Price_Attribute_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Price_Attribute_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [keyname]: #keyname #### [keyname] -Type: **string** +Type: **string** +
              diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Price_Premium/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Price_Premium/_index.md index 919e69a2a7..eb3192606c 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Price_Premium/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Price_Premium/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [hourlyModifier]: #hourlymodifier #### [hourlyModifier] -Type: **decimal** +Type: **decimal** +
              @@ -55,7 +58,8 @@ classes: [itemPriceId]: #itempriceid #### [itemPriceId] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [locationId]: #locationid #### [locationId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [monthlyModifier]: #monthlymodifier #### [monthlyModifier] -Type: **decimal** +Type: **decimal** + @@ -85,7 +91,8 @@ classes: [packageId]: #packageid #### [packageId] -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ classes: [itemPrice]: #itemprice #### [itemPrice] -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -111,7 +119,8 @@ classes: [location]: #location #### [location] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -121,7 +130,8 @@ classes: [package]: #package #### [package] -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Requirement/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Requirement/_index.md index 19190c5d48..72821cc561 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Requirement/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Requirement/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ The SoftLayer_Product_Item_Requirement data type contains information relating t [id]: #id #### [id] Identifier for this record. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ Identifier for this record. [itemId]: #itemid #### [itemId] This is the id of the item affected by the requirement. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ This is the id of the item affected by the requirement. [message]: #message #### [message] This is a custom message to display to the user when this requirement shortfall arises. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ This is a custom message to display to the user when this requirement shortfall [requiredItemId]: #requireditemid #### [requiredItemId] This is the id of the item required. -Type: **integer** +Type: **integer** + @@ -96,7 +102,8 @@ This is the id of the item required. [item]: #item #### [item] Item requirement applies to. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -106,7 +113,8 @@ Item requirement applies to. [product]: #product #### [product] The product containing the requirement. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Resource_Conflict/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Resource_Conflict/_index.md index 8b0581886f..3031b8dbab 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Resource_Conflict/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Resource_Conflict/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [itemId]: #itemid #### [itemId] The unique identifier of the item that contains the conflict. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ The unique identifier of the item that contains the conflict. [message]: #message #### [message] An optional conflict message. -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ An optional conflict message. [packageId]: #packageid #### [packageId] The unique identifier of the service offering that is associated with the conflict. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The unique identifier of the service offering that is associated with the confli [resourceTableId]: #resourcetableid #### [resourceTableId] The unique identifier of the conflicting type. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The unique identifier of the conflicting type. [item]: #item #### [item] -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -101,7 +108,8 @@ The unique identifier of the conflicting type. [package]: #package #### [package] -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Resource_Conflict_Item/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Resource_Conflict_Item/_index.md index 634d1d0f76..26cc371a80 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Resource_Conflict_Item/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Resource_Conflict_Item/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [itemId]: #itemid #### [itemId] The unique identifier of the item that contains the conflict. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ The unique identifier of the item that contains the conflict. [message]: #message #### [message] An optional conflict message. -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ An optional conflict message. [packageId]: #packageid #### [packageId] The unique identifier of the service offering that is associated with the conflict. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The unique identifier of the service offering that is associated with the confli [resourceTableId]: #resourcetableid #### [resourceTableId] The unique identifier of the conflicting type. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The unique identifier of the conflicting type. [item]: #item #### [item] -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -101,7 +108,8 @@ The unique identifier of the conflicting type. [package]: #package #### [package] -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -111,7 +119,8 @@ The unique identifier of the conflicting type. [resource]: #resource #### [resource] A product item that conflicts with another product item. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Resource_Conflict_Item_Category/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Resource_Conflict_Item_Category/_index.md index 7ace19ba17..af27ad2144 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Resource_Conflict_Item_Category/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Resource_Conflict_Item_Category/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [itemId]: #itemid #### [itemId] The unique identifier of the item that contains the conflict. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ The unique identifier of the item that contains the conflict. [message]: #message #### [message] An optional conflict message. -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ An optional conflict message. [packageId]: #packageid #### [packageId] The unique identifier of the service offering that is associated with the conflict. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The unique identifier of the service offering that is associated with the confli [resourceTableId]: #resourcetableid #### [resourceTableId] The unique identifier of the conflicting type. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The unique identifier of the conflicting type. [item]: #item #### [item] -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -101,7 +108,8 @@ The unique identifier of the conflicting type. [package]: #package #### [package] -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -111,7 +119,8 @@ The unique identifier of the conflicting type. [resource]: #resource #### [resource] An item category that conflicts with a product item. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Resource_Conflict_Location/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Resource_Conflict_Location/_index.md index c90b1f8152..ef6247104e 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Resource_Conflict_Location/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Resource_Conflict_Location/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [itemId]: #itemid #### [itemId] The unique identifier of the item that contains the conflict. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ The unique identifier of the item that contains the conflict. [message]: #message #### [message] An optional conflict message. -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ An optional conflict message. [packageId]: #packageid #### [packageId] The unique identifier of the service offering that is associated with the conflict. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The unique identifier of the service offering that is associated with the confli [resourceTableId]: #resourcetableid #### [resourceTableId] The unique identifier of the conflicting type. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The unique identifier of the conflicting type. [item]: #item #### [item] -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -101,7 +108,8 @@ The unique identifier of the conflicting type. [package]: #package #### [package] -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -111,7 +119,8 @@ The unique identifier of the conflicting type. [resource]: #resource #### [resource] A location that conflicts with a product item. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Rule/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Rule/_index.md index 33b2a13e9e..508eafdd0d 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Rule/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Rule/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The item rule data type represents a rule that must be followed when the item as [itemId]: #itemid #### [itemId] The unique identifier of the item that the rule applies to. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The unique identifier of the item that the rule applies to. [message]: #message #### [message] An optional message shown for when the rule is found to be invalid when ordering. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ An optional message shown for when the rule is found to be invalid when ordering [operation]: #operation #### [operation] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ An optional message shown for when the rule is found to be invalid when ordering [packageId]: #packageid #### [packageId] The unique identifier of the service offering that is associated with the rule. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The unique identifier of the service offering that is associated with the rule. [typeId]: #typeid #### [typeId] The unique identifier of the type of resource rule. -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ The unique identifier of the type of resource rule. [item]: #item #### [item] The product item that a rule applies to. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -111,7 +119,8 @@ The product item that a rule applies to. [itemCategoryResources]: #itemcategoryresources #### [itemCategoryResources] -Type: **SoftLayer_Product_Item_Rule_Resource[] ** +Type: **SoftLayer_Product_Item_Rule_Resource[] ** + @@ -121,7 +130,8 @@ The product item that a rule applies to. [itemResources]: #itemresources #### [itemResources] -Type: **SoftLayer_Product_Item_Rule_Resource[] ** +Type: **SoftLayer_Product_Item_Rule_Resource[] ** + @@ -131,7 +141,8 @@ The product item that a rule applies to. [locationResources]: #locationresources #### [locationResources] -Type: **SoftLayer_Product_Item_Rule_Resource[] ** +Type: **SoftLayer_Product_Item_Rule_Resource[] ** + @@ -141,7 +152,8 @@ The product item that a rule applies to. [package]: #package #### [package] The package that a rule is applicable to when ordering. If no package exists, the rule applies to any package. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -151,7 +163,8 @@ The package that a rule is applicable to when ordering. If no package exists, th [permissionResources]: #permissionresources #### [permissionResources] -Type: **SoftLayer_Product_Item_Rule_Resource[] ** +Type: **SoftLayer_Product_Item_Rule_Resource[] ** + @@ -161,7 +174,8 @@ The package that a rule is applicable to when ordering. If no package exists, th [resources]: #resources #### [resources] Resources for this rule that are validated when ordering. -Type: **SoftLayer_Product_Item_Rule_Resource[] ** +Type: **SoftLayer_Product_Item_Rule_Resource[] ** + @@ -171,7 +185,8 @@ Resources for this rule that are validated when ordering. [type]: #type #### [type] The type a rule is. The type affects how the rule is validated when ordering. -Type: **SoftLayer_Product_Item_Rule_Type ** +Type: **SoftLayer_Product_Item_Rule_Type ** + @@ -183,7 +198,8 @@ The type a rule is. The type affects how the rule is validated when ordering. [itemCategoryResourceCount]: #itemcategoryresourcecount #### [itemCategoryResourceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -193,7 +209,8 @@ A count of [itemResourceCount]: #itemresourcecount #### [itemResourceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -203,7 +220,8 @@ A count of [locationResourceCount]: #locationresourcecount #### [locationResourceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -213,7 +231,8 @@ A count of [permissionResourceCount]: #permissionresourcecount #### [permissionResourceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -223,7 +242,8 @@ A count of [resourceCount]: #resourcecount #### [resourceCount] A count of resources for this rule that are validated when ordering. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource/_index.md index 705a330790..5dd4be70d2 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The item rule resource data type represents a resource that is part of an item r [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The item rule resource data type represents a resource that is part of an item r [resourceTableId]: #resourcetableid #### [resourceTableId] The unique identifier of the resource. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The unique identifier of the resource. [ruleId]: #ruleid #### [ruleId] The unique identifier of the rule this resource is included in. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ The unique identifier of the rule this resource is included in. [rule]: #rule #### [rule] -Type: **SoftLayer_Product_Item_Rule ** +Type: **SoftLayer_Product_Item_Rule ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource_Item/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource_Item/_index.md index b5377c34f5..b43165c0ae 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource_Item/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource_Item/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [resourceTableId]: #resourcetableid #### [resourceTableId] The unique identifier of the resource. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ The unique identifier of the resource. [ruleId]: #ruleid #### [ruleId] The unique identifier of the rule this resource is included in. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ The unique identifier of the rule this resource is included in. [resource]: #resource #### [resource] A product item that the associated rule applies to. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -91,7 +97,8 @@ A product item that the associated rule applies to. [rule]: #rule #### [rule] -Type: **SoftLayer_Product_Item_Rule ** +Type: **SoftLayer_Product_Item_Rule ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource_Item_Category/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource_Item_Category/_index.md index addbd69008..d3a7d00f63 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource_Item_Category/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource_Item_Category/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [resourceTableId]: #resourcetableid #### [resourceTableId] The unique identifier of the resource. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ The unique identifier of the resource. [ruleId]: #ruleid #### [ruleId] The unique identifier of the rule this resource is included in. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ The unique identifier of the rule this resource is included in. [resource]: #resource #### [resource] An item category that the associated rule applies to. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -91,7 +97,8 @@ An item category that the associated rule applies to. [rule]: #rule #### [rule] -Type: **SoftLayer_Product_Item_Rule ** +Type: **SoftLayer_Product_Item_Rule ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource_Location/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource_Location/_index.md index 81ec91d08b..6b2d1abcdf 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource_Location/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource_Location/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [resourceTableId]: #resourcetableid #### [resourceTableId] The unique identifier of the resource. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ The unique identifier of the resource. [ruleId]: #ruleid #### [ruleId] The unique identifier of the rule this resource is included in. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ The unique identifier of the rule this resource is included in. [resource]: #resource #### [resource] A location that the associated rule applies to. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -91,7 +97,8 @@ A location that the associated rule applies to. [rule]: #rule #### [rule] -Type: **SoftLayer_Product_Item_Rule ** +Type: **SoftLayer_Product_Item_Rule ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource_Permission/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource_Permission/_index.md index 4737b0cef8..2101cc4492 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource_Permission/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Rule_Resource_Permission/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [resourceTableId]: #resourcetableid #### [resourceTableId] The unique identifier of the resource. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ The unique identifier of the resource. [ruleId]: #ruleid #### [ruleId] The unique identifier of the rule this resource is included in. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ The unique identifier of the rule this resource is included in. [resource]: #resource #### [resource] A user permission that the associated rule applies to. -Type: **SoftLayer_User_Customer_CustomerPermission_Permission ** +Type: **SoftLayer_User_Customer_CustomerPermission_Permission ** + @@ -91,7 +97,8 @@ A user permission that the associated rule applies to. [rule]: #rule #### [rule] -Type: **SoftLayer_Product_Item_Rule ** +Type: **SoftLayer_Product_Item_Rule ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Rule_Type/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Rule_Type/_index.md index 21d3ea54b6..816dcab20d 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Rule_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Rule_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The item rule type data type represents the type of an item rule. @@ -45,7 +47,8 @@ The item rule type data type represents the type of an item rule. [keyName]: #keyname #### [keyName] The identifier for the item rule type. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Server_Group/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Server_Group/_index.md index 787a14a3c0..2fbc5aa7e8 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Server_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Server_Group/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Product_Item_Server_Group data type details the type of compute service a [SoftLayer_Product_Item]({{}}) belongs to. @@ -45,7 +47,8 @@ The SoftLayer_Product_Item_Server_Group data type details the type of compute se [keyName]: #keyname #### [keyName] The server group's string identifier -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The server group's string identifier [name]: #name #### [name] The server group's friendly name -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Product_Item_Tax_Category/_index.md b/content/reference/datatypes/SoftLayer_Product_Item_Tax_Category/_index.md index 104a64117b..d92223fdd9 100644 --- a/content/reference/datatypes/SoftLayer_Product_Item_Tax_Category/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Item_Tax_Category/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Product_Item_Tax_Category data type contains the tax categories that are associated with products. @@ -45,7 +47,8 @@ The SoftLayer_Product_Item_Tax_Category data type contains the tax categories th [id]: #id #### [id] An internal identifier for each tax category. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ An internal identifier for each tax category. [keyName]: #keyname #### [keyName] The key name of the tax category. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The key name of the tax category. [name]: #name #### [name] The name of the tax category. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The name of the tax category. [statusFlag]: #statusflag #### [statusFlag] The status of the tax category. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The status of the tax category. [items]: #items #### [items] -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -103,7 +110,8 @@ The status of the tax category. [itemCount]: #itemcount #### [itemCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Product_Package/_index.md b/content/reference/datatypes/SoftLayer_Product_Package/_index.md index 72f533d39d..02d9f1d52e 100644 --- a/content/reference/datatypes/SoftLayer_Product_Package/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Package/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ The SoftLayer_Product_Package data type contains information about packages from [description]: #description #### [description] A generic description of the processor type and count. This includes HTML, so you may want to strip these tags if you plan to use it. -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ A generic description of the processor type and count. This includes HTML, so yo [firstOrderStepId]: #firstorderstepid #### [firstOrderStepId] This is only needed for step-based order verification. We use this for the order forms, but it is not required. This step is the first SoftLayer_Product_Package_Step for this package. Use this for for filtering which item categories are returned as a part of SoftLayer_Product_Package_Order_Configuration. -Type: **integer** +Type: **integer** + @@ -71,7 +75,8 @@ This is only needed for step-based order verification. We use this for the order [id]: #id #### [id] A package's internal identifier. Everything regarding a SoftLayer_Product_Package is tied back to this id. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ A package's internal identifier. Everything regarding a SoftLayer_Product_Packag [isActive]: #isactive #### [isActive] -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ A package's internal identifier. Everything regarding a SoftLayer_Product_Packag [keyName]: #keyname #### [keyName] A unique key name for the package. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ A unique key name for the package. [name]: #name #### [name] The description of the package. For server packages, this is usually a detailed description of processor type and count. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ The description of the package. For server packages, this is usually a detailed [subDescription]: #subdescription #### [subDescription] This currently contains no information but is here for future use. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ This currently contains no information but is here for future use. [unitSize]: #unitsize #### [unitSize] The server unit size this package will match to. -Type: **integer** +Type: **integer** + @@ -137,7 +147,8 @@ The server unit size this package will match to. [accountRestrictedActivePresets]: #accountrestrictedactivepresets #### [accountRestrictedActivePresets] The preset configurations available only for the authenticated account and this package. -Type: **SoftLayer_Product_Package_Preset[] ** +Type: **SoftLayer_Product_Package_Preset[] ** + @@ -147,7 +158,8 @@ The preset configurations available only for the authenticated account and this [accountRestrictedCategories]: #accountrestrictedcategories #### [accountRestrictedCategories] The results from this call are similar to [SoftLayer_Product_Package::getCategories]({{}}), but these ONLY include account-restricted prices. Not all accounts have restricted pricing. -Type: **SoftLayer_Product_Item_Category[] ** +Type: **SoftLayer_Product_Item_Category[] ** + @@ -157,7 +169,8 @@ The results from this call are similar to [SoftLayer_Product_Package::getCategor [accountRestrictedPricesFlag]: #accountrestrictedpricesflag #### [accountRestrictedPricesFlag] The flag to indicate if there are any restricted prices in a package for the currently-active account. -Type: **boolean** +Type: **boolean** + @@ -167,7 +180,8 @@ The flag to indicate if there are any restricted prices in a package for the cur [activePresets]: #activepresets #### [activePresets] The available preset configurations for this package. -Type: **SoftLayer_Product_Package_Preset[] ** +Type: **SoftLayer_Product_Package_Preset[] ** + @@ -177,7 +191,8 @@ The available preset configurations for this package. [activeRamItems]: #activeramitems #### [activeRamItems] A collection of valid RAM items available for purchase in this package. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -187,7 +202,8 @@ A collection of valid RAM items available for purchase in this package. [activeServerItems]: #activeserveritems #### [activeServerItems] A collection of valid server items available for purchase in this package. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -197,7 +213,8 @@ A collection of valid server items available for purchase in this package. [activeSoftwareItems]: #activesoftwareitems #### [activeSoftwareItems] A collection of valid software items available for purchase in this package. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -207,7 +224,8 @@ A collection of valid software items available for purchase in this package. [activeUsagePrices]: #activeusageprices #### [activeUsagePrices] A collection of [SoftLayer_Product_Item_Price]({{}}) objects for pay-as-you-go usage. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -217,7 +235,8 @@ A collection of [SoftLayer_Product_Item_Price]({{Type: **boolean** +Type: **boolean** + @@ -227,7 +246,8 @@ This flag indicates that the package is an additional service. [attributes]: #attributes #### [attributes] -Type: **SoftLayer_Product_Package_Attribute[] ** +Type: **SoftLayer_Product_Package_Attribute[] ** + @@ -237,7 +257,8 @@ This flag indicates that the package is an additional service. [availableLocations]: #availablelocations #### [availableLocations] A collection of valid locations for this package. (Deprecated - Use [SoftLayer_Product_Package::getRegions]({{}})) -Type: **SoftLayer_Product_Package_Locations[] ** +Type: **SoftLayer_Product_Package_Locations[] ** + @@ -247,7 +268,8 @@ A collection of valid locations for this package. (Deprecated - Use [SoftLayer_P [availableStorageUnits]: #availablestorageunits #### [availableStorageUnits] The maximum number of available disk storage units associated with the servers in a package. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -257,7 +279,8 @@ The maximum number of available disk storage units associated with the servers i [categories]: #categories #### [categories] This is a collection of categories ([SoftLayer_Product_Item_Category]({{}})) associated with a package which can be used for ordering. These categories have several objects prepopulated which are useful when determining the available products for purchase. The categories contain groups ([SoftLayer_Product_Package_Item_Category_Group]({{}})) that organize the products and prices by similar features. For example, operating systems will be grouped by their manufacturer and virtual server disks will be grouped by their disk type (SAN vs. local). Each group will contain prices ([SoftLayer_Product_Item_Price]({{}})) which you can use determine the cost of each product. Each price has a product ([SoftLayer_Product_Item]({{}})) which provides the name and other useful information about the server, service or software you may purchase. -Type: **SoftLayer_Product_Item_Category[] ** +Type: **SoftLayer_Product_Item_Category[] ** + @@ -267,7 +290,8 @@ This is a collection of categories ([SoftLayer_Product_Item_Category]({{Type: **SoftLayer_Product_Package_Order_Configuration[] ** +Type: **SoftLayer_Product_Package_Order_Configuration[] ** + @@ -277,7 +301,8 @@ The item categories associated with a package, including information detailing w [defaultBootCategoryCode]: #defaultbootcategorycode #### [defaultBootCategoryCode] The default boot category code for the package. -Type: **string** +Type: **string** + @@ -287,7 +312,8 @@ The default boot category code for the package. [defaultRamItems]: #defaultramitems #### [defaultRamItems] A collection of valid RAM items available for purchase in this package. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -297,7 +323,8 @@ A collection of valid RAM items available for purchase in this package. [deploymentNodeType]: #deploymentnodetype #### [deploymentNodeType] The node type for a package in a solution deployment. -Type: **string** +Type: **string** + @@ -307,7 +334,8 @@ The node type for a package in a solution deployment. [deploymentPackages]: #deploymentpackages #### [deploymentPackages] The packages that are allowed in a multi-server solution. (Deprecated) -Type: **SoftLayer_Product_Package[] ** +Type: **SoftLayer_Product_Package[] ** + @@ -317,7 +345,8 @@ The packages that are allowed in a multi-server solution. (Deprecated) [deploymentType]: #deploymenttype #### [deploymentType] The solution deployment type. -Type: **string** +Type: **string** + @@ -327,7 +356,8 @@ The solution deployment type. [deployments]: #deployments #### [deployments] The package that represents a multi-server solution. (Deprecated) -Type: **SoftLayer_Product_Package[] ** +Type: **SoftLayer_Product_Package[] ** + @@ -337,7 +367,8 @@ The package that represents a multi-server solution. (Deprecated) [disallowCustomDiskPartitions]: #disallowcustomdiskpartitions #### [disallowCustomDiskPartitions] This flag indicates the package does not allow custom disk partitions. -Type: **boolean** +Type: **boolean** + @@ -347,7 +378,8 @@ This flag indicates the package does not allow custom disk partitions. [firstOrderStep]: #firstorderstep #### [firstOrderStep] The Softlayer order step is optionally step-based. This returns the first SoftLayer_Product_Package_Order_Step in the step-based order process. -Type: **SoftLayer_Product_Package_Order_Step ** +Type: **SoftLayer_Product_Package_Order_Step ** + @@ -357,7 +389,8 @@ The Softlayer order step is optionally step-based. This returns the first SoftLa [gatewayApplianceFlag]: #gatewayapplianceflag #### [gatewayApplianceFlag] Whether the package is a specialized network gateway appliance package. -Type: **boolean** +Type: **boolean** + @@ -367,7 +400,8 @@ Whether the package is a specialized network gateway appliance package. [gpuFlag]: #gpuflag #### [gpuFlag] This flag indicates that the package supports GPUs. -Type: **boolean** +Type: **boolean** + @@ -377,7 +411,8 @@ This flag indicates that the package supports GPUs. [hourlyBillingAvailableFlag]: #hourlybillingavailableflag #### [hourlyBillingAvailableFlag] Determines whether the package contains prices that can be ordered hourly. -Type: **boolean** +Type: **boolean** + @@ -387,7 +422,8 @@ Determines whether the package contains prices that can be ordered hourly. [hourlyOnlyOrders]: #hourlyonlyorders #### [hourlyOnlyOrders] Packages with this flag do not allow monthly orders. -Type: **boolean** +Type: **boolean** + @@ -397,7 +433,8 @@ Packages with this flag do not allow monthly orders. [itemConflicts]: #itemconflicts #### [itemConflicts] The item-item conflicts associated with a package. -Type: **SoftLayer_Product_Item_Resource_Conflict[] ** +Type: **SoftLayer_Product_Item_Resource_Conflict[] ** + @@ -407,7 +444,8 @@ The item-item conflicts associated with a package. [itemLocationConflicts]: #itemlocationconflicts #### [itemLocationConflicts] The item-location conflicts associated with a package. -Type: **SoftLayer_Product_Item_Resource_Conflict[] ** +Type: **SoftLayer_Product_Item_Resource_Conflict[] ** + @@ -417,7 +455,8 @@ The item-location conflicts associated with a package. [itemPriceReferences]: #itempricereferences #### [itemPriceReferences] cross reference for item prices -Type: **SoftLayer_Product_Package_Item_Prices[] ** +Type: **SoftLayer_Product_Package_Item_Prices[] ** + @@ -427,7 +466,8 @@ cross reference for item prices [itemPrices]: #itemprices #### [itemPrices] A collection of SoftLayer_Product_Item_Prices that are valid for this package. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -437,7 +477,8 @@ A collection of SoftLayer_Product_Item_Prices that are valid for this package. [items]: #items #### [items] A collection of valid items available for purchase in this package. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -447,7 +488,8 @@ A collection of valid items available for purchase in this package. [locations]: #locations #### [locations] A collection of valid locations for this package. (Deprecated - Use [SoftLayer_Product_Package::getRegions]({{}})) -Type: **SoftLayer_Location[] ** +Type: **SoftLayer_Location[] ** + @@ -457,7 +499,8 @@ A collection of valid locations for this package. (Deprecated - Use [SoftLayer_P [lowestServerPrice]: #lowestserverprice #### [lowestServerPrice] The lowest server [SoftLayer_Product_Item_Price]({{}}) related to this package. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -467,7 +510,8 @@ The lowest server [SoftLayer_Product_Item_Price]({{Type: **unsigned integer** +Type: **unsigned integer** + @@ -477,7 +521,8 @@ The maximum available network speed associated with the package. [minimumPortSpeed]: #minimumportspeed #### [minimumPortSpeed] The minimum available network speed associated with the package. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -487,7 +532,8 @@ The minimum available network speed associated with the package. [mongoDbEngineeredFlag]: #mongodbengineeredflag #### [mongoDbEngineeredFlag] This flag indicates that this is a MongoDB engineered package. (Deprecated) -Type: **boolean** +Type: **boolean** + @@ -497,7 +543,8 @@ This flag indicates that this is a MongoDB engineered package. (Deprecated) [noUpgradesFlag]: #noupgradesflag #### [noUpgradesFlag] Services ordered from this package cannot have upgrades or downgrades performed. -Type: **boolean** +Type: **boolean** + @@ -507,7 +554,8 @@ Services ordered from this package cannot have upgrades or downgrades performed. [nonEuCompliantFlag]: #noneucompliantflag #### [nonEuCompliantFlag] Whether the package is not in compliance with EU support. -Type: **boolean** +Type: **boolean** + @@ -517,7 +565,8 @@ Whether the package is not in compliance with EU support. [orderPremiums]: #orderpremiums #### [orderPremiums] The premium price modifiers associated with the [SoftLayer_Product_Item_Price]({{}}) and [SoftLayer_Location]({{}}) objects in a package. -Type: **SoftLayer_Product_Item_Price_Premium[] ** +Type: **SoftLayer_Product_Item_Price_Premium[] ** + @@ -527,7 +576,8 @@ The premium price modifiers associated with the [SoftLayer_Product_Item_Price]({ [popLocationAvailabilityFlag]: #poplocationavailabilityflag #### [popLocationAvailabilityFlag] This flag indicates if the package may be available in PoP locations in addition to Datacenters. -Type: **boolean** +Type: **boolean** + @@ -537,7 +587,8 @@ This flag indicates if the package may be available in PoP locations in addition [preconfiguredFlag]: #preconfiguredflag #### [preconfiguredFlag] This flag indicates the package is pre-configured. (Deprecated) -Type: **boolean** +Type: **boolean** + @@ -547,7 +598,8 @@ This flag indicates the package is pre-configured. (Deprecated) [presetConfigurationRequiredFlag]: #presetconfigurationrequiredflag #### [presetConfigurationRequiredFlag] Whether the package requires the user to define a preset configuration. -Type: **boolean** +Type: **boolean** + @@ -557,7 +609,8 @@ Whether the package requires the user to define a preset configuration. [preventVlanSelectionFlag]: #preventvlanselectionflag #### [preventVlanSelectionFlag] Whether the package prevents the user from specifying a Vlan. -Type: **boolean** +Type: **boolean** + @@ -567,7 +620,8 @@ Whether the package prevents the user from specifying a Vlan. [privateHostedCloudPackageFlag]: #privatehostedcloudpackageflag #### [privateHostedCloudPackageFlag] This flag indicates the package is for a private hosted cloud deployment. (Deprecated) -Type: **boolean** +Type: **boolean** + @@ -577,7 +631,8 @@ This flag indicates the package is for a private hosted cloud deployment. (Depre [privateHostedCloudPackageType]: #privatehostedcloudpackagetype #### [privateHostedCloudPackageType] The server role of the private hosted cloud deployment. (Deprecated) -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ The server role of the private hosted cloud deployment. (Deprecated) [privateNetworkOnlyFlag]: #privatenetworkonlyflag #### [privateNetworkOnlyFlag] Whether the package only has access to the private network. -Type: **boolean** +Type: **boolean** + @@ -597,7 +653,8 @@ Whether the package only has access to the private network. [quantaStorPackageFlag]: #quantastorpackageflag #### [quantaStorPackageFlag] Whether the package is a specialized mass storage QuantaStor package. (Deprecated) -Type: **boolean** +Type: **boolean** + @@ -607,7 +664,8 @@ Whether the package is a specialized mass storage QuantaStor package. (Deprecate [raidDiskRestrictionFlag]: #raiddiskrestrictionflag #### [raidDiskRestrictionFlag] This flag indicates the package does not allow different disks with RAID. -Type: **boolean** +Type: **boolean** + @@ -617,7 +675,8 @@ This flag indicates the package does not allow different disks with RAID. [redundantPowerFlag]: #redundantpowerflag #### [redundantPowerFlag] This flag determines if the package contains a redundant power supply product. -Type: **boolean** +Type: **boolean** + @@ -627,7 +686,8 @@ This flag determines if the package contains a redundant power supply product. [regions]: #regions #### [regions] The regional locations that a package is available in. -Type: **SoftLayer_Location_Region[] ** +Type: **SoftLayer_Location_Region[] ** + @@ -637,7 +697,8 @@ The regional locations that a package is available in. [resourceGroupTemplate]: #resourcegrouptemplate #### [resourceGroupTemplate] The resource group template that describes a multi-server solution. (Deprecated) -Type: **SoftLayer_Resource_Group_Template ** +Type: **SoftLayer_Resource_Group_Template ** + @@ -647,7 +708,8 @@ The resource group template that describes a multi-server solution. (Deprecated) [topLevelItemCategoryCode]: #toplevelitemcategorycode #### [topLevelItemCategoryCode] The top level category code for this service offering. -Type: **string** +Type: **string** + @@ -657,7 +719,8 @@ The top level category code for this service offering. [type]: #type #### [type] The type of service offering. This property can be used to help filter packages. -Type: **SoftLayer_Product_Package_Type ** +Type: **SoftLayer_Product_Package_Type ** + @@ -669,7 +732,8 @@ The type of service offering. This property can be used to help filter packages. [accountRestrictedActivePresetCount]: #accountrestrictedactivepresetcount #### [accountRestrictedActivePresetCount] A count of the preset configurations available only for the authenticated account and this package. -Type: **unsigned long** +Type: **unsigned long** + @@ -679,7 +743,8 @@ A count of the preset configurations available only for the authenticated accoun [accountRestrictedCategoryCount]: #accountrestrictedcategorycount #### [accountRestrictedCategoryCount] A count of the results from this call are similar to [SoftLayer_Product_Package::getCategories]({{}}), but these ONLY include account-restricted prices. Not all accounts have restricted pricing. -Type: **unsigned long** +Type: **unsigned long** + @@ -689,7 +754,8 @@ A count of the results from this call are similar to [SoftLayer_Product_Package: [activePresetCount]: #activepresetcount #### [activePresetCount] A count of the available preset configurations for this package. -Type: **unsigned long** +Type: **unsigned long** + @@ -699,7 +765,8 @@ A count of the available preset configurations for this package. [activeRamItemCount]: #activeramitemcount #### [activeRamItemCount] A count of a collection of valid RAM items available for purchase in this package. -Type: **unsigned long** +Type: **unsigned long** + @@ -709,7 +776,8 @@ A count of a collection of valid RAM items available for purchase in this packag [activeServerItemCount]: #activeserveritemcount #### [activeServerItemCount] A count of a collection of valid server items available for purchase in this package. -Type: **unsigned long** +Type: **unsigned long** + @@ -719,7 +787,8 @@ A count of a collection of valid server items available for purchase in this pac [activeSoftwareItemCount]: #activesoftwareitemcount #### [activeSoftwareItemCount] A count of a collection of valid software items available for purchase in this package. -Type: **unsigned long** +Type: **unsigned long** + @@ -729,7 +798,8 @@ A count of a collection of valid software items available for purchase in this p [activeUsagePriceCount]: #activeusagepricecount #### [activeUsagePriceCount] A count of a collection of [SoftLayer_Product_Item_Price]({{}}) objects for pay-as-you-go usage. -Type: **unsigned long** +Type: **unsigned long** + @@ -739,7 +809,8 @@ A count of a collection of [SoftLayer_Product_Item_Price]({{Type: **unsigned long** +Type: **unsigned long** + @@ -749,7 +820,8 @@ A count of [availableLocationCount]: #availablelocationcount #### [availableLocationCount] A count of a collection of valid locations for this package. (Deprecated - Use [SoftLayer_Product_Package::getRegions]({{}})) -Type: **unsigned long** +Type: **unsigned long** + @@ -759,7 +831,8 @@ A count of a collection of valid locations for this package. (Deprecated - Use [ [configurationCount]: #configurationcount #### [configurationCount] A count of the item categories associated with a package, including information detailing which item categories are required as part of a SoftLayer product order. -Type: **unsigned long** +Type: **unsigned long** + @@ -769,7 +842,8 @@ A count of the item categories associated with a package, including information [defaultRamItemCount]: #defaultramitemcount #### [defaultRamItemCount] A count of a collection of valid RAM items available for purchase in this package. -Type: **unsigned long** +Type: **unsigned long** + @@ -779,7 +853,8 @@ A count of a collection of valid RAM items available for purchase in this packag [deploymentCount]: #deploymentcount #### [deploymentCount] A count of the package that represents a multi-server solution. (Deprecated) -Type: **unsigned long** +Type: **unsigned long** + @@ -789,7 +864,8 @@ A count of the package that represents a multi-server solution. (Deprecated) [deploymentPackageCount]: #deploymentpackagecount #### [deploymentPackageCount] A count of the packages that are allowed in a multi-server solution. (Deprecated) -Type: **unsigned long** +Type: **unsigned long** + @@ -799,7 +875,8 @@ A count of the packages that are allowed in a multi-server solution. (Deprecated [itemCount]: #itemcount #### [itemCount] A count of a collection of valid items available for purchase in this package. -Type: **unsigned long** +Type: **unsigned long** + @@ -809,7 +886,8 @@ A count of a collection of valid items available for purchase in this package. [itemPriceCount]: #itempricecount #### [itemPriceCount] A count of a collection of SoftLayer_Product_Item_Prices that are valid for this package. -Type: **unsigned long** +Type: **unsigned long** + @@ -819,7 +897,8 @@ A count of a collection of SoftLayer_Product_Item_Prices that are valid for this [itemPriceReferenceCount]: #itempricereferencecount #### [itemPriceReferenceCount] A count of cross reference for item prices -Type: **unsigned long** +Type: **unsigned long** + @@ -829,7 +908,8 @@ A count of cross reference for item prices [locationCount]: #locationcount #### [locationCount] A count of a collection of valid locations for this package. (Deprecated - Use [SoftLayer_Product_Package::getRegions]({{}})) -Type: **unsigned long** +Type: **unsigned long** + @@ -839,7 +919,8 @@ A count of a collection of valid locations for this package. (Deprecated - Use [ [orderPremiumCount]: #orderpremiumcount #### [orderPremiumCount] A count of the premium price modifiers associated with the [SoftLayer_Product_Item_Price]({{}}) and [SoftLayer_Location]({{}}) objects in a package. -Type: **unsigned long** +Type: **unsigned long** + @@ -849,7 +930,8 @@ A count of the premium price modifiers associated with the [SoftLayer_Product_It [regionCount]: #regioncount #### [regionCount] A count of the regional locations that a package is available in. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Product_Package_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Product_Package_Attribute/_index.md index b18507fe92..755c403415 100644 --- a/content/reference/datatypes/SoftLayer_Product_Package_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Package_Attribute/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [value]: #value #### [value] -Type: **string** +Type: **string** +
              @@ -61,7 +64,8 @@ classes: [attributeType]: #attributetype #### [attributeType] -Type: **SoftLayer_Product_Package_Attribute_Type ** +Type: **SoftLayer_Product_Package_Attribute_Type ** +
              @@ -71,7 +75,8 @@ classes: [package]: #package #### [package] -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Package_Attribute_Type/_index.md b/content/reference/datatypes/SoftLayer_Product_Package_Attribute_Type/_index.md index 3d7da91792..8bab1f7c74 100644 --- a/content/reference/datatypes/SoftLayer_Product_Package_Attribute_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Package_Attribute_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Product_Package_Inventory/_index.md b/content/reference/datatypes/SoftLayer_Product_Package_Inventory/_index.md index 87b125196c..acb68ad082 100644 --- a/content/reference/datatypes/SoftLayer_Product_Package_Inventory/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Package_Inventory/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This is deprecated. @@ -45,7 +47,8 @@ This is deprecated. [availableInventoryCount]: #availableinventorycount #### [availableInventoryCount] DEPRECATED. The number of units available for purchase in inventory for a single item in a single datacenter. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ DEPRECATED. The number of units available for purchase in inventory for a single [itemId]: #itemid #### [itemId] DEPRECATED. The unique identifier of the product item that an inventory record is associated with. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ DEPRECATED. The unique identifier of the product item that an inventory record i [locationId]: #locationid #### [locationId] DEPRECATED. The unique identifier of the datacenter that an inventory record is located in. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ DEPRECATED. The unique identifier of the datacenter that an inventory record is [modifyDate]: #modifydate #### [modifyDate] DEPRECATED. The date that an inventory record was last updated. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ DEPRECATED. The date that an inventory record was last updated. [overstockFlag]: #overstockflag #### [overstockFlag] DEPRECATED. Whether an inventory record is marked as "overstock". -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ DEPRECATED. Whether an inventory record is marked as "overstock". [packageId]: #packageid #### [packageId] DEPRECATED. The unique identifier of the product package that an inventory record is associated with. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ DEPRECATED. The unique identifier of the product package that an inventory recor [item]: #item #### [item] The product package item that is associated with an inventory record. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -121,7 +130,8 @@ The product package item that is associated with an inventory record. [location]: #location #### [location] The datacenter that an inventory record is located in. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -131,7 +141,8 @@ The datacenter that an inventory record is located in. [package]: #package #### [package] The product package that is associated with an inventory record. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Package_Item_Category_Group/_index.md b/content/reference/datatypes/SoftLayer_Product_Package_Item_Category_Group/_index.md index 9d0920ae17..1c2f2ed60f 100644 --- a/content/reference/datatypes/SoftLayer_Product_Package_Item_Category_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Package_Item_Category_Group/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ This class is used to organize categories for a service offering. A service offe [itemCategoryId]: #itemcategoryid #### [itemCategoryId] The item category id associated with this group. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The item category id associated with this group. [packageId]: #packageid #### [packageId] The service offering id associated with this group. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The service offering id associated with this group. [sort]: #sort #### [sort] The sort value for this group. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The sort value for this group. [title]: #title #### [title] An optional title associated with this group. E.g., for operating systems, this will be the manufacturer. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ An optional title associated with this group. E.g., for operating systems, this [category]: #category #### [category] -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -101,7 +108,8 @@ An optional title associated with this group. E.g., for operating systems, this [package]: #package #### [package] -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -111,7 +119,8 @@ An optional title associated with this group. E.g., for operating systems, this [prices]: #prices #### [prices] -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -123,7 +132,8 @@ An optional title associated with this group. E.g., for operating systems, this [priceCount]: #pricecount #### [priceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Product_Package_Item_Prices/_index.md b/content/reference/datatypes/SoftLayer_Product_Package_Item_Prices/_index.md index c4f300a2bc..9d64cee14d 100644 --- a/content/reference/datatypes/SoftLayer_Product_Package_Item_Prices/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Package_Item_Prices/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -56,7 +58,8 @@ The SoftLayer_Product_Package_Item_Prices contains price to package cross refere [id]: #id #### [id] The unique identifier for SoftLayer_Product_Package_Item_Price. This is only needed as a reference. The important data is the itemPriceId property. -Type: **integer** +Type: **integer** + @@ -66,7 +69,8 @@ The unique identifier for SoftLayer_Product_Package_Item_Price. This is only nee [itemPriceId]: #itempriceid #### [itemPriceId] The SoftLayer_Product_Item_Price id. This value is to be used when placing orders. To get more information about this item price, go from the item price to the item description -Type: **integer** +Type: **integer** + @@ -76,7 +80,8 @@ The SoftLayer_Product_Item_Price id. This value is to be used when placing order [packageId]: #packageid #### [packageId] The Package ID to which this price reference belongs -Type: **integer** +Type: **integer** + @@ -92,7 +97,8 @@ The Package ID to which this price reference belongs [itemPrice]: #itemprice #### [itemPrice] The item price to which this object belongs. The item price has details regarding cost for the item it belongs to. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -102,7 +108,8 @@ The item price to which this object belongs. The item price has details regardin [package]: #package #### [package] The package to which this object belongs. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Package_Items/_index.md b/content/reference/datatypes/SoftLayer_Product_Package_Items/_index.md index 271c2c6134..35d3a5ed0e 100644 --- a/content/reference/datatypes/SoftLayer_Product_Package_Items/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Package_Items/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ This data type is a cross-reference between the SoftLayer_Product_Package and th [id]: #id #### [id] The unique identifier for this object. It is not used anywhere but in this object. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The unique identifier for this object. It is not used anywhere but in this objec [itemId]: #itemid #### [itemId] The SoftLayer_Product_Item id to which this instance of the object belongs. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The SoftLayer_Product_Item id to which this instance of the object belongs. [packageId]: #packageid #### [packageId] The SoftLayer_Product_Package id to which this instance of the object belongs. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ The SoftLayer_Product_Package id to which this instance of the object belongs. [item]: #item #### [item] The item to which this object belongs. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -91,7 +97,8 @@ The item to which this object belongs. [package]: #package #### [package] The package to which this object belongs. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Package_Locations/_index.md b/content/reference/datatypes/SoftLayer_Product_Package_Locations/_index.md index d934490013..d9b2286522 100644 --- a/content/reference/datatypes/SoftLayer_Product_Package_Locations/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Package_Locations/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Most packages are available in many locations. This object describes that availability for each package. @@ -45,7 +47,8 @@ Most packages are available in many locations. This object describes that availa [deliveryTimeInformation]: #deliverytimeinformation #### [deliveryTimeInformation] This describes the availability of the package tied to this location. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ This describes the availability of the package tied to this location. [isAvailable]: #isavailable #### [isAvailable] A simple flag which describes whether or not this location is available for this package. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A simple flag which describes whether or not this location is available for this [locationId]: #locationid #### [locationId] The location id tied to this object. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The location id tied to this object. [packageId]: #packageid #### [packageId] The SoftLayer_Product_Package ID tied to this object. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The SoftLayer_Product_Package ID tied to this object. [location]: #location #### [location] The location to which this object belongs. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -101,7 +108,8 @@ The location to which this object belongs. [package]: #package #### [package] The package to which this object belongs. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Package_Order_Configuration/_index.md b/content/reference/datatypes/SoftLayer_Product_Package_Order_Configuration/_index.md index 4a288c8fb8..426e4871e4 100644 --- a/content/reference/datatypes/SoftLayer_Product_Package_Order_Configuration/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Package_Order_Configuration/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -55,7 +57,8 @@ There are others, but these are the main ones. For each required category, a Sof [bundledFlag]: #bundledflag #### [bundledFlag] Signifies that selections associated with the configuration are automatically provided by being bundled to another configurations selection. The actual bundling is on the product. -Type: **boolean** +Type: **boolean** + @@ -65,7 +68,8 @@ Signifies that selections associated with the configuration are automatically pr [errorMessage]: #errormessage #### [errorMessage] The error message displayed if the submitted order does not contain this item category, if it is required. -Type: **string** +Type: **string** + @@ -75,7 +79,8 @@ The error message displayed if the submitted order does not contain this item ca [id]: #id #### [id] The unique identifier for this object. -Type: **integer** +Type: **integer** + @@ -85,7 +90,8 @@ The unique identifier for this object. [isRequired]: #isrequired #### [isRequired] This is a flag which tells SoftLayer_Product_Order::verifyOrder() whether or not this category is required. If this is set, then the order submitted must contain a SoftLayer_Product_Item_Price with this category as part of the order. -Type: **integer** +Type: **integer** + @@ -95,7 +101,8 @@ This is a flag which tells SoftLayer_Product_Order::verifyOrder() whether or not [itemCategoryId]: #itemcategoryid #### [itemCategoryId] The SoftLayer_Product_Item_Category. -Type: **integer** +Type: **integer** + @@ -105,7 +112,8 @@ The SoftLayer_Product_Item_Category. [orderStepId]: #orderstepid #### [orderStepId] The order step ID for this particular option in the package. -Type: **integer** +Type: **integer** + @@ -115,7 +123,8 @@ The order step ID for this particular option in the package. [packageId]: #packageid #### [packageId] The PackageId tied to this instance. -Type: **integer** +Type: **integer** + @@ -125,7 +134,8 @@ The PackageId tied to this instance. [sort]: #sort #### [sort] This is an integer used to show the order in which each item Category should be displayed. This is merely the suggested order. -Type: **integer** +Type: **integer** + @@ -135,7 +145,8 @@ This is an integer used to show the order in which each item Category should be [termFlag]: #termflag #### [termFlag] Whether or not the item category is term-based. -Type: **boolean** +Type: **boolean** + @@ -151,7 +162,8 @@ Whether or not the item category is term-based. [itemCategory]: #itemcategory #### [itemCategory] The item category for this configuration instance. -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** + @@ -161,7 +173,8 @@ The item category for this configuration instance. [package]: #package #### [package] The package to which this instance belongs. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -171,7 +184,8 @@ The package to which this instance belongs. [step]: #step #### [step] The step to which this instance belongs. -Type: **SoftLayer_Product_Package_Order_Step ** +Type: **SoftLayer_Product_Package_Order_Step ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Package_Order_Step/_index.md b/content/reference/datatypes/SoftLayer_Product_Package_Order_Step/_index.md index 9ca6cebe5c..e8173e809e 100644 --- a/content/reference/datatypes/SoftLayer_Product_Package_Order_Step/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Package_Order_Step/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ Each package has at least 1 step to the ordering process. For server orders, the [id]: #id #### [id] The unique identifier for this object. It is not used anywhere but in this object. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The unique identifier for this object. It is not used anywhere but in this objec [step]: #step #### [step] The number of the step in the order process for this package. These are sequential and only needed for step-based ordering. -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ The number of the step in the order process for this package. These are sequenti [inclusivePreviousSteps]: #inclusiveprevioussteps #### [inclusivePreviousSteps] The next steps in the ordering process for the package tied to this object, including this step. -Type: **SoftLayer_Product_Package_Order_Step_Next[] ** +Type: **SoftLayer_Product_Package_Order_Step_Next[] ** + @@ -81,7 +86,8 @@ The next steps in the ordering process for the package tied to this object, incl [nextSteps]: #nextsteps #### [nextSteps] The next steps in the ordering process for the package tied to this object. -Type: **SoftLayer_Product_Package_Order_Step_Next[] ** +Type: **SoftLayer_Product_Package_Order_Step_Next[] ** + @@ -91,7 +97,8 @@ The next steps in the ordering process for the package tied to this object. [previousSteps]: #previoussteps #### [previousSteps] The item to which this object belongs. -Type: **SoftLayer_Product_Package_Order_Step_Next[] ** +Type: **SoftLayer_Product_Package_Order_Step_Next[] ** + @@ -103,7 +110,8 @@ The item to which this object belongs. [inclusivePreviousStepCount]: #inclusivepreviousstepcount #### [inclusivePreviousStepCount] A count of the next steps in the ordering process for the package tied to this object, including this step. -Type: **unsigned long** +Type: **unsigned long** + @@ -113,7 +121,8 @@ A count of the next steps in the ordering process for the package tied to this o [nextStepCount]: #nextstepcount #### [nextStepCount] A count of the next steps in the ordering process for the package tied to this object. -Type: **unsigned long** +Type: **unsigned long** + @@ -123,7 +132,8 @@ A count of the next steps in the ordering process for the package tied to this o [previousStepCount]: #previousstepcount #### [previousStepCount] A count of the item to which this object belongs. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Product_Package_Order_Step_Next/_index.md b/content/reference/datatypes/SoftLayer_Product_Package_Order_Step_Next/_index.md index 29e8bd4bae..2919de39e2 100644 --- a/content/reference/datatypes/SoftLayer_Product_Package_Order_Step_Next/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Package_Order_Step_Next/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This datatype simply describes which steps are next in line for ordering. @@ -45,7 +47,8 @@ This datatype simply describes which steps are next in line for ordering. [id]: #id #### [id] The unique identifier for this object. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The unique identifier for this object. [nextOrderStepId]: #nextorderstepid #### [nextOrderStepId] The unique identifier for SoftLayer_Product_Package_Order_Step for the next step in the process. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The unique identifier for SoftLayer_Product_Package_Order_Step for the next step [orderStepId]: #orderstepid #### [orderStepId] The unique identifier for SoftLayer_Product_Package_Order_Step for the current step. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ The unique identifier for SoftLayer_Product_Package_Order_Step for the current s [step]: #step #### [step] The SoftLayer_Product_Package_Order_Step to which this object belongs. -Type: **SoftLayer_Product_Package_Order_Step ** +Type: **SoftLayer_Product_Package_Order_Step ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Package_Preset/_index.md b/content/reference/datatypes/SoftLayer_Product_Package_Preset/_index.md index 016afc9fd4..80ad36837b 100644 --- a/content/reference/datatypes/SoftLayer_Product_Package_Preset/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Package_Preset/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + 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 (fixedConfigurationFlag) 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. @@ -49,7 +51,8 @@ Orders submitted with a preset id defined will use the prices included in the pa [description]: #description #### [description] A description of the package preset. -Type: **string** +Type: **string** + @@ -59,7 +62,8 @@ A description of the package preset. [id]: #id #### [id] A preset's internal identifier. Everything regarding a SoftLayer_Product_Package_Preset is tied back to this id. -Type: **integer** +Type: **integer** + @@ -69,7 +73,8 @@ A preset's internal identifier. Everything regarding a SoftLayer_Product_Package [isActive]: #isactive #### [isActive] The status of the package preset. -Type: **string** +Type: **string** + @@ -79,7 +84,8 @@ The status of the package preset. [keyName]: #keyname #### [keyName] The key name of the package preset. For the base configuration of a package the preset key name is "DEFAULT". -Type: **string** +Type: **string** + @@ -89,7 +95,8 @@ The key name of the package preset. For the base configuration of a package the [name]: #name #### [name] The name of the package preset. -Type: **string** +Type: **string** + @@ -99,7 +106,8 @@ The name of the package preset. [packageId]: #packageid #### [packageId] The package id for the package this preset belongs to. -Type: **integer** +Type: **integer** + @@ -115,7 +123,8 @@ The package id for the package this preset belongs to. [availableStorageUnits]: #availablestorageunits #### [availableStorageUnits] -Type: **unsigned integer** +Type: **unsigned integer** + @@ -125,7 +134,8 @@ The package id for the package this preset belongs to. [bareMetalReservedFlag]: #baremetalreservedflag #### [bareMetalReservedFlag] When true this preset is for ordering a Bare Metal Reserved server. -Type: **boolean** +Type: **boolean** + @@ -135,7 +145,8 @@ When true this preset is for ordering a Bare Metal Reserved server. [categories]: #categories #### [categories] The item categories that are included in this package preset configuration. -Type: **SoftLayer_Product_Item_Category[] ** +Type: **SoftLayer_Product_Item_Category[] ** + @@ -145,7 +156,8 @@ The item categories that are included in this package preset configuration. [computeGroup]: #computegroup #### [computeGroup] The compute family this configuration belongs to. -Type: **SoftLayer_Product_Item_Server_Group ** +Type: **SoftLayer_Product_Item_Server_Group ** + @@ -155,7 +167,8 @@ The compute family this configuration belongs to. [configuration]: #configuration #### [configuration] The preset configuration (category and price). -Type: **SoftLayer_Product_Package_Preset_Configuration[] ** +Type: **SoftLayer_Product_Package_Preset_Configuration[] ** + @@ -165,7 +178,8 @@ The preset configuration (category and price). [disallowedComputeGroupUpgradeFlag]: #disallowedcomputegroupupgradeflag #### [disallowedComputeGroupUpgradeFlag] When true this preset is only allowed to upgrade/downgrade to other presets in the same compute family. -Type: **boolean** +Type: **boolean** + @@ -175,7 +189,8 @@ When true this preset is only allowed to upgrade/downgrade to other presets in t [fixedConfigurationFlag]: #fixedconfigurationflag #### [fixedConfigurationFlag] A package preset with this flag set will not allow the price's defined in the preset configuration to be overriden during order placement. -Type: **boolean** +Type: **boolean** + @@ -185,7 +200,8 @@ A package preset with this flag set will not allow the price's defined in the pr [locations]: #locations #### [locations] The locations this preset configuration is available in. If empty the preset is available in all locations the package is available in. -Type: **SoftLayer_Location[] ** +Type: **SoftLayer_Location[] ** + @@ -195,7 +211,8 @@ The locations this preset configuration is available in. If empty the preset is [lowestPresetServerPrice]: #lowestpresetserverprice #### [lowestPresetServerPrice] The lowest server prices related to this package preset. -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -205,7 +222,8 @@ The lowest server prices related to this package preset. [package]: #package #### [package] The package this preset belongs to. -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -215,7 +233,8 @@ The package this preset belongs to. [packageConfiguration]: #packageconfiguration #### [packageConfiguration] The item categories associated with a package preset, including information detailing which item categories are required as part of a SoftLayer product order. -Type: **SoftLayer_Product_Package_Order_Configuration[] ** +Type: **SoftLayer_Product_Package_Order_Configuration[] ** + @@ -225,7 +244,8 @@ The item categories associated with a package preset, including information deta [prices]: #prices #### [prices] The item prices that are included in this package preset configuration. -Type: **SoftLayer_Product_Item_Price[] ** +Type: **SoftLayer_Product_Item_Price[] ** + @@ -235,7 +255,8 @@ The item prices that are included in this package preset configuration. [storageGroupTemplateArrays]: #storagegrouptemplatearrays #### [storageGroupTemplateArrays] Describes how all disks in this preset will be configured. -Type: **SoftLayer_Configuration_Storage_Group_Template_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group_Template_Group[] ** + @@ -245,7 +266,8 @@ Describes how all disks in this preset will be configured. [totalMinimumHourlyFee]: #totalminimumhourlyfee #### [totalMinimumHourlyFee] The starting hourly price for this configuration. Additional options not defined in the preset may increase the cost. -Type: **decimal** +Type: **decimal** + @@ -255,7 +277,8 @@ The starting hourly price for this configuration. Additional options not defined [totalMinimumRecurringFee]: #totalminimumrecurringfee #### [totalMinimumRecurringFee] The starting monthly price for this configuration. Additional options not defined in the preset may increase the cost. -Type: **decimal** +Type: **decimal** + @@ -267,7 +290,8 @@ The starting monthly price for this configuration. Additional options not define [categoryCount]: #categorycount #### [categoryCount] A count of the item categories that are included in this package preset configuration. -Type: **unsigned long** +Type: **unsigned long** + @@ -277,7 +301,8 @@ A count of the item categories that are included in this package preset configur [configurationCount]: #configurationcount #### [configurationCount] A count of the preset configuration (category and price). -Type: **unsigned long** +Type: **unsigned long** + @@ -287,7 +312,8 @@ A count of the preset configuration (category and price). [locationCount]: #locationcount #### [locationCount] A count of the locations this preset configuration is available in. If empty the preset is available in all locations the package is available in. -Type: **unsigned long** +Type: **unsigned long** + @@ -297,7 +323,8 @@ A count of the locations this preset configuration is available in. If empty the [packageConfigurationCount]: #packageconfigurationcount #### [packageConfigurationCount] A count of the item categories associated with a package preset, including information detailing which item categories are required as part of a SoftLayer product order. -Type: **unsigned long** +Type: **unsigned long** + @@ -307,7 +334,8 @@ A count of the item categories associated with a package preset, including infor [priceCount]: #pricecount #### [priceCount] A count of the item prices that are included in this package preset configuration. -Type: **unsigned long** +Type: **unsigned long** + @@ -317,7 +345,8 @@ A count of the item prices that are included in this package preset configuratio [storageGroupTemplateArrayCount]: #storagegrouptemplatearraycount #### [storageGroupTemplateArrayCount] A count of describes how all disks in this preset will be configured. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Product_Package_Preset_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Product_Package_Preset_Attribute/_index.md index 6a8eea15a4..21d0d41b8a 100644 --- a/content/reference/datatypes/SoftLayer_Product_Package_Preset_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Package_Preset_Attribute/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Package preset attributes contain supplementary information for a package preset. @@ -53,7 +55,8 @@ Package preset attributes contain supplementary information for a package preset [attributeTypeId]: #attributetypeid #### [attributeTypeId] The internal identifier of the type of attribute that a pacakge preset attribute belongs to. -Type: **integer** +Type: **integer** + @@ -63,7 +66,8 @@ The internal identifier of the type of attribute that a pacakge preset attribute [id]: #id #### [id] A package preset attribute's internal identifier. -Type: **integer** +Type: **integer** + @@ -73,7 +77,8 @@ A package preset attribute's internal identifier. [presetId]: #presetid #### [presetId] The internal identifier of the package preset an attribute belongs to. -Type: **integer** +Type: **integer** + @@ -83,7 +88,8 @@ The internal identifier of the package preset an attribute belongs to. [value]: #value #### [value] A package preset's attribute value. -Type: **string** +Type: **string** + @@ -99,7 +105,8 @@ A package preset's attribute value. [attributeType]: #attributetype #### [attributeType] -Type: **SoftLayer_Product_Package_Preset_Attribute_Type ** +Type: **SoftLayer_Product_Package_Preset_Attribute_Type ** + @@ -109,7 +116,8 @@ A package preset's attribute value. [preset]: #preset #### [preset] -Type: **SoftLayer_Product_Package_Preset ** +Type: **SoftLayer_Product_Package_Preset ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Package_Preset_Attribute_Type/_index.md b/content/reference/datatypes/SoftLayer_Product_Package_Preset_Attribute_Type/_index.md index da2f48c01e..cf64229b13 100644 --- a/content/reference/datatypes/SoftLayer_Product_Package_Preset_Attribute_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Package_Preset_Attribute_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Product_Package_Preset_Attribute_Type models the type of attribute that can be assigned to a package preset. @@ -50,7 +52,8 @@ SoftLayer_Product_Package_Preset_Attribute_Type models the type of attribute tha [description]: #description #### [description] A brief description of a package preset attribute type. -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ A brief description of a package preset attribute type. [id]: #id #### [id] A package preset attribute type's internal identifier. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ A package preset attribute type's internal identifier. [keyName]: #keyname #### [keyName] A package preset attribute type's key name. This is typically a shorter version of an attribute type's name. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ A package preset attribute type's key name. This is typically a shorter version [name]: #name #### [name] A package preset attribute type's name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Product_Package_Preset_Configuration/_index.md b/content/reference/datatypes/SoftLayer_Product_Package_Preset_Configuration/_index.md index 3af53cc132..13a5ca9541 100644 --- a/content/reference/datatypes/SoftLayer_Product_Package_Preset_Configuration/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Package_Preset_Configuration/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -51,7 +53,8 @@ classes: [category]: #category #### [category] -Type: **SoftLayer_Product_Item_Category ** +Type: **SoftLayer_Product_Item_Category ** +
              @@ -61,7 +64,8 @@ classes: [packagePreset]: #packagepreset #### [packagePreset] -Type: **SoftLayer_Product_Package_Preset ** +Type: **SoftLayer_Product_Package_Preset ** +
              @@ -71,7 +75,8 @@ classes: [price]: #price #### [price] -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Package_Server/_index.md b/content/reference/datatypes/SoftLayer_Product_Package_Server/_index.md index 5a89efe06e..c4b2b052f7 100644 --- a/content/reference/datatypes/SoftLayer_Product_Package_Server/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Package_Server/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Product_Package_Server data type contains summarized information for bare metal servers regarding pricing, processor stats, and feature sets. @@ -45,7 +47,8 @@ The SoftLayer_Product_Package_Server data type contains summarized information f [bareMetalReservedFlag]: #baremetalreservedflag #### [bareMetalReservedFlag] Flag to indicate if the server a Bare Metal Reserved offering. -Type: **boolean** +Type: **boolean** + @@ -55,7 +58,8 @@ Flag to indicate if the server a Bare Metal Reserved offering. [catalogId]: #catalogid #### [catalogId] The unique identifier of a [SoftLayer_Product_Catalog]({{}}). -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The unique identifier of a [SoftLayer_Product_Catalog]({{Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Comma-separated list of datacenter names this server is available in [defaultRamCapacity]: #defaultramcapacity #### [defaultRamCapacity] The minimum amount of RAM the server is configured with. -Type: **decimal** +Type: **decimal** + @@ -85,7 +91,8 @@ The minimum amount of RAM the server is configured with. [dualPathNetworkFlag]: #dualpathnetworkflag #### [dualPathNetworkFlag] Flag to indicate if the server configuration supports dual path network routing. -Type: **boolean** +Type: **boolean** + @@ -95,7 +102,8 @@ Flag to indicate if the server configuration supports dual path network routing. [flexCoreServerFlag]: #flexcoreserverflag #### [flexCoreServerFlag] -Type: **boolean** +Type: **boolean** + @@ -105,7 +113,8 @@ Flag to indicate if the server configuration supports dual path network routing. [gpuFlag]: #gpuflag #### [gpuFlag] Indicates whether or not the server contains a GPU. -Type: **boolean** +Type: **boolean** + @@ -115,7 +124,8 @@ Indicates whether or not the server contains a GPU. [hourlyBillingFlag]: #hourlybillingflag #### [hourlyBillingFlag] Flag to determine if a server is available for hourly billing. -Type: **boolean** +Type: **boolean** + @@ -125,7 +135,8 @@ Flag to determine if a server is available for hourly billing. [id]: #id #### [id] The unique identifier of a [SoftLayer_Product_Package_Server]({{}}). -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ The unique identifier of a [SoftLayer_Product_Package_Server]({{}}). -Type: **integer** +Type: **integer** + @@ -145,7 +157,8 @@ The unique identifier of a [SoftLayer_Product_Item]({{}}). -Type: **integer** +Type: **integer** + @@ -155,7 +168,8 @@ The unique identifier of a [SoftLayer_Product_Item_Price]({{Type: **integer** +Type: **integer** + @@ -165,7 +179,8 @@ The maximum number of hard drives the server can support. [maximumPortSpeed]: #maximumportspeed #### [maximumPortSpeed] The maximum available network speed for the server. -Type: **decimal** +Type: **decimal** + @@ -175,7 +190,8 @@ The maximum available network speed for the server. [maximumRamCapacity]: #maximumramcapacity #### [maximumRamCapacity] The maximum amount of RAM the server can support. -Type: **decimal** +Type: **decimal** + @@ -185,7 +201,8 @@ The maximum amount of RAM the server can support. [minimumPortSpeed]: #minimumportspeed #### [minimumPortSpeed] The minimum available network speed for the server. -Type: **decimal** +Type: **decimal** + @@ -195,7 +212,8 @@ The minimum available network speed for the server. [networkGatewayApplianceRoleFlag]: #networkgatewayapplianceroleflag #### [networkGatewayApplianceRoleFlag] -Type: **boolean** +Type: **boolean** + @@ -205,7 +223,8 @@ The minimum available network speed for the server. [outletFlag]: #outletflag #### [outletFlag] DEPRECATED. Indicates whether or not the server is being sold as part of an outlet package. -Type: **boolean** +Type: **boolean** + @@ -215,7 +234,8 @@ DEPRECATED. Indicates whether or not the server is being sold as part of an outl [packageId]: #packageid #### [packageId] The unique identifier of a [SoftLayer_Product_Package]({{}}). -Type: **integer** +Type: **integer** + @@ -225,7 +245,8 @@ The unique identifier of a [SoftLayer_Product_Package]({{Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ The type of service offering/package. [powerServerFlag]: #powerserverflag #### [powerServerFlag] Flag to indicate if the server is an IBM Power server. -Type: **boolean** +Type: **boolean** + @@ -245,7 +267,8 @@ Flag to indicate if the server is an IBM Power server. [presetId]: #presetid #### [presetId] The unique identifier of a [SoftLayer_Product_Package_Preset]({{}}). -Type: **integer** +Type: **integer** + @@ -255,7 +278,8 @@ The unique identifier of a [SoftLayer_Product_Package_Preset]({{Type: **boolean** +Type: **boolean** + @@ -265,7 +289,8 @@ Indicates whether or not the server can only be configured with a private networ [processorBusSpeed]: #processorbusspeed #### [processorBusSpeed] The processor's bus speed. -Type: **string** +Type: **string** + @@ -275,7 +300,8 @@ The processor's bus speed. [processorCache]: #processorcache #### [processorCache] The amount of cache the processor has. -Type: **string** +Type: **string** + @@ -285,7 +311,8 @@ The amount of cache the processor has. [processorCores]: #processorcores #### [processorCores] The number of cores in each processor. -Type: **integer** +Type: **integer** + @@ -295,7 +322,8 @@ The number of cores in each processor. [processorCount]: #processorcount #### [processorCount] The number of processors the server has. -Type: **integer** +Type: **integer** + @@ -305,7 +333,8 @@ The number of processors the server has. [processorManufacturer]: #processormanufacturer #### [processorManufacturer] The manufacturer of the server's processor. -Type: **string** +Type: **string** + @@ -315,7 +344,8 @@ The manufacturer of the server's processor. [processorModel]: #processormodel #### [processorModel] The model of the server's processor. -Type: **string** +Type: **string** + @@ -325,7 +355,8 @@ The model of the server's processor. [processorName]: #processorname #### [processorName] The name of the server's processor. -Type: **string** +Type: **string** + @@ -335,7 +366,8 @@ The name of the server's processor. [processorSpeed]: #processorspeed #### [processorSpeed] The processor speed. -Type: **string** +Type: **string** + @@ -345,7 +377,8 @@ The processor speed. [productName]: #productname #### [productName] The name of the server product. -Type: **string** +Type: **string** + @@ -355,7 +388,8 @@ The name of the server product. [redundantPowerFlag]: #redundantpowerflag #### [redundantPowerFlag] Indicates whether or not the server has the capability to support a redundant power supply. -Type: **boolean** +Type: **boolean** + @@ -365,7 +399,8 @@ Indicates whether or not the server has the capability to support a redundant po [sapCertifiedServerFlag]: #sapcertifiedserverflag #### [sapCertifiedServerFlag] Flag to indicate if the server is SAP certified. -Type: **boolean** +Type: **boolean** + @@ -375,7 +410,8 @@ Flag to indicate if the server is SAP certified. [startingHourlyPrice]: #startinghourlyprice #### [startingHourlyPrice] The hourly starting price for the server. This includes a sum of all the minimum required items, including RAM and hard drives. Not all servers are available hourly. -Type: **decimal** +Type: **decimal** + @@ -385,7 +421,8 @@ The hourly starting price for the server. This includes a sum of all the minimum [startingMonthlyPrice]: #startingmonthlyprice #### [startingMonthlyPrice] The monthly starting price for the server. This includes a sum of all the minimum required items, including RAM and hard drives. -Type: **decimal** +Type: **decimal** + @@ -395,7 +432,8 @@ The monthly starting price for the server. This includes a sum of all the minimu [termLength]: #termlength #### [termLength] The length of a term if a server has a term-based price -Type: **integer** +Type: **integer** + @@ -405,7 +443,8 @@ The length of a term if a server has a term-based price [totalCoreCount]: #totalcorecount #### [totalCoreCount] The total number of processor cores available for the server. -Type: **integer** +Type: **integer** + @@ -415,7 +454,8 @@ The total number of processor cores available for the server. [txtTpmFlag]: #txttpmflag #### [txtTpmFlag] Flag to indicate if the server configuration supports TXT/TPM. -Type: **boolean** +Type: **boolean** + @@ -425,7 +465,8 @@ Flag to indicate if the server configuration supports TXT/TPM. [unitSize]: #unitsize #### [unitSize] The size of the server. -Type: **integer** +Type: **integer** + @@ -435,7 +476,8 @@ The size of the server. [vmwareVsanNodeFlag]: #vmwarevsannodeflag #### [vmwareVsanNodeFlag] Flag to indicate if the server is a VMware vSAN Node configuration. -Type: **boolean** +Type: **boolean** + @@ -451,7 +493,8 @@ Flag to indicate if the server is a VMware vSAN Node configuration. [catalog]: #catalog #### [catalog] -Type: **SoftLayer_Product_Catalog ** +Type: **SoftLayer_Product_Catalog ** + @@ -461,7 +504,8 @@ Flag to indicate if the server is a VMware vSAN Node configuration. [item]: #item #### [item] -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -471,7 +515,8 @@ Flag to indicate if the server is a VMware vSAN Node configuration. [itemPrice]: #itemprice #### [itemPrice] -Type: **SoftLayer_Product_Item_Price ** +Type: **SoftLayer_Product_Item_Price ** + @@ -481,7 +526,8 @@ Flag to indicate if the server is a VMware vSAN Node configuration. [package]: #package #### [package] -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -491,7 +537,8 @@ Flag to indicate if the server is a VMware vSAN Node configuration. [preset]: #preset #### [preset] -Type: **SoftLayer_Product_Package_Preset ** +Type: **SoftLayer_Product_Package_Preset ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Package_Server_Option/_index.md b/content/reference/datatypes/SoftLayer_Product_Package_Server_Option/_index.md index c803e6e2a3..c3948a3076 100644 --- a/content/reference/datatypes/SoftLayer_Product_Package_Server_Option/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Package_Server_Option/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The [SoftLayer_Product_Package_Server_Option]({{}}) data type contains various data points associated with package servers that can be used in selection criteria. @@ -45,7 +47,8 @@ The [SoftLayer_Product_Package_Server_Option]({{Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The unique identifier of a Catalog. [description]: #description #### [description] A description of the option. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ A description of the option. [id]: #id #### [id] The unique identifier of a Package Server Option. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The unique identifier of a Package Server Option. [type]: #type #### [type] The type of option. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The type of option. [value]: #value #### [value] The value of the the option. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Product_Package_Type/_index.md b/content/reference/datatypes/SoftLayer_Product_Package_Type/_index.md index 9f6e712059..c070682392 100644 --- a/content/reference/datatypes/SoftLayer_Product_Package_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Package_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The [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. @@ -45,7 +47,8 @@ The [SoftLayer_Product_Package_Type]({{Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The package type's unique identifier. [keyName]: #keyname #### [keyName] The unique key name of the package type. Use this value when filtering. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The unique key name of the package type. Use this value when filtering. [name]: #name #### [name] The name of the package type. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ The name of the package type. [packages]: #packages #### [packages] All the packages associated with the given package type. -Type: **SoftLayer_Product_Package[] ** +Type: **SoftLayer_Product_Package[] ** + @@ -93,7 +99,8 @@ All the packages associated with the given package type. [packageCount]: #packagecount #### [packageCount] A count of all the packages associated with the given package type. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Product_Promotion/_index.md b/content/reference/datatypes/SoftLayer_Product_Promotion/_index.md index c9c70e93d8..2554f0c21e 100644 --- a/content/reference/datatypes/SoftLayer_Product_Promotion/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Promotion/_index.md @@ -24,6 +24,8 @@ classes: + +
              diff --git a/content/reference/datatypes/SoftLayer_Product_Upgrade_Request/_index.md b/content/reference/datatypes/SoftLayer_Product_Upgrade_Request/_index.md index b37fec8326..c5e7474a0f 100644 --- a/content/reference/datatypes/SoftLayer_Product_Upgrade_Request/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Upgrade_Request/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + 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]({{}}) to a [SoftLayer_Ticket]({{}}). @@ -53,7 +55,8 @@ The SoftLayer_Product_Upgrade_Request data type contains general information rel [accountId]: #accountid #### [accountId] The unique internal id of a SoftLayer account -Type: **integer** +Type: **integer** +
              @@ -63,7 +66,8 @@ The unique internal id of a SoftLayer account [createDate]: #createdate #### [createDate] The date an upgrade request was created. -Type: **dateTime** +Type: **dateTime** + @@ -73,7 +77,8 @@ The date an upgrade request was created. [employeeId]: #employeeid #### [employeeId] The unique internal id of the last modified user -Type: **integer** +Type: **integer** + @@ -83,7 +88,8 @@ The unique internal id of the last modified user [guestId]: #guestid #### [guestId] The unique internal id of the virtual server that an upgrade will be done -Type: **integer** +Type: **integer** + @@ -93,7 +99,8 @@ The unique internal id of the virtual server that an upgrade will be done [hardwareId]: #hardwareid #### [hardwareId] The unique internal id of the hardware that an upgrade will be done -Type: **integer** +Type: **integer** + @@ -103,7 +110,8 @@ The unique internal id of the hardware that an upgrade will be done [id]: #id #### [id] An upgrade request's internal identifier. -Type: **integer** +Type: **integer** + @@ -113,7 +121,8 @@ An upgrade request's internal identifier. [maintenanceStartTimeUtc]: #maintenancestarttimeutc #### [maintenanceStartTimeUtc] The time that system admin starts working on the order item. This is used for upgrade orders. -Type: **dateTime** +Type: **dateTime** + @@ -123,7 +132,8 @@ The time that system admin starts working on the order item. This is used for u [modifyDate]: #modifydate #### [modifyDate] The date an upgrade request was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -133,7 +143,8 @@ The date an upgrade request was last modified. [orderId]: #orderid #### [orderId] The unique internal id of the order that an upgrade request is related to -Type: **integer** +Type: **integer** + @@ -143,7 +154,8 @@ The unique internal id of the order that an upgrade request is related to [orderTotal]: #ordertotal #### [orderTotal] The total amount of fees -Type: **decimal** +Type: **decimal** + @@ -153,7 +165,8 @@ The total amount of fees [proratedTotal]: #proratedtotal #### [proratedTotal] The prorated total amount of recurring fees -Type: **decimal** +Type: **decimal** + @@ -163,7 +176,8 @@ The prorated total amount of recurring fees [statusId]: #statusid #### [statusId] The unique internal id of an upgrade status -Type: **integer** +Type: **integer** + @@ -173,7 +187,8 @@ The unique internal id of an upgrade status [ticketId]: #ticketid #### [ticketId] The unique internal id of the ticket related to an upgrade request -Type: **integer** +Type: **integer** + @@ -183,7 +198,8 @@ The unique internal id of the ticket related to an upgrade request [userId]: #userid #### [userId] The unique internal id of the customer who place the order -Type: **integer** +Type: **integer** + @@ -199,7 +215,8 @@ The unique internal id of the customer who place the order [account]: #account #### [account] The account that an order belongs to -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -209,7 +226,8 @@ The account that an order belongs to [completedFlag]: #completedflag #### [completedFlag] Indicates that the upgrade request has completed or has been cancelled. -Type: **boolean** +Type: **boolean** + @@ -219,7 +237,8 @@ Indicates that the upgrade request has completed or has been cancelled. [invoice]: #invoice #### [invoice] This is the invoice associated with the upgrade request. For hourly servers or services, an invoice will not be available. -Type: **SoftLayer_Billing_Invoice ** +Type: **SoftLayer_Billing_Invoice ** + @@ -229,7 +248,8 @@ This is the invoice associated with the upgrade request. For hourly servers or s [order]: #order #### [order] An order record associated to the upgrade request -Type: **SoftLayer_Billing_Order ** +Type: **SoftLayer_Billing_Order ** + @@ -239,7 +259,8 @@ An order record associated to the upgrade request [server]: #server #### [server] A server object associated with the upgrade request if any. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -249,7 +270,8 @@ A server object associated with the upgrade request if any. [status]: #status #### [status] The current status of the upgrade request. -Type: **SoftLayer_Product_Upgrade_Request_Status ** +Type: **SoftLayer_Product_Upgrade_Request_Status ** + @@ -259,7 +281,8 @@ The current status of the upgrade request. [ticket]: #ticket #### [ticket] The ticket that is used to coordinate the upgrade process. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -269,7 +292,8 @@ The ticket that is used to coordinate the upgrade process. [user]: #user #### [user] The user that placed the order. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -279,7 +303,8 @@ The user that placed the order. [virtualGuest]: #virtualguest #### [virtualGuest] A virtual server object associated with the upgrade request if any. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + diff --git a/content/reference/datatypes/SoftLayer_Product_Upgrade_Request_Status/_index.md b/content/reference/datatypes/SoftLayer_Product_Upgrade_Request_Status/_index.md index 6c33106760..5616c2a5f8 100644 --- a/content/reference/datatypes/SoftLayer_Product_Upgrade_Request_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Product_Upgrade_Request_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Product_Upgrade_Request_Status data type contains detailed information relating to an hardware or software upgrade request. @@ -45,7 +47,8 @@ The SoftLayer_Product_Upgrade_Request_Status data type contains detailed informa [description]: #description #### [description] The detailed description of an upgrade request status. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The detailed description of an upgrade request status. [id]: #id #### [id] An internal identifier of an upgrade request status. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An internal identifier of an upgrade request status. [name]: #name #### [name] The name of an upgrade request status. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The name of an upgrade request status. [statusCode]: #statuscode #### [statusCode] The status code of an upgrade request status. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Provisioning_Hook/_index.md b/content/reference/datatypes/SoftLayer_Provisioning_Hook/_index.md index 350eb46209..ff9933ea67 100644 --- a/content/reference/datatypes/SoftLayer_Provisioning_Hook/_index.md +++ b/content/reference/datatypes/SoftLayer_Provisioning_Hook/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Provisioning_Hook contains all the information needed to add a hook into a server/Virtual provision and os reload. @@ -45,7 +47,8 @@ The SoftLayer_Provisioning_Hook contains all the information needed to add a hoo [accountId]: #accountid #### [accountId] The ID of the account the script belongs to. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The ID of the account the script belongs to. [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The ID of the account the script belongs to. [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The ID of the account the script belongs to. [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The ID of the account the script belongs to. [name]: #name #### [name] The name of the hook. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The name of the hook. [typeId]: #typeid #### [typeId] The ID of the type of hook the script is identified as. Currently only CUSTOMER_PROVIDED_HOOK has been implemented. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The ID of the type of hook the script is identified as. Currently only CUSTOMER [uri]: #uri #### [uri] The endpoint that the script will be downloaded from (USERNAME AND PASSWORD SHOULD BE INCLUDED HERE). If the endpoint is HTTP, the script will only be downloaded. If the endpoint is HTTPS, the script will be downloaded and executed. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The endpoint that the script will be downloaded from (USERNAME AND PASSWORD SHOU [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -131,7 +141,8 @@ The endpoint that the script will be downloaded from (USERNAME AND PASSWORD SHOU [hookType]: #hooktype #### [hookType] -Type: **SoftLayer_Provisioning_Hook_Type ** +Type: **SoftLayer_Provisioning_Hook_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Provisioning_Hook_Type/_index.md b/content/reference/datatypes/SoftLayer_Provisioning_Hook_Type/_index.md index 9a1deac7f2..11e69ffcda 100644 --- a/content/reference/datatypes/SoftLayer_Provisioning_Hook_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Provisioning_Hook_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Classification/_index.md b/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Classification/_index.md index 0a6a873c26..c2634255fb 100644 --- a/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Classification/_index.md +++ b/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Classification/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Provisioning_Maintenance_Classification represent a maintenance type for the specific hardware maintenance desired. @@ -45,7 +47,8 @@ The SoftLayer_Provisioning_Maintenance_Classification represent a maintenance ty [id]: #id #### [id] The id of the maintenance classification. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The id of the maintenance classification. [slots]: #slots #### [slots] The number of slots required for the maintenance classification. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The number of slots required for the maintenance classification. [type]: #type #### [type] The type or name of the maintenance classification. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ The type or name of the maintenance classification. [itemCategories]: #itemcategories #### [itemCategories] -Type: **SoftLayer_Provisioning_Maintenance_Classification_Item_Category[] ** +Type: **SoftLayer_Provisioning_Maintenance_Classification_Item_Category[] ** + @@ -93,7 +99,8 @@ The type or name of the maintenance classification. [itemCategoryCount]: #itemcategorycount #### [itemCategoryCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/_index.md b/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/_index.md index 23dbccce67..e6503b7974 100644 --- a/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/_index.md +++ b/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [itemCategoryId]: #itemcategoryid #### [itemCategoryId] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [maintenanceClassificationId]: #maintenanceclassificationid #### [maintenanceClassificationId] -Type: **integer** +Type: **integer** +
              @@ -71,7 +75,8 @@ classes: [maintenanceClassification]: #maintenanceclassification #### [maintenanceClassification] -Type: **SoftLayer_Provisioning_Maintenance_Classification ** +Type: **SoftLayer_Provisioning_Maintenance_Classification ** + diff --git a/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Slots/_index.md b/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Slots/_index.md index c7b9705d8b..84a5751a0f 100644 --- a/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Slots/_index.md +++ b/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Slots/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Provisioning_Maintenance_Slots represent the available slots for a given maintenance window at a SoftLayer data center. @@ -50,7 +52,8 @@ The SoftLayer_Provisioning_Maintenance_Slots represent the available slots for a [availableSlots]: #availableslots #### [availableSlots] The available slots for a maintenance window. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Ticket/_index.md b/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Ticket/_index.md index 36c41797e9..e0ea58e1de 100644 --- a/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Ticket/_index.md +++ b/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Ticket/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [maintClassId]: #maintclassid #### [maintClassId] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [maintWindowId]: #maintwindowid #### [maintWindowId] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [maintenanceDate]: #maintenancedate #### [maintenanceDate] -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ classes: [ticketId]: #ticketid #### [ticketId] -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ classes: [availableSlots]: #availableslots #### [availableSlots] -Type: **SoftLayer_Provisioning_Maintenance_Slots ** +Type: **SoftLayer_Provisioning_Maintenance_Slots ** + @@ -101,7 +108,8 @@ classes: [maintenanceClass]: #maintenanceclass #### [maintenanceClass] -Type: **SoftLayer_Provisioning_Maintenance_Classification ** +Type: **SoftLayer_Provisioning_Maintenance_Classification ** + @@ -111,7 +119,8 @@ classes: [ticket]: #ticket #### [ticket] -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + diff --git a/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Window/_index.md b/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Window/_index.md index 8a1fb939b3..c12c646fd8 100644 --- a/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Window/_index.md +++ b/content/reference/datatypes/SoftLayer_Provisioning_Maintenance_Window/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Provisioning_Maintenance_Window represent a time window that SoftLayer performs a hardware or software maintenance and upgrades. @@ -55,7 +57,8 @@ The SoftLayer_Provisioning_Maintenance_Window represent a time window that SoftL [beginDate]: #begindate #### [beginDate] The date and time a maintenance window is scheduled to begin. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +68,8 @@ The date and time a maintenance window is scheduled to begin. [dayOfWeek]: #dayofweek #### [dayOfWeek] An ISO-8601 numeric representation of the day of the week that a maintenance window is performed. 1: Monday, 7: Sunday -Type: **integer** +Type: **integer** + @@ -75,7 +79,8 @@ An ISO-8601 numeric representation of the day of the week that a maintenance win [endDate]: #enddate #### [endDate] The date and time a maintenance window is scheduled to end. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +90,8 @@ The date and time a maintenance window is scheduled to end. [id]: #id #### [id] Id of the maintenance window -Type: **integer** +Type: **integer** + @@ -95,7 +101,8 @@ Id of the maintenance window [locationId]: #locationid #### [locationId] An internal identifier of the location (data center) record that a maintenance window takes place in. -Type: **integer** +Type: **integer** + @@ -105,7 +112,8 @@ An internal identifier of the location (data center) record that a maintenance w [portalTzId]: #portaltzid #### [portalTzId] An internal identifier of the datacenter timezone. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Provisioning_Version1_Transaction/_index.md b/content/reference/datatypes/SoftLayer_Provisioning_Version1_Transaction/_index.md index abb5690898..e4c31c056e 100644 --- a/content/reference/datatypes/SoftLayer_Provisioning_Version1_Transaction/_index.md +++ b/content/reference/datatypes/SoftLayer_Provisioning_Version1_Transaction/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -60,7 +62,8 @@ SoftLayer customers are unable to change their hardware transactions. [createDate]: #createdate #### [createDate] The date a transaction was created. -Type: **dateTime** +Type: **dateTime** + @@ -70,7 +73,8 @@ The date a transaction was created. [elapsedSeconds]: #elapsedseconds #### [elapsedSeconds] The amount of seconds that have elapsed since the transaction was last modified. -Type: **integer** +Type: **integer** + @@ -80,7 +84,8 @@ The amount of seconds that have elapsed since the transaction was last modified. [guestId]: #guestid #### [guestId] A transaction's associated guest identification number. -Type: **integer** +Type: **integer** + @@ -90,7 +95,8 @@ A transaction's associated guest identification number. [hardwareId]: #hardwareid #### [hardwareId] A transaction's associated hardware identification number. -Type: **integer** +Type: **integer** + @@ -100,7 +106,8 @@ A transaction's associated hardware identification number. [id]: #id #### [id] A transaction's identifying number. -Type: **integer** +Type: **integer** + @@ -110,7 +117,8 @@ A transaction's identifying number. [modifyDate]: #modifydate #### [modifyDate] The date a transaction was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -120,7 +128,8 @@ The date a transaction was last modified. [statusChangeDate]: #statuschangedate #### [statusChangeDate] The date the transaction status was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -136,7 +145,8 @@ The date the transaction status was last modified. [account]: #account #### [account] The account that a transaction belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -146,7 +156,8 @@ The account that a transaction belongs to. [guest]: #guest #### [guest] The guest record for this transaction. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -156,7 +167,8 @@ The guest record for this transaction. [hardware]: #hardware #### [hardware] The hardware object for this transaction. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -166,7 +178,8 @@ The hardware object for this transaction. [loopback]: #loopback #### [loopback] -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + @@ -176,7 +189,8 @@ The hardware object for this transaction. [pendingTransactions]: #pendingtransactions #### [pendingTransactions] -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + @@ -186,7 +200,8 @@ The hardware object for this transaction. [ticketScheduledActionReference]: #ticketscheduledactionreference #### [ticketScheduledActionReference] -Type: **SoftLayer_Ticket_Attachment[] ** +Type: **SoftLayer_Ticket_Attachment[] ** + @@ -196,7 +211,8 @@ The hardware object for this transaction. [transactionGroup]: #transactiongroup #### [transactionGroup] A transaction's group. This group object determines what type of service is being done on the hardware. -Type: **SoftLayer_Provisioning_Version1_Transaction_Group ** +Type: **SoftLayer_Provisioning_Version1_Transaction_Group ** + @@ -206,7 +222,8 @@ A transaction's group. This group object determines what type of service is bein [transactionStatus]: #transactionstatus #### [transactionStatus] A transaction's status. This status object determines the state it is in the transaction group. -Type: **SoftLayer_Provisioning_Version1_Transaction_Status ** +Type: **SoftLayer_Provisioning_Version1_Transaction_Status ** + @@ -218,7 +235,8 @@ A transaction's status. This status object determines the state it is in the tra [loopbackCount]: #loopbackcount #### [loopbackCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -228,7 +246,8 @@ A count of [pendingTransactionCount]: #pendingtransactioncount #### [pendingTransactionCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -238,7 +257,8 @@ A count of [ticketScheduledActionReferenceCount]: #ticketscheduledactionreferencecount #### [ticketScheduledActionReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Provisioning_Version1_Transaction_Group/_index.md b/content/reference/datatypes/SoftLayer_Provisioning_Version1_Transaction_Group/_index.md index 91c308996a..4dd3abe3bb 100644 --- a/content/reference/datatypes/SoftLayer_Provisioning_Version1_Transaction_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Provisioning_Version1_Transaction_Group/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -52,7 +54,8 @@ SoftLayer customers are unable to change their hardware transactions or the hard [averageTimeToComplete]: #averagetimetocomplete #### [averageTimeToComplete] Average time, in minutes, for this type of transaction to complete. Please note that this is only an estimate. -Type: **decimal** +Type: **decimal** + @@ -62,7 +65,8 @@ Average time, in minutes, for this type of transaction to complete. Please note [name]: #name #### [name] A transaction group's name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Provisioning_Version1_Transaction_History/_index.md b/content/reference/datatypes/SoftLayer_Provisioning_Version1_Transaction_History/_index.md index 7fffa46db0..300edd814d 100644 --- a/content/reference/datatypes/SoftLayer_Provisioning_Version1_Transaction_History/_index.md +++ b/content/reference/datatypes/SoftLayer_Provisioning_Version1_Transaction_History/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [finishDate]: #finishdate #### [finishDate] The finish date of a transaction history record. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ The finish date of a transaction history record. [guestId]: #guestid #### [guestId] The guest ID associated with a transaction history. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ The guest ID associated with a transaction history. [hardwareId]: #hardwareid #### [hardwareId] The hardware ID associated with a transaction history. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The hardware ID associated with a transaction history. [hostId]: #hostid #### [hostId] The host ID associated with a transaction history. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The host ID associated with a transaction history. [id]: #id #### [id] The ID associated with a transaction history. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The ID associated with a transaction history. [startDate]: #startdate #### [startDate] The start date of a transaction history record. -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ The start date of a transaction history record. [transactionId]: #transactionid #### [transactionId] The transaction ID associated with a transaction history. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ The transaction ID associated with a transaction history. [transactionStatusId]: #transactionstatusid #### [transactionStatusId] The transaction status ID associated with a transaction history. -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ The transaction status ID associated with a transaction history. [guest]: #guest #### [guest] The guest from where transaction history originates. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -141,7 +152,8 @@ The guest from where transaction history originates. [hardware]: #hardware #### [hardware] The hardware from where transaction history originates. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -151,7 +163,8 @@ The hardware from where transaction history originates. [transaction]: #transaction #### [transaction] The transaction from where transaction history originates. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -161,7 +174,8 @@ The transaction from where transaction history originates. [transactionStatus]: #transactionstatus #### [transactionStatus] The transaction status of a transaction history. -Type: **SoftLayer_Provisioning_Version1_Transaction_Status ** +Type: **SoftLayer_Provisioning_Version1_Transaction_Status ** + diff --git a/content/reference/datatypes/SoftLayer_Provisioning_Version1_Transaction_Status/_index.md b/content/reference/datatypes/SoftLayer_Provisioning_Version1_Transaction_Status/_index.md index f3cc8e9603..10a6cfaefb 100644 --- a/content/reference/datatypes/SoftLayer_Provisioning_Version1_Transaction_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Provisioning_Version1_Transaction_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -52,7 +54,8 @@ SoftLayer customers are unable to change their hardware transaction status. [averageDuration]: #averageduration #### [averageDuration] Hardware transaction status average duration. -Type: **decimal** +Type: **decimal** + @@ -62,7 +65,8 @@ Hardware transaction status average duration. [friendlyName]: #friendlyname #### [friendlyName] Transaction status friendly name. -Type: **string** +Type: **string** + @@ -72,7 +76,8 @@ Transaction status friendly name. [name]: #name #### [name] Transaction status name. -Type: **string** +Type: **string** + @@ -88,7 +93,8 @@ Transaction status name. [nonCompletedTransactions]: #noncompletedtransactions #### [nonCompletedTransactions] -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + @@ -100,7 +106,8 @@ Transaction status name. [nonCompletedTransactionCount]: #noncompletedtransactioncount #### [nonCompletedTransactionCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group/_index.md index 3a096d1eb2..c55064cb6b 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] A resource group's creation date. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ A resource group's creation date. [description]: #description #### [description] A resource group's description. -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ A resource group's description. [id]: #id #### [id] A resource group's ID. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A resource group's ID. [keyName]: #keyname #### [keyName] A resource group's keyname. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ A resource group's keyname. [name]: #name #### [name] A resource group's name. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ A resource group's name. [rootResourceGroupId]: #rootresourcegroupid #### [rootResourceGroupId] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ A resource group's name. [templateId]: #templateid #### [templateId] A resource group's template ID. -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ A resource group's template ID. [ancestorGroups]: #ancestorgroups #### [ancestorGroups] A resource group's associated group ancestors. -Type: **SoftLayer_Resource_Group[] ** +Type: **SoftLayer_Resource_Group[] ** + @@ -131,7 +141,8 @@ A resource group's associated group ancestors. [attributes]: #attributes #### [attributes] A resource group's associated attributes. -Type: **SoftLayer_Resource_Group_Attribute[] ** +Type: **SoftLayer_Resource_Group_Attribute[] ** + @@ -141,7 +152,8 @@ A resource group's associated attributes. [hardwareMembers]: #hardwaremembers #### [hardwareMembers] A resource group's associated hardware members. -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -151,7 +163,8 @@ A resource group's associated hardware members. [members]: #members #### [members] A resource group's associated members. -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -161,7 +174,8 @@ A resource group's associated members. [rootResourceGroup]: #rootresourcegroup #### [rootResourceGroup] A resource group's associated root resource group. -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -171,7 +185,8 @@ A resource group's associated root resource group. [subnetMembers]: #subnetmembers #### [subnetMembers] A resource group's associated subnet members. -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -181,7 +196,8 @@ A resource group's associated subnet members. [template]: #template #### [template] A resource group's associated template. -Type: **SoftLayer_Resource_Group_Template ** +Type: **SoftLayer_Resource_Group_Template ** + @@ -191,7 +207,8 @@ A resource group's associated template. [vlanMembers]: #vlanmembers #### [vlanMembers] A resource group's associated VLAN members. -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -203,7 +220,8 @@ A resource group's associated VLAN members. [ancestorGroupCount]: #ancestorgroupcount #### [ancestorGroupCount] A count of a resource group's associated group ancestors. -Type: **unsigned long** +Type: **unsigned long** + @@ -213,7 +231,8 @@ A count of a resource group's associated group ancestors. [attributeCount]: #attributecount #### [attributeCount] A count of a resource group's associated attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -223,7 +242,8 @@ A count of a resource group's associated attributes. [hardwareMemberCount]: #hardwaremembercount #### [hardwareMemberCount] A count of a resource group's associated hardware members. -Type: **unsigned long** +Type: **unsigned long** + @@ -233,7 +253,8 @@ A count of a resource group's associated hardware members. [memberCount]: #membercount #### [memberCount] A count of a resource group's associated members. -Type: **unsigned long** +Type: **unsigned long** + @@ -243,7 +264,8 @@ A count of a resource group's associated members. [subnetMemberCount]: #subnetmembercount #### [subnetMemberCount] A count of a resource group's associated subnet members. -Type: **unsigned long** +Type: **unsigned long** + @@ -253,7 +275,8 @@ A count of a resource group's associated subnet members. [vlanMemberCount]: #vlanmembercount #### [vlanMemberCount] A count of a resource group's associated VLAN members. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Attribute/_index.md index f6c3414b56..800f020c01 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Attribute/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] A resource group attribute's creation date. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ A resource group attribute's creation date. [id]: #id #### [id] A resource group attribute's ID. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ A resource group attribute's ID. [value]: #value #### [value] A resource group attribute's value. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A resource group attribute's value. [group]: #group #### [group] A resource group attribute's resource group. -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -91,7 +97,8 @@ A resource group attribute's resource group. [type]: #type #### [type] A resource group attribute's type. -Type: **SoftLayer_Resource_Group_Attribute_Type ** +Type: **SoftLayer_Resource_Group_Attribute_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Attribute_Type/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Attribute_Type/_index.md index 378f6d1f2e..3e72a9f574 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Attribute_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Attribute_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Descendant_Reference/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Descendant_Reference/_index.md index fe3dc50064..6649fce8aa 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Descendant_Reference/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Descendant_Reference/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Resource_Group_Descendant_Reference data type simplifies the link between one SoftLayer_Resource_Group_Member object and all of its parents. @@ -53,7 +55,8 @@ The SoftLayer_Resource_Group_Descendant_Reference data type simplifies the link [group]: #group #### [group] -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -63,7 +66,8 @@ The SoftLayer_Resource_Group_Descendant_Reference data type simplifies the link [groupMember]: #groupmember #### [groupMember] -Type: **SoftLayer_Resource_Group_Member ** +Type: **SoftLayer_Resource_Group_Member ** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Member/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Member/_index.md index bebaa5b7e4..857d918152 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Member/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Member/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] A resource group member's creation date. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ A resource group member's creation date. [id]: #id #### [id] A resource group member's ID. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ A resource group member's ID. [status]: #status #### [status] A resource group member's status. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A resource group member's status. [attributes]: #attributes #### [attributes] A resource group member's associated attributes. -Type: **SoftLayer_Resource_Group_Member_Attribute[] ** +Type: **SoftLayer_Resource_Group_Member_Attribute[] ** + @@ -91,7 +97,8 @@ A resource group member's associated attributes. [descendantMembers]: #descendantmembers #### [descendantMembers] A resource group member's associated member descendants. -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -101,7 +108,8 @@ A resource group member's associated member descendants. [group]: #group #### [group] A resource group member's resource group. -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -111,7 +119,8 @@ A resource group member's resource group. [roles]: #roles #### [roles] A resource group member's associated roles. -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -121,7 +130,8 @@ A resource group member's associated roles. [type]: #type #### [type] A resource group member's type. -Type: **SoftLayer_Resource_Group_Member_Type ** +Type: **SoftLayer_Resource_Group_Member_Type ** + @@ -133,7 +143,8 @@ A resource group member's type. [attributeCount]: #attributecount #### [attributeCount] A count of a resource group member's associated attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -143,7 +154,8 @@ A count of a resource group member's associated attributes. [descendantMemberCount]: #descendantmembercount #### [descendantMemberCount] A count of a resource group member's associated member descendants. -Type: **unsigned long** +Type: **unsigned long** + @@ -153,7 +165,8 @@ A count of a resource group member's associated member descendants. [roleCount]: #rolecount #### [roleCount] A count of a resource group member's associated roles. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Attribute/_index.md index 65243a0b4f..3edbaa18ca 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Attribute/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] A resource group member attribute's creation date. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ A resource group member attribute's creation date. [id]: #id #### [id] A resource group member attribute's ID. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ A resource group member attribute's ID. [value]: #value #### [value] A resource group member attribute's value. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A resource group member attribute's value. [member]: #member #### [member] A resource group member attribute's resource group member. -Type: **SoftLayer_Resource_Group_Member ** +Type: **SoftLayer_Resource_Group_Member ** + @@ -91,7 +97,8 @@ A resource group member attribute's resource group member. [type]: #type #### [type] A resource group member attribute's type. -Type: **SoftLayer_Resource_Group_Member_Attribute_Type ** +Type: **SoftLayer_Resource_Group_Member_Attribute_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Attribute_Type/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Attribute_Type/_index.md index 50cd3aac70..246ae73641 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Attribute_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Attribute_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Member_CloudStack_Version3_Cluster/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Member_CloudStack_Version3_Cluster/_index.md index 69fcf4f748..788faefea5 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Member_CloudStack_Version3_Cluster/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Member_CloudStack_Version3_Cluster/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] A resource group member's creation date. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ A resource group member's creation date. [id]: #id #### [id] A resource group member's ID. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ A resource group member's ID. [status]: #status #### [status] A resource group member's status. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A resource group member's status. [attributes]: #attributes #### [attributes] A resource group member's associated attributes. -Type: **SoftLayer_Resource_Group_Member_Attribute[] ** +Type: **SoftLayer_Resource_Group_Member_Attribute[] ** + @@ -91,7 +97,8 @@ A resource group member's associated attributes. [descendantMembers]: #descendantmembers #### [descendantMembers] A resource group member's associated member descendants. -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -101,7 +108,8 @@ A resource group member's associated member descendants. [group]: #group #### [group] A resource group member's resource group. -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -111,7 +119,8 @@ A resource group member's resource group. [resource]: #resource #### [resource] A resource group member's associated cluster. -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -121,7 +130,8 @@ A resource group member's associated cluster. [roles]: #roles #### [roles] A resource group member's associated roles. -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -131,7 +141,8 @@ A resource group member's associated roles. [type]: #type #### [type] A resource group member's type. -Type: **SoftLayer_Resource_Group_Member_Type ** +Type: **SoftLayer_Resource_Group_Member_Type ** + @@ -143,7 +154,8 @@ A resource group member's type. [attributeCount]: #attributecount #### [attributeCount] A count of a resource group member's associated attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -153,7 +165,8 @@ A count of a resource group member's associated attributes. [descendantMemberCount]: #descendantmembercount #### [descendantMemberCount] A count of a resource group member's associated member descendants. -Type: **unsigned long** +Type: **unsigned long** + @@ -163,7 +176,8 @@ A count of a resource group member's associated member descendants. [roleCount]: #rolecount #### [roleCount] A count of a resource group member's associated roles. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Member_CloudStack_Version3_Pod/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Member_CloudStack_Version3_Pod/_index.md index 6d9dbe6420..3128fd4ddd 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Member_CloudStack_Version3_Pod/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Member_CloudStack_Version3_Pod/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] A resource group member's creation date. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ A resource group member's creation date. [id]: #id #### [id] A resource group member's ID. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ A resource group member's ID. [status]: #status #### [status] A resource group member's status. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A resource group member's status. [attributes]: #attributes #### [attributes] A resource group member's associated attributes. -Type: **SoftLayer_Resource_Group_Member_Attribute[] ** +Type: **SoftLayer_Resource_Group_Member_Attribute[] ** + @@ -91,7 +97,8 @@ A resource group member's associated attributes. [descendantMembers]: #descendantmembers #### [descendantMembers] A resource group member's associated member descendants. -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -101,7 +108,8 @@ A resource group member's associated member descendants. [group]: #group #### [group] A resource group member's resource group. -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -111,7 +119,8 @@ A resource group member's resource group. [resource]: #resource #### [resource] A resource group member's associated pod. -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -121,7 +130,8 @@ A resource group member's associated pod. [roles]: #roles #### [roles] A resource group member's associated roles. -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -131,7 +141,8 @@ A resource group member's associated roles. [type]: #type #### [type] A resource group member's type. -Type: **SoftLayer_Resource_Group_Member_Type ** +Type: **SoftLayer_Resource_Group_Member_Type ** + @@ -143,7 +154,8 @@ A resource group member's type. [attributeCount]: #attributecount #### [attributeCount] A count of a resource group member's associated attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -153,7 +165,8 @@ A count of a resource group member's associated attributes. [descendantMemberCount]: #descendantmembercount #### [descendantMemberCount] A count of a resource group member's associated member descendants. -Type: **unsigned long** +Type: **unsigned long** + @@ -163,7 +176,8 @@ A count of a resource group member's associated member descendants. [roleCount]: #rolecount #### [roleCount] A count of a resource group member's associated roles. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Member_CloudStack_Version3_Zone/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Member_CloudStack_Version3_Zone/_index.md index e461ec2250..448897d046 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Member_CloudStack_Version3_Zone/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Member_CloudStack_Version3_Zone/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] A resource group member's creation date. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ A resource group member's creation date. [id]: #id #### [id] A resource group member's ID. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ A resource group member's ID. [status]: #status #### [status] A resource group member's status. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A resource group member's status. [attributes]: #attributes #### [attributes] A resource group member's associated attributes. -Type: **SoftLayer_Resource_Group_Member_Attribute[] ** +Type: **SoftLayer_Resource_Group_Member_Attribute[] ** + @@ -91,7 +97,8 @@ A resource group member's associated attributes. [descendantMembers]: #descendantmembers #### [descendantMembers] A resource group member's associated member descendants. -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -101,7 +108,8 @@ A resource group member's associated member descendants. [group]: #group #### [group] A resource group member's resource group. -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -111,7 +119,8 @@ A resource group member's resource group. [resource]: #resource #### [resource] A resource group member's associated zone. -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -121,7 +130,8 @@ A resource group member's associated zone. [roles]: #roles #### [roles] A resource group member's associated roles. -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -131,7 +141,8 @@ A resource group member's associated roles. [type]: #type #### [type] A resource group member's type. -Type: **SoftLayer_Resource_Group_Member_Type ** +Type: **SoftLayer_Resource_Group_Member_Type ** + @@ -143,7 +154,8 @@ A resource group member's type. [attributeCount]: #attributecount #### [attributeCount] A count of a resource group member's associated attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -153,7 +165,8 @@ A count of a resource group member's associated attributes. [descendantMemberCount]: #descendantmembercount #### [descendantMemberCount] A count of a resource group member's associated member descendants. -Type: **unsigned long** +Type: **unsigned long** + @@ -163,7 +176,8 @@ A count of a resource group member's associated member descendants. [roleCount]: #rolecount #### [roleCount] A count of a resource group member's associated roles. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Hardware/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Hardware/_index.md index 7aeb89df87..262433fcdd 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Hardware/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Hardware/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] A resource group member's creation date. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ A resource group member's creation date. [id]: #id #### [id] A resource group member's ID. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ A resource group member's ID. [status]: #status #### [status] A resource group member's status. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A resource group member's status. [attributes]: #attributes #### [attributes] A resource group member's associated attributes. -Type: **SoftLayer_Resource_Group_Member_Attribute[] ** +Type: **SoftLayer_Resource_Group_Member_Attribute[] ** + @@ -91,7 +97,8 @@ A resource group member's associated attributes. [descendantMembers]: #descendantmembers #### [descendantMembers] A resource group member's associated member descendants. -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -101,7 +108,8 @@ A resource group member's associated member descendants. [group]: #group #### [group] A resource group member's resource group. -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -111,7 +119,8 @@ A resource group member's resource group. [resource]: #resource #### [resource] A resource group member's associated hardware. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ A resource group member's associated hardware. [roles]: #roles #### [roles] A resource group member's associated roles. -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -131,7 +141,8 @@ A resource group member's associated roles. [serverArbiterOnly]: #serverarbiteronly #### [serverArbiterOnly] A resource group hardware member's associated server arbiter-only state. -Type: **SoftLayer_Resource_Group_Member_Attribute ** +Type: **SoftLayer_Resource_Group_Member_Attribute ** + @@ -141,7 +152,8 @@ A resource group hardware member's associated server arbiter-only state. [serverHidden]: #serverhidden #### [serverHidden] A resource group hardware member's associated server hidden state. -Type: **SoftLayer_Resource_Group_Member_Attribute ** +Type: **SoftLayer_Resource_Group_Member_Attribute ** + @@ -151,7 +163,8 @@ A resource group hardware member's associated server hidden state. [serverPriority]: #serverpriority #### [serverPriority] A resource group hardware member's associated server priority. -Type: **SoftLayer_Resource_Group_Member_Attribute ** +Type: **SoftLayer_Resource_Group_Member_Attribute ** + @@ -161,7 +174,8 @@ A resource group hardware member's associated server priority. [serverSlaveDelay]: #serverslavedelay #### [serverSlaveDelay] A resource group hardware member's associated server slave delay (in seconds). -Type: **SoftLayer_Resource_Group_Member_Attribute ** +Type: **SoftLayer_Resource_Group_Member_Attribute ** + @@ -171,7 +185,8 @@ A resource group hardware member's associated server slave delay (in seconds). [serverTags]: #servertags #### [serverTags] A resource group hardware member's associated server tags (in JSON format). -Type: **SoftLayer_Resource_Group_Member_Attribute ** +Type: **SoftLayer_Resource_Group_Member_Attribute ** + @@ -181,7 +196,8 @@ A resource group hardware member's associated server tags (in JSON format). [serverVotes]: #servervotes #### [serverVotes] A resource group hardware member's associated server vote count. -Type: **SoftLayer_Resource_Group_Member_Attribute ** +Type: **SoftLayer_Resource_Group_Member_Attribute ** + @@ -191,7 +207,8 @@ A resource group hardware member's associated server vote count. [type]: #type #### [type] A resource group member's type. -Type: **SoftLayer_Resource_Group_Member_Type ** +Type: **SoftLayer_Resource_Group_Member_Type ** + @@ -203,7 +220,8 @@ A resource group member's type. [attributeCount]: #attributecount #### [attributeCount] A count of a resource group member's associated attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -213,7 +231,8 @@ A count of a resource group member's associated attributes. [descendantMemberCount]: #descendantmembercount #### [descendantMemberCount] A count of a resource group member's associated member descendants. -Type: **unsigned long** +Type: **unsigned long** + @@ -223,7 +242,8 @@ A count of a resource group member's associated member descendants. [roleCount]: #rolecount #### [roleCount] A count of a resource group member's associated roles. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Network_Storage/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Network_Storage/_index.md index 48a97dd450..3ca602a867 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Network_Storage/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Network_Storage/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] A resource group member's creation date. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ A resource group member's creation date. [id]: #id #### [id] A resource group member's ID. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ A resource group member's ID. [status]: #status #### [status] A resource group member's status. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A resource group member's status. [attributes]: #attributes #### [attributes] A resource group member's associated attributes. -Type: **SoftLayer_Resource_Group_Member_Attribute[] ** +Type: **SoftLayer_Resource_Group_Member_Attribute[] ** + @@ -91,7 +97,8 @@ A resource group member's associated attributes. [descendantMembers]: #descendantmembers #### [descendantMembers] A resource group member's associated member descendants. -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -101,7 +108,8 @@ A resource group member's associated member descendants. [group]: #group #### [group] A resource group member's resource group. -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -111,7 +119,8 @@ A resource group member's resource group. [resource]: #resource #### [resource] A resource group member's associated network storage. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -121,7 +130,8 @@ A resource group member's associated network storage. [roles]: #roles #### [roles] A resource group member's associated roles. -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -131,7 +141,8 @@ A resource group member's associated roles. [type]: #type #### [type] A resource group member's type. -Type: **SoftLayer_Resource_Group_Member_Type ** +Type: **SoftLayer_Resource_Group_Member_Type ** + @@ -143,7 +154,8 @@ A resource group member's type. [attributeCount]: #attributecount #### [attributeCount] A count of a resource group member's associated attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -153,7 +165,8 @@ A count of a resource group member's associated attributes. [descendantMemberCount]: #descendantmembercount #### [descendantMemberCount] A count of a resource group member's associated member descendants. -Type: **unsigned long** +Type: **unsigned long** + @@ -163,7 +176,8 @@ A count of a resource group member's associated member descendants. [roleCount]: #rolecount #### [roleCount] A count of a resource group member's associated roles. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Network_Subnet/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Network_Subnet/_index.md index c5ce311a8f..f201c8bf35 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Network_Subnet/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Network_Subnet/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] A resource group member's creation date. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ A resource group member's creation date. [id]: #id #### [id] A resource group member's ID. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ A resource group member's ID. [status]: #status #### [status] A resource group member's status. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A resource group member's status. [attributes]: #attributes #### [attributes] A resource group member's associated attributes. -Type: **SoftLayer_Resource_Group_Member_Attribute[] ** +Type: **SoftLayer_Resource_Group_Member_Attribute[] ** + @@ -91,7 +97,8 @@ A resource group member's associated attributes. [descendantMembers]: #descendantmembers #### [descendantMembers] A resource group member's associated member descendants. -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -101,7 +108,8 @@ A resource group member's associated member descendants. [group]: #group #### [group] A resource group member's resource group. -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -111,7 +119,8 @@ A resource group member's resource group. [resource]: #resource #### [resource] A resource group member's associated network subnet. -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + @@ -121,7 +130,8 @@ A resource group member's associated network subnet. [roles]: #roles #### [roles] A resource group member's associated roles. -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -131,7 +141,8 @@ A resource group member's associated roles. [type]: #type #### [type] A resource group member's type. -Type: **SoftLayer_Resource_Group_Member_Type ** +Type: **SoftLayer_Resource_Group_Member_Type ** + @@ -143,7 +154,8 @@ A resource group member's type. [attributeCount]: #attributecount #### [attributeCount] A count of a resource group member's associated attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -153,7 +165,8 @@ A count of a resource group member's associated attributes. [descendantMemberCount]: #descendantmembercount #### [descendantMemberCount] A count of a resource group member's associated member descendants. -Type: **unsigned long** +Type: **unsigned long** + @@ -163,7 +176,8 @@ A count of a resource group member's associated member descendants. [roleCount]: #rolecount #### [roleCount] A count of a resource group member's associated roles. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Network_Vlan/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Network_Vlan/_index.md index b24c82864f..4e7fc7d0fb 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Network_Vlan/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Network_Vlan/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] A resource group member's creation date. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ A resource group member's creation date. [id]: #id #### [id] A resource group member's ID. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ A resource group member's ID. [status]: #status #### [status] A resource group member's status. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A resource group member's status. [attributes]: #attributes #### [attributes] A resource group member's associated attributes. -Type: **SoftLayer_Resource_Group_Member_Attribute[] ** +Type: **SoftLayer_Resource_Group_Member_Attribute[] ** + @@ -91,7 +97,8 @@ A resource group member's associated attributes. [descendantMembers]: #descendantmembers #### [descendantMembers] A resource group member's associated member descendants. -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -101,7 +108,8 @@ A resource group member's associated member descendants. [group]: #group #### [group] A resource group member's resource group. -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -111,7 +119,8 @@ A resource group member's resource group. [resource]: #resource #### [resource] A resource group member's associated network VLAN. -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + @@ -121,7 +130,8 @@ A resource group member's associated network VLAN. [roles]: #roles #### [roles] A resource group member's associated roles. -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -131,7 +141,8 @@ A resource group member's associated roles. [type]: #type #### [type] A resource group member's type. -Type: **SoftLayer_Resource_Group_Member_Type ** +Type: **SoftLayer_Resource_Group_Member_Type ** + @@ -143,7 +154,8 @@ A resource group member's type. [attributeCount]: #attributecount #### [attributeCount] A count of a resource group member's associated attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -153,7 +165,8 @@ A count of a resource group member's associated attributes. [descendantMemberCount]: #descendantmembercount #### [descendantMemberCount] A count of a resource group member's associated member descendants. -Type: **unsigned long** +Type: **unsigned long** + @@ -163,7 +176,8 @@ A count of a resource group member's associated member descendants. [roleCount]: #rolecount #### [roleCount] A count of a resource group member's associated roles. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Resource_Group/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Resource_Group/_index.md index 8bf08a510a..eb758d98ee 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Resource_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Resource_Group/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] A resource group member's creation date. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ A resource group member's creation date. [id]: #id #### [id] A resource group member's ID. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ A resource group member's ID. [status]: #status #### [status] A resource group member's status. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A resource group member's status. [attributes]: #attributes #### [attributes] A resource group member's associated attributes. -Type: **SoftLayer_Resource_Group_Member_Attribute[] ** +Type: **SoftLayer_Resource_Group_Member_Attribute[] ** + @@ -91,7 +97,8 @@ A resource group member's associated attributes. [descendantMembers]: #descendantmembers #### [descendantMembers] A resource group member's associated member descendants. -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -101,7 +108,8 @@ A resource group member's associated member descendants. [group]: #group #### [group] A resource group member's resource group. -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -111,7 +119,8 @@ A resource group member's resource group. [resource]: #resource #### [resource] A resource group member's associated resource group. -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -121,7 +130,8 @@ A resource group member's associated resource group. [roles]: #roles #### [roles] A resource group member's associated roles. -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -131,7 +141,8 @@ A resource group member's associated roles. [type]: #type #### [type] A resource group member's type. -Type: **SoftLayer_Resource_Group_Member_Type ** +Type: **SoftLayer_Resource_Group_Member_Type ** + @@ -143,7 +154,8 @@ A resource group member's type. [attributeCount]: #attributecount #### [attributeCount] A count of a resource group member's associated attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -153,7 +165,8 @@ A count of a resource group member's associated attributes. [descendantMemberCount]: #descendantmembercount #### [descendantMemberCount] A count of a resource group member's associated member descendants. -Type: **unsigned long** +Type: **unsigned long** + @@ -163,7 +176,8 @@ A count of a resource group member's associated member descendants. [roleCount]: #rolecount #### [roleCount] A count of a resource group member's associated roles. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Role_Link/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Role_Link/_index.md index 67cde2ba76..1319e6d684 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Role_Link/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Role_Link/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [groupMemberId]: #groupmemberid #### [groupMemberId] A resource group member's ID. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ A resource group member's ID. [groupTemplateRoleId]: #grouptemplateroleid #### [groupTemplateRoleId] A resource group's template role ID. -Type: **integer** +Type: **integer** +
              diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Software_Component_Password/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Software_Component_Password/_index.md index 0382e7cd5f..3cd872fd53 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Software_Component_Password/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Software_Component_Password/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] A resource group member's creation date. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ A resource group member's creation date. [id]: #id #### [id] A resource group member's ID. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ A resource group member's ID. [status]: #status #### [status] A resource group member's status. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A resource group member's status. [attributes]: #attributes #### [attributes] A resource group member's associated attributes. -Type: **SoftLayer_Resource_Group_Member_Attribute[] ** +Type: **SoftLayer_Resource_Group_Member_Attribute[] ** + @@ -91,7 +97,8 @@ A resource group member's associated attributes. [descendantMembers]: #descendantmembers #### [descendantMembers] A resource group member's associated member descendants. -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -101,7 +108,8 @@ A resource group member's associated member descendants. [group]: #group #### [group] A resource group member's resource group. -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -111,7 +119,8 @@ A resource group member's resource group. [resource]: #resource #### [resource] A resource group member's associated software component password. -Type: **SoftLayer_Software_Component_Password ** +Type: **SoftLayer_Software_Component_Password ** + @@ -121,7 +130,8 @@ A resource group member's associated software component password. [roles]: #roles #### [roles] A resource group member's associated roles. -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -131,7 +141,8 @@ A resource group member's associated roles. [type]: #type #### [type] A resource group member's type. -Type: **SoftLayer_Resource_Group_Member_Type ** +Type: **SoftLayer_Resource_Group_Member_Type ** + @@ -143,7 +154,8 @@ A resource group member's type. [attributeCount]: #attributecount #### [attributeCount] A count of a resource group member's associated attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -153,7 +165,8 @@ A count of a resource group member's associated attributes. [descendantMemberCount]: #descendantmembercount #### [descendantMemberCount] A count of a resource group member's associated member descendants. -Type: **unsigned long** +Type: **unsigned long** + @@ -163,7 +176,8 @@ A count of a resource group member's associated member descendants. [roleCount]: #rolecount #### [roleCount] A count of a resource group member's associated roles. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Type/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Type/_index.md index 4bc8a6944d..f988f6cb52 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] A resource group member's type description. -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ A resource group member's type description. [keyName]: #keyname #### [keyName] A resource group member's type keyname. -Type: **string** +Type: **string** +
              diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Virtual_Host_Pool/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Virtual_Host_Pool/_index.md index f8c898bf52..d84c4a4bc9 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Member_Virtual_Host_Pool/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Member_Virtual_Host_Pool/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] A resource group member's creation date. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ A resource group member's creation date. [id]: #id #### [id] A resource group member's ID. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ A resource group member's ID. [status]: #status #### [status] A resource group member's status. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A resource group member's status. [attributes]: #attributes #### [attributes] A resource group member's associated attributes. -Type: **SoftLayer_Resource_Group_Member_Attribute[] ** +Type: **SoftLayer_Resource_Group_Member_Attribute[] ** + @@ -91,7 +97,8 @@ A resource group member's associated attributes. [descendantMembers]: #descendantmembers #### [descendantMembers] A resource group member's associated member descendants. -Type: **SoftLayer_Resource_Group_Member[] ** +Type: **SoftLayer_Resource_Group_Member[] ** + @@ -101,7 +108,8 @@ A resource group member's associated member descendants. [group]: #group #### [group] A resource group member's resource group. -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -111,7 +119,8 @@ A resource group member's resource group. [roles]: #roles #### [roles] A resource group member's associated roles. -Type: **SoftLayer_Resource_Group_Role[] ** +Type: **SoftLayer_Resource_Group_Role[] ** + @@ -121,7 +130,8 @@ A resource group member's associated roles. [type]: #type #### [type] A resource group member's type. -Type: **SoftLayer_Resource_Group_Member_Type ** +Type: **SoftLayer_Resource_Group_Member_Type ** + @@ -133,7 +143,8 @@ A resource group member's type. [attributeCount]: #attributecount #### [attributeCount] A count of a resource group member's associated attributes. -Type: **unsigned long** +Type: **unsigned long** + @@ -143,7 +154,8 @@ A count of a resource group member's associated attributes. [descendantMemberCount]: #descendantmembercount #### [descendantMemberCount] A count of a resource group member's associated member descendants. -Type: **unsigned long** +Type: **unsigned long** + @@ -153,7 +165,8 @@ A count of a resource group member's associated member descendants. [roleCount]: #rolecount #### [roleCount] A count of a resource group member's associated roles. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Role/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Role/_index.md index 47232917ae..55867c138c 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Role/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Role/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] A resource group role's description. -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ A resource group role's description. [id]: #id #### [id] A resource group role's ID. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ A resource group role's ID. [keyName]: #keyname #### [keyName] A resource group role's keyname. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A resource group role's keyname. [memberLinks]: #memberlinks #### [memberLinks] A resource group's role. -Type: **SoftLayer_Resource_Group_Member_Role_Link[] ** +Type: **SoftLayer_Resource_Group_Member_Role_Link[] ** + @@ -93,7 +99,8 @@ A resource group's role. [memberLinkCount]: #memberlinkcount #### [memberLinkCount] A count of a resource group's role. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Template/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Template/_index.md index 05c6c3e7a9..eec6ebd626 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Template/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Template/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] A resource group template's description. -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ A resource group template's description. [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ A resource group template's description. [keyName]: #keyname #### [keyName] A resource group template's keyname. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ A resource group template's keyname. [children]: #children #### [children] -Type: **SoftLayer_Resource_Group_Template[] ** +Type: **SoftLayer_Resource_Group_Template[] ** + @@ -91,7 +97,8 @@ A resource group template's keyname. [members]: #members #### [members] -Type: **SoftLayer_Resource_Group_Template_Member[] ** +Type: **SoftLayer_Resource_Group_Template_Member[] ** + @@ -101,7 +108,8 @@ A resource group template's keyname. [package]: #package #### [package] -Type: **SoftLayer_Product_Package ** +Type: **SoftLayer_Product_Package ** + @@ -113,7 +121,8 @@ A resource group template's keyname. [childrenCount]: #childrencount #### [childrenCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -123,7 +132,8 @@ A count of [memberCount]: #membercount #### [memberCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Resource_Group_Template_Member/_index.md b/content/reference/datatypes/SoftLayer_Resource_Group_Template_Member/_index.md index 74259e2be9..3dff8620bd 100644 --- a/content/reference/datatypes/SoftLayer_Resource_Group_Template_Member/_index.md +++ b/content/reference/datatypes/SoftLayer_Resource_Group_Template_Member/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [maxQuantity]: #maxquantity #### [maxQuantity] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [minQuantity]: #minquantity #### [minQuantity] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [roleId]: #roleid #### [roleId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [templateId]: #templateid #### [templateId] -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ classes: [role]: #role #### [role] -Type: **SoftLayer_Resource_Group_Role ** +Type: **SoftLayer_Resource_Group_Role ** + @@ -101,7 +108,8 @@ classes: [template]: #template #### [template] -Type: **SoftLayer_Resource_Group_Template ** +Type: **SoftLayer_Resource_Group_Template ** + diff --git a/content/reference/datatypes/SoftLayer_Sales_Presale_Event/_index.md b/content/reference/datatypes/SoftLayer_Sales_Presale_Event/_index.md index 4dcf1da926..be007bc048 100644 --- a/content/reference/datatypes/SoftLayer_Sales_Presale_Event/_index.md +++ b/content/reference/datatypes/SoftLayer_Sales_Presale_Event/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ The presale event data types indicate the information regarding an individual pr [description]: #description #### [description] Description of the presale event. -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ Description of the presale event. [endDate]: #enddate #### [endDate] End date of the presale event. Orders can be approved and provisioned after this date. -Type: **dateTime** +Type: **dateTime** + @@ -70,7 +74,8 @@ End date of the presale event. Orders can be approved and provisioned after this [id]: #id #### [id] Presale event unique identifier. -Type: **integer** +Type: **integer** + @@ -80,7 +85,8 @@ Presale event unique identifier. [itemId]: #itemid #### [itemId] [SoftLayer_Product_Item]({{}}) id associated with the presale event. -Type: **integer** +Type: **integer** + @@ -90,7 +96,8 @@ Presale event unique identifier. [locationId]: #locationid #### [locationId] [SoftLayer_Location]({{}}) id for the presale event. -Type: **integer** +Type: **integer** + @@ -100,7 +107,8 @@ Presale event unique identifier. [startDate]: #startdate #### [startDate] Start date of the presale event. Orders cannot be approved before this date. -Type: **dateTime** +Type: **dateTime** + @@ -116,7 +124,8 @@ Start date of the presale event. Orders cannot be approved before this date. [activeFlag]: #activeflag #### [activeFlag] A flag to indicate that the presale event is currently active. A presale event is active if the current time is between the start and end dates. -Type: **boolean** +Type: **boolean** + @@ -126,7 +135,8 @@ A flag to indicate that the presale event is currently active. A presale event i [expiredFlag]: #expiredflag #### [expiredFlag] A flag to indicate that the presale event is expired. A presale event is expired if the current time is after the end date. -Type: **boolean** +Type: **boolean** + @@ -136,7 +146,8 @@ A flag to indicate that the presale event is expired. A presale event is expired [item]: #item #### [item] The [SoftLayer_Product_Item]({{}}) associated with the presale event. -Type: **SoftLayer_Product_Item ** +Type: **SoftLayer_Product_Item ** + @@ -146,7 +157,8 @@ The [SoftLayer_Product_Item]({{}}) associated with the presale event. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -156,7 +168,8 @@ The [SoftLayer_Location]({{}}) ass [orders]: #orders #### [orders] The orders ([SoftLayer_Billing_Order]({{}})) associated with this presale event that were created for the customer's account. -Type: **SoftLayer_Billing_Order[] ** +Type: **SoftLayer_Billing_Order[] ** + @@ -168,7 +181,8 @@ The orders ([SoftLayer_Billing_Order]({{}})) associated with this presale event that were created for the customer's account. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Asset/_index.md b/content/reference/datatypes/SoftLayer_Scale_Asset/_index.md index f6a58e1128..e86c33deb9 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Asset/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Asset/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] When this asset was created. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ When this asset was created. [deleteFlag]: #deleteflag #### [deleteFlag] When set and true any edit that happens on this object, be it calling edit on this directly or setting as a child while editing a parent object, will end up being a deletion. -Type: **boolean** +Type: **boolean** +
              @@ -65,7 +69,8 @@ When set and true any edit that happens on this object, be it calling edit on th [id]: #id #### [id] An asset's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ An asset's internal identifier. [scaleGroupId]: #scalegroupid #### [scaleGroupId] The identifier of the group this asset belongs to. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The identifier of the group this asset belongs to. [scaleGroup]: #scalegroup #### [scaleGroup] The group this asset belongs to. -Type: **SoftLayer_Scale_Group ** +Type: **SoftLayer_Scale_Group ** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Asset_Hardware/_index.md b/content/reference/datatypes/SoftLayer_Scale_Asset_Hardware/_index.md index a715c48e45..2ea023d0d9 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Asset_Hardware/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Asset_Hardware/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] When this asset was created. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ When this asset was created. [deleteFlag]: #deleteflag #### [deleteFlag] When set and true any edit that happens on this object, be it calling edit on this directly or setting as a child while editing a parent object, will end up being a deletion. -Type: **boolean** +Type: **boolean** +
              @@ -65,7 +69,8 @@ When set and true any edit that happens on this object, be it calling edit on th [id]: #id #### [id] An asset's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ An asset's internal identifier. [scaleGroupId]: #scalegroupid #### [scaleGroupId] The identifier of the group this asset belongs to. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The identifier of the group this asset belongs to. [hardware]: #hardware #### [hardware] The hardware for this asset. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -101,7 +108,8 @@ The hardware for this asset. [hardwareId]: #hardwareid #### [hardwareId] The identifier of the hardware for this asset. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The identifier of the hardware for this asset. [scaleGroup]: #scalegroup #### [scaleGroup] The group this asset belongs to. -Type: **SoftLayer_Scale_Group ** +Type: **SoftLayer_Scale_Group ** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Asset_Virtual_Guest/_index.md b/content/reference/datatypes/SoftLayer_Scale_Asset_Virtual_Guest/_index.md index e9aa9412d3..38f3701dfd 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Asset_Virtual_Guest/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Asset_Virtual_Guest/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] When this asset was created. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ When this asset was created. [deleteFlag]: #deleteflag #### [deleteFlag] When set and true any edit that happens on this object, be it calling edit on this directly or setting as a child while editing a parent object, will end up being a deletion. -Type: **boolean** +Type: **boolean** +
              @@ -65,7 +69,8 @@ When set and true any edit that happens on this object, be it calling edit on th [id]: #id #### [id] An asset's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ An asset's internal identifier. [scaleGroupId]: #scalegroupid #### [scaleGroupId] The identifier of the group this asset belongs to. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The identifier of the group this asset belongs to. [scaleGroup]: #scalegroup #### [scaleGroup] The group this asset belongs to. -Type: **SoftLayer_Scale_Group ** +Type: **SoftLayer_Scale_Group ** + @@ -101,7 +108,8 @@ The group this asset belongs to. [virtualGuest]: #virtualguest #### [virtualGuest] The guest for this asset. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -111,7 +119,8 @@ The guest for this asset. [virtualGuestId]: #virtualguestid #### [virtualGuestId] The identifier of the guest for this asset. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Group/_index.md b/content/reference/datatypes/SoftLayer_Scale_Group/_index.md index a267e3ff03..08a11b16ea 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Group/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The identifier of the account assigned to this group. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ The identifier of the account assigned to this group. [balancedTerminationFlag]: #balancedterminationflag #### [balancedTerminationFlag] If this is true, this group will scale down members in a way to preserve the balance across VLANs. If there is ambiguity about which member to use to maintain balance, the terminationPolicy is used to resolve it. This is false by default and can only be set to true if there are multiple VLANs that are being balanced across. -Type: **boolean** +Type: **boolean** +
              @@ -65,7 +69,8 @@ If this is true, this group will scale down members in a way to preserve the bal [cooldown]: #cooldown #### [cooldown] The number of seconds this group will wait after lastActionDate before performing another action. Be advised, this can be overridden per policy. While strongly discouraged, a value of 0 effectively disables cooldown. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The number of seconds this group will wait after lastActionDate before performin [createDate]: #createdate #### [createDate] When this group was created. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ When this group was created. [desiredMemberCount]: #desiredmembercount #### [desiredMemberCount] This value is only available on the template for creating and editing a group. It will be null when retrieved. When this value is provided on create or edit, guests will be scaled up or down to meet this number. This number must be in the range provided by minimumMemberCount and maximumMemberCount. This value can only be present during create or edit when this group is active. Note, guests that are created as a result of this value can possibly be removed after cooldown by a policy. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ This value is only available on the template for creating and editing a group. I [id]: #id #### [id] A group's internal identifier. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ A group's internal identifier. [lastActionDate]: #lastactiondate #### [lastActionDate] The date of the last action on this group or its create date -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The date of the last action on this group or its create date [maximumMemberCount]: #maximummembercount #### [maximumMemberCount] The greatest number of virtual guest members that are allowed on this group. Any attempts to add a guest member will fail if it will result in the total guest member count of this group to be above this number. If this number is edited and is less than the current guest member count, guests will be removed to at least be no greater than this number. -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ The greatest number of virtual guest members that are allowed on this group. Any [minimumMemberCount]: #minimummembercount #### [minimumMemberCount] The fewest number of virtual guest members that are allowed on this group. Any attempts to remove a guest member will fail if it will result in the total guest member count of this group to be below this number. If this number is edited and is larger than the current guest member count, guests will be added to at least reach this number. -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ The fewest number of virtual guest members that are allowed on this group. Any a [modifyDate]: #modifydate #### [modifyDate] When this group was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -145,7 +157,8 @@ When this group was last modified. [name]: #name #### [name] The name of this scale group. It must be unique on the account. -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ The name of this scale group. It must be unique on the account. [regionalGroupId]: #regionalgroupid #### [regionalGroupId] The identifier of the regional group this scaling group is assigned to. -Type: **integer** +Type: **integer** + @@ -165,7 +179,8 @@ The identifier of the regional group this scaling group is assigned to. [suspendedFlag]: #suspendedflag #### [suspendedFlag] If true, this group is suspended. -Type: **boolean** +Type: **boolean** + @@ -175,7 +190,8 @@ If true, this group is suspended. [terminationPolicyId]: #terminationpolicyid #### [terminationPolicyId] The termination policy for the group. This determines which member to choose to delete when scaling downwards. -Type: **integer** +Type: **integer** + @@ -187,7 +203,8 @@ The termination policy for the group. This determines which member to choose to This is the template to create guest members with. This is the same template accepted by the createObject call on SoftLayer_Virtual_Guest with some caveats. The hostname provided will have an arbitrary value appended to it for each guest created. Also, hourlyBillingFlag cannot be false, and if the datacenter is provided it must be in the region of this group. Finally, VLANs cannot be provided for the template, it will use VLANs provided to this group instead. Note, if this template is edited on an existing group the previous template values are not kept and are not considered during termination. This means a group's guest members could effectively be a hybrid of multiple templates because this value was changed after some guest members were created but before others were created. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -203,7 +220,8 @@ Note, if this template is edited on an existing group the previous template valu [account]: #account #### [account] The account for this scaling group. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -213,7 +231,8 @@ The account for this scaling group. [loadBalancers]: #loadbalancers #### [loadBalancers] Collection of load balancers for this auto scale group. -Type: **SoftLayer_Scale_LoadBalancer[] ** +Type: **SoftLayer_Scale_LoadBalancer[] ** + @@ -223,7 +242,8 @@ Collection of load balancers for this auto scale group. [logs]: #logs #### [logs] Collection of log entries for this group. -Type: **SoftLayer_Scale_Group_Log[] ** +Type: **SoftLayer_Scale_Group_Log[] ** + @@ -233,7 +253,8 @@ Collection of log entries for this group. [networkVlans]: #networkvlans #### [networkVlans] Collection of VLANs for this auto scale group. VLANs are optional. This can contain a public or private VLAN or both. When a single VLAN for a public/private type is given it can be a non-purchased VLAN only if the minimumMemberCount on the group is >= 1. This can also contain any number of public/private purchased VLANs and members are staggered across them when scaled up. -Type: **SoftLayer_Scale_Network_Vlan[] ** +Type: **SoftLayer_Scale_Network_Vlan[] ** + @@ -243,7 +264,8 @@ Collection of VLANs for this auto scale group. VLANs are optional. This can cont [policies]: #policies #### [policies] Collection of policies for this group. This can be empty. -Type: **SoftLayer_Scale_Policy[] ** +Type: **SoftLayer_Scale_Policy[] ** + @@ -253,7 +275,8 @@ Collection of policies for this group. This can be empty. [regionalGroup]: #regionalgroup #### [regionalGroup] The regional group for this scale group. -Type: **SoftLayer_Location_Group_Regional ** +Type: **SoftLayer_Location_Group_Regional ** + @@ -263,7 +286,8 @@ The regional group for this scale group. [status]: #status #### [status] The status for this scale group. -Type: **SoftLayer_Scale_Group_Status ** +Type: **SoftLayer_Scale_Group_Status ** + @@ -273,7 +297,8 @@ The status for this scale group. [terminationPolicy]: #terminationpolicy #### [terminationPolicy] The termination policy for this scaling group. -Type: **SoftLayer_Scale_Termination_Policy ** +Type: **SoftLayer_Scale_Termination_Policy ** + @@ -283,7 +308,8 @@ The termination policy for this scaling group. [virtualGuestAssets]: #virtualguestassets #### [virtualGuestAssets] Collection of guests that have been pinned to this group. Guest assets are only used for certain trigger checks such as resource watches. They do not count towards the auto scaling guest counts of this group in anyway and are never automatically added or removed. -Type: **SoftLayer_Scale_Asset[] ** +Type: **SoftLayer_Scale_Asset[] ** + @@ -293,7 +319,8 @@ Collection of guests that have been pinned to this group. Guest assets are only [virtualGuestMembers]: #virtualguestmembers #### [virtualGuestMembers] Collection of guests that have been scaled with the group. When this group is active, the count of guests here is guaranteed to be between minimumMemberCount and maximumMemberCount inclusively. -Type: **SoftLayer_Scale_Member[] ** +Type: **SoftLayer_Scale_Member[] ** + @@ -305,7 +332,8 @@ Collection of guests that have been scaled with the group. When this group is ac [loadBalancerCount]: #loadbalancercount #### [loadBalancerCount] A count of collection of load balancers for this auto scale group. -Type: **unsigned long** +Type: **unsigned long** + @@ -315,7 +343,8 @@ A count of collection of load balancers for this auto scale group. [logCount]: #logcount #### [logCount] A count of collection of log entries for this group. -Type: **unsigned long** +Type: **unsigned long** + @@ -325,7 +354,8 @@ A count of collection of log entries for this group. [networkVlanCount]: #networkvlancount #### [networkVlanCount] A count of collection of VLANs for this auto scale group. VLANs are optional. This can contain a public or private VLAN or both. When a single VLAN for a public/private type is given it can be a non-purchased VLAN only if the minimumMemberCount on the group is >= 1. This can also contain any number of public/private purchased VLANs and members are staggered across them when scaled up. -Type: **unsigned long** +Type: **unsigned long** + @@ -335,7 +365,8 @@ A count of collection of VLANs for this auto scale group. VLANs are optional. Th [policyCount]: #policycount #### [policyCount] A count of collection of policies for this group. This can be empty. -Type: **unsigned long** +Type: **unsigned long** + @@ -345,7 +376,8 @@ A count of collection of policies for this group. This can be empty. [virtualGuestAssetCount]: #virtualguestassetcount #### [virtualGuestAssetCount] A count of collection of guests that have been pinned to this group. Guest assets are only used for certain trigger checks such as resource watches. They do not count towards the auto scaling guest counts of this group in anyway and are never automatically added or removed. -Type: **unsigned long** +Type: **unsigned long** + @@ -355,7 +387,8 @@ A count of collection of guests that have been pinned to this group. Guest asset [virtualGuestMemberCount]: #virtualguestmembercount #### [virtualGuestMemberCount] A count of collection of guests that have been scaled with the group. When this group is active, the count of guests here is guaranteed to be between minimumMemberCount and maximumMemberCount inclusively. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Group_Log/_index.md b/content/reference/datatypes/SoftLayer_Scale_Group_Log/_index.md index 401ce97e55..ba262ed7b8 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Group_Log/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Group_Log/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] When this event occurred. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ When this event occurred. [description]: #description #### [description] A textual description of what happened during this action. -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ A textual description of what happened during this action. [id]: #id #### [id] This log's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ This log's internal identifier. [scaleGroupId]: #scalegroupid #### [scaleGroupId] The identifier of the group this log refers to. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The identifier of the group this log refers to. [scaleGroup]: #scalegroup #### [scaleGroup] The group this log refers to. -Type: **SoftLayer_Scale_Group ** +Type: **SoftLayer_Scale_Group ** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Group_Status/_index.md b/content/reference/datatypes/SoftLayer_Scale_Group_Status/_index.md index 1cbb81413e..94434766e8 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Group_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Group_Status/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] A status's internal identifier. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ A status's internal identifier. [keyName]: #keyname #### [keyName] A status's programmatic name. -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ A status's programmatic name. [name]: #name #### [name] A status's human-friendly name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Scale_LoadBalancer/_index.md b/content/reference/datatypes/SoftLayer_Scale_LoadBalancer/_index.md index 1c14c2bed1..85b203d654 100644 --- a/content/reference/datatypes/SoftLayer_Scale_LoadBalancer/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_LoadBalancer/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] When this load balancer configuration was created. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ When this load balancer configuration was created. [deleteFlag]: #deleteflag #### [deleteFlag] When set and true any edit that happens on this object, be it calling edit on this directly or setting as a child while editing a parent object, will end up being a deletion. -Type: **boolean** +Type: **boolean** +
              @@ -65,7 +69,8 @@ When set and true any edit that happens on this object, be it calling edit on th [healthCheckId]: #healthcheckid #### [healthCheckId] The identifier for the health check of this load balancer configuration -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The identifier for the health check of this load balancer configuration [id]: #id #### [id] The load balancer configuration's internal identifier. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The load balancer configuration's internal identifier. [modifyDate]: #modifydate #### [modifyDate] When this load balancer configuration was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ When this load balancer configuration was last modified. [port]: #port #### [port] The port for this load balancer configuration. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The port for this load balancer configuration. [scaleGroupId]: #scalegroupid #### [scaleGroupId] The identifier of the group this load balancer configuration applies to. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ The identifier of the group this load balancer configuration applies to. [virtualServerId]: #virtualserverid #### [virtualServerId] The identifier of the virtual server this load balancer configuration uses. -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ The identifier of the virtual server this load balancer configuration uses. [allocationPercent]: #allocationpercent #### [allocationPercent] The percentage of connections allocated to this virtual server. -Type: **integer** +Type: **integer** + @@ -141,7 +152,8 @@ The percentage of connections allocated to this virtual server. [healthCheck]: #healthcheck #### [healthCheck] The health check for this configuration. -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check ** + @@ -151,7 +163,8 @@ The health check for this configuration. [routingMethod]: #routingmethod #### [routingMethod] The routing method. -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method ** + @@ -161,7 +174,8 @@ The routing method. [routingType]: #routingtype #### [routingType] The routing type. -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type ** + @@ -171,7 +185,8 @@ The routing type. [scaleGroup]: #scalegroup #### [scaleGroup] The group this load balancer configuration is for. -Type: **SoftLayer_Scale_Group ** +Type: **SoftLayer_Scale_Group ** + @@ -181,7 +196,8 @@ The group this load balancer configuration is for. [virtualIpAddressId]: #virtualipaddressid #### [virtualIpAddressId] The ID of the virtual IP address. -Type: **integer** +Type: **integer** + @@ -191,7 +207,8 @@ The ID of the virtual IP address. [virtualServer]: #virtualserver #### [virtualServer] The virtual server for this configuration. -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer ** + @@ -201,7 +218,8 @@ The virtual server for this configuration. [virtualServerPort]: #virtualserverport #### [virtualServerPort] The port on the virtual server. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Member/_index.md b/content/reference/datatypes/SoftLayer_Scale_Member/_index.md index cae93b6195..67ba862a19 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Member/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Member/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] When this member was created. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ When this member was created. [id]: #id #### [id] A member's internal identifier. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ A member's internal identifier. [scaleGroupId]: #scalegroupid #### [scaleGroupId] The identifier of the group this member belongs to. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ The identifier of the group this member belongs to. [scaleGroup]: #scalegroup #### [scaleGroup] The group this member belongs to. -Type: **SoftLayer_Scale_Group ** +Type: **SoftLayer_Scale_Group ** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Member_Virtual_Guest/_index.md b/content/reference/datatypes/SoftLayer_Scale_Member_Virtual_Guest/_index.md index e2e1d9e83e..6581145354 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Member_Virtual_Guest/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Member_Virtual_Guest/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] When this member was created. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ When this member was created. [id]: #id #### [id] A member's internal identifier. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ A member's internal identifier. [scaleGroupId]: #scalegroupid #### [scaleGroupId] The identifier of the group this member belongs to. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ The identifier of the group this member belongs to. [scaleGroup]: #scalegroup #### [scaleGroup] The group this member belongs to. -Type: **SoftLayer_Scale_Group ** +Type: **SoftLayer_Scale_Group ** + @@ -91,7 +97,8 @@ The group this member belongs to. [virtualGuest]: #virtualguest #### [virtualGuest] The guest for this member. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -101,7 +108,8 @@ The guest for this member. [virtualGuestId]: #virtualguestid #### [virtualGuestId] The identifier of the guest for this member. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Network_Vlan/_index.md b/content/reference/datatypes/SoftLayer_Scale_Network_Vlan/_index.md index 5fe8cd39fd..b34566e114 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Network_Vlan/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Network_Vlan/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] When this network VLAN reference was created. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ When this network VLAN reference was created. [deleteFlag]: #deleteflag #### [deleteFlag] When set and true any edit that happens on this object, be it calling edit on this directly or setting as a child while editing a parent object, will end up being a deletion. -Type: **boolean** +Type: **boolean** +
              @@ -65,7 +69,8 @@ When set and true any edit that happens on this object, be it calling edit on th [id]: #id #### [id] The network VLAN reference's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The network VLAN reference's internal identifier. [networkVlanId]: #networkvlanid #### [networkVlanId] The identifier for the VLAN to scale with. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The identifier for the VLAN to scale with. [scaleGroupId]: #scalegroupid #### [scaleGroupId] The identifier of the group this network VLAN reference applies to. -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ The identifier of the group this network VLAN reference applies to. [networkVlan]: #networkvlan #### [networkVlan] The network VLAN to scale with. -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + @@ -111,7 +119,8 @@ The network VLAN to scale with. [scaleGroup]: #scalegroup #### [scaleGroup] The group this network VLAN is for. -Type: **SoftLayer_Scale_Group ** +Type: **SoftLayer_Scale_Group ** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Policy/_index.md b/content/reference/datatypes/SoftLayer_Scale_Policy/_index.md index faf39bff18..8613afcea4 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Policy/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Policy/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [cooldown]: #cooldown #### [cooldown] The number of seconds this policy will wait after lastActionDate on group before performing another action. If not present, the group's cooldown value is used. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ The number of seconds this policy will wait after lastActionDate on group before [createDate]: #createdate #### [createDate] When this policy was created. -Type: **dateTime** +Type: **dateTime** +
              @@ -65,7 +69,8 @@ When this policy was created. [deleteFlag]: #deleteflag #### [deleteFlag] When set and true any edit that happens on this object, be it calling edit on this directly or setting as a child while editing a parent object, will end up being a deletion. -Type: **boolean** +Type: **boolean** + @@ -75,7 +80,8 @@ When set and true any edit that happens on this object, be it calling edit on th [id]: #id #### [id] A policy's internal identifier. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ A policy's internal identifier. [modifyDate]: #modifydate #### [modifyDate] When this policy was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ When this policy was last modified. [name]: #name #### [name] The name of this policy. It must be unique within the group. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The name of this policy. It must be unique within the group. [scaleGroupId]: #scalegroupid #### [scaleGroupId] The identifier of the group this member belongs to. -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ The identifier of the group this member belongs to. [actions]: #actions #### [actions] The actions to perform upon any trigger hit. Currently this must be a single value. -Type: **SoftLayer_Scale_Policy_Action[] ** +Type: **SoftLayer_Scale_Policy_Action[] ** + @@ -131,7 +141,8 @@ The actions to perform upon any trigger hit. Currently this must be a single val [oneTimeTriggers]: #onetimetriggers #### [oneTimeTriggers] The one-time triggers to check for this group. -Type: **SoftLayer_Scale_Policy_Trigger[] ** +Type: **SoftLayer_Scale_Policy_Trigger[] ** + @@ -141,7 +152,8 @@ The one-time triggers to check for this group. [repeatingTriggers]: #repeatingtriggers #### [repeatingTriggers] The repeating triggers to check for this group. -Type: **SoftLayer_Scale_Policy_Trigger[] ** +Type: **SoftLayer_Scale_Policy_Trigger[] ** + @@ -151,7 +163,8 @@ The repeating triggers to check for this group. [resourceUseTriggers]: #resourceusetriggers #### [resourceUseTriggers] The resource-use triggers to check for this group. -Type: **SoftLayer_Scale_Policy_Trigger[] ** +Type: **SoftLayer_Scale_Policy_Trigger[] ** + @@ -161,7 +174,8 @@ The resource-use triggers to check for this group. [scaleActions]: #scaleactions #### [scaleActions] The scale actions to perform upon any trigger hit. Currently this must be a single value. -Type: **SoftLayer_Scale_Policy_Action[] ** +Type: **SoftLayer_Scale_Policy_Action[] ** + @@ -171,7 +185,8 @@ The scale actions to perform upon any trigger hit. Currently this must be a sing [scaleGroup]: #scalegroup #### [scaleGroup] The group this policy is on. -Type: **SoftLayer_Scale_Group ** +Type: **SoftLayer_Scale_Group ** + @@ -181,7 +196,8 @@ The group this policy is on. [triggers]: #triggers #### [triggers] The triggers to check for this group. -Type: **SoftLayer_Scale_Policy_Trigger[] ** +Type: **SoftLayer_Scale_Policy_Trigger[] ** + @@ -193,7 +209,8 @@ The triggers to check for this group. [actionCount]: #actioncount #### [actionCount] A count of the actions to perform upon any trigger hit. Currently this must be a single value. -Type: **unsigned long** +Type: **unsigned long** + @@ -203,7 +220,8 @@ A count of the actions to perform upon any trigger hit. Currently this must be a [oneTimeTriggerCount]: #onetimetriggercount #### [oneTimeTriggerCount] A count of the one-time triggers to check for this group. -Type: **unsigned long** +Type: **unsigned long** + @@ -213,7 +231,8 @@ A count of the one-time triggers to check for this group. [repeatingTriggerCount]: #repeatingtriggercount #### [repeatingTriggerCount] A count of the repeating triggers to check for this group. -Type: **unsigned long** +Type: **unsigned long** + @@ -223,7 +242,8 @@ A count of the repeating triggers to check for this group. [resourceUseTriggerCount]: #resourceusetriggercount #### [resourceUseTriggerCount] A count of the resource-use triggers to check for this group. -Type: **unsigned long** +Type: **unsigned long** + @@ -233,7 +253,8 @@ A count of the resource-use triggers to check for this group. [scaleActionCount]: #scaleactioncount #### [scaleActionCount] A count of the scale actions to perform upon any trigger hit. Currently this must be a single value. -Type: **unsigned long** +Type: **unsigned long** + @@ -243,7 +264,8 @@ A count of the scale actions to perform upon any trigger hit. Currently this mus [triggerCount]: #triggercount #### [triggerCount] A count of the triggers to check for this group. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Policy_Action/_index.md b/content/reference/datatypes/SoftLayer_Scale_Policy_Action/_index.md index f63e80dada..1ee51f58c0 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Policy_Action/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Policy_Action/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] When this action was created. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ When this action was created. [deleteFlag]: #deleteflag #### [deleteFlag] When set and true any edit that happens on this object, be it calling edit on this directly or setting as a child while editing a parent object, will end up being a deletion. -Type: **boolean** +Type: **boolean** +
              @@ -65,7 +69,8 @@ When set and true any edit that happens on this object, be it calling edit on th [id]: #id #### [id] An action's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ An action's internal identifier. [modifyDate]: #modifydate #### [modifyDate] Then this action was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ Then this action was last modified. [scalePolicyId]: #scalepolicyid #### [scalePolicyId] The policy this action is on. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The policy this action is on. [typeId]: #typeid #### [typeId] The identifier of this action's type. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The identifier of this action's type. [scalePolicy]: #scalepolicy #### [scalePolicy] The policy this action is on. -Type: **SoftLayer_Scale_Policy ** +Type: **SoftLayer_Scale_Policy ** + @@ -121,7 +130,8 @@ The policy this action is on. [type]: #type #### [type] The type of action. -Type: **SoftLayer_Scale_Policy_Action_Type ** +Type: **SoftLayer_Scale_Policy_Action_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Policy_Action_Scale/_index.md b/content/reference/datatypes/SoftLayer_Scale_Policy_Action_Scale/_index.md index 95c237eaf5..d97d5485be 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Policy_Action_Scale/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Policy_Action_Scale/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [amount]: #amount #### [amount] The number to scale by. This number has different meanings based on type. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ The number to scale by. This number has different meanings based on type. [createDate]: #createdate #### [createDate] When this action was created. -Type: **dateTime** +Type: **dateTime** +
              @@ -65,7 +69,8 @@ When this action was created. [deleteFlag]: #deleteflag #### [deleteFlag] When set and true any edit that happens on this object, be it calling edit on this directly or setting as a child while editing a parent object, will end up being a deletion. -Type: **boolean** +Type: **boolean** + @@ -75,7 +80,8 @@ When set and true any edit that happens on this object, be it calling edit on th [id]: #id #### [id] An action's internal identifier. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ An action's internal identifier. [modifyDate]: #modifydate #### [modifyDate] Then this action was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ Then this action was last modified. [scalePolicyId]: #scalepolicyid #### [scalePolicyId] The policy this action is on. -Type: **integer** +Type: **integer** + @@ -112,7 +120,8 @@ down or not at all. If the amount is outside of the min/max range of the group, * PERCENT - Scale the group up or down based on the positive or negative percentage given in amount. The number is a percent of the current group member count. Any extra percent after the decimal point is always ignored. If the resulting amount is zero, -1 or 1 is used depending upon whether the percentage was negative or positive respectively. * RELATIVE - Scale the group up or down by the positive or negative value given in amount. -Type: **string** +Type: **string** + @@ -122,7 +131,8 @@ number is a percent of the current group member count. Any extra percent after t [typeId]: #typeid #### [typeId] The identifier of this action's type. -Type: **integer** +Type: **integer** + @@ -138,7 +148,8 @@ The identifier of this action's type. [scalePolicy]: #scalepolicy #### [scalePolicy] The policy this action is on. -Type: **SoftLayer_Scale_Policy ** +Type: **SoftLayer_Scale_Policy ** + @@ -148,7 +159,8 @@ The policy this action is on. [type]: #type #### [type] The type of action. -Type: **SoftLayer_Scale_Policy_Action_Type ** +Type: **SoftLayer_Scale_Policy_Action_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Policy_Action_Type/_index.md b/content/reference/datatypes/SoftLayer_Scale_Policy_Action_Type/_index.md index c0fc6a2813..29dd438fce 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Policy_Action_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Policy_Action_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] This type's internal identifier. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ This type's internal identifier. [keyName]: #keyname #### [keyName] An action type's programmatic name. -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ An action type's programmatic name. [name]: #name #### [name] An action type's human-friendly name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger/_index.md b/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger/_index.md index 6639c0dc0a..387e43987f 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] When this trigger was created. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ When this trigger was created. [deleteFlag]: #deleteflag #### [deleteFlag] When set and true any edit that happens on this object, be it calling edit on this directly or setting as a child while editing a parent object, will end up being a deletion. -Type: **boolean** +Type: **boolean** +
              @@ -65,7 +69,8 @@ When set and true any edit that happens on this object, be it calling edit on th [id]: #id #### [id] A trigger's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A trigger's internal identifier. [modifyDate]: #modifydate #### [modifyDate] When this trigger was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ When this trigger was last modified. [scalePolicyId]: #scalepolicyid #### [scalePolicyId] The policy this trigger is on. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The policy this trigger is on. [typeId]: #typeid #### [typeId] The type of trigger this is. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The type of trigger this is. [scalePolicy]: #scalepolicy #### [scalePolicy] The policy this trigger is on. -Type: **SoftLayer_Scale_Policy ** +Type: **SoftLayer_Scale_Policy ** + @@ -121,7 +130,8 @@ The policy this trigger is on. [type]: #type #### [type] The type of trigger. -Type: **SoftLayer_Scale_Policy_Trigger_Type ** +Type: **SoftLayer_Scale_Policy_Trigger_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_OneTime/_index.md b/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_OneTime/_index.md index 98db864eb5..089d0f2383 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_OneTime/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_OneTime/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] When this trigger was created. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ When this trigger was created. [date]: #date #### [date] The date to execute the policy. -Type: **dateTime** +Type: **dateTime** +
              @@ -65,7 +69,8 @@ The date to execute the policy. [deleteFlag]: #deleteflag #### [deleteFlag] When set and true any edit that happens on this object, be it calling edit on this directly or setting as a child while editing a parent object, will end up being a deletion. -Type: **boolean** +Type: **boolean** + @@ -75,7 +80,8 @@ When set and true any edit that happens on this object, be it calling edit on th [id]: #id #### [id] A trigger's internal identifier. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ A trigger's internal identifier. [modifyDate]: #modifydate #### [modifyDate] When this trigger was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ When this trigger was last modified. [scalePolicyId]: #scalepolicyid #### [scalePolicyId] The policy this trigger is on. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The policy this trigger is on. [typeId]: #typeid #### [typeId] The type of trigger this is. -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ The type of trigger this is. [scalePolicy]: #scalepolicy #### [scalePolicy] The policy this trigger is on. -Type: **SoftLayer_Scale_Policy ** +Type: **SoftLayer_Scale_Policy ** + @@ -131,7 +141,8 @@ The policy this trigger is on. [type]: #type #### [type] The type of trigger. -Type: **SoftLayer_Scale_Policy_Trigger_Type ** +Type: **SoftLayer_Scale_Policy_Trigger_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_Repeating/_index.md b/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_Repeating/_index.md index f841d8e52b..1a248441b5 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_Repeating/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_Repeating/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] When this trigger was created. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ When this trigger was created. [deleteFlag]: #deleteflag #### [deleteFlag] When set and true any edit that happens on this object, be it calling edit on this directly or setting as a child while editing a parent object, will end up being a deletion. -Type: **boolean** +Type: **boolean** +
              @@ -65,7 +69,8 @@ When set and true any edit that happens on this object, be it calling edit on th [id]: #id #### [id] A trigger's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A trigger's internal identifier. [modifyDate]: #modifydate #### [modifyDate] When this trigger was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ When this trigger was last modified. [scalePolicyId]: #scalepolicyid #### [scalePolicyId] The policy this trigger is on. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The policy this trigger is on. [schedule]: #schedule #### [schedule] The cron-formatted schedule. This is run in the UTC timezone. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The cron-formatted schedule. This is run in the UTC timezone. [typeId]: #typeid #### [typeId] The type of trigger this is. -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ The type of trigger this is. [scalePolicy]: #scalepolicy #### [scalePolicy] The policy this trigger is on. -Type: **SoftLayer_Scale_Policy ** +Type: **SoftLayer_Scale_Policy ** + @@ -131,7 +141,8 @@ The policy this trigger is on. [type]: #type #### [type] The type of trigger. -Type: **SoftLayer_Scale_Policy_Trigger_Type ** +Type: **SoftLayer_Scale_Policy_Trigger_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_ResourceUse/_index.md b/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_ResourceUse/_index.md index f81235a0ff..720834abfc 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_ResourceUse/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_ResourceUse/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] When this trigger was created. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ When this trigger was created. [deleteFlag]: #deleteflag #### [deleteFlag] When set and true any edit that happens on this object, be it calling edit on this directly or setting as a child while editing a parent object, will end up being a deletion. -Type: **boolean** +Type: **boolean** +
              @@ -65,7 +69,8 @@ When set and true any edit that happens on this object, be it calling edit on th [id]: #id #### [id] A trigger's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A trigger's internal identifier. [modifyDate]: #modifydate #### [modifyDate] When this trigger was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ When this trigger was last modified. [scalePolicyId]: #scalepolicyid #### [scalePolicyId] The policy this trigger is on. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The policy this trigger is on. [typeId]: #typeid #### [typeId] The type of trigger this is. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The type of trigger this is. [scalePolicy]: #scalepolicy #### [scalePolicy] The policy this trigger is on. -Type: **SoftLayer_Scale_Policy ** +Type: **SoftLayer_Scale_Policy ** + @@ -121,7 +130,8 @@ The policy this trigger is on. [type]: #type #### [type] The type of trigger. -Type: **SoftLayer_Scale_Policy_Trigger_Type ** +Type: **SoftLayer_Scale_Policy_Trigger_Type ** + @@ -131,7 +141,8 @@ The type of trigger. [watches]: #watches #### [watches] The resource watches for this trigger. -Type: **SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch[] ** +Type: **SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch[] ** + @@ -143,7 +154,8 @@ The resource watches for this trigger. [watchCount]: #watchcount #### [watchCount] A count of the resource watches for this trigger. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/_index.md b/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/_index.md index c3f60eb6a9..f440d56f78 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [algorithm]: #algorithm #### [algorithm] The algorithm to use when aggregating and comparing. Currently, the only value that is accepted is EWMA (Exponential Weighted Moving Average). EWMA is the default value if no value is given. -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ The algorithm to use when aggregating and comparing. Currently, the only value t [createDate]: #createdate #### [createDate] When this watch was created. -Type: **dateTime** +Type: **dateTime** +
              @@ -65,7 +69,8 @@ When this watch was created. [deleteFlag]: #deleteflag #### [deleteFlag] When set and true any edit that happens on this object, be it calling edit on this directly or setting as a child while editing a parent object, will end up being a deletion. -Type: **boolean** +Type: **boolean** + @@ -75,7 +80,8 @@ When set and true any edit that happens on this object, be it calling edit on th [id]: #id #### [id] A watch's internal identifier. -Type: **integer** +Type: **integer** + @@ -92,7 +98,8 @@ The metric to watch. Possible values: of either the frontend or backend network. * host.network.backend.out and host.network.frontend.out - The network bytes-per-second incoming on the interface of either the frontend or backend network. -Type: **string** +Type: **string** + @@ -102,7 +109,8 @@ of either the frontend or backend network. [modifyDate]: #modifydate #### [modifyDate] When this watch was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -112,7 +120,8 @@ When this watch was last modified. [operator]: #operator #### [operator] The operator to use for comparison. The only two valid values are ">" and "<". -Type: **string** +Type: **string** + @@ -122,7 +131,8 @@ The operator to use for comparison. The only two valid values are ">" and "<". [period]: #period #### [period] The number of seconds the values are aggregated for when compared to value. If values are not retrieved steadily and consecutively for the length of this period, nothing is compared. -Type: **integer** +Type: **integer** + @@ -132,7 +142,8 @@ The number of seconds the values are aggregated for when compared to value. If v [scalePolicyTriggerId]: #scalepolicytriggerid #### [scalePolicyTriggerId] The trigger this watch is on. -Type: **integer** +Type: **integer** + @@ -142,7 +153,8 @@ The trigger this watch is on. [value]: #value #### [value] The value to compare against. Although the value is a string, validation will be done on the value for restrictions (such as numeric-only) based on the metric. -Type: **string** +Type: **string** + @@ -158,7 +170,8 @@ The value to compare against. Although the value is a string, validation will be [scalePolicyTrigger]: #scalepolicytrigger #### [scalePolicyTrigger] The trigger this watch is on. -Type: **SoftLayer_Scale_Policy_Trigger_ResourceUse ** +Type: **SoftLayer_Scale_Policy_Trigger_ResourceUse ** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_Type/_index.md b/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_Type/_index.md index 5245f7b063..6ee65ef0eb 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Policy_Trigger_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] A trigger type's internal identifier. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ A trigger type's internal identifier. [keyName]: #keyname #### [keyName] A trigger type's programmatic name. -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ A trigger type's programmatic name. [name]: #name #### [name] A trigger type's human-friendly name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Scale_Termination_Policy/_index.md b/content/reference/datatypes/SoftLayer_Scale_Termination_Policy/_index.md index 21731531c2..f382ddf7c9 100644 --- a/content/reference/datatypes/SoftLayer_Scale_Termination_Policy/_index.md +++ b/content/reference/datatypes/SoftLayer_Scale_Termination_Policy/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] A termination policy's internal identifier. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ A termination policy's internal identifier. [keyName]: #keyname #### [keyName] A termination policy's programmatic name. -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ A termination policy's programmatic name. [name]: #name #### [name] A termination policy's human-friendly name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Security_Certificate/_index.md b/content/reference/datatypes/SoftLayer_Security_Certificate/_index.md index f99bb9b92c..367016c71b 100644 --- a/content/reference/datatypes/SoftLayer_Security_Certificate/_index.md +++ b/content/reference/datatypes/SoftLayer_Security_Certificate/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -47,7 +49,8 @@ classes: The certificate provided publicly to clients requesting identity credentials. This certificate is usually signed by a source trusted by the client or a signature chain can be established between this certificate and the truested certificate. This property may only be modified when no services are associated. See associatedServiceCount. -Type: **string** +Type: **string** +
              @@ -59,7 +62,8 @@ This property may only be modified when no services are associated. See associat The signing request used to request a certificate authority generate a signed certificate. This property may only be modified when no services are associated. See associatedServiceCount. -Type: **string** +Type: **string** +
              @@ -71,7 +75,8 @@ This property may only be modified when no services are associated. See associat The common name (usually a domain name) encoded within the certificate. This property is read only. Changes made will be silently ignored. -Type: **string** +Type: **string** + @@ -83,7 +88,8 @@ This property is read only. Changes made will be silently ignored. The date the certificate _record_ was created. The contents of the certificate may of changed since the record was created, so this does not represent anything about the certificate itself. This property is read only. Changes made will be silently ignored. -Type: **dateTime** +Type: **dateTime** + @@ -93,7 +99,8 @@ This property is read only. Changes made will be silently ignored. [id]: #id #### [id] The ID of the certificate record. -Type: **integer** +Type: **integer** + @@ -105,7 +112,8 @@ The ID of the certificate record. The intermediate certificate authorities certificate that completes the certificate chain for the issued certificate. Required when clients will only trust the root certificate. This property may only be modified when no services are associated. See associatedServiceCount. -Type: **string** +Type: **string** + @@ -115,7 +123,8 @@ This property may only be modified when no services are associated. See associat [keySize]: #keysize #### [keySize] The size (number of bits) of the public key represented by the certificate. -Type: **integer** +Type: **integer** + @@ -127,7 +136,8 @@ The size (number of bits) of the public key represented by the certificate. The date the certificate _record_ was last modified.The contents of the certificate may of changed since the record was created, so this does not represent anything about the certificate itself. This property is read only. Changes made will be silently ignored. -Type: **dateTime** +Type: **dateTime** + @@ -137,7 +147,8 @@ This property is read only. Changes made will be silently ignored. [notes]: #notes #### [notes] A note to help describe the certificate. -Type: **string** +Type: **string** + @@ -149,7 +160,8 @@ A note to help describe the certificate. The organizational name encoded in the certificate. This property is read only. Changes made will be silently ignored. -Type: **string** +Type: **string** + @@ -161,7 +173,8 @@ This property is read only. Changes made will be silently ignored. The private key in the key/certificate pair. This property may only be modified when no services are associated. See associatedServiceCount. -Type: **string** +Type: **string** + @@ -173,7 +186,8 @@ This property may only be modified when no services are associated. See associat The UTC timestamp representing the beginning of the certificate's validity This property is read only. Changes made will be silently ignored. -Type: **dateTime** +Type: **dateTime** + @@ -185,7 +199,8 @@ This property is read only. Changes made will be silently ignored. The number of days remaining in the validity period for the certificate. This property is read only. Changes made will be silently ignored. -Type: **integer** +Type: **integer** + @@ -197,7 +212,8 @@ This property is read only. Changes made will be silently ignored. The UTC timestamp representing the end of the certificate's validity period. This property is read only. Changes made will be silently ignored. -Type: **dateTime** +Type: **dateTime** + @@ -213,7 +229,8 @@ This property is read only. Changes made will be silently ignored. [associatedServiceCount]: #associatedservicecount #### [associatedServiceCount] The number of services currently associated with the certificate. -Type: **integer** +Type: **integer** + @@ -223,7 +240,8 @@ The number of services currently associated with the certificate. [lbaasListeners]: #lbaaslisteners #### [lbaasListeners] Cloud Load Balancer [LBaaS] listeners currently associated with the certificate. -Type: **SoftLayer_Network_LBaaS_Listener[] ** +Type: **SoftLayer_Network_LBaaS_Listener[] ** + @@ -233,7 +251,8 @@ Cloud Load Balancer [LBaaS] listeners currently associated with the certificate. [loadBalancerVirtualIpAddresses]: #loadbalancervirtualipaddresses #### [loadBalancerVirtualIpAddresses] The load balancers virtual IP addresses currently associated with the certificate. -Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress[] ** +Type: **SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress[] ** + @@ -245,7 +264,8 @@ The load balancers virtual IP addresses currently associated with the certificat [lbaasListenerCount]: #lbaaslistenercount #### [lbaasListenerCount] A count of cloud Load Balancer [LBaaS] listeners currently associated with the certificate. -Type: **unsigned long** +Type: **unsigned long** + @@ -255,7 +275,8 @@ A count of cloud Load Balancer [LBaaS] listeners currently associated with the c [loadBalancerVirtualIpAddressCount]: #loadbalancervirtualipaddresscount #### [loadBalancerVirtualIpAddressCount] A count of the load balancers virtual IP addresses currently associated with the certificate. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Security_Certificate_Entry/_index.md b/content/reference/datatypes/SoftLayer_Security_Certificate_Entry/_index.md index f79043bc0d..a262730d35 100644 --- a/content/reference/datatypes/SoftLayer_Security_Certificate_Entry/_index.md +++ b/content/reference/datatypes/SoftLayer_Security_Certificate_Entry/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [certificateId]: #certificateid #### [certificateId] The ID of the certificate record. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ The ID of the certificate record. [commonName]: #commonname #### [commonName] The common name (usually a domain name) encoded within the certificate. -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ The common name (usually a domain name) encoded within the certificate. [keySize]: #keysize #### [keySize] The size (number of bits) of the public key represented by the certificate. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The size (number of bits) of the public key represented by the certificate. [organizationName]: #organizationname #### [organizationName] The organizational name encoded in the certificate. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The organizational name encoded in the certificate. [validityBegin]: #validitybegin #### [validityBegin] The UTC timestamp representing the beginning of the certificate's validity -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The UTC timestamp representing the beginning of the certificate's validity [validityDays]: #validitydays #### [validityDays] The number of days remaining in the validity period for the certificate. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The number of days remaining in the validity period for the certificate. [validityEnd]: #validityend #### [validityEnd] The UTC timestamp representing the end of the certificate's validity period. -Type: **dateTime** +Type: **dateTime** + diff --git a/content/reference/datatypes/SoftLayer_Security_Certificate_Request/_index.md b/content/reference/datatypes/SoftLayer_Security_Certificate_Request/_index.md index e6e0d028cf..006dd0dc41 100644 --- a/content/reference/datatypes/SoftLayer_Security_Certificate_Request/_index.md +++ b/content/reference/datatypes/SoftLayer_Security_Certificate_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Security_Certificate_Request data type is used to view details abo [accountId]: #accountid #### [accountId] This is a reference to your SoftLayer account. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ This is a reference to your SoftLayer account. [approverEmailAddress]: #approveremailaddress #### [approverEmailAddress] The email address of a person who will approve your SSL certificate order. This is usually an email address of your domain administrator. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The email address of a person who will approve your SSL certificate order. This [certificateSigningRequest]: #certificatesigningrequest #### [certificateSigningRequest] A Certificate Signing Request (CSR) string -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ A Certificate Signing Request (CSR) string [commonName]: #commonname #### [commonName] A domain name of a SSL certificate request -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ A domain name of a SSL certificate request [createDate]: #createdate #### [createDate] The date a SSL certificate request was created. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date a SSL certificate request was created. [effectiveDate]: #effectivedate #### [effectiveDate] The date of your SSL certificate went into effect -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ The date of your SSL certificate went into effect [expirationDate]: #expirationdate #### [expirationDate] The expiration date of your SSL certificate -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The expiration date of your SSL certificate [id]: #id #### [id] The internal identifier of an SSL certificate request -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ The internal identifier of an SSL certificate request [modifyDate]: #modifydate #### [modifyDate] The date a SSL certificate request was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -135,7 +146,8 @@ The date a SSL certificate request was last modified. [statusId]: #statusid #### [statusId] A status id reflecting the state of a SSL certificate request -Type: **integer** +Type: **integer** + @@ -145,7 +157,8 @@ A status id reflecting the state of a SSL certificate request [technicalContactEmailAddress]: #technicalcontactemailaddress #### [technicalContactEmailAddress] The technical contact email address. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ The technical contact email address. [account]: #account #### [account] The account to which a SSL certificate request belongs. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -171,7 +185,8 @@ The account to which a SSL certificate request belongs. [order]: #order #### [order] The order contains the information related to a SSL certificate request. -Type: **SoftLayer_Billing_Order ** +Type: **SoftLayer_Billing_Order ** + @@ -181,7 +196,8 @@ The order contains the information related to a SSL certificate request. [orderItem]: #orderitem #### [orderItem] The associated order item for this SSL certificate request. -Type: **SoftLayer_Billing_Order_Item ** +Type: **SoftLayer_Billing_Order_Item ** + @@ -191,7 +207,8 @@ The associated order item for this SSL certificate request. [status]: #status #### [status] The status of a SSL certificate request. -Type: **SoftLayer_Security_Certificate_Request_Status ** +Type: **SoftLayer_Security_Certificate_Request_Status ** + diff --git a/content/reference/datatypes/SoftLayer_Security_Certificate_Request_ServerType/_index.md b/content/reference/datatypes/SoftLayer_Security_Certificate_Request_ServerType/_index.md index d7a1cda6f4..0985d8671a 100644 --- a/content/reference/datatypes/SoftLayer_Security_Certificate_Request_ServerType/_index.md +++ b/content/reference/datatypes/SoftLayer_Security_Certificate_Request_ServerType/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Represents a server type that can be specified when ordering an SSL certificate. @@ -45,7 +47,8 @@ Represents a server type that can be specified when ordering an SSL certificate. [description]: #description #### [description] The description of the certificate server type. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The description of the certificate server type. [id]: #id #### [id] The internal identifier of the certificate server type. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The internal identifier of the certificate server type. [name]: #name #### [name] The name of the certificate server type. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The name of the certificate server type. [value]: #value #### [value] The value of the certificate server type. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Security_Certificate_Request_Status/_index.md b/content/reference/datatypes/SoftLayer_Security_Certificate_Request_Status/_index.md index 34474fe671..84ab709e54 100644 --- a/content/reference/datatypes/SoftLayer_Security_Certificate_Request_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Security_Certificate_Request_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Represents the status of an SSL certificate request. @@ -45,7 +47,8 @@ Represents the status of an SSL certificate request. [description]: #description #### [description] The description of a SSL certificate request status -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The description of a SSL certificate request status [id]: #id #### [id] The internal identifier of an SSL certificate request status -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The internal identifier of an SSL certificate request status [name]: #name #### [name] The status name -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Security_Directory_Service_Host_Xref_Hardware/_index.md b/content/reference/datatypes/SoftLayer_Security_Directory_Service_Host_Xref_Hardware/_index.md index 7c0fae35e5..65c2abb140 100644 --- a/content/reference/datatypes/SoftLayer_Security_Directory_Service_Host_Xref_Hardware/_index.md +++ b/content/reference/datatypes/SoftLayer_Security_Directory_Service_Host_Xref_Hardware/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Security_Directory_Service_Host_Xref_Hardware extends the [SoftLayer_Security_Directory_Service_Host_Xref]({{}}) data type to include hardware specific properties. @@ -56,7 +58,8 @@ SoftLayer_Security_Directory_Service_Host_Xref_Hardware extends the [SoftLayer_S [host]: #host #### [host] The hardware object. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + diff --git a/content/reference/datatypes/SoftLayer_Security_Level/_index.md b/content/reference/datatypes/SoftLayer_Security_Level/_index.md index 8cc5228ee8..e9c89fd65c 100644 --- a/content/reference/datatypes/SoftLayer_Security_Level/_index.md +++ b/content/reference/datatypes/SoftLayer_Security_Level/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Security_Level data type contains the security level restriction for the account @@ -45,7 +47,8 @@ The SoftLayer_Security_Level data type contains the security level restriction f [keyName]: #keyname #### [keyName] The unique name of the security level the account is under -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The unique name of the security level the account is under [name]: #name #### [name] The name of the security level the account is under -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Security_SecureTransportCipher/_index.md b/content/reference/datatypes/SoftLayer_Security_SecureTransportCipher/_index.md index f42bfc002c..72da829780 100644 --- a/content/reference/datatypes/SoftLayer_Security_SecureTransportCipher/_index.md +++ b/content/reference/datatypes/SoftLayer_Security_SecureTransportCipher/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Encryption algorithm intended for use in SSL/TLS communications @@ -50,7 +52,8 @@ Encryption algorithm intended for use in SSL/TLS communications [keyName]: #keyname #### [keyName] Unique identifier for the encryption algorithm -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Security_SecureTransportProtocol/_index.md b/content/reference/datatypes/SoftLayer_Security_SecureTransportProtocol/_index.md index f56cc3a327..33c88599bf 100644 --- a/content/reference/datatypes/SoftLayer_Security_SecureTransportProtocol/_index.md +++ b/content/reference/datatypes/SoftLayer_Security_SecureTransportProtocol/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Protocol intended for use in secure communications @@ -50,7 +52,8 @@ Protocol intended for use in secure communications [keyName]: #keyname #### [keyName] Unique identifier for the protocol -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ Unique identifier for the protocol [supportedSecureTransportCiphers]: #supportedsecuretransportciphers #### [supportedSecureTransportCiphers] List of the supported encryption ciphers -Type: **SoftLayer_Security_SecureTransportCipher[] ** +Type: **SoftLayer_Security_SecureTransportCipher[] ** + diff --git a/content/reference/datatypes/SoftLayer_Security_Ssh_Key/_index.md b/content/reference/datatypes/SoftLayer_Security_Ssh_Key/_index.md index eff1e7b11e..b4db64e9e9 100644 --- a/content/reference/datatypes/SoftLayer_Security_Ssh_Key/_index.md +++ b/content/reference/datatypes/SoftLayer_Security_Ssh_Key/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -47,7 +49,8 @@ classes: The date a ssh key was added. This property is read only. Changes made will be silently ignored. -Type: **dateTime** +Type: **dateTime** +
              @@ -59,7 +62,8 @@ This property is read only. Changes made will be silently ignored. A short sequence of bytes used to authenticate or lookup a longer ssh key. This will automatically be generated upon adding or modifying the ssh key. This property is read only. Changes made will be silently ignored. -Type: **string** +Type: **string** +
              @@ -69,7 +73,8 @@ This property is read only. Changes made will be silently ignored. [id]: #id #### [id] The ID of the ssh key record. -Type: **integer** +Type: **integer** + @@ -79,7 +84,8 @@ The ID of the ssh key record. [key]: #key #### [key] The ssh key. -Type: **string** +Type: **string** + @@ -89,7 +95,8 @@ The ssh key. [label]: #label #### [label] A descriptive name used to identify a ssh key. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ A descriptive name used to identify a ssh key. The date a ssh key was last modified. This property is read only. Changes made will be silently ignored. -Type: **dateTime** +Type: **dateTime** + @@ -111,7 +119,8 @@ This property is read only. Changes made will be silently ignored. [notes]: #notes #### [notes] A small note about a ssh key to use at your discretion. -Type: **string** +Type: **string** + @@ -127,7 +136,8 @@ A small note about a ssh key to use at your discretion. [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -137,7 +147,8 @@ A small note about a ssh key to use at your discretion. [blockDeviceTemplateGroups]: #blockdevicetemplategroups #### [blockDeviceTemplateGroups] The image template groups that are linked to an SSH key. -Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group[] ** +Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group[] ** + @@ -147,7 +158,8 @@ The image template groups that are linked to an SSH key. [softwarePasswords]: #softwarepasswords #### [softwarePasswords] The OS root users that are linked to an SSH key. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -159,7 +171,8 @@ The OS root users that are linked to an SSH key. [blockDeviceTemplateGroupCount]: #blockdevicetemplategroupcount #### [blockDeviceTemplateGroupCount] A count of the image template groups that are linked to an SSH key. -Type: **unsigned long** +Type: **unsigned long** + @@ -169,7 +182,8 @@ A count of the image template groups that are linked to an SSH key. [softwarePasswordCount]: #softwarepasswordcount #### [softwarePasswordCount] A count of the OS root users that are linked to an SSH key. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Service_External_Resource/_index.md b/content/reference/datatypes/SoftLayer_Service_External_Resource/_index.md index ca92545656..2ebcef9d1c 100644 --- a/content/reference/datatypes/SoftLayer_Service_External_Resource/_index.md +++ b/content/reference/datatypes/SoftLayer_Service_External_Resource/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Service_External_Resource is a placeholder that references a service being provided outside of the standard SoftLayer system. @@ -45,7 +47,8 @@ The SoftLayer_Service_External_Resource is a placeholder that references a servi [accountId]: #accountid #### [accountId] The customer account that is consuming the related service. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The customer account that is consuming the related service. [externalIdentifier]: #externalidentifier #### [externalIdentifier] The unique identifier in the service provider's system. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The unique identifier in the service provider's system. [id]: #id #### [id] An external resource's unique identifier in the SoftLayer system. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ An external resource's unique identifier in the SoftLayer system. [account]: #account #### [account] The customer account that is consuming the service. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + diff --git a/content/reference/datatypes/SoftLayer_Service_Provider/_index.md b/content/reference/datatypes/SoftLayer_Service_Provider/_index.md index f63a099071..44bdf24429 100644 --- a/content/reference/datatypes/SoftLayer_Service_Provider/_index.md +++ b/content/reference/datatypes/SoftLayer_Service_Provider/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Software_AccountLicense/_index.md b/content/reference/datatypes/SoftLayer_Software_AccountLicense/_index.md index 1f424fa12f..38f43e915d 100644 --- a/content/reference/datatypes/SoftLayer_Software_AccountLicense/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_AccountLicense/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -53,7 +55,8 @@ SoftLayer_Software_AccountLicense is a class that represents software licenses t [accountId]: #accountid #### [accountId] The ID of the SoftLayer Account to which this Account License belongs to. -Type: **integer** +Type: **integer** + @@ -63,7 +66,8 @@ The ID of the SoftLayer Account to which this Account License belongs to. [capacity]: #capacity #### [capacity] Some Account Licenses have capacity information such as CPU specified in the units key. This provides the numerical representation of the capacity of the units. -Type: **string** +Type: **string** + @@ -73,7 +77,8 @@ Some Account Licenses have capacity information such as CPU specified in the uni [key]: #key #### [key] The License Key for this specific Account License. -Type: **string** +Type: **string** + @@ -83,7 +88,8 @@ The License Key for this specific Account License. [units]: #units #### [units] The unit of measurement that an account license has the capacity of. -Type: **string** +Type: **string** + @@ -99,7 +105,8 @@ The unit of measurement that an account license has the capacity of. [account]: #account #### [account] The customer account this Account License belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -109,7 +116,8 @@ The customer account this Account License belongs to. [billingItem]: #billingitem #### [billingItem] The billing item for a software account license. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -119,7 +127,8 @@ The billing item for a software account license. [softwareDescription]: #softwaredescription #### [softwareDescription] The SoftLayer_Software_Description that this account license is for. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component/_index.md b/content/reference/datatypes/SoftLayer_Software_Component/_index.md index f400331cba..77497d8dc5 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -62,7 +64,8 @@ SoftLayer_Software_Component works with SoftLayer_Software_License and SoftLayer [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -72,7 +75,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -82,7 +86,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -92,7 +97,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -108,7 +114,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -118,7 +125,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -128,7 +136,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -138,7 +147,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -148,7 +158,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -158,7 +169,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -168,7 +180,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -178,7 +191,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -190,7 +204,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -200,7 +215,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_Analytics/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_Analytics/_index.md index b90b530577..9da97cda56 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_Analytics/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_Analytics/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ This object specifies a specific type of Software Component: An analytics insta [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -141,7 +152,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -151,7 +163,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -161,7 +174,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -173,7 +187,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_Analytics_Urchin/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_Analytics_Urchin/_index.md index 9b2ee4cc97..852393cf56 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_Analytics_Urchin/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_Analytics_Urchin/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ This object specifies a specific Software Component: An Urchin instance. Urchin [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -96,7 +102,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -106,7 +113,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -116,7 +124,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -126,7 +135,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -136,7 +146,8 @@ History Records for Software Passwords. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -146,7 +157,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -156,7 +168,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -168,7 +181,8 @@ The virtual guest this software component is installed upon. [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware/_index.md index ceec445329..e23688d57d 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ This object specifies a specific type of Software Component: An Anti-virus/spyw [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -141,7 +152,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -151,7 +163,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -161,7 +174,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -173,7 +187,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware_Mcafee/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware_Mcafee/_index.md index ad5a43452d..f02ad4b6a5 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware_Mcafee/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware_Mcafee/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Software_Component_AntivirusSpyware_Mcafee represents a single anti-virus/spyware software component. @@ -45,7 +47,8 @@ The SoftLayer_Software_Component_AntivirusSpyware_Mcafee represents a single ant [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -141,7 +152,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -151,7 +163,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -161,7 +174,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -173,7 +187,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version36/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version36/_index.md index 9f5d497d55..eb8d21fac9 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version36/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version36/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version36 data type [epoVersion]: #epoversion #### [epoVersion] The version of ePolicy Orchestrator that the anti-virus/spyware client communicates with. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The version of ePolicy Orchestrator that the anti-virus/spyware client communica [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ A license key for this specific installation of software, if it is needed. [agentDetails]: #agentdetails #### [agentDetails] The virus scan agent details. -Type: **McAfee_Epolicy_Orchestrator_Version36_Agent_Details** +Type: **McAfee_Epolicy_Orchestrator_Version36_Agent_Details** + @@ -111,7 +119,8 @@ The virus scan agent details. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -121,7 +130,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -131,7 +141,8 @@ The billing item for a software component. [currentAntivirusPolicy]: #currentantiviruspolicy #### [currentAntivirusPolicy] The current anti-virus policy. -Type: **integer** +Type: **integer** + @@ -141,7 +152,8 @@ The current anti-virus policy. [dataFileVersion]: #datafileversion #### [dataFileVersion] The virus definition file version. -Type: **McAfee_Epolicy_Orchestrator_Version36_Product_Properties** +Type: **McAfee_Epolicy_Orchestrator_Version36_Product_Properties** + @@ -151,7 +163,8 @@ The virus definition file version. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -161,7 +174,8 @@ The hardware this Software Component is installed upon. [latestAccessProtectionEvents]: #latestaccessprotectionevents #### [latestAccessProtectionEvents] The latest access protection events. -Type: **McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_AccessProtection[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_AccessProtection[]** + @@ -171,7 +185,8 @@ The latest access protection events. [latestAntivirusEvents]: #latestantivirusevents #### [latestAntivirusEvents] The latest anti-virus events. -Type: **McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event[]** + @@ -181,7 +196,8 @@ The latest anti-virus events. [latestSpywareEvents]: #latestspywareevents #### [latestSpywareEvents] The latest spyware events. -Type: **McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event[]** + @@ -191,7 +207,8 @@ The latest spyware events. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -201,7 +218,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -211,7 +229,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -221,7 +240,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -231,7 +251,8 @@ The License this Software Component uses. [transactionStatus]: #transactionstatus #### [transactionStatus] The current transaction status of a server. -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ The current transaction status of a server. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -253,7 +275,8 @@ The virtual guest this software component is installed upon. [latestAccessProtectionEventCount]: #latestaccessprotectioneventcount #### [latestAccessProtectionEventCount] A count of the latest access protection events. -Type: **unsigned long** +Type: **unsigned long** + @@ -263,7 +286,8 @@ A count of the latest access protection events. [latestAntivirusEventCount]: #latestantiviruseventcount #### [latestAntivirusEventCount] A count of the latest anti-virus events. -Type: **unsigned long** +Type: **unsigned long** + @@ -273,7 +297,8 @@ A count of the latest anti-virus events. [latestSpywareEventCount]: #latestspywareeventcount #### [latestSpywareEventCount] A count of the latest spyware events. -Type: **unsigned long** +Type: **unsigned long** + @@ -283,7 +308,8 @@ A count of the latest spyware events. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -293,7 +319,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version45/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version45/_index.md index 5eb6f540c1..01ec634c43 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version45/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version45/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version45 data type [epoVersion]: #epoversion #### [epoVersion] The version of ePolicy Orchestrator that the anti-virus/spyware client communicates with. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The version of ePolicy Orchestrator that the anti-virus/spyware client communica [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ A license key for this specific installation of software, if it is needed. [agentDetails]: #agentdetails #### [agentDetails] The virus scan agent details. -Type: **McAfee_Epolicy_Orchestrator_Version45_Agent_Details** +Type: **McAfee_Epolicy_Orchestrator_Version45_Agent_Details** + @@ -111,7 +119,8 @@ The virus scan agent details. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -121,7 +130,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -131,7 +141,8 @@ The billing item for a software component. [currentAntivirusPolicy]: #currentantiviruspolicy #### [currentAntivirusPolicy] The current anti-virus policy. -Type: **integer** +Type: **integer** + @@ -141,7 +152,8 @@ The current anti-virus policy. [dataFileVersion]: #datafileversion #### [dataFileVersion] The virus definition file version. -Type: **McAfee_Epolicy_Orchestrator_Version45_Product_Properties** +Type: **McAfee_Epolicy_Orchestrator_Version45_Product_Properties** + @@ -151,7 +163,8 @@ The virus definition file version. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -161,7 +174,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -171,7 +185,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -181,7 +196,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -191,7 +207,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -201,7 +218,8 @@ The License this Software Component uses. [transactionStatus]: #transactionstatus #### [transactionStatus] The current transaction status of a server. -Type: **string** +Type: **string** + @@ -211,7 +229,8 @@ The current transaction status of a server. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -223,7 +242,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -233,7 +253,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version51/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version51/_index.md index a12af9b061..e404431934 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version51/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version51/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version51 data type [epoVersion]: #epoversion #### [epoVersion] The version of McAfee ePO Server that the anti-virus/spyware client communicates with. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The version of McAfee ePO Server that the anti-virus/spyware client communicate [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ A license key for this specific installation of software, if it is needed. [transactionStatus]: #transactionstatus #### [transactionStatus] The version of ePolicy Server that the host IPS client communicates with. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ The version of ePolicy Server that the host IPS client communicates with. [agentDetails]: #agentdetails #### [agentDetails] The virus scan agent details. -Type: **McAfee_Epolicy_Orchestrator_Version51_Agent_Details** +Type: **McAfee_Epolicy_Orchestrator_Version51_Agent_Details** + @@ -121,7 +130,8 @@ The virus scan agent details. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -131,7 +141,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -141,7 +152,8 @@ The billing item for a software component. [currentAntivirusPolicy]: #currentantiviruspolicy #### [currentAntivirusPolicy] The current anti-virus policy. -Type: **integer** +Type: **integer** + @@ -151,7 +163,8 @@ The current anti-virus policy. [dataFileVersion]: #datafileversion #### [dataFileVersion] The virus definition file version. -Type: **McAfee_Epolicy_Orchestrator_Version51_Product_Properties** +Type: **McAfee_Epolicy_Orchestrator_Version51_Product_Properties** + @@ -161,7 +174,8 @@ The virus definition file version. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -171,7 +185,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -181,7 +196,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -191,7 +207,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -201,7 +218,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -211,7 +229,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -223,7 +242,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -233,7 +253,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel/_index.md index 96f3ce4ac6..fca4be74c0 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ This object specifies a specific type of Software Component: A control panel in [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -141,7 +152,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -151,7 +163,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -161,7 +174,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -173,7 +187,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Cpanel/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Cpanel/_index.md index 05cea5a6bf..cdfda15102 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Cpanel/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Cpanel/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ This object specifies a specific Software Component: A cPanel instance. cPanel [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -141,7 +152,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -151,7 +163,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -163,7 +176,8 @@ The virtual guest this software component is installed upon. [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Idera/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Idera/_index.md index 07556ee421..40e6995ec3 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Idera/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Idera/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object specifies a specific type of control panel Software Component: An Idera instance. @@ -45,7 +47,8 @@ This object specifies a specific type of control panel Software Component: An I [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -141,7 +152,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -151,7 +163,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -161,7 +174,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -173,7 +187,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Idera_ServerBackup/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Idera_ServerBackup/_index.md index 8df068b620..3833bc7cb6 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Idera_ServerBackup/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Idera_ServerBackup/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object specifies a specific type of Software Component: A Idera Server Backup instance. @@ -45,7 +47,8 @@ This object specifies a specific type of Software Component: A Idera Server Bac [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -141,7 +152,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -151,7 +163,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -161,7 +174,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -173,7 +187,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Microsoft/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Microsoft/_index.md index bb3ec0e528..5dbcbccef5 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Microsoft/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Microsoft/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object is a parent class for Microsoft Products, like Web Matrix @@ -45,7 +47,8 @@ This object is a parent class for Microsoft Products, like Web Matrix [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -141,7 +152,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -151,7 +163,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -161,7 +174,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -173,7 +187,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Microsoft_WebPlatform/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Microsoft_WebPlatform/_index.md index 081f38fa82..9712a3de7d 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Microsoft_WebPlatform/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Microsoft_WebPlatform/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ This object specifies a specific Software Component: A WebPlatform instance. We [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -96,7 +102,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -106,7 +113,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -116,7 +124,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -126,7 +135,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -136,7 +146,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -146,7 +157,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -156,7 +168,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -166,7 +179,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -178,7 +192,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -188,7 +203,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Parallels/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Parallels/_index.md index c1c63c2248..cab69fe8ed 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Parallels/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Parallels/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object is a parent class for SWSoft Products, like Plesk @@ -45,7 +47,8 @@ This object is a parent class for SWSoft Products, like Plesk [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -141,7 +152,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -151,7 +163,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -161,7 +174,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -173,7 +187,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Parallels_Plesk/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Parallels_Plesk/_index.md index 778c5c1629..349e3daacc 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Parallels_Plesk/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Parallels_Plesk/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ This object specifies a specific Software Component: A Plesk instance produced [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -96,7 +102,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -106,7 +113,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -116,7 +124,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -126,7 +135,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -136,7 +146,8 @@ History Records for Software Passwords. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -146,7 +157,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -156,7 +168,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -168,7 +181,8 @@ The virtual guest this software component is installed upon. [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_R1soft/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_R1soft/_index.md index 3bd0bb47b1..f26dc37238 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_R1soft/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_R1soft/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object specifies a specific type of control panel Software Component: A R1soft instance. @@ -45,7 +47,8 @@ This object specifies a specific type of control panel Software Component: A R1 [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -141,7 +152,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -151,7 +163,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -161,7 +174,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -173,7 +187,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_R1soft_Cdp/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_R1soft_Cdp/_index.md index 25b79e53b7..30d09f0056 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_R1soft_Cdp/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_R1soft_Cdp/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object specifies a specific type of Software Component: A R1soft continuous data protection instance. @@ -45,7 +47,8 @@ This object specifies a specific type of Software Component: A R1soft continuou [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -141,7 +152,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -151,7 +163,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -161,7 +174,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -173,7 +187,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_R1soft_ServerBackup/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_R1soft_ServerBackup/_index.md index 1a7483ac0d..a5651392a4 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_R1soft_ServerBackup/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_R1soft_ServerBackup/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object specifies a specific type of Software Component: A R1Soft Server Backup instance. @@ -45,7 +47,8 @@ This object specifies a specific type of Software Component: A R1Soft Server Ba [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -141,7 +152,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -151,7 +163,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -161,7 +174,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -173,7 +187,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Swsoft/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Swsoft/_index.md index af4e6a3f80..a22727607d 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Swsoft/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_Swsoft/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object is a parent class for SWSoft Products, like Plesk @@ -45,7 +47,8 @@ This object is a parent class for SWSoft Products, like Plesk [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -141,7 +152,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -151,7 +163,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -161,7 +174,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -173,7 +187,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_WebhostAutomation/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_WebhostAutomation/_index.md index 45f6c57069..19de1bd6be 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_WebhostAutomation/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_ControlPanel_WebhostAutomation/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ This object specifies a specific Software Component: A Helm instance produced b [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -141,7 +152,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -151,7 +163,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -163,7 +176,8 @@ The virtual guest this software component is installed upon. [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_HostIps/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_HostIps/_index.md index 19e86e32d5..c58b4b337a 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_HostIps/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_HostIps/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object specifies a specific type of Software Component: A Host Intrusion Protection System instance. @@ -45,7 +47,8 @@ This object specifies a specific type of Software Component: A Host Intrusion P [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -141,7 +152,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -151,7 +163,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -161,7 +174,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -173,7 +187,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee/_index.md index 17026adfa8..2e65f340aa 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Software_Component_HostIps_Mcafee represents a single host IPS software component. @@ -45,7 +47,8 @@ The SoftLayer_Software_Component_HostIps_Mcafee represents a single host IPS sof [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -141,7 +152,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -151,7 +163,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -161,7 +174,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -173,7 +187,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips/_index.md index a0b9369bb8..05f937abb5 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips data type rep [epoVersion]: #epoversion #### [epoVersion] The version of ePolicy Orchestrator that the host IPS client communicates with. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The version of ePolicy Orchestrator that the host IPS client communicates with. [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ A license key for this specific installation of software, if it is needed. [agentDetails]: #agentdetails #### [agentDetails] The host IPS agent details. -Type: **McAfee_Epolicy_Orchestrator_Version36_Agent_Details** +Type: **McAfee_Epolicy_Orchestrator_Version36_Agent_Details** + @@ -111,7 +119,8 @@ The host IPS agent details. [applicationModePolicyNames]: #applicationmodepolicynames #### [applicationModePolicyNames] The names of the possible policy options for the application mode setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -121,7 +130,8 @@ The names of the possible policy options for the application mode setting. [applicationRuleSetPolicyNames]: #applicationrulesetpolicynames #### [applicationRuleSetPolicyNames] The names of the possible policy options for the application rule set setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -131,7 +141,8 @@ The names of the possible policy options for the application rule set setting. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -141,7 +152,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -151,7 +163,8 @@ The billing item for a software component. [enforcementPolicyNames]: #enforcementpolicynames #### [enforcementPolicyNames] The names of the possible options for the enforcement policy setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -161,7 +174,8 @@ The names of the possible options for the enforcement policy setting. [firewallModePolicyNames]: #firewallmodepolicynames #### [firewallModePolicyNames] The names of the possible policy options for the firewall mode setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -171,7 +185,8 @@ The names of the possible policy options for the firewall mode setting. [firewallRuleSetPolicyNames]: #firewallrulesetpolicynames #### [firewallRuleSetPolicyNames] The names of the possible policy options for the firewall rule set setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -181,7 +196,8 @@ The names of the possible policy options for the firewall rule set setting. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -191,7 +207,8 @@ The hardware this Software Component is installed upon. [ipsModePolicyNames]: #ipsmodepolicynames #### [ipsModePolicyNames] The names of the possible policy options for the host IPS mode setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -201,7 +218,8 @@ The names of the possible policy options for the host IPS mode setting. [ipsProtectionPolicyNames]: #ipsprotectionpolicynames #### [ipsProtectionPolicyNames] The names of the possible policy options for the host IPS protection setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -211,7 +229,8 @@ The names of the possible policy options for the host IPS protection setting. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -221,7 +240,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -231,7 +251,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -241,7 +262,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -251,7 +273,8 @@ The License this Software Component uses. [transactionStatus]: #transactionstatus #### [transactionStatus] The current transaction status of a server. -Type: **string** +Type: **string** + @@ -261,7 +284,8 @@ The current transaction status of a server. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -273,7 +297,8 @@ The virtual guest this software component is installed upon. [applicationModePolicyNameCount]: #applicationmodepolicynamecount #### [applicationModePolicyNameCount] A count of the names of the possible policy options for the application mode setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -283,7 +308,8 @@ A count of the names of the possible policy options for the application mode set [applicationRuleSetPolicyNameCount]: #applicationrulesetpolicynamecount #### [applicationRuleSetPolicyNameCount] A count of the names of the possible policy options for the application rule set setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -293,7 +319,8 @@ A count of the names of the possible policy options for the application rule set [enforcementPolicyNameCount]: #enforcementpolicynamecount #### [enforcementPolicyNameCount] A count of the names of the possible options for the enforcement policy setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -303,7 +330,8 @@ A count of the names of the possible options for the enforcement policy setting. [firewallModePolicyNameCount]: #firewallmodepolicynamecount #### [firewallModePolicyNameCount] A count of the names of the possible policy options for the firewall mode setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -313,7 +341,8 @@ A count of the names of the possible policy options for the firewall mode settin [firewallRuleSetPolicyNameCount]: #firewallrulesetpolicynamecount #### [firewallRuleSetPolicyNameCount] A count of the names of the possible policy options for the firewall rule set setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -323,7 +352,8 @@ A count of the names of the possible policy options for the firewall rule set se [ipsModePolicyNameCount]: #ipsmodepolicynamecount #### [ipsModePolicyNameCount] A count of the names of the possible policy options for the host IPS mode setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -333,7 +363,8 @@ A count of the names of the possible policy options for the host IPS mode settin [ipsProtectionPolicyNameCount]: #ipsprotectionpolicynamecount #### [ipsProtectionPolicyNameCount] A count of the names of the possible policy options for the host IPS protection setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -343,7 +374,8 @@ A count of the names of the possible policy options for the host IPS protection [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -353,7 +385,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version6/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version6/_index.md index 7758d97dc3..bfa944b7dd 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version6/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version6/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version6 data [epoVersion]: #epoversion #### [epoVersion] The version of ePolicy Orchestrator that the host IPS client communicates with. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The version of ePolicy Orchestrator that the host IPS client communicates with. [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ A license key for this specific installation of software, if it is needed. [agentDetails]: #agentdetails #### [agentDetails] The host IPS agent details. -Type: **McAfee_Epolicy_Orchestrator_Version36_Agent_Details** +Type: **McAfee_Epolicy_Orchestrator_Version36_Agent_Details** + @@ -111,7 +119,8 @@ The host IPS agent details. [applicationModePolicyNames]: #applicationmodepolicynames #### [applicationModePolicyNames] The names of the possible policy options for the application mode setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -121,7 +130,8 @@ The names of the possible policy options for the application mode setting. [applicationRuleSetPolicyNames]: #applicationrulesetpolicynames #### [applicationRuleSetPolicyNames] The names of the possible policy options for the application rule set setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -131,7 +141,8 @@ The names of the possible policy options for the application rule set setting. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -141,7 +152,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -151,7 +163,8 @@ The billing item for a software component. [blockedApplicationEvents]: #blockedapplicationevents #### [blockedApplicationEvents] The blocked application events for this software component. -Type: **McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_BlockedApplicationEvent[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_BlockedApplicationEvent[]** + @@ -161,7 +174,8 @@ The blocked application events for this software component. [enforcementPolicyNames]: #enforcementpolicynames #### [enforcementPolicyNames] The names of the possible options for the enforcement policy setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -171,7 +185,8 @@ The names of the possible options for the enforcement policy setting. [firewallModePolicyNames]: #firewallmodepolicynames #### [firewallModePolicyNames] The names of the possible policy options for the firewall mode setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -181,7 +196,8 @@ The names of the possible policy options for the firewall mode setting. [firewallRuleSetPolicyNames]: #firewallrulesetpolicynames #### [firewallRuleSetPolicyNames] The names of the possible policy options for the firewall rule set setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -191,7 +207,8 @@ The names of the possible policy options for the firewall rule set setting. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -201,7 +218,8 @@ The hardware this Software Component is installed upon. [ipsEvents]: #ipsevents #### [ipsEvents] The host IPS events for this software component. -Type: **McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_IPSEvent[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_IPSEvent[]** + @@ -211,7 +229,8 @@ The host IPS events for this software component. [ipsModePolicyNames]: #ipsmodepolicynames #### [ipsModePolicyNames] The names of the possible policy options for the host IPS mode setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -221,7 +240,8 @@ The names of the possible policy options for the host IPS mode setting. [ipsProtectionPolicyNames]: #ipsprotectionpolicynames #### [ipsProtectionPolicyNames] The names of the possible policy options for the host IPS protection setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -231,7 +251,8 @@ The names of the possible policy options for the host IPS protection setting. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -241,7 +262,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -251,7 +273,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -261,7 +284,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -271,7 +295,8 @@ The License this Software Component uses. [transactionStatus]: #transactionstatus #### [transactionStatus] The current transaction status of a server. -Type: **string** +Type: **string** + @@ -281,7 +306,8 @@ The current transaction status of a server. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -293,7 +319,8 @@ The virtual guest this software component is installed upon. [applicationModePolicyNameCount]: #applicationmodepolicynamecount #### [applicationModePolicyNameCount] A count of the names of the possible policy options for the application mode setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -303,7 +330,8 @@ A count of the names of the possible policy options for the application mode set [applicationRuleSetPolicyNameCount]: #applicationrulesetpolicynamecount #### [applicationRuleSetPolicyNameCount] A count of the names of the possible policy options for the application rule set setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -313,7 +341,8 @@ A count of the names of the possible policy options for the application rule set [blockedApplicationEventCount]: #blockedapplicationeventcount #### [blockedApplicationEventCount] A count of the blocked application events for this software component. -Type: **unsigned long** +Type: **unsigned long** + @@ -323,7 +352,8 @@ A count of the blocked application events for this software component. [enforcementPolicyNameCount]: #enforcementpolicynamecount #### [enforcementPolicyNameCount] A count of the names of the possible options for the enforcement policy setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -333,7 +363,8 @@ A count of the names of the possible options for the enforcement policy setting. [firewallModePolicyNameCount]: #firewallmodepolicynamecount #### [firewallModePolicyNameCount] A count of the names of the possible policy options for the firewall mode setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -343,7 +374,8 @@ A count of the names of the possible policy options for the firewall mode settin [firewallRuleSetPolicyNameCount]: #firewallrulesetpolicynamecount #### [firewallRuleSetPolicyNameCount] A count of the names of the possible policy options for the firewall rule set setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -353,7 +385,8 @@ A count of the names of the possible policy options for the firewall rule set se [ipsEventCount]: #ipseventcount #### [ipsEventCount] A count of the host IPS events for this software component. -Type: **unsigned long** +Type: **unsigned long** + @@ -363,7 +396,8 @@ A count of the host IPS events for this software component. [ipsModePolicyNameCount]: #ipsmodepolicynamecount #### [ipsModePolicyNameCount] A count of the names of the possible policy options for the host IPS mode setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -373,7 +407,8 @@ A count of the names of the possible policy options for the host IPS mode settin [ipsProtectionPolicyNameCount]: #ipsprotectionpolicynamecount #### [ipsProtectionPolicyNameCount] A count of the names of the possible policy options for the host IPS protection setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -383,7 +418,8 @@ A count of the names of the possible policy options for the host IPS protection [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -393,7 +429,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version7/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version7/_index.md index 7c0a928615..e53ef5ae73 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version7/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version7/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version7 data [epoVersion]: #epoversion #### [epoVersion] The version of ePolicy Orchestrator that the host IPS client communicates with. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The version of ePolicy Orchestrator that the host IPS client communicates with. [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ A license key for this specific installation of software, if it is needed. [agentDetails]: #agentdetails #### [agentDetails] The host IPS agent details. -Type: **McAfee_Epolicy_Orchestrator_Version36_Agent_Details** +Type: **McAfee_Epolicy_Orchestrator_Version36_Agent_Details** + @@ -111,7 +119,8 @@ The host IPS agent details. [applicationModePolicyNames]: #applicationmodepolicynames #### [applicationModePolicyNames] The names of the possible policy options for the application mode setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -121,7 +130,8 @@ The names of the possible policy options for the application mode setting. [applicationRuleSetPolicyNames]: #applicationrulesetpolicynames #### [applicationRuleSetPolicyNames] The names of the possible policy options for the application rule set setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -131,7 +141,8 @@ The names of the possible policy options for the application rule set setting. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -141,7 +152,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -151,7 +163,8 @@ The billing item for a software component. [blockedApplicationEvents]: #blockedapplicationevents #### [blockedApplicationEvents] The blocked application events for this software component. -Type: **McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_BlockedApplicationEvent[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_BlockedApplicationEvent[]** + @@ -161,7 +174,8 @@ The blocked application events for this software component. [enforcementPolicyNames]: #enforcementpolicynames #### [enforcementPolicyNames] The names of the possible options for the enforcement policy setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -171,7 +185,8 @@ The names of the possible options for the enforcement policy setting. [firewallModePolicyNames]: #firewallmodepolicynames #### [firewallModePolicyNames] The names of the possible policy options for the firewall mode setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -181,7 +196,8 @@ The names of the possible policy options for the firewall mode setting. [firewallRuleSetPolicyNames]: #firewallrulesetpolicynames #### [firewallRuleSetPolicyNames] The names of the possible policy options for the firewall rule set setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -191,7 +207,8 @@ The names of the possible policy options for the firewall rule set setting. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -201,7 +218,8 @@ The hardware this Software Component is installed upon. [ipsEvents]: #ipsevents #### [ipsEvents] The host IPS events for this software component. -Type: **McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_IPSEvent[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_IPSEvent[]** + @@ -211,7 +229,8 @@ The host IPS events for this software component. [ipsModePolicyNames]: #ipsmodepolicynames #### [ipsModePolicyNames] The names of the possible policy options for the host IPS mode setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -221,7 +240,8 @@ The names of the possible policy options for the host IPS mode setting. [ipsProtectionPolicyNames]: #ipsprotectionpolicynames #### [ipsProtectionPolicyNames] The names of the possible policy options for the host IPS protection setting. -Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version36_Policy_Object[]** + @@ -231,7 +251,8 @@ The names of the possible policy options for the host IPS protection setting. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -241,7 +262,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -251,7 +273,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -261,7 +284,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -271,7 +295,8 @@ The License this Software Component uses. [transactionStatus]: #transactionstatus #### [transactionStatus] The current transaction status of a server. -Type: **string** +Type: **string** + @@ -281,7 +306,8 @@ The current transaction status of a server. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -293,7 +319,8 @@ The virtual guest this software component is installed upon. [applicationModePolicyNameCount]: #applicationmodepolicynamecount #### [applicationModePolicyNameCount] A count of the names of the possible policy options for the application mode setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -303,7 +330,8 @@ A count of the names of the possible policy options for the application mode set [applicationRuleSetPolicyNameCount]: #applicationrulesetpolicynamecount #### [applicationRuleSetPolicyNameCount] A count of the names of the possible policy options for the application rule set setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -313,7 +341,8 @@ A count of the names of the possible policy options for the application rule set [blockedApplicationEventCount]: #blockedapplicationeventcount #### [blockedApplicationEventCount] A count of the blocked application events for this software component. -Type: **unsigned long** +Type: **unsigned long** + @@ -323,7 +352,8 @@ A count of the blocked application events for this software component. [enforcementPolicyNameCount]: #enforcementpolicynamecount #### [enforcementPolicyNameCount] A count of the names of the possible options for the enforcement policy setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -333,7 +363,8 @@ A count of the names of the possible options for the enforcement policy setting. [firewallModePolicyNameCount]: #firewallmodepolicynamecount #### [firewallModePolicyNameCount] A count of the names of the possible policy options for the firewall mode setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -343,7 +374,8 @@ A count of the names of the possible policy options for the firewall mode settin [firewallRuleSetPolicyNameCount]: #firewallrulesetpolicynamecount #### [firewallRuleSetPolicyNameCount] A count of the names of the possible policy options for the firewall rule set setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -353,7 +385,8 @@ A count of the names of the possible policy options for the firewall rule set se [ipsEventCount]: #ipseventcount #### [ipsEventCount] A count of the host IPS events for this software component. -Type: **unsigned long** +Type: **unsigned long** + @@ -363,7 +396,8 @@ A count of the host IPS events for this software component. [ipsModePolicyNameCount]: #ipsmodepolicynamecount #### [ipsModePolicyNameCount] A count of the names of the possible policy options for the host IPS mode setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -373,7 +407,8 @@ A count of the names of the possible policy options for the host IPS mode settin [ipsProtectionPolicyNameCount]: #ipsprotectionpolicynamecount #### [ipsProtectionPolicyNameCount] A count of the names of the possible policy options for the host IPS protection setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -383,7 +418,8 @@ A count of the names of the possible policy options for the host IPS protection [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -393,7 +429,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips/_index.md index 21c3cd8c96..c68c734116 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips data type rep [epoVersion]: #epoversion #### [epoVersion] The version of ePolicy Orchestrator that the host IPS client communicates with. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The version of ePolicy Orchestrator that the host IPS client communicates with. [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ A license key for this specific installation of software, if it is needed. [agentDetails]: #agentdetails #### [agentDetails] The host IPS agent details. -Type: **McAfee_Epolicy_Orchestrator_Version45_Agent_Details** +Type: **McAfee_Epolicy_Orchestrator_Version45_Agent_Details** + @@ -111,7 +119,8 @@ The host IPS agent details. [applicationModePolicyNames]: #applicationmodepolicynames #### [applicationModePolicyNames] The names of the possible policy options for the application mode setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -121,7 +130,8 @@ The names of the possible policy options for the application mode setting. [applicationRuleSetPolicyNames]: #applicationrulesetpolicynames #### [applicationRuleSetPolicyNames] The names of the possible policy options for the application rule set setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -131,7 +141,8 @@ The names of the possible policy options for the application rule set setting. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -141,7 +152,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -151,7 +163,8 @@ The billing item for a software component. [enforcementPolicyNames]: #enforcementpolicynames #### [enforcementPolicyNames] The names of the possible options for the enforcement policy setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -161,7 +174,8 @@ The names of the possible options for the enforcement policy setting. [firewallModePolicyNames]: #firewallmodepolicynames #### [firewallModePolicyNames] The names of the possible policy options for the firewall mode setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -171,7 +185,8 @@ The names of the possible policy options for the firewall mode setting. [firewallRuleSetPolicyNames]: #firewallrulesetpolicynames #### [firewallRuleSetPolicyNames] The names of the possible policy options for the firewall rule set setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -181,7 +196,8 @@ The names of the possible policy options for the firewall rule set setting. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -191,7 +207,8 @@ The hardware this Software Component is installed upon. [ipsModePolicyNames]: #ipsmodepolicynames #### [ipsModePolicyNames] The names of the possible policy options for the host IPS mode setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -201,7 +218,8 @@ The names of the possible policy options for the host IPS mode setting. [ipsProtectionPolicyNames]: #ipsprotectionpolicynames #### [ipsProtectionPolicyNames] The names of the possible policy options for the host IPS protection setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -211,7 +229,8 @@ The names of the possible policy options for the host IPS protection setting. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -221,7 +240,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -231,7 +251,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -241,7 +262,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -251,7 +273,8 @@ The License this Software Component uses. [transactionStatus]: #transactionstatus #### [transactionStatus] The current transaction status of a server. -Type: **string** +Type: **string** + @@ -261,7 +284,8 @@ The current transaction status of a server. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -273,7 +297,8 @@ The virtual guest this software component is installed upon. [applicationModePolicyNameCount]: #applicationmodepolicynamecount #### [applicationModePolicyNameCount] A count of the names of the possible policy options for the application mode setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -283,7 +308,8 @@ A count of the names of the possible policy options for the application mode set [applicationRuleSetPolicyNameCount]: #applicationrulesetpolicynamecount #### [applicationRuleSetPolicyNameCount] A count of the names of the possible policy options for the application rule set setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -293,7 +319,8 @@ A count of the names of the possible policy options for the application rule set [enforcementPolicyNameCount]: #enforcementpolicynamecount #### [enforcementPolicyNameCount] A count of the names of the possible options for the enforcement policy setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -303,7 +330,8 @@ A count of the names of the possible options for the enforcement policy setting. [firewallModePolicyNameCount]: #firewallmodepolicynamecount #### [firewallModePolicyNameCount] A count of the names of the possible policy options for the firewall mode setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -313,7 +341,8 @@ A count of the names of the possible policy options for the firewall mode settin [firewallRuleSetPolicyNameCount]: #firewallrulesetpolicynamecount #### [firewallRuleSetPolicyNameCount] A count of the names of the possible policy options for the firewall rule set setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -323,7 +352,8 @@ A count of the names of the possible policy options for the firewall rule set se [ipsModePolicyNameCount]: #ipsmodepolicynamecount #### [ipsModePolicyNameCount] A count of the names of the possible policy options for the host IPS mode setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -333,7 +363,8 @@ A count of the names of the possible policy options for the host IPS mode settin [ipsProtectionPolicyNameCount]: #ipsprotectionpolicynamecount #### [ipsProtectionPolicyNameCount] A count of the names of the possible policy options for the host IPS protection setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -343,7 +374,8 @@ A count of the names of the possible policy options for the host IPS protection [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -353,7 +385,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version7/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version7/_index.md index 264926c193..bee6a4f887 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version7/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version7/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version7 data [epoVersion]: #epoversion #### [epoVersion] The version of ePolicy Orchestrator that the host IPS client communicates with. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The version of ePolicy Orchestrator that the host IPS client communicates with. [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ A license key for this specific installation of software, if it is needed. [agentDetails]: #agentdetails #### [agentDetails] The host IPS agent details. -Type: **McAfee_Epolicy_Orchestrator_Version45_Agent_Details** +Type: **McAfee_Epolicy_Orchestrator_Version45_Agent_Details** + @@ -111,7 +119,8 @@ The host IPS agent details. [applicationModePolicyNames]: #applicationmodepolicynames #### [applicationModePolicyNames] The names of the possible policy options for the application mode setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -121,7 +130,8 @@ The names of the possible policy options for the application mode setting. [applicationRuleSetPolicyNames]: #applicationrulesetpolicynames #### [applicationRuleSetPolicyNames] The names of the possible policy options for the application rule set setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -131,7 +141,8 @@ The names of the possible policy options for the application rule set setting. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -141,7 +152,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -151,7 +163,8 @@ The billing item for a software component. [enforcementPolicyNames]: #enforcementpolicynames #### [enforcementPolicyNames] The names of the possible options for the enforcement policy setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -161,7 +174,8 @@ The names of the possible options for the enforcement policy setting. [firewallModePolicyNames]: #firewallmodepolicynames #### [firewallModePolicyNames] The names of the possible policy options for the firewall mode setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -171,7 +185,8 @@ The names of the possible policy options for the firewall mode setting. [firewallRuleSetPolicyNames]: #firewallrulesetpolicynames #### [firewallRuleSetPolicyNames] The names of the possible policy options for the firewall rule set setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -181,7 +196,8 @@ The names of the possible policy options for the firewall rule set setting. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -191,7 +207,8 @@ The hardware this Software Component is installed upon. [ipsModePolicyNames]: #ipsmodepolicynames #### [ipsModePolicyNames] The names of the possible policy options for the host IPS mode setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -201,7 +218,8 @@ The names of the possible policy options for the host IPS mode setting. [ipsProtectionPolicyNames]: #ipsprotectionpolicynames #### [ipsProtectionPolicyNames] The names of the possible policy options for the host IPS protection setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -211,7 +229,8 @@ The names of the possible policy options for the host IPS protection setting. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -221,7 +240,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -231,7 +251,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -241,7 +262,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -251,7 +273,8 @@ The License this Software Component uses. [transactionStatus]: #transactionstatus #### [transactionStatus] The current transaction status of a server. -Type: **string** +Type: **string** + @@ -261,7 +284,8 @@ The current transaction status of a server. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -273,7 +297,8 @@ The virtual guest this software component is installed upon. [applicationModePolicyNameCount]: #applicationmodepolicynamecount #### [applicationModePolicyNameCount] A count of the names of the possible policy options for the application mode setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -283,7 +308,8 @@ A count of the names of the possible policy options for the application mode set [applicationRuleSetPolicyNameCount]: #applicationrulesetpolicynamecount #### [applicationRuleSetPolicyNameCount] A count of the names of the possible policy options for the application rule set setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -293,7 +319,8 @@ A count of the names of the possible policy options for the application rule set [enforcementPolicyNameCount]: #enforcementpolicynamecount #### [enforcementPolicyNameCount] A count of the names of the possible options for the enforcement policy setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -303,7 +330,8 @@ A count of the names of the possible options for the enforcement policy setting. [firewallModePolicyNameCount]: #firewallmodepolicynamecount #### [firewallModePolicyNameCount] A count of the names of the possible policy options for the firewall mode setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -313,7 +341,8 @@ A count of the names of the possible policy options for the firewall mode settin [firewallRuleSetPolicyNameCount]: #firewallrulesetpolicynamecount #### [firewallRuleSetPolicyNameCount] A count of the names of the possible policy options for the firewall rule set setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -323,7 +352,8 @@ A count of the names of the possible policy options for the firewall rule set se [ipsModePolicyNameCount]: #ipsmodepolicynamecount #### [ipsModePolicyNameCount] A count of the names of the possible policy options for the host IPS mode setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -333,7 +363,8 @@ A count of the names of the possible policy options for the host IPS mode settin [ipsProtectionPolicyNameCount]: #ipsprotectionpolicynamecount #### [ipsProtectionPolicyNameCount] A count of the names of the possible policy options for the host IPS protection setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -343,7 +374,8 @@ A count of the names of the possible policy options for the host IPS protection [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -353,7 +385,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version8/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version8/_index.md index 011c23e96d..7d77168def 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version8/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version8/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version8 data [epoVersion]: #epoversion #### [epoVersion] The version of ePolicy Orchestrator that the host IPS client communicates with. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The version of ePolicy Orchestrator that the host IPS client communicates with. [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ A license key for this specific installation of software, if it is needed. [agentDetails]: #agentdetails #### [agentDetails] The host IPS agent details. -Type: **McAfee_Epolicy_Orchestrator_Version45_Agent_Details** +Type: **McAfee_Epolicy_Orchestrator_Version45_Agent_Details** + @@ -111,7 +119,8 @@ The host IPS agent details. [applicationModePolicyNames]: #applicationmodepolicynames #### [applicationModePolicyNames] The names of the possible policy options for the application mode setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -121,7 +130,8 @@ The names of the possible policy options for the application mode setting. [applicationRuleSetPolicyNames]: #applicationrulesetpolicynames #### [applicationRuleSetPolicyNames] The names of the possible policy options for the application rule set setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -131,7 +141,8 @@ The names of the possible policy options for the application rule set setting. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -141,7 +152,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -151,7 +163,8 @@ The billing item for a software component. [enforcementPolicyNames]: #enforcementpolicynames #### [enforcementPolicyNames] The names of the possible options for the enforcement policy setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -161,7 +174,8 @@ The names of the possible options for the enforcement policy setting. [firewallModePolicyNames]: #firewallmodepolicynames #### [firewallModePolicyNames] The names of the possible policy options for the firewall mode setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -171,7 +185,8 @@ The names of the possible policy options for the firewall mode setting. [firewallRuleSetPolicyNames]: #firewallrulesetpolicynames #### [firewallRuleSetPolicyNames] The names of the possible policy options for the firewall rule set setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -181,7 +196,8 @@ The names of the possible policy options for the firewall rule set setting. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -191,7 +207,8 @@ The hardware this Software Component is installed upon. [ipsModePolicyNames]: #ipsmodepolicynames #### [ipsModePolicyNames] The names of the possible policy options for the host IPS mode setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -201,7 +218,8 @@ The names of the possible policy options for the host IPS mode setting. [ipsProtectionPolicyNames]: #ipsprotectionpolicynames #### [ipsProtectionPolicyNames] The names of the possible policy options for the host IPS protection setting. -Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version45_Policy_Object[]** + @@ -211,7 +229,8 @@ The names of the possible policy options for the host IPS protection setting. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -221,7 +240,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -231,7 +251,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -241,7 +262,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -251,7 +273,8 @@ The License this Software Component uses. [transactionStatus]: #transactionstatus #### [transactionStatus] The current transaction status of a server. -Type: **string** +Type: **string** + @@ -261,7 +284,8 @@ The current transaction status of a server. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -273,7 +297,8 @@ The virtual guest this software component is installed upon. [applicationModePolicyNameCount]: #applicationmodepolicynamecount #### [applicationModePolicyNameCount] A count of the names of the possible policy options for the application mode setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -283,7 +308,8 @@ A count of the names of the possible policy options for the application mode set [applicationRuleSetPolicyNameCount]: #applicationrulesetpolicynamecount #### [applicationRuleSetPolicyNameCount] A count of the names of the possible policy options for the application rule set setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -293,7 +319,8 @@ A count of the names of the possible policy options for the application rule set [enforcementPolicyNameCount]: #enforcementpolicynamecount #### [enforcementPolicyNameCount] A count of the names of the possible options for the enforcement policy setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -303,7 +330,8 @@ A count of the names of the possible options for the enforcement policy setting. [firewallModePolicyNameCount]: #firewallmodepolicynamecount #### [firewallModePolicyNameCount] A count of the names of the possible policy options for the firewall mode setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -313,7 +341,8 @@ A count of the names of the possible policy options for the firewall mode settin [firewallRuleSetPolicyNameCount]: #firewallrulesetpolicynamecount #### [firewallRuleSetPolicyNameCount] A count of the names of the possible policy options for the firewall rule set setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -323,7 +352,8 @@ A count of the names of the possible policy options for the firewall rule set se [ipsModePolicyNameCount]: #ipsmodepolicynamecount #### [ipsModePolicyNameCount] A count of the names of the possible policy options for the host IPS mode setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -333,7 +363,8 @@ A count of the names of the possible policy options for the host IPS mode settin [ipsProtectionPolicyNameCount]: #ipsprotectionpolicynamecount #### [ipsProtectionPolicyNameCount] A count of the names of the possible policy options for the host IPS protection setting. -Type: **unsigned long** +Type: **unsigned long** + @@ -343,7 +374,8 @@ A count of the names of the possible policy options for the host IPS protection [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -353,7 +385,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version51/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version51/_index.md index 24d4002940..70b147c9a2 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version51/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version51/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version51 data type represents a single McAfee Secure Host IPS software component that uses the ePO Server. @@ -45,7 +47,8 @@ The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version51 data type represen [epoVersion]: #epoversion #### [epoVersion] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version51 data type represen [firewallModePolicyNames]: #firewallmodepolicynames #### [firewallModePolicyNames] -Type: **McAfee_Epolicy_Orchestrator_Version51_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version51_Policy_Object[]** + @@ -65,7 +69,8 @@ The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version51 data type represen [firewallRuleSetPolicyNames]: #firewallrulesetpolicynames #### [firewallRuleSetPolicyNames] -Type: **McAfee_Epolicy_Orchestrator_Version51_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version51_Policy_Object[]** + @@ -75,7 +80,8 @@ The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version51 data type represen [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ An ID number identifying this Software Component (Software Installation) [ipsModePolicyNames]: #ipsmodepolicynames #### [ipsModePolicyNames] -Type: **McAfee_Epolicy_Orchestrator_Version51_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version51_Policy_Object[]** + @@ -105,7 +113,8 @@ An ID number identifying this Software Component (Software Installation) [ipsProtectionPolicyNames]: #ipsprotectionpolicynames #### [ipsProtectionPolicyNames] -Type: **McAfee_Epolicy_Orchestrator_Version51_Policy_Object[]** +Type: **McAfee_Epolicy_Orchestrator_Version51_Policy_Object[]** + @@ -115,7 +124,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ A license key for this specific installation of software, if it is needed. [transactionStatus]: #transactionstatus #### [transactionStatus] -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ A license key for this specific installation of software, if it is needed. [agentDetails]: #agentdetails #### [agentDetails] The virus scan agent details. -Type: **McAfee_Epolicy_Orchestrator_Version51_Agent_Details** +Type: **McAfee_Epolicy_Orchestrator_Version51_Agent_Details** + @@ -161,7 +174,8 @@ The virus scan agent details. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -171,7 +185,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -181,7 +196,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -191,7 +207,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -201,7 +218,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -211,7 +229,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -221,7 +240,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -231,7 +251,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -243,7 +264,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -253,7 +275,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_OperatingSystem/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_OperatingSystem/_index.md index 80e5e9200f..86cb3680c9 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_OperatingSystem/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_OperatingSystem/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Software_Component_OperatingSystem extends the [SoftLayer_Software_Component]({{}}) data type to include operating system specific properties. @@ -50,7 +52,8 @@ SoftLayer_Software_Component_OperatingSystem extends the [SoftLayer_Software_Com [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -96,7 +102,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The expected amount of time in minutes that an operating system can be installed. -Type: **unsigned long** +Type: **unsigned long** + @@ -106,7 +113,8 @@ The expected amount of time in minutes that an operating system can be installed [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -116,7 +124,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -126,7 +135,8 @@ The hardware this Software Component is installed upon. [licenseExpirationDate]: #licenseexpirationdate #### [licenseExpirationDate] The date in which the license for this software expires. -Type: **dateTime** +Type: **dateTime** + @@ -136,7 +146,8 @@ The date in which the license for this software expires. [partitionTemplates]: #partitiontemplates #### [partitionTemplates] An operating system's associated [SoftLayer_Hardware_Component_Partition_Template]({{}}) that can be used to configure a hardware drive. -Type: **SoftLayer_Hardware_Component_Partition_Template[] ** +Type: **SoftLayer_Hardware_Component_Partition_Template[] ** + @@ -146,7 +157,8 @@ An operating system's associated [SoftLayer_Hardware_Component_Partition_Templat [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -156,7 +168,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -166,7 +179,8 @@ Username/Password pairs used for access to this Software Installation. [reloadTransactionGroup]: #reloadtransactiongroup #### [reloadTransactionGroup] An operating systems associated [SoftLayer_Provisioning_Version1_Transaction_Group]({{}}). A transaction group is a list of operations that will occur during the installment of an operating system. -Type: **SoftLayer_Provisioning_Version1_Transaction_Group ** +Type: **SoftLayer_Provisioning_Version1_Transaction_Group ** + @@ -176,7 +190,8 @@ An operating systems associated [SoftLayer_Provisioning_Version1_Transaction_Gro [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -186,7 +201,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -196,7 +212,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -208,7 +225,8 @@ The virtual guest this software component is installed upon. [partitionTemplateCount]: #partitiontemplatecount #### [partitionTemplateCount] A count of an operating system's associated [SoftLayer_Hardware_Component_Partition_Template]({{}}) that can be used to configure a hardware drive. -Type: **unsigned long** +Type: **unsigned long** + @@ -218,7 +236,8 @@ A count of an operating system's associated [SoftLayer_Hardware_Component_Partit [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -228,7 +247,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_Package/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_Package/_index.md index 67ca2a014f..8c11c825d9 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_Package/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_Package/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object specifies a specific type of Software Component: A package instance. @@ -45,7 +47,8 @@ This object specifies a specific type of Software Component: A package instance [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -141,7 +152,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -151,7 +163,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -161,7 +174,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -173,7 +187,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_Package_Management/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_Package_Management/_index.md index dfa5811a8d..e9a8743f88 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_Package_Management/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_Package_Management/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object specifies a specific type of Software Component: A package management instance. @@ -45,7 +47,8 @@ This object specifies a specific type of Software Component: A package manageme [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -141,7 +152,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -151,7 +163,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -161,7 +174,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -173,7 +187,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_Package_Management_Ksplice/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_Package_Management_Ksplice/_index.md index e0a78e3def..991fb8756d 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_Package_Management_Ksplice/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_Package_Management_Ksplice/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object specifies a specific type of Software Component: A Ksplice instance. @@ -45,7 +47,8 @@ This object specifies a specific type of Software Component: A Ksplice instance [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -141,7 +152,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -151,7 +163,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -161,7 +174,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -173,7 +187,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_Password/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_Password/_index.md index 79d23bcd81..a94d6d5f26 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_Password/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_Password/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This SoftLayer_Software_Component_Password data type contains a password for a specific software component instance. @@ -53,7 +55,8 @@ This SoftLayer_Software_Component_Password data type contains a password for a s [createDate]: #createdate #### [createDate] The date this username/password pair was created. -Type: **dateTime** +Type: **dateTime** + @@ -63,7 +66,8 @@ The date this username/password pair was created. [id]: #id #### [id] An id number for this specific username/password pair. -Type: **integer** +Type: **integer** + @@ -73,7 +77,8 @@ An id number for this specific username/password pair. [modifyDate]: #modifydate #### [modifyDate] The date of the last modification to this username/password pair. -Type: **dateTime** +Type: **dateTime** + @@ -83,7 +88,8 @@ The date of the last modification to this username/password pair. [notes]: #notes #### [notes] A note string stored for this username/password pair. -Type: **string** +Type: **string** + @@ -93,7 +99,8 @@ A note string stored for this username/password pair. [password]: #password #### [password] The password part of the username/password pair. -Type: **string** +Type: **string** + @@ -103,7 +110,8 @@ The password part of the username/password pair. [port]: #port #### [port] The application access port for the Software Component. -Type: **integer** +Type: **integer** + @@ -113,7 +121,8 @@ The application access port for the Software Component. [softwareId]: #softwareid #### [softwareId] An id number for the software component this username/password pair is valid for. -Type: **integer** +Type: **integer** + @@ -123,7 +132,8 @@ An id number for the software component this username/password pair is valid for [username]: #username #### [username] The username part of the username/password pair. -Type: **string** +Type: **string** + @@ -139,7 +149,8 @@ The username part of the username/password pair. [software]: #software #### [software] The SoftLayer_Software_Component instance that this username/password pair is valid for. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -149,7 +160,8 @@ The SoftLayer_Software_Component instance that this username/password pair is va [sshKeys]: #sshkeys #### [sshKeys] SSH keys to be installed on the server during provisioning or an OS reload. -Type: **SoftLayer_Security_Ssh_Key[] ** +Type: **SoftLayer_Security_Ssh_Key[] ** + @@ -161,7 +173,8 @@ SSH keys to be installed on the server during provisioning or an OS reload. [sshKeyCount]: #sshkeycount #### [sshKeyCount] A count of sSH keys to be installed on the server during provisioning or an OS reload. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_Password_History/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_Password_History/_index.md index 93f42fd13f..de8eb449f9 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_Password_History/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_Password_History/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object allows you to find the history of password changes for a specific SoftLayer_Software Component @@ -53,7 +55,8 @@ This object allows you to find the history of password changes for a specific So [createDate]: #createdate #### [createDate] The date this username/password pair was created. -Type: **dateTime** +Type: **dateTime** + @@ -63,7 +66,8 @@ The date this username/password pair was created. [notes]: #notes #### [notes] A note string stored for this username/password pair. -Type: **string** +Type: **string** + @@ -73,7 +77,8 @@ A note string stored for this username/password pair. [password]: #password #### [password] The password part of this specific password history instance. -Type: **string** +Type: **string** + @@ -83,7 +88,8 @@ The password part of this specific password history instance. [softwareComponentId]: #softwarecomponentid #### [softwareComponentId] The id number for the Software Component this username/password pair is for. -Type: **integer** +Type: **integer** + @@ -93,7 +99,8 @@ The id number for the Software Component this username/password pair is for. [username]: #username #### [username] The username part of this specific password history instance. -Type: **string** +Type: **string** + @@ -109,7 +116,8 @@ The username part of this specific password history instance. [softwareComponent]: #softwarecomponent #### [softwareComponent] An installed and licensed instance of a piece of software -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_Security/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_Security/_index.md index 540804ad0d..d3a17579a7 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_Security/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_Security/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object specifies a specific type of Software Component: A security instance. Security installations have custom configurations for password requirements. @@ -45,7 +47,8 @@ This object specifies a specific type of Software Component: A security instanc [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -101,7 +108,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -111,7 +119,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -121,7 +130,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -131,7 +141,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -141,7 +152,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -151,7 +163,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -161,7 +174,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -173,7 +187,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Component_Security_SafeNet/_index.md b/content/reference/datatypes/SoftLayer_Software_Component_Security_SafeNet/_index.md index 3b69e6eb0e..40cae11577 100644 --- a/content/reference/datatypes/SoftLayer_Software_Component_Security_SafeNet/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Component_Security_SafeNet/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object specifies a specific Software Component: A SafeNet instance. SafeNet installations have custom configurations for password requirements. @@ -50,7 +52,8 @@ This object specifies a specific Software Component: A SafeNet instance. SafeNe [hardwareId]: #hardwareid #### [hardwareId] Hardware Identification Number for the server this Software Component is installed upon. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ Hardware Identification Number for the server this Software Component is install [id]: #id #### [id] An ID number identifying this Software Component (Software Installation) -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ An ID number identifying this Software Component (Software Installation) [manufacturerActivationCode]: #manufactureractivationcode #### [manufacturerActivationCode] The manufacturer code that is needed to activate a license. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ The manufacturer code that is needed to activate a license. [manufacturerLicenseInstance]: #manufacturerlicenseinstance #### [manufacturerLicenseInstance] A license key for this specific installation of software, if it is needed. -Type: **string** +Type: **string** + @@ -96,7 +102,8 @@ A license key for this specific installation of software, if it is needed. [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software component takes to install. -Type: **unsigned long** +Type: **unsigned long** + @@ -106,7 +113,8 @@ The average amount of time that a software component takes to install. [billingItem]: #billingitem #### [billingItem] The billing item for a software component. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -116,7 +124,8 @@ The billing item for a software component. [hardware]: #hardware #### [hardware] The hardware this Software Component is installed upon. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -126,7 +135,8 @@ The hardware this Software Component is installed upon. [passwordHistory]: #passwordhistory #### [passwordHistory] History Records for Software Passwords. -Type: **SoftLayer_Software_Component_Password_History[] ** +Type: **SoftLayer_Software_Component_Password_History[] ** + @@ -136,7 +146,8 @@ History Records for Software Passwords. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to this Software Installation. -Type: **SoftLayer_Software_Component_Password[] ** +Type: **SoftLayer_Software_Component_Password[] ** + @@ -146,7 +157,8 @@ Username/Password pairs used for access to this Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The Software Description of this Software Component. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -156,7 +168,8 @@ The Software Description of this Software Component. [softwareLicense]: #softwarelicense #### [softwareLicense] The License this Software Component uses. -Type: **SoftLayer_Software_License ** +Type: **SoftLayer_Software_License ** + @@ -166,7 +179,8 @@ The License this Software Component uses. [virtualGuest]: #virtualguest #### [virtualGuest] The virtual guest this software component is installed upon. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -178,7 +192,8 @@ The virtual guest this software component is installed upon. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to this Software Installation. -Type: **unsigned long** +Type: **unsigned long** + @@ -188,7 +203,8 @@ A count of username/Password pairs used for access to this Software Installation [passwordHistoryCount]: #passwordhistorycount #### [passwordHistoryCount] A count of history Records for Software Passwords. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Description/_index.md b/content/reference/datatypes/SoftLayer_Software_Description/_index.md index ec225070e6..ae5a8042c0 100644 --- a/content/reference/datatypes/SoftLayer_Software_Description/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Description/_index.md @@ -20,6 +20,8 @@ classes: ## 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. @@ -59,7 +61,8 @@ The "Manufacturer" and "Name" properties of a SoftLayer_Software_Description are [controlPanel]: #controlpanel #### [controlPanel] This is set to '1' if this Software Description describes a Control Panel. -Type: **integer** +Type: **integer** + @@ -69,7 +72,8 @@ This is set to '1' if this Software Description describes a Control Panel. [id]: #id #### [id] An ID number to identify this Software Description. -Type: **integer** +Type: **integer** + @@ -79,7 +83,8 @@ An ID number to identify this Software Description. [licenseTermUnit]: #licensetermunit #### [licenseTermUnit] The unit of measurement (day, month, or year) for license registration. Used in conjunction with licenseTermValue to determine overall license registration length of a new license. -Type: **string** +Type: **string** + @@ -89,7 +94,8 @@ The unit of measurement (day, month, or year) for license registration. Used in [licenseTermValue]: #licensetermvalue #### [licenseTermValue] The number of units (licenseTermUnit) a new license is valid for at the time of registration. -Type: **integer** +Type: **integer** + @@ -99,7 +105,8 @@ The number of units (licenseTermUnit) a new license is valid for at the time of [longDescription]: #longdescription #### [longDescription] The manufacturer, name and version of a piece of software. -Type: **string** +Type: **string** + @@ -109,7 +116,8 @@ The manufacturer, name and version of a piece of software. [manufacturer]: #manufacturer #### [manufacturer] The name of the manufacturer for this specific piece of software. This name is used by SoftLayer_Software_Component to tailor make (factory) specific types of Software Components that know details like default ports. -Type: **string** +Type: **string** + @@ -119,7 +127,8 @@ The name of the manufacturer for this specific piece of software. This name is [name]: #name #### [name] The name of this specific piece of software. This name is used by SoftLayer_Software_Component to tailor make (factory) specific types of Software Components that know details like default ports. -Type: **string** +Type: **string** + @@ -129,7 +138,8 @@ The name of this specific piece of software. This name is used by SoftLayer_Sof [operatingSystem]: #operatingsystem #### [operatingSystem] This is set to '1' if this Software Description describes an Operating System. -Type: **integer** +Type: **integer** + @@ -139,7 +149,8 @@ This is set to '1' if this Software Description describes an Operating System. [referenceCode]: #referencecode #### [referenceCode] A reference code is structured as three tokens separated by underscores. The first token represents the product, the second is the version of the product, and the third is whether the software is 32 or 64bit. -Type: **string** +Type: **string** + @@ -149,7 +160,8 @@ A reference code is structured as three tokens separated by underscores. The fir [upgradeSoftwareDescriptionId]: #upgradesoftwaredescriptionid #### [upgradeSoftwareDescriptionId] Contains the ID of the suggested upgrade from this Software_Description to a more powerful software installation. -Type: **integer** +Type: **integer** + @@ -159,7 +171,8 @@ Contains the ID of the suggested upgrade from this Software_Description to a mor [upgradeSwDescId]: #upgradeswdescid #### [upgradeSwDescId] Contains the ID of the suggested upgrade from this Software_Description to a more powerful software installation. (Deprecated - Use upgradeSoftwareDescriptionId) -Type: **integer** +Type: **integer** + @@ -169,7 +182,8 @@ Contains the ID of the suggested upgrade from this Software_Description to a mor [version]: #version #### [version] The version of this specific piece of software. -Type: **string** +Type: **string** + @@ -179,7 +193,8 @@ The version of this specific piece of software. [virtualLicense]: #virtuallicense #### [virtualLicense] This is set to '1' if this Software Description can be licensed to a Virtual Machine (an IP address). -Type: **integer** +Type: **integer** + @@ -189,7 +204,8 @@ This is set to '1' if this Software Description can be licensed to a Virtual Mac [virtualizationPlatform]: #virtualizationplatform #### [virtualizationPlatform] This is set to '1' if this Software Description a platform for hosting virtual servers. -Type: **integer** +Type: **integer** + @@ -205,7 +221,8 @@ This is set to '1' if this Software Description a platform for hosting virtual s [attributes]: #attributes #### [attributes] -Type: **SoftLayer_Software_Description_Attribute[] ** +Type: **SoftLayer_Software_Description_Attribute[] ** + @@ -215,7 +232,8 @@ This is set to '1' if this Software Description a platform for hosting virtual s [averageInstallationDuration]: #averageinstallationduration #### [averageInstallationDuration] The average amount of time that a software description takes to install. -Type: **integer** +Type: **integer** + @@ -225,7 +243,8 @@ The average amount of time that a software description takes to install. [compatibleSoftwareDescriptions]: #compatiblesoftwaredescriptions #### [compatibleSoftwareDescriptions] A list of the software descriptions that are compatible with this software description. -Type: **SoftLayer_Software_Description[] ** +Type: **SoftLayer_Software_Description[] ** + @@ -235,7 +254,8 @@ A list of the software descriptions that are compatible with this software descr [features]: #features #### [features] The feature attributes of a software description. -Type: **SoftLayer_Software_Description_Feature[] ** +Type: **SoftLayer_Software_Description_Feature[] ** + @@ -245,7 +265,8 @@ The feature attributes of a software description. [latestVersion]: #latestversion #### [latestVersion] The latest version of a software description. -Type: **SoftLayer_Software_Description[] ** +Type: **SoftLayer_Software_Description[] ** + @@ -255,7 +276,8 @@ The latest version of a software description. [productItems]: #productitems #### [productItems] The various product items to which this software description is linked. -Type: **SoftLayer_Product_Item[] ** +Type: **SoftLayer_Product_Item[] ** + @@ -265,7 +287,8 @@ The various product items to which this software description is linked. [provisionTransactionGroup]: #provisiontransactiongroup #### [provisionTransactionGroup] This details the provisioning transaction group for this software. This is only valid for Operating System software. -Type: **SoftLayer_Provisioning_Version1_Transaction_Group ** +Type: **SoftLayer_Provisioning_Version1_Transaction_Group ** + @@ -275,7 +298,8 @@ This details the provisioning transaction group for this software. This is only [reloadTransactionGroup]: #reloadtransactiongroup #### [reloadTransactionGroup] The transaction group that a software description belongs to. A transaction group is a sequence of transactions that must be performed in a specific order for the installation of software. -Type: **SoftLayer_Provisioning_Version1_Transaction_Group ** +Type: **SoftLayer_Provisioning_Version1_Transaction_Group ** + @@ -285,7 +309,8 @@ The transaction group that a software description belongs to. A transaction grou [requiredUser]: #requireduser #### [requiredUser] The default user created for a given a software description. -Type: **string** +Type: **string** + @@ -295,7 +320,8 @@ The default user created for a given a software description. [softwareLicenses]: #softwarelicenses #### [softwareLicenses] Software Licenses that govern this Software Description. -Type: **SoftLayer_Software_License[] ** +Type: **SoftLayer_Software_License[] ** + @@ -305,7 +331,8 @@ Software Licenses that govern this Software Description. [upgradeSoftwareDescription]: #upgradesoftwaredescription #### [upgradeSoftwareDescription] A suggestion for an upgrade path from this Software Description -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -315,7 +342,8 @@ A suggestion for an upgrade path from this Software Description [upgradeSwDesc]: #upgradeswdesc #### [upgradeSwDesc] A suggestion for an upgrade path from this Software Description (Deprecated - Use upgradeSoftwareDescription) -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -325,7 +353,8 @@ A suggestion for an upgrade path from this Software Description (Deprecated - Us [validFilesystemTypes]: #validfilesystemtypes #### [validFilesystemTypes] -Type: **SoftLayer_Configuration_Storage_Filesystem_Type[] ** +Type: **SoftLayer_Configuration_Storage_Filesystem_Type[] ** + @@ -337,7 +366,8 @@ A suggestion for an upgrade path from this Software Description (Deprecated - Us [attributeCount]: #attributecount #### [attributeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -347,7 +377,8 @@ A count of [compatibleSoftwareDescriptionCount]: #compatiblesoftwaredescriptioncount #### [compatibleSoftwareDescriptionCount] A count of a list of the software descriptions that are compatible with this software description. -Type: **unsigned long** +Type: **unsigned long** + @@ -357,7 +388,8 @@ A count of a list of the software descriptions that are compatible with this sof [featureCount]: #featurecount #### [featureCount] A count of the feature attributes of a software description. -Type: **unsigned long** +Type: **unsigned long** + @@ -367,7 +399,8 @@ A count of the feature attributes of a software description. [latestVersionCount]: #latestversioncount #### [latestVersionCount] A count of the latest version of a software description. -Type: **unsigned long** +Type: **unsigned long** + @@ -377,7 +410,8 @@ A count of the latest version of a software description. [productItemCount]: #productitemcount #### [productItemCount] A count of the various product items to which this software description is linked. -Type: **unsigned long** +Type: **unsigned long** + @@ -387,7 +421,8 @@ A count of the various product items to which this software description is linke [softwareLicenseCount]: #softwarelicensecount #### [softwareLicenseCount] A count of software Licenses that govern this Software Description. -Type: **unsigned long** +Type: **unsigned long** + @@ -397,7 +432,8 @@ A count of software Licenses that govern this Software Description. [validFilesystemTypeCount]: #validfilesystemtypecount #### [validFilesystemTypeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Software_Description_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Software_Description_Attribute/_index.md index 2967c9c3ab..e37177e798 100644 --- a/content/reference/datatypes/SoftLayer_Software_Description_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Description_Attribute/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Software_Description_Attribute data type represents an attributes associated with this software description. @@ -45,7 +47,8 @@ The SoftLayer_Software_Description_Attribute data type represents an attributes [value]: #value #### [value] The value that was assigned to this attribute. -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ The value that was assigned to this attribute. [softwareDescription]: #softwaredescription #### [softwareDescription] -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -71,7 +75,8 @@ The value that was assigned to this attribute. [type]: #type #### [type] -Type: **SoftLayer_Software_Description_Attribute_Type ** +Type: **SoftLayer_Software_Description_Attribute_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Software_Description_Attribute_Type/_index.md b/content/reference/datatypes/SoftLayer_Software_Description_Attribute_Type/_index.md index 27a78168d3..6ccd2b59a7 100644 --- a/content/reference/datatypes/SoftLayer_Software_Description_Attribute_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Description_Attribute_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Software_Description_Attribute_Type data type represents the type of an attribute. @@ -45,7 +47,8 @@ The SoftLayer_Software_Description_Attribute_Type data type represents the type [keyname]: #keyname #### [keyname] The keyname for this attribute type. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Software_Description_Feature/_index.md b/content/reference/datatypes/SoftLayer_Software_Description_Feature/_index.md index 91b2fbebd3..0fa4b68795 100644 --- a/content/reference/datatypes/SoftLayer_Software_Description_Feature/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Description_Feature/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ The SoftLayer_Software_Description_Feature data type represents a single softwar [id]: #id #### [id] The unique identifier for a software description feature. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ The unique identifier for a software description feature. [keyName]: #keyname #### [keyName] A unique name used to reference this software description feature. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ A unique name used to reference this software description feature. [name]: #name #### [name] The name of a software description feature. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ The name of a software description feature. [vendor]: #vendor #### [vendor] The vendor that a software description feature belongs to. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Software_Description_RequiredUser/_index.md b/content/reference/datatypes/SoftLayer_Software_Description_RequiredUser/_index.md index 97b2649bf2..0ab18c8e09 100644 --- a/content/reference/datatypes/SoftLayer_Software_Description_RequiredUser/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_Description_RequiredUser/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class represents a software description's required user @@ -45,7 +47,8 @@ This class represents a software description's required user [defaultPassword]: #defaultpassword #### [defaultPassword] If the default password is set the user will be created with that password, otherwise a random password is generated. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ If the default password is set the user will be created with that password, othe [username]: #username #### [username] If this software has a required user (such as "root") this string contains it's name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Software_License/_index.md b/content/reference/datatypes/SoftLayer_Software_License/_index.md index 05a4298278..3da693f4fc 100644 --- a/content/reference/datatypes/SoftLayer_Software_License/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_License/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class describes a specific type of license, like a Microsoft Windows Site License, a GPL license, or a license of another type. @@ -53,7 +55,8 @@ This class describes a specific type of license, like a Microsoft Windows Site L [id]: #id #### [id] An ID number for this specific License type. -Type: **integer** +Type: **integer** + @@ -63,7 +66,8 @@ An ID number for this specific License type. [softwareDescriptionId]: #softwaredescriptionid #### [softwareDescriptionId] The ID number of a Software Description that this specific license is valid for. -Type: **integer** +Type: **integer** + @@ -79,7 +83,8 @@ The ID number of a Software Description that this specific license is valid for. [account]: #account #### [account] The account that owns this specific License instance. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -89,7 +94,8 @@ The account that owns this specific License instance. [owner]: #owner #### [owner] The account that owns this specific License instance. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -99,7 +105,8 @@ The account that owns this specific License instance. [softwareDescription]: #softwaredescription #### [softwareDescription] A Description of the software that this license instance is valid for. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + diff --git a/content/reference/datatypes/SoftLayer_Software_VirtualLicense/_index.md b/content/reference/datatypes/SoftLayer_Software_VirtualLicense/_index.md index a4d9b77073..101ce08e59 100644 --- a/content/reference/datatypes/SoftLayer_Software_VirtualLicense/_index.md +++ b/content/reference/datatypes/SoftLayer_Software_VirtualLicense/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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". @@ -62,7 +64,8 @@ SoftLayer_Software_VirtualLicense is the application class that handles a specia [accountId]: #accountid #### [accountId] The ID of the SoftLayer Account to which this Virtual License belongs to. -Type: **integer** +Type: **integer** + @@ -72,7 +75,8 @@ The ID of the SoftLayer Account to which this Virtual License belongs to. [hostHardwareId]: #hosthardwareid #### [hostHardwareId] The ID of the SoftLayer Hardware Server record to which this Virtual License belongs. -Type: **integer** +Type: **integer** + @@ -82,7 +86,8 @@ The ID of the SoftLayer Hardware Server record to which this Virtual License bel [id]: #id #### [id] An ID number for this Virtual License instance. -Type: **integer** +Type: **integer** + @@ -92,7 +97,8 @@ An ID number for this Virtual License instance. [ipAddress]: #ipaddress #### [ipAddress] The specific IP address this Virtual License belongs to. -Type: **string** +Type: **string** + @@ -102,7 +108,8 @@ The specific IP address this Virtual License belongs to. [key]: #key #### [key] The License Key for this specific Virtual License. -Type: **string** +Type: **string** + @@ -112,7 +119,8 @@ The License Key for this specific Virtual License. [notes]: #notes #### [notes] A "notes" string attached to this specific Virtual License. -Type: **string** +Type: **string** + @@ -122,7 +130,8 @@ A "notes" string attached to this specific Virtual License. [softwareDescriptionId]: #softwaredescriptionid #### [softwareDescriptionId] The Software Description ID this Virtual License is for. -Type: **integer** +Type: **integer** + @@ -132,7 +141,8 @@ The Software Description ID this Virtual License is for. [subnetId]: #subnetid #### [subnetId] The ID of the SoftLayer Network Subnet this Virtual License belongs to. -Type: **integer** +Type: **integer** + @@ -148,7 +158,8 @@ The ID of the SoftLayer Network Subnet this Virtual License belongs to. [account]: #account #### [account] The customer account this Virtual License belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -158,7 +169,8 @@ The customer account this Virtual License belongs to. [billingItem]: #billingitem #### [billingItem] The billing item for a software virtual license. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -168,7 +180,8 @@ The billing item for a software virtual license. [hostHardware]: #hosthardware #### [hostHardware] The hardware record to which the software virtual license is assigned. -Type: **SoftLayer_Hardware_Server ** +Type: **SoftLayer_Hardware_Server ** + @@ -178,7 +191,8 @@ The hardware record to which the software virtual license is assigned. [ipAddressRecord]: #ipaddressrecord #### [ipAddressRecord] The IP Address record associated with a virtual license. -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -188,7 +202,8 @@ The IP Address record associated with a virtual license. [softwareDescription]: #softwaredescription #### [softwareDescription] The SoftLayer_Software_Description that this virtual license is for. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -198,7 +213,8 @@ The SoftLayer_Software_Description that this virtual license is for. [subnet]: #subnet #### [subnet] The subnet this Virtual License's IP address belongs to. -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + diff --git a/content/reference/datatypes/SoftLayer_Survey/_index.md b/content/reference/datatypes/SoftLayer_Survey/_index.md index 0d9506246f..fbaef3fe3d 100644 --- a/content/reference/datatypes/SoftLayer_Survey/_index.md +++ b/content/reference/datatypes/SoftLayer_Survey/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Survey data type contains general information relating to a single SoftLayer survey. @@ -45,7 +47,8 @@ The SoftLayer_Survey data type contains general information relating to a single [active]: #active #### [active] A flag indicating if a survey can be taken. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ A flag indicating if a survey can be taken. [createDate]: #createdate #### [createDate] The date that a survey had originally started. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The date that a survey had originally started. [id]: #id #### [id] A survey's id. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A survey's id. [name]: #name #### [name] A survey's name or title. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ A survey's name or title. [statusId]: #statusid #### [statusId] The status id of the survey. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The status id of the survey. [typeId]: #typeid #### [typeId] The type id of the survey. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The type id of the survey. [questions]: #questions #### [questions] The questions for a survey. -Type: **SoftLayer_Survey_Question[] ** +Type: **SoftLayer_Survey_Question[] ** + @@ -121,7 +130,8 @@ The questions for a survey. [status]: #status #### [status] The status of the survey -Type: **SoftLayer_Survey_Status ** +Type: **SoftLayer_Survey_Status ** + @@ -131,7 +141,8 @@ The status of the survey [type]: #type #### [type] The type of survey -Type: **SoftLayer_Survey_Type ** +Type: **SoftLayer_Survey_Type ** + @@ -143,7 +154,8 @@ The type of survey [questionCount]: #questioncount #### [questionCount] A count of the questions for a survey. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Survey_Answer/_index.md b/content/reference/datatypes/SoftLayer_Survey_Answer/_index.md index 7a5262a893..aae953cc6e 100644 --- a/content/reference/datatypes/SoftLayer_Survey_Answer/_index.md +++ b/content/reference/datatypes/SoftLayer_Survey_Answer/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Survey_Answer data type contains general information relating to a single SoftLayer survey answer. @@ -45,7 +47,8 @@ The SoftLayer_Survey_Answer data type contains general information relating to a [answer]: #answer #### [answer] A survey answer's answer that a user can response too. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ A survey answer's answer that a user can response too. [answerOrder]: #answerorder #### [answerOrder] A value indicating the order in when a survey answer will be displayed to a user. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A value indicating the order in when a survey answer will be displayed to a user [id]: #id #### [id] A survey answer's Id. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A survey answer's Id. [surveyQuestionId]: #surveyquestionid #### [surveyQuestionId] A survey answer's associated [SoftLayer_Survey_Question]({{}}) Id. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ A survey answer's associated [SoftLayer_Survey_Question]({{Type: **SoftLayer_Survey_Question ** +Type: **SoftLayer_Survey_Question ** + diff --git a/content/reference/datatypes/SoftLayer_Survey_Question/_index.md b/content/reference/datatypes/SoftLayer_Survey_Question/_index.md index d51afffe67..d8f5377c3f 100644 --- a/content/reference/datatypes/SoftLayer_Survey_Question/_index.md +++ b/content/reference/datatypes/SoftLayer_Survey_Question/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Survey_Question data type contains general information relating to a single SoftLayer survey question. @@ -45,7 +47,8 @@ The SoftLayer_Survey_Question data type contains general information relating to [id]: #id #### [id] A survey question's Id. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ A survey question's Id. [isRequired]: #isrequired #### [isRequired] A flag indicating that a survey question requires a response. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ A flag indicating that a survey question requires a response. [multiAnswer]: #multianswer #### [multiAnswer] A flag indicating that a survey question can have multiple answers responded to. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A flag indicating that a survey question can have multiple answers responded to. [question]: #question #### [question] A survey question's question. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ A survey question's question. [questionOrder]: #questionorder #### [questionOrder] A value indicating the order in when a survey question will be asked. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ A value indicating the order in when a survey question will be asked. [surveyId]: #surveyid #### [surveyId] A survey question's associated [SoftLayer_Survey]({{}}) Id. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ A survey question's associated [SoftLayer_Survey]({{Type: **SoftLayer_Survey_Answer[] ** +Type: **SoftLayer_Survey_Answer[] ** + @@ -121,7 +130,8 @@ The possible answers for a survey question. [survey]: #survey #### [survey] The survey that a question belongs to. -Type: **SoftLayer_Survey ** +Type: **SoftLayer_Survey ** + @@ -133,7 +143,8 @@ The survey that a question belongs to. [answerCount]: #answercount #### [answerCount] A count of the possible answers for a survey question. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Survey_Response/_index.md b/content/reference/datatypes/SoftLayer_Survey_Response/_index.md index 1f29026677..ef15a8c61b 100644 --- a/content/reference/datatypes/SoftLayer_Survey_Response/_index.md +++ b/content/reference/datatypes/SoftLayer_Survey_Response/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Survey_Response data type contains general information relating to a single SoftLayer survey response. @@ -45,7 +47,8 @@ The SoftLayer_Survey_Response data type contains general information relating to [otherAnswer]: #otheranswer #### [otherAnswer] The user typed response for the [SoftLayer_Survey_Answer]({{}}) that a response is associated with. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The user typed response for the [SoftLayer_Survey_Answer]({{}}) that a response was made for. -Type: **integer** +Type: **integer** + @@ -71,7 +75,8 @@ The Id of the [SoftLayer_Survey_Answer]({{Type: **SoftLayer_Survey_Answer ** +Type: **SoftLayer_Survey_Answer ** + diff --git a/content/reference/datatypes/SoftLayer_Survey_Status/_index.md b/content/reference/datatypes/SoftLayer_Survey_Status/_index.md index 1b8c2f2d5b..0a06e7e4bf 100644 --- a/content/reference/datatypes/SoftLayer_Survey_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Survey_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Survey_Status data type contains survey status information. @@ -45,7 +47,8 @@ The SoftLayer_Survey_Status data type contains survey status information. [description]: #description #### [description] Description of a survey status -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Description of a survey status [id]: #id #### [id] Internal identifier of a survey status -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Internal identifier of a survey status [name]: #name #### [name] Name of a survey status -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Survey_Type/_index.md b/content/reference/datatypes/SoftLayer_Survey_Type/_index.md index 5bc5b07730..6b90afe168 100644 --- a/content/reference/datatypes/SoftLayer_Survey_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Survey_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Survey_Type data type contains survey type information. @@ -45,7 +47,8 @@ The SoftLayer_Survey_Type data type contains survey type information. [description]: #description #### [description] Description of a survey type -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Description of a survey type [id]: #id #### [id] Internal identifier of a survey type -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Internal identifier of a survey type [name]: #name #### [name] Name of a survey type -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Tag/_index.md b/content/reference/datatypes/SoftLayer_Tag/_index.md index c33cbead7a..6a53061980 100644 --- a/content/reference/datatypes/SoftLayer_Tag/_index.md +++ b/content/reference/datatypes/SoftLayer_Tag/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_Tag data type is an optional type associated with hardware. The ac [accountId]: #accountid #### [accountId] Account the tag belongs to. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Account the tag belongs to. [id]: #id #### [id] Unique identifier for a tag. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Unique identifier for a tag. [internal]: #internal #### [internal] Indicates whether a tag is internal. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ Indicates whether a tag is internal. [name]: #name #### [name] Name of the tag. The characters permitted are A-Z, 0-9, whitespace, -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ Name of the tag. The characters permitted are A-Z, 0-9, whitespace, [account]: #account #### [account] The account to which the tag is tied. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -101,7 +108,8 @@ The account to which the tag is tied. [references]: #references #### [references] References that tie object to the tag. -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** + @@ -113,7 +121,8 @@ References that tie object to the tag. [referenceCount]: #referencecount #### [referenceCount] A count of references that tie object to the tag. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Tag_Reference/_index.md b/content/reference/datatypes/SoftLayer_Tag_Reference/_index.md index 0b549547ae..52365b743a 100644 --- a/content/reference/datatypes/SoftLayer_Tag_Reference/_index.md +++ b/content/reference/datatypes/SoftLayer_Tag_Reference/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [empRecordId]: #emprecordid #### [empRecordId] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [resourceTableId]: #resourcetableid #### [resourceTableId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [tagId]: #tagid #### [tagId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [tagTypeId]: #tagtypeid #### [tagTypeId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [usrRecordId]: #usrrecordid #### [usrRecordId] -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ classes: [customer]: #customer #### [customer] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -121,7 +130,8 @@ classes: [employee]: #employee #### [employee] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -131,7 +141,8 @@ classes: [tag]: #tag #### [tag] -Type: **SoftLayer_Tag ** +Type: **SoftLayer_Tag ** + @@ -141,7 +152,8 @@ classes: [tagType]: #tagtype #### [tagType] -Type: **SoftLayer_Tag_Type ** +Type: **SoftLayer_Tag_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Tag_Reference_Hardware/_index.md b/content/reference/datatypes/SoftLayer_Tag_Reference_Hardware/_index.md index 99679230f5..0f91c9f9ea 100644 --- a/content/reference/datatypes/SoftLayer_Tag_Reference_Hardware/_index.md +++ b/content/reference/datatypes/SoftLayer_Tag_Reference_Hardware/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [empRecordId]: #emprecordid #### [empRecordId] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [resourceTableId]: #resourcetableid #### [resourceTableId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [tagId]: #tagid #### [tagId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [tagTypeId]: #tagtypeid #### [tagTypeId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [usrRecordId]: #usrrecordid #### [usrRecordId] -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ classes: [customer]: #customer #### [customer] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -121,7 +130,8 @@ classes: [employee]: #employee #### [employee] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -131,7 +141,8 @@ classes: [resource]: #resource #### [resource] -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -141,7 +152,8 @@ classes: [tag]: #tag #### [tag] -Type: **SoftLayer_Tag ** +Type: **SoftLayer_Tag ** + @@ -151,7 +163,8 @@ classes: [tagType]: #tagtype #### [tagType] -Type: **SoftLayer_Tag_Type ** +Type: **SoftLayer_Tag_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Tag_Reference_Network_Application_Delivery_Controller/_index.md b/content/reference/datatypes/SoftLayer_Tag_Reference_Network_Application_Delivery_Controller/_index.md index d6d396985e..43a7d95271 100644 --- a/content/reference/datatypes/SoftLayer_Tag_Reference_Network_Application_Delivery_Controller/_index.md +++ b/content/reference/datatypes/SoftLayer_Tag_Reference_Network_Application_Delivery_Controller/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [empRecordId]: #emprecordid #### [empRecordId] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [resourceTableId]: #resourcetableid #### [resourceTableId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [tagId]: #tagid #### [tagId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [tagTypeId]: #tagtypeid #### [tagTypeId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [usrRecordId]: #usrrecordid #### [usrRecordId] -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ classes: [customer]: #customer #### [customer] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -121,7 +130,8 @@ classes: [employee]: #employee #### [employee] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -131,7 +141,8 @@ classes: [resource]: #resource #### [resource] -Type: **SoftLayer_Network_Application_Delivery_Controller ** +Type: **SoftLayer_Network_Application_Delivery_Controller ** + @@ -141,7 +152,8 @@ classes: [tag]: #tag #### [tag] -Type: **SoftLayer_Tag ** +Type: **SoftLayer_Tag ** + @@ -151,7 +163,8 @@ classes: [tagType]: #tagtype #### [tagType] -Type: **SoftLayer_Tag_Type ** +Type: **SoftLayer_Tag_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Tag_Reference_Network_Vlan/_index.md b/content/reference/datatypes/SoftLayer_Tag_Reference_Network_Vlan/_index.md index 5d5ba17a73..89349df5f7 100644 --- a/content/reference/datatypes/SoftLayer_Tag_Reference_Network_Vlan/_index.md +++ b/content/reference/datatypes/SoftLayer_Tag_Reference_Network_Vlan/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [empRecordId]: #emprecordid #### [empRecordId] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [resourceTableId]: #resourcetableid #### [resourceTableId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [tagId]: #tagid #### [tagId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [tagTypeId]: #tagtypeid #### [tagTypeId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [usrRecordId]: #usrrecordid #### [usrRecordId] -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ classes: [customer]: #customer #### [customer] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -121,7 +130,8 @@ classes: [employee]: #employee #### [employee] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -131,7 +141,8 @@ classes: [resource]: #resource #### [resource] -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + @@ -141,7 +152,8 @@ classes: [tag]: #tag #### [tag] -Type: **SoftLayer_Tag ** +Type: **SoftLayer_Tag ** + @@ -151,7 +163,8 @@ classes: [tagType]: #tagtype #### [tagType] -Type: **SoftLayer_Tag_Type ** +Type: **SoftLayer_Tag_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Tag_Reference_Network_Vlan_Firewall/_index.md b/content/reference/datatypes/SoftLayer_Tag_Reference_Network_Vlan_Firewall/_index.md index 2dd0b68b67..57f2cf06e2 100644 --- a/content/reference/datatypes/SoftLayer_Tag_Reference_Network_Vlan_Firewall/_index.md +++ b/content/reference/datatypes/SoftLayer_Tag_Reference_Network_Vlan_Firewall/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [empRecordId]: #emprecordid #### [empRecordId] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [resourceTableId]: #resourcetableid #### [resourceTableId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [tagId]: #tagid #### [tagId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [tagTypeId]: #tagtypeid #### [tagTypeId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [usrRecordId]: #usrrecordid #### [usrRecordId] -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ classes: [customer]: #customer #### [customer] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -121,7 +130,8 @@ classes: [employee]: #employee #### [employee] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -131,7 +141,8 @@ classes: [resource]: #resource #### [resource] -Type: **SoftLayer_Network_Vlan_Firewall ** +Type: **SoftLayer_Network_Vlan_Firewall ** + @@ -141,7 +152,8 @@ classes: [tag]: #tag #### [tag] -Type: **SoftLayer_Tag ** +Type: **SoftLayer_Tag ** + @@ -151,7 +163,8 @@ classes: [tagType]: #tagtype #### [tagType] -Type: **SoftLayer_Tag_Type ** +Type: **SoftLayer_Tag_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Tag_Reference_Resource_Group/_index.md b/content/reference/datatypes/SoftLayer_Tag_Reference_Resource_Group/_index.md index 87fca02c33..5fc4b2a752 100644 --- a/content/reference/datatypes/SoftLayer_Tag_Reference_Resource_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Tag_Reference_Resource_Group/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [empRecordId]: #emprecordid #### [empRecordId] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [resourceTableId]: #resourcetableid #### [resourceTableId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [tagId]: #tagid #### [tagId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [tagTypeId]: #tagtypeid #### [tagTypeId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [usrRecordId]: #usrrecordid #### [usrRecordId] -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ classes: [customer]: #customer #### [customer] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -121,7 +130,8 @@ classes: [employee]: #employee #### [employee] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -131,7 +141,8 @@ classes: [resource]: #resource #### [resource] -Type: **SoftLayer_Resource_Group ** +Type: **SoftLayer_Resource_Group ** + @@ -141,7 +152,8 @@ classes: [tag]: #tag #### [tag] -Type: **SoftLayer_Tag ** +Type: **SoftLayer_Tag ** + @@ -151,7 +163,8 @@ classes: [tagType]: #tagtype #### [tagType] -Type: **SoftLayer_Tag_Type ** +Type: **SoftLayer_Tag_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Tag_Reference_Virtual_DedicatedHost/_index.md b/content/reference/datatypes/SoftLayer_Tag_Reference_Virtual_DedicatedHost/_index.md index 5d7e5bb4c9..8e5fa5f4fb 100644 --- a/content/reference/datatypes/SoftLayer_Tag_Reference_Virtual_DedicatedHost/_index.md +++ b/content/reference/datatypes/SoftLayer_Tag_Reference_Virtual_DedicatedHost/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [empRecordId]: #emprecordid #### [empRecordId] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [resourceTableId]: #resourcetableid #### [resourceTableId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [tagId]: #tagid #### [tagId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [tagTypeId]: #tagtypeid #### [tagTypeId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [usrRecordId]: #usrrecordid #### [usrRecordId] -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ classes: [customer]: #customer #### [customer] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -121,7 +130,8 @@ classes: [employee]: #employee #### [employee] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -131,7 +141,8 @@ classes: [resource]: #resource #### [resource] -Type: **SoftLayer_Virtual_DedicatedHost ** +Type: **SoftLayer_Virtual_DedicatedHost ** + @@ -141,7 +152,8 @@ classes: [tag]: #tag #### [tag] -Type: **SoftLayer_Tag ** +Type: **SoftLayer_Tag ** + @@ -151,7 +163,8 @@ classes: [tagType]: #tagtype #### [tagType] -Type: **SoftLayer_Tag_Type ** +Type: **SoftLayer_Tag_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Tag_Reference_Virtual_Guest/_index.md b/content/reference/datatypes/SoftLayer_Tag_Reference_Virtual_Guest/_index.md index 21a0c58569..d5e1f9f304 100644 --- a/content/reference/datatypes/SoftLayer_Tag_Reference_Virtual_Guest/_index.md +++ b/content/reference/datatypes/SoftLayer_Tag_Reference_Virtual_Guest/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [empRecordId]: #emprecordid #### [empRecordId] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [resourceTableId]: #resourcetableid #### [resourceTableId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [tagId]: #tagid #### [tagId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [tagTypeId]: #tagtypeid #### [tagTypeId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [usrRecordId]: #usrrecordid #### [usrRecordId] -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ classes: [customer]: #customer #### [customer] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -121,7 +130,8 @@ classes: [employee]: #employee #### [employee] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -131,7 +141,8 @@ classes: [resource]: #resource #### [resource] -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -141,7 +152,8 @@ classes: [tag]: #tag #### [tag] -Type: **SoftLayer_Tag ** +Type: **SoftLayer_Tag ** + @@ -151,7 +163,8 @@ classes: [tagType]: #tagtype #### [tagType] -Type: **SoftLayer_Tag_Type ** +Type: **SoftLayer_Tag_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Tag_Reference_Virtual_Guest_Block_Device_Template_Group/_index.md b/content/reference/datatypes/SoftLayer_Tag_Reference_Virtual_Guest_Block_Device_Template_Group/_index.md index e0608fffc5..f9891bbde9 100644 --- a/content/reference/datatypes/SoftLayer_Tag_Reference_Virtual_Guest_Block_Device_Template_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Tag_Reference_Virtual_Guest_Block_Device_Template_Group/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [empRecordId]: #emprecordid #### [empRecordId] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [resourceTableId]: #resourcetableid #### [resourceTableId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [tagId]: #tagid #### [tagId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [tagTypeId]: #tagtypeid #### [tagTypeId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [usrRecordId]: #usrrecordid #### [usrRecordId] -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ classes: [customer]: #customer #### [customer] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -121,7 +130,8 @@ classes: [employee]: #employee #### [employee] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -131,7 +141,8 @@ classes: [resource]: #resource #### [resource] -Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group ** +Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group ** + @@ -141,7 +152,8 @@ classes: [tag]: #tag #### [tag] -Type: **SoftLayer_Tag ** +Type: **SoftLayer_Tag ** + @@ -151,7 +163,8 @@ classes: [tagType]: #tagtype #### [tagType] -Type: **SoftLayer_Tag_Type ** +Type: **SoftLayer_Tag_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Tag_Type/_index.md b/content/reference/datatypes/SoftLayer_Tag_Type/_index.md index a3384bf790..0dab835516 100644 --- a/content/reference/datatypes/SoftLayer_Tag_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Tag_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
              diff --git a/content/reference/datatypes/SoftLayer_Ticket/_index.md b/content/reference/datatypes/SoftLayer_Ticket/_index.md index 70f0ff255b..7f29d530bd 100644 --- a/content/reference/datatypes/SoftLayer_Ticket/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) service page. To create a support ticket execute the [SoftLayer_Ticket::createStandardTicket]({{}}). @@ -65,7 +67,8 @@ To create a support ticket execute the [SoftLayer_Ticket::createStandardTicket]( [accountId]: #accountid #### [accountId] An internal identifier of the SoftLayer customer account that a ticket is associated with. -Type: **integer** +Type: **integer** + @@ -75,7 +78,8 @@ An internal identifier of the SoftLayer customer account that a ticket is associ [assignedUserId]: #assigneduserid #### [assignedUserId] An internal identifier of the portal user that a ticket is assigned to. -Type: **integer** +Type: **integer** + @@ -85,7 +89,8 @@ An internal identifier of the portal user that a ticket is assigned to. [billableFlag]: #billableflag #### [billableFlag] Whether a ticket has a one-time charge associated with it. Standard tickets are free while administrative tickets typically cost $3 USD. -Type: **boolean** +Type: **boolean** + @@ -95,7 +100,8 @@ Whether a ticket has a one-time charge associated with it. Standard tickets are [bnppSupportedLocationId]: #bnppsupportedlocationid #### [bnppSupportedLocationId] -Type: **integer** +Type: **integer** + @@ -105,7 +111,8 @@ Whether a ticket has a one-time charge associated with it. Standard tickets are [changeOwnerFlag]: #changeownerflag #### [changeOwnerFlag] -Type: **boolean** +Type: **boolean** + @@ -115,7 +122,8 @@ Whether a ticket has a one-time charge associated with it. Standard tickets are [createDate]: #createdate #### [createDate] The date that a ticket was created. -Type: **dateTime** +Type: **dateTime** + @@ -125,7 +133,8 @@ The date that a ticket was created. [euSupportedLocationId]: #eusupportedlocationid #### [euSupportedLocationId] -Type: **integer** +Type: **integer** + @@ -135,7 +144,8 @@ The date that a ticket was created. [finalComments]: #finalcomments #### [finalComments] Feedback left by a portal or API user on their experiences in a ticket. Final comments may be created after a ticket is closed. -Type: **string** +Type: **string** + @@ -145,7 +155,8 @@ Feedback left by a portal or API user on their experiences in a ticket. Final co [groupId]: #groupid #### [groupId] The internal identifier of the SoftLayer department that a ticket is assigned to. -Type: **integer** +Type: **integer** + @@ -155,7 +166,8 @@ The internal identifier of the SoftLayer department that a ticket is assigned to [id]: #id #### [id] A ticket's internal identifier. Each ticket is defined by a unique identifier. -Type: **integer** +Type: **integer** + @@ -165,7 +177,8 @@ A ticket's internal identifier. Each ticket is defined by a unique identifier. [lastEditDate]: #lasteditdate #### [lastEditDate] The date that a ticket was last modified. A modification does not necessarily mean that an update was added. -Type: **dateTime** +Type: **dateTime** + @@ -175,7 +188,8 @@ The date that a ticket was last modified. A modification does not necessarily me [lastEditType]: #lastedittype #### [lastEditType] The type of user who last edited or updated a ticket. This is either "EMPLOYEE" or "USER". -Type: **string** +Type: **string** + @@ -185,7 +199,8 @@ The type of user who last edited or updated a ticket. This is either "EMPLOYEE" [lastResponseDate]: #lastresponsedate #### [lastResponseDate] The date that the last ticket update was made -Type: **dateTime** +Type: **dateTime** + @@ -195,7 +210,8 @@ The date that the last ticket update was made [locationId]: #locationid #### [locationId] The internal identifier of the location associated with a ticket. -Type: **integer** +Type: **integer** + @@ -205,7 +221,8 @@ The internal identifier of the location associated with a ticket. [modifyDate]: #modifydate #### [modifyDate] The date that a ticket was last updated. -Type: **dateTime** +Type: **dateTime** + @@ -215,7 +232,8 @@ The date that a ticket was last updated. [notifyUserOnUpdateFlag]: #notifyuseronupdateflag #### [notifyUserOnUpdateFlag] Whether or not the user who owns a ticket is notified via email when a ticket is updated. -Type: **boolean** +Type: **boolean** + @@ -225,7 +243,8 @@ Whether or not the user who owns a ticket is notified via email when a ticket is [originatingIpAddress]: #originatingipaddress #### [originatingIpAddress] The IP address of the user who opened a ticket. -Type: **string** +Type: **string** + @@ -235,7 +254,8 @@ The IP address of the user who opened a ticket. [priority]: #priority #### [priority] -Type: **integer** +Type: **integer** + @@ -245,7 +265,8 @@ The IP address of the user who opened a ticket. [responsibleBrandId]: #responsiblebrandid #### [responsibleBrandId] -Type: **integer** +Type: **integer** + @@ -255,7 +276,8 @@ The IP address of the user who opened a ticket. [serverAdministrationBillingAmount]: #serveradministrationbillingamount #### [serverAdministrationBillingAmount] The amount of money in US Dollars ($USD) that a ticket has charged to an account. A ticket's administrative billing amount is a one time charge and only applies to administrative support tickets. -Type: **integer** +Type: **integer** + @@ -265,7 +287,8 @@ The amount of money in US Dollars ($USD) that a ticket has charged to an account [serverAdministrationBillingInvoiceId]: #serveradministrationbillinginvoiceid #### [serverAdministrationBillingInvoiceId] The internal identifier of the invoice associated with a ticket's administrative charge. Only tickets with an administrative charge have an associated invoice. -Type: **integer** +Type: **integer** + @@ -275,7 +298,8 @@ The internal identifier of the invoice associated with a ticket's administrative [serverAdministrationFlag]: #serveradministrationflag #### [serverAdministrationFlag] Whether a ticket is a standard or an administrative support ticket. Administrative support tickets typically incur a $3 USD charge. -Type: **integer** +Type: **integer** + @@ -285,7 +309,8 @@ Whether a ticket is a standard or an administrative support ticket. Administrati [serverAdministrationRefundInvoiceId]: #serveradministrationrefundinvoiceid #### [serverAdministrationRefundInvoiceId] The internal identifier of the refund invoice associated with a ticket. Only tickets with an account refund associated with them have an associated refund invoice. -Type: **integer** +Type: **integer** + @@ -295,7 +320,8 @@ The internal identifier of the refund invoice associated with a ticket. Only tic [serviceProviderId]: #serviceproviderid #### [serviceProviderId] -Type: **integer** +Type: **integer** + @@ -305,7 +331,8 @@ The internal identifier of the refund invoice associated with a ticket. Only tic [serviceProviderResourceId]: #serviceproviderresourceid #### [serviceProviderResourceId] A ticket's internal identifier at its service provider. Each ticket is defined by a unique identifier. -Type: **string** +Type: **string** + @@ -315,7 +342,8 @@ A ticket's internal identifier at its service provider. Each ticket is defined b [statusId]: #statusid #### [statusId] A ticket status' internal identifier. -Type: **integer** +Type: **integer** + @@ -325,7 +353,8 @@ A ticket status' internal identifier. [subjectId]: #subjectid #### [subjectId] An internal identifier of the pre-set subject that a ticket is associated with. Standard support tickets have a subject set while administrative tickets have a null subject. A standard support ticket's title is the name of it's associated subject. -Type: **integer** +Type: **integer** + @@ -335,7 +364,8 @@ An internal identifier of the pre-set subject that a ticket is associated with. [title]: #title #### [title] A ticket's title. This is typically a brief summary of the issue described in the ticket. -Type: **string** +Type: **string** + @@ -345,7 +375,8 @@ A ticket's title. This is typically a brief summary of the issue described in th [totalUpdateCount]: #totalupdatecount #### [totalUpdateCount] -Type: **integer** +Type: **integer** + @@ -355,7 +386,8 @@ A ticket's title. This is typically a brief summary of the issue described in th [userEditableFlag]: #usereditableflag #### [userEditableFlag] Whether a user is able to update a ticket. -Type: **boolean** +Type: **boolean** + @@ -371,7 +403,8 @@ Whether a user is able to update a ticket. [account]: #account #### [account] The SoftLayer customer account associated with a ticket. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -381,7 +414,8 @@ The SoftLayer customer account associated with a ticket. [assignedAgents]: #assignedagents #### [assignedAgents] -Type: **SoftLayer_User_Customer[] ** +Type: **SoftLayer_User_Customer[] ** + @@ -391,7 +425,8 @@ The SoftLayer customer account associated with a ticket. [assignedUser]: #assigneduser #### [assignedUser] The portal user that a ticket is assigned to. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -401,7 +436,8 @@ The portal user that a ticket is assigned to. [attachedAdditionalEmails]: #attachedadditionalemails #### [attachedAdditionalEmails] The list of additional emails to notify when a ticket update is made. -Type: **SoftLayer_User_Customer_AdditionalEmail[] ** +Type: **SoftLayer_User_Customer_AdditionalEmail[] ** + @@ -411,7 +447,8 @@ The list of additional emails to notify when a ticket update is made. [attachedDedicatedHosts]: #attacheddedicatedhosts #### [attachedDedicatedHosts] The Dedicated Hosts associated with a ticket. This is used in cases where a ticket is directly associated with one or more Dedicated Hosts. -Type: **SoftLayer_Virtual_DedicatedHost[] ** +Type: **SoftLayer_Virtual_DedicatedHost[] ** + @@ -421,7 +458,8 @@ The Dedicated Hosts associated with a ticket. This is used in cases where a tick [attachedFiles]: #attachedfiles #### [attachedFiles] The files attached to a ticket. -Type: **SoftLayer_Ticket_Attachment_File[] ** +Type: **SoftLayer_Ticket_Attachment_File[] ** + @@ -431,7 +469,8 @@ The files attached to a ticket. [attachedHardware]: #attachedhardware #### [attachedHardware] The hardware associated with a ticket. This is used in cases where a ticket is directly associated with one or more pieces of hardware. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -441,7 +480,8 @@ The hardware associated with a ticket. This is used in cases where a ticket is d [attachedHardwareCount]: #attachedhardwarecount #### [attachedHardwareCount] -Type: **unsigned integer** +Type: **unsigned integer** + @@ -451,7 +491,8 @@ The hardware associated with a ticket. This is used in cases where a ticket is d [attachedResources]: #attachedresources #### [attachedResources] -Type: **SoftLayer_Ticket_Attachment[] ** +Type: **SoftLayer_Ticket_Attachment[] ** + @@ -461,7 +502,8 @@ The hardware associated with a ticket. This is used in cases where a ticket is d [attachedVirtualGuests]: #attachedvirtualguests #### [attachedVirtualGuests] The virtual guests associated with a ticket. This is used in cases where a ticket is directly associated with one or more virtualized guests installations or Virtual Servers. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -471,7 +513,8 @@ The virtual guests associated with a ticket. This is used in cases where a ticke [awaitingUserResponseFlag]: #awaitinguserresponseflag #### [awaitingUserResponseFlag] Ticket is waiting on a response from a customer flag. -Type: **boolean** +Type: **boolean** + @@ -481,7 +524,8 @@ Ticket is waiting on a response from a customer flag. [bnppSupportedFlag]: #bnppsupportedflag #### [bnppSupportedFlag] A ticket's associated BNPP compliant record -Type: **boolean** +Type: **boolean** + @@ -491,7 +535,8 @@ A ticket's associated BNPP compliant record [cancellationRequest]: #cancellationrequest #### [cancellationRequest] A service cancellation request. -Type: **SoftLayer_Billing_Item_Cancellation_Request ** +Type: **SoftLayer_Billing_Item_Cancellation_Request ** + @@ -501,7 +546,8 @@ A service cancellation request. [employeeAttachments]: #employeeattachments #### [employeeAttachments] -Type: **SoftLayer_User_Employee[] ** +Type: **SoftLayer_User_Employee[] ** + @@ -511,7 +557,8 @@ A service cancellation request. [euSupportedFlag]: #eusupportedflag #### [euSupportedFlag] A ticket's associated EU compliant record -Type: **boolean** +Type: **boolean** + @@ -521,7 +568,8 @@ A ticket's associated EU compliant record [firstAttachedResource]: #firstattachedresource #### [firstAttachedResource] The first physical or virtual server attached to a ticket. -Type: **SoftLayer_Ticket_Attachment ** +Type: **SoftLayer_Ticket_Attachment ** + @@ -531,7 +579,8 @@ The first physical or virtual server attached to a ticket. [firstUpdate]: #firstupdate #### [firstUpdate] The first update made to a ticket. This is typically the contents of a ticket when it's created. -Type: **SoftLayer_Ticket_Update ** +Type: **SoftLayer_Ticket_Update ** + @@ -541,7 +590,8 @@ The first update made to a ticket. This is typically the contents of a ticket wh [fsboaSupportedFlag]: #fsboasupportedflag #### [fsboaSupportedFlag] A ticket's associated FSBOA compliant record -Type: **boolean** +Type: **boolean** + @@ -551,7 +601,8 @@ A ticket's associated FSBOA compliant record [group]: #group #### [group] The SoftLayer department that a ticket is assigned to. -Type: **SoftLayer_Ticket_Group ** +Type: **SoftLayer_Ticket_Group ** + @@ -561,7 +612,8 @@ The SoftLayer department that a ticket is assigned to. [invoiceItems]: #invoiceitems #### [invoiceItems] The invoice items associated with a ticket. Ticket based invoice items only exist when a ticket incurs a fee that has been invoiced. -Type: **SoftLayer_Billing_Invoice_Item[] ** +Type: **SoftLayer_Billing_Invoice_Item[] ** + @@ -571,7 +623,8 @@ The invoice items associated with a ticket. Ticket based invoice items only exis [lastActivity]: #lastactivity #### [lastActivity] -Type: **SoftLayer_Ticket_Activity ** +Type: **SoftLayer_Ticket_Activity ** + @@ -581,7 +634,8 @@ The invoice items associated with a ticket. Ticket based invoice items only exis [lastEditor]: #lasteditor #### [lastEditor] -Type: **SoftLayer_User_Interface ** +Type: **SoftLayer_User_Interface ** + @@ -591,7 +645,8 @@ The invoice items associated with a ticket. Ticket based invoice items only exis [lastUpdate]: #lastupdate #### [lastUpdate] The last update made to a ticket. -Type: **SoftLayer_Ticket_Update ** +Type: **SoftLayer_Ticket_Update ** + @@ -601,7 +656,8 @@ The last update made to a ticket. [location]: #location #### [location] A ticket's associated location within the SoftLayer location hierarchy. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -611,7 +667,8 @@ A ticket's associated location within the SoftLayer location hierarchy. [newUpdatesFlag]: #newupdatesflag #### [newUpdatesFlag] True if there are new, unread updates to this ticket for the current user, False otherwise. -Type: **boolean** +Type: **boolean** + @@ -621,7 +678,8 @@ True if there are new, unread updates to this ticket for the current user, False [scheduledActions]: #scheduledactions #### [scheduledActions] -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + @@ -631,7 +689,8 @@ True if there are new, unread updates to this ticket for the current user, False [serverAdministrationBillingInvoice]: #serveradministrationbillinginvoice #### [serverAdministrationBillingInvoice] The invoice associated with a ticket. Only tickets with an associated administrative charge have an invoice. -Type: **SoftLayer_Billing_Invoice ** +Type: **SoftLayer_Billing_Invoice ** + @@ -641,7 +700,8 @@ The invoice associated with a ticket. Only tickets with an associated administra [serverAdministrationRefundInvoice]: #serveradministrationrefundinvoice #### [serverAdministrationRefundInvoice] The refund invoice associated with a ticket. Only tickets with a refund applied in them have an associated refund invoice. -Type: **SoftLayer_Billing_Invoice ** +Type: **SoftLayer_Billing_Invoice ** + @@ -651,7 +711,8 @@ The refund invoice associated with a ticket. Only tickets with a refund applied [serviceProvider]: #serviceprovider #### [serviceProvider] -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -661,7 +722,8 @@ The refund invoice associated with a ticket. Only tickets with a refund applied [state]: #state #### [state] -Type: **SoftLayer_Ticket_State[] ** +Type: **SoftLayer_Ticket_State[] ** + @@ -671,7 +733,8 @@ The refund invoice associated with a ticket. Only tickets with a refund applied [status]: #status #### [status] A ticket's status. -Type: **SoftLayer_Ticket_Status ** +Type: **SoftLayer_Ticket_Status ** + @@ -681,7 +744,8 @@ A ticket's status. [subject]: #subject #### [subject] A ticket's subject. Only standard support tickets have an associated subject. A standard support ticket's title corresponds with it's subject's name. -Type: **SoftLayer_Ticket_Subject ** +Type: **SoftLayer_Ticket_Subject ** + @@ -691,7 +755,8 @@ A ticket's subject. Only standard support tickets have an associated subject. A [tagReferences]: #tagreferences #### [tagReferences] -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** + @@ -701,7 +766,8 @@ A ticket's subject. Only standard support tickets have an associated subject. A [updateRatingFlag]: #updateratingflag #### [updateRatingFlag] Whether employees' updates of this ticket could be rated by customer -Type: **boolean** +Type: **boolean** + @@ -711,7 +777,8 @@ Whether employees' updates of this ticket could be rated by customer [updates]: #updates #### [updates] A ticket's updates. -Type: **SoftLayer_Ticket_Update[] ** +Type: **SoftLayer_Ticket_Update[] ** + @@ -723,7 +790,8 @@ A ticket's updates. [assignedAgentCount]: #assignedagentcount #### [assignedAgentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -733,7 +801,8 @@ A count of [attachedAdditionalEmailCount]: #attachedadditionalemailcount #### [attachedAdditionalEmailCount] A count of the list of additional emails to notify when a ticket update is made. -Type: **unsigned long** +Type: **unsigned long** + @@ -743,7 +812,8 @@ A count of the list of additional emails to notify when a ticket update is made. [attachedDedicatedHostCount]: #attacheddedicatedhostcount #### [attachedDedicatedHostCount] A count of the Dedicated Hosts associated with a ticket. This is used in cases where a ticket is directly associated with one or more Dedicated Hosts. -Type: **unsigned long** +Type: **unsigned long** + @@ -753,7 +823,8 @@ A count of the Dedicated Hosts associated with a ticket. This is used in cases w [attachedFileCount]: #attachedfilecount #### [attachedFileCount] A count of the files attached to a ticket. -Type: **unsigned long** +Type: **unsigned long** + @@ -763,7 +834,8 @@ A count of the files attached to a ticket. [attachedResourceCount]: #attachedresourcecount #### [attachedResourceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -773,7 +845,8 @@ A count of [attachedVirtualGuestCount]: #attachedvirtualguestcount #### [attachedVirtualGuestCount] A count of the virtual guests associated with a ticket. This is used in cases where a ticket is directly associated with one or more virtualized guests installations or Virtual Servers. -Type: **unsigned long** +Type: **unsigned long** + @@ -783,7 +856,8 @@ A count of the virtual guests associated with a ticket. This is used in cases wh [employeeAttachmentCount]: #employeeattachmentcount #### [employeeAttachmentCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -793,7 +867,8 @@ A count of [invoiceItemCount]: #invoiceitemcount #### [invoiceItemCount] A count of the invoice items associated with a ticket. Ticket based invoice items only exist when a ticket incurs a fee that has been invoiced. -Type: **unsigned long** +Type: **unsigned long** + @@ -803,7 +878,8 @@ A count of the invoice items associated with a ticket. Ticket based invoice item [scheduledActionCount]: #scheduledactioncount #### [scheduledActionCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -813,7 +889,8 @@ A count of [stateCount]: #statecount #### [stateCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -823,7 +900,8 @@ A count of [tagReferenceCount]: #tagreferencecount #### [tagReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -833,7 +911,8 @@ A count of [updateCount]: #updatecount #### [updateCount] A count of a ticket's updates. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Activity/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Activity/_index.md index 0d27381225..5bf4dc301e 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Activity/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Activity/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ classes: [createTimestamp]: #createtimestamp #### [createTimestamp] -Type: **dateTime** +Type: **dateTime** +
              @@ -65,7 +69,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [value]: #value #### [value] -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ classes: [editor]: #editor #### [editor] -Type: **SoftLayer_User_Interface ** +Type: **SoftLayer_User_Interface ** + @@ -101,7 +108,8 @@ classes: [ticket]: #ticket #### [ticket] -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -111,7 +119,8 @@ classes: [ticketUpdate]: #ticketupdate #### [ticketUpdate] -Type: **SoftLayer_Ticket_Update ** +Type: **SoftLayer_Ticket_Update ** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Attachment/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Attachment/_index.md index 437e3a265c..36fd394161 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Attachment/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Attachment/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -59,7 +61,8 @@ SoftLayer tickets have the ability to be associated with specific pieces of hard [attachmentId]: #attachmentid #### [attachmentId] The internal identifier of an item that is attached to a ticket. -Type: **integer** +Type: **integer** + @@ -69,7 +72,8 @@ The internal identifier of an item that is attached to a ticket. [createDate]: #createdate #### [createDate] The date that an item was attached to a ticket. -Type: **dateTime** +Type: **dateTime** + @@ -79,7 +83,8 @@ The date that an item was attached to a ticket. [id]: #id #### [id] A ticket attachment's internal identifier. -Type: **integer** +Type: **integer** + @@ -89,7 +94,8 @@ A ticket attachment's internal identifier. [ticketId]: #ticketid #### [ticketId] The internal identifier of the ticket that an item is attached to. -Type: **integer** +Type: **integer** + @@ -105,7 +111,8 @@ The internal identifier of the ticket that an item is attached to. [ticket]: #ticket #### [ticket] The ticket that an item is attached to. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Attachment_Assigned_Agent/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Attachment_Assigned_Agent/_index.md index 6fa3b2ce48..9b3565879f 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Attachment_Assigned_Agent/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Attachment_Assigned_Agent/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [assignedAgentId]: #assignedagentid #### [assignedAgentId] The internal identifier of an assigned Agent that is attached to a ticket. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ The internal identifier of an assigned Agent that is attached to a ticket. [attachmentId]: #attachmentid #### [attachmentId] The internal identifier of an item that is attached to a ticket. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ The internal identifier of an item that is attached to a ticket. [createDate]: #createdate #### [createDate] The date that an item was attached to a ticket. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date that an item was attached to a ticket. [id]: #id #### [id] A ticket attachment's internal identifier. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ A ticket attachment's internal identifier. [ticketId]: #ticketid #### [ticketId] The internal identifier of the ticket that an item is attached to. -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ The internal identifier of the ticket that an item is attached to. [assignedAgent]: #assignedagent #### [assignedAgent] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -111,7 +119,8 @@ The internal identifier of the ticket that an item is attached to. [resource]: #resource #### [resource] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -121,7 +130,8 @@ The internal identifier of the ticket that an item is attached to. [ticket]: #ticket #### [ticket] The ticket that an item is attached to. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Attachment_CardChangeRequest/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Attachment_CardChangeRequest/_index.md index 8eb76be132..29714dd869 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Attachment_CardChangeRequest/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Attachment_CardChangeRequest/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This datatype contains tickets referenced from card change request @@ -45,7 +47,8 @@ This datatype contains tickets referenced from card change request [attachmentId]: #attachmentid #### [attachmentId] The internal identifier of an item that is attached to a ticket. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of an item that is attached to a ticket. [createDate]: #createdate #### [createDate] The date that an item was attached to a ticket. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The date that an item was attached to a ticket. [id]: #id #### [id] A ticket attachment's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A ticket attachment's internal identifier. [ticketId]: #ticketid #### [ticketId] The internal identifier of the ticket that an item is attached to. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The internal identifier of the ticket that an item is attached to. [resource]: #resource #### [resource] The card change request that is attached to a ticket. -Type: **SoftLayer_Billing_Payment_Card_ChangeRequest ** +Type: **SoftLayer_Billing_Payment_Card_ChangeRequest ** + @@ -101,7 +108,8 @@ The card change request that is attached to a ticket. [ticket]: #ticket #### [ticket] The ticket that an item is attached to. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Attachment_Dedicated_Host/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Attachment_Dedicated_Host/_index.md index 731b08ef27..270e972723 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Attachment_Dedicated_Host/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Attachment_Dedicated_Host/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -63,7 +65,8 @@ SoftLayer tickets have the ability to be associated with specific dedicated host [attachmentId]: #attachmentid #### [attachmentId] The internal identifier of an item that is attached to a ticket. -Type: **integer** +Type: **integer** + @@ -73,7 +76,8 @@ The internal identifier of an item that is attached to a ticket. [createDate]: #createdate #### [createDate] The date that an item was attached to a ticket. -Type: **dateTime** +Type: **dateTime** + @@ -83,7 +87,8 @@ The date that an item was attached to a ticket. [dedicatedHostId]: #dedicatedhostid #### [dedicatedHostId] The internal identifier of the Dedicated Host that is attached to a ticket. -Type: **integer** +Type: **integer** + @@ -93,7 +98,8 @@ The internal identifier of the Dedicated Host that is attached to a ticket. [id]: #id #### [id] A ticket attachment's internal identifier. -Type: **integer** +Type: **integer** + @@ -103,7 +109,8 @@ A ticket attachment's internal identifier. [ticketId]: #ticketid #### [ticketId] The internal identifier of the ticket that an item is attached to. -Type: **integer** +Type: **integer** + @@ -119,7 +126,8 @@ The internal identifier of the ticket that an item is attached to. [dedicatedHost]: #dedicatedhost #### [dedicatedHost] The dedicated dost that is attached to a ticket. -Type: **SoftLayer_Virtual_DedicatedHost ** +Type: **SoftLayer_Virtual_DedicatedHost ** + @@ -129,7 +137,8 @@ The dedicated dost that is attached to a ticket. [resource]: #resource #### [resource] The Dedicated Host that is attached to a ticket. -Type: **SoftLayer_Virtual_DedicatedHost ** +Type: **SoftLayer_Virtual_DedicatedHost ** + @@ -139,7 +148,8 @@ The Dedicated Host that is attached to a ticket. [ticket]: #ticket #### [ticket] The ticket that an item is attached to. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Attachment_File/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Attachment_File/_index.md index dbec6aefba..84aed9c5cf 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Attachment_File/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Attachment_File/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -59,7 +61,8 @@ SoftLayer tickets can have have files attached to them. Attaching a file to a ti [createDate]: #createdate #### [createDate] The date a file was originally attached to a ticket. -Type: **dateTime** +Type: **dateTime** + @@ -69,7 +72,8 @@ The date a file was originally attached to a ticket. [fileName]: #filename #### [fileName] The name of a file attached to a ticket. -Type: **string** +Type: **string** + @@ -79,7 +83,8 @@ The name of a file attached to a ticket. [fileSize]: #filesize #### [fileSize] The size of a file attached to a ticket, measured in bytes. -Type: **string** +Type: **string** + @@ -89,7 +94,8 @@ The size of a file attached to a ticket, measured in bytes. [id]: #id #### [id] A ticket file attachment's internal identifier. -Type: **integer** +Type: **integer** + @@ -99,7 +105,8 @@ A ticket file attachment's internal identifier. [modifyDate]: #modifydate #### [modifyDate] The date that a file attachment record was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -109,7 +116,8 @@ The date that a file attachment record was last modified. [ticketId]: #ticketid #### [ticketId] The internal identifier of the ticket that a file is attached to. -Type: **integer** +Type: **integer** + @@ -119,7 +127,8 @@ The internal identifier of the ticket that a file is attached to. [updateId]: #updateid #### [updateId] The internal identifier of the ticket update the attached file is associated with. -Type: **integer** +Type: **integer** + @@ -129,7 +138,8 @@ The internal identifier of the ticket update the attached file is associated wit [uploaderId]: #uploaderid #### [uploaderId] The internal identifier of the user that uploaded a ticket file attachment. This is only used when A file attachment's ''uploaderType'' is set to "USER". -Type: **string** +Type: **string** + @@ -139,7 +149,8 @@ The internal identifier of the user that uploaded a ticket file attachment. This [uploaderType]: #uploadertype #### [uploaderType] The type of user that attached a file to a ticket. This is either "USER" if the file was uploaded by a portal or API user or "EMPLOYEE" if the file was uploaded by a SoftLayer employee. -Type: **string** +Type: **string** + @@ -155,7 +166,8 @@ The type of user that attached a file to a ticket. This is either "USER" if the [ticket]: #ticket #### [ticket] -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -165,7 +177,8 @@ The type of user that attached a file to a ticket. This is either "USER" if the [update]: #update #### [update] The ticket that a file is attached to. -Type: **SoftLayer_Ticket_Update ** +Type: **SoftLayer_Ticket_Update ** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Attachment_File_ServiceNow/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Attachment_File_ServiceNow/_index.md index f734d4f673..4939204ed3 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Attachment_File_ServiceNow/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Attachment_File_ServiceNow/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] The date a file was originally attached to a ticket. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ The date a file was originally attached to a ticket. [fileName]: #filename #### [fileName] The name of a file attached to a ticket. -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ The name of a file attached to a ticket. [fileSize]: #filesize #### [fileSize] The size of a file attached to a ticket, measured in bytes. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The size of a file attached to a ticket, measured in bytes. [id]: #id #### [id] A ticket file attachment's internal identifier. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ A ticket file attachment's internal identifier. [modifyDate]: #modifydate #### [modifyDate] The date that a file attachment record was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date that a file attachment record was last modified. [ticketId]: #ticketid #### [ticketId] The internal identifier of the ticket that a file is attached to. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The internal identifier of the ticket that a file is attached to. [updateId]: #updateid #### [updateId] The internal identifier of the ticket update the attached file is associated with. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ The internal identifier of the ticket update the attached file is associated wit [uploaderId]: #uploaderid #### [uploaderId] The internal identifier of the user that uploaded a ticket file attachment. This is only used when A file attachment's ''uploaderType'' is set to "USER". -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The internal identifier of the user that uploaded a ticket file attachment. This [uploaderType]: #uploadertype #### [uploaderType] The type of user that attached a file to a ticket. This is either "USER" if the file was uploaded by a portal or API user or "EMPLOYEE" if the file was uploaded by a SoftLayer employee. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ The type of user that attached a file to a ticket. This is either "USER" if the [ticket]: #ticket #### [ticket] -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -151,7 +163,8 @@ The type of user that attached a file to a ticket. This is either "USER" if the [update]: #update #### [update] The ticket that a file is attached to. -Type: **SoftLayer_Ticket_Update ** +Type: **SoftLayer_Ticket_Update ** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Attachment_Hardware/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Attachment_Hardware/_index.md index e9609ef7ec..cae33b5cd0 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Attachment_Hardware/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Attachment_Hardware/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -65,7 +67,8 @@ SoftLayer tickets have the ability to be associated with specific pieces of hard [attachmentId]: #attachmentid #### [attachmentId] The internal identifier of an item that is attached to a ticket. -Type: **integer** +Type: **integer** + @@ -75,7 +78,8 @@ The internal identifier of an item that is attached to a ticket. [createDate]: #createdate #### [createDate] The date that an item was attached to a ticket. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +89,8 @@ The date that an item was attached to a ticket. [hardwareId]: #hardwareid #### [hardwareId] The internal identifier of a piece of hardware that is attached to a ticket. -Type: **integer** +Type: **integer** + @@ -95,7 +100,8 @@ The internal identifier of a piece of hardware that is attached to a ticket. [id]: #id #### [id] A ticket attachment's internal identifier. -Type: **integer** +Type: **integer** + @@ -105,7 +111,8 @@ A ticket attachment's internal identifier. [ticketId]: #ticketid #### [ticketId] The internal identifier of the ticket that an item is attached to. -Type: **integer** +Type: **integer** + @@ -121,7 +128,8 @@ The internal identifier of the ticket that an item is attached to. [hardware]: #hardware #### [hardware] The hardware that is attached to a ticket. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -131,7 +139,8 @@ The hardware that is attached to a ticket. [resource]: #resource #### [resource] The hardware that is attached to a ticket. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -141,7 +150,8 @@ The hardware that is attached to a ticket. [ticket]: #ticket #### [ticket] The ticket that an item is attached to. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Attachment_Manual_Payment/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Attachment_Manual_Payment/_index.md index f06cd5c597..882310d8ff 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Attachment_Manual_Payment/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Attachment_Manual_Payment/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This datatype contains tickets referenced from manual payments @@ -45,7 +47,8 @@ This datatype contains tickets referenced from manual payments [attachmentId]: #attachmentid #### [attachmentId] The internal identifier of an item that is attached to a ticket. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The internal identifier of an item that is attached to a ticket. [createDate]: #createdate #### [createDate] The date that an item was attached to a ticket. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The date that an item was attached to a ticket. [id]: #id #### [id] A ticket attachment's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A ticket attachment's internal identifier. [ticketId]: #ticketid #### [ticketId] The internal identifier of the ticket that an item is attached to. -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ The internal identifier of the ticket that an item is attached to. [resource]: #resource #### [resource] The manual payment that is attached to a ticket. -Type: **SoftLayer_Billing_Payment_Card_ManualPayment ** +Type: **SoftLayer_Billing_Payment_Card_ManualPayment ** + @@ -101,7 +108,8 @@ The manual payment that is attached to a ticket. [ticket]: #ticket #### [ticket] The ticket that an item is attached to. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Attachment_Network_Storage_Mass_Data_Migration/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Attachment_Network_Storage_Mass_Data_Migration/_index.md index 8c3add7f5f..a67ef2358e 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Attachment_Network_Storage_Mass_Data_Migration/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Attachment_Network_Storage_Mass_Data_Migration/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [attachmentId]: #attachmentid #### [attachmentId] The internal identifier of an item that is attached to a ticket. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ The internal identifier of an item that is attached to a ticket. [createDate]: #createdate #### [createDate] The date that an item was attached to a ticket. -Type: **dateTime** +Type: **dateTime** +
              @@ -65,7 +69,8 @@ The date that an item was attached to a ticket. [id]: #id #### [id] A ticket attachment's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A ticket attachment's internal identifier. [requestId]: #requestid #### [requestId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ A ticket attachment's internal identifier. [ticketId]: #ticketid #### [ticketId] The internal identifier of the ticket that an item is attached to. -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ The internal identifier of the ticket that an item is attached to. [request]: #request #### [request] The Mass Data Migration request that is attached to a ticket. -Type: **SoftLayer_Network_Storage_MassDataMigration_Request ** +Type: **SoftLayer_Network_Storage_MassDataMigration_Request ** + @@ -111,7 +119,8 @@ The Mass Data Migration request that is attached to a ticket. [resource]: #resource #### [resource] The Mass Data Migration request that is attached to a ticket. -Type: **SoftLayer_Network_Storage_MassDataMigration_Request ** +Type: **SoftLayer_Network_Storage_MassDataMigration_Request ** + @@ -121,7 +130,8 @@ The Mass Data Migration request that is attached to a ticket. [ticket]: #ticket #### [ticket] The ticket that an item is attached to. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Attachment_Scheduled_Action/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Attachment_Scheduled_Action/_index.md index 67123be31b..2dee6b39b2 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Attachment_Scheduled_Action/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Attachment_Scheduled_Action/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [attachmentId]: #attachmentid #### [attachmentId] The internal identifier of an item that is attached to a ticket. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ The internal identifier of an item that is attached to a ticket. [createDate]: #createdate #### [createDate] The date that an item was attached to a ticket. -Type: **dateTime** +Type: **dateTime** +
              @@ -65,7 +69,8 @@ The date that an item was attached to a ticket. [id]: #id #### [id] A ticket attachment's internal identifier. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ A ticket attachment's internal identifier. [runDate]: #rundate #### [runDate] The internal identifier of a scheduled action transaction that is attached to a ticket. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The internal identifier of a scheduled action transaction that is attached to a [ticketId]: #ticketid #### [ticketId] The internal identifier of the ticket that an item is attached to. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The internal identifier of the ticket that an item is attached to. [transactionId]: #transactionid #### [transactionId] The internal identifier of a scheduled action transaction that is attached to a ticket. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The internal identifier of a scheduled action transaction that is attached to a [resource]: #resource #### [resource] -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -121,7 +130,8 @@ The internal identifier of a scheduled action transaction that is attached to a [scheduledAction]: #scheduledaction #### [scheduledAction] -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -131,7 +141,8 @@ The internal identifier of a scheduled action transaction that is attached to a [ticket]: #ticket #### [ticket] The ticket that an item is attached to. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -141,7 +152,8 @@ The ticket that an item is attached to. [transaction]: #transaction #### [transaction] -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Attachment_Virtual_Guest/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Attachment_Virtual_Guest/_index.md index 8288d6c403..b7af8d3569 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Attachment_Virtual_Guest/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Attachment_Virtual_Guest/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -63,7 +65,8 @@ SoftLayer tickets have the ability to be associated with specific virtual guests [attachmentId]: #attachmentid #### [attachmentId] The internal identifier of an item that is attached to a ticket. -Type: **integer** +Type: **integer** + @@ -73,7 +76,8 @@ The internal identifier of an item that is attached to a ticket. [createDate]: #createdate #### [createDate] The date that an item was attached to a ticket. -Type: **dateTime** +Type: **dateTime** + @@ -83,7 +87,8 @@ The date that an item was attached to a ticket. [id]: #id #### [id] A ticket attachment's internal identifier. -Type: **integer** +Type: **integer** + @@ -93,7 +98,8 @@ A ticket attachment's internal identifier. [ticketId]: #ticketid #### [ticketId] The internal identifier of the ticket that an item is attached to. -Type: **integer** +Type: **integer** + @@ -103,7 +109,8 @@ The internal identifier of the ticket that an item is attached to. [virtualGuestId]: #virtualguestid #### [virtualGuestId] The internal identifier of the virtualized guest or CloudLayer Computing Instance that is attached to a ticket. -Type: **integer** +Type: **integer** + @@ -119,7 +126,8 @@ The internal identifier of the virtualized guest or CloudLayer Computing Instanc [resource]: #resource #### [resource] The virtualized guest or CloudLayer Computing Instance that is attached to a ticket. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -129,7 +137,8 @@ The virtualized guest or CloudLayer Computing Instance that is attached to a tic [ticket]: #ticket #### [ticket] The ticket that an item is attached to. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -139,7 +148,8 @@ The ticket that an item is attached to. [virtualGuest]: #virtualguest #### [virtualGuest] The virtualized guest or CloudLayer Computing Instance that is attached to a ticket. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Chat/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Chat/_index.md index d7cb8884dd..2cbdcc234d 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Chat/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Chat/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [customerId]: #customerid #### [customerId] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [endDate]: #enddate #### [endDate] -Type: **dateTime** +Type: **dateTime** +
              @@ -65,7 +69,8 @@ classes: [startDate]: #startdate #### [startDate] -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ classes: [transcript]: #transcript #### [transcript] -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ classes: [agent]: #agent #### [agent] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -101,7 +108,8 @@ classes: [customer]: #customer #### [customer] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -111,7 +119,8 @@ classes: [ticketUpdate]: #ticketupdate #### [ticketUpdate] -Type: **SoftLayer_Ticket_Update_Chat ** +Type: **SoftLayer_Ticket_Update_Chat ** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Chat_Liveperson/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Chat_Liveperson/_index.md index 5f29df53c7..ddadba645c 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Chat_Liveperson/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Chat_Liveperson/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [customerId]: #customerid #### [customerId] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [endDate]: #enddate #### [endDate] -Type: **dateTime** +Type: **dateTime** +
              @@ -65,7 +69,8 @@ classes: [startDate]: #startdate #### [startDate] -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ classes: [transcript]: #transcript #### [transcript] -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ classes: [agent]: #agent #### [agent] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -101,7 +108,8 @@ classes: [customer]: #customer #### [customer] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -111,7 +119,8 @@ classes: [ticketUpdate]: #ticketupdate #### [ticketUpdate] -Type: **SoftLayer_Ticket_Update_Chat ** +Type: **SoftLayer_Ticket_Update_Chat ** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Chat_TranscriptLine/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Chat_TranscriptLine/_index.md index ff02c35084..62b8287c4b 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Chat_TranscriptLine/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Chat_TranscriptLine/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -51,7 +53,8 @@ classes: [speaker]: #speaker #### [speaker] -Type: **SoftLayer_User_Interface ** +Type: **SoftLayer_User_Interface ** +
              diff --git a/content/reference/datatypes/SoftLayer_Ticket_Chat_TranscriptLine_Customer/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Chat_TranscriptLine_Customer/_index.md index d419b65037..65e83db066 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Chat_TranscriptLine_Customer/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Chat_TranscriptLine_Customer/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -51,7 +53,8 @@ classes: [speaker]: #speaker #### [speaker] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** +
              diff --git a/content/reference/datatypes/SoftLayer_Ticket_Chat_TranscriptLine_Employee/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Chat_TranscriptLine_Employee/_index.md index 9135e3da05..741da05dca 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Chat_TranscriptLine_Employee/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Chat_TranscriptLine_Employee/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -51,7 +53,8 @@ classes: [speaker]: #speaker #### [speaker] -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** +
              diff --git a/content/reference/datatypes/SoftLayer_Ticket_EuCompliance/_index.md b/content/reference/datatypes/SoftLayer_Ticket_EuCompliance/_index.md index 6621fb1c66..654ae0ce92 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_EuCompliance/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_EuCompliance/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -51,7 +53,8 @@ classes: [datacenter]: #datacenter #### [datacenter] -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** +
              @@ -61,7 +64,8 @@ classes: [securityLevel]: #securitylevel #### [securityLevel] -Type: **SoftLayer_Security_Level ** +Type: **SoftLayer_Security_Level ** +
              @@ -71,7 +75,8 @@ classes: [ticket]: #ticket #### [ticket] -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** +
              diff --git a/content/reference/datatypes/SoftLayer_Ticket_Group/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Group/_index.md index c6e465c437..8656e8f7dc 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Group/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + 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. @@ -53,7 +55,8 @@ SoftLayer tickets have the ability to be assigned to one of SoftLayer's internal [id]: #id #### [id] A ticket group's internal identifier. -Type: **integer** +Type: **integer** +
              @@ -63,7 +66,8 @@ A ticket group's internal identifier. [name]: #name #### [name] A ticket group's name. -Type: **string** +Type: **string** + @@ -73,7 +77,8 @@ A ticket group's name. [ticketGroupCategoryId]: #ticketgroupcategoryid #### [ticketGroupCategoryId] The internal identifier for the category that a ticket group belongs to.. -Type: **integer** +Type: **integer** + @@ -89,7 +94,8 @@ The internal identifier for the category that a ticket group belongs to.. [category]: #category #### [category] The category that a ticket group belongs to. -Type: **SoftLayer_Ticket_Group_Category ** +Type: **SoftLayer_Ticket_Group_Category ** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Group_Category/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Group_Category/_index.md index c7d0a4ee70..7d50646f2b 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Group_Category/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Group_Category/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -53,7 +55,8 @@ SoftLayer's support ticket groups represent the department at SoftLayer that is [id]: #id #### [id] A ticket group category's unique identifier. -Type: **integer** +Type: **integer** + @@ -63,7 +66,8 @@ A ticket group category's unique identifier. [name]: #name #### [name] A ticket group category's name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Priority/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Priority/_index.md index 95f33523e2..8b5654315b 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Priority/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Priority/_index.md @@ -24,6 +24,8 @@ classes: + +
              diff --git a/content/reference/datatypes/SoftLayer_Ticket_State/_index.md b/content/reference/datatypes/SoftLayer_Ticket_State/_index.md index c8f2332b02..6acb72a7f6 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_State/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_State/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [stateTypeId]: #statetypeid #### [stateTypeId] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [ticketId]: #ticketid #### [ticketId] -Type: **integer** +Type: **integer** +
              @@ -81,7 +86,8 @@ classes: [stateType]: #statetype #### [stateType] -Type: **SoftLayer_Ticket_State_Type ** +Type: **SoftLayer_Ticket_State_Type ** +
              @@ -91,7 +97,8 @@ classes: [ticket]: #ticket #### [ticket] -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_State_Type/_index.md b/content/reference/datatypes/SoftLayer_Ticket_State_Type/_index.md index 8c289dbbc3..0594cf4d1b 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_State_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_State_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Status/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Status/_index.md index b27f6edae9..f19d4337e1 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -56,7 +58,8 @@ A ticket usually goes from the Open to Assigned to Closed states during its life [id]: #id #### [id] A ticket status' internal identifier. -Type: **integer** +Type: **integer** + @@ -66,7 +69,8 @@ A ticket status' internal identifier. [name]: #name #### [name] A ticket status' name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Subject/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Subject/_index.md index c56148a1cc..781ccd617a 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Subject/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Subject/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -60,7 +62,8 @@ The SoftLayer_Ticket_Subject data type models one of the possible subjects that [categoryId]: #categoryid #### [categoryId] The subject category id that this ticket subject belongs to. -Type: **integer** +Type: **integer** + @@ -70,7 +73,8 @@ The subject category id that this ticket subject belongs to. [id]: #id #### [id] A ticket subject's internal identifier. -Type: **integer** +Type: **integer** + @@ -80,7 +84,8 @@ A ticket subject's internal identifier. [name]: #name #### [name] A ticket subject's name. This name is used for a standard support ticket's title. -Type: **string** +Type: **string** + @@ -90,7 +95,8 @@ A ticket subject's name. This name is used for a standard support ticket's title [parentId]: #parentid #### [parentId] Specifies the parent subject id. -Type: **integer** +Type: **integer** + @@ -106,7 +112,8 @@ Specifies the parent subject id. [category]: #category #### [category] -Type: **SoftLayer_Ticket_Subject_Category ** +Type: **SoftLayer_Ticket_Subject_Category ** + @@ -116,7 +123,8 @@ Specifies the parent subject id. [children]: #children #### [children] A child subject -Type: **SoftLayer_Ticket_Subject[] ** +Type: **SoftLayer_Ticket_Subject[] ** + @@ -126,7 +134,8 @@ A child subject [group]: #group #### [group] -Type: **SoftLayer_Ticket_Group ** +Type: **SoftLayer_Ticket_Group ** + @@ -136,7 +145,8 @@ A child subject [parent]: #parent #### [parent] A parent subject -Type: **SoftLayer_Ticket_Subject ** +Type: **SoftLayer_Ticket_Subject ** + @@ -148,7 +158,8 @@ A parent subject [childrenCount]: #childrencount #### [childrenCount] A count of a child subject -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Subject_Category/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Subject_Category/_index.md index 321ba0fae1..5d5f5239e3 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Subject_Category/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Subject_Category/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Ticket_Subject_Category groups ticket subjects into logical group. @@ -50,7 +52,8 @@ SoftLayer_Ticket_Subject_Category groups ticket subjects into logical group. [id]: #id #### [id] A unique identifier of a ticket subject category. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ A unique identifier of a ticket subject category. [name]: #name #### [name] A ticket subject category name. -Type: **string** +Type: **string** + @@ -76,7 +80,8 @@ A ticket subject category name. [subjects]: #subjects #### [subjects] -Type: **SoftLayer_Ticket_Subject[] ** +Type: **SoftLayer_Ticket_Subject[] ** + @@ -88,7 +93,8 @@ A ticket subject category name. [subjectCount]: #subjectcount #### [subjectCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Survey/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Survey/_index.md index 128ebf9a0d..8eb55df11d 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Survey/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Survey/_index.md @@ -24,6 +24,8 @@ classes: + +
              diff --git a/content/reference/datatypes/SoftLayer_Ticket_Type/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Type/_index.md index 2711a39ac2..2c9e7a72e7 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
              diff --git a/content/reference/datatypes/SoftLayer_Ticket_Update/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Update/_index.md index 59382cd740..5cf1dfe95b 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Update/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Update/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + The SoftLayer_Ticket_Update type relates to a single update to a ticket, either by a customer or an employee. @@ -45,7 +47,8 @@ The SoftLayer_Ticket_Update type relates to a single update to a ticket, either [createDate]: #createdate #### [createDate] The data a ticket update was created. -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ The data a ticket update was created. [editorId]: #editorid #### [editorId] The internal identifier of the SoftLayer portal or API user who created a ticket update. This is only used if a ticket update's ''editorType'' property is "USER". -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The internal identifier of the SoftLayer portal or API user who created a ticket [editorType]: #editortype #### [editorType] The type user who created a ticket update. This is either "USER" for an update created by a SoftLayer portal or API user, "EMPLOYEE" for an update created by a SoftLayer employee, or "AUTO" if a ticket update was generated automatically by SoftLayer's backend systems. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The type user who created a ticket update. This is either "USER" for an update c [entry]: #entry #### [entry] The contents of a ticket update. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ The contents of a ticket update. [id]: #id #### [id] A ticket update's internal identifier. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ A ticket update's internal identifier. [ticketId]: #ticketid #### [ticketId] The internal identifier of the ticket that a ticket update belongs to. -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ The internal identifier of the ticket that a ticket update belongs to. [changeOwnerActivity]: #changeowneractivity #### [changeOwnerActivity] -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The internal identifier of the ticket that a ticket update belongs to. [chat]: #chat #### [chat] The chat between the Customer and Agent -Type: **SoftLayer_Ticket_Chat_Liveperson ** +Type: **SoftLayer_Ticket_Chat_Liveperson ** + @@ -131,7 +141,8 @@ The chat between the Customer and Agent [editor]: #editor #### [editor] The user or SoftLayer employee who created a ticket update. -Type: **SoftLayer_User_Interface ** +Type: **SoftLayer_User_Interface ** + @@ -141,7 +152,8 @@ The user or SoftLayer employee who created a ticket update. [fileAttachment]: #fileattachment #### [fileAttachment] The files attached to a ticket update. -Type: **SoftLayer_Ticket_Attachment_File[] ** +Type: **SoftLayer_Ticket_Attachment_File[] ** + @@ -151,7 +163,8 @@ The files attached to a ticket update. [ticket]: #ticket #### [ticket] The ticket that a ticket update belongs to. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -161,7 +174,8 @@ The ticket that a ticket update belongs to. [type]: #type #### [type] The Type of update to this ticket -Type: **SoftLayer_Ticket_Update_Type ** +Type: **SoftLayer_Ticket_Update_Type ** + @@ -173,7 +187,8 @@ The Type of update to this ticket [fileAttachmentCount]: #fileattachmentcount #### [fileAttachmentCount] A count of the files attached to a ticket update. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Update_Agent/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Update_Agent/_index.md index f449ea649d..f9858252e7 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Update_Agent/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Update_Agent/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A SoftLayer_Ticket_Update_Agent type models an update to a ticket made by an agent. @@ -56,7 +58,8 @@ A SoftLayer_Ticket_Update_Agent type models an update to a ticket made by an age [createDate]: #createdate #### [createDate] The data a ticket update was created. -Type: **dateTime** +Type: **dateTime** + @@ -66,7 +69,8 @@ The data a ticket update was created. [editorId]: #editorid #### [editorId] The internal identifier of the SoftLayer portal or API user who created a ticket update. This is only used if a ticket update's ''editorType'' property is "USER". -Type: **integer** +Type: **integer** + @@ -76,7 +80,8 @@ The internal identifier of the SoftLayer portal or API user who created a ticket [editorType]: #editortype #### [editorType] The type user who created a ticket update. This is either "USER" for an update created by a SoftLayer portal or API user, "EMPLOYEE" for an update created by a SoftLayer employee, or "AUTO" if a ticket update was generated automatically by SoftLayer's backend systems. -Type: **string** +Type: **string** + @@ -86,7 +91,8 @@ The type user who created a ticket update. This is either "USER" for an update c [entry]: #entry #### [entry] The contents of a ticket update. -Type: **string** +Type: **string** + @@ -96,7 +102,8 @@ The contents of a ticket update. [id]: #id #### [id] A ticket update's internal identifier. -Type: **integer** +Type: **integer** + @@ -106,7 +113,8 @@ A ticket update's internal identifier. [ticketId]: #ticketid #### [ticketId] The internal identifier of the ticket that a ticket update belongs to. -Type: **integer** +Type: **integer** + @@ -122,7 +130,8 @@ The internal identifier of the ticket that a ticket update belongs to. [changeOwnerActivity]: #changeowneractivity #### [changeOwnerActivity] -Type: **string** +Type: **string** + @@ -132,7 +141,8 @@ The internal identifier of the ticket that a ticket update belongs to. [chat]: #chat #### [chat] The chat between the Customer and Agent -Type: **SoftLayer_Ticket_Chat_Liveperson ** +Type: **SoftLayer_Ticket_Chat_Liveperson ** + @@ -142,7 +152,8 @@ The chat between the Customer and Agent [fileAttachment]: #fileattachment #### [fileAttachment] The files attached to a ticket update. -Type: **SoftLayer_Ticket_Attachment_File[] ** +Type: **SoftLayer_Ticket_Attachment_File[] ** + @@ -152,7 +163,8 @@ The files attached to a ticket update. [ticket]: #ticket #### [ticket] The ticket that a ticket update belongs to. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -162,7 +174,8 @@ The ticket that a ticket update belongs to. [type]: #type #### [type] The Type of update to this ticket -Type: **SoftLayer_Ticket_Update_Type ** +Type: **SoftLayer_Ticket_Update_Type ** + @@ -174,7 +187,8 @@ The Type of update to this ticket [fileAttachmentCount]: #fileattachmentcount #### [fileAttachmentCount] A count of the files attached to a ticket update. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Update_Chat/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Update_Chat/_index.md index 29b66a9ae3..a1995aa407 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Update_Chat/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Update_Chat/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A SoftLayer_Ticket_Update_Chat is a chat between a customer and a customer service representative relating to a ticket. @@ -50,7 +52,8 @@ A SoftLayer_Ticket_Update_Chat is a chat between a customer and a customer servi [createDate]: #createdate #### [createDate] The data a ticket update was created. -Type: **dateTime** +Type: **dateTime** + @@ -60,7 +63,8 @@ The data a ticket update was created. [editorId]: #editorid #### [editorId] The internal identifier of the SoftLayer portal or API user who created a ticket update. This is only used if a ticket update's ''editorType'' property is "USER". -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ The internal identifier of the SoftLayer portal or API user who created a ticket [editorType]: #editortype #### [editorType] The type user who created a ticket update. This is either "USER" for an update created by a SoftLayer portal or API user, "EMPLOYEE" for an update created by a SoftLayer employee, or "AUTO" if a ticket update was generated automatically by SoftLayer's backend systems. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ The type user who created a ticket update. This is either "USER" for an update c [entry]: #entry #### [entry] The contents of a ticket update. -Type: **string** +Type: **string** + @@ -90,7 +96,8 @@ The contents of a ticket update. [id]: #id #### [id] A ticket update's internal identifier. -Type: **integer** +Type: **integer** + @@ -100,7 +107,8 @@ A ticket update's internal identifier. [ticketId]: #ticketid #### [ticketId] The internal identifier of the ticket that a ticket update belongs to. -Type: **integer** +Type: **integer** + @@ -116,7 +124,8 @@ The internal identifier of the ticket that a ticket update belongs to. [changeOwnerActivity]: #changeowneractivity #### [changeOwnerActivity] -Type: **string** +Type: **string** + @@ -126,7 +135,8 @@ The internal identifier of the ticket that a ticket update belongs to. [chat]: #chat #### [chat] The chat between the Customer and Agent -Type: **SoftLayer_Ticket_Chat_Liveperson ** +Type: **SoftLayer_Ticket_Chat_Liveperson ** + @@ -136,7 +146,8 @@ The chat between the Customer and Agent [editor]: #editor #### [editor] The portal or API user who created a ticket update. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -146,7 +157,8 @@ The portal or API user who created a ticket update. [fileAttachment]: #fileattachment #### [fileAttachment] The files attached to a ticket update. -Type: **SoftLayer_Ticket_Attachment_File[] ** +Type: **SoftLayer_Ticket_Attachment_File[] ** + @@ -156,7 +168,8 @@ The files attached to a ticket update. [ticket]: #ticket #### [ticket] The ticket that a ticket update belongs to. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -166,7 +179,8 @@ The ticket that a ticket update belongs to. [type]: #type #### [type] The Type of update to this ticket -Type: **SoftLayer_Ticket_Update_Type ** +Type: **SoftLayer_Ticket_Update_Type ** + @@ -178,7 +192,8 @@ The Type of update to this ticket [fileAttachmentCount]: #fileattachmentcount #### [fileAttachmentCount] A count of the files attached to a ticket update. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Update_Customer/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Update_Customer/_index.md index 8560df9a66..3e058a3ed2 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Update_Customer/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Update_Customer/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A SoftLayer_Ticket_Update_Customer is a single update made by a customer to a ticket. @@ -53,7 +55,8 @@ A SoftLayer_Ticket_Update_Customer is a single update made by a customer to a ti [createDate]: #createdate #### [createDate] The data a ticket update was created. -Type: **dateTime** +Type: **dateTime** + @@ -63,7 +66,8 @@ The data a ticket update was created. [editorId]: #editorid #### [editorId] The internal identifier of the SoftLayer portal or API user who created a ticket update. This is only used if a ticket update's ''editorType'' property is "USER". -Type: **integer** +Type: **integer** + @@ -73,7 +77,8 @@ The internal identifier of the SoftLayer portal or API user who created a ticket [editorType]: #editortype #### [editorType] The type user who created a ticket update. This is either "USER" for an update created by a SoftLayer portal or API user, "EMPLOYEE" for an update created by a SoftLayer employee, or "AUTO" if a ticket update was generated automatically by SoftLayer's backend systems. -Type: **string** +Type: **string** + @@ -83,7 +88,8 @@ The type user who created a ticket update. This is either "USER" for an update c [entry]: #entry #### [entry] The contents of a ticket update. -Type: **string** +Type: **string** + @@ -93,7 +99,8 @@ The contents of a ticket update. [id]: #id #### [id] A ticket update's internal identifier. -Type: **integer** +Type: **integer** + @@ -103,7 +110,8 @@ A ticket update's internal identifier. [ticketId]: #ticketid #### [ticketId] The internal identifier of the ticket that a ticket update belongs to. -Type: **integer** +Type: **integer** + @@ -119,7 +127,8 @@ The internal identifier of the ticket that a ticket update belongs to. [changeOwnerActivity]: #changeowneractivity #### [changeOwnerActivity] -Type: **string** +Type: **string** + @@ -129,7 +138,8 @@ The internal identifier of the ticket that a ticket update belongs to. [chat]: #chat #### [chat] The chat between the Customer and Agent -Type: **SoftLayer_Ticket_Chat_Liveperson ** +Type: **SoftLayer_Ticket_Chat_Liveperson ** + @@ -139,7 +149,8 @@ The chat between the Customer and Agent [editor]: #editor #### [editor] The portal or API user who created a ticket update. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -149,7 +160,8 @@ The portal or API user who created a ticket update. [fileAttachment]: #fileattachment #### [fileAttachment] The files attached to a ticket update. -Type: **SoftLayer_Ticket_Attachment_File[] ** +Type: **SoftLayer_Ticket_Attachment_File[] ** + @@ -159,7 +171,8 @@ The files attached to a ticket update. [ticket]: #ticket #### [ticket] The ticket that a ticket update belongs to. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -169,7 +182,8 @@ The ticket that a ticket update belongs to. [type]: #type #### [type] The Type of update to this ticket -Type: **SoftLayer_Ticket_Update_Type ** +Type: **SoftLayer_Ticket_Update_Type ** + @@ -181,7 +195,8 @@ The Type of update to this ticket [fileAttachmentCount]: #fileattachmentcount #### [fileAttachmentCount] A count of the files attached to a ticket update. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Update_Employee/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Update_Employee/_index.md index 1e67c10b0d..42e353aeee 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Update_Employee/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Update_Employee/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Ticket_Update_Employee data type models an update to a ticket made by a SoftLayer employee. @@ -56,7 +58,8 @@ The SoftLayer_Ticket_Update_Employee data type models an update to a ticket made [createDate]: #createdate #### [createDate] The data a ticket update was created. -Type: **dateTime** +Type: **dateTime** + @@ -66,7 +69,8 @@ The data a ticket update was created. [editorId]: #editorid #### [editorId] The internal identifier of the SoftLayer portal or API user who created a ticket update. This is only used if a ticket update's ''editorType'' property is "USER". -Type: **integer** +Type: **integer** + @@ -76,7 +80,8 @@ The internal identifier of the SoftLayer portal or API user who created a ticket [editorType]: #editortype #### [editorType] The type user who created a ticket update. This is either "USER" for an update created by a SoftLayer portal or API user, "EMPLOYEE" for an update created by a SoftLayer employee, or "AUTO" if a ticket update was generated automatically by SoftLayer's backend systems. -Type: **string** +Type: **string** + @@ -86,7 +91,8 @@ The type user who created a ticket update. This is either "USER" for an update c [entry]: #entry #### [entry] The contents of a ticket update. -Type: **string** +Type: **string** + @@ -96,7 +102,8 @@ The contents of a ticket update. [id]: #id #### [id] A ticket update's internal identifier. -Type: **integer** +Type: **integer** + @@ -106,7 +113,8 @@ A ticket update's internal identifier. [responseRating]: #responserating #### [responseRating] A ticket update's response rating. Ticket updates posted by SoftLayer employees have the option of earning a rating from SoftLayer's customers. Ratings are based on a 1 - 5 scale, with one being a poor rating while 5 is a very high rating. This is only used if a ticket update's ''editorType'' property is "EMPLOYEE". -Type: **integer** +Type: **integer** + @@ -116,7 +124,8 @@ A ticket update's response rating. Ticket updates posted by SoftLayer employees [ticketId]: #ticketid #### [ticketId] The internal identifier of the ticket that a ticket update belongs to. -Type: **integer** +Type: **integer** + @@ -132,7 +141,8 @@ The internal identifier of the ticket that a ticket update belongs to. [changeOwnerActivity]: #changeowneractivity #### [changeOwnerActivity] -Type: **string** +Type: **string** + @@ -142,7 +152,8 @@ The internal identifier of the ticket that a ticket update belongs to. [chat]: #chat #### [chat] The chat between the Customer and Agent -Type: **SoftLayer_Ticket_Chat_Liveperson ** +Type: **SoftLayer_Ticket_Chat_Liveperson ** + @@ -152,7 +163,8 @@ The chat between the Customer and Agent [editor]: #editor #### [editor] A representation of the SoftLayer employee who created a ticket update. -Type: **SoftLayer_User_Employee ** +Type: **SoftLayer_User_Employee ** + @@ -162,7 +174,8 @@ A representation of the SoftLayer employee who created a ticket update. [fileAttachment]: #fileattachment #### [fileAttachment] The files attached to a ticket update. -Type: **SoftLayer_Ticket_Attachment_File[] ** +Type: **SoftLayer_Ticket_Attachment_File[] ** + @@ -172,7 +185,8 @@ The files attached to a ticket update. [ticket]: #ticket #### [ticket] The ticket that a ticket update belongs to. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -182,7 +196,8 @@ The ticket that a ticket update belongs to. [type]: #type #### [type] The Type of update to this ticket -Type: **SoftLayer_Ticket_Update_Type ** +Type: **SoftLayer_Ticket_Update_Type ** + @@ -194,7 +209,8 @@ The Type of update to this ticket [fileAttachmentCount]: #fileattachmentcount #### [fileAttachmentCount] A count of the files attached to a ticket update. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Ticket_Update_Type/_index.md b/content/reference/datatypes/SoftLayer_Ticket_Update_Type/_index.md index fc3e123eea..052f250f76 100644 --- a/content/reference/datatypes/SoftLayer_Ticket_Update_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Ticket_Update_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
              @@ -71,7 +75,8 @@ classes: [ticket]: #ticket #### [ticket] -Type: **SoftLayer_Ticket_Update ** +Type: **SoftLayer_Ticket_Update ** + diff --git a/content/reference/datatypes/SoftLayer_User_Access_Facility_Log/_index.md b/content/reference/datatypes/SoftLayer_User_Access_Facility_Log/_index.md index f74843e7c7..a2dbfdceaf 100644 --- a/content/reference/datatypes/SoftLayer_User_Access_Facility_Log/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Access_Facility_Log/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class represents a login/logout sheet for facility visitors. @@ -45,7 +47,8 @@ This class represents a login/logout sheet for facility visitors. [accountId]: #accountid #### [accountId] This is the account associated with a log record. For a customer logging into a datacenter, this is the customer's account. For a contractor or any other guest logging into a customer's cabinet or colocation cage, this is the customer's account. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ This is the account associated with a log record. For a customer logging into a [description]: #description #### [description] This is a short description of why the person is at the location. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This is a short description of why the person is at the location. [hardwareId]: #hardwareid #### [hardwareId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ This is a short description of why the person is at the location. [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ This is a short description of why the person is at the location. [locationId]: #locationid #### [locationId] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ This is a short description of why the person is at the location. [timeIn]: #timein #### [timeIn] This is the date and time the person arrived. -Type: **dateTime** +Type: **dateTime** + @@ -105,7 +113,8 @@ This is the date and time the person arrived. [timeOut]: #timeout #### [timeOut] -Type: **dateTime** +Type: **dateTime** + @@ -121,7 +130,8 @@ This is the date and time the person arrived. [account]: #account #### [account] This is the account associated with the log entry. For users under a customer's account, it is the customer's account. For contractors and others visiting a colocation area, it is the account associated with the area they visited. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -131,7 +141,8 @@ This is the account associated with the log entry. For users under a customer's [datacenter]: #datacenter #### [datacenter] This is the location of the facility. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -141,7 +152,8 @@ This is the location of the facility. [hardware]: #hardware #### [hardware] This is the colocation hardware that was visited. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -151,7 +163,8 @@ This is the colocation hardware that was visited. [logType]: #logtype #### [logType] This is the type of person entering the facility. -Type: **SoftLayer_User_Access_Facility_Log_Type ** +Type: **SoftLayer_User_Access_Facility_Log_Type ** + @@ -161,7 +174,8 @@ This is the type of person entering the facility. [visitor]: #visitor #### [visitor] -Type: **SoftLayer_Entity ** +Type: **SoftLayer_Entity ** + diff --git a/content/reference/datatypes/SoftLayer_User_Access_Facility_Log_Type/_index.md b/content/reference/datatypes/SoftLayer_User_Access_Facility_Log_Type/_index.md index 9c293fab00..d6f327f9cf 100644 --- a/content/reference/datatypes/SoftLayer_User_Access_Facility_Log_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Access_Facility_Log_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_User_Access_Facility_Visitor/_index.md b/content/reference/datatypes/SoftLayer_User_Access_Facility_Visitor/_index.md index bc5efeab90..42f34aab87 100644 --- a/content/reference/datatypes/SoftLayer_User_Access_Facility_Visitor/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Access_Facility_Visitor/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class represents a facility visitor that is not an active employee or customer. @@ -45,7 +47,8 @@ This class represents a facility visitor that is not an active employee or custo [companyName]: #companyname #### [companyName] -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ This class represents a facility visitor that is not an active employee or custo [firstName]: #firstname #### [firstName] -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ This class represents a facility visitor that is not an active employee or custo [lastName]: #lastname #### [lastName] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ This class represents a facility visitor that is not an active employee or custo [typeId]: #typeid #### [typeId] -Type: **integer** +Type: **integer** + @@ -91,7 +97,8 @@ This class represents a facility visitor that is not an active employee or custo [visitorType]: #visitortype #### [visitorType] -Type: **SoftLayer_User_Access_Facility_Visitor_Type ** +Type: **SoftLayer_User_Access_Facility_Visitor_Type ** + diff --git a/content/reference/datatypes/SoftLayer_User_Access_Facility_Visitor_Type/_index.md b/content/reference/datatypes/SoftLayer_User_Access_Facility_Visitor_Type/_index.md index b84f776765..49d02b0c7a 100644 --- a/content/reference/datatypes/SoftLayer_User_Access_Facility_Visitor_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Access_Facility_Visitor_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer/_index.md b/content/reference/datatypes/SoftLayer_User_Customer/_index.md index dec710bcf2..ca7a6c7934 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ The SoftLayer_User_Customer data type contains general information relating to a [accountId]: #accountid #### [accountId] A portal user's associated [SoftLayer_Account]({{}}) id. -Type: **integer** +Type: **integer** + @@ -61,7 +64,8 @@ A portal user's associated [SoftLayer_Account]({{Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ The first line of the mailing address belonging to a portal user. [address2]: #address2 #### [address2] The second line of the mailing address belonging to a portal user. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ The second line of the mailing address belonging to a portal user. [aim]: #aim #### [aim] A portal user's AOL Instant Messenger screen name. -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ A portal user's AOL Instant Messenger screen name. [alternatePhone]: #alternatephone #### [alternatePhone] A portal user's secondary phone number. -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ A portal user's secondary phone number. [authenticationToken]: #authenticationtoken #### [authenticationToken] The authentication token used for logging into the SoftLayer customer portal. -Type: **SoftLayer_Container_User_Authentication_Token ** +Type: **SoftLayer_Container_User_Authentication_Token ** + @@ -111,7 +119,8 @@ The authentication token used for logging into the SoftLayer customer portal. [city]: #city #### [city] The city of the mailing address belonging to a portal user. -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The city of the mailing address belonging to a portal user. [companyName]: #companyname #### [companyName] A portal user's associated company. This may not be the same company as the customer that owns this portal user. -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ A portal user's associated company. This may not be the same company as the cust [country]: #country #### [country] A two-letter abbreviation of the country in the mailing address belonging to a portal user. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ A two-letter abbreviation of the country in the mailing address belonging to a p [createDate]: #createdate #### [createDate] The date a portal user's record was created. -Type: **dateTime** +Type: **dateTime** + @@ -151,7 +163,8 @@ The date a portal user's record was created. [daylightSavingsTimeFlag]: #daylightsavingstimeflag #### [daylightSavingsTimeFlag] Whether a portal user's time zone is affected by Daylight Savings Time. -Type: **boolean** +Type: **boolean** + @@ -161,7 +174,8 @@ Whether a portal user's time zone is affected by Daylight Savings Time. [denyAllResourceAccessOnCreateFlag]: #denyallresourceaccessoncreateflag #### [denyAllResourceAccessOnCreateFlag] Flag used to deny access to all hardware and cloud computing instances upon user creation. -Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ Flag used to deny access to all hardware and cloud computing instances upon user [displayName]: #displayname #### [displayName] -Type: **string** +Type: **string** + @@ -181,7 +196,8 @@ Flag used to deny access to all hardware and cloud computing instances upon user [email]: #email #### [email] A portal user's email address. -Type: **string** +Type: **string** + @@ -191,7 +207,8 @@ A portal user's email address. [firstName]: #firstname #### [firstName] A portal user's first name. -Type: **string** +Type: **string** + @@ -201,7 +218,8 @@ A portal user's first name. [forumPasswordHash]: #forumpasswordhash #### [forumPasswordHash] A user's password for the SoftLayer forums, hashed for auto-login capability from the SoftLayer customer portal -Type: **string** +Type: **string** + @@ -211,7 +229,8 @@ A user's password for the SoftLayer forums, hashed for auto-login capability fro [iamAuthorizationStatus]: #iamauthorizationstatus #### [iamAuthorizationStatus] -Type: **integer** +Type: **integer** + @@ -221,7 +240,8 @@ A user's password for the SoftLayer forums, hashed for auto-login capability fro [iamId]: #iamid #### [iamId] The IAMid (realm-identifier) of the user being created by PaaS -Type: **string** +Type: **string** + @@ -231,7 +251,8 @@ The IAMid (realm-identifier) of the user being created by PaaS [icq]: #icq #### [icq] A portal user's ICQ UIN. -Type: **string** +Type: **string** + @@ -241,7 +262,8 @@ A portal user's ICQ UIN. [id]: #id #### [id] A portal user's internal identifying number. -Type: **integer** +Type: **integer** + @@ -251,7 +273,8 @@ A portal user's internal identifying number. [ipAddressRestriction]: #ipaddressrestriction #### [ipAddressRestriction] The IP addresses or IP ranges from which a user may login to the SoftLayer customer portal. Specify subnets in CIDR format and separate multiple addresses and subnets by commas. You may combine IPv4 and IPv6 addresses and subnets, for example: 192.168.0.0/16,fe80:021b::0/64. -Type: **string** +Type: **string** + @@ -261,7 +284,8 @@ The IP addresses or IP ranges from which a user may login to the SoftLayer custo [isMasterUserFlag]: #ismasteruserflag #### [isMasterUserFlag] -Type: **boolean** +Type: **boolean** + @@ -271,7 +295,8 @@ The IP addresses or IP ranges from which a user may login to the SoftLayer custo [lastName]: #lastname #### [lastName] A portal user's last name. -Type: **string** +Type: **string** + @@ -281,7 +306,8 @@ A portal user's last name. [linkedAccountIntegrationMode]: #linkedaccountintegrationmode #### [linkedAccountIntegrationMode] The linked account integration mode -Type: **string** +Type: **string** + @@ -291,7 +317,8 @@ The linked account integration mode [localeId]: #localeid #### [localeId] A portal user's associated [SoftLayer_Locale]({{}}) id. -Type: **integer** +Type: **integer** + @@ -301,7 +328,8 @@ A portal user's associated [SoftLayer_Locale]({{Type: **boolean** +Type: **boolean** + @@ -311,7 +339,8 @@ Determines if this portal user is managed by SAML federation. [managedByOpenIdConnectFlag]: #managedbyopenidconnectflag #### [managedByOpenIdConnectFlag] Determines if this portal user is managed by IBMid federation. -Type: **boolean** +Type: **boolean** + @@ -321,7 +350,8 @@ Determines if this portal user is managed by IBMid federation. [minimumPasswordLifeHours]: #minimumpasswordlifehours #### [minimumPasswordLifeHours] The minimum number of hours that must pass between password resets. -Type: **integer** +Type: **integer** + @@ -331,7 +361,8 @@ The minimum number of hours that must pass between password resets. [modifyDate]: #modifydate #### [modifyDate] The date a portal user's record was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -341,7 +372,8 @@ The date a portal user's record was last modified. [msn]: #msn #### [msn] A portal user's MSN address. -Type: **string** +Type: **string** + @@ -351,7 +383,8 @@ A portal user's MSN address. [nameId]: #nameid #### [nameId] -Type: **string** +Type: **string** + @@ -361,7 +394,8 @@ A portal user's MSN address. [officePhone]: #officephone #### [officePhone] A portal user's office phone number. -Type: **string** +Type: **string** + @@ -371,7 +405,8 @@ A portal user's office phone number. [openIdConnectUserName]: #openidconnectusername #### [openIdConnectUserName] The BlueID username associated to with this user, if the account is managed by OpenIDConnect / BlueID federation -Type: **string** +Type: **string** + @@ -381,7 +416,8 @@ The BlueID username associated to with this user, if the account is managed by O [parentId]: #parentid #### [parentId] A portal user's parent user. Id a users parentId is ''null'' then it doesn't have a parent user in the customer portal. -Type: **integer** +Type: **integer** + @@ -391,7 +427,8 @@ A portal user's parent user. Id a users parentId is ''null'' then it doesn't hav [passwordExpireDate]: #passwordexpiredate #### [passwordExpireDate] The expiration date for the user's password -Type: **dateTime** +Type: **dateTime** + @@ -401,7 +438,8 @@ The expiration date for the user's password [postalCode]: #postalcode #### [postalCode] The postal code of the mailing address belonging to an portal user. -Type: **string** +Type: **string** + @@ -411,7 +449,8 @@ The postal code of the mailing address belonging to an portal user. [pptpVpnAllowedFlag]: #pptpvpnallowedflag #### [pptpVpnAllowedFlag] Whether a portal user may connect to the SoftLayer private network via PPTP VPN or not. -Type: **boolean** +Type: **boolean** + @@ -421,7 +460,8 @@ Whether a portal user may connect to the SoftLayer private network via PPTP VPN [preventPreviousPasswords]: #preventpreviouspasswords #### [preventPreviousPasswords] -Type: **integer** +Type: **integer** + @@ -431,7 +471,8 @@ Whether a portal user may connect to the SoftLayer private network via PPTP VPN [savedId]: #savedid #### [savedId] -Type: **string** +Type: **string** + @@ -441,7 +482,8 @@ Whether a portal user may connect to the SoftLayer private network via PPTP VPN [secondaryLoginManagementFlag]: #secondaryloginmanagementflag #### [secondaryLoginManagementFlag] Whether a user may change their security options (IP restriction, password expiration, or enforce security questions on login) which were pre-selected by their account's master user. -Type: **boolean** +Type: **boolean** + @@ -451,7 +493,8 @@ Whether a user may change their security options (IP restriction, password expir [secondaryLoginRequiredFlag]: #secondaryloginrequiredflag #### [secondaryLoginRequiredFlag] Whether a user is required to answer a security question when logging into the SoftLayer customer portal. -Type: **boolean** +Type: **boolean** + @@ -461,7 +504,8 @@ Whether a user is required to answer a security question when logging into the S [secondaryPasswordModifyDate]: #secondarypasswordmodifydate #### [secondaryPasswordModifyDate] The date when a user's password was last updated. -Type: **dateTime** +Type: **dateTime** + @@ -471,7 +515,8 @@ The date when a user's password was last updated. [secondaryPasswordTimeoutDays]: #secondarypasswordtimeoutdays #### [secondaryPasswordTimeoutDays] The number of days for which a user's password is active. -Type: **integer** +Type: **integer** + @@ -481,7 +526,8 @@ The number of days for which a user's password is active. [sms]: #sms #### [sms] A phone number that can receive SMS text messages for this portal user. -Type: **string** +Type: **string** + @@ -491,7 +537,8 @@ A phone number that can receive SMS text messages for this portal user. [sslVpnAllowedFlag]: #sslvpnallowedflag #### [sslVpnAllowedFlag] Whether a portal user may connect to the SoftLayer private network via SSL VPN or not. -Type: **boolean** +Type: **boolean** + @@ -501,7 +548,8 @@ Whether a portal user may connect to the SoftLayer private network via SSL VPN o [state]: #state #### [state] A two-letter abbreviation of the state in the mailing address belonging to a portal user. If a user does not reside in a province then this is typically blank. -Type: **string** +Type: **string** + @@ -511,7 +559,8 @@ A two-letter abbreviation of the state in the mailing address belonging to a por [statusDate]: #statusdate #### [statusDate] The date a portal users record's last status change. -Type: **dateTime** +Type: **dateTime** + @@ -521,7 +570,8 @@ The date a portal users record's last status change. [timezoneId]: #timezoneid #### [timezoneId] A portal user's time zone. -Type: **integer** +Type: **integer** + @@ -531,7 +581,8 @@ A portal user's time zone. [userStatusId]: #userstatusid #### [userStatusId] A number reflecting the state of a portal user. -Type: **integer** +Type: **integer** + @@ -541,7 +592,8 @@ A number reflecting the state of a portal user. [username]: #username #### [username] A portal user's username. -Type: **string** +Type: **string** + @@ -551,7 +603,8 @@ A portal user's username. [verificationCode]: #verificationcode #### [verificationCode] The verification code from Bluemix BSS to save in the invitation -Type: **string** +Type: **string** + @@ -561,7 +614,8 @@ The verification code from Bluemix BSS to save in the invitation [vpnManualConfig]: #vpnmanualconfig #### [vpnManualConfig] Whether a portal user vpn subnets have been manual configured. -Type: **boolean** +Type: **boolean** + @@ -571,7 +625,8 @@ Whether a portal user vpn subnets have been manual configured. [yahoo]: #yahoo #### [yahoo] A portal user's Yahoo! Chat name. -Type: **string** +Type: **string** + @@ -587,7 +642,8 @@ A portal user's Yahoo! Chat name. [account]: #account #### [account] The customer account that a user belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -597,7 +653,8 @@ The customer account that a user belongs to. [actions]: #actions #### [actions] -Type: **SoftLayer_User_Permission_Action[] ** +Type: **SoftLayer_User_Permission_Action[] ** + @@ -607,7 +664,8 @@ The customer account that a user belongs to. [additionalEmails]: #additionalemails #### [additionalEmails] A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets. -Type: **SoftLayer_User_Customer_AdditionalEmail[] ** +Type: **SoftLayer_User_Customer_AdditionalEmail[] ** + @@ -617,7 +675,8 @@ A portal user's additional email addresses. These email addresses are contacted [apiAuthenticationKeys]: #apiauthenticationkeys #### [apiAuthenticationKeys] A portal user's API Authentication keys. There is a max limit of one API key per user. -Type: **SoftLayer_User_Customer_ApiAuthentication[] ** +Type: **SoftLayer_User_Customer_ApiAuthentication[] ** + @@ -627,7 +686,8 @@ A portal user's API Authentication keys. There is a max limit of one API key per [childUsers]: #childusers #### [childUsers] A portal user's child users. Some portal users may not have child users. -Type: **SoftLayer_User_Customer[] ** +Type: **SoftLayer_User_Customer[] ** + @@ -637,7 +697,8 @@ A portal user's child users. Some portal users may not have child users. [closedTickets]: #closedtickets #### [closedTickets] An user's associated closed tickets. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -647,7 +708,8 @@ An user's associated closed tickets. [dedicatedHosts]: #dedicatedhosts #### [dedicatedHosts] The dedicated hosts to which the user has been granted access. -Type: **SoftLayer_Virtual_DedicatedHost[] ** +Type: **SoftLayer_Virtual_DedicatedHost[] ** + @@ -657,7 +719,8 @@ The dedicated hosts to which the user has been granted access. [externalBindings]: #externalbindings #### [externalBindings] The external authentication bindings that link an external identifier to a SoftLayer user. -Type: **SoftLayer_User_External_Binding[] ** +Type: **SoftLayer_User_External_Binding[] ** + @@ -667,7 +730,8 @@ The external authentication bindings that link an external identifier to a SoftL [hardware]: #hardware #### [hardware] A portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -677,7 +741,8 @@ A portal user's accessible hardware. These permissions control which hardware a [hardwareNotifications]: #hardwarenotifications #### [hardwareNotifications] Hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'. -Type: **SoftLayer_User_Customer_Notification_Hardware[] ** +Type: **SoftLayer_User_Customer_Notification_Hardware[] ** + @@ -687,7 +752,8 @@ Hardware notifications associated with this user. A hardware notification links [hasAcknowledgedSupportPolicyFlag]: #hasacknowledgedsupportpolicyflag #### [hasAcknowledgedSupportPolicyFlag] Whether or not a user has acknowledged the support policy. -Type: **boolean** +Type: **boolean** + @@ -697,7 +763,8 @@ Whether or not a user has acknowledged the support policy. [hasFullDedicatedHostAccessFlag]: #hasfulldedicatedhostaccessflag #### [hasFullDedicatedHostAccessFlag] Permission granting the user access to all Dedicated Host devices on the account. -Type: **boolean** +Type: **boolean** + @@ -707,7 +774,8 @@ Permission granting the user access to all Dedicated Host devices on the account [hasFullHardwareAccessFlag]: #hasfullhardwareaccessflag #### [hasFullHardwareAccessFlag] Whether or not a portal user has access to all hardware on their account. -Type: **boolean** +Type: **boolean** + @@ -717,7 +785,8 @@ Whether or not a portal user has access to all hardware on their account. [hasFullVirtualGuestAccessFlag]: #hasfullvirtualguestaccessflag #### [hasFullVirtualGuestAccessFlag] Whether or not a portal user has access to all virtual guests on their account. -Type: **boolean** +Type: **boolean** + @@ -727,7 +796,8 @@ Whether or not a portal user has access to all virtual guests on their account. [ibmIdLink]: #ibmidlink #### [ibmIdLink] Specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link. -Type: **SoftLayer_User_Customer_Link ** +Type: **SoftLayer_User_Customer_Link ** + @@ -737,7 +807,8 @@ Specifically relating the Customer instance to an IBMid. A Customer instance may [layoutProfiles]: #layoutprofiles #### [layoutProfiles] Contains the definition of the layout profile. -Type: **SoftLayer_Layout_Profile[] ** +Type: **SoftLayer_Layout_Profile[] ** + @@ -747,7 +818,8 @@ Contains the definition of the layout profile. [locale]: #locale #### [locale] A user's locale. Locale holds user's language and region information. -Type: **SoftLayer_Locale ** +Type: **SoftLayer_Locale ** + @@ -757,7 +829,8 @@ A user's locale. Locale holds user's language and region information. [loginAttempts]: #loginattempts #### [loginAttempts] A user's attempts to log into the SoftLayer customer portal. -Type: **SoftLayer_User_Customer_Access_Authentication[] ** +Type: **SoftLayer_User_Customer_Access_Authentication[] ** + @@ -767,7 +840,8 @@ A user's attempts to log into the SoftLayer customer portal. [mobileDevices]: #mobiledevices #### [mobileDevices] A portal user's associated mobile device profiles. -Type: **SoftLayer_User_Customer_MobileDevice[] ** +Type: **SoftLayer_User_Customer_MobileDevice[] ** + @@ -777,7 +851,8 @@ A portal user's associated mobile device profiles. [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] Notification subscription records for the user. -Type: **SoftLayer_Notification_Subscriber[] ** +Type: **SoftLayer_Notification_Subscriber[] ** + @@ -787,7 +862,8 @@ Notification subscription records for the user. [openTickets]: #opentickets #### [openTickets] An user's associated open tickets. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -797,7 +873,8 @@ An user's associated open tickets. [overrides]: #overrides #### [overrides] A portal user's vpn accessible subnets. -Type: **SoftLayer_Network_Service_Vpn_Overrides[] ** +Type: **SoftLayer_Network_Service_Vpn_Overrides[] ** + @@ -807,7 +884,8 @@ A portal user's vpn accessible subnets. [parent]: #parent #### [parent] A portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -817,7 +895,8 @@ A portal user's parent user. If a SoftLayer_User_Customer has a null parentId pr [permissions]: #permissions #### [permissions] A portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API. -Type: **SoftLayer_User_Customer_CustomerPermission_Permission[] ** +Type: **SoftLayer_User_Customer_CustomerPermission_Permission[] ** + @@ -827,7 +906,8 @@ A portal user's permissions. These permissions control that user's access to fun [preferences]: #preferences #### [preferences] Data type contains a single user preference to a specific preference type. -Type: **SoftLayer_User_Preference[] ** +Type: **SoftLayer_User_Preference[] ** + @@ -837,7 +917,8 @@ Data type contains a single user preference to a specific preference type. [roles]: #roles #### [roles] -Type: **SoftLayer_User_Permission_Role[] ** +Type: **SoftLayer_User_Permission_Role[] ** + @@ -847,7 +928,8 @@ Data type contains a single user preference to a specific preference type. [salesforceUserLink]: #salesforceuserlink #### [salesforceUserLink] [DEPRECATED] -Type: **SoftLayer_User_Customer_Link ** +Type: **SoftLayer_User_Customer_Link ** + @@ -857,7 +939,8 @@ Data type contains a single user preference to a specific preference type. [securityAnswers]: #securityanswers #### [securityAnswers] A portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login. -Type: **SoftLayer_User_Customer_Security_Answer[] ** +Type: **SoftLayer_User_Customer_Security_Answer[] ** + @@ -867,7 +950,8 @@ A portal user's security question answers. Some portal users may not have securi [subscribers]: #subscribers #### [subscribers] A user's notification subscription records. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -877,7 +961,8 @@ A user's notification subscription records. [successfulLogins]: #successfullogins #### [successfulLogins] A user's successful attempts to log into the SoftLayer customer portal. -Type: **SoftLayer_User_Customer_Access_Authentication[] ** +Type: **SoftLayer_User_Customer_Access_Authentication[] ** + @@ -887,7 +972,8 @@ A user's successful attempts to log into the SoftLayer customer portal. [supportPolicyAcknowledgementRequiredFlag]: #supportpolicyacknowledgementrequiredflag #### [supportPolicyAcknowledgementRequiredFlag] Whether or not a user is required to acknowledge the support policy for portal access. -Type: **integer** +Type: **integer** + @@ -897,7 +983,8 @@ Whether or not a user is required to acknowledge the support policy for portal a [surveyRequiredFlag]: #surveyrequiredflag #### [surveyRequiredFlag] Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal. -Type: **boolean** +Type: **boolean** + @@ -907,7 +994,8 @@ Whether or not a user must take a brief survey the next time they log into the S [surveys]: #surveys #### [surveys] The surveys that a user has taken in the SoftLayer customer portal. -Type: **SoftLayer_Survey[] ** +Type: **SoftLayer_Survey[] ** + @@ -917,7 +1005,8 @@ The surveys that a user has taken in the SoftLayer customer portal. [tickets]: #tickets #### [tickets] An user's associated tickets. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -927,7 +1016,8 @@ An user's associated tickets. [timezone]: #timezone #### [timezone] A portal user's time zone. -Type: **SoftLayer_Locale_Timezone ** +Type: **SoftLayer_Locale_Timezone ** + @@ -937,7 +1027,8 @@ A portal user's time zone. [unsuccessfulLogins]: #unsuccessfullogins #### [unsuccessfulLogins] A user's unsuccessful attempts to log into the SoftLayer customer portal. -Type: **SoftLayer_User_Customer_Access_Authentication[] ** +Type: **SoftLayer_User_Customer_Access_Authentication[] ** + @@ -947,7 +1038,8 @@ A user's unsuccessful attempts to log into the SoftLayer customer portal. [userLinks]: #userlinks #### [userLinks] User customer link with IBMid and IAMid. -Type: **SoftLayer_User_Customer_Link[] ** +Type: **SoftLayer_User_Customer_Link[] ** + @@ -957,7 +1049,8 @@ User customer link with IBMid and IAMid. [userStatus]: #userstatus #### [userStatus] A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network. -Type: **SoftLayer_User_Customer_Status ** +Type: **SoftLayer_User_Customer_Status ** + @@ -967,7 +1060,8 @@ A portal user's status, which controls overall access to the SoftLayer customer [virtualGuests]: #virtualguests #### [virtualGuests] A portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -979,7 +1073,8 @@ A portal user's accessible CloudLayer Computing Instances. These permissions con [actionCount]: #actioncount #### [actionCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -989,7 +1084,8 @@ A count of [additionalEmailCount]: #additionalemailcount #### [additionalEmailCount] A count of a portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets. -Type: **unsigned long** +Type: **unsigned long** + @@ -999,7 +1095,8 @@ A count of a portal user's additional email addresses. These email addresses are [apiAuthenticationKeyCount]: #apiauthenticationkeycount #### [apiAuthenticationKeyCount] A count of a portal user's API Authentication keys. There is a max limit of one API key per user. -Type: **unsigned long** +Type: **unsigned long** + @@ -1009,7 +1106,8 @@ A count of a portal user's API Authentication keys. There is a max limit of one [childUserCount]: #childusercount #### [childUserCount] A count of a portal user's child users. Some portal users may not have child users. -Type: **unsigned long** +Type: **unsigned long** + @@ -1019,7 +1117,8 @@ A count of a portal user's child users. Some portal users may not have child use [closedTicketCount]: #closedticketcount #### [closedTicketCount] A count of an user's associated closed tickets. -Type: **unsigned long** +Type: **unsigned long** + @@ -1029,7 +1128,8 @@ A count of an user's associated closed tickets. [dedicatedHostCount]: #dedicatedhostcount #### [dedicatedHostCount] A count of the dedicated hosts to which the user has been granted access. -Type: **unsigned long** +Type: **unsigned long** + @@ -1039,7 +1139,8 @@ A count of the dedicated hosts to which the user has been granted access. [externalBindingCount]: #externalbindingcount #### [externalBindingCount] A count of the external authentication bindings that link an external identifier to a SoftLayer user. -Type: **unsigned long** +Type: **unsigned long** + @@ -1049,7 +1150,8 @@ A count of the external authentication bindings that link an external identifier [hardwareCount]: #hardwarecount #### [hardwareCount] A count of a portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal. -Type: **unsigned long** +Type: **unsigned long** + @@ -1059,7 +1161,8 @@ A count of a portal user's accessible hardware. These permissions control which [hardwareNotificationCount]: #hardwarenotificationcount #### [hardwareNotificationCount] A count of hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'. -Type: **unsigned long** +Type: **unsigned long** + @@ -1069,7 +1172,8 @@ A count of hardware notifications associated with this user. A hardware notifica [layoutProfileCount]: #layoutprofilecount #### [layoutProfileCount] A count of contains the definition of the layout profile. -Type: **unsigned long** +Type: **unsigned long** + @@ -1079,7 +1183,8 @@ A count of contains the definition of the layout profile. [loginAttemptCount]: #loginattemptcount #### [loginAttemptCount] A count of a user's attempts to log into the SoftLayer customer portal. -Type: **unsigned long** +Type: **unsigned long** + @@ -1089,7 +1194,8 @@ A count of a user's attempts to log into the SoftLayer customer portal. [mobileDeviceCount]: #mobiledevicecount #### [mobileDeviceCount] A count of a portal user's associated mobile device profiles. -Type: **unsigned long** +Type: **unsigned long** + @@ -1099,7 +1205,8 @@ A count of a portal user's associated mobile device profiles. [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of notification subscription records for the user. -Type: **unsigned long** +Type: **unsigned long** + @@ -1109,7 +1216,8 @@ A count of notification subscription records for the user. [openTicketCount]: #openticketcount #### [openTicketCount] A count of an user's associated open tickets. -Type: **unsigned long** +Type: **unsigned long** + @@ -1119,7 +1227,8 @@ A count of an user's associated open tickets. [overrideCount]: #overridecount #### [overrideCount] A count of a portal user's vpn accessible subnets. -Type: **unsigned long** +Type: **unsigned long** + @@ -1129,7 +1238,8 @@ A count of a portal user's vpn accessible subnets. [permissionCount]: #permissioncount #### [permissionCount] A count of a portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API. -Type: **unsigned long** +Type: **unsigned long** + @@ -1139,7 +1249,8 @@ A count of a portal user's permissions. These permissions control that user's ac [preferenceCount]: #preferencecount #### [preferenceCount] A count of data type contains a single user preference to a specific preference type. -Type: **unsigned long** +Type: **unsigned long** + @@ -1149,7 +1260,8 @@ A count of data type contains a single user preference to a specific preference [roleCount]: #rolecount #### [roleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1159,7 +1271,8 @@ A count of [securityAnswerCount]: #securityanswercount #### [securityAnswerCount] A count of a portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login. -Type: **unsigned long** +Type: **unsigned long** + @@ -1169,7 +1282,8 @@ A count of a portal user's security question answers. Some portal users may not [subscriberCount]: #subscribercount #### [subscriberCount] A count of a user's notification subscription records. -Type: **unsigned long** +Type: **unsigned long** + @@ -1179,7 +1293,8 @@ A count of a user's notification subscription records. [successfulLoginCount]: #successfullogincount #### [successfulLoginCount] A count of a user's successful attempts to log into the SoftLayer customer portal. -Type: **unsigned long** +Type: **unsigned long** + @@ -1189,7 +1304,8 @@ A count of a user's successful attempts to log into the SoftLayer customer porta [surveyCount]: #surveycount #### [surveyCount] A count of the surveys that a user has taken in the SoftLayer customer portal. -Type: **unsigned long** +Type: **unsigned long** + @@ -1199,7 +1315,8 @@ A count of the surveys that a user has taken in the SoftLayer customer portal. [ticketCount]: #ticketcount #### [ticketCount] A count of an user's associated tickets. -Type: **unsigned long** +Type: **unsigned long** + @@ -1209,7 +1326,8 @@ A count of an user's associated tickets. [unsuccessfulLoginCount]: #unsuccessfullogincount #### [unsuccessfulLoginCount] A count of a user's unsuccessful attempts to log into the SoftLayer customer portal. -Type: **unsigned long** +Type: **unsigned long** + @@ -1219,7 +1337,8 @@ A count of a user's unsuccessful attempts to log into the SoftLayer customer por [userLinkCount]: #userlinkcount #### [userLinkCount] A count of user customer link with IBMid and IAMid. -Type: **unsigned long** +Type: **unsigned long** + @@ -1229,7 +1348,8 @@ A count of user customer link with IBMid and IAMid. [virtualGuestCount]: #virtualguestcount #### [virtualGuestCount] A count of a portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_Access_Authentication/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_Access_Authentication/_index.md index 7b10d74445..235e73c66b 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_Access_Authentication/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_Access_Authentication/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -66,7 +68,8 @@ SoftLayer employees periodically log into our customer portal as users to diagno [createDate]: #createdate #### [createDate] The date of an attempt to log into the SoftLayer customer portal. -Type: **dateTime** +Type: **dateTime** + @@ -76,7 +79,8 @@ The date of an attempt to log into the SoftLayer customer portal. [ipAddress]: #ipaddress #### [ipAddress] The IP address of the user who attempted to log into the SoftLayer customer portal. -Type: **string** +Type: **string** + @@ -86,7 +90,8 @@ The IP address of the user who attempted to log into the SoftLayer customer port [successFlag]: #successflag #### [successFlag] Whether an attempt to log into the SoftLayer customer portal was successful or not. -Type: **boolean** +Type: **boolean** + @@ -96,7 +101,8 @@ Whether an attempt to log into the SoftLayer customer portal was successful or n [userId]: #userid #### [userId] The internal identifier of the user who attempted to log into the SoftLayer customer portal. -Type: **integer** +Type: **integer** + @@ -106,7 +112,8 @@ The internal identifier of the user who attempted to log into the SoftLayer cust [username]: #username #### [username] The username used when attempting to log into the SoftLayer customer portal -Type: **string** +Type: **string** + @@ -122,7 +129,8 @@ The username used when attempting to log into the SoftLayer customer portal [user]: #user #### [user] The user who has attempted to log into the SoftLayer customer portal. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_AdditionalEmail/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_AdditionalEmail/_index.md index b1864168b7..0753401683 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_AdditionalEmail/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_AdditionalEmail/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_User_Customer_AdditionalEmail data type contains the additional email for use in ticket update notifications. @@ -52,7 +54,8 @@ The SoftLayer_User_Customer_AdditionalEmail data type contains the additional em [email]: #email #### [email] Email assigned to user for use in ticket update notifications. -Type: **string** +Type: **string** + @@ -62,7 +65,8 @@ Email assigned to user for use in ticket update notifications. [userId]: #userid #### [userId] An internal identifier for the portal user who this additional email belongs to. -Type: **integer** +Type: **integer** + @@ -78,7 +82,8 @@ An internal identifier for the portal user who this additional email belongs to. [user]: #user #### [user] The portal user that owns this additional email address. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_ApiAuthentication/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_ApiAuthentication/_index.md index 048c76f768..4ac584481e 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_ApiAuthentication/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_ApiAuthentication/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_User_Customer_ApiAuthentication type contains user's authentication key(s). @@ -56,7 +58,8 @@ The SoftLayer_User_Customer_ApiAuthentication type contains user's authenticatio [authenticationKey]: #authenticationkey #### [authenticationKey] The user's authentication key for API access. -Type: **string** +Type: **string** + @@ -66,7 +69,8 @@ The user's authentication key for API access. [id]: #id #### [id] The user's API authentication identifying number. -Type: **integer** +Type: **integer** + @@ -76,7 +80,8 @@ The user's API authentication identifying number. [ipAddressRestriction]: #ipaddressrestriction #### [ipAddressRestriction] The IP addresses or IP ranges from which this user may access the SoftLayer API. Specify subnets in CIDR format and separate multiple addresses and subnets by commas. You may combine IPv4 and IPv6 addresses and subnets, for example: 192.168.0.0/16,fe80:021b::0/64. -Type: **string** +Type: **string** + @@ -86,7 +91,8 @@ The IP addresses or IP ranges from which this user may access the SoftLayer API. [timestampKey]: #timestampkey #### [timestampKey] The user's authentication key modification date. -Type: **integer** +Type: **integer** + @@ -96,7 +102,8 @@ The user's authentication key modification date. [userId]: #userid #### [userId] The user's identifying number. -Type: **integer** +Type: **integer** + @@ -112,7 +119,8 @@ The user's identifying number. [user]: #user #### [user] The user who owns the api authentication key. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission/_index.md index c9e75fbc0f..bbc8ced735 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -59,7 +61,8 @@ Each SoftLayer portal account is assigned a series of permissions that determine [key]: #key #### [key] A user permission's short name. -Type: **string** +Type: **string** + @@ -69,7 +72,8 @@ A user permission's short name. [keyName]: #keyname #### [keyName] A user permission's key name. -Type: **string** +Type: **string** + @@ -79,7 +83,8 @@ A user permission's key name. [name]: #name #### [name] A user permission's name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_External_Binding/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_External_Binding/_index.md index ab9cbf023d..48c4f5528a 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_External_Binding/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_External_Binding/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_User_Customer_External_Binding data type contains general informat [active]: #active #### [active] The flag that determines whether the external binding is active will be used for authentication or not. -Type: **boolean** +Type: **boolean** + @@ -55,7 +58,8 @@ The flag that determines whether the external binding is active will be used for [createDate]: #createdate #### [createDate] The date that the external authentication binding was created. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The date that the external authentication binding was created. [externalId]: #externalid #### [externalId] The identifier used to identify this binding to an external authentication source. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The identifier used to identify this binding to an external authentication sourc [id]: #id #### [id] An external authentication binding's internal identifier. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ An external authentication binding's internal identifier. [password]: #password #### [password] The password used to authenticate the external id at an external authentication source. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The password used to authenticate the external id at an external authentication [typeId]: #typeid #### [typeId] The [SoftLayer_User_External_Binding_Type]({{}}) identifier of an external authentication binding. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The [SoftLayer_User_External_Binding_Type]({{}}) id. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ An external authentication binding's associated [SoftLayer_User_Customer]({{}}) identifier of an external authentication binding. -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ The [SoftLayer_User_External_Binding_Vendor]({{Type: **SoftLayer_User_External_Binding_Attribute[] ** +Type: **SoftLayer_User_External_Binding_Attribute[] ** + @@ -141,7 +152,8 @@ Attributes of an external authentication binding. [billingItem]: #billingitem #### [billingItem] Information regarding the billing item for external authentication. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -151,7 +163,8 @@ Information regarding the billing item for external authentication. [note]: #note #### [note] An optional note for identifying the external binding. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ An optional note for identifying the external binding. [type]: #type #### [type] The type of external authentication binding. -Type: **SoftLayer_User_External_Binding_Type ** +Type: **SoftLayer_User_External_Binding_Type ** + @@ -171,7 +185,8 @@ The type of external authentication binding. [user]: #user #### [user] The SoftLayer user that the external authentication binding belongs to. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -181,7 +196,8 @@ The SoftLayer user that the external authentication binding belongs to. [vendor]: #vendor #### [vendor] The vendor of an external authentication binding. -Type: **SoftLayer_User_External_Binding_Vendor ** +Type: **SoftLayer_User_External_Binding_Vendor ** + @@ -193,7 +209,8 @@ The vendor of an external authentication binding. [attributeCount]: #attributecount #### [attributeCount] A count of attributes of an external authentication binding. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Attribute/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Attribute/_index.md index 2a69ea61e7..5ee3c83e9e 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Attribute/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -49,7 +51,8 @@ The SoftLayer_User_Customer_External_Binding_Attribute data type contains the va [value]: #value #### [value] The value of an external binding attribute. -Type: **string** +Type: **string** + @@ -65,7 +68,8 @@ The value of an external binding attribute. [externalBinding]: #externalbinding #### [externalBinding] The external authentication binding an attribute belongs to. -Type: **SoftLayer_User_External_Binding ** +Type: **SoftLayer_User_External_Binding ** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Phone/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Phone/_index.md index 00de9d922c..7a81bbe129 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Phone/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Phone/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_User_Customer_External_Binding_Phone data type contains information about an external binding that uses a phone call, SMS or mobile app for 2 form factor authentication. The external binding information is used when a SoftLayer customer logs into the SoftLayer customer portal or VPN to authenticate them against a trusted 3rd party, in this case using a mobile phone, mobile phone application or land-line phone. SoftLayer users with an active external binding will be prohibited from using the API for security reasons. @@ -47,7 +49,8 @@ SoftLayer users with an active external binding will be prohibited from using th [active]: #active #### [active] The flag that determines whether the external binding is active will be used for authentication or not. -Type: **boolean** +Type: **boolean** + @@ -57,7 +60,8 @@ The flag that determines whether the external binding is active will be used for [createDate]: #createdate #### [createDate] The date that the external authentication binding was created. -Type: **dateTime** +Type: **dateTime** + @@ -67,7 +71,8 @@ The date that the external authentication binding was created. [externalId]: #externalid #### [externalId] The identifier used to identify this binding to an external authentication source. -Type: **string** +Type: **string** + @@ -77,7 +82,8 @@ The identifier used to identify this binding to an external authentication sourc [id]: #id #### [id] An external authentication binding's internal identifier. -Type: **integer** +Type: **integer** + @@ -87,7 +93,8 @@ An external authentication binding's internal identifier. [password]: #password #### [password] The password used to authenticate the external id at an external authentication source. -Type: **string** +Type: **string** + @@ -97,7 +104,8 @@ The password used to authenticate the external id at an external authentication [typeId]: #typeid #### [typeId] The [SoftLayer_User_External_Binding_Type]({{}}) identifier of an external authentication binding. -Type: **integer** +Type: **integer** + @@ -107,7 +115,8 @@ The [SoftLayer_User_External_Binding_Type]({{}}) id. -Type: **integer** +Type: **integer** + @@ -117,7 +126,8 @@ An external authentication binding's associated [SoftLayer_User_Customer]({{}}) identifier of an external authentication binding. -Type: **integer** +Type: **integer** + @@ -133,7 +143,8 @@ The [SoftLayer_User_External_Binding_Vendor]({{Type: **SoftLayer_User_External_Binding_Attribute[] ** +Type: **SoftLayer_User_External_Binding_Attribute[] ** + @@ -143,7 +154,8 @@ Attributes of an external authentication binding. [billingItem]: #billingitem #### [billingItem] The current billing item for an external binding. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -153,7 +165,8 @@ The current billing item for an external binding. [bindingStatus]: #bindingstatus #### [bindingStatus] The current external binding status. It can be "ACTIVE" or "BLOCKED". -Type: **string** +Type: **string** + @@ -163,7 +176,8 @@ The current external binding status. It can be "ACTIVE" or "BLOCKED". [note]: #note #### [note] An optional note for identifying the external binding. -Type: **string** +Type: **string** + @@ -173,7 +187,8 @@ An optional note for identifying the external binding. [pinLength]: #pinlength #### [pinLength] -Type: **string** +Type: **string** + @@ -183,7 +198,8 @@ An optional note for identifying the external binding. [type]: #type #### [type] The type of external authentication binding. -Type: **SoftLayer_User_External_Binding_Type ** +Type: **SoftLayer_User_External_Binding_Type ** + @@ -193,7 +209,8 @@ The type of external authentication binding. [user]: #user #### [user] The SoftLayer user that the external authentication binding belongs to. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -203,7 +220,8 @@ The SoftLayer user that the external authentication binding belongs to. [vendor]: #vendor #### [vendor] The vendor of an external authentication binding. -Type: **SoftLayer_User_External_Binding_Vendor ** +Type: **SoftLayer_User_External_Binding_Vendor ** + @@ -215,7 +233,8 @@ The vendor of an external authentication binding. [attributeCount]: #attributecount #### [attributeCount] A count of attributes of an external authentication binding. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Totp/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Totp/_index.md index b5d4c5e891..a8dca2923f 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Totp/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Totp/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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: @@ -54,7 +56,8 @@ SoftLayer users with an active external binding will be prohibited from using th [active]: #active #### [active] The flag that determines whether the external binding is active will be used for authentication or not. -Type: **boolean** +Type: **boolean** + @@ -64,7 +67,8 @@ The flag that determines whether the external binding is active will be used for [createDate]: #createdate #### [createDate] The date that the external authentication binding was created. -Type: **dateTime** +Type: **dateTime** + @@ -74,7 +78,8 @@ The date that the external authentication binding was created. [externalId]: #externalid #### [externalId] The identifier used to identify this binding to an external authentication source. -Type: **string** +Type: **string** + @@ -84,7 +89,8 @@ The identifier used to identify this binding to an external authentication sourc [id]: #id #### [id] An external authentication binding's internal identifier. -Type: **integer** +Type: **integer** + @@ -94,7 +100,8 @@ An external authentication binding's internal identifier. [password]: #password #### [password] The password used to authenticate the external id at an external authentication source. -Type: **string** +Type: **string** + @@ -104,7 +111,8 @@ The password used to authenticate the external id at an external authentication [typeId]: #typeid #### [typeId] The [SoftLayer_User_External_Binding_Type]({{}}) identifier of an external authentication binding. -Type: **integer** +Type: **integer** + @@ -114,7 +122,8 @@ The [SoftLayer_User_External_Binding_Type]({{}}) id. -Type: **integer** +Type: **integer** + @@ -124,7 +133,8 @@ An external authentication binding's associated [SoftLayer_User_Customer]({{}}) identifier of an external authentication binding. -Type: **integer** +Type: **integer** + @@ -140,7 +150,8 @@ The [SoftLayer_User_External_Binding_Vendor]({{Type: **SoftLayer_User_External_Binding_Attribute[] ** +Type: **SoftLayer_User_External_Binding_Attribute[] ** + @@ -150,7 +161,8 @@ Attributes of an external authentication binding. [billingItem]: #billingitem #### [billingItem] Information regarding the billing item for external authentication. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -160,7 +172,8 @@ Information regarding the billing item for external authentication. [note]: #note #### [note] An optional note for identifying the external binding. -Type: **string** +Type: **string** + @@ -170,7 +183,8 @@ An optional note for identifying the external binding. [type]: #type #### [type] The type of external authentication binding. -Type: **SoftLayer_User_External_Binding_Type ** +Type: **SoftLayer_User_External_Binding_Type ** + @@ -180,7 +194,8 @@ The type of external authentication binding. [user]: #user #### [user] The SoftLayer user that the external authentication binding belongs to. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -190,7 +205,8 @@ The SoftLayer user that the external authentication binding belongs to. [vendor]: #vendor #### [vendor] The vendor of an external authentication binding. -Type: **SoftLayer_User_External_Binding_Vendor ** +Type: **SoftLayer_User_External_Binding_Vendor ** + @@ -202,7 +218,8 @@ The vendor of an external authentication binding. [attributeCount]: #attributecount #### [attributeCount] A count of attributes of an external authentication binding. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Type/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Type/_index.md index 2962f930d1..41c0bff28b 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_User_Customer_External_Binding_Type data type contains information [keyName]: #keyname #### [keyName] The unique name used to identify a type of external authentication binding. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The unique name used to identify a type of external authentication binding. [name]: #name #### [name] The user friendly name of a type of external authentication binding. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Vendor/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Vendor/_index.md index edc9a39eab..f2106de150 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Vendor/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Vendor/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_User_Customer_External_Binding_Vendor data type contains informati [id]: #id #### [id] The unique identifier for an external binding vendor. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The unique identifier for an external binding vendor. [keyName]: #keyname #### [keyName] A unique version of the name property. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ A unique version of the name property. [name]: #name #### [name] The user friendly name of an external binding vendor. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Verisign/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Verisign/_index.md index b2179da733..99eb3f5dc6 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Verisign/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_External_Binding_Verisign/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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: @@ -57,7 +59,8 @@ SoftLayer users with an active external binding will be prohibited from using th [active]: #active #### [active] The flag that determines whether the external binding is active will be used for authentication or not. -Type: **boolean** +Type: **boolean** + @@ -67,7 +70,8 @@ The flag that determines whether the external binding is active will be used for [createDate]: #createdate #### [createDate] The date that the external authentication binding was created. -Type: **dateTime** +Type: **dateTime** + @@ -77,7 +81,8 @@ The date that the external authentication binding was created. [externalId]: #externalid #### [externalId] The identifier used to identify this binding to an external authentication source. -Type: **string** +Type: **string** + @@ -87,7 +92,8 @@ The identifier used to identify this binding to an external authentication sourc [id]: #id #### [id] An external authentication binding's internal identifier. -Type: **integer** +Type: **integer** + @@ -97,7 +103,8 @@ An external authentication binding's internal identifier. [password]: #password #### [password] The password used to authenticate the external id at an external authentication source. -Type: **string** +Type: **string** + @@ -107,7 +114,8 @@ The password used to authenticate the external id at an external authentication [typeId]: #typeid #### [typeId] The [SoftLayer_User_External_Binding_Type]({{}}) identifier of an external authentication binding. -Type: **integer** +Type: **integer** + @@ -117,7 +125,8 @@ The [SoftLayer_User_External_Binding_Type]({{}}) id. -Type: **integer** +Type: **integer** + @@ -127,7 +136,8 @@ An external authentication binding's associated [SoftLayer_User_Customer]({{}}) identifier of an external authentication binding. -Type: **integer** +Type: **integer** + @@ -143,7 +153,8 @@ The [SoftLayer_User_External_Binding_Vendor]({{Type: **SoftLayer_User_External_Binding_Attribute[] ** +Type: **SoftLayer_User_External_Binding_Attribute[] ** + @@ -153,7 +164,8 @@ Attributes of an external authentication binding. [billingItem]: #billingitem #### [billingItem] The current billing item for an external binding. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -163,7 +175,8 @@ The current billing item for an external binding. [credentialExpirationDate]: #credentialexpirationdate #### [credentialExpirationDate] The date that a VeriSign credential expires. -Type: **string** +Type: **string** + @@ -173,7 +186,8 @@ The date that a VeriSign credential expires. [credentialLastUpdateDate]: #credentiallastupdatedate #### [credentialLastUpdateDate] The last time a VeriSign credential was updated. -Type: **string** +Type: **string** + @@ -183,7 +197,8 @@ The last time a VeriSign credential was updated. [credentialState]: #credentialstate #### [credentialState] The current state of a VeriSign credential. This can be 'Enabled', 'Disabled', or 'Locked'. -Type: **string** +Type: **string** + @@ -193,7 +208,8 @@ The current state of a VeriSign credential. This can be 'Enabled', 'Disabled', o [credentialType]: #credentialtype #### [credentialType] The type of VeriSign credential. This can be either 'Hardware' or 'Software'. -Type: **string** +Type: **string** + @@ -203,7 +219,8 @@ The type of VeriSign credential. This can be either 'Hardware' or 'Software'. [note]: #note #### [note] An optional note for identifying the external binding. -Type: **string** +Type: **string** + @@ -213,7 +230,8 @@ An optional note for identifying the external binding. [type]: #type #### [type] The type of external authentication binding. -Type: **SoftLayer_User_External_Binding_Type ** +Type: **SoftLayer_User_External_Binding_Type ** + @@ -223,7 +241,8 @@ The type of external authentication binding. [user]: #user #### [user] The SoftLayer user that the external authentication binding belongs to. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -233,7 +252,8 @@ The SoftLayer user that the external authentication binding belongs to. [vendor]: #vendor #### [vendor] The vendor of an external authentication binding. -Type: **SoftLayer_User_External_Binding_Vendor ** +Type: **SoftLayer_User_External_Binding_Vendor ** + @@ -245,7 +265,8 @@ The vendor of an external authentication binding. [attributeCount]: #attributecount #### [attributeCount] A count of attributes of an external authentication binding. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_Invitation/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_Invitation/_index.md index b42981a95b..1ad1ff704a 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_Invitation/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_Invitation/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [code]: #code #### [code] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
              @@ -65,7 +69,8 @@ classes: [creatorId]: #creatorid #### [creatorId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [creatorType]: #creatortype #### [creatorType] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [email]: #email #### [email] -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ classes: [existingBlueIdFlag]: #existingblueidflag #### [existingBlueIdFlag] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [expirationDate]: #expirationdate #### [expirationDate] -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ classes: [ibmIdUsername]: #ibmidusername #### [ibmIdUsername] -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ classes: [isFederatedEmailDomainFlag]: #isfederatedemaildomainflag #### [isFederatedEmailDomainFlag] -Type: **integer** +Type: **integer** + @@ -145,7 +157,8 @@ classes: [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -155,7 +168,8 @@ classes: [responseDate]: #responsedate #### [responseDate] -Type: **dateTime** +Type: **dateTime** + @@ -165,7 +179,8 @@ classes: [statusId]: #statusid #### [statusId] -Type: **integer** +Type: **integer** + @@ -175,7 +190,8 @@ classes: [userId]: #userid #### [userId] -Type: **integer** +Type: **integer** + @@ -191,7 +207,8 @@ classes: [user]: #user #### [user] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_Link/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_Link/_index.md index 57e0d1c161..920856ec8e 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_Link/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_Link/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ classes: [defaultFlag]: #defaultflag #### [defaultFlag] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [destinationUserAlphanumericId]: #destinationuseralphanumericid #### [destinationUserAlphanumericId] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [destinationUserId]: #destinationuserid #### [destinationUserId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [iamIdVerificationFlag]: #iamidverificationflag #### [iamIdVerificationFlag] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [realm]: #realm #### [realm] The realm of the IAMid unique identifier. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The realm of the IAMid unique identifier. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ The realm of the IAMid unique identifier. [uniqueIdentifier]: #uniqueidentifier #### [uniqueIdentifier] The IAMid Unique Identifier formed in the format of "realm-uniqueIdentifier" -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The IAMid Unique Identifier formed in the format of "realm-uniqueIdentifier" [userId]: #userid #### [userId] -Type: **integer** +Type: **integer** + @@ -151,7 +163,8 @@ The IAMid Unique Identifier formed in the format of "realm-uniqueIdentifier" [serviceProvider]: #serviceprovider #### [serviceProvider] -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -161,7 +174,8 @@ The IAMid Unique Identifier formed in the format of "realm-uniqueIdentifier" [user]: #user #### [user] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_Link_TrustedProfile/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_Link_TrustedProfile/_index.md index cb5cf3e08b..8274804653 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_Link_TrustedProfile/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_Link_TrustedProfile/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ classes: [defaultFlag]: #defaultflag #### [defaultFlag] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [destinationUserAlphanumericId]: #destinationuseralphanumericid #### [destinationUserAlphanumericId] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [destinationUserId]: #destinationuserid #### [destinationUserId] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [iamIdVerificationFlag]: #iamidverificationflag #### [iamIdVerificationFlag] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ classes: [realm]: #realm #### [realm] The realm of the IAMid unique identifier. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The realm of the IAMid unique identifier. [serviceProviderId]: #serviceproviderid #### [serviceProviderId] -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ The realm of the IAMid unique identifier. [uniqueIdentifier]: #uniqueidentifier #### [uniqueIdentifier] The IAMid Unique Identifier formed in the format of "realm-uniqueIdentifier" -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The IAMid Unique Identifier formed in the format of "realm-uniqueIdentifier" [userId]: #userid #### [userId] -Type: **integer** +Type: **integer** + @@ -151,7 +163,8 @@ The IAMid Unique Identifier formed in the format of "realm-uniqueIdentifier" [serviceProvider]: #serviceprovider #### [serviceProvider] -Type: **SoftLayer_Service_Provider ** +Type: **SoftLayer_Service_Provider ** + @@ -161,7 +174,8 @@ The IAMid Unique Identifier formed in the format of "realm-uniqueIdentifier" [user]: #user #### [user] -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_Link_VerifiedIamIdLinkCollection/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_Link_VerifiedIamIdLinkCollection/_index.md index cee98bc64c..4edef1bda2 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_Link_VerifiedIamIdLinkCollection/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_Link_VerifiedIamIdLinkCollection/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [badLinksDifferentIUI]: #badlinksdifferentiui #### [badLinksDifferentIUI] -Type: **SoftLayer_User_Customer_Link[] ** +Type: **SoftLayer_User_Customer_Link[] ** +
              @@ -55,7 +58,8 @@ classes: [badLinksDifferentUsername]: #badlinksdifferentusername #### [badLinksDifferentUsername] -Type: **SoftLayer_User_Customer_Link[] ** +Type: **SoftLayer_User_Customer_Link[] ** +
              @@ -65,7 +69,8 @@ classes: [goodLinks]: #goodlinks #### [goodLinks] -Type: **SoftLayer_User_Customer_Link[] ** +Type: **SoftLayer_User_Customer_Link[] ** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_MobileDevice/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_MobileDevice/_index.md index 31c61244a1..1d36693b04 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_MobileDevice/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_MobileDevice/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class represents a mobile device belonging to a user. The device can be a phone, tablet, or possibly even some Android based net books. The purpose is to tie just enough info with the device and the user to enable push notifications through non-softlayer entities (Google, Apple, RIM). @@ -45,7 +47,8 @@ This class represents a mobile device belonging to a user. The device can be a [createDate]: #createdate #### [createDate] Created date for the record. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ Created date for the record. [displayResolutionXxY]: #displayresolutionxxy #### [displayResolutionXxY] The device resolution formatted width x height -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The device resolution formatted width x height [id]: #id #### [id] Record Identifier -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ Record Identifier [mobileDeviceTypeId]: #mobiledevicetypeid #### [mobileDeviceTypeId] Device type identifier. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Device type identifier. [mobileOperatingSystemId]: #mobileoperatingsystemid #### [mobileOperatingSystemId] Mobile OS identifier. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ Mobile OS identifier. [modelNumber]: #modelnumber #### [modelNumber] Device model number -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ Device model number [modifyDate]: #modifydate #### [modifyDate] Last modify date for the record. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ Last modify date for the record. [name]: #name #### [name] The name of the device the user is using. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The name of the device the user is using. [phoneNumber]: #phonenumber #### [phoneNumber] Device phone number -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Device phone number [serialNumber]: #serialnumber #### [serialNumber] Device serial number -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ Device serial number [token]: #token #### [token] The token that is provided by the mobile device. -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ The token that is provided by the mobile device. [userId]: #userid #### [userId] User Identifier -Type: **integer** +Type: **integer** + @@ -171,7 +185,8 @@ User Identifier [availablePushNotificationSubscriptions]: #availablepushnotificationsubscriptions #### [availablePushNotificationSubscriptions] Notification subscriptions available to a mobile device. -Type: **SoftLayer_Notification[] ** +Type: **SoftLayer_Notification[] ** + @@ -181,7 +196,8 @@ Notification subscriptions available to a mobile device. [customer]: #customer #### [customer] The user this mobile device belongs to. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -191,7 +207,8 @@ The user this mobile device belongs to. [operatingSystem]: #operatingsystem #### [operatingSystem] The operating system this device is using -Type: **SoftLayer_User_Customer_MobileDevice_OperatingSystem ** +Type: **SoftLayer_User_Customer_MobileDevice_OperatingSystem ** + @@ -201,7 +218,8 @@ The operating system this device is using [pushNotificationSubscriptions]: #pushnotificationsubscriptions #### [pushNotificationSubscriptions] Notification subscriptions attached to a mobile device. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -211,7 +229,8 @@ Notification subscriptions attached to a mobile device. [type]: #type #### [type] The type of device this user is using -Type: **SoftLayer_User_Customer_MobileDevice_Type ** +Type: **SoftLayer_User_Customer_MobileDevice_Type ** + @@ -223,7 +242,8 @@ The type of device this user is using [availablePushNotificationSubscriptionCount]: #availablepushnotificationsubscriptioncount #### [availablePushNotificationSubscriptionCount] A count of notification subscriptions available to a mobile device. -Type: **unsigned long** +Type: **unsigned long** + @@ -233,7 +253,8 @@ A count of notification subscriptions available to a mobile device. [pushNotificationSubscriptionCount]: #pushnotificationsubscriptioncount #### [pushNotificationSubscriptionCount] A count of notification subscriptions attached to a mobile device. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_MobileDevice_OperatingSystem/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_MobileDevice_OperatingSystem/_index.md index 7e8b0c0acd..e981dfb32d 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_MobileDevice_OperatingSystem/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_MobileDevice_OperatingSystem/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class represents the mobile operating system installed on a user's registered mobile device. It assists us when determining the how to get a push notification to the user. @@ -45,7 +47,8 @@ This class represents the mobile operating system installed on a user's register [buildVersion]: #buildversion #### [buildVersion] Build revision number of the operating system. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Build revision number of the operating system. [createDate]: #createdate #### [createDate] Create date of the record. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ Create date of the record. [description]: #description #### [description] Description of the mobile operating system.. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Description of the mobile operating system.. [id]: #id #### [id] Indentifier for the record. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Indentifier for the record. [majorVersion]: #majorversion #### [majorVersion] Major revision number of the operating system. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ Major revision number of the operating system. [minorVersion]: #minorversion #### [minorVersion] Minor revision number of the operating system. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ Minor revision number of the operating system. [modifyDate]: #modifydate #### [modifyDate] Modify date of the record. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ Modify date of the record. [name]: #name #### [name] Name of the mobile operating system. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_MobileDevice_Type/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_MobileDevice_Type/_index.md index e6b22dad0e..fd1c06fac7 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_MobileDevice_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_MobileDevice_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Describes a supported class of mobile device. In this the word class is used in the context of classes of consumer electronic devices, the two most prominent examples being mobile phones and tablets. @@ -50,7 +52,8 @@ Describes a supported class of mobile device. In this the word class is used in [createDate]: #createdate #### [createDate] Record create date. -Type: **dateTime** +Type: **dateTime** + @@ -60,7 +63,8 @@ Record create date. [description]: #description #### [description] A description of the device -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ A description of the device [id]: #id #### [id] Indentifier for record. -Type: **integer** +Type: **integer** + @@ -80,7 +85,8 @@ Indentifier for record. [modifyDate]: #modifydate #### [modifyDate] Last modify date for record. -Type: **dateTime** +Type: **dateTime** + @@ -90,7 +96,8 @@ Last modify date for record. [name]: #name #### [name] The common name of the device. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_Notification_Hardware/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_Notification_Hardware/_index.md index 2b8c3b29c8..c1f76a8f06 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_Notification_Hardware/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_Notification_Hardware/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ The Customer_Notification_Hardware object stores links between customers and the [hardwareId]: #hardwareid #### [hardwareId] The ID of the Hardware object that is to be monitored. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ The ID of the Hardware object that is to be monitored. [id]: #id #### [id] The unique identifier for this object -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ The unique identifier for this object [userId]: #userid #### [userId] The ID of the SoftLayer_User_Customer object that represents the user to be notified on monitoring failure. -Type: **integer** +Type: **integer** + @@ -86,7 +91,8 @@ The ID of the SoftLayer_User_Customer object that represents the user to be noti [hardware]: #hardware #### [hardware] The hardware object that will be monitored. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -96,7 +102,8 @@ The hardware object that will be monitored. [user]: #user #### [user] The user that will be notified when the associated hardware object fails a monitoring instance. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_Notification_Virtual_Guest/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_Notification_Virtual_Guest/_index.md index 84978f1679..a4fce3ee22 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_Notification_Virtual_Guest/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_Notification_Virtual_Guest/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_User_Customer_Notification_Virtual_Guest object stores links betwe [guestId]: #guestid #### [guestId] The ID of the virtual guest object that is to be monitored. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The ID of the virtual guest object that is to be monitored. [id]: #id #### [id] The unique identifier for this object -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The unique identifier for this object [userId]: #userid #### [userId] The ID of the SoftLayer_User_Customer object that represents the user to be notified on monitoring failure. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ The ID of the SoftLayer_User_Customer object that represents the user to be noti [guest]: #guest #### [guest] The virtual guest object that will be monitored. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -91,7 +97,8 @@ The virtual guest object that will be monitored. [user]: #user #### [user] The user that will be notified when the associated virtual guest object fails a monitoring instance. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_OpenIdConnect/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_OpenIdConnect/_index.md index 6728fcd9e2..e521022063 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_OpenIdConnect/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_OpenIdConnect/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] A portal user's associated [SoftLayer_Account]({{}}) id. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ A portal user's associated [SoftLayer_Account]({{Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ The first line of the mailing address belonging to a portal user. [address2]: #address2 #### [address2] The second line of the mailing address belonging to a portal user. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The second line of the mailing address belonging to a portal user. [aim]: #aim #### [aim] A portal user's AOL Instant Messenger screen name. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ A portal user's AOL Instant Messenger screen name. [alternatePhone]: #alternatephone #### [alternatePhone] A portal user's secondary phone number. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ A portal user's secondary phone number. [authenticationToken]: #authenticationtoken #### [authenticationToken] The authentication token used for logging into the SoftLayer customer portal. -Type: **SoftLayer_Container_User_Authentication_Token ** +Type: **SoftLayer_Container_User_Authentication_Token ** + @@ -105,7 +113,8 @@ The authentication token used for logging into the SoftLayer customer portal. [city]: #city #### [city] The city of the mailing address belonging to a portal user. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The city of the mailing address belonging to a portal user. [companyName]: #companyname #### [companyName] A portal user's associated company. This may not be the same company as the customer that owns this portal user. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A portal user's associated company. This may not be the same company as the cust [country]: #country #### [country] A two-letter abbreviation of the country in the mailing address belonging to a portal user. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ A two-letter abbreviation of the country in the mailing address belonging to a p [createDate]: #createdate #### [createDate] The date a portal user's record was created. -Type: **dateTime** +Type: **dateTime** + @@ -145,7 +157,8 @@ The date a portal user's record was created. [daylightSavingsTimeFlag]: #daylightsavingstimeflag #### [daylightSavingsTimeFlag] Whether a portal user's time zone is affected by Daylight Savings Time. -Type: **boolean** +Type: **boolean** + @@ -155,7 +168,8 @@ Whether a portal user's time zone is affected by Daylight Savings Time. [denyAllResourceAccessOnCreateFlag]: #denyallresourceaccessoncreateflag #### [denyAllResourceAccessOnCreateFlag] Flag used to deny access to all hardware and cloud computing instances upon user creation. -Type: **boolean** +Type: **boolean** + @@ -165,7 +179,8 @@ Flag used to deny access to all hardware and cloud computing instances upon user [displayName]: #displayname #### [displayName] -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ Flag used to deny access to all hardware and cloud computing instances upon user [email]: #email #### [email] A portal user's email address. -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ A portal user's email address. [firstName]: #firstname #### [firstName] A portal user's first name. -Type: **string** +Type: **string** + @@ -195,7 +212,8 @@ A portal user's first name. [forumPasswordHash]: #forumpasswordhash #### [forumPasswordHash] A user's password for the SoftLayer forums, hashed for auto-login capability from the SoftLayer customer portal -Type: **string** +Type: **string** + @@ -205,7 +223,8 @@ A user's password for the SoftLayer forums, hashed for auto-login capability fro [iamAuthorizationStatus]: #iamauthorizationstatus #### [iamAuthorizationStatus] -Type: **integer** +Type: **integer** + @@ -215,7 +234,8 @@ A user's password for the SoftLayer forums, hashed for auto-login capability fro [iamId]: #iamid #### [iamId] The IAMid (realm-identifier) of the user being created by PaaS -Type: **string** +Type: **string** + @@ -225,7 +245,8 @@ The IAMid (realm-identifier) of the user being created by PaaS [icq]: #icq #### [icq] A portal user's ICQ UIN. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ A portal user's ICQ UIN. [id]: #id #### [id] A portal user's internal identifying number. -Type: **integer** +Type: **integer** + @@ -245,7 +267,8 @@ A portal user's internal identifying number. [ipAddressRestriction]: #ipaddressrestriction #### [ipAddressRestriction] The IP addresses or IP ranges from which a user may login to the SoftLayer customer portal. Specify subnets in CIDR format and separate multiple addresses and subnets by commas. You may combine IPv4 and IPv6 addresses and subnets, for example: 192.168.0.0/16,fe80:021b::0/64. -Type: **string** +Type: **string** + @@ -255,7 +278,8 @@ The IP addresses or IP ranges from which a user may login to the SoftLayer custo [isMasterUserFlag]: #ismasteruserflag #### [isMasterUserFlag] -Type: **boolean** +Type: **boolean** + @@ -265,7 +289,8 @@ The IP addresses or IP ranges from which a user may login to the SoftLayer custo [lastName]: #lastname #### [lastName] A portal user's last name. -Type: **string** +Type: **string** + @@ -275,7 +300,8 @@ A portal user's last name. [linkedAccountIntegrationMode]: #linkedaccountintegrationmode #### [linkedAccountIntegrationMode] The linked account integration mode -Type: **string** +Type: **string** + @@ -285,7 +311,8 @@ The linked account integration mode [localeId]: #localeid #### [localeId] A portal user's associated [SoftLayer_Locale]({{}}) id. -Type: **integer** +Type: **integer** + @@ -295,7 +322,8 @@ A portal user's associated [SoftLayer_Locale]({{Type: **boolean** +Type: **boolean** + @@ -305,7 +333,8 @@ Determines if this portal user is managed by SAML federation. [managedByOpenIdConnectFlag]: #managedbyopenidconnectflag #### [managedByOpenIdConnectFlag] Determines if this portal user is managed by IBMid federation. -Type: **boolean** +Type: **boolean** + @@ -315,7 +344,8 @@ Determines if this portal user is managed by IBMid federation. [minimumPasswordLifeHours]: #minimumpasswordlifehours #### [minimumPasswordLifeHours] The minimum number of hours that must pass between password resets. -Type: **integer** +Type: **integer** + @@ -325,7 +355,8 @@ The minimum number of hours that must pass between password resets. [modifyDate]: #modifydate #### [modifyDate] The date a portal user's record was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -335,7 +366,8 @@ The date a portal user's record was last modified. [msn]: #msn #### [msn] A portal user's MSN address. -Type: **string** +Type: **string** + @@ -345,7 +377,8 @@ A portal user's MSN address. [nameId]: #nameid #### [nameId] -Type: **string** +Type: **string** + @@ -355,7 +388,8 @@ A portal user's MSN address. [officePhone]: #officephone #### [officePhone] A portal user's office phone number. -Type: **string** +Type: **string** + @@ -365,7 +399,8 @@ A portal user's office phone number. [openIdConnectUserName]: #openidconnectusername #### [openIdConnectUserName] The BlueID username associated to with this user, if the account is managed by OpenIDConnect / BlueID federation -Type: **string** +Type: **string** + @@ -375,7 +410,8 @@ The BlueID username associated to with this user, if the account is managed by O [parentId]: #parentid #### [parentId] A portal user's parent user. Id a users parentId is ''null'' then it doesn't have a parent user in the customer portal. -Type: **integer** +Type: **integer** + @@ -385,7 +421,8 @@ A portal user's parent user. Id a users parentId is ''null'' then it doesn't hav [passwordExpireDate]: #passwordexpiredate #### [passwordExpireDate] The expiration date for the user's password -Type: **dateTime** +Type: **dateTime** + @@ -395,7 +432,8 @@ The expiration date for the user's password [postalCode]: #postalcode #### [postalCode] The postal code of the mailing address belonging to an portal user. -Type: **string** +Type: **string** + @@ -405,7 +443,8 @@ The postal code of the mailing address belonging to an portal user. [pptpVpnAllowedFlag]: #pptpvpnallowedflag #### [pptpVpnAllowedFlag] Whether a portal user may connect to the SoftLayer private network via PPTP VPN or not. -Type: **boolean** +Type: **boolean** + @@ -415,7 +454,8 @@ Whether a portal user may connect to the SoftLayer private network via PPTP VPN [preventPreviousPasswords]: #preventpreviouspasswords #### [preventPreviousPasswords] -Type: **integer** +Type: **integer** + @@ -425,7 +465,8 @@ Whether a portal user may connect to the SoftLayer private network via PPTP VPN [savedId]: #savedid #### [savedId] -Type: **string** +Type: **string** + @@ -435,7 +476,8 @@ Whether a portal user may connect to the SoftLayer private network via PPTP VPN [secondaryLoginManagementFlag]: #secondaryloginmanagementflag #### [secondaryLoginManagementFlag] Whether a user may change their security options (IP restriction, password expiration, or enforce security questions on login) which were pre-selected by their account's master user. -Type: **boolean** +Type: **boolean** + @@ -445,7 +487,8 @@ Whether a user may change their security options (IP restriction, password expir [secondaryLoginRequiredFlag]: #secondaryloginrequiredflag #### [secondaryLoginRequiredFlag] Whether a user is required to answer a security question when logging into the SoftLayer customer portal. -Type: **boolean** +Type: **boolean** + @@ -455,7 +498,8 @@ Whether a user is required to answer a security question when logging into the S [secondaryPasswordModifyDate]: #secondarypasswordmodifydate #### [secondaryPasswordModifyDate] The date when a user's password was last updated. -Type: **dateTime** +Type: **dateTime** + @@ -465,7 +509,8 @@ The date when a user's password was last updated. [secondaryPasswordTimeoutDays]: #secondarypasswordtimeoutdays #### [secondaryPasswordTimeoutDays] The number of days for which a user's password is active. -Type: **integer** +Type: **integer** + @@ -475,7 +520,8 @@ The number of days for which a user's password is active. [sms]: #sms #### [sms] A phone number that can receive SMS text messages for this portal user. -Type: **string** +Type: **string** + @@ -485,7 +531,8 @@ A phone number that can receive SMS text messages for this portal user. [sslVpnAllowedFlag]: #sslvpnallowedflag #### [sslVpnAllowedFlag] Whether a portal user may connect to the SoftLayer private network via SSL VPN or not. -Type: **boolean** +Type: **boolean** + @@ -495,7 +542,8 @@ Whether a portal user may connect to the SoftLayer private network via SSL VPN o [state]: #state #### [state] A two-letter abbreviation of the state in the mailing address belonging to a portal user. If a user does not reside in a province then this is typically blank. -Type: **string** +Type: **string** + @@ -505,7 +553,8 @@ A two-letter abbreviation of the state in the mailing address belonging to a por [statusDate]: #statusdate #### [statusDate] The date a portal users record's last status change. -Type: **dateTime** +Type: **dateTime** + @@ -515,7 +564,8 @@ The date a portal users record's last status change. [timezoneId]: #timezoneid #### [timezoneId] A portal user's time zone. -Type: **integer** +Type: **integer** + @@ -525,7 +575,8 @@ A portal user's time zone. [userStatusId]: #userstatusid #### [userStatusId] A number reflecting the state of a portal user. -Type: **integer** +Type: **integer** + @@ -535,7 +586,8 @@ A number reflecting the state of a portal user. [username]: #username #### [username] A portal user's username. -Type: **string** +Type: **string** + @@ -545,7 +597,8 @@ A portal user's username. [verificationCode]: #verificationcode #### [verificationCode] The verification code from Bluemix BSS to save in the invitation -Type: **string** +Type: **string** + @@ -555,7 +608,8 @@ The verification code from Bluemix BSS to save in the invitation [vpnManualConfig]: #vpnmanualconfig #### [vpnManualConfig] Whether a portal user vpn subnets have been manual configured. -Type: **boolean** +Type: **boolean** + @@ -565,7 +619,8 @@ Whether a portal user vpn subnets have been manual configured. [yahoo]: #yahoo #### [yahoo] A portal user's Yahoo! Chat name. -Type: **string** +Type: **string** + @@ -581,7 +636,8 @@ A portal user's Yahoo! Chat name. [account]: #account #### [account] The customer account that a user belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -591,7 +647,8 @@ The customer account that a user belongs to. [actions]: #actions #### [actions] -Type: **SoftLayer_User_Permission_Action[] ** +Type: **SoftLayer_User_Permission_Action[] ** + @@ -601,7 +658,8 @@ The customer account that a user belongs to. [additionalEmails]: #additionalemails #### [additionalEmails] A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets. -Type: **SoftLayer_User_Customer_AdditionalEmail[] ** +Type: **SoftLayer_User_Customer_AdditionalEmail[] ** + @@ -611,7 +669,8 @@ A portal user's additional email addresses. These email addresses are contacted [apiAuthenticationKeys]: #apiauthenticationkeys #### [apiAuthenticationKeys] A portal user's API Authentication keys. There is a max limit of one API key per user. -Type: **SoftLayer_User_Customer_ApiAuthentication[] ** +Type: **SoftLayer_User_Customer_ApiAuthentication[] ** + @@ -621,7 +680,8 @@ A portal user's API Authentication keys. There is a max limit of one API key per [childUsers]: #childusers #### [childUsers] A portal user's child users. Some portal users may not have child users. -Type: **SoftLayer_User_Customer[] ** +Type: **SoftLayer_User_Customer[] ** + @@ -631,7 +691,8 @@ A portal user's child users. Some portal users may not have child users. [closedTickets]: #closedtickets #### [closedTickets] An user's associated closed tickets. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -641,7 +702,8 @@ An user's associated closed tickets. [dedicatedHosts]: #dedicatedhosts #### [dedicatedHosts] The dedicated hosts to which the user has been granted access. -Type: **SoftLayer_Virtual_DedicatedHost[] ** +Type: **SoftLayer_Virtual_DedicatedHost[] ** + @@ -651,7 +713,8 @@ The dedicated hosts to which the user has been granted access. [externalBindings]: #externalbindings #### [externalBindings] The external authentication bindings that link an external identifier to a SoftLayer user. -Type: **SoftLayer_User_External_Binding[] ** +Type: **SoftLayer_User_External_Binding[] ** + @@ -661,7 +724,8 @@ The external authentication bindings that link an external identifier to a SoftL [hardware]: #hardware #### [hardware] A portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -671,7 +735,8 @@ A portal user's accessible hardware. These permissions control which hardware a [hardwareNotifications]: #hardwarenotifications #### [hardwareNotifications] Hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'. -Type: **SoftLayer_User_Customer_Notification_Hardware[] ** +Type: **SoftLayer_User_Customer_Notification_Hardware[] ** + @@ -681,7 +746,8 @@ Hardware notifications associated with this user. A hardware notification links [hasAcknowledgedSupportPolicyFlag]: #hasacknowledgedsupportpolicyflag #### [hasAcknowledgedSupportPolicyFlag] Whether or not a user has acknowledged the support policy. -Type: **boolean** +Type: **boolean** + @@ -691,7 +757,8 @@ Whether or not a user has acknowledged the support policy. [hasFullDedicatedHostAccessFlag]: #hasfulldedicatedhostaccessflag #### [hasFullDedicatedHostAccessFlag] Permission granting the user access to all Dedicated Host devices on the account. -Type: **boolean** +Type: **boolean** + @@ -701,7 +768,8 @@ Permission granting the user access to all Dedicated Host devices on the account [hasFullHardwareAccessFlag]: #hasfullhardwareaccessflag #### [hasFullHardwareAccessFlag] Whether or not a portal user has access to all hardware on their account. -Type: **boolean** +Type: **boolean** + @@ -711,7 +779,8 @@ Whether or not a portal user has access to all hardware on their account. [hasFullVirtualGuestAccessFlag]: #hasfullvirtualguestaccessflag #### [hasFullVirtualGuestAccessFlag] Whether or not a portal user has access to all virtual guests on their account. -Type: **boolean** +Type: **boolean** + @@ -721,7 +790,8 @@ Whether or not a portal user has access to all virtual guests on their account. [ibmIdLink]: #ibmidlink #### [ibmIdLink] Specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link. -Type: **SoftLayer_User_Customer_Link ** +Type: **SoftLayer_User_Customer_Link ** + @@ -731,7 +801,8 @@ Specifically relating the Customer instance to an IBMid. A Customer instance may [layoutProfiles]: #layoutprofiles #### [layoutProfiles] Contains the definition of the layout profile. -Type: **SoftLayer_Layout_Profile[] ** +Type: **SoftLayer_Layout_Profile[] ** + @@ -741,7 +812,8 @@ Contains the definition of the layout profile. [locale]: #locale #### [locale] A user's locale. Locale holds user's language and region information. -Type: **SoftLayer_Locale ** +Type: **SoftLayer_Locale ** + @@ -751,7 +823,8 @@ A user's locale. Locale holds user's language and region information. [loginAttempts]: #loginattempts #### [loginAttempts] A user's attempts to log into the SoftLayer customer portal. -Type: **SoftLayer_User_Customer_Access_Authentication[] ** +Type: **SoftLayer_User_Customer_Access_Authentication[] ** + @@ -761,7 +834,8 @@ A user's attempts to log into the SoftLayer customer portal. [mobileDevices]: #mobiledevices #### [mobileDevices] A portal user's associated mobile device profiles. -Type: **SoftLayer_User_Customer_MobileDevice[] ** +Type: **SoftLayer_User_Customer_MobileDevice[] ** + @@ -771,7 +845,8 @@ A portal user's associated mobile device profiles. [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] Notification subscription records for the user. -Type: **SoftLayer_Notification_Subscriber[] ** +Type: **SoftLayer_Notification_Subscriber[] ** + @@ -781,7 +856,8 @@ Notification subscription records for the user. [openTickets]: #opentickets #### [openTickets] An user's associated open tickets. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -791,7 +867,8 @@ An user's associated open tickets. [overrides]: #overrides #### [overrides] A portal user's vpn accessible subnets. -Type: **SoftLayer_Network_Service_Vpn_Overrides[] ** +Type: **SoftLayer_Network_Service_Vpn_Overrides[] ** + @@ -801,7 +878,8 @@ A portal user's vpn accessible subnets. [parent]: #parent #### [parent] A portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -811,7 +889,8 @@ A portal user's parent user. If a SoftLayer_User_Customer has a null parentId pr [permissions]: #permissions #### [permissions] A portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API. -Type: **SoftLayer_User_Customer_CustomerPermission_Permission[] ** +Type: **SoftLayer_User_Customer_CustomerPermission_Permission[] ** + @@ -821,7 +900,8 @@ A portal user's permissions. These permissions control that user's access to fun [preferences]: #preferences #### [preferences] Data type contains a single user preference to a specific preference type. -Type: **SoftLayer_User_Preference[] ** +Type: **SoftLayer_User_Preference[] ** + @@ -831,7 +911,8 @@ Data type contains a single user preference to a specific preference type. [roles]: #roles #### [roles] -Type: **SoftLayer_User_Permission_Role[] ** +Type: **SoftLayer_User_Permission_Role[] ** + @@ -841,7 +922,8 @@ Data type contains a single user preference to a specific preference type. [salesforceUserLink]: #salesforceuserlink #### [salesforceUserLink] [DEPRECATED] -Type: **SoftLayer_User_Customer_Link ** +Type: **SoftLayer_User_Customer_Link ** + @@ -851,7 +933,8 @@ Data type contains a single user preference to a specific preference type. [securityAnswers]: #securityanswers #### [securityAnswers] A portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login. -Type: **SoftLayer_User_Customer_Security_Answer[] ** +Type: **SoftLayer_User_Customer_Security_Answer[] ** + @@ -861,7 +944,8 @@ A portal user's security question answers. Some portal users may not have securi [subscribers]: #subscribers #### [subscribers] A user's notification subscription records. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -871,7 +955,8 @@ A user's notification subscription records. [successfulLogins]: #successfullogins #### [successfulLogins] A user's successful attempts to log into the SoftLayer customer portal. -Type: **SoftLayer_User_Customer_Access_Authentication[] ** +Type: **SoftLayer_User_Customer_Access_Authentication[] ** + @@ -881,7 +966,8 @@ A user's successful attempts to log into the SoftLayer customer portal. [supportPolicyAcknowledgementRequiredFlag]: #supportpolicyacknowledgementrequiredflag #### [supportPolicyAcknowledgementRequiredFlag] Whether or not a user is required to acknowledge the support policy for portal access. -Type: **integer** +Type: **integer** + @@ -891,7 +977,8 @@ Whether or not a user is required to acknowledge the support policy for portal a [surveyRequiredFlag]: #surveyrequiredflag #### [surveyRequiredFlag] Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal. -Type: **boolean** +Type: **boolean** + @@ -901,7 +988,8 @@ Whether or not a user must take a brief survey the next time they log into the S [surveys]: #surveys #### [surveys] The surveys that a user has taken in the SoftLayer customer portal. -Type: **SoftLayer_Survey[] ** +Type: **SoftLayer_Survey[] ** + @@ -911,7 +999,8 @@ The surveys that a user has taken in the SoftLayer customer portal. [tickets]: #tickets #### [tickets] An user's associated tickets. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -921,7 +1010,8 @@ An user's associated tickets. [timezone]: #timezone #### [timezone] A portal user's time zone. -Type: **SoftLayer_Locale_Timezone ** +Type: **SoftLayer_Locale_Timezone ** + @@ -931,7 +1021,8 @@ A portal user's time zone. [unsuccessfulLogins]: #unsuccessfullogins #### [unsuccessfulLogins] A user's unsuccessful attempts to log into the SoftLayer customer portal. -Type: **SoftLayer_User_Customer_Access_Authentication[] ** +Type: **SoftLayer_User_Customer_Access_Authentication[] ** + @@ -941,7 +1032,8 @@ A user's unsuccessful attempts to log into the SoftLayer customer portal. [userLinks]: #userlinks #### [userLinks] User customer link with IBMid and IAMid. -Type: **SoftLayer_User_Customer_Link[] ** +Type: **SoftLayer_User_Customer_Link[] ** + @@ -951,7 +1043,8 @@ User customer link with IBMid and IAMid. [userStatus]: #userstatus #### [userStatus] A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network. -Type: **SoftLayer_User_Customer_Status ** +Type: **SoftLayer_User_Customer_Status ** + @@ -961,7 +1054,8 @@ A portal user's status, which controls overall access to the SoftLayer customer [virtualGuests]: #virtualguests #### [virtualGuests] A portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -973,7 +1067,8 @@ A portal user's accessible CloudLayer Computing Instances. These permissions con [actionCount]: #actioncount #### [actionCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of [additionalEmailCount]: #additionalemailcount #### [additionalEmailCount] A count of a portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a portal user's additional email addresses. These email addresses are [apiAuthenticationKeyCount]: #apiauthenticationkeycount #### [apiAuthenticationKeyCount] A count of a portal user's API Authentication keys. There is a max limit of one API key per user. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a portal user's API Authentication keys. There is a max limit of one [childUserCount]: #childusercount #### [childUserCount] A count of a portal user's child users. Some portal users may not have child users. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a portal user's child users. Some portal users may not have child use [closedTicketCount]: #closedticketcount #### [closedTicketCount] A count of an user's associated closed tickets. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of an user's associated closed tickets. [dedicatedHostCount]: #dedicatedhostcount #### [dedicatedHostCount] A count of the dedicated hosts to which the user has been granted access. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of the dedicated hosts to which the user has been granted access. [externalBindingCount]: #externalbindingcount #### [externalBindingCount] A count of the external authentication bindings that link an external identifier to a SoftLayer user. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of the external authentication bindings that link an external identifier [hardwareCount]: #hardwarecount #### [hardwareCount] A count of a portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a portal user's accessible hardware. These permissions control which [hardwareNotificationCount]: #hardwarenotificationcount #### [hardwareNotificationCount] A count of hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of hardware notifications associated with this user. A hardware notifica [layoutProfileCount]: #layoutprofilecount #### [layoutProfileCount] A count of contains the definition of the layout profile. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of contains the definition of the layout profile. [loginAttemptCount]: #loginattemptcount #### [loginAttemptCount] A count of a user's attempts to log into the SoftLayer customer portal. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1188,8 @@ A count of a user's attempts to log into the SoftLayer customer portal. [mobileDeviceCount]: #mobiledevicecount #### [mobileDeviceCount] A count of a portal user's associated mobile device profiles. -Type: **unsigned long** +Type: **unsigned long** + @@ -1093,7 +1199,8 @@ A count of a portal user's associated mobile device profiles. [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of notification subscription records for the user. -Type: **unsigned long** +Type: **unsigned long** + @@ -1103,7 +1210,8 @@ A count of notification subscription records for the user. [openTicketCount]: #openticketcount #### [openTicketCount] A count of an user's associated open tickets. -Type: **unsigned long** +Type: **unsigned long** + @@ -1113,7 +1221,8 @@ A count of an user's associated open tickets. [overrideCount]: #overridecount #### [overrideCount] A count of a portal user's vpn accessible subnets. -Type: **unsigned long** +Type: **unsigned long** + @@ -1123,7 +1232,8 @@ A count of a portal user's vpn accessible subnets. [permissionCount]: #permissioncount #### [permissionCount] A count of a portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API. -Type: **unsigned long** +Type: **unsigned long** + @@ -1133,7 +1243,8 @@ A count of a portal user's permissions. These permissions control that user's ac [preferenceCount]: #preferencecount #### [preferenceCount] A count of data type contains a single user preference to a specific preference type. -Type: **unsigned long** +Type: **unsigned long** + @@ -1143,7 +1254,8 @@ A count of data type contains a single user preference to a specific preference [roleCount]: #rolecount #### [roleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1153,7 +1265,8 @@ A count of [securityAnswerCount]: #securityanswercount #### [securityAnswerCount] A count of a portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login. -Type: **unsigned long** +Type: **unsigned long** + @@ -1163,7 +1276,8 @@ A count of a portal user's security question answers. Some portal users may not [subscriberCount]: #subscribercount #### [subscriberCount] A count of a user's notification subscription records. -Type: **unsigned long** +Type: **unsigned long** + @@ -1173,7 +1287,8 @@ A count of a user's notification subscription records. [successfulLoginCount]: #successfullogincount #### [successfulLoginCount] A count of a user's successful attempts to log into the SoftLayer customer portal. -Type: **unsigned long** +Type: **unsigned long** + @@ -1183,7 +1298,8 @@ A count of a user's successful attempts to log into the SoftLayer customer porta [surveyCount]: #surveycount #### [surveyCount] A count of the surveys that a user has taken in the SoftLayer customer portal. -Type: **unsigned long** +Type: **unsigned long** + @@ -1193,7 +1309,8 @@ A count of the surveys that a user has taken in the SoftLayer customer portal. [ticketCount]: #ticketcount #### [ticketCount] A count of an user's associated tickets. -Type: **unsigned long** +Type: **unsigned long** + @@ -1203,7 +1320,8 @@ A count of an user's associated tickets. [unsuccessfulLoginCount]: #unsuccessfullogincount #### [unsuccessfulLoginCount] A count of a user's unsuccessful attempts to log into the SoftLayer customer portal. -Type: **unsigned long** +Type: **unsigned long** + @@ -1213,7 +1331,8 @@ A count of a user's unsuccessful attempts to log into the SoftLayer customer por [userLinkCount]: #userlinkcount #### [userLinkCount] A count of user customer link with IBMid and IAMid. -Type: **unsigned long** +Type: **unsigned long** + @@ -1223,7 +1342,8 @@ A count of user customer link with IBMid and IAMid. [virtualGuestCount]: #virtualguestcount #### [virtualGuestCount] A count of a portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/_index.md index b82c23abc5..06506e856f 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] A portal user's associated [SoftLayer_Account]({{}}) id. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ A portal user's associated [SoftLayer_Account]({{Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ The first line of the mailing address belonging to a portal user. [address2]: #address2 #### [address2] The second line of the mailing address belonging to a portal user. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The second line of the mailing address belonging to a portal user. [aim]: #aim #### [aim] A portal user's AOL Instant Messenger screen name. -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ A portal user's AOL Instant Messenger screen name. [alternatePhone]: #alternatephone #### [alternatePhone] A portal user's secondary phone number. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ A portal user's secondary phone number. [authenticationToken]: #authenticationtoken #### [authenticationToken] The authentication token used for logging into the SoftLayer customer portal. -Type: **SoftLayer_Container_User_Authentication_Token ** +Type: **SoftLayer_Container_User_Authentication_Token ** + @@ -105,7 +113,8 @@ The authentication token used for logging into the SoftLayer customer portal. [city]: #city #### [city] The city of the mailing address belonging to a portal user. -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ The city of the mailing address belonging to a portal user. [companyName]: #companyname #### [companyName] A portal user's associated company. This may not be the same company as the customer that owns this portal user. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A portal user's associated company. This may not be the same company as the cust [country]: #country #### [country] A two-letter abbreviation of the country in the mailing address belonging to a portal user. -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ A two-letter abbreviation of the country in the mailing address belonging to a p [createDate]: #createdate #### [createDate] The date a portal user's record was created. -Type: **dateTime** +Type: **dateTime** + @@ -145,7 +157,8 @@ The date a portal user's record was created. [daylightSavingsTimeFlag]: #daylightsavingstimeflag #### [daylightSavingsTimeFlag] Whether a portal user's time zone is affected by Daylight Savings Time. -Type: **boolean** +Type: **boolean** + @@ -155,7 +168,8 @@ Whether a portal user's time zone is affected by Daylight Savings Time. [denyAllResourceAccessOnCreateFlag]: #denyallresourceaccessoncreateflag #### [denyAllResourceAccessOnCreateFlag] Flag used to deny access to all hardware and cloud computing instances upon user creation. -Type: **boolean** +Type: **boolean** + @@ -165,7 +179,8 @@ Flag used to deny access to all hardware and cloud computing instances upon user [displayName]: #displayname #### [displayName] -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ Flag used to deny access to all hardware and cloud computing instances upon user [email]: #email #### [email] A portal user's email address. -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ A portal user's email address. [firstName]: #firstname #### [firstName] A portal user's first name. -Type: **string** +Type: **string** + @@ -195,7 +212,8 @@ A portal user's first name. [forumPasswordHash]: #forumpasswordhash #### [forumPasswordHash] A user's password for the SoftLayer forums, hashed for auto-login capability from the SoftLayer customer portal -Type: **string** +Type: **string** + @@ -205,7 +223,8 @@ A user's password for the SoftLayer forums, hashed for auto-login capability fro [iamAuthorizationStatus]: #iamauthorizationstatus #### [iamAuthorizationStatus] -Type: **integer** +Type: **integer** + @@ -215,7 +234,8 @@ A user's password for the SoftLayer forums, hashed for auto-login capability fro [iamId]: #iamid #### [iamId] The IAMid (realm-identifier) of the user being created by PaaS -Type: **string** +Type: **string** + @@ -225,7 +245,8 @@ The IAMid (realm-identifier) of the user being created by PaaS [icq]: #icq #### [icq] A portal user's ICQ UIN. -Type: **string** +Type: **string** + @@ -235,7 +256,8 @@ A portal user's ICQ UIN. [id]: #id #### [id] A portal user's internal identifying number. -Type: **integer** +Type: **integer** + @@ -245,7 +267,8 @@ A portal user's internal identifying number. [ipAddressRestriction]: #ipaddressrestriction #### [ipAddressRestriction] The IP addresses or IP ranges from which a user may login to the SoftLayer customer portal. Specify subnets in CIDR format and separate multiple addresses and subnets by commas. You may combine IPv4 and IPv6 addresses and subnets, for example: 192.168.0.0/16,fe80:021b::0/64. -Type: **string** +Type: **string** + @@ -255,7 +278,8 @@ The IP addresses or IP ranges from which a user may login to the SoftLayer custo [isMasterUserFlag]: #ismasteruserflag #### [isMasterUserFlag] -Type: **boolean** +Type: **boolean** + @@ -265,7 +289,8 @@ The IP addresses or IP ranges from which a user may login to the SoftLayer custo [lastName]: #lastname #### [lastName] A portal user's last name. -Type: **string** +Type: **string** + @@ -275,7 +300,8 @@ A portal user's last name. [linkedAccountIntegrationMode]: #linkedaccountintegrationmode #### [linkedAccountIntegrationMode] The linked account integration mode -Type: **string** +Type: **string** + @@ -285,7 +311,8 @@ The linked account integration mode [localeId]: #localeid #### [localeId] A portal user's associated [SoftLayer_Locale]({{}}) id. -Type: **integer** +Type: **integer** + @@ -295,7 +322,8 @@ A portal user's associated [SoftLayer_Locale]({{Type: **boolean** +Type: **boolean** + @@ -305,7 +333,8 @@ Determines if this portal user is managed by SAML federation. [managedByOpenIdConnectFlag]: #managedbyopenidconnectflag #### [managedByOpenIdConnectFlag] Determines if this portal user is managed by IBMid federation. -Type: **boolean** +Type: **boolean** + @@ -315,7 +344,8 @@ Determines if this portal user is managed by IBMid federation. [minimumPasswordLifeHours]: #minimumpasswordlifehours #### [minimumPasswordLifeHours] The minimum number of hours that must pass between password resets. -Type: **integer** +Type: **integer** + @@ -325,7 +355,8 @@ The minimum number of hours that must pass between password resets. [modifyDate]: #modifydate #### [modifyDate] The date a portal user's record was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -335,7 +366,8 @@ The date a portal user's record was last modified. [msn]: #msn #### [msn] A portal user's MSN address. -Type: **string** +Type: **string** + @@ -345,7 +377,8 @@ A portal user's MSN address. [nameId]: #nameid #### [nameId] -Type: **string** +Type: **string** + @@ -355,7 +388,8 @@ A portal user's MSN address. [officePhone]: #officephone #### [officePhone] A portal user's office phone number. -Type: **string** +Type: **string** + @@ -365,7 +399,8 @@ A portal user's office phone number. [openIdConnectUserName]: #openidconnectusername #### [openIdConnectUserName] The BlueID username associated to with this user, if the account is managed by OpenIDConnect / BlueID federation -Type: **string** +Type: **string** + @@ -375,7 +410,8 @@ The BlueID username associated to with this user, if the account is managed by O [parentId]: #parentid #### [parentId] A portal user's parent user. Id a users parentId is ''null'' then it doesn't have a parent user in the customer portal. -Type: **integer** +Type: **integer** + @@ -385,7 +421,8 @@ A portal user's parent user. Id a users parentId is ''null'' then it doesn't hav [passwordExpireDate]: #passwordexpiredate #### [passwordExpireDate] The expiration date for the user's password -Type: **dateTime** +Type: **dateTime** + @@ -395,7 +432,8 @@ The expiration date for the user's password [postalCode]: #postalcode #### [postalCode] The postal code of the mailing address belonging to an portal user. -Type: **string** +Type: **string** + @@ -405,7 +443,8 @@ The postal code of the mailing address belonging to an portal user. [pptpVpnAllowedFlag]: #pptpvpnallowedflag #### [pptpVpnAllowedFlag] Whether a portal user may connect to the SoftLayer private network via PPTP VPN or not. -Type: **boolean** +Type: **boolean** + @@ -415,7 +454,8 @@ Whether a portal user may connect to the SoftLayer private network via PPTP VPN [preventPreviousPasswords]: #preventpreviouspasswords #### [preventPreviousPasswords] -Type: **integer** +Type: **integer** + @@ -425,7 +465,8 @@ Whether a portal user may connect to the SoftLayer private network via PPTP VPN [savedId]: #savedid #### [savedId] -Type: **string** +Type: **string** + @@ -435,7 +476,8 @@ Whether a portal user may connect to the SoftLayer private network via PPTP VPN [secondaryLoginManagementFlag]: #secondaryloginmanagementflag #### [secondaryLoginManagementFlag] Whether a user may change their security options (IP restriction, password expiration, or enforce security questions on login) which were pre-selected by their account's master user. -Type: **boolean** +Type: **boolean** + @@ -445,7 +487,8 @@ Whether a user may change their security options (IP restriction, password expir [secondaryLoginRequiredFlag]: #secondaryloginrequiredflag #### [secondaryLoginRequiredFlag] Whether a user is required to answer a security question when logging into the SoftLayer customer portal. -Type: **boolean** +Type: **boolean** + @@ -455,7 +498,8 @@ Whether a user is required to answer a security question when logging into the S [secondaryPasswordModifyDate]: #secondarypasswordmodifydate #### [secondaryPasswordModifyDate] The date when a user's password was last updated. -Type: **dateTime** +Type: **dateTime** + @@ -465,7 +509,8 @@ The date when a user's password was last updated. [secondaryPasswordTimeoutDays]: #secondarypasswordtimeoutdays #### [secondaryPasswordTimeoutDays] The number of days for which a user's password is active. -Type: **integer** +Type: **integer** + @@ -475,7 +520,8 @@ The number of days for which a user's password is active. [sms]: #sms #### [sms] A phone number that can receive SMS text messages for this portal user. -Type: **string** +Type: **string** + @@ -485,7 +531,8 @@ A phone number that can receive SMS text messages for this portal user. [sslVpnAllowedFlag]: #sslvpnallowedflag #### [sslVpnAllowedFlag] Whether a portal user may connect to the SoftLayer private network via SSL VPN or not. -Type: **boolean** +Type: **boolean** + @@ -495,7 +542,8 @@ Whether a portal user may connect to the SoftLayer private network via SSL VPN o [state]: #state #### [state] A two-letter abbreviation of the state in the mailing address belonging to a portal user. If a user does not reside in a province then this is typically blank. -Type: **string** +Type: **string** + @@ -505,7 +553,8 @@ A two-letter abbreviation of the state in the mailing address belonging to a por [statusDate]: #statusdate #### [statusDate] The date a portal users record's last status change. -Type: **dateTime** +Type: **dateTime** + @@ -515,7 +564,8 @@ The date a portal users record's last status change. [timezoneId]: #timezoneid #### [timezoneId] A portal user's time zone. -Type: **integer** +Type: **integer** + @@ -525,7 +575,8 @@ A portal user's time zone. [userStatusId]: #userstatusid #### [userStatusId] A number reflecting the state of a portal user. -Type: **integer** +Type: **integer** + @@ -535,7 +586,8 @@ A number reflecting the state of a portal user. [username]: #username #### [username] A portal user's username. -Type: **string** +Type: **string** + @@ -545,7 +597,8 @@ A portal user's username. [verificationCode]: #verificationcode #### [verificationCode] The verification code from Bluemix BSS to save in the invitation -Type: **string** +Type: **string** + @@ -555,7 +608,8 @@ The verification code from Bluemix BSS to save in the invitation [vpnManualConfig]: #vpnmanualconfig #### [vpnManualConfig] Whether a portal user vpn subnets have been manual configured. -Type: **boolean** +Type: **boolean** + @@ -565,7 +619,8 @@ Whether a portal user vpn subnets have been manual configured. [yahoo]: #yahoo #### [yahoo] A portal user's Yahoo! Chat name. -Type: **string** +Type: **string** + @@ -581,7 +636,8 @@ A portal user's Yahoo! Chat name. [account]: #account #### [account] The customer account that a user belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -591,7 +647,8 @@ The customer account that a user belongs to. [actions]: #actions #### [actions] -Type: **SoftLayer_User_Permission_Action[] ** +Type: **SoftLayer_User_Permission_Action[] ** + @@ -601,7 +658,8 @@ The customer account that a user belongs to. [additionalEmails]: #additionalemails #### [additionalEmails] A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets. -Type: **SoftLayer_User_Customer_AdditionalEmail[] ** +Type: **SoftLayer_User_Customer_AdditionalEmail[] ** + @@ -611,7 +669,8 @@ A portal user's additional email addresses. These email addresses are contacted [apiAuthenticationKeys]: #apiauthenticationkeys #### [apiAuthenticationKeys] A portal user's API Authentication keys. There is a max limit of one API key per user. -Type: **SoftLayer_User_Customer_ApiAuthentication[] ** +Type: **SoftLayer_User_Customer_ApiAuthentication[] ** + @@ -621,7 +680,8 @@ A portal user's API Authentication keys. There is a max limit of one API key per [childUsers]: #childusers #### [childUsers] A portal user's child users. Some portal users may not have child users. -Type: **SoftLayer_User_Customer[] ** +Type: **SoftLayer_User_Customer[] ** + @@ -631,7 +691,8 @@ A portal user's child users. Some portal users may not have child users. [closedTickets]: #closedtickets #### [closedTickets] An user's associated closed tickets. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -641,7 +702,8 @@ An user's associated closed tickets. [dedicatedHosts]: #dedicatedhosts #### [dedicatedHosts] The dedicated hosts to which the user has been granted access. -Type: **SoftLayer_Virtual_DedicatedHost[] ** +Type: **SoftLayer_Virtual_DedicatedHost[] ** + @@ -651,7 +713,8 @@ The dedicated hosts to which the user has been granted access. [externalBindings]: #externalbindings #### [externalBindings] The external authentication bindings that link an external identifier to a SoftLayer user. -Type: **SoftLayer_User_External_Binding[] ** +Type: **SoftLayer_User_External_Binding[] ** + @@ -661,7 +724,8 @@ The external authentication bindings that link an external identifier to a SoftL [hardware]: #hardware #### [hardware] A portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -671,7 +735,8 @@ A portal user's accessible hardware. These permissions control which hardware a [hardwareNotifications]: #hardwarenotifications #### [hardwareNotifications] Hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'. -Type: **SoftLayer_User_Customer_Notification_Hardware[] ** +Type: **SoftLayer_User_Customer_Notification_Hardware[] ** + @@ -681,7 +746,8 @@ Hardware notifications associated with this user. A hardware notification links [hasAcknowledgedSupportPolicyFlag]: #hasacknowledgedsupportpolicyflag #### [hasAcknowledgedSupportPolicyFlag] Whether or not a user has acknowledged the support policy. -Type: **boolean** +Type: **boolean** + @@ -691,7 +757,8 @@ Whether or not a user has acknowledged the support policy. [hasFullDedicatedHostAccessFlag]: #hasfulldedicatedhostaccessflag #### [hasFullDedicatedHostAccessFlag] Permission granting the user access to all Dedicated Host devices on the account. -Type: **boolean** +Type: **boolean** + @@ -701,7 +768,8 @@ Permission granting the user access to all Dedicated Host devices on the account [hasFullHardwareAccessFlag]: #hasfullhardwareaccessflag #### [hasFullHardwareAccessFlag] Whether or not a portal user has access to all hardware on their account. -Type: **boolean** +Type: **boolean** + @@ -711,7 +779,8 @@ Whether or not a portal user has access to all hardware on their account. [hasFullVirtualGuestAccessFlag]: #hasfullvirtualguestaccessflag #### [hasFullVirtualGuestAccessFlag] Whether or not a portal user has access to all virtual guests on their account. -Type: **boolean** +Type: **boolean** + @@ -721,7 +790,8 @@ Whether or not a portal user has access to all virtual guests on their account. [ibmIdLink]: #ibmidlink #### [ibmIdLink] Specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link. -Type: **SoftLayer_User_Customer_Link ** +Type: **SoftLayer_User_Customer_Link ** + @@ -731,7 +801,8 @@ Specifically relating the Customer instance to an IBMid. A Customer instance may [layoutProfiles]: #layoutprofiles #### [layoutProfiles] Contains the definition of the layout profile. -Type: **SoftLayer_Layout_Profile[] ** +Type: **SoftLayer_Layout_Profile[] ** + @@ -741,7 +812,8 @@ Contains the definition of the layout profile. [locale]: #locale #### [locale] A user's locale. Locale holds user's language and region information. -Type: **SoftLayer_Locale ** +Type: **SoftLayer_Locale ** + @@ -751,7 +823,8 @@ A user's locale. Locale holds user's language and region information. [loginAttempts]: #loginattempts #### [loginAttempts] A user's attempts to log into the SoftLayer customer portal. -Type: **SoftLayer_User_Customer_Access_Authentication[] ** +Type: **SoftLayer_User_Customer_Access_Authentication[] ** + @@ -761,7 +834,8 @@ A user's attempts to log into the SoftLayer customer portal. [mobileDevices]: #mobiledevices #### [mobileDevices] A portal user's associated mobile device profiles. -Type: **SoftLayer_User_Customer_MobileDevice[] ** +Type: **SoftLayer_User_Customer_MobileDevice[] ** + @@ -771,7 +845,8 @@ A portal user's associated mobile device profiles. [notificationSubscribers]: #notificationsubscribers #### [notificationSubscribers] Notification subscription records for the user. -Type: **SoftLayer_Notification_Subscriber[] ** +Type: **SoftLayer_Notification_Subscriber[] ** + @@ -781,7 +856,8 @@ Notification subscription records for the user. [openTickets]: #opentickets #### [openTickets] An user's associated open tickets. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -791,7 +867,8 @@ An user's associated open tickets. [overrides]: #overrides #### [overrides] A portal user's vpn accessible subnets. -Type: **SoftLayer_Network_Service_Vpn_Overrides[] ** +Type: **SoftLayer_Network_Service_Vpn_Overrides[] ** + @@ -801,7 +878,8 @@ A portal user's vpn accessible subnets. [parent]: #parent #### [parent] A portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -811,7 +889,8 @@ A portal user's parent user. If a SoftLayer_User_Customer has a null parentId pr [permissions]: #permissions #### [permissions] A portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API. -Type: **SoftLayer_User_Customer_CustomerPermission_Permission[] ** +Type: **SoftLayer_User_Customer_CustomerPermission_Permission[] ** + @@ -821,7 +900,8 @@ A portal user's permissions. These permissions control that user's access to fun [preferences]: #preferences #### [preferences] Data type contains a single user preference to a specific preference type. -Type: **SoftLayer_User_Preference[] ** +Type: **SoftLayer_User_Preference[] ** + @@ -831,7 +911,8 @@ Data type contains a single user preference to a specific preference type. [roles]: #roles #### [roles] -Type: **SoftLayer_User_Permission_Role[] ** +Type: **SoftLayer_User_Permission_Role[] ** + @@ -841,7 +922,8 @@ Data type contains a single user preference to a specific preference type. [salesforceUserLink]: #salesforceuserlink #### [salesforceUserLink] [DEPRECATED] -Type: **SoftLayer_User_Customer_Link ** +Type: **SoftLayer_User_Customer_Link ** + @@ -851,7 +933,8 @@ Data type contains a single user preference to a specific preference type. [securityAnswers]: #securityanswers #### [securityAnswers] A portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login. -Type: **SoftLayer_User_Customer_Security_Answer[] ** +Type: **SoftLayer_User_Customer_Security_Answer[] ** + @@ -861,7 +944,8 @@ A portal user's security question answers. Some portal users may not have securi [subscribers]: #subscribers #### [subscribers] A user's notification subscription records. -Type: **SoftLayer_Notification_User_Subscriber[] ** +Type: **SoftLayer_Notification_User_Subscriber[] ** + @@ -871,7 +955,8 @@ A user's notification subscription records. [successfulLogins]: #successfullogins #### [successfulLogins] A user's successful attempts to log into the SoftLayer customer portal. -Type: **SoftLayer_User_Customer_Access_Authentication[] ** +Type: **SoftLayer_User_Customer_Access_Authentication[] ** + @@ -881,7 +966,8 @@ A user's successful attempts to log into the SoftLayer customer portal. [supportPolicyAcknowledgementRequiredFlag]: #supportpolicyacknowledgementrequiredflag #### [supportPolicyAcknowledgementRequiredFlag] Whether or not a user is required to acknowledge the support policy for portal access. -Type: **integer** +Type: **integer** + @@ -891,7 +977,8 @@ Whether or not a user is required to acknowledge the support policy for portal a [surveyRequiredFlag]: #surveyrequiredflag #### [surveyRequiredFlag] Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal. -Type: **boolean** +Type: **boolean** + @@ -901,7 +988,8 @@ Whether or not a user must take a brief survey the next time they log into the S [surveys]: #surveys #### [surveys] The surveys that a user has taken in the SoftLayer customer portal. -Type: **SoftLayer_Survey[] ** +Type: **SoftLayer_Survey[] ** + @@ -911,7 +999,8 @@ The surveys that a user has taken in the SoftLayer customer portal. [tickets]: #tickets #### [tickets] An user's associated tickets. -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -921,7 +1010,8 @@ An user's associated tickets. [timezone]: #timezone #### [timezone] A portal user's time zone. -Type: **SoftLayer_Locale_Timezone ** +Type: **SoftLayer_Locale_Timezone ** + @@ -931,7 +1021,8 @@ A portal user's time zone. [unsuccessfulLogins]: #unsuccessfullogins #### [unsuccessfulLogins] A user's unsuccessful attempts to log into the SoftLayer customer portal. -Type: **SoftLayer_User_Customer_Access_Authentication[] ** +Type: **SoftLayer_User_Customer_Access_Authentication[] ** + @@ -941,7 +1032,8 @@ A user's unsuccessful attempts to log into the SoftLayer customer portal. [userLinks]: #userlinks #### [userLinks] User customer link with IBMid and IAMid. -Type: **SoftLayer_User_Customer_Link[] ** +Type: **SoftLayer_User_Customer_Link[] ** + @@ -951,7 +1043,8 @@ User customer link with IBMid and IAMid. [userStatus]: #userstatus #### [userStatus] A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network. -Type: **SoftLayer_User_Customer_Status ** +Type: **SoftLayer_User_Customer_Status ** + @@ -961,7 +1054,8 @@ A portal user's status, which controls overall access to the SoftLayer customer [virtualGuests]: #virtualguests #### [virtualGuests] A portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -973,7 +1067,8 @@ A portal user's accessible CloudLayer Computing Instances. These permissions con [actionCount]: #actioncount #### [actionCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -983,7 +1078,8 @@ A count of [additionalEmailCount]: #additionalemailcount #### [additionalEmailCount] A count of a portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets. -Type: **unsigned long** +Type: **unsigned long** + @@ -993,7 +1089,8 @@ A count of a portal user's additional email addresses. These email addresses are [apiAuthenticationKeyCount]: #apiauthenticationkeycount #### [apiAuthenticationKeyCount] A count of a portal user's API Authentication keys. There is a max limit of one API key per user. -Type: **unsigned long** +Type: **unsigned long** + @@ -1003,7 +1100,8 @@ A count of a portal user's API Authentication keys. There is a max limit of one [childUserCount]: #childusercount #### [childUserCount] A count of a portal user's child users. Some portal users may not have child users. -Type: **unsigned long** +Type: **unsigned long** + @@ -1013,7 +1111,8 @@ A count of a portal user's child users. Some portal users may not have child use [closedTicketCount]: #closedticketcount #### [closedTicketCount] A count of an user's associated closed tickets. -Type: **unsigned long** +Type: **unsigned long** + @@ -1023,7 +1122,8 @@ A count of an user's associated closed tickets. [dedicatedHostCount]: #dedicatedhostcount #### [dedicatedHostCount] A count of the dedicated hosts to which the user has been granted access. -Type: **unsigned long** +Type: **unsigned long** + @@ -1033,7 +1133,8 @@ A count of the dedicated hosts to which the user has been granted access. [externalBindingCount]: #externalbindingcount #### [externalBindingCount] A count of the external authentication bindings that link an external identifier to a SoftLayer user. -Type: **unsigned long** +Type: **unsigned long** + @@ -1043,7 +1144,8 @@ A count of the external authentication bindings that link an external identifier [hardwareCount]: #hardwarecount #### [hardwareCount] A count of a portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal. -Type: **unsigned long** +Type: **unsigned long** + @@ -1053,7 +1155,8 @@ A count of a portal user's accessible hardware. These permissions control which [hardwareNotificationCount]: #hardwarenotificationcount #### [hardwareNotificationCount] A count of hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'. -Type: **unsigned long** +Type: **unsigned long** + @@ -1063,7 +1166,8 @@ A count of hardware notifications associated with this user. A hardware notifica [layoutProfileCount]: #layoutprofilecount #### [layoutProfileCount] A count of contains the definition of the layout profile. -Type: **unsigned long** +Type: **unsigned long** + @@ -1073,7 +1177,8 @@ A count of contains the definition of the layout profile. [loginAttemptCount]: #loginattemptcount #### [loginAttemptCount] A count of a user's attempts to log into the SoftLayer customer portal. -Type: **unsigned long** +Type: **unsigned long** + @@ -1083,7 +1188,8 @@ A count of a user's attempts to log into the SoftLayer customer portal. [mobileDeviceCount]: #mobiledevicecount #### [mobileDeviceCount] A count of a portal user's associated mobile device profiles. -Type: **unsigned long** +Type: **unsigned long** + @@ -1093,7 +1199,8 @@ A count of a portal user's associated mobile device profiles. [notificationSubscriberCount]: #notificationsubscribercount #### [notificationSubscriberCount] A count of notification subscription records for the user. -Type: **unsigned long** +Type: **unsigned long** + @@ -1103,7 +1210,8 @@ A count of notification subscription records for the user. [openTicketCount]: #openticketcount #### [openTicketCount] A count of an user's associated open tickets. -Type: **unsigned long** +Type: **unsigned long** + @@ -1113,7 +1221,8 @@ A count of an user's associated open tickets. [overrideCount]: #overridecount #### [overrideCount] A count of a portal user's vpn accessible subnets. -Type: **unsigned long** +Type: **unsigned long** + @@ -1123,7 +1232,8 @@ A count of a portal user's vpn accessible subnets. [permissionCount]: #permissioncount #### [permissionCount] A count of a portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API. -Type: **unsigned long** +Type: **unsigned long** + @@ -1133,7 +1243,8 @@ A count of a portal user's permissions. These permissions control that user's ac [preferenceCount]: #preferencecount #### [preferenceCount] A count of data type contains a single user preference to a specific preference type. -Type: **unsigned long** +Type: **unsigned long** + @@ -1143,7 +1254,8 @@ A count of data type contains a single user preference to a specific preference [roleCount]: #rolecount #### [roleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1153,7 +1265,8 @@ A count of [securityAnswerCount]: #securityanswercount #### [securityAnswerCount] A count of a portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login. -Type: **unsigned long** +Type: **unsigned long** + @@ -1163,7 +1276,8 @@ A count of a portal user's security question answers. Some portal users may not [subscriberCount]: #subscribercount #### [subscriberCount] A count of a user's notification subscription records. -Type: **unsigned long** +Type: **unsigned long** + @@ -1173,7 +1287,8 @@ A count of a user's notification subscription records. [successfulLoginCount]: #successfullogincount #### [successfulLoginCount] A count of a user's successful attempts to log into the SoftLayer customer portal. -Type: **unsigned long** +Type: **unsigned long** + @@ -1183,7 +1298,8 @@ A count of a user's successful attempts to log into the SoftLayer customer porta [surveyCount]: #surveycount #### [surveyCount] A count of the surveys that a user has taken in the SoftLayer customer portal. -Type: **unsigned long** +Type: **unsigned long** + @@ -1193,7 +1309,8 @@ A count of the surveys that a user has taken in the SoftLayer customer portal. [ticketCount]: #ticketcount #### [ticketCount] A count of an user's associated tickets. -Type: **unsigned long** +Type: **unsigned long** + @@ -1203,7 +1320,8 @@ A count of an user's associated tickets. [unsuccessfulLoginCount]: #unsuccessfullogincount #### [unsuccessfulLoginCount] A count of a user's unsuccessful attempts to log into the SoftLayer customer portal. -Type: **unsigned long** +Type: **unsigned long** + @@ -1213,7 +1331,8 @@ A count of a user's unsuccessful attempts to log into the SoftLayer customer por [userLinkCount]: #userlinkcount #### [userLinkCount] A count of user customer link with IBMid and IAMid. -Type: **unsigned long** +Type: **unsigned long** + @@ -1223,7 +1342,8 @@ A count of user customer link with IBMid and IAMid. [virtualGuestCount]: #virtualguestcount #### [virtualGuestCount] A count of a portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_Profile_Event_HyperWarp/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_Profile_Event_HyperWarp/_index.md index 13b66da8dc..c56b8aef1e 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_Profile_Event_HyperWarp/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_Profile_Event_HyperWarp/_index.md @@ -24,6 +24,8 @@ classes: + +
              diff --git a/content/reference/datatypes/SoftLayer_User_Customer_Prospect/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_Prospect/_index.md index f2d382f2b5..240d5a22ce 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_Prospect/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_Prospect/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -51,7 +53,8 @@ classes: [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** +
              @@ -61,7 +64,8 @@ classes: [assignedEmployees]: #assignedemployees #### [assignedEmployees] -Type: **SoftLayer_User_Employee[] ** +Type: **SoftLayer_User_Employee[] ** +
              @@ -71,7 +75,8 @@ classes: [quotes]: #quotes #### [quotes] -Type: **SoftLayer_Billing_Order_Quote[] ** +Type: **SoftLayer_Billing_Order_Quote[] ** +
              @@ -81,7 +86,8 @@ classes: [type]: #type #### [type] -Type: **SoftLayer_User_Customer_Prospect_Type ** +Type: **SoftLayer_User_Customer_Prospect_Type ** +
              @@ -93,7 +99,8 @@ classes: [assignedEmployeeCount]: #assignedemployeecount #### [assignedEmployeeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -103,7 +110,8 @@ A count of [quoteCount]: #quotecount #### [quoteCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/_index.md index 85b90db24c..3938b8f125 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Contains user information for Service Provider Enrollment. @@ -45,7 +47,8 @@ Contains user information for Service Provider Enrollment. [acceptAllAgreementsFlag]: #acceptallagreementsflag #### [acceptAllAgreementsFlag] Flag indicating whether or not applicant has accepted all current SSP agreements. -Type: **boolean** +Type: **boolean** + @@ -55,7 +58,8 @@ Flag indicating whether or not applicant has accepted all current SSP agreements [accountId]: #accountid #### [accountId] accountId of existing SoftLayer Customer -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ accountId of existing SoftLayer Customer [address1]: #address1 #### [address1] Service provider address1 -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Service provider address1 [address2]: #address2 #### [address2] Service provider address2 -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ Service provider address2 [cardAccountNumber]: #cardaccountnumber #### [cardAccountNumber] Credit card account number -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ Credit card account number [cardExpirationMonth]: #cardexpirationmonth #### [cardExpirationMonth] Credit card expiration month -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ Credit card expiration month [cardExpirationYear]: #cardexpirationyear #### [cardExpirationYear] Credit card expiration year -Type: **string** +Type: **string** + @@ -115,7 +124,8 @@ Credit card expiration year [cardType]: #cardtype #### [cardType] Type of credit card being used -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ Type of credit card being used [cardVerificationNumber]: #cardverificationnumber #### [cardVerificationNumber] Credit card verification number -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ Credit card verification number [city]: #city #### [city] Service provider city -Type: **string** +Type: **string** + @@ -145,7 +157,8 @@ Service provider city [companyName]: #companyname #### [companyName] Service provider company name -Type: **string** +Type: **string** + @@ -155,7 +168,8 @@ Service provider company name [companyTypeId]: #companytypeid #### [companyTypeId] Id of the company type which best describes applicant's company -Type: **integer** +Type: **integer** + @@ -165,7 +179,8 @@ Id of the company type which best describes applicant's company [companyUrl]: #companyurl #### [companyUrl] Service provider company url -Type: **string** +Type: **string** + @@ -175,7 +190,8 @@ Service provider company url [contactEmail]: #contactemail #### [contactEmail] Service provider contact's email -Type: **string** +Type: **string** + @@ -185,7 +201,8 @@ Service provider contact's email [contactFirstName]: #contactfirstname #### [contactFirstName] Service provider contact's first name -Type: **string** +Type: **string** + @@ -195,7 +212,8 @@ Service provider contact's first name [contactLastName]: #contactlastname #### [contactLastName] Service provider contact's last name -Type: **string** +Type: **string** + @@ -205,7 +223,8 @@ Service provider contact's last name [contactPhone]: #contactphone #### [contactPhone] Service provider contact's Phone -Type: **string** +Type: **string** + @@ -215,7 +234,8 @@ Service provider contact's Phone [country]: #country #### [country] Service provider country -Type: **string** +Type: **string** + @@ -225,7 +245,8 @@ Service provider country [customerProspectId]: #customerprospectid #### [customerProspectId] Customer Prospect id -Type: **integer** +Type: **integer** + @@ -235,7 +256,8 @@ Customer Prospect id [deviceFingerprintId]: #devicefingerprintid #### [deviceFingerprintId] Id of the device fingerprint -Type: **string** +Type: **string** + @@ -245,7 +267,8 @@ Id of the device fingerprint [email]: #email #### [email] Service provider email -Type: **string** +Type: **string** + @@ -255,7 +278,8 @@ Service provider email [existingCustomerFlag]: #existingcustomerflag #### [existingCustomerFlag] Indicates if customer has an existing SoftLayer account -Type: **boolean** +Type: **boolean** + @@ -265,7 +289,8 @@ Indicates if customer has an existing SoftLayer account [firstName]: #firstname #### [firstName] Service provider first name -Type: **string** +Type: **string** + @@ -275,7 +300,8 @@ Service provider first name [ibmIdUsername]: #ibmidusername #### [ibmIdUsername] Service provider IBMid username, if different than the email. -Type: **string** +Type: **string** + @@ -285,7 +311,8 @@ Service provider IBMid username, if different than the email. [ibmPartnerWorldId]: #ibmpartnerworldid #### [ibmPartnerWorldId] IBM partner world id -Type: **string** +Type: **string** + @@ -295,7 +322,8 @@ IBM partner world id [ibmPartnerWorldMemberFlag]: #ibmpartnerworldmemberflag #### [ibmPartnerWorldMemberFlag] Indicates if the customer is IBM partner world member -Type: **boolean** +Type: **boolean** + @@ -305,7 +333,8 @@ Indicates if the customer is IBM partner world member [lastName]: #lastname #### [lastName] Service provider last name -Type: **string** +Type: **string** + @@ -315,7 +344,8 @@ Service provider last name [masterAgreementCompleteFlag]: #masteragreementcompleteflag #### [masterAgreementCompleteFlag] Flag indicating whether or not applicant acknowledged MSA -Type: **boolean** +Type: **boolean** + @@ -325,7 +355,8 @@ Flag indicating whether or not applicant acknowledged MSA [officePhone]: #officephone #### [officePhone] Service provider office phone -Type: **string** +Type: **string** + @@ -335,7 +366,8 @@ Service provider office phone [postalCode]: #postalcode #### [postalCode] Service provider postalCode -Type: **string** +Type: **string** + @@ -345,7 +377,8 @@ Service provider postalCode [serviceProviderAddendumFlag]: #serviceprovideraddendumflag #### [serviceProviderAddendumFlag] Flag indicating whether or not applicant acknowledged service provider addendum -Type: **boolean** +Type: **boolean** + @@ -355,7 +388,8 @@ Flag indicating whether or not applicant acknowledged service provider addendum [state]: #state #### [state] Service provider state -Type: **string** +Type: **string** + @@ -365,7 +399,8 @@ Service provider state [surveyResponses]: #surveyresponses #### [surveyResponses] Survey responses -Type: **SoftLayer_Survey_Response[] ** +Type: **SoftLayer_Survey_Response[] ** + @@ -375,7 +410,8 @@ Survey responses [vatId]: #vatid #### [vatId] Applicant's VAT id, if one exists -Type: **string** +Type: **string** + @@ -391,7 +427,8 @@ Applicant's VAT id, if one exists [companyType]: #companytype #### [companyType] Catalyst company types. -Type: **SoftLayer_Catalyst_Company_Type ** +Type: **SoftLayer_Catalyst_Company_Type ** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_Prospect_Type/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_Prospect_Type/_index.md index cee0e55b8a..f61e7b3743 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_Prospect_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_Prospect_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ classes: [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_Security_Answer/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_Security_Answer/_index.md index 8aed780644..32db8f9b21 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_Security_Answer/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_Security_Answer/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_User_Customer_Security_Answer type contains user's answers to security questions. @@ -59,7 +61,8 @@ The SoftLayer_User_Customer_Security_Answer type contains user's answers to secu [answer]: #answer #### [answer] A user's answer. -Type: **string** +Type: **string** + @@ -69,7 +72,8 @@ A user's answer. [id]: #id #### [id] A user's answer identifying number. -Type: **integer** +Type: **integer** + @@ -79,7 +83,8 @@ A user's answer identifying number. [questionId]: #questionid #### [questionId] A user's question identifying number. -Type: **integer** +Type: **integer** + @@ -89,7 +94,8 @@ A user's question identifying number. [userId]: #userid #### [userId] A user's identifying number. -Type: **integer** +Type: **integer** + @@ -105,7 +111,8 @@ A user's identifying number. [question]: #question #### [question] The question the security answer is associated with. -Type: **SoftLayer_User_Security_Question ** +Type: **SoftLayer_User_Security_Question ** + @@ -115,7 +122,8 @@ The question the security answer is associated with. [user]: #user #### [user] The user who the security answer belongs to. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + diff --git a/content/reference/datatypes/SoftLayer_User_Customer_Status/_index.md b/content/reference/datatypes/SoftLayer_User_Customer_Status/_index.md index ed7518657c..9ffed78b92 100644 --- a/content/reference/datatypes/SoftLayer_User_Customer_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Customer_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -60,7 +62,8 @@ Note that a status of "PENDING" also has been added. This status is specific to [id]: #id #### [id] A user's status identifying number. -Type: **integer** +Type: **integer** + @@ -70,7 +73,8 @@ A user's status identifying number. [keyName]: #keyname #### [keyName] A user's status keyname -Type: **string** +Type: **string** + @@ -80,7 +84,8 @@ A user's status keyname [name]: #name #### [name] A user's status. This can be either "Active" for user accounts with portal access, "Inactive" for users disabled by another portal user, "Disabled" for accounts turned off by SoftLayer, or "VPN Only" for user accounts with no access to the customer portal but VPN access to the private network. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_User_Employee/_index.md b/content/reference/datatypes/SoftLayer_User_Employee/_index.md index 752d823f58..eaf7d541b1 100644 --- a/content/reference/datatypes/SoftLayer_User_Employee/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Employee/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -55,7 +57,8 @@ A SoftLayer_User_Employee models a single SoftLayer employee for the purposes of [displayName]: #displayname #### [displayName] -Type: **string** +Type: **string** + @@ -65,7 +68,8 @@ A SoftLayer_User_Employee models a single SoftLayer employee for the purposes of [email]: #email #### [email] A SoftLayer employee's email address. Email addresses are only visible to [SoftLayer_Account]({{}}) that are assigned to an employee -Type: **string** +Type: **string** + @@ -75,7 +79,8 @@ A SoftLayer employee's email address. Email addresses are only visible to [SoftL [employeeDepartmentId]: #employeedepartmentid #### [employeeDepartmentId] A SoftLayer employee's [SoftLayer_User_Employee_Department]({{}}) id. -Type: **integer** +Type: **integer** + @@ -85,7 +90,8 @@ A SoftLayer employee's [SoftLayer_User_Employee_Department]({{}}) that are assigned to an employee -Type: **string** +Type: **string** + @@ -95,7 +101,8 @@ A SoftLayer employee's first name. First names are only visible to [SoftLayer_Ac [lastName]: #lastname #### [lastName] A SoftLayer employee's last name. Last names are only visible to [SoftLayer_Account]({{}}) that are assigned to an employee -Type: **string** +Type: **string** + @@ -105,7 +112,8 @@ A SoftLayer employee's last name. Last names are only visible to [SoftLayer_Acco [username]: #username #### [username] A representation of a SoftLayer employee's username. -Type: **string** +Type: **string** + @@ -121,7 +129,8 @@ A representation of a SoftLayer employee's username. [chatTranscript]: #chattranscript #### [chatTranscript] -Type: **SoftLayer_Ticket_Chat[] ** +Type: **SoftLayer_Ticket_Chat[] ** + @@ -131,7 +140,8 @@ A representation of a SoftLayer employee's username. [employeeDepartment]: #employeedepartment #### [employeeDepartment] The department that a SoftLayer employee belongs to. -Type: **SoftLayer_User_Employee_Department ** +Type: **SoftLayer_User_Employee_Department ** + @@ -141,7 +151,8 @@ The department that a SoftLayer employee belongs to. [layoutProfiles]: #layoutprofiles #### [layoutProfiles] -Type: **SoftLayer_Layout_Profile[] ** +Type: **SoftLayer_Layout_Profile[] ** + @@ -151,7 +162,8 @@ The department that a SoftLayer employee belongs to. [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -161,7 +173,8 @@ The department that a SoftLayer employee belongs to. [securityLevels]: #securitylevels #### [securityLevels] -Type: **SoftLayer_Security_Level[] ** +Type: **SoftLayer_Security_Level[] ** + @@ -171,7 +184,8 @@ The department that a SoftLayer employee belongs to. [ticketActivities]: #ticketactivities #### [ticketActivities] -Type: **SoftLayer_Ticket_Activity[] ** +Type: **SoftLayer_Ticket_Activity[] ** + @@ -181,7 +195,8 @@ The department that a SoftLayer employee belongs to. [ticketAttachmentReferences]: #ticketattachmentreferences #### [ticketAttachmentReferences] -Type: **SoftLayer_Ticket_Attachment[] ** +Type: **SoftLayer_Ticket_Attachment[] ** + @@ -193,7 +208,8 @@ The department that a SoftLayer employee belongs to. [chatTranscriptCount]: #chattranscriptcount #### [chatTranscriptCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -203,7 +219,8 @@ A count of [layoutProfileCount]: #layoutprofilecount #### [layoutProfileCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -213,7 +230,8 @@ A count of [securityLevelCount]: #securitylevelcount #### [securityLevelCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -223,7 +241,8 @@ A count of [ticketActivityCount]: #ticketactivitycount #### [ticketActivityCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -233,7 +252,8 @@ A count of [ticketAttachmentReferenceCount]: #ticketattachmentreferencecount #### [ticketAttachmentReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_User_Employee_Department/_index.md b/content/reference/datatypes/SoftLayer_User_Employee_Department/_index.md index f196a02474..45905cfab9 100644 --- a/content/reference/datatypes/SoftLayer_User_Employee_Department/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Employee_Department/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_User_Employee_Department models a department within SoftLayer's internal employee hierarchy. Common departments include Support, Sales, Accounting, Development, Systems, and Networking. @@ -50,7 +52,8 @@ SoftLayer_User_Employee_Department models a department within SoftLayer's intern [name]: #name #### [name] The name of one of SoftLayer's employee departments. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_User_External_Binding/_index.md b/content/reference/datatypes/SoftLayer_User_External_Binding/_index.md index ef596859ca..28fd18314b 100644 --- a/content/reference/datatypes/SoftLayer_User_External_Binding/_index.md +++ b/content/reference/datatypes/SoftLayer_User_External_Binding/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_User_External_Binding data type contains general information for a [active]: #active #### [active] The flag that determines whether the external binding is active will be used for authentication or not. -Type: **boolean** +Type: **boolean** + @@ -55,7 +58,8 @@ The flag that determines whether the external binding is active will be used for [createDate]: #createdate #### [createDate] The date that the external authentication binding was created. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The date that the external authentication binding was created. [externalId]: #externalid #### [externalId] The identifier used to identify this binding to an external authentication source. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The identifier used to identify this binding to an external authentication sourc [id]: #id #### [id] An external authentication binding's internal identifier. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ An external authentication binding's internal identifier. [password]: #password #### [password] The password used to authenticate the external id at an external authentication source. -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ The password used to authenticate the external id at an external authentication [typeId]: #typeid #### [typeId] The [SoftLayer_User_External_Binding_Type]({{}}) identifier of an external authentication binding. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The [SoftLayer_User_External_Binding_Type]({{}}) id. -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ An external authentication binding's associated [SoftLayer_User_Customer]({{}}) identifier of an external authentication binding. -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ The [SoftLayer_User_External_Binding_Vendor]({{Type: **SoftLayer_User_External_Binding_Attribute[] ** +Type: **SoftLayer_User_External_Binding_Attribute[] ** + @@ -141,7 +152,8 @@ Attributes of an external authentication binding. [billingItem]: #billingitem #### [billingItem] Information regarding the billing item for external authentication. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -151,7 +163,8 @@ Information regarding the billing item for external authentication. [note]: #note #### [note] An optional note for identifying the external binding. -Type: **string** +Type: **string** + @@ -161,7 +174,8 @@ An optional note for identifying the external binding. [type]: #type #### [type] The type of external authentication binding. -Type: **SoftLayer_User_External_Binding_Type ** +Type: **SoftLayer_User_External_Binding_Type ** + @@ -171,7 +185,8 @@ The type of external authentication binding. [vendor]: #vendor #### [vendor] The vendor of an external authentication binding. -Type: **SoftLayer_User_External_Binding_Vendor ** +Type: **SoftLayer_User_External_Binding_Vendor ** + @@ -183,7 +198,8 @@ The vendor of an external authentication binding. [attributeCount]: #attributecount #### [attributeCount] A count of attributes of an external authentication binding. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_User_External_Binding_Attribute/_index.md b/content/reference/datatypes/SoftLayer_User_External_Binding_Attribute/_index.md index db6435f4e4..13123bfb19 100644 --- a/content/reference/datatypes/SoftLayer_User_External_Binding_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_User_External_Binding_Attribute/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -49,7 +51,8 @@ The SoftLayer_User_External_Binding_Attribute data type contains the value for a [value]: #value #### [value] The value of an external binding attribute. -Type: **string** +Type: **string** + @@ -65,7 +68,8 @@ The value of an external binding attribute. [externalBinding]: #externalbinding #### [externalBinding] The external authentication binding an attribute belongs to. -Type: **SoftLayer_User_External_Binding ** +Type: **SoftLayer_User_External_Binding ** + diff --git a/content/reference/datatypes/SoftLayer_User_External_Binding_Type/_index.md b/content/reference/datatypes/SoftLayer_User_External_Binding_Type/_index.md index ef44e801a2..95dac837b3 100644 --- a/content/reference/datatypes/SoftLayer_User_External_Binding_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_User_External_Binding_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_User_External_Binding_Type data type contains information relating [keyName]: #keyname #### [keyName] The unique name used to identify a type of external authentication binding. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The unique name used to identify a type of external authentication binding. [name]: #name #### [name] The user friendly name of a type of external authentication binding. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_User_External_Binding_Vendor/_index.md b/content/reference/datatypes/SoftLayer_User_External_Binding_Vendor/_index.md index d880eab58e..9b1a231ace 100644 --- a/content/reference/datatypes/SoftLayer_User_External_Binding_Vendor/_index.md +++ b/content/reference/datatypes/SoftLayer_User_External_Binding_Vendor/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ The SoftLayer_User_External_Binding_Vendor data type contains information for a [id]: #id #### [id] The unique identifier for an external binding vendor. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The unique identifier for an external binding vendor. [keyName]: #keyname #### [keyName] A unique version of the name property. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ A unique version of the name property. [name]: #name #### [name] The user friendly name of an external binding vendor. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_User_Interface/_index.md b/content/reference/datatypes/SoftLayer_User_Interface/_index.md index e1f1b194a9..461a485ffd 100644 --- a/content/reference/datatypes/SoftLayer_User_Interface/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Interface/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) and [SoftLayer_User_Employee]({{}}) classes are abstracted by this type. diff --git a/content/reference/datatypes/SoftLayer_User_Permission_Action/_index.md b/content/reference/datatypes/SoftLayer_User_Permission_Action/_index.md index 22b5ec2df0..dd5dc8083a 100644 --- a/content/reference/datatypes/SoftLayer_User_Permission_Action/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Permission_Action/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -53,7 +55,8 @@ It also contains relational attributes that indicate which SoftLayer_User_Permis [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -63,7 +66,8 @@ It also contains relational attributes that indicate which SoftLayer_User_Permis [description]: #description #### [description] -Type: **string** +Type: **string** + @@ -73,7 +77,8 @@ It also contains relational attributes that indicate which SoftLayer_User_Permis [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -83,7 +88,8 @@ It also contains relational attributes that indicate which SoftLayer_User_Permis [key]: #key #### [key] -Type: **string** +Type: **string** + @@ -93,7 +99,8 @@ It also contains relational attributes that indicate which SoftLayer_User_Permis [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -103,7 +110,8 @@ It also contains relational attributes that indicate which SoftLayer_User_Permis [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -113,7 +121,8 @@ It also contains relational attributes that indicate which SoftLayer_User_Permis [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_User_Permission_Group/_index.md b/content/reference/datatypes/SoftLayer_User_Permission_Group/_index.md index 4edde065cc..7a60be3fa0 100644 --- a/content/reference/datatypes/SoftLayer_User_Permission_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Permission_Group/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}). 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. @@ -47,7 +49,8 @@ It also contains relational attributes that indicate what SoftLayer_User_Permiss [accountId]: #accountid #### [accountId] A permission groups associated [SoftLayer_Account]({{}}) id. -Type: **integer** +Type: **integer** + @@ -57,7 +60,8 @@ A permission groups associated [SoftLayer_Account]({{Type: **dateTime** +Type: **dateTime** + @@ -67,7 +71,8 @@ The date the permission group record was created. [description]: #description #### [description] The description of the permission group. -Type: **string** +Type: **string** + @@ -77,7 +82,8 @@ The description of the permission group. [expirationDate]: #expirationdate #### [expirationDate] The date the group will be destroyed. -Type: **dateTime** +Type: **dateTime** + @@ -87,7 +93,8 @@ The date the group will be destroyed. [id]: #id #### [id] A permission groups internal identifying number. -Type: **integer** +Type: **integer** + @@ -97,7 +104,8 @@ A permission groups internal identifying number. [modifyDate]: #modifydate #### [modifyDate] The date the permission group record was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -107,7 +115,8 @@ The date the permission group record was last modified. [name]: #name #### [name] The name of the permission group. -Type: **string** +Type: **string** + @@ -117,7 +126,8 @@ The name of the permission group. [typeId]: #typeid #### [typeId] The type of permission group. -Type: **integer** +Type: **integer** + @@ -133,7 +143,8 @@ The type of permission group. [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -143,7 +154,8 @@ The type of permission group. [actions]: #actions #### [actions] -Type: **SoftLayer_User_Permission_Action[] ** +Type: **SoftLayer_User_Permission_Action[] ** + @@ -153,7 +165,8 @@ The type of permission group. [roles]: #roles #### [roles] -Type: **SoftLayer_User_Permission_Role[] ** +Type: **SoftLayer_User_Permission_Role[] ** + @@ -163,7 +176,8 @@ The type of permission group. [type]: #type #### [type] The type of the permission group. -Type: **SoftLayer_User_Permission_Group_Type ** +Type: **SoftLayer_User_Permission_Group_Type ** + @@ -175,7 +189,8 @@ The type of the permission group. [actionCount]: #actioncount #### [actionCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -185,7 +200,8 @@ A count of [roleCount]: #rolecount #### [roleCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_User_Permission_Group_Type/_index.md b/content/reference/datatypes/SoftLayer_User_Permission_Group_Type/_index.md index 9ee2af7ee8..21b388e7e4 100644 --- a/content/reference/datatypes/SoftLayer_User_Permission_Group_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Permission_Group_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}). @@ -47,7 +49,8 @@ For further information see: [SoftLayer_User_Permission_Group]({{Type: **integer** +Type: **integer** + @@ -57,7 +60,8 @@ Unique Record ID. [keyName]: #keyname #### [keyName] The keyname for the group type. -Type: **string** +Type: **string** + @@ -67,7 +71,8 @@ The keyname for the group type. [name]: #name #### [name] A descriptive name for the group type. -Type: **string** +Type: **string** + @@ -83,7 +88,8 @@ A descriptive name for the group type. [groups]: #groups #### [groups] The groups that are of this type. -Type: **SoftLayer_User_Permission_Group[] ** +Type: **SoftLayer_User_Permission_Group[] ** + @@ -95,7 +101,8 @@ The groups that are of this type. [groupCount]: #groupcount #### [groupCount] A count of the groups that are of this type. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_User_Permission_Resource_Type/_index.md b/content/reference/datatypes/SoftLayer_User_Permission_Resource_Type/_index.md index 8ed1e626dc..f5fd998c3c 100644 --- a/content/reference/datatypes/SoftLayer_User_Permission_Resource_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Permission_Resource_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}). @@ -45,7 +47,8 @@ These are the variables relating to SoftLayer_User_Permission_Resource_Type. Col [className]: #classname #### [className] The associated IMS class name for a resource type. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The associated IMS class name for a resource type. [id]: #id #### [id] Resource Type record ID. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ Resource Type record ID. [keyName]: #keyname #### [keyName] Descriptive Identifier for a Resource Type. A key name contains no spaces, but may use underscores. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Descriptive Identifier for a Resource Type. A key name contains no spaces, but m [name]: #name #### [name] A name for the resource type. It is the most descriptive variable of the resource type and can include spaces. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_User_Permission_Role/_index.md b/content/reference/datatypes/SoftLayer_User_Permission_Role/_index.md index 35159161c5..0a8685b20d 100644 --- a/content/reference/datatypes/SoftLayer_User_Permission_Role/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Permission_Role/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}). 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. @@ -47,7 +49,8 @@ It also contains relational attributes that indicate what SoftLayer_User_Permiss [accountId]: #accountid #### [accountId] Id of a [SoftLayer_Account]({{}}) to which this role belongs. -Type: **integer** +Type: **integer** + @@ -57,7 +60,8 @@ Id of a [SoftLayer_Account]({{}}) t [createDate]: #createdate #### [createDate] The date the permission role record was created. -Type: **dateTime** +Type: **dateTime** + @@ -67,7 +71,8 @@ The date the permission role record was created. [description]: #description #### [description] The description of the permission role. -Type: **string** +Type: **string** + @@ -77,7 +82,8 @@ The description of the permission role. [id]: #id #### [id] A permission roles internal identifying number. -Type: **integer** +Type: **integer** + @@ -87,7 +93,8 @@ A permission roles internal identifying number. [modifyDate]: #modifydate #### [modifyDate] The date the permission role record was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -97,7 +104,8 @@ The date the permission role record was last modified. [name]: #name #### [name] The name of the permission role. -Type: **string** +Type: **string** + @@ -107,7 +115,8 @@ The name of the permission role. [newUserDefaultFlag]: #newuserdefaultflag #### [newUserDefaultFlag] A flag showing if new users should be automatically added to this role. -Type: **integer** +Type: **integer** + @@ -117,7 +126,8 @@ A flag showing if new users should be automatically added to this role. [systemFlag]: #systemflag #### [systemFlag] A flag showing if the permission role was created by our internal system for a single user. If this flag is set, only a single user can be assigned to this permission role and it can not be deleted. -Type: **integer** +Type: **integer** + @@ -133,7 +143,8 @@ A flag showing if the permission role was created by our internal system for a s [account]: #account #### [account] -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -143,7 +154,8 @@ A flag showing if the permission role was created by our internal system for a s [actions]: #actions #### [actions] -Type: **SoftLayer_User_Permission_Action[] ** +Type: **SoftLayer_User_Permission_Action[] ** + @@ -153,7 +165,8 @@ A flag showing if the permission role was created by our internal system for a s [groups]: #groups #### [groups] -Type: **SoftLayer_User_Permission_Group[] ** +Type: **SoftLayer_User_Permission_Group[] ** + @@ -163,7 +176,8 @@ A flag showing if the permission role was created by our internal system for a s [users]: #users #### [users] -Type: **SoftLayer_User_Customer[] ** +Type: **SoftLayer_User_Customer[] ** + @@ -175,7 +189,8 @@ A flag showing if the permission role was created by our internal system for a s [actionCount]: #actioncount #### [actionCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -185,7 +200,8 @@ A count of [groupCount]: #groupcount #### [groupCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -195,7 +211,8 @@ A count of [userCount]: #usercount #### [userCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_User_Preference/_index.md b/content/reference/datatypes/SoftLayer_User_Preference/_index.md index e9989bcc13..845b240c67 100644 --- a/content/reference/datatypes/SoftLayer_User_Preference/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Preference/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_User_Preference data type contains a single user preference to a specific preference type. @@ -45,7 +47,8 @@ The SoftLayer_User_Preference data type contains a single user preference to a s [value]: #value #### [value] The users current preference value -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ The users current preference value [description]: #description #### [description] Description of the user preference -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ Description of the user preference [type]: #type #### [type] Type of user preference -Type: **SoftLayer_User_Preference_Type ** +Type: **SoftLayer_User_Preference_Type ** + diff --git a/content/reference/datatypes/SoftLayer_User_Preference_Type/_index.md b/content/reference/datatypes/SoftLayer_User_Preference_Type/_index.md index c83c3d5f69..130e14dd18 100644 --- a/content/reference/datatypes/SoftLayer_User_Preference_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Preference_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_User_Preference_Type data type contains a single preference type including the accepted values. @@ -45,7 +47,8 @@ The SoftLayer_User_Preference_Type data type contains a single preference type i [description]: #description #### [description] A description of the preference type -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ A description of the preference type [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ A description of the preference type [name]: #name #### [name] The name of the preference type -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The name of the preference type [valueExample]: #valueexample #### [valueExample] An example of accepted preference values -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_User_Security_Question/_index.md b/content/reference/datatypes/SoftLayer_User_Security_Question/_index.md index f7c7429e8d..3504d24ecd 100644 --- a/content/reference/datatypes/SoftLayer_User_Security_Question/_index.md +++ b/content/reference/datatypes/SoftLayer_User_Security_Question/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_User_Security_Question data type contains questions. @@ -50,7 +52,8 @@ The SoftLayer_User_Security_Question data type contains questions. [displayOrder]: #displayorder #### [displayOrder] A security question's display order. -Type: **integer** +Type: **integer** + @@ -60,7 +63,8 @@ A security question's display order. [id]: #id #### [id] A security question's internal identifying number. -Type: **integer** +Type: **integer** + @@ -70,7 +74,8 @@ A security question's internal identifying number. [question]: #question #### [question] A security question's question. -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ A security question's question. [viewable]: #viewable #### [viewable] A security question's viewable flag. -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Utility_ObjectFilter/_index.md b/content/reference/datatypes/SoftLayer_Utility_ObjectFilter/_index.md index 2777a4715e..c0a87b92c7 100644 --- a/content/reference/datatypes/SoftLayer_Utility_ObjectFilter/_index.md +++ b/content/reference/datatypes/SoftLayer_Utility_ObjectFilter/_index.md @@ -24,6 +24,8 @@ classes: + +
              diff --git a/content/reference/datatypes/SoftLayer_Utility_ObjectFilter_Operation/_index.md b/content/reference/datatypes/SoftLayer_Utility_ObjectFilter_Operation/_index.md index 4b58692dfb..c567ee4fec 100644 --- a/content/reference/datatypes/SoftLayer_Utility_ObjectFilter_Operation/_index.md +++ b/content/reference/datatypes/SoftLayer_Utility_ObjectFilter_Operation/_index.md @@ -24,6 +24,8 @@ classes: + +
              diff --git a/content/reference/datatypes/SoftLayer_Utility_ObjectFilter_Operation_Option/_index.md b/content/reference/datatypes/SoftLayer_Utility_ObjectFilter_Operation_Option/_index.md index f2e4027aa8..886f764a30 100644 --- a/content/reference/datatypes/SoftLayer_Utility_ObjectFilter_Operation_Option/_index.md +++ b/content/reference/datatypes/SoftLayer_Utility_ObjectFilter_Operation_Option/_index.md @@ -24,6 +24,8 @@ classes: + +
              diff --git a/content/reference/datatypes/SoftLayer_Vendor_Type/_index.md b/content/reference/datatypes/SoftLayer_Vendor_Type/_index.md index 04910b703b..54256b72c5 100644 --- a/content/reference/datatypes/SoftLayer_Vendor_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Vendor_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
              diff --git a/content/reference/datatypes/SoftLayer_Virtual_BrowserConsoleAccessLog/_index.md b/content/reference/datatypes/SoftLayer_Virtual_BrowserConsoleAccessLog/_index.md index 91ea422c3e..135360bcd2 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_BrowserConsoleAccessLog/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_BrowserConsoleAccessLog/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + The SoftLayer_Virtual_BrowserConsoleAccessLog data type presents the data for events associated with accessing a VSIs console via the browser interface. @@ -45,7 +47,8 @@ The SoftLayer_Virtual_BrowserConsoleAccessLog data type presents the data for ev [createDate]: #createdate #### [createDate] Date created -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ Date created [eventType]: #eventtype #### [eventType] The event type that was triggered -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ The event type that was triggered [id]: #id #### [id] Unique ID for a console log event instance. -Type: **integer** +Type: **integer** +
              @@ -75,7 +80,8 @@ Unique ID for a console log event instance. [message]: #message #### [message] The message for the event -Type: **string** +Type: **string** +
              @@ -85,7 +91,8 @@ The message for the event [modifyDate]: #modifydate #### [modifyDate] Date modified -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ Date modified [sourceIp]: #sourceip #### [sourceIp] The IP address of the client that triggered the event -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The IP address of the client that triggered the event [sourcePort]: #sourceport #### [sourcePort] The IP port of the client that triggered the event -Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ The IP port of the client that triggered the event [userId]: #userid #### [userId] The user id that triggered the event -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ The user id that triggered the event [userType]: #usertype #### [userType] The user type that triggered the event -Type: **string** +Type: **string** + @@ -135,7 +146,8 @@ The user type that triggered the event [username]: #username #### [username] The username of the user that triggered the event -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_DedicatedHost/_index.md b/content/reference/datatypes/SoftLayer_Virtual_DedicatedHost/_index.md index ccae6f518c..c8475d165e 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_DedicatedHost/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_DedicatedHost/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ This data type presents the structure for a dedicated host. The data type contai [accountId]: #accountid #### [accountId] The dedicated host's associated account id. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The dedicated host's associated account id. [cpuCount]: #cpucount #### [cpuCount] The capacity that the dedicated host's CPU allocation is restricted to. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The capacity that the dedicated host's CPU allocation is restricted to. [createDate]: #createdate #### [createDate] The date that the dedicated host was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date that the dedicated host was created. [diskCapacity]: #diskcapacity #### [diskCapacity] The capacity that the dedicated host's disk allocation is restricted to. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The capacity that the dedicated host's disk allocation is restricted to. [id]: #id #### [id] The dedicated host's associated unique id. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ The dedicated host's associated unique id. [memoryCapacity]: #memorycapacity #### [memoryCapacity] The capacity that the dedicated host's memory allocation is restricted to. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The capacity that the dedicated host's memory allocation is restricted to. [modifyDate]: #modifydate #### [modifyDate] The date that the dedicated host was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The date that the dedicated host was last modified. [name]: #name #### [name] The dedicated host's name. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ The dedicated host's name. [notes]: #notes #### [notes] A note of up to 1,000 characters about a dedicated host. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ A note of up to 1,000 characters about a dedicated host. [account]: #account #### [account] The account that the dedicated host belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -151,7 +163,8 @@ The account that the dedicated host belongs to. [allocationStatus]: #allocationstatus #### [allocationStatus] The container that represents allocations on the dedicated host. -Type: **SoftLayer_Container_Virtual_DedicatedHost_AllocationStatus ** +Type: **SoftLayer_Container_Virtual_DedicatedHost_AllocationStatus ** + @@ -161,7 +174,8 @@ The container that represents allocations on the dedicated host. [backendRouter]: #backendrouter #### [backendRouter] The backend router behind dedicated host's pool of resources. -Type: **SoftLayer_Hardware_Router_Backend ** +Type: **SoftLayer_Hardware_Router_Backend ** + @@ -171,7 +185,8 @@ The backend router behind dedicated host's pool of resources. [billingItem]: #billingitem #### [billingItem] The billing item for the dedicated host. -Type: **SoftLayer_Billing_Item_Virtual_DedicatedHost ** +Type: **SoftLayer_Billing_Item_Virtual_DedicatedHost ** + @@ -181,7 +196,8 @@ The billing item for the dedicated host. [datacenter]: #datacenter #### [datacenter] The datacenter that the dedicated host resides in. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -191,7 +207,8 @@ The datacenter that the dedicated host resides in. [guests]: #guests #### [guests] The guests associated with the dedicated host. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -201,7 +218,8 @@ The guests associated with the dedicated host. [internalTagReferences]: #internaltagreferences #### [internalTagReferences] -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** + @@ -211,7 +229,8 @@ The guests associated with the dedicated host. [pciDeviceAllocationStatus]: #pcideviceallocationstatus #### [pciDeviceAllocationStatus] The container that represents PCI device allocations on the dedicated host. -Type: **SoftLayer_Container_Virtual_DedicatedHost_Pci_Device_AllocationStatus ** +Type: **SoftLayer_Container_Virtual_DedicatedHost_Pci_Device_AllocationStatus ** + @@ -221,7 +240,8 @@ The container that represents PCI device allocations on the dedicated host. [pciDevices]: #pcidevices #### [pciDevices] A collection of SoftLayer_Virtual_Host_PciDevice objects on the host. -Type: **SoftLayer_Virtual_Host_PciDevice[] ** +Type: **SoftLayer_Virtual_Host_PciDevice[] ** + @@ -231,7 +251,8 @@ A collection of SoftLayer_Virtual_Host_PciDevice objects on the host. [tagReferences]: #tagreferences #### [tagReferences] -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** + @@ -243,7 +264,8 @@ A collection of SoftLayer_Virtual_Host_PciDevice objects on the host. [guestCount]: #guestcount #### [guestCount] A count of the guests associated with the dedicated host. -Type: **unsigned long** +Type: **unsigned long** + @@ -253,7 +275,8 @@ A count of the guests associated with the dedicated host. [internalTagReferenceCount]: #internaltagreferencecount #### [internalTagReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -263,7 +286,8 @@ A count of [pciDeviceCount]: #pcidevicecount #### [pciDeviceCount] A count of a collection of SoftLayer_Virtual_Host_PciDevice objects on the host. -Type: **unsigned long** +Type: **unsigned long** + @@ -273,7 +297,8 @@ A count of a collection of SoftLayer_Virtual_Host_PciDevice objects on the host. [tagReferenceCount]: #tagreferencecount #### [tagReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Disk_Image/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Disk_Image/_index.md index 1331c8b6ea..6f87f28b02 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Disk_Image/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Disk_Image/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + 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. @@ -49,7 +51,8 @@ Virtual block devices are assigned to disk images. [capacity]: #capacity #### [capacity] A disk image's size measured in gigabytes. -Type: **integer** +Type: **integer** + @@ -59,7 +62,8 @@ A disk image's size measured in gigabytes. [checksum]: #checksum #### [checksum] A disk image's unique md5 checksum. -Type: **string** +Type: **string** + @@ -69,7 +73,8 @@ A disk image's unique md5 checksum. [checksumAlgorithm]: #checksumalgorithm #### [checksumAlgorithm] A column to save the Algorithm being used to store the checksum. -Type: **string** +Type: **string** + @@ -79,7 +84,8 @@ A column to save the Algorithm being used to store the checksum. [createDate]: #createdate #### [createDate] The date a disk image was created. -Type: **dateTime** +Type: **dateTime** + @@ -89,7 +95,8 @@ The date a disk image was created. [description]: #description #### [description] A brief description of a virtual disk image. -Type: **string** +Type: **string** + @@ -99,7 +106,8 @@ A brief description of a virtual disk image. [id]: #id #### [id] A disk image's unique ID. -Type: **integer** +Type: **integer** + @@ -109,7 +117,8 @@ A disk image's unique ID. [modifyDate]: #modifydate #### [modifyDate] The date a disk image was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -119,7 +128,8 @@ The date a disk image was last modified. [name]: #name #### [name] A descriptive name used to identify a disk image to a user. -Type: **string** +Type: **string** + @@ -129,7 +139,8 @@ A descriptive name used to identify a disk image to a user. [parentId]: #parentid #### [parentId] The ID of the the disk image that this disk image is based on, if applicable. -Type: **integer** +Type: **integer** + @@ -139,7 +150,8 @@ The ID of the the disk image that this disk image is based on, if applicable. [storageRepositoryId]: #storagerepositoryid #### [storageRepositoryId] The [SoftLayer_Virtual_Storage_Repository]({{}}) that a disk image is in. -Type: **integer** +Type: **integer** + @@ -149,7 +161,8 @@ The [SoftLayer_Virtual_Storage_Repository]({{}}) ID -Type: **integer** +Type: **integer** + @@ -159,7 +172,8 @@ A disk image's [SoftLayer_Virtual_Disk_Image_Type]({{Type: **string** +Type: **string** + @@ -169,7 +183,8 @@ The unit of storage in which the size of the image is measured. Defaults to "GB" [uuid]: #uuid #### [uuid] A disk image's unique ID on a virtualization platform. -Type: **string** +Type: **string** + @@ -185,7 +200,8 @@ A disk image's unique ID on a virtualization platform. [billingItem]: #billingitem #### [billingItem] The billing item for a virtual disk image. -Type: **SoftLayer_Billing_Item_Virtual_Disk_Image ** +Type: **SoftLayer_Billing_Item_Virtual_Disk_Image ** + @@ -195,7 +211,8 @@ The billing item for a virtual disk image. [blockDevices]: #blockdevices #### [blockDevices] The block devices that a disk image is attached to. Block devices connect computing instances to disk images. -Type: **SoftLayer_Virtual_Guest_Block_Device[] ** +Type: **SoftLayer_Virtual_Guest_Block_Device[] ** + @@ -205,7 +222,8 @@ The block devices that a disk image is attached to. Block devices connect comput [bootableVolumeFlag]: #bootablevolumeflag #### [bootableVolumeFlag] -Type: **boolean** +Type: **boolean** + @@ -215,7 +233,8 @@ The block devices that a disk image is attached to. Block devices connect comput [cloudInitFlag]: #cloudinitflag #### [cloudInitFlag] Check if cloud-init is enabled. -Type: **boolean** +Type: **boolean** + @@ -225,7 +244,8 @@ Check if cloud-init is enabled. [coalescedDiskImages]: #coalesceddiskimages #### [coalescedDiskImages] -Type: **SoftLayer_Virtual_Disk_Image[] ** +Type: **SoftLayer_Virtual_Disk_Image[] ** + @@ -235,7 +255,8 @@ Check if cloud-init is enabled. [copyOnWriteFlag]: #copyonwriteflag #### [copyOnWriteFlag] -Type: **boolean** +Type: **boolean** + @@ -245,7 +266,8 @@ Check if cloud-init is enabled. [diskFileExtension]: #diskfileextension #### [diskFileExtension] Return disk file extension -Type: **string** +Type: **string** + @@ -255,7 +277,8 @@ Return disk file extension [diskImageStorageGroup]: #diskimagestoragegroup #### [diskImageStorageGroup] -Type: **SoftLayer_Configuration_Storage_Group ** +Type: **SoftLayer_Configuration_Storage_Group ** + @@ -265,7 +288,8 @@ Return disk file extension [importedDiskType]: #importeddisktype #### [importedDiskType] Return imported disk type -Type: **string** +Type: **string** + @@ -275,7 +299,8 @@ Return imported disk type [isEncrypted]: #isencrypted #### [isEncrypted] Return if image is encrypted -Type: **boolean** +Type: **boolean** + @@ -285,7 +310,8 @@ Return if image is encrypted [localDiskFlag]: #localdiskflag #### [localDiskFlag] -Type: **boolean** +Type: **boolean** + @@ -295,7 +321,8 @@ Return if image is encrypted [metadataFlag]: #metadataflag #### [metadataFlag] Whether this disk image is meant for storage of custom user data supplied with a Cloud Computing Instance order. -Type: **boolean** +Type: **boolean** + @@ -305,7 +332,8 @@ Whether this disk image is meant for storage of custom user data supplied with a [softwareReferences]: #softwarereferences #### [softwareReferences] References to the software that resides on a disk image. -Type: **SoftLayer_Virtual_Disk_Image_Software[] ** +Type: **SoftLayer_Virtual_Disk_Image_Software[] ** + @@ -315,7 +343,8 @@ References to the software that resides on a disk image. [sourceDiskImage]: #sourcediskimage #### [sourceDiskImage] The original disk image that the current disk image was cloned from. -Type: **SoftLayer_Virtual_Disk_Image ** +Type: **SoftLayer_Virtual_Disk_Image ** + @@ -325,7 +354,8 @@ The original disk image that the current disk image was cloned from. [storageGroupDetails]: #storagegroupdetails #### [storageGroupDetails] Return storage group details for symantec disk -Type: **SoftLayer_Container_Image_StorageGroupDetails ** +Type: **SoftLayer_Container_Image_StorageGroupDetails ** + @@ -335,7 +365,8 @@ Return storage group details for symantec disk [storageGroups]: #storagegroups #### [storageGroups] The storage group for a virtual disk image. -Type: **SoftLayer_Configuration_Storage_Group[] ** +Type: **SoftLayer_Configuration_Storage_Group[] ** + @@ -345,7 +376,8 @@ The storage group for a virtual disk image. [storageRepository]: #storagerepository #### [storageRepository] The storage repository that a disk image resides in. -Type: **SoftLayer_Virtual_Storage_Repository ** +Type: **SoftLayer_Virtual_Storage_Repository ** + @@ -355,7 +387,8 @@ The storage repository that a disk image resides in. [storageRepositoryType]: #storagerepositorytype #### [storageRepositoryType] The type of storage repository that a disk image resides in. -Type: **SoftLayer_Virtual_Storage_Repository_Type ** +Type: **SoftLayer_Virtual_Storage_Repository_Type ** + @@ -365,7 +398,8 @@ The type of storage repository that a disk image resides in. [supportedHardware]: #supportedhardware #### [supportedHardware] Return supported hardware component IDs for symantec disk -Type: **string** +Type: **string** + @@ -375,7 +409,8 @@ Return supported hardware component IDs for symantec disk [templateBlockDevice]: #templateblockdevice #### [templateBlockDevice] The template that attaches a disk image to a [SoftLayer_Virtual_Guest_Block_Device_Template_Group]({{}}). -Type: **SoftLayer_Virtual_Guest_Block_Device_Template ** +Type: **SoftLayer_Virtual_Guest_Block_Device_Template ** + @@ -385,7 +420,8 @@ The template that attaches a disk image to a [SoftLayer_Virtual_Guest_Block_Devi [type]: #type #### [type] A virtual disk image's type. -Type: **SoftLayer_Virtual_Disk_Image_Type ** +Type: **SoftLayer_Virtual_Disk_Image_Type ** + @@ -397,7 +433,8 @@ A virtual disk image's type. [blockDeviceCount]: #blockdevicecount #### [blockDeviceCount] A count of the block devices that a disk image is attached to. Block devices connect computing instances to disk images. -Type: **unsigned long** +Type: **unsigned long** + @@ -407,7 +444,8 @@ A count of the block devices that a disk image is attached to. Block devices con [coalescedDiskImageCount]: #coalesceddiskimagecount #### [coalescedDiskImageCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -417,7 +455,8 @@ A count of [softwareReferenceCount]: #softwarereferencecount #### [softwareReferenceCount] A count of references to the software that resides on a disk image. -Type: **unsigned long** +Type: **unsigned long** + @@ -427,7 +466,8 @@ A count of references to the software that resides on a disk image. [storageGroupCount]: #storagegroupcount #### [storageGroupCount] A count of the storage group for a virtual disk image. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Disk_Image_Software/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Disk_Image_Software/_index.md index b22e1707c4..9c77fe6945 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Disk_Image_Software/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Disk_Image_Software/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -53,7 +55,8 @@ A SoftLayer_Virtual_Disk_Image_Software record connects a computing instance's v [id]: #id #### [id] The unique identifier of a virtual disk image to software relationship. -Type: **integer** +Type: **integer** + @@ -63,7 +66,8 @@ The unique identifier of a virtual disk image to software relationship. [softwareDescriptionId]: #softwaredescriptionid #### [softwareDescriptionId] The unique identifier of the software that a virtual disk image is associated with. -Type: **integer** +Type: **integer** + @@ -79,7 +83,8 @@ The unique identifier of the software that a virtual disk image is associated wi [diskImage]: #diskimage #### [diskImage] The virtual disk image that is associated with software. -Type: **SoftLayer_Virtual_Disk_Image ** +Type: **SoftLayer_Virtual_Disk_Image ** + @@ -89,7 +94,8 @@ The virtual disk image that is associated with software. [passwords]: #passwords #### [passwords] Username/Password pairs used for access to a Software Installation. -Type: **SoftLayer_Virtual_Disk_Image_Software_Password[] ** +Type: **SoftLayer_Virtual_Disk_Image_Software_Password[] ** + @@ -99,7 +105,8 @@ Username/Password pairs used for access to a Software Installation. [softwareDescription]: #softwaredescription #### [softwareDescription] The software associated with a virtual disk image. -Type: **SoftLayer_Software_Description ** +Type: **SoftLayer_Software_Description ** + @@ -111,7 +118,8 @@ The software associated with a virtual disk image. [passwordCount]: #passwordcount #### [passwordCount] A count of username/Password pairs used for access to a Software Installation. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Disk_Image_Software_Password/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Disk_Image_Software_Password/_index.md index ba44ca6d6e..b845358ec9 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Disk_Image_Software_Password/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Disk_Image_Software_Password/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This SoftLayer_Virtual_Disk_Image_Software_Password data type contains a password for a specific virtual disk image software instance. @@ -50,7 +52,8 @@ This SoftLayer_Virtual_Disk_Image_Software_Password data type contains a passwor [password]: #password #### [password] A virtual disk images' password. -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ A virtual disk images' password. [username]: #username #### [username] A virtual disk images' username. -Type: **string** +Type: **string** + @@ -76,7 +80,8 @@ A virtual disk images' username. [software]: #software #### [software] The instance that this username/password pair is valid for. -Type: **SoftLayer_Virtual_Disk_Image_Software ** +Type: **SoftLayer_Virtual_Disk_Image_Software ** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Disk_Image_Type/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Disk_Image_Type/_index.md index c670638382..6c8ea8adc9 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Disk_Image_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Disk_Image_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ SoftLayer_Virtual_Disk_Image_Type models the types of virtual disk images availa [description]: #description #### [description] A brief description of a virtual disk image type's function. -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ A brief description of a virtual disk image type's function. [keyName]: #keyname #### [keyName] A virtual disk image type's key name. -Type: **string** +Type: **string** + @@ -70,7 +74,8 @@ A virtual disk image type's key name. [name]: #name #### [name] A virtual disk image type's name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest/_index.md index 05a7b44bcd..ce92eac8ad 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -52,7 +54,8 @@ A guest, also known as a virtual server, represents an allocation of resources o [accountId]: #accountid #### [accountId] A computing instance's associated [SoftLayer_Account]({{}}) id -Type: **integer** +Type: **integer** + @@ -62,7 +65,8 @@ A computing instance's associated [SoftLayer_Account]({{Type: **dateTime** +Type: **dateTime** + @@ -72,7 +76,8 @@ The date a virtual computing instance was created. [dedicatedAccountHostOnlyFlag]: #dedicatedaccounthostonlyflag #### [dedicatedAccountHostOnlyFlag] When true this flag specifies that a compute instance is to run on hosts that only have guests from the same account. -Type: **boolean** +Type: **boolean** + @@ -82,7 +87,8 @@ When true this flag specifies that a compute instance is to run on hosts that on [domain]: #domain #### [domain] A computing instance's domain name -Type: **string** +Type: **string** + @@ -92,7 +98,8 @@ A computing instance's domain name [fullyQualifiedDomainName]: #fullyqualifieddomainname #### [fullyQualifiedDomainName] A name reflecting the hostname and domain of the computing instance. -Type: **string** +Type: **string** + @@ -102,7 +109,8 @@ A name reflecting the hostname and domain of the computing instance. [hostname]: #hostname #### [hostname] A virtual computing instance's hostname -Type: **string** +Type: **string** + @@ -112,7 +120,8 @@ A virtual computing instance's hostname [id]: #id #### [id] Unique ID for a computing instance. -Type: **integer** +Type: **integer** + @@ -122,7 +131,8 @@ Unique ID for a computing instance. [lastPowerStateId]: #lastpowerstateid #### [lastPowerStateId] -Type: **integer** +Type: **integer** + @@ -132,7 +142,8 @@ Unique ID for a computing instance. [lastVerifiedDate]: #lastverifieddate #### [lastVerifiedDate] The last timestamp of when the guest was verified as a resident virtual machine on the host's hypervisor platform. -Type: **dateTime** +Type: **dateTime** + @@ -142,7 +153,8 @@ The last timestamp of when the guest was verified as a resident virtual machine [maxCpu]: #maxcpu #### [maxCpu] The maximum amount of CPU resources a computing instance may utilize. -Type: **integer** +Type: **integer** + @@ -152,7 +164,8 @@ The maximum amount of CPU resources a computing instance may utilize. [maxCpuUnits]: #maxcpuunits #### [maxCpuUnits] The unit of the maximum amount of CPU resources a computing instance may utilize. -Type: **string** +Type: **string** + @@ -162,7 +175,8 @@ The unit of the maximum amount of CPU resources a computing instance may utilize [maxMemory]: #maxmemory #### [maxMemory] The maximum amount of memory a computing instance may utilize. -Type: **integer** +Type: **integer** + @@ -172,7 +186,8 @@ The maximum amount of memory a computing instance may utilize. [metricPollDate]: #metricpolldate #### [metricPollDate] The date of the most recent metric tracking poll performed. -Type: **dateTime** +Type: **dateTime** + @@ -182,7 +197,8 @@ The date of the most recent metric tracking poll performed. [modifyDate]: #modifydate #### [modifyDate] The date a virtual computing instance was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -192,7 +208,8 @@ The date a virtual computing instance was last modified. [notes]: #notes #### [notes] A note of up to 1,000 characters about a virtual server. -Type: **string** +Type: **string** + @@ -202,7 +219,8 @@ A note of up to 1,000 characters about a virtual server. [placementGroupId]: #placementgroupid #### [placementGroupId] The placement group ID that the virtual guest belongs to. -Type: **integer** +Type: **integer** + @@ -212,7 +230,8 @@ The placement group ID that the virtual guest belongs to. [postInstallScriptUri]: #postinstallscripturi #### [postInstallScriptUri] URI of the script to be downloaded and executed after installation is complete. This is deprecated in favor of supplementalCreateObjectOptions' postInstallScriptUri. -Type: **string** +Type: **string** + @@ -222,7 +241,8 @@ URI of the script to be downloaded and executed after installation is complete. [provisionDate]: #provisiondate #### [provisionDate] -Type: **dateTime** +Type: **dateTime** + @@ -232,7 +252,8 @@ URI of the script to be downloaded and executed after installation is complete. [startCpus]: #startcpus #### [startCpus] The number of CPUs available to a computing instance upon startup. -Type: **integer** +Type: **integer** + @@ -242,7 +263,8 @@ The number of CPUs available to a computing instance upon startup. [statusId]: #statusid #### [statusId] A computing instances [SoftLayer_Virtual_Guest_Status]({{}}) ID -Type: **integer** +Type: **integer** + @@ -252,7 +274,8 @@ A computing instances [SoftLayer_Virtual_Guest_Status]({{}}). -Type: **SoftLayer_Virtual_Guest_SupplementalCreateObjectOptions ** +Type: **SoftLayer_Virtual_Guest_SupplementalCreateObjectOptions ** + @@ -262,7 +285,8 @@ Extra options needed for [SoftLayer_Virtual_Guest::createObject]({{Type: **integer** +Type: **integer** + @@ -272,7 +296,8 @@ Gives the type of guest categorized as PUBLIC, DEDICATED or PRIVATE. [uuid]: #uuid #### [uuid] Unique ID for a computing instance's record on a virtualization platform. -Type: **string** +Type: **string** + @@ -288,7 +313,8 @@ Unique ID for a computing instance's record on a virtualization platform. [account]: #account #### [account] The account that a virtual guest belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -298,7 +324,8 @@ The account that a virtual guest belongs to. [accountOwnedPoolFlag]: #accountownedpoolflag #### [accountOwnedPoolFlag] -Type: **boolean** +Type: **boolean** + @@ -308,7 +335,8 @@ The account that a virtual guest belongs to. [activeNetworkMonitorIncident]: #activenetworkmonitorincident #### [activeNetworkMonitorIncident] A virtual guest's currently active network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -318,7 +346,8 @@ A virtual guest's currently active network monitoring incidents. [activeTickets]: #activetickets #### [activeTickets] -Type: **SoftLayer_Ticket[] ** +Type: **SoftLayer_Ticket[] ** + @@ -328,7 +357,8 @@ A virtual guest's currently active network monitoring incidents. [activeTransaction]: #activetransaction #### [activeTransaction] A transaction that is still be performed on a cloud server. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -338,7 +368,8 @@ A transaction that is still be performed on a cloud server. [activeTransactions]: #activetransactions #### [activeTransactions] Any active transaction(s) that are currently running for the server (example: os reload). -Type: **SoftLayer_Provisioning_Version1_Transaction[] ** +Type: **SoftLayer_Provisioning_Version1_Transaction[] ** + @@ -348,7 +379,8 @@ Any active transaction(s) that are currently running for the server (example: os [allowedHost]: #allowedhost #### [allowedHost] The SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual Guest to Network Storage volumes that require access control lists. -Type: **SoftLayer_Network_Storage_Allowed_Host ** +Type: **SoftLayer_Network_Storage_Allowed_Host ** + @@ -358,7 +390,8 @@ The SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual G [allowedNetworkStorage]: #allowednetworkstorage #### [allowedNetworkStorage] The SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -368,7 +401,8 @@ The SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has acce [allowedNetworkStorageReplicas]: #allowednetworkstoragereplicas #### [allowedNetworkStorageReplicas] The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -378,7 +412,8 @@ The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_ [antivirusSpywareSoftwareComponent]: #antivirusspywaresoftwarecomponent #### [antivirusSpywareSoftwareComponent] A antivirus / spyware software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -388,7 +423,8 @@ A antivirus / spyware software component object. [applicationDeliveryController]: #applicationdeliverycontroller #### [applicationDeliveryController] -Type: **SoftLayer_Network_Application_Delivery_Controller ** +Type: **SoftLayer_Network_Application_Delivery_Controller ** + @@ -398,7 +434,8 @@ A antivirus / spyware software component object. [attributes]: #attributes #### [attributes] -Type: **SoftLayer_Virtual_Guest_Attribute[] ** +Type: **SoftLayer_Virtual_Guest_Attribute[] ** + @@ -408,7 +445,8 @@ A antivirus / spyware software component object. [availableMonitoring]: #availablemonitoring #### [availableMonitoring] An object that stores the maximum level for the monitoring query types and response types. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum[] ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum[] ** + @@ -418,7 +456,8 @@ An object that stores the maximum level for the monitoring query types and respo [averageDailyPrivateBandwidthUsage]: #averagedailyprivatebandwidthusage #### [averageDailyPrivateBandwidthUsage] The average daily private bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -428,7 +467,8 @@ The average daily private bandwidth usage for the current billing cycle. [averageDailyPublicBandwidthUsage]: #averagedailypublicbandwidthusage #### [averageDailyPublicBandwidthUsage] The average daily public bandwidth usage for the current billing cycle. -Type: **float** +Type: **float** + @@ -438,7 +478,8 @@ The average daily public bandwidth usage for the current billing cycle. [backendNetworkComponents]: #backendnetworkcomponents #### [backendNetworkComponents] A guests's backend network components. -Type: **SoftLayer_Virtual_Guest_Network_Component[] ** +Type: **SoftLayer_Virtual_Guest_Network_Component[] ** + @@ -448,7 +489,8 @@ A guests's backend network components. [backendRouters]: #backendrouters #### [backendRouters] A guest's backend or private router. -Type: **SoftLayer_Hardware[] ** +Type: **SoftLayer_Hardware[] ** + @@ -458,7 +500,8 @@ A guest's backend or private router. [bandwidthAllocation]: #bandwidthallocation #### [bandwidthAllocation] A computing instance's allotted bandwidth (measured in GB). -Type: **decimal** +Type: **decimal** + @@ -468,7 +511,8 @@ A computing instance's allotted bandwidth (measured in GB). [bandwidthAllotmentDetail]: #bandwidthallotmentdetail #### [bandwidthAllotmentDetail] A computing instance's allotted detail record. Allotment details link bandwidth allocation with allotments. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment_Detail ** + @@ -478,7 +522,8 @@ A computing instance's allotted detail record. Allotment details link bandwidth [billingCycleBandwidthUsage]: #billingcyclebandwidthusage #### [billingCycleBandwidthUsage] The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -Type: **SoftLayer_Network_Bandwidth_Usage[] ** +Type: **SoftLayer_Network_Bandwidth_Usage[] ** + @@ -488,7 +533,8 @@ The raw bandwidth usage data for the current billing cycle. One object will be r [billingCyclePrivateBandwidthUsage]: #billingcycleprivatebandwidthusage #### [billingCyclePrivateBandwidthUsage] The raw private bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage ** +Type: **SoftLayer_Network_Bandwidth_Usage ** + @@ -498,7 +544,8 @@ The raw private bandwidth usage data for the current billing cycle. [billingCyclePublicBandwidthUsage]: #billingcyclepublicbandwidthusage #### [billingCyclePublicBandwidthUsage] The raw public bandwidth usage data for the current billing cycle. -Type: **SoftLayer_Network_Bandwidth_Usage ** +Type: **SoftLayer_Network_Bandwidth_Usage ** + @@ -508,7 +555,8 @@ The raw public bandwidth usage data for the current billing cycle. [billingItem]: #billingitem #### [billingItem] The billing item for a CloudLayer Compute Instance. -Type: **SoftLayer_Billing_Item_Virtual_Guest ** +Type: **SoftLayer_Billing_Item_Virtual_Guest ** + @@ -518,7 +566,8 @@ The billing item for a CloudLayer Compute Instance. [blockCancelBecauseDisconnectedFlag]: #blockcancelbecausedisconnectedflag #### [blockCancelBecauseDisconnectedFlag] Determines whether the instance is ineligible for cancellation because it is disconnected. -Type: **boolean** +Type: **boolean** + @@ -528,7 +577,8 @@ Determines whether the instance is ineligible for cancellation because it is dis [blockDeviceTemplateGroup]: #blockdevicetemplategroup #### [blockDeviceTemplateGroup] The global identifier for the image template that was used to provision or reload a guest. -Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group ** +Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group ** + @@ -538,7 +588,8 @@ The global identifier for the image template that was used to provision or reloa [blockDevices]: #blockdevices #### [blockDevices] A computing instance's block devices. Block devices link [SoftLayer_Virtual_Disk_Image]({{}}) to computing instances. -Type: **SoftLayer_Virtual_Guest_Block_Device[] ** +Type: **SoftLayer_Virtual_Guest_Block_Device[] ** + @@ -548,7 +599,8 @@ A computing instance's block devices. Block devices link [SoftLayer_Virtual_Disk [browserConsoleAccessLogs]: #browserconsoleaccesslogs #### [browserConsoleAccessLogs] A virtual guest's browser access logs. -Type: **SoftLayer_Virtual_BrowserConsoleAccessLog[] ** +Type: **SoftLayer_Virtual_BrowserConsoleAccessLog[] ** + @@ -558,7 +610,8 @@ A virtual guest's browser access logs. [consoleData]: #consoledata #### [consoleData] A container for a guest's console data -Type: **SoftLayer_Container_Virtual_ConsoleData ** +Type: **SoftLayer_Container_Virtual_ConsoleData ** + @@ -568,7 +621,8 @@ A container for a guest's console data [consoleIpAddressFlag]: #consoleipaddressflag #### [consoleIpAddressFlag] A flag indicating a computing instance's console IP address is assigned. -Type: **boolean** +Type: **boolean** + @@ -578,7 +632,8 @@ A flag indicating a computing instance's console IP address is assigned. [consoleIpAddressRecord]: #consoleipaddressrecord #### [consoleIpAddressRecord] A record containing information about a computing instance's console IP and port number. -Type: **SoftLayer_Virtual_Guest_Network_Component_IpAddress ** +Type: **SoftLayer_Virtual_Guest_Network_Component_IpAddress ** + @@ -588,7 +643,8 @@ A record containing information about a computing instance's console IP and port [continuousDataProtectionSoftwareComponent]: #continuousdataprotectionsoftwarecomponent #### [continuousDataProtectionSoftwareComponent] A continuous data protection software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -598,7 +654,8 @@ A continuous data protection software component object. [controlPanel]: #controlpanel #### [controlPanel] A guest's control panel. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -608,7 +665,8 @@ A guest's control panel. [currentBandwidthSummary]: #currentbandwidthsummary #### [currentBandwidthSummary] An object that provides commonly used bandwidth summary components for the current billing cycle. -Type: **SoftLayer_Metric_Tracking_Object_Bandwidth_Summary ** +Type: **SoftLayer_Metric_Tracking_Object_Bandwidth_Summary ** + @@ -618,7 +676,8 @@ An object that provides commonly used bandwidth summary components for the curre [datacenter]: #datacenter #### [datacenter] The datacenter that a virtual guest resides in. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -628,7 +687,8 @@ The datacenter that a virtual guest resides in. [dedicatedHost]: #dedicatedhost #### [dedicatedHost] The dedicated host associated with this guest. -Type: **SoftLayer_Virtual_DedicatedHost ** +Type: **SoftLayer_Virtual_DedicatedHost ** + @@ -638,7 +698,8 @@ The dedicated host associated with this guest. [evaultNetworkStorage]: #evaultnetworkstorage #### [evaultNetworkStorage] A guest's associated EVault network storage service account. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -648,7 +709,8 @@ A guest's associated EVault network storage service account. [firewallServiceComponent]: #firewallservicecomponent #### [firewallServiceComponent] A computing instance's hardware firewall services. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -658,7 +720,8 @@ A computing instance's hardware firewall services. [frontendNetworkComponents]: #frontendnetworkcomponents #### [frontendNetworkComponents] A guest's frontend network components. -Type: **SoftLayer_Virtual_Guest_Network_Component[] ** +Type: **SoftLayer_Virtual_Guest_Network_Component[] ** + @@ -668,7 +731,8 @@ A guest's frontend network components. [frontendRouters]: #frontendrouters #### [frontendRouters] A guest's frontend or public router. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -678,7 +742,8 @@ A guest's frontend or public router. [globalIdentifier]: #globalidentifier #### [globalIdentifier] A guest's universally unique identifier. -Type: **string** +Type: **string** + @@ -688,7 +753,8 @@ A guest's universally unique identifier. [gpuCount]: #gpucount #### [gpuCount] The number of GPUs attached to the guest. -Type: **integer** +Type: **integer** + @@ -698,7 +764,8 @@ The number of GPUs attached to the guest. [gpuType]: #gputype #### [gpuType] The name of the GPU type attached to the guest. -Type: **string** +Type: **string** + @@ -708,7 +775,8 @@ The name of the GPU type attached to the guest. [guestBootParameter]: #guestbootparameter #### [guestBootParameter] -Type: **SoftLayer_Virtual_Guest_Boot_Parameter ** +Type: **SoftLayer_Virtual_Guest_Boot_Parameter ** + @@ -718,7 +786,8 @@ The name of the GPU type attached to the guest. [hardwareFunctionDescription]: #hardwarefunctiondescription #### [hardwareFunctionDescription] The object's function. -Type: **string** +Type: **string** + @@ -728,7 +797,8 @@ The object's function. [host]: #host #### [host] The virtual host on which a virtual guest resides (available only on private clouds). -Type: **SoftLayer_Virtual_Host ** +Type: **SoftLayer_Virtual_Host ** + @@ -738,7 +808,8 @@ The virtual host on which a virtual guest resides (available only on private clo [hostIpsSoftwareComponent]: #hostipssoftwarecomponent #### [hostIpsSoftwareComponent] A host IPS software component object. -Type: **SoftLayer_Software_Component ** +Type: **SoftLayer_Software_Component ** + @@ -748,7 +819,8 @@ A host IPS software component object. [hourlyBillingFlag]: #hourlybillingflag #### [hourlyBillingFlag] A guest's hourly billing status. -Type: **boolean** +Type: **boolean** + @@ -758,7 +830,8 @@ A guest's hourly billing status. [inboundPrivateBandwidthUsage]: #inboundprivatebandwidthusage #### [inboundPrivateBandwidthUsage] The total private inbound bandwidth for this computing instance for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -768,7 +841,8 @@ The total private inbound bandwidth for this computing instance for the current [inboundPublicBandwidthUsage]: #inboundpublicbandwidthusage #### [inboundPublicBandwidthUsage] The total public inbound bandwidth for this computing instance for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -778,7 +852,8 @@ The total public inbound bandwidth for this computing instance for the current b [internalTagReferences]: #internaltagreferences #### [internalTagReferences] -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** + @@ -788,7 +863,8 @@ The total public inbound bandwidth for this computing instance for the current b [lastKnownPowerState]: #lastknownpowerstate #### [lastKnownPowerState] The last known power state of a virtual guest in the event the guest is turned off outside of IMS or has gone offline. -Type: **SoftLayer_Virtual_Guest_Power_State ** +Type: **SoftLayer_Virtual_Guest_Power_State ** + @@ -798,7 +874,8 @@ The last known power state of a virtual guest in the event the guest is turned o [lastOperatingSystemReload]: #lastoperatingsystemreload #### [lastOperatingSystemReload] The last transaction that a cloud server's operating system was loaded. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -808,7 +885,8 @@ The last transaction that a cloud server's operating system was loaded. [lastTransaction]: #lasttransaction #### [lastTransaction] The last transaction a cloud server had performed. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -818,7 +896,8 @@ The last transaction a cloud server had performed. [latestNetworkMonitorIncident]: #latestnetworkmonitorincident #### [latestNetworkMonitorIncident] A virtual guest's latest network monitoring incident. -Type: **SoftLayer_Network_Monitor_Version1_Incident ** +Type: **SoftLayer_Network_Monitor_Version1_Incident ** + @@ -828,7 +907,8 @@ A virtual guest's latest network monitoring incident. [localDiskFlag]: #localdiskflag #### [localDiskFlag] A flag indicating that the virtual guest has at least one disk which is local to the host it runs on. This does not include a SWAP device. -Type: **boolean** +Type: **boolean** + @@ -838,7 +918,8 @@ A flag indicating that the virtual guest has at least one disk which is local to [location]: #location #### [location] Where guest is located within SoftLayer's location hierarchy. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -848,7 +929,8 @@ Where guest is located within SoftLayer's location hierarchy. [managedResourceFlag]: #managedresourceflag #### [managedResourceFlag] A flag indicating that the virtual guest is a managed resource. -Type: **boolean** +Type: **boolean** + @@ -858,7 +940,8 @@ A flag indicating that the virtual guest is a managed resource. [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] A guest's metric tracking object. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -868,7 +951,8 @@ A guest's metric tracking object. [metricTrackingObjectId]: #metrictrackingobjectid #### [metricTrackingObjectId] The metric tracking object id for this guest. -Type: **integer** +Type: **integer** + @@ -878,7 +962,8 @@ The metric tracking object id for this guest. [monitoringRobot]: #monitoringrobot #### [monitoringRobot] -Type: **SoftLayer_Monitoring_Robot ** +Type: **SoftLayer_Monitoring_Robot ** + @@ -888,7 +973,8 @@ The metric tracking object id for this guest. [monitoringServiceComponent]: #monitoringservicecomponent #### [monitoringServiceComponent] A virtual guest's network monitoring services. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host_Stratum ** + @@ -898,7 +984,8 @@ A virtual guest's network monitoring services. [monitoringServiceEligibilityFlag]: #monitoringserviceeligibilityflag #### [monitoringServiceEligibilityFlag] -Type: **boolean** +Type: **boolean** + @@ -908,7 +995,8 @@ A virtual guest's network monitoring services. [monitoringUserNotification]: #monitoringusernotification #### [monitoringUserNotification] The monitoring notification objects for this guest. Each object links this guest instance to a user account that will be notified if monitoring on this guest object fails -Type: **SoftLayer_User_Customer_Notification_Virtual_Guest[] ** +Type: **SoftLayer_User_Customer_Notification_Virtual_Guest[] ** + @@ -918,7 +1006,8 @@ The monitoring notification objects for this guest. Each object links this guest [networkComponents]: #networkcomponents #### [networkComponents] A guests's network components. -Type: **SoftLayer_Virtual_Guest_Network_Component[] ** +Type: **SoftLayer_Virtual_Guest_Network_Component[] ** + @@ -928,7 +1017,8 @@ A guests's network components. [networkMonitorIncidents]: #networkmonitorincidents #### [networkMonitorIncidents] All of a virtual guest's network monitoring incidents. -Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** +Type: **SoftLayer_Network_Monitor_Version1_Incident[] ** + @@ -938,7 +1028,8 @@ All of a virtual guest's network monitoring incidents. [networkMonitors]: #networkmonitors #### [networkMonitors] A guests's network monitors. -Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** +Type: **SoftLayer_Network_Monitor_Version1_Query_Host[] ** + @@ -948,7 +1039,8 @@ A guests's network monitors. [networkStorage]: #networkstorage #### [networkStorage] A guest's associated network storage accounts. -Type: **SoftLayer_Network_Storage[] ** +Type: **SoftLayer_Network_Storage[] ** + @@ -958,7 +1050,8 @@ A guest's associated network storage accounts. [networkVlans]: #networkvlans #### [networkVlans] The network Vlans that a guest's network components are associated with. -Type: **SoftLayer_Network_Vlan[] ** +Type: **SoftLayer_Network_Vlan[] ** + @@ -968,7 +1061,8 @@ The network Vlans that a guest's network components are associated with. [openCancellationTicket]: #opencancellationticket #### [openCancellationTicket] An open ticket requesting cancellation of this server, if one exists. -Type: **SoftLayer_Ticket ** +Type: **SoftLayer_Ticket ** + @@ -978,7 +1072,8 @@ An open ticket requesting cancellation of this server, if one exists. [operatingSystem]: #operatingsystem #### [operatingSystem] A guest's operating system. -Type: **SoftLayer_Software_Component_OperatingSystem ** +Type: **SoftLayer_Software_Component_OperatingSystem ** + @@ -988,7 +1083,8 @@ A guest's operating system. [operatingSystemReferenceCode]: #operatingsystemreferencecode #### [operatingSystemReferenceCode] A guest's operating system software description. -Type: **string** +Type: **string** + @@ -998,7 +1094,8 @@ A guest's operating system software description. [orderedPackageId]: #orderedpackageid #### [orderedPackageId] The original package id provided with the order for a Cloud Computing Instance. -Type: **string** +Type: **string** + @@ -1008,7 +1105,8 @@ The original package id provided with the order for a Cloud Computing Instance. [outboundPrivateBandwidthUsage]: #outboundprivatebandwidthusage #### [outboundPrivateBandwidthUsage] The total private outbound bandwidth for this computing instance for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -1018,7 +1116,8 @@ The total private outbound bandwidth for this computing instance for the current [outboundPublicBandwidthUsage]: #outboundpublicbandwidthusage #### [outboundPublicBandwidthUsage] The total public outbound bandwidth for this computing instance for the current billing cycle. -Type: **decimal** +Type: **decimal** + @@ -1028,7 +1127,8 @@ The total public outbound bandwidth for this computing instance for the current [overBandwidthAllocationFlag]: #overbandwidthallocationflag #### [overBandwidthAllocationFlag] Whether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation. -Type: **integer** +Type: **integer** + @@ -1038,7 +1138,8 @@ Whether the bandwidth usage for this computing instance for the current billing [pendingMigrationFlag]: #pendingmigrationflag #### [pendingMigrationFlag] When true this virtual guest must be migrated using SoftLayer_Virtual_Guest::migrate. -Type: **boolean** +Type: **boolean** + @@ -1048,7 +1149,8 @@ When true this virtual guest must be migrated using SoftLayer_Virtual_Guest::mig [placementGroup]: #placementgroup #### [placementGroup] The placement group that a virtual guest belongs to. -Type: **SoftLayer_Virtual_PlacementGroup ** +Type: **SoftLayer_Virtual_PlacementGroup ** + @@ -1058,7 +1160,8 @@ The placement group that a virtual guest belongs to. [powerState]: #powerstate #### [powerState] The current power state of a virtual guest. -Type: **SoftLayer_Virtual_Guest_Power_State ** +Type: **SoftLayer_Virtual_Guest_Power_State ** + @@ -1068,7 +1171,8 @@ The current power state of a virtual guest. [primaryBackendIpAddress]: #primarybackendipaddress #### [primaryBackendIpAddress] A guest's primary private IP address. -Type: **string** +Type: **string** + @@ -1078,7 +1182,8 @@ A guest's primary private IP address. [primaryBackendNetworkComponent]: #primarybackendnetworkcomponent #### [primaryBackendNetworkComponent] A guest's primary backend network component. -Type: **SoftLayer_Virtual_Guest_Network_Component ** +Type: **SoftLayer_Virtual_Guest_Network_Component ** + @@ -1088,7 +1193,8 @@ A guest's primary backend network component. [primaryIpAddress]: #primaryipaddress #### [primaryIpAddress] The guest's primary public IP address. -Type: **string** +Type: **string** + @@ -1098,7 +1204,8 @@ The guest's primary public IP address. [primaryNetworkComponent]: #primarynetworkcomponent #### [primaryNetworkComponent] A guest's primary public network component. -Type: **SoftLayer_Virtual_Guest_Network_Component ** +Type: **SoftLayer_Virtual_Guest_Network_Component ** + @@ -1108,7 +1215,8 @@ A guest's primary public network component. [privateNetworkOnlyFlag]: #privatenetworkonlyflag #### [privateNetworkOnlyFlag] Whether the computing instance only has access to the private network. -Type: **boolean** +Type: **boolean** + @@ -1118,7 +1226,8 @@ Whether the computing instance only has access to the private network. [projectedOverBandwidthAllocationFlag]: #projectedoverbandwidthallocationflag #### [projectedOverBandwidthAllocationFlag] Whether the bandwidth usage for this computing instance for the current billing cycle is projected to exceed the allocation. -Type: **integer** +Type: **integer** + @@ -1128,7 +1237,8 @@ Whether the bandwidth usage for this computing instance for the current billing [projectedPublicBandwidthUsage]: #projectedpublicbandwidthusage #### [projectedPublicBandwidthUsage] The projected public outbound bandwidth for this computing instance for the current billing cycle. -Type: **float** +Type: **float** + @@ -1138,7 +1248,8 @@ The projected public outbound bandwidth for this computing instance for the curr [recentEvents]: #recentevents #### [recentEvents] Recent events that impact this computing instance. -Type: **SoftLayer_Notification_Occurrence_Event[] ** +Type: **SoftLayer_Notification_Occurrence_Event[] ** + @@ -1148,7 +1259,8 @@ Recent events that impact this computing instance. [regionalGroup]: #regionalgroup #### [regionalGroup] The regional group this guest is in. -Type: **SoftLayer_Location_Group_Regional ** +Type: **SoftLayer_Location_Group_Regional ** + @@ -1158,7 +1270,8 @@ The regional group this guest is in. [regionalInternetRegistry]: #regionalinternetregistry #### [regionalInternetRegistry] -Type: **SoftLayer_Network_Regional_Internet_Registry ** +Type: **SoftLayer_Network_Regional_Internet_Registry ** + @@ -1168,7 +1281,8 @@ The regional group this guest is in. [reservedCapacityGroup]: #reservedcapacitygroup #### [reservedCapacityGroup] The reserved capacity group the guest is associated with. -Type: **SoftLayer_Virtual_ReservedCapacityGroup ** +Type: **SoftLayer_Virtual_ReservedCapacityGroup ** + @@ -1178,7 +1292,8 @@ The reserved capacity group the guest is associated with. [reservedCapacityGroupFlag]: #reservedcapacitygroupflag #### [reservedCapacityGroupFlag] Flag to indicate whether or not a guest is part of a reserved capacity group. -Type: **boolean** +Type: **boolean** + @@ -1188,7 +1303,8 @@ Flag to indicate whether or not a guest is part of a reserved capacity group. [reservedCapacityGroupInstance]: #reservedcapacitygroupinstance #### [reservedCapacityGroupInstance] The reserved capacity group instance the guest is associated with. -Type: **SoftLayer_Virtual_ReservedCapacityGroup_Instance ** +Type: **SoftLayer_Virtual_ReservedCapacityGroup_Instance ** + @@ -1198,7 +1314,8 @@ The reserved capacity group instance the guest is associated with. [scaleAssets]: #scaleassets #### [scaleAssets] Collection of scale assets this guest corresponds to. -Type: **SoftLayer_Scale_Asset[] ** +Type: **SoftLayer_Scale_Asset[] ** + @@ -1208,7 +1325,8 @@ Collection of scale assets this guest corresponds to. [scaleMember]: #scalemember #### [scaleMember] The scale member for this guest, if applicable. -Type: **SoftLayer_Scale_Member_Virtual_Guest ** +Type: **SoftLayer_Scale_Member_Virtual_Guest ** + @@ -1218,7 +1336,8 @@ The scale member for this guest, if applicable. [scaledFlag]: #scaledflag #### [scaledFlag] Whether or not this guest is a member of a scale group and was automatically created as part of a scale group action. -Type: **boolean** +Type: **boolean** + @@ -1228,7 +1347,8 @@ Whether or not this guest is a member of a scale group and was automatically cre [securityScanRequests]: #securityscanrequests #### [securityScanRequests] A guest's vulnerability scan requests. -Type: **SoftLayer_Network_Security_Scanner_Request[] ** +Type: **SoftLayer_Network_Security_Scanner_Request[] ** + @@ -1238,7 +1358,8 @@ A guest's vulnerability scan requests. [serverRoom]: #serverroom #### [serverRoom] The server room that a guest is located at. There may be more than one server room for every data center. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -1248,7 +1369,8 @@ The server room that a guest is located at. There may be more than one server ro [softwareComponents]: #softwarecomponents #### [softwareComponents] A guest's installed software. -Type: **SoftLayer_Software_Component[] ** +Type: **SoftLayer_Software_Component[] ** + @@ -1258,7 +1380,8 @@ A guest's installed software. [sshKeys]: #sshkeys #### [sshKeys] SSH keys to be installed on the server during provisioning or an OS reload. -Type: **SoftLayer_Security_Ssh_Key[] ** +Type: **SoftLayer_Security_Ssh_Key[] ** + @@ -1268,7 +1391,8 @@ SSH keys to be installed on the server during provisioning or an OS reload. [status]: #status #### [status] A computing instance's status. -Type: **SoftLayer_Virtual_Guest_Status ** +Type: **SoftLayer_Virtual_Guest_Status ** + @@ -1278,7 +1402,8 @@ A computing instance's status. [tagReferences]: #tagreferences #### [tagReferences] -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** + @@ -1288,7 +1413,8 @@ A computing instance's status. [transientGuestFlag]: #transientguestflag #### [transientGuestFlag] Whether or not a computing instance is a Transient Instance. -Type: **boolean** +Type: **boolean** + @@ -1298,7 +1424,8 @@ Whether or not a computing instance is a Transient Instance. [transientWebhookURI]: #transientwebhookuri #### [transientWebhookURI] The endpoint used to notify customers their transient guest is terminating. -Type: **SoftLayer_Virtual_Guest_Attribute ** +Type: **SoftLayer_Virtual_Guest_Attribute ** + @@ -1308,7 +1435,8 @@ The endpoint used to notify customers their transient guest is terminating. [type]: #type #### [type] The type of this virtual guest. -Type: **SoftLayer_Virtual_Guest_Type ** +Type: **SoftLayer_Virtual_Guest_Type ** + @@ -1318,7 +1446,8 @@ The type of this virtual guest. [upgradeRequest]: #upgraderequest #### [upgradeRequest] A computing instance's associated upgrade request object if any. -Type: **SoftLayer_Product_Upgrade_Request ** +Type: **SoftLayer_Product_Upgrade_Request ** + @@ -1328,7 +1457,8 @@ A computing instance's associated upgrade request object if any. [userData]: #userdata #### [userData] A base64 encoded string containing custom user data for a Cloud Computing Instance order. -Type: **SoftLayer_Virtual_Guest_Attribute[] ** +Type: **SoftLayer_Virtual_Guest_Attribute[] ** + @@ -1338,7 +1468,8 @@ A base64 encoded string containing custom user data for a Cloud Computing Instan [users]: #users #### [users] A list of users that have access to this computing instance. -Type: **SoftLayer_User_Customer[] ** +Type: **SoftLayer_User_Customer[] ** + @@ -1348,7 +1479,8 @@ A list of users that have access to this computing instance. [virtualRack]: #virtualrack #### [virtualRack] The name of the bandwidth allotment that a hardware belongs too. -Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** +Type: **SoftLayer_Network_Bandwidth_Version1_Allotment ** + @@ -1358,7 +1490,8 @@ The name of the bandwidth allotment that a hardware belongs too. [virtualRackId]: #virtualrackid #### [virtualRackId] The id of the bandwidth allotment that a computing instance belongs too. -Type: **integer** +Type: **integer** + @@ -1368,7 +1501,8 @@ The id of the bandwidth allotment that a computing instance belongs too. [virtualRackName]: #virtualrackname #### [virtualRackName] The name of the bandwidth allotment that a computing instance belongs too. -Type: **string** +Type: **string** + @@ -1380,7 +1514,8 @@ The name of the bandwidth allotment that a computing instance belongs too. [activeNetworkMonitorIncidentCount]: #activenetworkmonitorincidentcount #### [activeNetworkMonitorIncidentCount] A count of a virtual guest's currently active network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -1390,7 +1525,8 @@ A count of a virtual guest's currently active network monitoring incidents. [activeTicketCount]: #activeticketcount #### [activeTicketCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1400,7 +1536,8 @@ A count of [activeTransactionCount]: #activetransactioncount #### [activeTransactionCount] A count of any active transaction(s) that are currently running for the server (example: os reload). -Type: **unsigned long** +Type: **unsigned long** + @@ -1410,7 +1547,8 @@ A count of any active transaction(s) that are currently running for the server ( [allowedNetworkStorageCount]: #allowednetworkstoragecount #### [allowedNetworkStorageCount] A count of the SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1420,7 +1558,8 @@ A count of the SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Gue [allowedNetworkStorageReplicaCount]: #allowednetworkstoragereplicacount #### [allowedNetworkStorageReplicaCount] A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1430,7 +1569,8 @@ A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLay [attributeCount]: #attributecount #### [attributeCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1440,7 +1580,8 @@ A count of [availableMonitoringCount]: #availablemonitoringcount #### [availableMonitoringCount] A count of an object that stores the maximum level for the monitoring query types and response types. -Type: **unsigned long** +Type: **unsigned long** + @@ -1450,7 +1591,8 @@ A count of an object that stores the maximum level for the monitoring query type [backendNetworkComponentCount]: #backendnetworkcomponentcount #### [backendNetworkComponentCount] A count of a guests's backend network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1460,7 +1602,8 @@ A count of a guests's backend network components. [backendRouterCount]: #backendroutercount #### [backendRouterCount] A count of a guest's backend or private router. -Type: **unsigned long** +Type: **unsigned long** + @@ -1470,7 +1613,8 @@ A count of a guest's backend or private router. [billingCycleBandwidthUsageCount]: #billingcyclebandwidthusagecount #### [billingCycleBandwidthUsageCount] A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1480,7 +1624,8 @@ A count of the raw bandwidth usage data for the current billing cycle. One objec [blockDeviceCount]: #blockdevicecount #### [blockDeviceCount] A count of a computing instance's block devices. Block devices link [SoftLayer_Virtual_Disk_Image]({{}}) to computing instances. -Type: **unsigned long** +Type: **unsigned long** + @@ -1490,7 +1635,8 @@ A count of a computing instance's block devices. Block devices link [SoftLayer_V [browserConsoleAccessLogCount]: #browserconsoleaccesslogcount #### [browserConsoleAccessLogCount] A count of a virtual guest's browser access logs. -Type: **unsigned long** +Type: **unsigned long** + @@ -1500,7 +1646,8 @@ A count of a virtual guest's browser access logs. [evaultNetworkStorageCount]: #evaultnetworkstoragecount #### [evaultNetworkStorageCount] A count of a guest's associated EVault network storage service account. -Type: **unsigned long** +Type: **unsigned long** + @@ -1510,7 +1657,8 @@ A count of a guest's associated EVault network storage service account. [frontendNetworkComponentCount]: #frontendnetworkcomponentcount #### [frontendNetworkComponentCount] A count of a guest's frontend network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1520,7 +1668,8 @@ A count of a guest's frontend network components. [internalTagReferenceCount]: #internaltagreferencecount #### [internalTagReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1530,7 +1679,8 @@ A count of [monitoringUserNotificationCount]: #monitoringusernotificationcount #### [monitoringUserNotificationCount] A count of the monitoring notification objects for this guest. Each object links this guest instance to a user account that will be notified if monitoring on this guest object fails -Type: **unsigned long** +Type: **unsigned long** + @@ -1540,7 +1690,8 @@ A count of the monitoring notification objects for this guest. Each object links [networkComponentCount]: #networkcomponentcount #### [networkComponentCount] A count of a guests's network components. -Type: **unsigned long** +Type: **unsigned long** + @@ -1550,7 +1701,8 @@ A count of a guests's network components. [networkMonitorCount]: #networkmonitorcount #### [networkMonitorCount] A count of a guests's network monitors. -Type: **unsigned long** +Type: **unsigned long** + @@ -1560,7 +1712,8 @@ A count of a guests's network monitors. [networkMonitorIncidentCount]: #networkmonitorincidentcount #### [networkMonitorIncidentCount] A count of all of a virtual guest's network monitoring incidents. -Type: **unsigned long** +Type: **unsigned long** + @@ -1570,7 +1723,8 @@ A count of all of a virtual guest's network monitoring incidents. [networkStorageCount]: #networkstoragecount #### [networkStorageCount] A count of a guest's associated network storage accounts. -Type: **unsigned long** +Type: **unsigned long** + @@ -1580,7 +1734,8 @@ A count of a guest's associated network storage accounts. [networkVlanCount]: #networkvlancount #### [networkVlanCount] A count of the network Vlans that a guest's network components are associated with. -Type: **unsigned long** +Type: **unsigned long** + @@ -1590,7 +1745,8 @@ A count of the network Vlans that a guest's network components are associated wi [recentEventCount]: #recenteventcount #### [recentEventCount] A count of recent events that impact this computing instance. -Type: **unsigned long** +Type: **unsigned long** + @@ -1600,7 +1756,8 @@ A count of recent events that impact this computing instance. [scaleAssetCount]: #scaleassetcount #### [scaleAssetCount] A count of collection of scale assets this guest corresponds to. -Type: **unsigned long** +Type: **unsigned long** + @@ -1610,7 +1767,8 @@ A count of collection of scale assets this guest corresponds to. [securityScanRequestCount]: #securityscanrequestcount #### [securityScanRequestCount] A count of a guest's vulnerability scan requests. -Type: **unsigned long** +Type: **unsigned long** + @@ -1620,7 +1778,8 @@ A count of a guest's vulnerability scan requests. [softwareComponentCount]: #softwarecomponentcount #### [softwareComponentCount] A count of a guest's installed software. -Type: **unsigned long** +Type: **unsigned long** + @@ -1630,7 +1789,8 @@ A count of a guest's installed software. [sshKeyCount]: #sshkeycount #### [sshKeyCount] A count of sSH keys to be installed on the server during provisioning or an OS reload. -Type: **unsigned long** +Type: **unsigned long** + @@ -1640,7 +1800,8 @@ A count of sSH keys to be installed on the server during provisioning or an OS r [tagReferenceCount]: #tagreferencecount #### [tagReferenceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -1650,7 +1811,8 @@ A count of [userCount]: #usercount #### [userCount] A count of a list of users that have access to this computing instance. -Type: **unsigned long** +Type: **unsigned long** + @@ -1660,7 +1822,8 @@ A count of a list of users that have access to this computing instance. [userDataCount]: #userdatacount #### [userDataCount] A count of a base64 encoded string containing custom user data for a Cloud Computing Instance order. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Attribute/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Attribute/_index.md index a6ba45632d..f00d9aef79 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Attribute/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Attribute/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [value]: #value #### [value] A guest attribute's value. -Type: **string** +Type: **string** +
              @@ -61,7 +64,8 @@ A guest attribute's value. [guest]: #guest #### [guest] -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** +
              @@ -71,7 +75,8 @@ A guest attribute's value. [type]: #type #### [type] -Type: **SoftLayer_Virtual_Guest_Attribute_Type ** +Type: **SoftLayer_Virtual_Guest_Attribute_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Attribute_Type/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Attribute_Type/_index.md index f5e10e12c0..afa18b57e2 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Attribute_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Attribute_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [keyname]: #keyname #### [keyname] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
              diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Attribute_UserData/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Attribute_UserData/_index.md index 47c2475886..5139e85214 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Attribute_UserData/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Attribute_UserData/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [value]: #value #### [value] A guest attribute's value. -Type: **string** +Type: **string** +
              @@ -61,7 +64,8 @@ A guest attribute's value. [guest]: #guest #### [guest] -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** +
              @@ -71,7 +75,8 @@ A guest attribute's value. [type]: #type #### [type] -Type: **SoftLayer_Virtual_Guest_Attribute_Type ** +Type: **SoftLayer_Virtual_Guest_Attribute_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device/_index.md index e5e348c32a..d2b7f0ebb4 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -47,7 +49,8 @@ A guest, also known as a virtual server, represents an allocation of resources o [bootableFlag]: #bootableflag #### [bootableFlag] A flag indicating if a block device can be booted from. -Type: **integer** +Type: **integer** + @@ -57,7 +60,8 @@ A flag indicating if a block device can be booted from. [createDate]: #createdate #### [createDate] The date a block device was created. -Type: **dateTime** +Type: **dateTime** + @@ -67,7 +71,8 @@ The date a block device was created. [device]: #device #### [device] A name used to identify a block device. -Type: **string** +Type: **string** + @@ -77,7 +82,8 @@ A name used to identify a block device. [diskImageId]: #diskimageid #### [diskImageId] A block device [SoftLayer_Virtual_Disk_Image]({{}})'s unique ID. -Type: **integer** +Type: **integer** + @@ -87,7 +93,8 @@ A block device [SoftLayer_Virtual_Disk_Image]({{}}) that a block device is associated with. -Type: **integer** +Type: **integer** + @@ -97,7 +104,8 @@ The [SoftLayer_Virtual_Guest]({{Type: **integer** +Type: **integer** + @@ -107,7 +115,8 @@ A flag indicating if a block device can be plugged into a computing instance wit [id]: #id #### [id] A computing instance block device's unique ID. -Type: **integer** +Type: **integer** + @@ -117,7 +126,8 @@ A computing instance block device's unique ID. [modifyDate]: #modifydate #### [modifyDate] The data a block device was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -127,7 +137,8 @@ The data a block device was last modified. [mountMode]: #mountmode #### [mountMode] The writing mode that a virtual block device is mounted as, either "RO" for read-only mode or "RW" for read and write mode. -Type: **string** +Type: **string** + @@ -137,7 +148,8 @@ The writing mode that a virtual block device is mounted as, either "RO" for read [mountType]: #mounttype #### [mountType] The type of device that a virtual block device is mounted as, either "Disk" for a directly connected storage disk or "CD" for devices that are mounted as optical drives.. -Type: **string** +Type: **string** + @@ -147,7 +159,8 @@ The type of device that a virtual block device is mounted as, either "Disk" for [statusId]: #statusid #### [statusId] The status of the device, either disconnected or connected -Type: **integer** +Type: **integer** + @@ -157,7 +170,8 @@ The status of the device, either disconnected or connected [uuid]: #uuid #### [uuid] A block device's unique ID on a virtualization platform. -Type: **string** +Type: **string** + @@ -173,7 +187,8 @@ A block device's unique ID on a virtualization platform. [diskImage]: #diskimage #### [diskImage] The disk image that a block device connects to in a computing instance. -Type: **SoftLayer_Virtual_Disk_Image ** +Type: **SoftLayer_Virtual_Disk_Image ** + @@ -183,7 +198,8 @@ The disk image that a block device connects to in a computing instance. [guest]: #guest #### [guest] The computing instance that this block device is attached to. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -193,7 +209,8 @@ The computing instance that this block device is attached to. [status]: #status #### [status] -Type: **SoftLayer_Virtual_Guest_Block_Device_Status ** +Type: **SoftLayer_Virtual_Guest_Block_Device_Status ** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Status/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Status/_index.md index 166bd7f7a8..b839d68590 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Status/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
              diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Template/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Template/_index.md index a00cb16b1a..6e491946a1 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Template/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Template/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -47,7 +49,8 @@ A virtual block device template, also known as a image template, represents the [device]: #device #### [device] A name that identifies a block device template. -Type: **string** +Type: **string** + @@ -57,7 +60,8 @@ A name that identifies a block device template. [diskImageId]: #diskimageid #### [diskImageId] A block device template's [SoftLayer_Virtual_Disk_Image]({{}}) ID. -Type: **integer** +Type: **integer** + @@ -67,7 +71,8 @@ A block device template's [SoftLayer_Virtual_Disk_Image]({{Type: **float** +Type: **float** + @@ -77,7 +82,8 @@ The amount of disk space that a block device template is using. Use this number [groupId]: #groupid #### [groupId] A block device template's [SoftLayer_Virtual_Guest_Block_Device_Template_Group]({{}}) ID. -Type: **integer** +Type: **integer** + @@ -87,7 +93,8 @@ A block device template's [SoftLayer_Virtual_Guest_Block_Device_Template_Group]( [id]: #id #### [id] A block device template's unique ID. -Type: **integer** +Type: **integer** + @@ -97,7 +104,8 @@ A block device template's unique ID. [units]: #units #### [units] The units that will be used with the disk space property to identify the amount of disk space used. -Type: **string** +Type: **string** + @@ -113,7 +121,8 @@ The units that will be used with the disk space property to identify the amount [diskImage]: #diskimage #### [diskImage] A block device template's disk image. -Type: **SoftLayer_Virtual_Disk_Image ** +Type: **SoftLayer_Virtual_Disk_Image ** + @@ -123,7 +132,8 @@ A block device template's disk image. [group]: #group #### [group] A block device template's group. Several block device templates can be combined together into a group for archiving purposes. -Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group ** +Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group ** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Template_Group/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Template_Group/_index.md index 55b1c1e09e..670957aaa4 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Template_Group/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Template_Group/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -47,7 +49,8 @@ A virtual block device template group, also known as an image template group, re [accountId]: #accountid #### [accountId] A block device template group's [SoftLayer_Account]({{}}) ID -Type: **integer** +Type: **integer** + @@ -57,7 +60,8 @@ A block device template group's [SoftLayer_Account]({{Type: **dateTime** +Type: **dateTime** + @@ -67,7 +71,8 @@ The date a block device template group was created. [id]: #id #### [id] A block device template group's unique ID. -Type: **integer** +Type: **integer** + @@ -77,7 +82,8 @@ A block device template group's unique ID. [name]: #name #### [name] A user definable and optional name of a block device template group. -Type: **string** +Type: **string** + @@ -87,7 +93,8 @@ A user definable and optional name of a block device template group. [note]: #note #### [note] A block device template group's user defined note. -Type: **string** +Type: **string** + @@ -97,7 +104,8 @@ A block device template group's user defined note. [parentId]: #parentid #### [parentId] A block device template group's [SoftLayer_Virtual_Guest_Block_Device_Template_Group]({{}}) ID. This will only be set when a template group is created from a previously existing template group -Type: **integer** +Type: **integer** + @@ -107,7 +115,8 @@ A block device template group's [SoftLayer_Virtual_Guest_Block_Device_Template_G [publicFlag]: #publicflag #### [publicFlag] -Type: **integer** +Type: **integer** + @@ -117,7 +126,8 @@ A block device template group's [SoftLayer_Virtual_Guest_Block_Device_Template_G [statusId]: #statusid #### [statusId] A block device template group's [SoftLayer_Virtual_Guest_Block_Device_Template_Group_Status]({{}}) ID -Type: **integer** +Type: **integer** + @@ -127,7 +137,8 @@ A block device template group's [SoftLayer_Virtual_Guest_Block_Device_Template_G [summary]: #summary #### [summary] A block device template group's user defined summary. -Type: **string** +Type: **string** + @@ -137,7 +148,8 @@ A block device template group's user defined summary. [transactionId]: #transactionid #### [transactionId] A block device template group's [SoftLayer_Provisioning_Version1_Transaction]({{}}) ID. This will only be set when there is a transaction being performed on the block device template group. -Type: **integer** +Type: **integer** + @@ -147,7 +159,8 @@ A block device template group's [SoftLayer_Provisioning_Version1_Transaction]({{ [userRecordId]: #userrecordid #### [userRecordId] A block device template group's [SoftLayer_User_Customer]({{}}) ID -Type: **integer** +Type: **integer** + @@ -163,7 +176,8 @@ A block device template group's [SoftLayer_User_Customer]({{}}). -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -173,7 +187,8 @@ A block device template group's [SoftLayer_Account]({{Type: **SoftLayer_Account_Contact[] ** +Type: **SoftLayer_Account_Contact[] ** + @@ -183,7 +198,8 @@ A block device template group's [SoftLayer_Account]({{Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group_Accounts[] ** +Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group_Accounts[] ** + @@ -193,7 +209,8 @@ The accounts which may have read-only access to an image template group. Will on [blockDevices]: #blockdevices #### [blockDevices] The block devices that are part of an image template group -Type: **SoftLayer_Virtual_Guest_Block_Device_Template[] ** +Type: **SoftLayer_Virtual_Guest_Block_Device_Template[] ** + @@ -203,7 +220,8 @@ The block devices that are part of an image template group [blockDevicesDiskSpaceTotal]: #blockdevicesdiskspacetotal #### [blockDevicesDiskSpaceTotal] The total disk space of all images in a image template group. -Type: **float** +Type: **float** + @@ -213,7 +231,8 @@ The total disk space of all images in a image template group. [byolFlag]: #byolflag #### [byolFlag] A flag indicating that customer is providing the software licenses. -Type: **boolean** +Type: **boolean** + @@ -223,7 +242,8 @@ A flag indicating that customer is providing the software licenses. [children]: #children #### [children] The image template groups that are clones of an image template group. -Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group[] ** +Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group[] ** + @@ -233,7 +253,8 @@ The image template groups that are clones of an image template group. [datacenter]: #datacenter #### [datacenter] The location containing this image template group. Will only be populated for child template group objects. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -243,7 +264,8 @@ The location containing this image template group. Will only be populated for ch [datacenters]: #datacenters #### [datacenters] A collection of locations containing a copy of this image template group. Will only be populated for parent template group objects. -Type: **SoftLayer_Location[] ** +Type: **SoftLayer_Location[] ** + @@ -253,7 +275,8 @@ A collection of locations containing a copy of this image template group. Will o [firstChild]: #firstchild #### [firstChild] The first clone of the image template group -Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group ** +Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group ** + @@ -263,7 +286,8 @@ The first clone of the image template group [flexImageFlag]: #fleximageflag #### [flexImageFlag] A flag indicating if this is a flex image. -Type: **boolean** +Type: **boolean** + @@ -273,7 +297,8 @@ A flag indicating if this is a flex image. [globalIdentifier]: #globalidentifier #### [globalIdentifier] An image template's universally unique identifier. -Type: **string** +Type: **string** + @@ -283,7 +308,8 @@ An image template's universally unique identifier. [imageType]: #imagetype #### [imageType] The virtual disk image type of this template. Value will be populated on parent and child, but only supports object filtering on the parent. -Type: **SoftLayer_Virtual_Disk_Image_Type ** +Type: **SoftLayer_Virtual_Disk_Image_Type ** + @@ -293,7 +319,8 @@ The virtual disk image type of this template. Value will be populated on parent [imageTypeKeyName]: #imagetypekeyname #### [imageTypeKeyName] The virtual disk image type keyname (e.g. SYSTEM, DISK_CAPTURE, ISO, etc) of this template. Value will be populated on parent and child, but only supports object filtering on the parent. -Type: **string** +Type: **string** + @@ -303,7 +330,8 @@ The virtual disk image type keyname (e.g. SYSTEM, DISK_CAPTURE, ISO, etc) of thi [nextGenFlag]: #nextgenflag #### [nextGenFlag] A flag indicating if this is a next generation image. -Type: **boolean** +Type: **boolean** + @@ -313,7 +341,8 @@ A flag indicating if this is a next generation image. [parent]: #parent #### [parent] The image template group that another image template group was cloned from. -Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group ** +Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group ** + @@ -323,7 +352,8 @@ The image template group that another image template group was cloned from. [region]: #region #### [region] -Type: **SoftLayer_Network_Service_Resource ** +Type: **SoftLayer_Network_Service_Resource ** + @@ -333,7 +363,8 @@ The image template group that another image template group was cloned from. [regions]: #regions #### [regions] -Type: **SoftLayer_Network_Service_Resource[] ** +Type: **SoftLayer_Network_Service_Resource[] ** + @@ -343,7 +374,8 @@ The image template group that another image template group was cloned from. [sshKeys]: #sshkeys #### [sshKeys] The ssh keys to be implemented on the server when provisioned or reloaded from an image template group. -Type: **SoftLayer_Security_Ssh_Key[] ** +Type: **SoftLayer_Security_Ssh_Key[] ** + @@ -353,7 +385,8 @@ The ssh keys to be implemented on the server when provisioned or reloaded from a [status]: #status #### [status] A template group's status. -Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group_Status ** +Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group_Status ** + @@ -363,7 +396,8 @@ A template group's status. [storageRepository]: #storagerepository #### [storageRepository] The storage repository that an image template group resides on. -Type: **SoftLayer_Virtual_Storage_Repository ** +Type: **SoftLayer_Virtual_Storage_Repository ** + @@ -373,7 +407,8 @@ The storage repository that an image template group resides on. [tagReferences]: #tagreferences #### [tagReferences] The tags associated with this image template group. -Type: **SoftLayer_Tag_Reference[] ** +Type: **SoftLayer_Tag_Reference[] ** + @@ -383,7 +418,8 @@ The tags associated with this image template group. [transaction]: #transaction #### [transaction] A transaction that is being performed on a image template group. -Type: **SoftLayer_Provisioning_Version1_Transaction ** +Type: **SoftLayer_Provisioning_Version1_Transaction ** + @@ -395,7 +431,8 @@ A transaction that is being performed on a image template group. [accountContactCount]: #accountcontactcount #### [accountContactCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -405,7 +442,8 @@ A count of [accountReferenceCount]: #accountreferencecount #### [accountReferenceCount] A count of the accounts which may have read-only access to an image template group. Will only be populated for parent template group objects. -Type: **unsigned long** +Type: **unsigned long** + @@ -415,7 +453,8 @@ A count of the accounts which may have read-only access to an image template gro [blockDeviceCount]: #blockdevicecount #### [blockDeviceCount] A count of the block devices that are part of an image template group -Type: **unsigned long** +Type: **unsigned long** + @@ -425,7 +464,8 @@ A count of the block devices that are part of an image template group [childrenCount]: #childrencount #### [childrenCount] A count of the image template groups that are clones of an image template group. -Type: **unsigned long** +Type: **unsigned long** + @@ -435,7 +475,8 @@ A count of the image template groups that are clones of an image template group. [datacenterCount]: #datacentercount #### [datacenterCount] A count of a collection of locations containing a copy of this image template group. Will only be populated for parent template group objects. -Type: **unsigned long** +Type: **unsigned long** + @@ -445,7 +486,8 @@ A count of a collection of locations containing a copy of this image template gr [regionCount]: #regioncount #### [regionCount] A count of -Type: **unsigned long** +Type: **unsigned long** + @@ -455,7 +497,8 @@ A count of [sshKeyCount]: #sshkeycount #### [sshKeyCount] A count of the ssh keys to be implemented on the server when provisioned or reloaded from an image template group. -Type: **unsigned long** +Type: **unsigned long** + @@ -465,7 +508,8 @@ A count of the ssh keys to be implemented on the server when provisioned or relo [tagReferenceCount]: #tagreferencecount #### [tagReferenceCount] A count of the tags associated with this image template group. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Template_Group_Accounts/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Template_Group_Accounts/_index.md index dea8881c52..8b9c5d954b 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Template_Group_Accounts/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Template_Group_Accounts/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -59,7 +61,8 @@ It is important to note that this data type should only exist to give accounts a [accountId]: #accountid #### [accountId] The [SoftLayer_Account]({{}}) ID which will have access to an image. -Type: **integer** +Type: **integer** + @@ -69,7 +72,8 @@ The [SoftLayer_Account]({{}}) ID wh [createDate]: #createdate #### [createDate] The date access was granted to an account. -Type: **dateTime** +Type: **dateTime** + @@ -79,7 +83,8 @@ The date access was granted to an account. [groupId]: #groupid #### [groupId] The [SoftLayer_Virtual_Guest_Block_Device_Template_Group]({{}}) ID which access will be granted to. -Type: **integer** +Type: **integer** + @@ -95,7 +100,8 @@ The [SoftLayer_Virtual_Guest_Block_Device_Template_Group]({{}}) that an image template group is shared with. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -105,7 +111,8 @@ The [SoftLayer_Account]({{}}) that [group]: #group #### [group] The [SoftLayer_Virtual_Guest_Block_Device_Template_Group]({{}}) that is shared with an account. -Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group ** +Type: **SoftLayer_Virtual_Guest_Block_Device_Template_Group ** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Template_Group_Status/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Template_Group_Status/_index.md index 97f7622077..b5b1659a82 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Template_Group_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device_Template_Group_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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' @@ -49,7 +51,8 @@ For an operating system reload, the image template will need to have a status of [description]: #description #### [description] -Type: **string** +Type: **string** + @@ -59,7 +62,8 @@ For an operating system reload, the image template will need to have a status of [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** + @@ -69,7 +73,8 @@ For an operating system reload, the image template will need to have a status of [name]: #name #### [name] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Boot_Parameter/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Boot_Parameter/_index.md index 6176e11ff8..201d186cfd 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Boot_Parameter/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Boot_Parameter/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** +
              @@ -55,7 +58,8 @@ classes: [guestBootParameterTypeId]: #guestbootparametertypeid #### [guestBootParameterTypeId] -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ classes: [guestId]: #guestid #### [guestId] -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ classes: [id]: #id #### [id] -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ classes: [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -101,7 +108,8 @@ classes: [guest]: #guest #### [guest] -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -111,7 +119,8 @@ classes: [guestBootParameterType]: #guestbootparametertype #### [guestBootParameterType] -Type: **SoftLayer_Virtual_Guest_Boot_Parameter_Type ** +Type: **SoftLayer_Virtual_Guest_Boot_Parameter_Type ** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Boot_Parameter_Type/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Boot_Parameter_Type/_index.md index 5de9841a2b..1152341e71 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Boot_Parameter_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Boot_Parameter_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,7 +52,8 @@ Describes a virtual guest boot parameter. In this the word class is used in the [bootOption]: #bootoption #### [bootOption] Available boot options. -Type: **string** +Type: **string** + @@ -60,7 +63,8 @@ Available boot options. [createDate]: #createdate #### [createDate] -Type: **dateTime** +Type: **dateTime** + @@ -70,7 +74,8 @@ Available boot options. [description]: #description #### [description] A description of the boot parameter -Type: **string** +Type: **string** + @@ -80,7 +85,8 @@ A description of the boot parameter [id]: #id #### [id] Indentifier for record. -Type: **integer** +Type: **integer** + @@ -90,7 +96,8 @@ Indentifier for record. [keyName]: #keyname #### [keyName] The key name of the boot parameter. -Type: **string** +Type: **string** + @@ -100,7 +107,8 @@ The key name of the boot parameter. [modifyDate]: #modifydate #### [modifyDate] -Type: **dateTime** +Type: **dateTime** + @@ -110,7 +118,8 @@ The key name of the boot parameter. [name]: #name #### [name] The common name of the boot parameter. -Type: **string** +Type: **string** + @@ -120,7 +129,8 @@ The common name of the boot parameter. [value]: #value #### [value] The virtual machine arguments -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component/_index.md index 17167c7196..300bb05751 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -47,7 +49,8 @@ A guest, also known as a virtual server, represents an allocation of resources o [createDate]: #createdate #### [createDate] The date a computing instance's network component was created. -Type: **dateTime** +Type: **dateTime** + @@ -57,7 +60,8 @@ The date a computing instance's network component was created. [guestId]: #guestid #### [guestId] The unique ID of the [SoftLayer_Virtual_Guest]({{}}) that this network component belongs to. -Type: **integer** +Type: **integer** + @@ -67,7 +71,8 @@ The unique ID of the [SoftLayer_Virtual_Guest]({{Type: **integer** +Type: **integer** + @@ -77,7 +82,8 @@ A computing instance's network component's unique ID. [macAddress]: #macaddress #### [macAddress] A computing instance network component's unique MAC address. -Type: **string** +Type: **string** + @@ -87,7 +93,8 @@ A computing instance network component's unique MAC address. [maxSpeed]: #maxspeed #### [maxSpeed] A computing instance network component's maximum allowed speed, measured in Mbit per second. ''maxSpeed'' is determined by the capabilities of the network interface and the port speed purchased on your SoftLayer computing instance. -Type: **integer** +Type: **integer** + @@ -97,7 +104,8 @@ A computing instance network component's maximum allowed speed, measured in Mbit [modifyDate]: #modifydate #### [modifyDate] The date a computing instance's network component was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -107,7 +115,8 @@ The date a computing instance's network component was last modified. [name]: #name #### [name] A computing instance network component's short name. This is usually ''eth''. Use this in conjunction with the ''port'' property to identify a network component. For instance, the "eth0" interface on a server has the network component name "eth" and port 0. -Type: **string** +Type: **string** + @@ -117,7 +126,8 @@ A computing instance network component's short name. This is usually ''eth''. Us [networkId]: #networkid #### [networkId] A computing instance's network component's [SoftLayer_Virtual_Network]({{}}) ID -Type: **integer** +Type: **integer** + @@ -127,7 +137,8 @@ A computing instance's network component's [SoftLayer_Virtual_Network]({{Type: **integer** +Type: **integer** + @@ -137,7 +148,8 @@ A computing instance network component's port number. Most computing instances h [speed]: #speed #### [speed] A computing instance network component's speed, measured in Mbit per second. -Type: **integer** +Type: **integer** + @@ -147,7 +159,8 @@ A computing instance network component's speed, measured in Mbit per second. [status]: #status #### [status] A computing instance network component's status. This can be one of four possible values: "ACTIVE", "DISABLED", "INACTIVE", or "ABUSE_DISCONNECT". "ACTIVE" network components are enabled and in use on a cloud instance. "ABUSE_DISCONNECT" status components have been administratively disabled by SoftLayer accounting or abuse. "DISABLED" components have been administratively disabled by you, the user. You should never see a network interface in MACWAIT state. If you happen to see one please contact SoftLayer support. -Type: **string** +Type: **string** + @@ -157,7 +170,8 @@ A computing instance network component's status. This can be one of four possibl [uuid]: #uuid #### [uuid] A computing instance's network component's unique ID on a virtualization platform. -Type: **string** +Type: **string** + @@ -173,7 +187,8 @@ A computing instance's network component's unique ID on a virtualization platfor [guest]: #guest #### [guest] The computing instance that this network component exists on. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -183,7 +198,8 @@ The computing instance that this network component exists on. [highAvailabilityFirewallFlag]: #highavailabilityfirewallflag #### [highAvailabilityFirewallFlag] -Type: **boolean** +Type: **boolean** + @@ -193,7 +209,8 @@ The computing instance that this network component exists on. [icpBinding]: #icpbinding #### [icpBinding] -Type: **SoftLayer_Virtual_Guest_Network_Component_IcpBinding ** +Type: **SoftLayer_Virtual_Guest_Network_Component_IcpBinding ** + @@ -203,7 +220,8 @@ The computing instance that this network component exists on. [ipAddressBindings]: #ipaddressbindings #### [ipAddressBindings] The records of all IP addresses bound to a computing instance's network component. -Type: **SoftLayer_Virtual_Guest_Network_Component_IpAddress[] ** +Type: **SoftLayer_Virtual_Guest_Network_Component_IpAddress[] ** + @@ -213,7 +231,8 @@ The records of all IP addresses bound to a computing instance's network componen [networkComponentFirewall]: #networkcomponentfirewall #### [networkComponentFirewall] The upstream network component firewall. -Type: **SoftLayer_Network_Component_Firewall ** +Type: **SoftLayer_Network_Component_Firewall ** + @@ -223,7 +242,8 @@ The upstream network component firewall. [networkVlan]: #networkvlan #### [networkVlan] The VLAN that a computing instance network component's subnet is associated with. -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + @@ -233,7 +253,8 @@ The VLAN that a computing instance network component's subnet is associated with [primaryIpAddress]: #primaryipaddress #### [primaryIpAddress] A computing instance network component's primary IP address. -Type: **string** +Type: **string** + @@ -243,7 +264,8 @@ A computing instance network component's primary IP address. [primaryIpAddressRecord]: #primaryipaddressrecord #### [primaryIpAddressRecord] -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -253,7 +275,8 @@ A computing instance network component's primary IP address. [primarySubnet]: #primarysubnet #### [primarySubnet] A network component's subnet for its primary IP address -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + @@ -263,7 +286,8 @@ A network component's subnet for its primary IP address [primaryVersion6IpAddressRecord]: #primaryversion6ipaddressrecord #### [primaryVersion6IpAddressRecord] A network component's primary IPv6 IP address record. -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -273,7 +297,8 @@ A network component's primary IPv6 IP address record. [router]: #router #### [router] A network component's routers. -Type: **SoftLayer_Hardware_Router ** +Type: **SoftLayer_Hardware_Router ** + @@ -283,7 +308,8 @@ A network component's routers. [securityGroupBindings]: #securitygroupbindings #### [securityGroupBindings] The bindings associating security groups to this network component -Type: **SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding[] ** +Type: **SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding[] ** + @@ -293,7 +319,8 @@ The bindings associating security groups to this network component [subnets]: #subnets #### [subnets] A network component's subnets. A subnet is a group of IP addresses -Type: **SoftLayer_Network_Subnet[] ** +Type: **SoftLayer_Network_Subnet[] ** + @@ -305,7 +332,8 @@ A network component's subnets. A subnet is a group of IP addresses [ipAddressBindingCount]: #ipaddressbindingcount #### [ipAddressBindingCount] A count of the records of all IP addresses bound to a computing instance's network component. -Type: **unsigned long** +Type: **unsigned long** + @@ -315,7 +343,8 @@ A count of the records of all IP addresses bound to a computing instance's netwo [securityGroupBindingCount]: #securitygroupbindingcount #### [securityGroupBindingCount] A count of the bindings associating security groups to this network component -Type: **unsigned long** +Type: **unsigned long** + @@ -325,7 +354,8 @@ A count of the bindings associating security groups to this network component [subnetCount]: #subnetcount #### [subnetCount] A count of a network component's subnets. A subnet is a group of IP addresses -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component_IcpBinding/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component_IcpBinding/_index.md index 5d9d06a977..c70aa0b8ec 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component_IcpBinding/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component_IcpBinding/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [interfaceId]: #interfaceid #### [interfaceId] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [ipAllocationId]: #ipallocationid #### [ipAllocationId] -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ classes: [type]: #type #### [type] The type of IP that this IP allocation id record references. Set to PRIMARY for the first servic port. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ The type of IP that this IP allocation id record references. Set to PRIMARY for [vpcId]: #vpcid #### [vpcId] -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The type of IP that this IP allocation id record references. Set to PRIMARY for [networkComponent]: #networkcomponent #### [networkComponent] The network component associated with this object. -Type: **SoftLayer_Virtual_Guest_Network_Component ** +Type: **SoftLayer_Virtual_Guest_Network_Component ** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component_IpAddress/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component_IpAddress/_index.md index d981318bd4..b8071b1cc5 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component_IpAddress/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component_IpAddress/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -51,7 +53,8 @@ The SoftLayer_Virtual_Guest_Network_Component_IpAddress data type contains gener [ipAddressId]: #ipaddressid #### [ipAddressId] The unique ID of the [SoftLayer_Network_Subnet_ipAddress]({{}}) this virtual IP address is associated with. -Type: **integer** +Type: **integer** + @@ -61,7 +64,8 @@ The unique ID of the [SoftLayer_Network_Subnet_ipAddress]({{Type: **integer** +Type: **integer** + @@ -71,7 +75,8 @@ The port that a network component has reserved. This field is only required for [type]: #type #### [type] The type of IP that this IP address record references. Some examples are PRIMARY for the network component's primary IP address and CONSOLE_PROXY which represents the IP information for logging into a computing instance's console. -Type: **string** +Type: **string** + @@ -87,7 +92,8 @@ The type of IP that this IP address record references. Some examples are PRIMAR [ipAddress]: #ipaddress #### [ipAddress] The IP address associated with this object's network component. -Type: **SoftLayer_Network_Subnet_IpAddress ** +Type: **SoftLayer_Network_Subnet_IpAddress ** + @@ -97,7 +103,8 @@ The IP address associated with this object's network component. [networkComponent]: #networkcomponent #### [networkComponent] The network component associated with this object's IP address. -Type: **SoftLayer_Virtual_Guest_Network_Component ** +Type: **SoftLayer_Virtual_Guest_Network_Component ** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Power_State/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Power_State/_index.md index 7558168f4d..6ae8bdbf20 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Power_State/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Power_State/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The power state class provides a common set of values for which a guest's power state will be presented in the SoftLayer API. @@ -45,7 +47,8 @@ The power state class provides a common set of values for which a guest's power [description]: #description #### [description] The description of a power state -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ The description of a power state [keyName]: #keyname #### [keyName] The key name of a power state -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The key name of a power state [name]: #name #### [name] The name of a power state -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Status/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Status/_index.md index 5a88e9b66e..1102f53cfb 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Status/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Status/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [keyName]: #keyname #### [keyName] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [name]: #name #### [name] -Type: **string** +Type: **string** +
              diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_SupplementalCreateObjectOptions/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_SupplementalCreateObjectOptions/_index.md index 5c481c7b0b..7ab065f341 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_SupplementalCreateObjectOptions/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_SupplementalCreateObjectOptions/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [bootMode]: #bootmode #### [bootMode] The mode used to boot the [SoftLayer_Virtual_Guest]({{}}). Supported values are 'PV' and 'HVM'. -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ The mode used to boot the [SoftLayer_Virtual_Guest]({{Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ When set the startCpus and maxMemory are defined by the flavor. If the flavor in [immediateApprovalOnlyFlag]: #immediateapprovalonlyflag #### [immediateApprovalOnlyFlag] When explicitly set to true, createObject(s) will fail unless the order is started automatically. This can be used by automated systems to fail an order that might otherwise require manual approval. For multi-guest orders via [SoftLayer_Virtual_Guest::createObjects]({{}}), this value must be the exact same for every item. -Type: **boolean** +Type: **boolean** + @@ -75,7 +80,8 @@ When explicitly set to true, createObject(s) will fail unless the order is start [postInstallScriptUri]: #postinstallscripturi #### [postInstallScriptUri] URI of the script to be downloaded and executed after installation is complete. This can be different for each virtual guest when multiple are sent to [SoftLayer_Virtual_Guest::createObjects]({{}}). -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Type/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Type/_index.md index 6b1862a7bd..e5ec963364 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Virtual_Guest_Type models the type of a [SoftLayer_Virtual_Guest]({{}}) (PUBLIC | DEDICATED | PRIVATE) @@ -45,7 +47,8 @@ SoftLayer_Virtual_Guest_Type models the type of a [SoftLayer_Virtual_Guest]({{Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ SoftLayer_Virtual_Guest_Type models the type of a [SoftLayer_Virtual_Guest]({{Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ SoftLayer_Virtual_Guest_Type models the type of a [SoftLayer_Virtual_Guest]({{Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Vpc_IpAllocation/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Vpc_IpAllocation/_index.md index dee7ddf860..5206314397 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Vpc_IpAllocation/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Vpc_IpAllocation/_index.md @@ -24,6 +24,8 @@ classes: + +
              diff --git a/content/reference/datatypes/SoftLayer_Virtual_Guest_Vpc_Subnet/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Guest_Vpc_Subnet/_index.md index 081e3c5c2e..f624866182 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Guest_Vpc_Subnet/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Guest_Vpc_Subnet/_index.md @@ -24,6 +24,8 @@ classes: + +
              diff --git a/content/reference/datatypes/SoftLayer_Virtual_Host/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Host/_index.md index 4ba02f6874..00e40e3364 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Host/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Host/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + 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. @@ -45,7 +47,8 @@ The virtual host represents the platform on which virtual guests reside. At time [accountId]: #accountid #### [accountId] A virtual host's associated account id -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ A virtual host's associated account id [createDate]: #createdate #### [createDate] The date a virtual host was created. -Type: **dateTime** +Type: **dateTime** +
              @@ -65,7 +69,8 @@ The date a virtual host was created. [description]: #description #### [description] A virtual host's description. -Type: **string** +Type: **string** +
              @@ -75,7 +80,8 @@ A virtual host's description. [enabledFlag]: #enabledflag #### [enabledFlag] The enabled flag specifies whether a virtual host can run guests. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The enabled flag specifies whether a virtual host can run guests. [hardwareId]: #hardwareid #### [hardwareId] A hardware device which a virtual host resides. -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ A hardware device which a virtual host resides. [id]: #id #### [id] Unique ID for a virtual host. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ Unique ID for a virtual host. [modifyDate]: #modifydate #### [modifyDate] The date a virtual host was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -115,7 +124,8 @@ The date a virtual host was last modified. [name]: #name #### [name] A virtual host's name. -Type: **string** +Type: **string** + @@ -125,7 +135,8 @@ A virtual host's name. [physicalMemoryCapacity]: #physicalmemorycapacity #### [physicalMemoryCapacity] The amount of memory physically available for a virtual host. -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ The amount of memory physically available for a virtual host. [uuid]: #uuid #### [uuid] Unique ID for a virtual host's record on a virtualization platform. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ Unique ID for a virtual host's record on a virtualization platform. [account]: #account #### [account] The account which a virtual host belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -161,7 +174,8 @@ The account which a virtual host belongs to. [billedPerGuestFlag]: #billedperguestflag #### [billedPerGuestFlag] Boolean flag indicating whether this virtualization platform gets billed per guest rather than at a fixed rate. -Type: **boolean** +Type: **boolean** + @@ -171,7 +185,8 @@ Boolean flag indicating whether this virtualization platform gets billed per gue [billedPerMemoryUsageFlag]: #billedpermemoryusageflag #### [billedPerMemoryUsageFlag] Boolean flag indicating whether this virtualization platform gets billed per memory usage rather than at a fixed rate. -Type: **boolean** +Type: **boolean** + @@ -181,7 +196,8 @@ Boolean flag indicating whether this virtualization platform gets billed per mem [guests]: #guests #### [guests] The guests associated with a virtual host. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -191,7 +207,8 @@ The guests associated with a virtual host. [hardware]: #hardware #### [hardware] The hardware record which a virtual host resides on. -Type: **SoftLayer_Hardware_Server ** +Type: **SoftLayer_Hardware_Server ** + @@ -201,7 +218,8 @@ The hardware record which a virtual host resides on. [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] The metric tracking object for this virtual host. -Type: **SoftLayer_Metric_Tracking_Object ** +Type: **SoftLayer_Metric_Tracking_Object ** + @@ -211,7 +229,8 @@ The metric tracking object for this virtual host. [pciDevices]: #pcidevices #### [pciDevices] -Type: **SoftLayer_Virtual_Host_PciDevice[] ** +Type: **SoftLayer_Virtual_Host_PciDevice[] ** + @@ -223,7 +242,8 @@ The metric tracking object for this virtual host. [guestCount]: #guestcount #### [guestCount] A count of the guests associated with a virtual host. -Type: **unsigned long** +Type: **unsigned long** + @@ -233,7 +253,8 @@ A count of the guests associated with a virtual host. [pciDeviceCount]: #pcidevicecount #### [pciDeviceCount] A count of -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Host_PciDevice/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Host_PciDevice/_index.md index d909387be2..9c494e55eb 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Host_PciDevice/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Host_PciDevice/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This type represents a PCI device on a host. @@ -45,7 +47,8 @@ This type represents a PCI device on a host. [id]: #id #### [id] ID of the PCI device. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ ID of the PCI device. [uuid]: #uuid #### [uuid] The unique id of the PCI device's record on a virtualization platform. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The unique id of the PCI device's record on a virtualization platform. [xenPciId]: #xenpciid #### [xenPciId] The BDF (Domain:Bus:Device.Function) id of the PCI device in XenServer. -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ The BDF (Domain:Bus:Device.Function) id of the PCI device in XenServer. [hardwareComponentModel]: #hardwarecomponentmodel #### [hardwareComponentModel] -Type: **SoftLayer_Hardware_Component_Model ** +Type: **SoftLayer_Hardware_Component_Model ** + @@ -91,7 +97,8 @@ The BDF (Domain:Bus:Device.Function) id of the PCI device in XenServer. [host]: #host #### [host] -Type: **SoftLayer_Virtual_Host ** +Type: **SoftLayer_Virtual_Host ** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding/_index.md index e65871114a..75a89c5bdc 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding data type contains general information for a single binding. A binding associates a [SoftLayer_Virtual_Guest_Network_Component]({{}}) with a [SoftLayer_Network_SecurityGroup]({{}}). @@ -45,7 +47,8 @@ The SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding data type co [id]: #id #### [id] The unique ID for a binding. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The unique ID for a binding. [networkComponentId]: #networkcomponentid #### [networkComponentId] The ID of the network component. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The ID of the network component. [securityGroupId]: #securitygroupid #### [securityGroupId] The ID of the security group. -Type: **integer** +Type: **integer** + @@ -81,7 +86,8 @@ The ID of the security group. [networkComponent]: #networkcomponent #### [networkComponent] -Type: **SoftLayer_Virtual_Guest_Network_Component ** +Type: **SoftLayer_Virtual_Guest_Network_Component ** + @@ -91,7 +97,8 @@ The ID of the security group. [securityGroup]: #securitygroup #### [securityGroup] -Type: **SoftLayer_Network_SecurityGroup ** +Type: **SoftLayer_Network_SecurityGroup ** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_PlacementGroup/_index.md b/content/reference/datatypes/SoftLayer_Virtual_PlacementGroup/_index.md index 0abb6d3169..e1db72f4d4 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_PlacementGroup/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_PlacementGroup/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ This data type presents the structure for a virtual guest placement group. The d [accountId]: #accountid #### [accountId] The unique ID of the account that created the placement group. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The unique ID of the account that created the placement group. [backendRouterId]: #backendrouterid #### [backendRouterId] The placement group's backend router's associated unique ID. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The placement group's backend router's associated unique ID. [createDate]: #createdate #### [createDate] The placement group's date of creation. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The placement group's date of creation. [id]: #id #### [id] The placement group's associated unique ID. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The placement group's associated unique ID. [modifyDate]: #modifydate #### [modifyDate] The placement group's date of most recent modification. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The placement group's date of most recent modification. [name]: #name #### [name] The placement group's name. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ The placement group's name. [ruleId]: #ruleid #### [ruleId] The associated unique ID of the placement group's rule. -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ The associated unique ID of the placement group's rule. [account]: #account #### [account] The account that the placement group is implemented on. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -131,7 +141,8 @@ The account that the placement group is implemented on. [backendRouter]: #backendrouter #### [backendRouter] The router the placement group is implemented on. -Type: **SoftLayer_Hardware_Router_Backend ** +Type: **SoftLayer_Hardware_Router_Backend ** + @@ -141,7 +152,8 @@ The router the placement group is implemented on. [guests]: #guests #### [guests] The virtual guests that are members of the placement group. -Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -151,7 +163,8 @@ The virtual guests that are members of the placement group. [rule]: #rule #### [rule] The placement rule that the placement group is implementing. -Type: **SoftLayer_Virtual_PlacementGroup_Rule ** +Type: **SoftLayer_Virtual_PlacementGroup_Rule ** + @@ -163,7 +176,8 @@ The placement rule that the placement group is implementing. [guestCount]: #guestcount #### [guestCount] A count of the virtual guests that are members of the placement group. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_PlacementGroup_Rule/_index.md b/content/reference/datatypes/SoftLayer_Virtual_PlacementGroup_Rule/_index.md index b5292af971..e1f296ab78 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_PlacementGroup_Rule/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_PlacementGroup_Rule/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This data type presents the structure of a virtual guest placement group rule. @@ -45,7 +47,8 @@ This data type presents the structure of a virtual guest placement group rule. [id]: #id #### [id] The placement group rule's associated unique ID. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The placement group rule's associated unique ID. [keyName]: #keyname #### [keyName] The placement group rule's key name. -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ The placement group rule's key name. [name]: #name #### [name] The placement group rule's name. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_ReservedCapacityGroup/_index.md b/content/reference/datatypes/SoftLayer_Virtual_ReservedCapacityGroup/_index.md index f716b17b78..87798429d0 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_ReservedCapacityGroup/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_ReservedCapacityGroup/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This data type presents the structure for a virtual reserved capacity group. @@ -45,7 +47,8 @@ This data type presents the structure for a virtual reserved capacity group. [accountId]: #accountid #### [accountId] The unique ID of the account that created the reserved capacity group. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The unique ID of the account that created the reserved capacity group. [backendRouterId]: #backendrouterid #### [backendRouterId] The reserved capacity group's backend router's associated unique ID. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The reserved capacity group's backend router's associated unique ID. [createDate]: #createdate #### [createDate] The date that the reserved capacity group was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date that the reserved capacity group was created. [id]: #id #### [id] The reserved capacity group's associated unique ID. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ The reserved capacity group's associated unique ID. [modifyDate]: #modifydate #### [modifyDate] The date that the reserved capacity group was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date that the reserved capacity group was last modified. [name]: #name #### [name] The reserved capacity group's name. -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ The reserved capacity group's name. [account]: #account #### [account] The account that the reserved capacity group is implemented on. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -121,7 +130,8 @@ The account that the reserved capacity group is implemented on. [availableInstances]: #availableinstances #### [availableInstances] The instances available for guest provisions on this reserved capacity group. -Type: **SoftLayer_Virtual_ReservedCapacityGroup_Instance[] ** +Type: **SoftLayer_Virtual_ReservedCapacityGroup_Instance[] ** + @@ -131,7 +141,8 @@ The instances available for guest provisions on this reserved capacity group. [backendRouter]: #backendrouter #### [backendRouter] The router the reserved capacity group is implemented on. -Type: **SoftLayer_Hardware_Router_Backend ** +Type: **SoftLayer_Hardware_Router_Backend ** + @@ -141,7 +152,8 @@ The router the reserved capacity group is implemented on. [instances]: #instances #### [instances] The guest instances that are members of this reserved capacity group. -Type: **SoftLayer_Virtual_ReservedCapacityGroup_Instance[] ** +Type: **SoftLayer_Virtual_ReservedCapacityGroup_Instance[] ** + @@ -151,7 +163,8 @@ The guest instances that are members of this reserved capacity group. [instancesCount]: #instancescount #### [instancesCount] The number of instances that are members of this reserved capacity group. -Type: **unsigned integer** +Type: **unsigned integer** + @@ -161,7 +174,8 @@ The number of instances that are members of this reserved capacity group. [occupiedInstances]: #occupiedinstances #### [occupiedInstances] The instances already occupied by a guest on this reserved capacity group. -Type: **SoftLayer_Virtual_ReservedCapacityGroup_Instance[] ** +Type: **SoftLayer_Virtual_ReservedCapacityGroup_Instance[] ** + @@ -173,7 +187,8 @@ The instances already occupied by a guest on this reserved capacity group. [availableInstanceCount]: #availableinstancecount #### [availableInstanceCount] A count of the instances available for guest provisions on this reserved capacity group. -Type: **unsigned long** +Type: **unsigned long** + @@ -183,7 +198,8 @@ A count of the instances available for guest provisions on this reserved capacit [instanceCount]: #instancecount #### [instanceCount] A count of the guest instances that are members of this reserved capacity group. -Type: **unsigned long** +Type: **unsigned long** + @@ -193,7 +209,8 @@ A count of the guest instances that are members of this reserved capacity group. [occupiedInstanceCount]: #occupiedinstancecount #### [occupiedInstanceCount] A count of the instances already occupied by a guest on this reserved capacity group. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_ReservedCapacityGroup_Instance/_index.md b/content/reference/datatypes/SoftLayer_Virtual_ReservedCapacityGroup_Instance/_index.md index 4d6a8d7d7b..367117c509 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_ReservedCapacityGroup_Instance/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_ReservedCapacityGroup_Instance/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This data type presents the structure for a virtual reserved capacity group instance. @@ -45,7 +47,8 @@ This data type presents the structure for a virtual reserved capacity group inst [createDate]: #createdate #### [createDate] The date that the reserved capacity group instance was created. -Type: **dateTime** +Type: **dateTime** + @@ -55,7 +58,8 @@ The date that the reserved capacity group instance was created. [guestId]: #guestid #### [guestId] The virtual guest ID associated with this reserved capacity group instance. -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ The virtual guest ID associated with this reserved capacity group instance. [id]: #id #### [id] The reserved capacity group instance's associated unique ID. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ The reserved capacity group instance's associated unique ID. [modifyDate]: #modifydate #### [modifyDate] The date that the reserved capacity group instance was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -85,7 +91,8 @@ The date that the reserved capacity group instance was last modified. [reservedCapacityGroupId]: #reservedcapacitygroupid #### [reservedCapacityGroupId] The ID of the reserved capacity group this instance is associated with. -Type: **integer** +Type: **integer** + @@ -101,7 +108,8 @@ The ID of the reserved capacity group this instance is associated with. [availableFlag]: #availableflag #### [availableFlag] Flag to indecate whether or not the reserved instance is available or not. -Type: **boolean** +Type: **boolean** + @@ -111,7 +119,8 @@ Flag to indecate whether or not the reserved instance is available or not. [billingItem]: #billingitem #### [billingItem] The billing item for the reserved capacity group instance. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -121,7 +130,8 @@ The billing item for the reserved capacity group instance. [guest]: #guest #### [guest] The virtual guest associated with this reserved capacity group instance. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -131,7 +141,8 @@ The virtual guest associated with this reserved capacity group instance. [reservedCapacityGroup]: #reservedcapacitygroup #### [reservedCapacityGroup] The reserved instances that are members of this reserved capacity group. -Type: **SoftLayer_Virtual_ReservedCapacityGroup ** +Type: **SoftLayer_Virtual_ReservedCapacityGroup ** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Storage_Repository/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Storage_Repository/_index.md index 51b2d912eb..6bc0496649 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Storage_Repository/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Storage_Repository/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Virtual_Storage_Repository represents a web based storage system that can be accessed through many types of devices, interfaces, and other resources. @@ -45,7 +47,8 @@ The SoftLayer_Virtual_Storage_Repository represents a web based storage system t [capacity]: #capacity #### [capacity] A storage repositories capacity measured in Giga-Bytes (GB) -Type: **float** +Type: **float** + @@ -55,7 +58,8 @@ A storage repositories capacity measured in Giga-Bytes (GB) [description]: #description #### [description] A storage repositories description that describes its purpose or contents -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ A storage repositories description that describes its purpose or contents [id]: #id #### [id] Unique ID for a storage repository. -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ Unique ID for a storage repository. [name]: #name #### [name] A storage repositories name that describes its purpose or contents -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ A storage repositories name that describes its purpose or contents [publicFlag]: #publicflag #### [publicFlag] -Type: **integer** +Type: **integer** + @@ -95,7 +102,8 @@ A storage repositories name that describes its purpose or contents [typeId]: #typeid #### [typeId] A storage repositories [SoftLayer_Virtual_Storage_Repository_Type]({{}}) ID -Type: **integer** +Type: **integer** + @@ -111,7 +119,8 @@ A storage repositories [SoftLayer_Virtual_Storage_Repository_Type]({{}}) that a storage repository belongs to. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -121,7 +130,8 @@ The [SoftLayer_Account]({{}}) that [billingItem]: #billingitem #### [billingItem] The current billing item for a storage repository. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -131,7 +141,8 @@ The current billing item for a storage repository. [datacenter]: #datacenter #### [datacenter] The datacenter that a virtual storage repository resides in. -Type: **SoftLayer_Location ** +Type: **SoftLayer_Location ** + @@ -141,7 +152,8 @@ The datacenter that a virtual storage repository resides in. [diskImages]: #diskimages #### [diskImages] The [SoftLayer_Virtual_Disk_Image]({{}}) that are in a storage repository. Disk images are the virtual hard drives for a virtual guest. -Type: **SoftLayer_Virtual_Disk_Image[] ** +Type: **SoftLayer_Virtual_Disk_Image[] ** + @@ -151,7 +163,8 @@ The [SoftLayer_Virtual_Disk_Image]({{Type: **SoftLayer_Virtual_Guest[] ** +Type: **SoftLayer_Virtual_Guest[] ** + @@ -161,7 +174,8 @@ The computing instances that have disk images in a storage repository. [metricTrackingObject]: #metrictrackingobject #### [metricTrackingObject] -Type: **SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository ** +Type: **SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository ** + @@ -171,7 +185,8 @@ The computing instances that have disk images in a storage repository. [publicImageBillingItem]: #publicimagebillingitem #### [publicImageBillingItem] The current billing item for a public storage repository. -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -181,7 +196,8 @@ The current billing item for a public storage repository. [type]: #type #### [type] A storage repository's [SoftLayer_Virtual_Storage_Repository_Type]({{}}). -Type: **SoftLayer_Virtual_Storage_Repository_Type ** +Type: **SoftLayer_Virtual_Storage_Repository_Type ** + @@ -193,7 +209,8 @@ A storage repository's [SoftLayer_Virtual_Storage_Repository_Type]({{}}) that are in a storage repository. Disk images are the virtual hard drives for a virtual guest. -Type: **unsigned long** +Type: **unsigned long** + @@ -203,7 +220,8 @@ A count of the [SoftLayer_Virtual_Disk_Image]({{Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Virtual_Storage_Repository_Type/_index.md b/content/reference/datatypes/SoftLayer_Virtual_Storage_Repository_Type/_index.md index 9e9b483ae8..20f45bb8bc 100644 --- a/content/reference/datatypes/SoftLayer_Virtual_Storage_Repository_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Virtual_Storage_Repository_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,7 +47,8 @@ SoftLayer employs many different types of repositories that computing instances [description]: #description #### [description] A brief description os a storage repository type. -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ A brief description os a storage repository type. [name]: #name #### [name] A storage repository type's name. -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ A storage repository type's name. [storageRepositories]: #storagerepositories #### [storageRepositories] The storage repositories on a SoftLayer customer account that belong to this type. -Type: **SoftLayer_Virtual_Storage_Repository[] ** +Type: **SoftLayer_Virtual_Storage_Repository[] ** + @@ -83,7 +88,8 @@ The storage repositories on a SoftLayer customer account that belong to this typ [storageRepositoryCount]: #storagerepositorycount #### [storageRepositoryCount] A count of the storage repositories on a SoftLayer customer account that belong to this type. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Workload_Citrix_Client/_index.md b/content/reference/datatypes/SoftLayer_Workload_Citrix_Client/_index.md index bc0694d778..fcdf14d6ab 100644 --- a/content/reference/datatypes/SoftLayer_Workload_Citrix_Client/_index.md +++ b/content/reference/datatypes/SoftLayer_Workload_Citrix_Client/_index.md @@ -24,6 +24,8 @@ classes: + +
              diff --git a/content/reference/datatypes/SoftLayer_Workload_Citrix_Client_Response/_index.md b/content/reference/datatypes/SoftLayer_Workload_Citrix_Client_Response/_index.md index a2b871f372..ca436eca55 100644 --- a/content/reference/datatypes/SoftLayer_Workload_Citrix_Client_Response/_index.md +++ b/content/reference/datatypes/SoftLayer_Workload_Citrix_Client_Response/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [messageId]: #messageid #### [messageId] messageId of Citrix account validation response. -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ messageId of Citrix account validation response. [status]: #status #### [status] status of Citrix account validation. -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ status of Citrix account validation. [statusMessage]: #statusmessage #### [statusMessage] status message of Citrix account validation. -Type: **string** +Type: **string** +
              diff --git a/content/reference/datatypes/SoftLayer_Workload_Citrix_Client_Response_ResourceLocations/_index.md b/content/reference/datatypes/SoftLayer_Workload_Citrix_Client_Response_ResourceLocations/_index.md index 893952d95e..e1735fea09 100644 --- a/content/reference/datatypes/SoftLayer_Workload_Citrix_Client_Response_ResourceLocations/_index.md +++ b/content/reference/datatypes/SoftLayer_Workload_Citrix_Client_Response_ResourceLocations/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [messageId]: #messageid #### [messageId] messageId of Citrix account validation response. -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ messageId of Citrix account validation response. [resourceLocations]: #resourcelocations #### [resourceLocations] -Type: **array of strings** +Type: **array of strings** +
              @@ -65,7 +69,8 @@ messageId of Citrix account validation response. [status]: #status #### [status] status of Citrix account validation. -Type: **string** +Type: **string** +
              @@ -75,7 +80,8 @@ status of Citrix account validation. [statusMessage]: #statusmessage #### [statusMessage] status message of Citrix account validation. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment/_index.md b/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment/_index.md index 138361d814..70589d3fe7 100644 --- a/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment/_index.md +++ b/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [accountId]: #accountid #### [accountId] The account ID to which the deployment belongs. -Type: **integer** +Type: **integer** +
              @@ -55,7 +58,8 @@ The account ID to which the deployment belongs. [activeDirectoryTopology]: #activedirectorytopology #### [activeDirectoryTopology] Topology used for the Citrix Virtual Apps And Desktop deployment. -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ Topology used for the Citrix Virtual Apps And Desktop deployment. [createDate]: #createdate #### [createDate] The date when this record was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date when this record was created. [id]: #id #### [id] It is the unique identifier for the deployment. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ It is the unique identifier for the deployment. [modifyDate]: #modifydate #### [modifyDate] The date when this record was last modified. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date when this record was last modified. [typeId]: #typeid #### [typeId] The [SoftLayer_Workload_Citrix_Deployment_Type]({{}}) of the deployment. -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ The [SoftLayer_Workload_Citrix_Deployment_Type]({{Type: **integer** +Type: **integer** + @@ -115,7 +124,8 @@ The identifier for the customer who placed the CVAD order. [vlanId]: #vlanid #### [vlanId] VLAN ID of the deployment. -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ VLAN ID of the deployment. [vmwareOrderId]: #vmwareorderid #### [vmwareOrderId] It is an internal identifier for the VMware solution. It gets set if the CVAD order is for VMware. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ It is an internal identifier for the VMware solution. It gets set if the CVAD or [account]: #account #### [account] The [SoftLayer_Account]({{}}) to which the deployment belongs. -Type: **SoftLayer_Account ** +Type: **SoftLayer_Account ** + @@ -151,7 +163,8 @@ The [SoftLayer_Account]({{}}) to wh [resources]: #resources #### [resources] It contains a collection of items under the CVAD deployment. -Type: **SoftLayer_Workload_Citrix_Deployment_Resource[] ** +Type: **SoftLayer_Workload_Citrix_Deployment_Resource[] ** + @@ -161,7 +174,8 @@ It contains a collection of items under the CVAD deployment. [type]: #type #### [type] It shows if the deployment is for Citrix Hypervisor or VMware. -Type: **SoftLayer_Workload_Citrix_Deployment_Type ** +Type: **SoftLayer_Workload_Citrix_Deployment_Type ** + @@ -171,7 +185,8 @@ It shows if the deployment is for Citrix Hypervisor or VMware. [user]: #user #### [user] It is the [SoftLayer_User_Customer]({{}}) who placed the order for CVAD. -Type: **SoftLayer_User_Customer ** +Type: **SoftLayer_User_Customer ** + @@ -181,7 +196,8 @@ It is the [SoftLayer_User_Customer]({{Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + @@ -193,7 +209,8 @@ It is the VLAN resource for the CVAD deployment. [resourceCount]: #resourcecount #### [resourceCount] A count of it contains a collection of items under the CVAD deployment. -Type: **unsigned long** +Type: **unsigned long** + diff --git a/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource/_index.md b/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource/_index.md index d47e8a7449..43500a9f89 100644 --- a/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource/_index.md +++ b/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Workload_Citrix_Deployment_Resource type contains the information of the resource such as the Deployment ID, resource's Billing Item ID, Order ID and Role of the resource in the CVAD deployment. @@ -45,7 +47,8 @@ The SoftLayer_Workload_Citrix_Deployment_Resource type contains the information [billingItemId]: #billingitemid #### [billingItemId] Billing item ID of the resource -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ Billing item ID of the resource [createDate]: #createdate #### [createDate] The point in time at which the resource was ordered. -Type: **dateTime** +Type: **dateTime** + @@ -65,7 +69,8 @@ The point in time at which the resource was ordered. [deploymentId]: #deploymentid #### [deploymentId] CVAD Deployment ID of the resource -Type: **integer** +Type: **integer** + @@ -75,7 +80,8 @@ CVAD Deployment ID of the resource [id]: #id #### [id] Unique Identifier of the CVAD Deployment Resource -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ Unique Identifier of the CVAD Deployment Resource [modifyDate]: #modifydate #### [modifyDate] The last time when the resource was modified. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The last time when the resource was modified. [orderId]: #orderid #### [orderId] Billing Order ID of the resource -Type: **integer** +Type: **integer** + @@ -105,7 +113,8 @@ Billing Order ID of the resource [orderedByCvad]: #orderedbycvad #### [orderedByCvad] This flag indicates that whether the CVAD APIs have control over this resource. This resource can be cancelled using CVAD cancellation APIs only if this flag is true. -Type: **boolean** +Type: **boolean** + @@ -115,7 +124,8 @@ This flag indicates that whether the CVAD APIs have control over this resource. [roleId]: #roleid #### [roleId] Role of the resource within the CVAD deployment. For example, a VSI can have different roles such as Proxy Server or DHCP Server. -Type: **integer** +Type: **integer** + @@ -131,7 +141,8 @@ Role of the resource within the CVAD deployment. For example, a VSI can have dif [billingItem]: #billingitem #### [billingItem] -Type: **SoftLayer_Billing_Item ** +Type: **SoftLayer_Billing_Item ** + @@ -141,7 +152,8 @@ Role of the resource within the CVAD deployment. For example, a VSI can have dif [deployment]: #deployment #### [deployment] -Type: **SoftLayer_Workload_Citrix_Deployment ** +Type: **SoftLayer_Workload_Citrix_Deployment ** + @@ -151,7 +163,8 @@ Role of the resource within the CVAD deployment. For example, a VSI can have dif [order]: #order #### [order] -Type: **SoftLayer_Billing_Order ** +Type: **SoftLayer_Billing_Order ** + @@ -161,7 +174,8 @@ Role of the resource within the CVAD deployment. For example, a VSI can have dif [role]: #role #### [role] -Type: **SoftLayer_Workload_Citrix_Deployment_Resource_Role ** +Type: **SoftLayer_Workload_Citrix_Deployment_Resource_Role ** + diff --git a/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource_Response/_index.md b/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource_Response/_index.md index 49c098737b..c39ab737b4 100644 --- a/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource_Response/_index.md +++ b/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource_Response/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Workload_Citrix_Deployment_Resource_Response constructs a response object for [SoftLayer_Workload_Citrix_Deployment_Resource_Response]({{}}) for the CVAD resource. @@ -45,7 +47,8 @@ The SoftLayer_Workload_Citrix_Deployment_Resource_Response constructs a response [hardware]: #hardware #### [hardware] Represents the hardware resource of the CVAD deployment. -Type: **SoftLayer_Hardware ** +Type: **SoftLayer_Hardware ** + @@ -55,7 +58,8 @@ Represents the hardware resource of the CVAD deployment. [isDeploymentOwned]: #isdeploymentowned #### [isDeploymentOwned] It is a flag for internal usage that represents if the underlying resource is ordered by another system of the same infrastructure provider. -Type: **boolean** +Type: **boolean** + @@ -65,7 +69,8 @@ It is a flag for internal usage that represents if the underlying resource is or [role]: #role #### [role] It represents the role of a VSI resource in the CVAD deployment, e.g., a proxy server, DHCP server, cloud connector. -Type: **SoftLayer_Workload_Citrix_Deployment_Resource_Role ** +Type: **SoftLayer_Workload_Citrix_Deployment_Resource_Role ** + @@ -75,7 +80,8 @@ It represents the role of a VSI resource in the CVAD deployment, e.g., a proxy s [storage]: #storage #### [storage] Storage resource for the CVAD deployment. -Type: **SoftLayer_Network_Storage ** +Type: **SoftLayer_Network_Storage ** + @@ -85,7 +91,8 @@ Storage resource for the CVAD deployment. [subnet]: #subnet #### [subnet] Represents the subnet resource of the CVAD deployment. -Type: **SoftLayer_Network_Subnet ** +Type: **SoftLayer_Network_Subnet ** + @@ -95,7 +102,8 @@ Represents the subnet resource of the CVAD deployment. [type]: #type #### [type] It contains the category of the item which is set for the current response. -Type: **string** +Type: **string** + @@ -105,7 +113,8 @@ It contains the category of the item which is set for the current response. [virtualGuest]: #virtualguest #### [virtualGuest] VSI resource for the CVAD deployment. -Type: **SoftLayer_Virtual_Guest ** +Type: **SoftLayer_Virtual_Guest ** + @@ -115,7 +124,8 @@ VSI resource for the CVAD deployment. [vlan]: #vlan #### [vlan] Represents the VLAN resource of the CVAD deployment. -Type: **SoftLayer_Network_Vlan ** +Type: **SoftLayer_Network_Vlan ** + diff --git a/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource_Role/_index.md b/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource_Role/_index.md index 8594469047..fe9fcce504 100644 --- a/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource_Role/_index.md +++ b/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource_Role/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Workload_Citrix_Deployment_Resource_Role contains the role and its description of any resource of Citrix Virtual Apps & Desktops deployment. @@ -45,7 +47,8 @@ SoftLayer_Workload_Citrix_Deployment_Resource_Role contains the role and its des [description]: #description #### [description] Description of the resource role -Type: **string** +Type: **string** + @@ -55,7 +58,8 @@ Description of the resource role [id]: #id #### [id] ID of the role -Type: **integer** +Type: **integer** + @@ -65,7 +69,8 @@ ID of the role [keyName]: #keyname #### [keyName] Unique keyName of the role -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ Unique keyName of the role [name]: #name #### [name] Name of the role -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Response/_index.md b/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Response/_index.md index bbaaa629ba..57d92d2b1f 100644 --- a/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Response/_index.md +++ b/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Response/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Workload_Citrix_Deployment_Response constructs a response object for the [SoftLayer_Workload_Citrix_Deployment]({{}}) that includes all resources, i.e., [SoftLayer_Workload_Citrix_Deployment_Resource]({{}}). @@ -45,7 +47,8 @@ The SoftLayer_Workload_Citrix_Deployment_Response constructs a response object f [accountId]: #accountid #### [accountId] The account ID to which the deployment belongs. -Type: **integer** +Type: **integer** + @@ -55,7 +58,8 @@ The account ID to which the deployment belongs. [activeDirectoryTopology]: #activedirectorytopology #### [activeDirectoryTopology] Topology used for the CVAD deployment -Type: **string** +Type: **string** + @@ -65,7 +69,8 @@ Topology used for the CVAD deployment [createDate]: #createdate #### [createDate] The date when this deployment was created. -Type: **dateTime** +Type: **dateTime** + @@ -75,7 +80,8 @@ The date when this deployment was created. [id]: #id #### [id] ID of the CVAD deployment. -Type: **integer** +Type: **integer** + @@ -85,7 +91,8 @@ ID of the CVAD deployment. [modifyDate]: #modifydate #### [modifyDate] The date when this deployment was modified. -Type: **dateTime** +Type: **dateTime** + @@ -95,7 +102,8 @@ The date when this deployment was modified. [resources]: #resources #### [resources] It is a collection of objects representing deployment resources such as VLAN, subnet, bare metal, proxy, DHCP, cloud connectors. -Type: **SoftLayer_Workload_Citrix_Deployment_Resource_Response[] ** +Type: **SoftLayer_Workload_Citrix_Deployment_Resource_Response[] ** + @@ -105,7 +113,8 @@ It is a collection of objects representing deployment resources such as VLAN, su [type]: #type #### [type] Represents if the deployment is for Citrix Hypervisor or VMware -Type: **SoftLayer_Workload_Citrix_Deployment_Type ** +Type: **SoftLayer_Workload_Citrix_Deployment_Type ** + @@ -115,7 +124,8 @@ Represents if the deployment is for Citrix Hypervisor or VMware [userRecordId]: #userrecordid #### [userRecordId] The identifier for the customer who placed the CVAD order. -Type: **integer** +Type: **integer** + @@ -125,7 +135,8 @@ The identifier for the customer who placed the CVAD order. [vlanId]: #vlanid #### [vlanId] VLAN ID of the deployment. -Type: **integer** +Type: **integer** + @@ -135,7 +146,8 @@ VLAN ID of the deployment. [vmwareOrderId]: #vmwareorderid #### [vmwareOrderId] It is an internal identifier for the VMware solution. It gets set if the CVAD order is for VMware. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Type/_index.md b/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Type/_index.md index fbc5c6b299..9c963c26e0 100644 --- a/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Type/_index.md +++ b/content/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Type/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [description]: #description #### [description] Description of the deployment type. -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ Description of the deployment type. [id]: #id #### [id] The identifer of the deployment type. -Type: **integer** +Type: **integer** +
              @@ -65,7 +69,8 @@ The identifer of the deployment type. [keyName]: #keyname #### [keyName] KeyName of the deployment type. -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ KeyName of the deployment type. [name]: #name #### [name] Name of the deployment type. -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Workload_Citrix_Request/_index.md b/content/reference/datatypes/SoftLayer_Workload_Citrix_Request/_index.md index ad5875906c..5af1d228b2 100644 --- a/content/reference/datatypes/SoftLayer_Workload_Citrix_Request/_index.md +++ b/content/reference/datatypes/SoftLayer_Workload_Citrix_Request/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [clientId]: #clientid #### [clientId] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [clientSecret]: #clientsecret #### [clientSecret] -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ classes: [customerId]: #customerid #### [customerId] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Workload_Citrix_Request_CreateResourceLocation/_index.md b/content/reference/datatypes/SoftLayer_Workload_Citrix_Request_CreateResourceLocation/_index.md index 66283d8031..03fd0fa02f 100644 --- a/content/reference/datatypes/SoftLayer_Workload_Citrix_Request_CreateResourceLocation/_index.md +++ b/content/reference/datatypes/SoftLayer_Workload_Citrix_Request_CreateResourceLocation/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [clientId]: #clientid #### [clientId] -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ classes: [clientSecret]: #clientsecret #### [clientSecret] -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ classes: [customerId]: #customerid #### [customerId] -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ classes: [resourceLocationName]: #resourcelocationname #### [resourceLocationName] -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_Container/_index.md b/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_Container/_index.md index 7df739c011..cc93da67d1 100644 --- a/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_Container/_index.md +++ b/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_Container/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This is the datatype that needs to be populated and sent to SoftLayer_Workload_Citrix_Workspace_Order::placeWorkspaceOrder. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Workload_C [activeDirectoryDomainName]: #activedirectorydomainname #### [activeDirectoryDomainName] The active directory domain name -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ The active directory domain name [activeDirectoryNetbiosName]: #activedirectorynetbiosname #### [activeDirectoryNetbiosName] The active directory netbios name (optional) -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ The active directory netbios name (optional) [activeDirectorySafeModePassword]: #activedirectorysafemodepassword #### [activeDirectorySafeModePassword] The active directory safe mode password -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ The active directory safe mode password [activeDirectoryTopology]: #activedirectorytopology #### [activeDirectoryTopology] The active directory topology -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The active directory topology [citrixAPIClientId]: #citrixapiclientid #### [citrixAPIClientId] The Citrix API Client Id -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The Citrix API Client Id [citrixAPIClientSecret]: #citrixapiclientsecret #### [citrixAPIClientSecret] The Citrix API Client Secret -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ The Citrix API Client Secret [citrixCustomerId]: #citrixcustomerid #### [citrixCustomerId] The Citrix customer id -Type: **string** +Type: **string** + @@ -121,7 +130,8 @@ The Citrix customer id [citrixResourceLocationName]: #citrixresourcelocationname #### [citrixResourceLocationName] The Citrix resource location name -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The Citrix resource location name [domain]: #domain #### [domain] The default domain to be used for all server orders where the domain is not specified. -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ The default domain to be used for all server orders where the domain is not spec [location]: #location #### [location] The specific [SoftLayer_Location_Datacenter]({{}}) id where the order should be provisioned. -Type: **string** +Type: **string** + @@ -151,7 +163,8 @@ The specific [SoftLayer_Location_Datacenter]({{Type: **SoftLayer_Container_Product_Order[] ** +Type: **SoftLayer_Container_Product_Order[] ** + @@ -161,7 +174,8 @@ There should be one child orderContainer for each component ordered. The contai [vmwareContainer]: #vmwarecontainer #### [vmwareContainer] Set this value to order IBM Cloud for VMware Solutions servers as part of your Citrix Virtual Apps and Desktops order -Type: **SoftLayer_Workload_Citrix_Workspace_Order_VMwareContainer ** +Type: **SoftLayer_Workload_Citrix_Workspace_Order_VMwareContainer ** + diff --git a/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_LicenseKey/_index.md b/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_LicenseKey/_index.md index ce6e323c9d..37c89bdde2 100644 --- a/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_LicenseKey/_index.md +++ b/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_LicenseKey/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This is the datatype that can be populated by the customer to provide license key information for VMware orders. @@ -51,7 +53,8 @@ This is the datatype that can be populated by the customer to provide license ke [key]: #key #### [key] The license key -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ The license key [name]: #name #### [name] The name of the product (e.g. vcenter, nsx, vsphere, vsan) -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ The name of the product (e.g. vcenter, nsx, vsphere, vsan) [type]: #type #### [type] The license type -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_SharedStorage/_index.md b/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_SharedStorage/_index.md index 1529477ddf..b8cb276ea8 100644 --- a/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_SharedStorage/_index.md +++ b/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_SharedStorage/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This is the datatype that can be populated by the customer to provide NFS shared storage information for VMware orders. @@ -51,7 +53,8 @@ This is the datatype that can be populated by the customer to provide NFS shared [iops]: #iops #### [iops] Which storage tier: e.g. READHEAVY_TIER -Type: **string** +Type: **string** + @@ -61,7 +64,8 @@ Which storage tier: e.g. READHEAVY_TIER [quantity]: #quantity #### [quantity] The number of shared storages to order -Type: **integer** +Type: **integer** + @@ -71,7 +75,8 @@ The number of shared storages to order [size]: #size #### [size] The size of the storage (e.g. STORAGE_SPACE_FOR_2_IOPS_PER_GB) -Type: **string** +Type: **string** + @@ -81,7 +86,8 @@ The size of the storage (e.g. STORAGE_SPACE_FOR_2_IOPS_PER_GB) [volume]: #volume #### [volume] The volume -Type: **integer** +Type: **integer** + diff --git a/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_VMwareContainer/_index.md b/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_VMwareContainer/_index.md index a57fbc973c..0e5a91c913 100644 --- a/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_VMwareContainer/_index.md +++ b/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_VMwareContainer/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This is the datatype that needs to be populated and sent to SoftLayer_Workload_Citrix_Workspace_Order::placeWorkspaceOrder to order and provision one or more VMware server instances to be used with Citrix Virtual Apps and Desktops. @@ -51,7 +53,8 @@ This is the datatype that needs to be populated and sent to SoftLayer_Workload_C [disks]: #disks #### [disks] The bare metal disks -Type: **array of strings** +Type: **array of strings** + @@ -61,7 +64,8 @@ The bare metal disks [domain]: #domain #### [domain] The domain for the ordered hosts (e.g. example.org) -Type: **string** +Type: **string** + @@ -71,7 +75,8 @@ The domain for the ordered hosts (e.g. example.org) [licenseKeys]: #licensekeys #### [licenseKeys] Customer provided license keys (optional) -Type: **SoftLayer_Workload_Citrix_Workspace_Order_LicenseKey[] ** +Type: **SoftLayer_Workload_Citrix_Workspace_Order_LicenseKey[] ** + @@ -81,7 +86,8 @@ Customer provided license keys (optional) [location]: #location #### [location] The datacenter location -Type: **string** +Type: **string** + @@ -91,7 +97,8 @@ The datacenter location [name]: #name #### [name] The name associated with the order -Type: **string** +Type: **string** + @@ -101,7 +108,8 @@ The name associated with the order [nickname]: #nickname #### [nickname] The nickname for the vSRX service -Type: **string** +Type: **string** + @@ -111,7 +119,8 @@ The nickname for the vSRX service [quantity]: #quantity #### [quantity] The number of instances to order -Type: **integer** +Type: **integer** + @@ -121,7 +130,8 @@ The number of instances to order [ram]: #ram #### [ram] The bare metal ram type -Type: **string** +Type: **string** + @@ -131,7 +141,8 @@ The bare metal ram type [server]: #server #### [server] The bare metal server type -Type: **string** +Type: **string** + @@ -141,7 +152,8 @@ The bare metal server type [sharedStorage]: #sharedstorage #### [sharedStorage] The bare metal shared nfs storage (optional) -Type: **SoftLayer_Workload_Citrix_Workspace_Order_SharedStorage[] ** +Type: **SoftLayer_Workload_Citrix_Workspace_Order_SharedStorage[] ** + @@ -150,8 +162,9 @@ The bare metal shared nfs storage (optional) ----- [subdomain]: #subdomain #### [subdomain] -The subdomain for the ordered hosts (e.g. corp) -Type: **string** +The subdomain for the ordered hosts (e.g. corp). +Type: **string** + @@ -161,7 +174,8 @@ The subdomain for the ordered hosts (e.g. corp) [vsanCacheDisks]: #vsancachedisks #### [vsanCacheDisks] The bare metal vsan cache disks (optional) -Type: **array of strings** +Type: **array of strings** + diff --git a/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response/_index.md b/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response/_index.md index fb58c7e47d..5703f950d8 100644 --- a/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response/_index.md +++ b/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [messageId]: #messageid #### [messageId] messageId associated with any error -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ messageId associated with any error [status]: #status #### [status] status of service methods -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ status of service methods [statusMessage]: #statusmessage #### [statusMessage] status message -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response_Item/_index.md b/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response_Item/_index.md index 8e1974d420..3da83a1e0c 100644 --- a/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response_Item/_index.md +++ b/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response_Item/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [id]: #id #### [id] the id of the resource (HARDWARE, GUEST, VLAN, SUBNET, VMWARE) -Type: **string** +Type: **string** +
              @@ -55,7 +58,8 @@ the id of the resource (HARDWARE, GUEST, VLAN, SUBNET, VMWARE) [messageId]: #messageid #### [messageId] messageId associated with any error -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ messageId associated with any error [name]: #name #### [name] the name associated with the resource (e.g. name, hostname) -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ the name associated with the resource (e.g. name, hostname) [status]: #status #### [status] status of service methods -Type: **string** +Type: **string** + @@ -85,7 +91,8 @@ status of service methods [statusMessage]: #statusmessage #### [statusMessage] status message -Type: **string** +Type: **string** + @@ -95,7 +102,8 @@ status message [typeName]: #typename #### [typeName] the type of resource (HARDWARE, GUEST, NETWORK_VLAN, SUBNET) -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response_Result/_index.md b/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response_Result/_index.md index 26a1bb6588..53f52581e8 100644 --- a/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response_Result/_index.md +++ b/content/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response_Result/_index.md @@ -24,6 +24,8 @@ classes: + +
              @@ -45,7 +47,8 @@ classes: [items]: #items #### [items] identification and operation result for each item -Type: **SoftLayer_Workload_Citrix_Workspace_Response[] ** +Type: **SoftLayer_Workload_Citrix_Workspace_Response[] ** +
              @@ -55,7 +58,8 @@ identification and operation result for each item [messageId]: #messageid #### [messageId] messageId associated with any error -Type: **string** +Type: **string** +
              @@ -65,7 +69,8 @@ messageId associated with any error [status]: #status #### [status] status of service methods -Type: **string** +Type: **string** + @@ -75,7 +80,8 @@ status of service methods [statusMessage]: #statusmessage #### [statusMessage] status message -Type: **string** +Type: **string** + diff --git a/content/reference/datatypes/list.html b/content/reference/datatypes/list.html index e6509152d7..ad0782ad73 100644 --- a/content/reference/datatypes/list.html +++ b/content/reference/datatypes/list.html @@ -2206,6 +2206,9 @@
              Network_DirectLink_ServiceType
              +
              +
              Network_FbDbChangeRequestHistory
              +
              Network_Firewall_AccessControlList
              diff --git a/content/reference/services/BluePages_Search/_index.md b/content/reference/services/BluePages_Search/_index.md index f52982c05d..71a434e5f6 100644 --- a/content/reference/services/BluePages_Search/_index.md +++ b/content/reference/services/BluePages_Search/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,6 +44,7 @@ Searches BluePages for an employee and returns a container representing the empl #### [findBluePagesProfile](/reference/services/BluePages_Search/findBluePagesProfile) + diff --git a/content/reference/services/BluePages_Search/findBluePagesProfile.md b/content/reference/services/BluePages_Search/findBluePagesProfile.md index 39179d1761..b049c7cb13 100644 --- a/content/reference/services/BluePages_Search/findBluePagesProfile.md +++ b/content/reference/services/BluePages_Search/findBluePagesProfile.md @@ -16,6 +16,7 @@ aliases: + ## Overview Given an IBM email address, searches BluePages and returns the employee's details. Note that this method is not available to customers, despite being visible, and will return an error response. diff --git a/content/reference/services/IntegratedOfferingTeam_Region/_index.md b/content/reference/services/IntegratedOfferingTeam_Region/_index.md index caacfe68b8..9ce5eadbfc 100644 --- a/content/reference/services/IntegratedOfferingTeam_Region/_index.md +++ b/content/reference/services/IntegratedOfferingTeam_Region/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class represents an Integrated Offering Team region. @@ -42,12 +44,14 @@ This class represents an Integrated Offering Team region. #### [getAllObjects](/reference/services/IntegratedOfferingTeam_Region/getAllObjects) +
              #### [getRegionLeads](/reference/services/IntegratedOfferingTeam_Region/getRegionLeads) +
              diff --git a/content/reference/services/IntegratedOfferingTeam_Region/getAllObjects.md b/content/reference/services/IntegratedOfferingTeam_Region/getAllObjects.md index 57766c2d36..0e782349ea 100644 --- a/content/reference/services/IntegratedOfferingTeam_Region/getAllObjects.md +++ b/content/reference/services/IntegratedOfferingTeam_Region/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview Returns a list of all Integrated Offering Team regions. Note that this method, despite being visible, is not accessible by customers and attempting to use it will result in an error response. diff --git a/content/reference/services/IntegratedOfferingTeam_Region/getRegionLeads.md b/content/reference/services/IntegratedOfferingTeam_Region/getRegionLeads.md index 5424975d17..f5c93aa149 100644 --- a/content/reference/services/IntegratedOfferingTeam_Region/getRegionLeads.md +++ b/content/reference/services/IntegratedOfferingTeam_Region/getRegionLeads.md @@ -16,6 +16,7 @@ aliases: + ## Overview Returns a list of all Integrated Offering Team region leads. Note that this method, despite being visible, is not accessible by customers and attempting to use it will result in an error response. diff --git a/content/reference/services/SoftLayer_Account/_index.md b/content/reference/services/SoftLayer_Account/_index.md index f08258edf8..43e5b59ea3 100644 --- a/content/reference/services/SoftLayer_Account/_index.md +++ b/content/reference/services/SoftLayer_Account/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -44,864 +46,1032 @@ SoftLayer customers are unable to change their company account information in th #### [activatePartner](/reference/services/SoftLayer_Account/activatePartner) This service enables a partner account that has been created but is currently inactive. This restricted service is only available for certain accounts. Please contact support for questions. +
              #### [addAchInformation](/reference/services/SoftLayer_Account/addAchInformation) +
              #### [addReferralPartnerPaymentOption](/reference/services/SoftLayer_Account/addReferralPartnerPaymentOption) +
              #### [areVdrUpdatesBlockedForBilling](/reference/services/SoftLayer_Account/areVdrUpdatesBlockedForBilling) This method returns true if Bandwidth Pooling updates are blocked so billing can run for this account. +
              #### [cancelPayPalTransaction](/reference/services/SoftLayer_Account/cancelPayPalTransaction) Cancel the PayPal Payment Request process. +
              #### [completePayPalTransaction](/reference/services/SoftLayer_Account/completePayPalTransaction) Complete the PayPal Payment Request process and receive confirmation message. +
              #### [countHourlyInstances](/reference/services/SoftLayer_Account/countHourlyInstances) Retrieve the number of hourly services on an account that are active, plus any pending orders with hourly services attached. +
              #### [createUser](/reference/services/SoftLayer_Account/createUser) Create a new user record, optionally skipping the IBMid email ("silently"). +
              #### [disableEuSupport](/reference/services/SoftLayer_Account/disableEuSupport) Turn off the EU Supported account flag. +
              #### [disableVpnConfigRequiresVpnManageAttribute](/reference/services/SoftLayer_Account/disableVpnConfigRequiresVpnManageAttribute) Disable the VPN Config Requires VPN Manage attribute, creating it if necessary. +
              #### [editAccount](/reference/services/SoftLayer_Account/editAccount) Edit an account's information. +
              #### [enableEuSupport](/reference/services/SoftLayer_Account/enableEuSupport) Turn on the EU Supported account flag. +
              #### [enableVpnConfigRequiresVpnManageAttribute](/reference/services/SoftLayer_Account/enableVpnConfigRequiresVpnManageAttribute) Enable the VPN Config Requires VPN Manage attribute, creating it if necessary. +
              #### [getAbuseEmail](/reference/services/SoftLayer_Account/getAbuseEmail) Retrieve an email address that is responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to this address. +
              #### [getAbuseEmails](/reference/services/SoftLayer_Account/getAbuseEmails) Retrieve email addresses that are responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to these addresses. +
              #### [getAccountBackupHistory](/reference/services/SoftLayer_Account/getAccountBackupHistory) This method provides a history of account backups. +
              #### [getAccountContacts](/reference/services/SoftLayer_Account/getAccountContacts) Retrieve the account contacts on an account. +
              #### [getAccountLicenses](/reference/services/SoftLayer_Account/getAccountLicenses) Retrieve the account software licenses owned by an account +
              #### [getAccountLinks](/reference/services/SoftLayer_Account/getAccountLinks) +
              #### [getAccountStatus](/reference/services/SoftLayer_Account/getAccountStatus) Retrieve an account's status presented in a more detailed data type. +
              #### [getAccountTraitValue](/reference/services/SoftLayer_Account/getAccountTraitValue) Get the specific trait by its key +
              #### [getActiveAccountDiscountBillingItem](/reference/services/SoftLayer_Account/getActiveAccountDiscountBillingItem) Retrieve the billing item associated with an account's monthly discount. +
              #### [getActiveAccountLicenses](/reference/services/SoftLayer_Account/getActiveAccountLicenses) Retrieve the active account software licenses owned by an account +
              #### [getActiveAddresses](/reference/services/SoftLayer_Account/getActiveAddresses) Retrieve the active address(es) that belong to an account. +
              #### [getActiveAgreements](/reference/services/SoftLayer_Account/getActiveAgreements) Retrieve all active agreements for an account +
              #### [getActiveBillingAgreements](/reference/services/SoftLayer_Account/getActiveBillingAgreements) Retrieve all billing agreements for an account +
              #### [getActiveCatalystEnrollment](/reference/services/SoftLayer_Account/getActiveCatalystEnrollment) +
              #### [getActiveColocationContainers](/reference/services/SoftLayer_Account/getActiveColocationContainers) Retrieve the account's active top level colocation containers. +
              #### [getActiveFlexibleCreditEnrollment](/reference/services/SoftLayer_Account/getActiveFlexibleCreditEnrollment) Retrieve [Deprecated] Please use SoftLayer_Account::activeFlexibleCreditEnrollments. +
              #### [getActiveFlexibleCreditEnrollments](/reference/services/SoftLayer_Account/getActiveFlexibleCreditEnrollments) +
              #### [getActiveNotificationSubscribers](/reference/services/SoftLayer_Account/getActiveNotificationSubscribers) +
              -
              +
              #### [getActiveOutletPackages](/reference/services/SoftLayer_Account/getActiveOutletPackages) DEPRECATED. This method will return nothing. + +Deprecated + +
              #### [getActivePackages](/reference/services/SoftLayer_Account/getActivePackages) Retrieve the active [SoftLayer_Product_Package]({{}}) objects from which you can order a server, service or software. +
              -
              +
              #### [getActivePackagesByAttribute](/reference/services/SoftLayer_Account/getActivePackagesByAttribute) [DEPRECATED] Retrieve the active [SoftLayer_Product_Package]({{}}) objects from which you can order a server, service or software filtered by an attribute type ([SoftLayer_Product_Package_Attribute_Type]({{}})) on the package. + +Deprecated + +
              -
              +
              #### [getActivePrivateHostedCloudPackages](/reference/services/SoftLayer_Account/getActivePrivateHostedCloudPackages) + +Deprecated + +
              #### [getActiveQuotes](/reference/services/SoftLayer_Account/getActiveQuotes) Retrieve an account's non-expired quotes. +
              #### [getActiveReservedCapacityAgreements](/reference/services/SoftLayer_Account/getActiveReservedCapacityAgreements) Retrieve active reserved capacity agreements for an account +
              #### [getActiveVirtualLicenses](/reference/services/SoftLayer_Account/getActiveVirtualLicenses) Retrieve the virtual software licenses controlled by an account +
              #### [getAdcLoadBalancers](/reference/services/SoftLayer_Account/getAdcLoadBalancers) Retrieve an account's associated load balancers. +
              #### [getAddresses](/reference/services/SoftLayer_Account/getAddresses) Retrieve all the address(es) that belong to an account. +
              #### [getAffiliateId](/reference/services/SoftLayer_Account/getAffiliateId) Retrieve an affiliate identifier associated with the customer account. +
              #### [getAggregatedUptimeGraph](/reference/services/SoftLayer_Account/getAggregatedUptimeGraph) Returns URL uptime data for your account +
              #### [getAllBillingItems](/reference/services/SoftLayer_Account/getAllBillingItems) Retrieve the billing items that will be on an account's next invoice. +
              #### [getAllCommissionBillingItems](/reference/services/SoftLayer_Account/getAllCommissionBillingItems) Retrieve the billing items that will be on an account's next invoice. +
              #### [getAllRecurringTopLevelBillingItems](/reference/services/SoftLayer_Account/getAllRecurringTopLevelBillingItems) Retrieve the billing items that will be on an account's next invoice. +
              #### [getAllRecurringTopLevelBillingItemsUnfiltered](/reference/services/SoftLayer_Account/getAllRecurringTopLevelBillingItemsUnfiltered) Retrieve the billing items that will be on an account's next invoice. Does not consider associated items. +
              #### [getAllSubnetBillingItems](/reference/services/SoftLayer_Account/getAllSubnetBillingItems) Retrieve the billing items that will be on an account's next invoice. +
              #### [getAllTopLevelBillingItems](/reference/services/SoftLayer_Account/getAllTopLevelBillingItems) Retrieve all billing items of an account. +
              #### [getAllTopLevelBillingItemsUnfiltered](/reference/services/SoftLayer_Account/getAllTopLevelBillingItemsUnfiltered) Retrieve the billing items that will be on an account's next invoice. Does not consider associated items. +
              #### [getAllowIbmIdSilentMigrationFlag](/reference/services/SoftLayer_Account/getAllowIbmIdSilentMigrationFlag) Retrieve indicates whether this account is allowed to silently migrate to use IBMid Authentication. +
              #### [getAllowsBluemixAccountLinkingFlag](/reference/services/SoftLayer_Account/getAllowsBluemixAccountLinkingFlag) Retrieve flag indicating if this account can be linked with Bluemix. +
              #### [getAlternateCreditCardData](/reference/services/SoftLayer_Account/getAlternateCreditCardData) +
              #### [getApplicationDeliveryControllers](/reference/services/SoftLayer_Account/getApplicationDeliveryControllers) Retrieve an account's associated application delivery controller records. +
              #### [getAttributeByType](/reference/services/SoftLayer_Account/getAttributeByType) Retrieve an account attribute by type key name. +
              #### [getAttributes](/reference/services/SoftLayer_Account/getAttributes) Retrieve the account attribute values for a SoftLayer customer account. +
              #### [getAuxiliaryNotifications](/reference/services/SoftLayer_Account/getAuxiliaryNotifications) +
              #### [getAvailablePublicNetworkVlans](/reference/services/SoftLayer_Account/getAvailablePublicNetworkVlans) Retrieve the public network VLANs assigned to an account. +
              #### [getAverageArchiveUsageMetricDataByDate](/reference/services/SoftLayer_Account/getAverageArchiveUsageMetricDataByDate) Returns the average disk usage for all archive repositories for the timeframe based on the parameters provided. +
              #### [getAveragePublicUsageMetricDataByDate](/reference/services/SoftLayer_Account/getAveragePublicUsageMetricDataByDate) Returns the average disk usage for all public repositories for the timeframe based on the parameters provided. +
              #### [getBalance](/reference/services/SoftLayer_Account/getBalance) Retrieve the account balance of a SoftLayer customer account. An account's balance is the amount of money owed to SoftLayer by the account holder, returned as a floating point number with two decimal places, measured in US Dollars ($USD). A negative account balance means the account holder has overpaid and is owed money by SoftLayer. +
              #### [getBandwidthAllotments](/reference/services/SoftLayer_Account/getBandwidthAllotments) Retrieve the bandwidth allotments for an account. +
              #### [getBandwidthAllotmentsOverAllocation](/reference/services/SoftLayer_Account/getBandwidthAllotmentsOverAllocation) Retrieve the bandwidth allotments for an account currently over allocation. +
              #### [getBandwidthAllotmentsProjectedOverAllocation](/reference/services/SoftLayer_Account/getBandwidthAllotmentsProjectedOverAllocation) Retrieve the bandwidth allotments for an account projected to go over allocation. +
              #### [getBandwidthList](/reference/services/SoftLayer_Account/getBandwidthList) +
              #### [getBareMetalInstances](/reference/services/SoftLayer_Account/getBareMetalInstances) Retrieve an account's associated bare metal server objects. +
              #### [getBillingAgreements](/reference/services/SoftLayer_Account/getBillingAgreements) Retrieve all billing agreements for an account +
              #### [getBillingInfo](/reference/services/SoftLayer_Account/getBillingInfo) Retrieve an account's billing information. +
              #### [getBlockDeviceTemplateGroups](/reference/services/SoftLayer_Account/getBlockDeviceTemplateGroups) Retrieve private template group objects (parent and children) and the shared template group objects (parent only) for an account. +
              #### [getBluemixAccountLink](/reference/services/SoftLayer_Account/getBluemixAccountLink) Retrieve the Bluemix account link associated with this SoftLayer account, if one exists. +
              #### [getBluemixLinkedFlag](/reference/services/SoftLayer_Account/getBluemixLinkedFlag) Retrieve returns true if this account is linked to IBM Bluemix, false if not. +
              #### [getBrand](/reference/services/SoftLayer_Account/getBrand) +
              #### [getBrandAccountFlag](/reference/services/SoftLayer_Account/getBrandAccountFlag) +
              #### [getBrandKeyName](/reference/services/SoftLayer_Account/getBrandKeyName) Retrieve the brand keyName. +
              #### [getBusinessPartner](/reference/services/SoftLayer_Account/getBusinessPartner) Retrieve the Business Partner details for the account. Country Enterprise Code, Channel, Segment, Reseller Level. +
              #### [getCanOrderAdditionalVlansFlag](/reference/services/SoftLayer_Account/getCanOrderAdditionalVlansFlag) Retrieve [DEPRECATED] All accounts may order VLANs. +
              #### [getCarts](/reference/services/SoftLayer_Account/getCarts) Retrieve an account's active carts. +
              #### [getCatalystEnrollments](/reference/services/SoftLayer_Account/getCatalystEnrollments) +
              #### [getClosedTickets](/reference/services/SoftLayer_Account/getClosedTickets) Retrieve all closed tickets associated with an account. +
              -
              +
              #### [getCurrentBackupStatisticsGraph](/reference/services/SoftLayer_Account/getCurrentBackupStatisticsGraph) This method retrieves a pie chart for today's backup statistics. + +Deprecated + +
              -
              +
              #### [getCurrentTicketStatisticsGraph](/reference/services/SoftLayer_Account/getCurrentTicketStatisticsGraph) (Deprecated) + +Deprecated + +
              #### [getCurrentUser](/reference/services/SoftLayer_Account/getCurrentUser) Retrieve the current API user's record. +
              #### [getDatacentersWithSubnetAllocations](/reference/services/SoftLayer_Account/getDatacentersWithSubnetAllocations) Retrieve datacenters which contain subnets that the account has access to route. +
              #### [getDedicatedHosts](/reference/services/SoftLayer_Account/getDedicatedHosts) Retrieve an account's associated virtual dedicated host objects. +
              #### [getDedicatedHostsForImageTemplate](/reference/services/SoftLayer_Account/getDedicatedHostsForImageTemplate) Get a collection of dedicated hosts that are valid for a given image template. +
              #### [getDisablePaymentProcessingFlag](/reference/services/SoftLayer_Account/getDisablePaymentProcessingFlag) Retrieve a flag indicating whether payments are processed for this account. +
              #### [getDiskUsageMetricDataByDate](/reference/services/SoftLayer_Account/getDiskUsageMetricDataByDate) Retrieve the metric data for disk space usage for a storage repository from the Metric Tracking Object System and the Legacy Data Warehouse. +
              #### [getDiskUsageMetricDataFromLegacyByDate](/reference/services/SoftLayer_Account/getDiskUsageMetricDataFromLegacyByDate) Retrieve the metric data for disk space usage for a storage repository from the Legacy Data Warehouse. +
              #### [getDiskUsageMetricDataFromMetricTrackingObjectSystemByDate](/reference/services/SoftLayer_Account/getDiskUsageMetricDataFromMetricTrackingObjectSystemByDate) Retrieve the metric data for disk space usage for a storage repository from the Metric Tracking Object System. +
              -
              +
              #### [getDiskUsageMetricImageByDate](/reference/services/SoftLayer_Account/getDiskUsageMetricImageByDate) Retrieve an image of the disk usage data on a [SoftLayer_Virtual_Guest]({{}}) image for the time range you provide. + +Deprecated + +
              #### [getDisplaySupportRepresentativeAssignments](/reference/services/SoftLayer_Account/getDisplaySupportRepresentativeAssignments) Retrieve the SoftLayer employees that an account is assigned to. +
              #### [getDomainRegistrations](/reference/services/SoftLayer_Account/getDomainRegistrations) +
              #### [getDomains](/reference/services/SoftLayer_Account/getDomains) Retrieve the DNS domains associated with an account. +
              #### [getDomainsWithoutSecondaryDnsRecords](/reference/services/SoftLayer_Account/getDomainsWithoutSecondaryDnsRecords) Retrieve the DNS domains associated with an account that were not created as a result of a secondary DNS zone transfer. +
              #### [getEuSupportedFlag](/reference/services/SoftLayer_Account/getEuSupportedFlag) Retrieve boolean flag dictating whether or not this account has the EU Supported flag. This flag indicates that this account uses IBM Cloud services to process EU citizen's personal data. +
              #### [getEvaultCapacityGB](/reference/services/SoftLayer_Account/getEvaultCapacityGB) Retrieve the total capacity of Legacy EVault Volumes on an account, in GB. +
              #### [getEvaultMasterUsers](/reference/services/SoftLayer_Account/getEvaultMasterUsers) Retrieve an account's master EVault user. This is only used when an account has EVault service. +
              #### [getEvaultNetworkStorage](/reference/services/SoftLayer_Account/getEvaultNetworkStorage) Retrieve an account's associated EVault storage volumes. +
              #### [getExecutiveSummaryPdf](/reference/services/SoftLayer_Account/getExecutiveSummaryPdf) This method provides an executive summary PDF for managed hosting services. +
              #### [getExpiredSecurityCertificates](/reference/services/SoftLayer_Account/getExpiredSecurityCertificates) Retrieve stored security certificates that are expired (ie. SSL) +
              #### [getFacilityLogs](/reference/services/SoftLayer_Account/getFacilityLogs) Retrieve logs of who entered a colocation area which is assigned to this account, or when a user under this account enters a datacenter. +
              #### [getFileBlockBetaAccessFlag](/reference/services/SoftLayer_Account/getFileBlockBetaAccessFlag) +
              #### [getFlexibleCreditEnrollments](/reference/services/SoftLayer_Account/getFlexibleCreditEnrollments) Retrieve all of the account's current and former Flexible Credit enrollments. +
              -
              +
              #### [getFlexibleCreditProgramInfo](/reference/services/SoftLayer_Account/getFlexibleCreditProgramInfo) [DEPRECATED] Please use SoftLayer_Account::getFlexibleCreditProgramsInfo. This is no longer an accurate representation of discounts. + +Deprecated + +
              #### [getFlexibleCreditProgramsInfo](/reference/services/SoftLayer_Account/getFlexibleCreditProgramsInfo) This method retrieves information on all of your Flexible Credit Program enrollments for your account. +
              #### [getForcePaasAccountLinkDate](/reference/services/SoftLayer_Account/getForcePaasAccountLinkDate) Retrieve timestamp representing the point in time when an account is required to link with PaaS. +
              #### [getGlobalIpRecords](/reference/services/SoftLayer_Account/getGlobalIpRecords) +
              #### [getGlobalIpv4Records](/reference/services/SoftLayer_Account/getGlobalIpv4Records) +
              #### [getGlobalIpv6Records](/reference/services/SoftLayer_Account/getGlobalIpv6Records) +
              #### [getGlobalLoadBalancerAccounts](/reference/services/SoftLayer_Account/getGlobalLoadBalancerAccounts) Retrieve [Deprecated] The global load balancer accounts for a softlayer customer account. +
              #### [getHardware](/reference/services/SoftLayer_Account/getHardware) Retrieve an account's associated hardware objects. +
              #### [getHardwareOverBandwidthAllocation](/reference/services/SoftLayer_Account/getHardwareOverBandwidthAllocation) Retrieve an account's associated hardware objects currently over bandwidth allocation. +
              #### [getHardwarePools](/reference/services/SoftLayer_Account/getHardwarePools) Get a collection of managed hardware pools. +
              #### [getHardwareProjectedOverBandwidthAllocation](/reference/services/SoftLayer_Account/getHardwareProjectedOverBandwidthAllocation) Retrieve an account's associated hardware objects projected to go over bandwidth allocation. +
              #### [getHardwareWithCpanel](/reference/services/SoftLayer_Account/getHardwareWithCpanel) Retrieve all hardware associated with an account that has the cPanel web hosting control panel installed. +
              #### [getHardwareWithHelm](/reference/services/SoftLayer_Account/getHardwareWithHelm) Retrieve all hardware associated with an account that has the Helm web hosting control panel installed. +
              #### [getHardwareWithMcafee](/reference/services/SoftLayer_Account/getHardwareWithMcafee) Retrieve all hardware associated with an account that has McAfee Secure software components. +
              #### [getHardwareWithMcafeeAntivirusRedhat](/reference/services/SoftLayer_Account/getHardwareWithMcafeeAntivirusRedhat) Retrieve all hardware associated with an account that has McAfee Secure AntiVirus for Redhat software components. +
              #### [getHardwareWithMcafeeAntivirusWindows](/reference/services/SoftLayer_Account/getHardwareWithMcafeeAntivirusWindows) Retrieve all hardware associated with an account that has McAfee Secure AntiVirus for Windows software components. +
              #### [getHardwareWithMcafeeIntrusionDetectionSystem](/reference/services/SoftLayer_Account/getHardwareWithMcafeeIntrusionDetectionSystem) Retrieve all hardware associated with an account that has McAfee Secure Intrusion Detection System software components. +
              #### [getHardwareWithPlesk](/reference/services/SoftLayer_Account/getHardwareWithPlesk) Retrieve all hardware associated with an account that has the Plesk web hosting control panel installed. +
              #### [getHardwareWithQuantastor](/reference/services/SoftLayer_Account/getHardwareWithQuantastor) Retrieve all hardware associated with an account that has the QuantaStor storage system installed. +
              #### [getHardwareWithUrchin](/reference/services/SoftLayer_Account/getHardwareWithUrchin) Retrieve all hardware associated with an account that has the Urchin web traffic analytics package installed. +
              #### [getHardwareWithWindows](/reference/services/SoftLayer_Account/getHardwareWithWindows) Retrieve all hardware associated with an account that is running a version of the Microsoft Windows operating system. +
              #### [getHasEvaultBareMetalRestorePluginFlag](/reference/services/SoftLayer_Account/getHasEvaultBareMetalRestorePluginFlag) Retrieve return 1 if one of the account's hardware has the EVault Bare Metal Server Restore Plugin otherwise 0. +
              #### [getHasIderaBareMetalRestorePluginFlag](/reference/services/SoftLayer_Account/getHasIderaBareMetalRestorePluginFlag) Retrieve return 1 if one of the account's hardware has an installation of Idera Server Backup otherwise 0. +
              #### [getHasPendingOrder](/reference/services/SoftLayer_Account/getHasPendingOrder) Retrieve the number of orders in a PENDING status for a SoftLayer customer account. +
              #### [getHasR1softBareMetalRestorePluginFlag](/reference/services/SoftLayer_Account/getHasR1softBareMetalRestorePluginFlag) Retrieve return 1 if one of the account's hardware has an installation of R1Soft CDP otherwise 0. +
              #### [getHistoricalBackupGraph](/reference/services/SoftLayer_Account/getHistoricalBackupGraph) +
              -
              +
              #### [getHistoricalBandwidthGraph](/reference/services/SoftLayer_Account/getHistoricalBandwidthGraph) [DEPRECATED] This method returns a line graph of bandwidth statistics. + +Deprecated + +
              #### [getHistoricalTicketGraph](/reference/services/SoftLayer_Account/getHistoricalTicketGraph) This method returns a pie chart of ticket statistics for the given dates. +
              #### [getHistoricalUptimeGraph](/reference/services/SoftLayer_Account/getHistoricalUptimeGraph) This method returns a SoftLayer_Container_Account_Graph_Outputs object for the specified date range. +
              #### [getHourlyBareMetalInstances](/reference/services/SoftLayer_Account/getHourlyBareMetalInstances) Retrieve an account's associated hourly bare metal server objects. +
              #### [getHourlyServiceBillingItems](/reference/services/SoftLayer_Account/getHourlyServiceBillingItems) Retrieve hourly service billing items that will be on an account's next invoice. +
              #### [getHourlyVirtualGuests](/reference/services/SoftLayer_Account/getHourlyVirtualGuests) Retrieve an account's associated hourly virtual guest objects. +
              #### [getHubNetworkStorage](/reference/services/SoftLayer_Account/getHubNetworkStorage) Retrieve an account's associated Virtual Storage volumes. +
              #### [getIbmCustomerNumber](/reference/services/SoftLayer_Account/getIbmCustomerNumber) Retrieve unique identifier for a customer used throughout IBM. +
              #### [getIbmIdAuthenticationRequiredFlag](/reference/services/SoftLayer_Account/getIbmIdAuthenticationRequiredFlag) Retrieve indicates whether this account requires IBMid authentication. +
              #### [getIbmIdMigrationExpirationTimestamp](/reference/services/SoftLayer_Account/getIbmIdMigrationExpirationTimestamp) Retrieve this key is deprecated and should not be used. +
              #### [getInProgressExternalAccountSetup](/reference/services/SoftLayer_Account/getInProgressExternalAccountSetup) Retrieve an in progress request to switch billing systems. +
              #### [getInternalNotes](/reference/services/SoftLayer_Account/getInternalNotes) +
              #### [getInvoices](/reference/services/SoftLayer_Account/getInvoices) Retrieve an account's associated billing invoices. +
              #### [getIpAddresses](/reference/services/SoftLayer_Account/getIpAddresses) +
              #### [getIscsiIsolationDisabled](/reference/services/SoftLayer_Account/getIscsiIsolationDisabled) +
              #### [getIscsiNetworkStorage](/reference/services/SoftLayer_Account/getIscsiNetworkStorage) Retrieve an account's associated iSCSI storage volumes. +
              @@ -912,1140 +1082,1333 @@ Computes the number of available public secondary IP addresses, augmented by the 0 is returned if an overflow is detected. The use of $locationId has been deprecated. +
              #### [getLastCanceledBillingItem](/reference/services/SoftLayer_Account/getLastCanceledBillingItem) Retrieve the most recently canceled billing item. +
              #### [getLastCancelledServerBillingItem](/reference/services/SoftLayer_Account/getLastCancelledServerBillingItem) Retrieve the most recent cancelled server billing item. +
              #### [getLastFiveClosedAbuseTickets](/reference/services/SoftLayer_Account/getLastFiveClosedAbuseTickets) Retrieve the five most recently closed abuse tickets associated with an account. +
              #### [getLastFiveClosedAccountingTickets](/reference/services/SoftLayer_Account/getLastFiveClosedAccountingTickets) Retrieve the five most recently closed accounting tickets associated with an account. +
              #### [getLastFiveClosedOtherTickets](/reference/services/SoftLayer_Account/getLastFiveClosedOtherTickets) Retrieve the five most recently closed tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account. +
              #### [getLastFiveClosedSalesTickets](/reference/services/SoftLayer_Account/getLastFiveClosedSalesTickets) Retrieve the five most recently closed sales tickets associated with an account. +
              #### [getLastFiveClosedSupportTickets](/reference/services/SoftLayer_Account/getLastFiveClosedSupportTickets) Retrieve the five most recently closed support tickets associated with an account. +
              #### [getLastFiveClosedTickets](/reference/services/SoftLayer_Account/getLastFiveClosedTickets) Retrieve the five most recently closed tickets associated with an account. +
              #### [getLatestBillDate](/reference/services/SoftLayer_Account/getLatestBillDate) Retrieve an account's most recent billing date. +
              #### [getLatestRecurringInvoice](/reference/services/SoftLayer_Account/getLatestRecurringInvoice) Retrieve an account's latest recurring invoice. +
              #### [getLatestRecurringPendingInvoice](/reference/services/SoftLayer_Account/getLatestRecurringPendingInvoice) Retrieve an account's latest recurring pending invoice. +
              #### [getLegacyBandwidthAllotments](/reference/services/SoftLayer_Account/getLegacyBandwidthAllotments) Retrieve the legacy bandwidth allotments for an account. +
              #### [getLegacyIscsiCapacityGB](/reference/services/SoftLayer_Account/getLegacyIscsiCapacityGB) Retrieve the total capacity of Legacy iSCSI Volumes on an account, in GB. +
              #### [getLoadBalancers](/reference/services/SoftLayer_Account/getLoadBalancers) Retrieve an account's associated load balancers. +
              #### [getLockboxCapacityGB](/reference/services/SoftLayer_Account/getLockboxCapacityGB) Retrieve the total capacity of Legacy lockbox Volumes on an account, in GB. +
              #### [getLockboxNetworkStorage](/reference/services/SoftLayer_Account/getLockboxNetworkStorage) Retrieve an account's associated Lockbox storage volumes. +
              #### [getManualPaymentsUnderReview](/reference/services/SoftLayer_Account/getManualPaymentsUnderReview) +
              #### [getMasterUser](/reference/services/SoftLayer_Account/getMasterUser) Retrieve an account's master user. +
              #### [getMediaDataTransferRequests](/reference/services/SoftLayer_Account/getMediaDataTransferRequests) Retrieve an account's media transfer service requests. +
              #### [getMigratedToIbmCloudPortalFlag](/reference/services/SoftLayer_Account/getMigratedToIbmCloudPortalFlag) Retrieve flag indicating whether this account is restricted to the IBM Cloud portal. +
              #### [getMonthlyBareMetalInstances](/reference/services/SoftLayer_Account/getMonthlyBareMetalInstances) Retrieve an account's associated monthly bare metal server objects. +
              #### [getMonthlyVirtualGuests](/reference/services/SoftLayer_Account/getMonthlyVirtualGuests) Retrieve an account's associated monthly virtual guest objects. +
              #### [getNasNetworkStorage](/reference/services/SoftLayer_Account/getNasNetworkStorage) Retrieve an account's associated NAS storage volumes. +
              #### [getNetAppActiveAccountLicenseKeys](/reference/services/SoftLayer_Account/getNetAppActiveAccountLicenseKeys) Get a collection of active NetApp software account license keys. +
              #### [getNetworkCreationFlag](/reference/services/SoftLayer_Account/getNetworkCreationFlag) Retrieve [Deprecated] Whether or not this account can define their own networks. +
              #### [getNetworkGateways](/reference/services/SoftLayer_Account/getNetworkGateways) Retrieve all network gateway devices on this account. +
              #### [getNetworkHardware](/reference/services/SoftLayer_Account/getNetworkHardware) Retrieve an account's associated network hardware. +
              #### [getNetworkMessageDeliveryAccounts](/reference/services/SoftLayer_Account/getNetworkMessageDeliveryAccounts) +
              #### [getNetworkMonitorDownHardware](/reference/services/SoftLayer_Account/getNetworkMonitorDownHardware) Retrieve hardware which is currently experiencing a service failure. +
              #### [getNetworkMonitorDownVirtualGuests](/reference/services/SoftLayer_Account/getNetworkMonitorDownVirtualGuests) Retrieve virtual guest which is currently experiencing a service failure. +
              #### [getNetworkMonitorRecoveringHardware](/reference/services/SoftLayer_Account/getNetworkMonitorRecoveringHardware) Retrieve hardware which is currently recovering from a service failure. +
              #### [getNetworkMonitorRecoveringVirtualGuests](/reference/services/SoftLayer_Account/getNetworkMonitorRecoveringVirtualGuests) Retrieve virtual guest which is currently recovering from a service failure. +
              #### [getNetworkMonitorUpHardware](/reference/services/SoftLayer_Account/getNetworkMonitorUpHardware) Retrieve hardware which is currently online. +
              #### [getNetworkMonitorUpVirtualGuests](/reference/services/SoftLayer_Account/getNetworkMonitorUpVirtualGuests) Retrieve virtual guest which is currently online. +
              #### [getNetworkStorage](/reference/services/SoftLayer_Account/getNetworkStorage) Retrieve an account's associated storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes. +
              #### [getNetworkStorageGroups](/reference/services/SoftLayer_Account/getNetworkStorageGroups) Retrieve an account's Network Storage groups. +
              #### [getNetworkTunnelContexts](/reference/services/SoftLayer_Account/getNetworkTunnelContexts) Retrieve iPSec network tunnels for an account. +
              #### [getNetworkVlanSpan](/reference/services/SoftLayer_Account/getNetworkVlanSpan) Retrieve whether or not an account has automatic private VLAN spanning enabled. +
              #### [getNetworkVlans](/reference/services/SoftLayer_Account/getNetworkVlans) Retrieve all network VLANs assigned to an account. +
              #### [getNextBillingPublicAllotmentHardwareBandwidthDetails](/reference/services/SoftLayer_Account/getNextBillingPublicAllotmentHardwareBandwidthDetails) Retrieval: DEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED. The allotments for this account and their servers for the next billing cycle. The public inbound and outbound bandwidth is calculated for each server in addition to the daily average network traffic since the last billing date. +
              #### [getNextInvoiceExcel](/reference/services/SoftLayer_Account/getNextInvoiceExcel) Retrieve the next billing period's invoice. Note, this should be considered preliminary as you may add, remove, change billing items on your account. +
              #### [getNextInvoiceIncubatorExemptTotal](/reference/services/SoftLayer_Account/getNextInvoiceIncubatorExemptTotal) Retrieve the pre-tax total amount exempt from incubator credit for the account's next invoice. This field is now deprecated and will soon be removed. Please update all references to instead use nextInvoiceTotalAmount +
              #### [getNextInvoicePdf](/reference/services/SoftLayer_Account/getNextInvoicePdf) Retrieve the next billing period's invoice. Note, this should be considered preliminary as you may add, remove, change billing items on your account. +
              #### [getNextInvoicePdfDetailed](/reference/services/SoftLayer_Account/getNextInvoicePdfDetailed) Retrieve the next billing period's detailed invoice. Note, this should be considered preliminary as you may add, remove, change billing items on your account. +
              #### [getNextInvoiceRecurringAmountEligibleForAccountDiscount](/reference/services/SoftLayer_Account/getNextInvoiceRecurringAmountEligibleForAccountDiscount) Retrieve the total recurring charge amount of an account's next invoice eligible for account discount measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. +
              #### [getNextInvoiceTopLevelBillingItems](/reference/services/SoftLayer_Account/getNextInvoiceTopLevelBillingItems) Retrieve the billing items that will be on an account's next invoice. +
              #### [getNextInvoiceTotalAmount](/reference/services/SoftLayer_Account/getNextInvoiceTotalAmount) Retrieve the pre-tax total amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. +
              #### [getNextInvoiceTotalOneTimeAmount](/reference/services/SoftLayer_Account/getNextInvoiceTotalOneTimeAmount) Retrieve the total one-time charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. +
              #### [getNextInvoiceTotalOneTimeTaxAmount](/reference/services/SoftLayer_Account/getNextInvoiceTotalOneTimeTaxAmount) Retrieve the total one-time tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. +
              #### [getNextInvoiceTotalRecurringAmount](/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringAmount) Retrieve the total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. +
              #### [getNextInvoiceTotalRecurringAmountBeforeAccountDiscount](/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringAmountBeforeAccountDiscount) Retrieve the total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. +
              #### [getNextInvoiceTotalRecurringTaxAmount](/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringTaxAmount) Retrieve the total recurring tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. +
              #### [getNextInvoiceTotalTaxableRecurringAmount](/reference/services/SoftLayer_Account/getNextInvoiceTotalTaxableRecurringAmount) Retrieve the total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. +
              #### [getNextInvoiceZeroFeeItemCounts](/reference/services/SoftLayer_Account/getNextInvoiceZeroFeeItemCounts) +
              #### [getNotificationSubscribers](/reference/services/SoftLayer_Account/getNotificationSubscribers) +
              #### [getObject](/reference/services/SoftLayer_Account/getObject) Retrieve a SoftLayer_Account record. +
              #### [getOpenAbuseTickets](/reference/services/SoftLayer_Account/getOpenAbuseTickets) Retrieve the open abuse tickets associated with an account. +
              #### [getOpenAccountingTickets](/reference/services/SoftLayer_Account/getOpenAccountingTickets) Retrieve the open accounting tickets associated with an account. +
              #### [getOpenBillingTickets](/reference/services/SoftLayer_Account/getOpenBillingTickets) Retrieve the open billing tickets associated with an account. +
              #### [getOpenCancellationRequests](/reference/services/SoftLayer_Account/getOpenCancellationRequests) Retrieve an open ticket requesting cancellation of this server, if one exists. +
              #### [getOpenOtherTickets](/reference/services/SoftLayer_Account/getOpenOtherTickets) Retrieve the open tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account. +
              #### [getOpenRecurringInvoices](/reference/services/SoftLayer_Account/getOpenRecurringInvoices) Retrieve an account's recurring invoices. +
              #### [getOpenSalesTickets](/reference/services/SoftLayer_Account/getOpenSalesTickets) Retrieve the open sales tickets associated with an account. +
              #### [getOpenStackAccountLinks](/reference/services/SoftLayer_Account/getOpenStackAccountLinks) +
              #### [getOpenStackObjectStorage](/reference/services/SoftLayer_Account/getOpenStackObjectStorage) Retrieve an account's associated Openstack related Object Storage accounts. +
              #### [getOpenSupportTickets](/reference/services/SoftLayer_Account/getOpenSupportTickets) Retrieve the open support tickets associated with an account. +
              #### [getOpenTickets](/reference/services/SoftLayer_Account/getOpenTickets) Retrieve all open tickets associated with an account. +
              #### [getOpenTicketsWaitingOnCustomer](/reference/services/SoftLayer_Account/getOpenTicketsWaitingOnCustomer) Retrieve all open tickets associated with an account last edited by an employee. +
              #### [getOrders](/reference/services/SoftLayer_Account/getOrders) Retrieve an account's associated billing orders excluding upgrades. +
              #### [getOrphanBillingItems](/reference/services/SoftLayer_Account/getOrphanBillingItems) Retrieve the billing items that have no parent billing item. These are items that don't necessarily belong to a single server. +
              #### [getOwnedBrands](/reference/services/SoftLayer_Account/getOwnedBrands) +
              #### [getOwnedHardwareGenericComponentModels](/reference/services/SoftLayer_Account/getOwnedHardwareGenericComponentModels) +
              #### [getPaymentProcessors](/reference/services/SoftLayer_Account/getPaymentProcessors) +
              #### [getPendingCreditCardChangeRequestData](/reference/services/SoftLayer_Account/getPendingCreditCardChangeRequestData) Retrieve details of all credit card change requests which have not been processed by a SoftLayer agent. +
              #### [getPendingEvents](/reference/services/SoftLayer_Account/getPendingEvents) +
              #### [getPendingInvoice](/reference/services/SoftLayer_Account/getPendingInvoice) Retrieve an account's latest open (pending) invoice. +
              #### [getPendingInvoiceTopLevelItems](/reference/services/SoftLayer_Account/getPendingInvoiceTopLevelItems) Retrieve a list of top-level invoice items that are on an account's currently pending invoice. +
              #### [getPendingInvoiceTotalAmount](/reference/services/SoftLayer_Account/getPendingInvoiceTotalAmount) Retrieve the total amount of an account's pending invoice, if one exists. +
              #### [getPendingInvoiceTotalOneTimeAmount](/reference/services/SoftLayer_Account/getPendingInvoiceTotalOneTimeAmount) Retrieve the total one-time charges for an account's pending invoice, if one exists. In other words, it is the sum of one-time charges, setup fees, and labor fees. It does not include taxes. +
              #### [getPendingInvoiceTotalOneTimeTaxAmount](/reference/services/SoftLayer_Account/getPendingInvoiceTotalOneTimeTaxAmount) Retrieve the sum of all the taxes related to one time charges for an account's pending invoice, if one exists. +
              #### [getPendingInvoiceTotalRecurringAmount](/reference/services/SoftLayer_Account/getPendingInvoiceTotalRecurringAmount) Retrieve the total recurring amount of an account's pending invoice, if one exists. +
              #### [getPendingInvoiceTotalRecurringTaxAmount](/reference/services/SoftLayer_Account/getPendingInvoiceTotalRecurringTaxAmount) Retrieve the total amount of the recurring taxes on an account's pending invoice, if one exists. +
              #### [getPermissionGroups](/reference/services/SoftLayer_Account/getPermissionGroups) Retrieve an account's permission groups. +
              #### [getPermissionRoles](/reference/services/SoftLayer_Account/getPermissionRoles) Retrieve an account's user roles. +
              #### [getPlacementGroups](/reference/services/SoftLayer_Account/getPlacementGroups) Retrieve an account's associated virtual placement groups. +
              #### [getPortableStorageVolumes](/reference/services/SoftLayer_Account/getPortableStorageVolumes) +
              #### [getPostProvisioningHooks](/reference/services/SoftLayer_Account/getPostProvisioningHooks) Retrieve customer specified URIs that are downloaded onto a newly provisioned or reloaded server. If the URI is sent over https it will be executed directly on the server. +
              #### [getPptpVpnAllowedFlag](/reference/services/SoftLayer_Account/getPptpVpnAllowedFlag) Retrieve (Deprecated) Boolean flag dictating whether or not this account supports PPTP VPN Access. +
              #### [getPptpVpnUsers](/reference/services/SoftLayer_Account/getPptpVpnUsers) Retrieve an account's associated portal users with PPTP VPN access. (Deprecated) +
              #### [getPreviousRecurringRevenue](/reference/services/SoftLayer_Account/getPreviousRecurringRevenue) Retrieve the total recurring amount for an accounts previous revenue. +
              #### [getPriceRestrictions](/reference/services/SoftLayer_Account/getPriceRestrictions) Retrieve the item price that an account is restricted to. +
              #### [getPriorityOneTickets](/reference/services/SoftLayer_Account/getPriorityOneTickets) Retrieve all priority one tickets associated with an account. +
              #### [getPrivateAllotmentHardwareBandwidthDetails](/reference/services/SoftLayer_Account/getPrivateAllotmentHardwareBandwidthDetails) Retrieval: DEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED. The allotments for this account and their servers. The private inbound and outbound bandwidth is calculated for each server in addition to the daily average network traffic since the last billing date. +
              #### [getPrivateBlockDeviceTemplateGroups](/reference/services/SoftLayer_Account/getPrivateBlockDeviceTemplateGroups) Retrieve private and shared template group objects (parent only) for an account. +
              #### [getPrivateIpAddresses](/reference/services/SoftLayer_Account/getPrivateIpAddresses) +
              #### [getPrivateNetworkVlans](/reference/services/SoftLayer_Account/getPrivateNetworkVlans) Retrieve the private network VLANs assigned to an account. +
              #### [getPrivateSubnets](/reference/services/SoftLayer_Account/getPrivateSubnets) Retrieve all private subnets associated with an account. +
              #### [getProofOfConceptAccountFlag](/reference/services/SoftLayer_Account/getProofOfConceptAccountFlag) Retrieve boolean flag indicating whether or not this account is a Proof of Concept account. +
              #### [getPublicAllotmentHardwareBandwidthDetails](/reference/services/SoftLayer_Account/getPublicAllotmentHardwareBandwidthDetails) Retrieval: DEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED. The allotments for this account and their servers. The public inbound and outbound bandwidth is calculated for each server in addition to the daily average network traffic since the last billing date. +
              #### [getPublicIpAddresses](/reference/services/SoftLayer_Account/getPublicIpAddresses) +
              #### [getPublicNetworkVlans](/reference/services/SoftLayer_Account/getPublicNetworkVlans) Retrieve the public network VLANs assigned to an account. +
              #### [getPublicSubnets](/reference/services/SoftLayer_Account/getPublicSubnets) Retrieve all public network subnets associated with an account. +
              #### [getQuotes](/reference/services/SoftLayer_Account/getQuotes) Retrieve an account's quotes. +
              #### [getRecentEvents](/reference/services/SoftLayer_Account/getRecentEvents) +
              #### [getReferralPartner](/reference/services/SoftLayer_Account/getReferralPartner) Retrieve the Referral Partner for this account, if any. +
              #### [getReferralPartnerCommissionForecast](/reference/services/SoftLayer_Account/getReferralPartnerCommissionForecast) +
              #### [getReferralPartnerCommissionHistory](/reference/services/SoftLayer_Account/getReferralPartnerCommissionHistory) +
              #### [getReferralPartnerCommissionPending](/reference/services/SoftLayer_Account/getReferralPartnerCommissionPending) +
              #### [getReferredAccounts](/reference/services/SoftLayer_Account/getReferredAccounts) Retrieve if this is a account is a referral partner, the accounts this referral partner has referred +
              #### [getRegulatedWorkloads](/reference/services/SoftLayer_Account/getRegulatedWorkloads) +
              #### [getRemoteManagementCommandRequests](/reference/services/SoftLayer_Account/getRemoteManagementCommandRequests) Retrieve remote management command requests for an account +
              #### [getReplicationEvents](/reference/services/SoftLayer_Account/getReplicationEvents) Retrieve the Replication events for all Network Storage volumes on an account. +
              #### [getRequireSilentIBMidUserCreation](/reference/services/SoftLayer_Account/getRequireSilentIBMidUserCreation) Retrieve indicates whether newly created users under this account will be associated with IBMid via an email requiring a response, or not. +
              #### [getReservedCapacityAgreements](/reference/services/SoftLayer_Account/getReservedCapacityAgreements) Retrieve all reserved capacity agreements for an account +
              #### [getReservedCapacityGroups](/reference/services/SoftLayer_Account/getReservedCapacityGroups) Retrieve the reserved capacity groups owned by this account. +
              #### [getResourceGroups](/reference/services/SoftLayer_Account/getResourceGroups) Retrieve an account's associated top-level resource groups. +
              #### [getRouters](/reference/services/SoftLayer_Account/getRouters) Retrieve all Routers that an accounts VLANs reside on +
              #### [getRwhoisData](/reference/services/SoftLayer_Account/getRwhoisData) Retrieval: DEPRECATED +
              #### [getSamlAuthentication](/reference/services/SoftLayer_Account/getSamlAuthentication) Retrieve the SAML configuration for this account. +
              #### [getScaleGroups](/reference/services/SoftLayer_Account/getScaleGroups) Retrieve all scale groups on this account. +
              #### [getSecondaryDomains](/reference/services/SoftLayer_Account/getSecondaryDomains) Retrieve the secondary DNS records for a SoftLayer customer account. +
              #### [getSecurityCertificates](/reference/services/SoftLayer_Account/getSecurityCertificates) Retrieve stored security certificates (ie. SSL) +
              #### [getSecurityGroups](/reference/services/SoftLayer_Account/getSecurityGroups) Retrieve the security groups belonging to this account. +
              #### [getSecurityLevel](/reference/services/SoftLayer_Account/getSecurityLevel) +
              #### [getSecurityScanRequests](/reference/services/SoftLayer_Account/getSecurityScanRequests) Retrieve an account's vulnerability scan requests. +
              #### [getServiceBillingItems](/reference/services/SoftLayer_Account/getServiceBillingItems) Retrieve the service billing items that will be on an account's next invoice. +
              #### [getSharedBlockDeviceTemplateGroups](/reference/services/SoftLayer_Account/getSharedBlockDeviceTemplateGroups) Get the collection of template group objects that have been shared with this account. +
              #### [getShipments](/reference/services/SoftLayer_Account/getShipments) Retrieve shipments that belong to the customer's account. +
              #### [getSshKeys](/reference/services/SoftLayer_Account/getSshKeys) Retrieve customer specified SSH keys that can be implemented onto a newly provisioned or reloaded server. +
              #### [getSslVpnUsers](/reference/services/SoftLayer_Account/getSslVpnUsers) Retrieve an account's associated portal users with SSL VPN access. +
              #### [getStandardPoolVirtualGuests](/reference/services/SoftLayer_Account/getStandardPoolVirtualGuests) Retrieve an account's virtual guest objects that are hosted on a user provisioned hypervisor. +
              #### [getSubnetRegistrationDetails](/reference/services/SoftLayer_Account/getSubnetRegistrationDetails) +
              #### [getSubnetRegistrations](/reference/services/SoftLayer_Account/getSubnetRegistrations) +
              #### [getSubnets](/reference/services/SoftLayer_Account/getSubnets) Retrieve all network subnets associated with an account. +
              #### [getSupportRepresentatives](/reference/services/SoftLayer_Account/getSupportRepresentatives) Retrieve the SoftLayer employees that an account is assigned to. +
              #### [getSupportSubscriptions](/reference/services/SoftLayer_Account/getSupportSubscriptions) Retrieve the active support subscriptions for this account. +
              #### [getSupportTier](/reference/services/SoftLayer_Account/getSupportTier) +
              #### [getSuppressInvoicesFlag](/reference/services/SoftLayer_Account/getSuppressInvoicesFlag) Retrieve a flag indicating to suppress invoices. +
              #### [getTags](/reference/services/SoftLayer_Account/getTags) +
              #### [getTechIncubatorProgramInfo](/reference/services/SoftLayer_Account/getTechIncubatorProgramInfo) This method retrieves the Technology Incubator Program information for your account. +
              #### [getThirdPartyPoliciesAcceptanceStatus](/reference/services/SoftLayer_Account/getThirdPartyPoliciesAcceptanceStatus) Get the acceptance status of the applicable third-party policies. +
              #### [getTickets](/reference/services/SoftLayer_Account/getTickets) Retrieve an account's associated tickets. +
              #### [getTicketsClosedInTheLastThreeDays](/reference/services/SoftLayer_Account/getTicketsClosedInTheLastThreeDays) Retrieve tickets closed within the last 72 hours or last 10 tickets, whichever is less, associated with an account. +
              #### [getTicketsClosedToday](/reference/services/SoftLayer_Account/getTicketsClosedToday) Retrieve tickets closed today associated with an account. +
              #### [getTranscodeAccounts](/reference/services/SoftLayer_Account/getTranscodeAccounts) Retrieve an account's associated Transcode account. +
              #### [getUpgradeRequests](/reference/services/SoftLayer_Account/getUpgradeRequests) Retrieve an account's associated upgrade requests. +
              #### [getUsers](/reference/services/SoftLayer_Account/getUsers) Retrieve an account's portal users. +
              #### [getValidSecurityCertificateEntries](/reference/services/SoftLayer_Account/getValidSecurityCertificateEntries) +
              #### [getValidSecurityCertificates](/reference/services/SoftLayer_Account/getValidSecurityCertificates) Retrieve stored security certificates that are not expired (ie. SSL) +
              #### [getVdrUpdatesInProgressFlag](/reference/services/SoftLayer_Account/getVdrUpdatesInProgressFlag) Retrieve return 0 if vpn updates are currently in progress on this account otherwise 1. +
              #### [getVirtualDedicatedRacks](/reference/services/SoftLayer_Account/getVirtualDedicatedRacks) Retrieve the bandwidth pooling for this account. +
              #### [getVirtualDiskImages](/reference/services/SoftLayer_Account/getVirtualDiskImages) Retrieve an account's associated virtual server virtual disk images. +
              #### [getVirtualGuests](/reference/services/SoftLayer_Account/getVirtualGuests) Retrieve an account's associated virtual guest objects. +
              #### [getVirtualGuestsOverBandwidthAllocation](/reference/services/SoftLayer_Account/getVirtualGuestsOverBandwidthAllocation) Retrieve an account's associated virtual guest objects currently over bandwidth allocation. +
              #### [getVirtualGuestsProjectedOverBandwidthAllocation](/reference/services/SoftLayer_Account/getVirtualGuestsProjectedOverBandwidthAllocation) Retrieve an account's associated virtual guest objects currently over bandwidth allocation. +
              #### [getVirtualGuestsWithCpanel](/reference/services/SoftLayer_Account/getVirtualGuestsWithCpanel) Retrieve all virtual guests associated with an account that has the cPanel web hosting control panel installed. +
              #### [getVirtualGuestsWithMcafee](/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafee) Retrieve all virtual guests associated with an account that have McAfee Secure software components. +
              #### [getVirtualGuestsWithMcafeeAntivirusRedhat](/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafeeAntivirusRedhat) Retrieve all virtual guests associated with an account that have McAfee Secure AntiVirus for Redhat software components. +
              #### [getVirtualGuestsWithMcafeeAntivirusWindows](/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafeeAntivirusWindows) Retrieve all virtual guests associated with an account that has McAfee Secure AntiVirus for Windows software components. +
              #### [getVirtualGuestsWithMcafeeIntrusionDetectionSystem](/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafeeIntrusionDetectionSystem) Retrieve all virtual guests associated with an account that has McAfee Secure Intrusion Detection System software components. +
              #### [getVirtualGuestsWithPlesk](/reference/services/SoftLayer_Account/getVirtualGuestsWithPlesk) Retrieve all virtual guests associated with an account that has the Plesk web hosting control panel installed. +
              #### [getVirtualGuestsWithQuantastor](/reference/services/SoftLayer_Account/getVirtualGuestsWithQuantastor) Retrieve all virtual guests associated with an account that have the QuantaStor storage system installed. +
              #### [getVirtualGuestsWithUrchin](/reference/services/SoftLayer_Account/getVirtualGuestsWithUrchin) Retrieve all virtual guests associated with an account that has the Urchin web traffic analytics package installed. +
              #### [getVirtualPrivateRack](/reference/services/SoftLayer_Account/getVirtualPrivateRack) Retrieve the bandwidth pooling for this account. +
              #### [getVirtualStorageArchiveRepositories](/reference/services/SoftLayer_Account/getVirtualStorageArchiveRepositories) Retrieve an account's associated virtual server archived storage repositories. +
              #### [getVirtualStoragePublicRepositories](/reference/services/SoftLayer_Account/getVirtualStoragePublicRepositories) Retrieve an account's associated virtual server public storage repositories. +
              #### [getVmWareActiveAccountLicenseKeys](/reference/services/SoftLayer_Account/getVmWareActiveAccountLicenseKeys) Get a collection of active VMware software account license keys. +
              #### [getVpcVirtualGuests](/reference/services/SoftLayer_Account/getVpcVirtualGuests) Retrieve an account's associated VPC configured virtual guest objects. +
              #### [getVpnConfigRequiresVPNManageFlag](/reference/services/SoftLayer_Account/getVpnConfigRequiresVPNManageFlag) +
              #### [getWindowsUpdateStatus](/reference/services/SoftLayer_Account/getWindowsUpdateStatus) Retrieve a list of an account's hardware's Windows Update status. +
              #### [hasAttribute](/reference/services/SoftLayer_Account/hasAttribute) Determine if an account has a given attribute. +
              #### [hourlyInstanceLimit](/reference/services/SoftLayer_Account/hourlyInstanceLimit) Retrieve the number of hourly services that an account is allowed to have +
              #### [hourlyServerLimit](/reference/services/SoftLayer_Account/hourlyServerLimit) Retrieve the number of hourly bare metal servers that an account is allowed to have +
              #### [isActiveVmwareCustomer](/reference/services/SoftLayer_Account/isActiveVmwareCustomer) Determines if the account is considered an active VMware customer and as such eligible to order VMware restricted products. This result is cached for up to 60 seconds. +
              #### [isEligibleForLocalCurrencyProgram](/reference/services/SoftLayer_Account/isEligibleForLocalCurrencyProgram) +
              #### [isEligibleToLinkWithPaas](/reference/services/SoftLayer_Account/isEligibleToLinkWithPaas) Returns true if this account is eligible to link with PaaS. False otherwise. +
              #### [linkExternalAccount](/reference/services/SoftLayer_Account/linkExternalAccount) This method will link this SoftLayer account with the provided external account. +
              #### [removeAlternateCreditCard](/reference/services/SoftLayer_Account/removeAlternateCreditCard) +
              #### [requestCreditCardChange](/reference/services/SoftLayer_Account/requestCreditCardChange) Retrieve the record data associated with the submission of a Credit Card Change Request. +
              #### [requestManualPayment](/reference/services/SoftLayer_Account/requestManualPayment) Retrieve the record data associated with the submission of a Manual Payment Request. +
              #### [requestManualPaymentUsingCreditCardOnFile](/reference/services/SoftLayer_Account/requestManualPaymentUsingCreditCardOnFile) Retrieve the record data associated with the submission of a Manual Payment Request which charges the manual payment to a credit card already on file. +
              #### [setAbuseEmails](/reference/services/SoftLayer_Account/setAbuseEmails) Set this account's abuse emails. +
              #### [setManagedPoolQuantity](/reference/services/SoftLayer_Account/setManagedPoolQuantity) Set the number of desired servers in the pool +
              #### [setVlanSpan](/reference/services/SoftLayer_Account/setVlanSpan) Set the flag that enables or disables automatic private network VLAN spanning for a SoftLayer customer account. +
              #### [swapCreditCards](/reference/services/SoftLayer_Account/swapCreditCards) +
              #### [syncCurrentUserPopulationWithPaas](/reference/services/SoftLayer_Account/syncCurrentUserPopulationWithPaas) This method manually starts a synchronize operation for the current IBMid-authenticated user population of a linked account pair. "Manually" means "independent of an account link operation". +
              -
              +
              #### [updateVpnUsersForResource](/reference/services/SoftLayer_Account/updateVpnUsersForResource) [DEPRECATED] Creates or updates a user VPN access privileges for a server on account. + +Deprecated + +
              #### [validate](/reference/services/SoftLayer_Account/validate) Validates SoftLayer account information. Will return an error if any field is not valid. +
              #### [validateManualPaymentAmount](/reference/services/SoftLayer_Account/validateManualPaymentAmount) Ensure the amount requested for a manual payment is valid. +
              diff --git a/content/reference/services/SoftLayer_Account/activatePartner.md b/content/reference/services/SoftLayer_Account/activatePartner.md index 4ff39a4778..efa49f1baa 100644 --- a/content/reference/services/SoftLayer_Account/activatePartner.md +++ b/content/reference/services/SoftLayer_Account/activatePartner.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::activatePartner + This service enables a partner account that has been created but is currently inactive. This restricted service is only available for certain accounts. Please contact support for questions. diff --git a/content/reference/services/SoftLayer_Account/addAchInformation.md b/content/reference/services/SoftLayer_Account/addAchInformation.md index d292d6044c..038e8c0c6a 100644 --- a/content/reference/services/SoftLayer_Account/addAchInformation.md +++ b/content/reference/services/SoftLayer_Account/addAchInformation.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/addReferralPartnerPaymentOption.md b/content/reference/services/SoftLayer_Account/addReferralPartnerPaymentOption.md index 461b31bd9c..988ae7ea74 100644 --- a/content/reference/services/SoftLayer_Account/addReferralPartnerPaymentOption.md +++ b/content/reference/services/SoftLayer_Account/addReferralPartnerPaymentOption.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/areVdrUpdatesBlockedForBilling.md b/content/reference/services/SoftLayer_Account/areVdrUpdatesBlockedForBilling.md index 44dc37a63c..0c8ffe1400 100644 --- a/content/reference/services/SoftLayer_Account/areVdrUpdatesBlockedForBilling.md +++ b/content/reference/services/SoftLayer_Account/areVdrUpdatesBlockedForBilling.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::areVdrUpdatesBlockedForBilling + This method returns true if Bandwidth Pooling updates are blocked so billing can run for this account. diff --git a/content/reference/services/SoftLayer_Account/cancelPayPalTransaction.md b/content/reference/services/SoftLayer_Account/cancelPayPalTransaction.md index e63ad09e5d..c5199843a5 100644 --- a/content/reference/services/SoftLayer_Account/cancelPayPalTransaction.md +++ b/content/reference/services/SoftLayer_Account/cancelPayPalTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::cancelPayPalTransaction + Cancel the PayPal Payment Request process. diff --git a/content/reference/services/SoftLayer_Account/completePayPalTransaction.md b/content/reference/services/SoftLayer_Account/completePayPalTransaction.md index f36720ce2b..796eca3e57 100644 --- a/content/reference/services/SoftLayer_Account/completePayPalTransaction.md +++ b/content/reference/services/SoftLayer_Account/completePayPalTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::completePayPalTransaction + Complete the PayPal Payment Request process and receive confirmation message. diff --git a/content/reference/services/SoftLayer_Account/countHourlyInstances.md b/content/reference/services/SoftLayer_Account/countHourlyInstances.md index 3051dd3c93..c36d403e87 100644 --- a/content/reference/services/SoftLayer_Account/countHourlyInstances.md +++ b/content/reference/services/SoftLayer_Account/countHourlyInstances.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::countHourlyInstances + Retrieve the number of hourly services on an account that are active, plus any pending orders with hourly services attached. diff --git a/content/reference/services/SoftLayer_Account/createUser.md b/content/reference/services/SoftLayer_Account/createUser.md index 455d038404..4b8aa99ce9 100644 --- a/content/reference/services/SoftLayer_Account/createUser.md +++ b/content/reference/services/SoftLayer_Account/createUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::createUser + Create a new user record, optionally skipping the IBMid email ("silently"). diff --git a/content/reference/services/SoftLayer_Account/disableEuSupport.md b/content/reference/services/SoftLayer_Account/disableEuSupport.md index 54afd64391..b878af8e8e 100644 --- a/content/reference/services/SoftLayer_Account/disableEuSupport.md +++ b/content/reference/services/SoftLayer_Account/disableEuSupport.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::disableEuSupport + Turn off the EU Supported account flag. diff --git a/content/reference/services/SoftLayer_Account/disableVpnConfigRequiresVpnManageAttribute.md b/content/reference/services/SoftLayer_Account/disableVpnConfigRequiresVpnManageAttribute.md index 53c97ee8f9..87695e3a1a 100644 --- a/content/reference/services/SoftLayer_Account/disableVpnConfigRequiresVpnManageAttribute.md +++ b/content/reference/services/SoftLayer_Account/disableVpnConfigRequiresVpnManageAttribute.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::disableVpnConfigRequiresVpnManageAttribute + Disable the VPN Config Requires VPN Manage attribute, creating it if necessary. diff --git a/content/reference/services/SoftLayer_Account/editAccount.md b/content/reference/services/SoftLayer_Account/editAccount.md index 110e7b6a61..ba5f9d5b75 100644 --- a/content/reference/services/SoftLayer_Account/editAccount.md +++ b/content/reference/services/SoftLayer_Account/editAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::editAccount + Edit an account's information. diff --git a/content/reference/services/SoftLayer_Account/enableEuSupport.md b/content/reference/services/SoftLayer_Account/enableEuSupport.md index 2a1760569b..f0c6846712 100644 --- a/content/reference/services/SoftLayer_Account/enableEuSupport.md +++ b/content/reference/services/SoftLayer_Account/enableEuSupport.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::enableEuSupport + Turn on the EU Supported account flag. diff --git a/content/reference/services/SoftLayer_Account/enableVpnConfigRequiresVpnManageAttribute.md b/content/reference/services/SoftLayer_Account/enableVpnConfigRequiresVpnManageAttribute.md index e9f8436b04..849bd9345b 100644 --- a/content/reference/services/SoftLayer_Account/enableVpnConfigRequiresVpnManageAttribute.md +++ b/content/reference/services/SoftLayer_Account/enableVpnConfigRequiresVpnManageAttribute.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::enableVpnConfigRequiresVpnManageAttribute + Enable the VPN Config Requires VPN Manage attribute, creating it if necessary. diff --git a/content/reference/services/SoftLayer_Account/getAbuseEmail.md b/content/reference/services/SoftLayer_Account/getAbuseEmail.md index 6a765dd3a0..019ec4e3fc 100644 --- a/content/reference/services/SoftLayer_Account/getAbuseEmail.md +++ b/content/reference/services/SoftLayer_Account/getAbuseEmail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAbuseEmail + Retrieve an email address that is responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to this address. diff --git a/content/reference/services/SoftLayer_Account/getAbuseEmails.md b/content/reference/services/SoftLayer_Account/getAbuseEmails.md index bdc5fe437b..8c36263bf5 100644 --- a/content/reference/services/SoftLayer_Account/getAbuseEmails.md +++ b/content/reference/services/SoftLayer_Account/getAbuseEmails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAbuseEmails + Retrieve email addresses that are responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to these addresses. diff --git a/content/reference/services/SoftLayer_Account/getAccountBackupHistory.md b/content/reference/services/SoftLayer_Account/getAccountBackupHistory.md index d508047a11..3e5e5ef407 100644 --- a/content/reference/services/SoftLayer_Account/getAccountBackupHistory.md +++ b/content/reference/services/SoftLayer_Account/getAccountBackupHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAccountBackupHistory + This method provides a history of account backups. diff --git a/content/reference/services/SoftLayer_Account/getAccountContacts.md b/content/reference/services/SoftLayer_Account/getAccountContacts.md index 3a944c2561..a413002a6d 100644 --- a/content/reference/services/SoftLayer_Account/getAccountContacts.md +++ b/content/reference/services/SoftLayer_Account/getAccountContacts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAccountContacts + Retrieve the account contacts on an account. diff --git a/content/reference/services/SoftLayer_Account/getAccountLicenses.md b/content/reference/services/SoftLayer_Account/getAccountLicenses.md index e61979cd94..81fefc800d 100644 --- a/content/reference/services/SoftLayer_Account/getAccountLicenses.md +++ b/content/reference/services/SoftLayer_Account/getAccountLicenses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAccountLicenses + Retrieve the account software licenses owned by an account diff --git a/content/reference/services/SoftLayer_Account/getAccountLinks.md b/content/reference/services/SoftLayer_Account/getAccountLinks.md index 115d7b9c79..516a82173a 100644 --- a/content/reference/services/SoftLayer_Account/getAccountLinks.md +++ b/content/reference/services/SoftLayer_Account/getAccountLinks.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getAccountStatus.md b/content/reference/services/SoftLayer_Account/getAccountStatus.md index 82b844bda5..e89d1e243f 100644 --- a/content/reference/services/SoftLayer_Account/getAccountStatus.md +++ b/content/reference/services/SoftLayer_Account/getAccountStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAccountStatus + Retrieve an account's status presented in a more detailed data type. diff --git a/content/reference/services/SoftLayer_Account/getAccountTraitValue.md b/content/reference/services/SoftLayer_Account/getAccountTraitValue.md index 3bc9b2edd3..1b89335459 100644 --- a/content/reference/services/SoftLayer_Account/getAccountTraitValue.md +++ b/content/reference/services/SoftLayer_Account/getAccountTraitValue.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAccountTraitValue + Get the specific trait by its key diff --git a/content/reference/services/SoftLayer_Account/getActiveAccountDiscountBillingItem.md b/content/reference/services/SoftLayer_Account/getActiveAccountDiscountBillingItem.md index 19b4aeddf2..ebf814d038 100644 --- a/content/reference/services/SoftLayer_Account/getActiveAccountDiscountBillingItem.md +++ b/content/reference/services/SoftLayer_Account/getActiveAccountDiscountBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getActiveAccountDiscountBillingItem + Retrieve the billing item associated with an account's monthly discount. diff --git a/content/reference/services/SoftLayer_Account/getActiveAccountLicenses.md b/content/reference/services/SoftLayer_Account/getActiveAccountLicenses.md index 047e02631c..31116fa4e5 100644 --- a/content/reference/services/SoftLayer_Account/getActiveAccountLicenses.md +++ b/content/reference/services/SoftLayer_Account/getActiveAccountLicenses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getActiveAccountLicenses + Retrieve the active account software licenses owned by an account diff --git a/content/reference/services/SoftLayer_Account/getActiveAddresses.md b/content/reference/services/SoftLayer_Account/getActiveAddresses.md index 2b0fb0462b..4d28cdf11b 100644 --- a/content/reference/services/SoftLayer_Account/getActiveAddresses.md +++ b/content/reference/services/SoftLayer_Account/getActiveAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getActiveAddresses + Retrieve the active address(es) that belong to an account. diff --git a/content/reference/services/SoftLayer_Account/getActiveAgreements.md b/content/reference/services/SoftLayer_Account/getActiveAgreements.md index 9fc3f7c25c..2d74f47f79 100644 --- a/content/reference/services/SoftLayer_Account/getActiveAgreements.md +++ b/content/reference/services/SoftLayer_Account/getActiveAgreements.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getActiveAgreements + Retrieve all active agreements for an account diff --git a/content/reference/services/SoftLayer_Account/getActiveBillingAgreements.md b/content/reference/services/SoftLayer_Account/getActiveBillingAgreements.md index b8c8188d02..4089b8123a 100644 --- a/content/reference/services/SoftLayer_Account/getActiveBillingAgreements.md +++ b/content/reference/services/SoftLayer_Account/getActiveBillingAgreements.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getActiveBillingAgreements + Retrieve all billing agreements for an account diff --git a/content/reference/services/SoftLayer_Account/getActiveCatalystEnrollment.md b/content/reference/services/SoftLayer_Account/getActiveCatalystEnrollment.md index 35c93a26aa..0496aca56a 100644 --- a/content/reference/services/SoftLayer_Account/getActiveCatalystEnrollment.md +++ b/content/reference/services/SoftLayer_Account/getActiveCatalystEnrollment.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getActiveColocationContainers.md b/content/reference/services/SoftLayer_Account/getActiveColocationContainers.md index ced0b23caa..5a386fe5e8 100644 --- a/content/reference/services/SoftLayer_Account/getActiveColocationContainers.md +++ b/content/reference/services/SoftLayer_Account/getActiveColocationContainers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getActiveColocationContainers + Retrieve the account's active top level colocation containers. diff --git a/content/reference/services/SoftLayer_Account/getActiveFlexibleCreditEnrollment.md b/content/reference/services/SoftLayer_Account/getActiveFlexibleCreditEnrollment.md index cec7901e64..a6da7b386a 100644 --- a/content/reference/services/SoftLayer_Account/getActiveFlexibleCreditEnrollment.md +++ b/content/reference/services/SoftLayer_Account/getActiveFlexibleCreditEnrollment.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getActiveFlexibleCreditEnrollment + Retrieve [Deprecated] Please use SoftLayer_Account::activeFlexibleCreditEnrollments. diff --git a/content/reference/services/SoftLayer_Account/getActiveFlexibleCreditEnrollments.md b/content/reference/services/SoftLayer_Account/getActiveFlexibleCreditEnrollments.md index 2252c7a711..ce8f847e35 100644 --- a/content/reference/services/SoftLayer_Account/getActiveFlexibleCreditEnrollments.md +++ b/content/reference/services/SoftLayer_Account/getActiveFlexibleCreditEnrollments.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getActiveNotificationSubscribers.md b/content/reference/services/SoftLayer_Account/getActiveNotificationSubscribers.md index e7053f3a51..0d30ce4777 100644 --- a/content/reference/services/SoftLayer_Account/getActiveNotificationSubscribers.md +++ b/content/reference/services/SoftLayer_Account/getActiveNotificationSubscribers.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getActiveOutletPackages.md b/content/reference/services/SoftLayer_Account/getActiveOutletPackages.md index 16ccb26dbe..d3e2e086e7 100644 --- a/content/reference/services/SoftLayer_Account/getActiveOutletPackages.md +++ b/content/reference/services/SoftLayer_Account/getActiveOutletPackages.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getActiveOutletPackages +
              Deprecated
              + DEPRECATED. This method will return nothing. diff --git a/content/reference/services/SoftLayer_Account/getActivePackages.md b/content/reference/services/SoftLayer_Account/getActivePackages.md index 6120357c5e..7a905c69f1 100644 --- a/content/reference/services/SoftLayer_Account/getActivePackages.md +++ b/content/reference/services/SoftLayer_Account/getActivePackages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getActivePackages + Retrieve the active [SoftLayer_Product_Package]({{}}) objects from which you can order a server, service or software. diff --git a/content/reference/services/SoftLayer_Account/getActivePackagesByAttribute.md b/content/reference/services/SoftLayer_Account/getActivePackagesByAttribute.md index eb39f7e1c9..74ddc97b25 100644 --- a/content/reference/services/SoftLayer_Account/getActivePackagesByAttribute.md +++ b/content/reference/services/SoftLayer_Account/getActivePackagesByAttribute.md @@ -15,6 +15,8 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getActivePackagesByAttribute +
              Deprecated
              + [DEPRECATED] Retrieve the active [SoftLayer_Product_Package]({{}}) objects from which you can order a server, service or software filtered by an attribute type ([SoftLayer_Product_Package_Attribute_Type]({{}})) on the package. diff --git a/content/reference/services/SoftLayer_Account/getActivePrivateHostedCloudPackages.md b/content/reference/services/SoftLayer_Account/getActivePrivateHostedCloudPackages.md index 658b9aeee4..c9bb85e0bc 100644 --- a/content/reference/services/SoftLayer_Account/getActivePrivateHostedCloudPackages.md +++ b/content/reference/services/SoftLayer_Account/getActivePrivateHostedCloudPackages.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getActivePrivateHostedCloudPackages +
              Deprecated
              + diff --git a/content/reference/services/SoftLayer_Account/getActiveQuotes.md b/content/reference/services/SoftLayer_Account/getActiveQuotes.md index 387843837e..e80270274c 100644 --- a/content/reference/services/SoftLayer_Account/getActiveQuotes.md +++ b/content/reference/services/SoftLayer_Account/getActiveQuotes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getActiveQuotes + Retrieve an account's non-expired quotes. diff --git a/content/reference/services/SoftLayer_Account/getActiveReservedCapacityAgreements.md b/content/reference/services/SoftLayer_Account/getActiveReservedCapacityAgreements.md index e63b1343fe..edb20df91e 100644 --- a/content/reference/services/SoftLayer_Account/getActiveReservedCapacityAgreements.md +++ b/content/reference/services/SoftLayer_Account/getActiveReservedCapacityAgreements.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getActiveReservedCapacityAgreements + Retrieve active reserved capacity agreements for an account diff --git a/content/reference/services/SoftLayer_Account/getActiveVirtualLicenses.md b/content/reference/services/SoftLayer_Account/getActiveVirtualLicenses.md index af59c5e094..ae43554a4a 100644 --- a/content/reference/services/SoftLayer_Account/getActiveVirtualLicenses.md +++ b/content/reference/services/SoftLayer_Account/getActiveVirtualLicenses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getActiveVirtualLicenses + Retrieve the virtual software licenses controlled by an account diff --git a/content/reference/services/SoftLayer_Account/getAdcLoadBalancers.md b/content/reference/services/SoftLayer_Account/getAdcLoadBalancers.md index f9bc25b38d..35ec68f36e 100644 --- a/content/reference/services/SoftLayer_Account/getAdcLoadBalancers.md +++ b/content/reference/services/SoftLayer_Account/getAdcLoadBalancers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAdcLoadBalancers + Retrieve an account's associated load balancers. diff --git a/content/reference/services/SoftLayer_Account/getAddresses.md b/content/reference/services/SoftLayer_Account/getAddresses.md index 41ec849de3..a7cdb68d76 100644 --- a/content/reference/services/SoftLayer_Account/getAddresses.md +++ b/content/reference/services/SoftLayer_Account/getAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAddresses + Retrieve all the address(es) that belong to an account. diff --git a/content/reference/services/SoftLayer_Account/getAffiliateId.md b/content/reference/services/SoftLayer_Account/getAffiliateId.md index 9aafc091e7..5c83f5b5db 100644 --- a/content/reference/services/SoftLayer_Account/getAffiliateId.md +++ b/content/reference/services/SoftLayer_Account/getAffiliateId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAffiliateId + Retrieve an affiliate identifier associated with the customer account. diff --git a/content/reference/services/SoftLayer_Account/getAggregatedUptimeGraph.md b/content/reference/services/SoftLayer_Account/getAggregatedUptimeGraph.md index 2e7e15dfcd..70531b4049 100644 --- a/content/reference/services/SoftLayer_Account/getAggregatedUptimeGraph.md +++ b/content/reference/services/SoftLayer_Account/getAggregatedUptimeGraph.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAggregatedUptimeGraph + Returns URL uptime data for your account diff --git a/content/reference/services/SoftLayer_Account/getAllBillingItems.md b/content/reference/services/SoftLayer_Account/getAllBillingItems.md index 702c521ee2..83b4998ea7 100644 --- a/content/reference/services/SoftLayer_Account/getAllBillingItems.md +++ b/content/reference/services/SoftLayer_Account/getAllBillingItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAllBillingItems + Retrieve the billing items that will be on an account's next invoice. diff --git a/content/reference/services/SoftLayer_Account/getAllCommissionBillingItems.md b/content/reference/services/SoftLayer_Account/getAllCommissionBillingItems.md index 4c29998422..ba520951ff 100644 --- a/content/reference/services/SoftLayer_Account/getAllCommissionBillingItems.md +++ b/content/reference/services/SoftLayer_Account/getAllCommissionBillingItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAllCommissionBillingItems + Retrieve the billing items that will be on an account's next invoice. diff --git a/content/reference/services/SoftLayer_Account/getAllRecurringTopLevelBillingItems.md b/content/reference/services/SoftLayer_Account/getAllRecurringTopLevelBillingItems.md index 3e9a92112e..f6ad1aebd0 100644 --- a/content/reference/services/SoftLayer_Account/getAllRecurringTopLevelBillingItems.md +++ b/content/reference/services/SoftLayer_Account/getAllRecurringTopLevelBillingItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAllRecurringTopLevelBillingItems + Retrieve the billing items that will be on an account's next invoice. diff --git a/content/reference/services/SoftLayer_Account/getAllRecurringTopLevelBillingItemsUnfiltered.md b/content/reference/services/SoftLayer_Account/getAllRecurringTopLevelBillingItemsUnfiltered.md index 78766afbaf..a72efa1794 100644 --- a/content/reference/services/SoftLayer_Account/getAllRecurringTopLevelBillingItemsUnfiltered.md +++ b/content/reference/services/SoftLayer_Account/getAllRecurringTopLevelBillingItemsUnfiltered.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAllRecurringTopLevelBillingItemsUnfiltered + Retrieve the billing items that will be on an account's next invoice. Does not consider associated items. diff --git a/content/reference/services/SoftLayer_Account/getAllSubnetBillingItems.md b/content/reference/services/SoftLayer_Account/getAllSubnetBillingItems.md index 221662c4b0..235256beb4 100644 --- a/content/reference/services/SoftLayer_Account/getAllSubnetBillingItems.md +++ b/content/reference/services/SoftLayer_Account/getAllSubnetBillingItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAllSubnetBillingItems + Retrieve the billing items that will be on an account's next invoice. diff --git a/content/reference/services/SoftLayer_Account/getAllTopLevelBillingItems.md b/content/reference/services/SoftLayer_Account/getAllTopLevelBillingItems.md index 0fea11cc77..fcb37e8108 100644 --- a/content/reference/services/SoftLayer_Account/getAllTopLevelBillingItems.md +++ b/content/reference/services/SoftLayer_Account/getAllTopLevelBillingItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAllTopLevelBillingItems + Retrieve all billing items of an account. diff --git a/content/reference/services/SoftLayer_Account/getAllTopLevelBillingItemsUnfiltered.md b/content/reference/services/SoftLayer_Account/getAllTopLevelBillingItemsUnfiltered.md index 82b1146df5..4d6185bdf0 100644 --- a/content/reference/services/SoftLayer_Account/getAllTopLevelBillingItemsUnfiltered.md +++ b/content/reference/services/SoftLayer_Account/getAllTopLevelBillingItemsUnfiltered.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAllTopLevelBillingItemsUnfiltered + Retrieve the billing items that will be on an account's next invoice. Does not consider associated items. diff --git a/content/reference/services/SoftLayer_Account/getAllowIbmIdSilentMigrationFlag.md b/content/reference/services/SoftLayer_Account/getAllowIbmIdSilentMigrationFlag.md index 4af30ea97d..78c5bcf7bf 100644 --- a/content/reference/services/SoftLayer_Account/getAllowIbmIdSilentMigrationFlag.md +++ b/content/reference/services/SoftLayer_Account/getAllowIbmIdSilentMigrationFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAllowIbmIdSilentMigrationFlag + Retrieve indicates whether this account is allowed to silently migrate to use IBMid Authentication. diff --git a/content/reference/services/SoftLayer_Account/getAllowsBluemixAccountLinkingFlag.md b/content/reference/services/SoftLayer_Account/getAllowsBluemixAccountLinkingFlag.md index ca4125866e..f02acd3bbd 100644 --- a/content/reference/services/SoftLayer_Account/getAllowsBluemixAccountLinkingFlag.md +++ b/content/reference/services/SoftLayer_Account/getAllowsBluemixAccountLinkingFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAllowsBluemixAccountLinkingFlag + Retrieve flag indicating if this account can be linked with Bluemix. diff --git a/content/reference/services/SoftLayer_Account/getAlternateCreditCardData.md b/content/reference/services/SoftLayer_Account/getAlternateCreditCardData.md index eb26a461d9..70342e21ba 100644 --- a/content/reference/services/SoftLayer_Account/getAlternateCreditCardData.md +++ b/content/reference/services/SoftLayer_Account/getAlternateCreditCardData.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getApplicationDeliveryControllers.md b/content/reference/services/SoftLayer_Account/getApplicationDeliveryControllers.md index 1031634242..6e4f2447a9 100644 --- a/content/reference/services/SoftLayer_Account/getApplicationDeliveryControllers.md +++ b/content/reference/services/SoftLayer_Account/getApplicationDeliveryControllers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getApplicationDeliveryControllers + Retrieve an account's associated application delivery controller records. diff --git a/content/reference/services/SoftLayer_Account/getAttributeByType.md b/content/reference/services/SoftLayer_Account/getAttributeByType.md index 6f7ddaaf19..70288e372c 100644 --- a/content/reference/services/SoftLayer_Account/getAttributeByType.md +++ b/content/reference/services/SoftLayer_Account/getAttributeByType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAttributeByType + Retrieve an account attribute by type key name. diff --git a/content/reference/services/SoftLayer_Account/getAttributes.md b/content/reference/services/SoftLayer_Account/getAttributes.md index c5fd9ac8a1..1b91a1b225 100644 --- a/content/reference/services/SoftLayer_Account/getAttributes.md +++ b/content/reference/services/SoftLayer_Account/getAttributes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAttributes + Retrieve the account attribute values for a SoftLayer customer account. diff --git a/content/reference/services/SoftLayer_Account/getAuxiliaryNotifications.md b/content/reference/services/SoftLayer_Account/getAuxiliaryNotifications.md index fec59d8529..b24fcc254e 100644 --- a/content/reference/services/SoftLayer_Account/getAuxiliaryNotifications.md +++ b/content/reference/services/SoftLayer_Account/getAuxiliaryNotifications.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getAvailablePublicNetworkVlans.md b/content/reference/services/SoftLayer_Account/getAvailablePublicNetworkVlans.md index 7a367e04a1..30e9ec8708 100644 --- a/content/reference/services/SoftLayer_Account/getAvailablePublicNetworkVlans.md +++ b/content/reference/services/SoftLayer_Account/getAvailablePublicNetworkVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAvailablePublicNetworkVlans + Retrieve the public network VLANs assigned to an account. diff --git a/content/reference/services/SoftLayer_Account/getAverageArchiveUsageMetricDataByDate.md b/content/reference/services/SoftLayer_Account/getAverageArchiveUsageMetricDataByDate.md index c35a32b98c..9bcc6e1603 100644 --- a/content/reference/services/SoftLayer_Account/getAverageArchiveUsageMetricDataByDate.md +++ b/content/reference/services/SoftLayer_Account/getAverageArchiveUsageMetricDataByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAverageArchiveUsageMetricDataByDate + Returns the average disk usage for all archive repositories for the timeframe based on the parameters provided. diff --git a/content/reference/services/SoftLayer_Account/getAveragePublicUsageMetricDataByDate.md b/content/reference/services/SoftLayer_Account/getAveragePublicUsageMetricDataByDate.md index ec0194579d..9f2017d0b8 100644 --- a/content/reference/services/SoftLayer_Account/getAveragePublicUsageMetricDataByDate.md +++ b/content/reference/services/SoftLayer_Account/getAveragePublicUsageMetricDataByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getAveragePublicUsageMetricDataByDate + Returns the average disk usage for all public repositories for the timeframe based on the parameters provided. diff --git a/content/reference/services/SoftLayer_Account/getBalance.md b/content/reference/services/SoftLayer_Account/getBalance.md index 26c25aa918..69d0bdc101 100644 --- a/content/reference/services/SoftLayer_Account/getBalance.md +++ b/content/reference/services/SoftLayer_Account/getBalance.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getBalance + Retrieve the account balance of a SoftLayer customer account. An account's balance is the amount of money owed to SoftLayer by the account holder, returned as a floating point number with two decimal places, measured in US Dollars ($USD). A negative account balance means the account holder has overpaid and is owed money by SoftLayer. diff --git a/content/reference/services/SoftLayer_Account/getBandwidthAllotments.md b/content/reference/services/SoftLayer_Account/getBandwidthAllotments.md index 4b5ee2db78..10ff59982f 100644 --- a/content/reference/services/SoftLayer_Account/getBandwidthAllotments.md +++ b/content/reference/services/SoftLayer_Account/getBandwidthAllotments.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getBandwidthAllotments + Retrieve the bandwidth allotments for an account. diff --git a/content/reference/services/SoftLayer_Account/getBandwidthAllotmentsOverAllocation.md b/content/reference/services/SoftLayer_Account/getBandwidthAllotmentsOverAllocation.md index 0c174172be..a3202e8f28 100644 --- a/content/reference/services/SoftLayer_Account/getBandwidthAllotmentsOverAllocation.md +++ b/content/reference/services/SoftLayer_Account/getBandwidthAllotmentsOverAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getBandwidthAllotmentsOverAllocation + Retrieve the bandwidth allotments for an account currently over allocation. diff --git a/content/reference/services/SoftLayer_Account/getBandwidthAllotmentsProjectedOverAllocation.md b/content/reference/services/SoftLayer_Account/getBandwidthAllotmentsProjectedOverAllocation.md index b6c02dc75c..f1fd2baae5 100644 --- a/content/reference/services/SoftLayer_Account/getBandwidthAllotmentsProjectedOverAllocation.md +++ b/content/reference/services/SoftLayer_Account/getBandwidthAllotmentsProjectedOverAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getBandwidthAllotmentsProjectedOverAllocation + Retrieve the bandwidth allotments for an account projected to go over allocation. diff --git a/content/reference/services/SoftLayer_Account/getBandwidthList.md b/content/reference/services/SoftLayer_Account/getBandwidthList.md index f63821cdb1..dbc0246fcb 100644 --- a/content/reference/services/SoftLayer_Account/getBandwidthList.md +++ b/content/reference/services/SoftLayer_Account/getBandwidthList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getBareMetalInstances.md b/content/reference/services/SoftLayer_Account/getBareMetalInstances.md index 9c15e05f64..97035f7781 100644 --- a/content/reference/services/SoftLayer_Account/getBareMetalInstances.md +++ b/content/reference/services/SoftLayer_Account/getBareMetalInstances.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getBareMetalInstances + Retrieve an account's associated bare metal server objects. diff --git a/content/reference/services/SoftLayer_Account/getBillingAgreements.md b/content/reference/services/SoftLayer_Account/getBillingAgreements.md index 2abc047c3b..88445d4f5d 100644 --- a/content/reference/services/SoftLayer_Account/getBillingAgreements.md +++ b/content/reference/services/SoftLayer_Account/getBillingAgreements.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getBillingAgreements + Retrieve all billing agreements for an account diff --git a/content/reference/services/SoftLayer_Account/getBillingInfo.md b/content/reference/services/SoftLayer_Account/getBillingInfo.md index 81e24bbe25..8905b49ce6 100644 --- a/content/reference/services/SoftLayer_Account/getBillingInfo.md +++ b/content/reference/services/SoftLayer_Account/getBillingInfo.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getBillingInfo + Retrieve an account's billing information. diff --git a/content/reference/services/SoftLayer_Account/getBlockDeviceTemplateGroups.md b/content/reference/services/SoftLayer_Account/getBlockDeviceTemplateGroups.md index 49e2c83276..41d7e95661 100644 --- a/content/reference/services/SoftLayer_Account/getBlockDeviceTemplateGroups.md +++ b/content/reference/services/SoftLayer_Account/getBlockDeviceTemplateGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getBlockDeviceTemplateGroups + Retrieve private template group objects (parent and children) and the shared template group objects (parent only) for an account. diff --git a/content/reference/services/SoftLayer_Account/getBluemixAccountLink.md b/content/reference/services/SoftLayer_Account/getBluemixAccountLink.md index 127c02f42c..84d509cbf2 100644 --- a/content/reference/services/SoftLayer_Account/getBluemixAccountLink.md +++ b/content/reference/services/SoftLayer_Account/getBluemixAccountLink.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getBluemixAccountLink + Retrieve the Bluemix account link associated with this SoftLayer account, if one exists. diff --git a/content/reference/services/SoftLayer_Account/getBluemixLinkedFlag.md b/content/reference/services/SoftLayer_Account/getBluemixLinkedFlag.md index 768453bfa3..160a29cd87 100644 --- a/content/reference/services/SoftLayer_Account/getBluemixLinkedFlag.md +++ b/content/reference/services/SoftLayer_Account/getBluemixLinkedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getBluemixLinkedFlag + Retrieve returns true if this account is linked to IBM Bluemix, false if not. diff --git a/content/reference/services/SoftLayer_Account/getBrand.md b/content/reference/services/SoftLayer_Account/getBrand.md index e33013acba..865acb9ee2 100644 --- a/content/reference/services/SoftLayer_Account/getBrand.md +++ b/content/reference/services/SoftLayer_Account/getBrand.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getBrandAccountFlag.md b/content/reference/services/SoftLayer_Account/getBrandAccountFlag.md index 018bce4ee1..974acc3db9 100644 --- a/content/reference/services/SoftLayer_Account/getBrandAccountFlag.md +++ b/content/reference/services/SoftLayer_Account/getBrandAccountFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getBrandKeyName.md b/content/reference/services/SoftLayer_Account/getBrandKeyName.md index e773f100e3..5fd17d6e89 100644 --- a/content/reference/services/SoftLayer_Account/getBrandKeyName.md +++ b/content/reference/services/SoftLayer_Account/getBrandKeyName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getBrandKeyName + Retrieve the brand keyName. diff --git a/content/reference/services/SoftLayer_Account/getBusinessPartner.md b/content/reference/services/SoftLayer_Account/getBusinessPartner.md index 558a9851cb..2cd7c4330e 100644 --- a/content/reference/services/SoftLayer_Account/getBusinessPartner.md +++ b/content/reference/services/SoftLayer_Account/getBusinessPartner.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getBusinessPartner + Retrieve the Business Partner details for the account. Country Enterprise Code, Channel, Segment, Reseller Level. diff --git a/content/reference/services/SoftLayer_Account/getCanOrderAdditionalVlansFlag.md b/content/reference/services/SoftLayer_Account/getCanOrderAdditionalVlansFlag.md index f37cc448b4..803a5333f0 100644 --- a/content/reference/services/SoftLayer_Account/getCanOrderAdditionalVlansFlag.md +++ b/content/reference/services/SoftLayer_Account/getCanOrderAdditionalVlansFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getCanOrderAdditionalVlansFlag + Retrieve [DEPRECATED] All accounts may order VLANs. diff --git a/content/reference/services/SoftLayer_Account/getCarts.md b/content/reference/services/SoftLayer_Account/getCarts.md index f68b530310..04d5d7acf2 100644 --- a/content/reference/services/SoftLayer_Account/getCarts.md +++ b/content/reference/services/SoftLayer_Account/getCarts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getCarts + Retrieve an account's active carts. diff --git a/content/reference/services/SoftLayer_Account/getCatalystEnrollments.md b/content/reference/services/SoftLayer_Account/getCatalystEnrollments.md index fd7e5af57c..ca84512ebc 100644 --- a/content/reference/services/SoftLayer_Account/getCatalystEnrollments.md +++ b/content/reference/services/SoftLayer_Account/getCatalystEnrollments.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getClosedTickets.md b/content/reference/services/SoftLayer_Account/getClosedTickets.md index 3949473a4b..d585d480ad 100644 --- a/content/reference/services/SoftLayer_Account/getClosedTickets.md +++ b/content/reference/services/SoftLayer_Account/getClosedTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getClosedTickets + Retrieve all closed tickets associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getCurrentBackupStatisticsGraph.md b/content/reference/services/SoftLayer_Account/getCurrentBackupStatisticsGraph.md index a097dfbc96..4df5005e32 100644 --- a/content/reference/services/SoftLayer_Account/getCurrentBackupStatisticsGraph.md +++ b/content/reference/services/SoftLayer_Account/getCurrentBackupStatisticsGraph.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getCurrentBackupStatisticsGraph +
              Deprecated
              + This method retrieves a pie chart for today's backup statistics. diff --git a/content/reference/services/SoftLayer_Account/getCurrentTicketStatisticsGraph.md b/content/reference/services/SoftLayer_Account/getCurrentTicketStatisticsGraph.md index 343cd92297..f2967eb340 100644 --- a/content/reference/services/SoftLayer_Account/getCurrentTicketStatisticsGraph.md +++ b/content/reference/services/SoftLayer_Account/getCurrentTicketStatisticsGraph.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getCurrentTicketStatisticsGraph +
              Deprecated
              + (Deprecated) diff --git a/content/reference/services/SoftLayer_Account/getCurrentUser.md b/content/reference/services/SoftLayer_Account/getCurrentUser.md index 58991c40d7..f1cd1aacbc 100644 --- a/content/reference/services/SoftLayer_Account/getCurrentUser.md +++ b/content/reference/services/SoftLayer_Account/getCurrentUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getCurrentUser + Retrieve the current API user's record. diff --git a/content/reference/services/SoftLayer_Account/getDatacentersWithSubnetAllocations.md b/content/reference/services/SoftLayer_Account/getDatacentersWithSubnetAllocations.md index 7d5e55824f..f89c450aef 100644 --- a/content/reference/services/SoftLayer_Account/getDatacentersWithSubnetAllocations.md +++ b/content/reference/services/SoftLayer_Account/getDatacentersWithSubnetAllocations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getDatacentersWithSubnetAllocations + Retrieve datacenters which contain subnets that the account has access to route. diff --git a/content/reference/services/SoftLayer_Account/getDedicatedHosts.md b/content/reference/services/SoftLayer_Account/getDedicatedHosts.md index de0657e3aa..a76a259a0d 100644 --- a/content/reference/services/SoftLayer_Account/getDedicatedHosts.md +++ b/content/reference/services/SoftLayer_Account/getDedicatedHosts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getDedicatedHosts + Retrieve an account's associated virtual dedicated host objects. diff --git a/content/reference/services/SoftLayer_Account/getDedicatedHostsForImageTemplate.md b/content/reference/services/SoftLayer_Account/getDedicatedHostsForImageTemplate.md index 8cd8c579d6..ab37b23393 100644 --- a/content/reference/services/SoftLayer_Account/getDedicatedHostsForImageTemplate.md +++ b/content/reference/services/SoftLayer_Account/getDedicatedHostsForImageTemplate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getDedicatedHostsForImageTemplate + Get a collection of dedicated hosts that are valid for a given image template. diff --git a/content/reference/services/SoftLayer_Account/getDisablePaymentProcessingFlag.md b/content/reference/services/SoftLayer_Account/getDisablePaymentProcessingFlag.md index 5b6a2f3d4c..2fc26a737e 100644 --- a/content/reference/services/SoftLayer_Account/getDisablePaymentProcessingFlag.md +++ b/content/reference/services/SoftLayer_Account/getDisablePaymentProcessingFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getDisablePaymentProcessingFlag + Retrieve a flag indicating whether payments are processed for this account. diff --git a/content/reference/services/SoftLayer_Account/getDiskUsageMetricDataByDate.md b/content/reference/services/SoftLayer_Account/getDiskUsageMetricDataByDate.md index 1e2fd8c144..ea77dcc746 100644 --- a/content/reference/services/SoftLayer_Account/getDiskUsageMetricDataByDate.md +++ b/content/reference/services/SoftLayer_Account/getDiskUsageMetricDataByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getDiskUsageMetricDataByDate + Retrieve the metric data for disk space usage for a storage repository from the Metric Tracking Object System and the Legacy Data Warehouse. diff --git a/content/reference/services/SoftLayer_Account/getDiskUsageMetricDataFromLegacyByDate.md b/content/reference/services/SoftLayer_Account/getDiskUsageMetricDataFromLegacyByDate.md index f3a8e49e60..dcb4653f47 100644 --- a/content/reference/services/SoftLayer_Account/getDiskUsageMetricDataFromLegacyByDate.md +++ b/content/reference/services/SoftLayer_Account/getDiskUsageMetricDataFromLegacyByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getDiskUsageMetricDataFromLegacyByDate + Retrieve the metric data for disk space usage for a storage repository from the Legacy Data Warehouse. diff --git a/content/reference/services/SoftLayer_Account/getDiskUsageMetricDataFromMetricTrackingObjectSystemByDate.md b/content/reference/services/SoftLayer_Account/getDiskUsageMetricDataFromMetricTrackingObjectSystemByDate.md index 3c948ef1d2..1a73475595 100644 --- a/content/reference/services/SoftLayer_Account/getDiskUsageMetricDataFromMetricTrackingObjectSystemByDate.md +++ b/content/reference/services/SoftLayer_Account/getDiskUsageMetricDataFromMetricTrackingObjectSystemByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getDiskUsageMetricDataFromMetricTrackingObjectSystemByDate + Retrieve the metric data for disk space usage for a storage repository from the Metric Tracking Object System. diff --git a/content/reference/services/SoftLayer_Account/getDiskUsageMetricImageByDate.md b/content/reference/services/SoftLayer_Account/getDiskUsageMetricImageByDate.md index 0045e18e40..0acdfad080 100644 --- a/content/reference/services/SoftLayer_Account/getDiskUsageMetricImageByDate.md +++ b/content/reference/services/SoftLayer_Account/getDiskUsageMetricImageByDate.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getDiskUsageMetricImageByDate +
              Deprecated
              + Retrieve an image of the disk usage data on a [SoftLayer_Virtual_Guest]({{}}) image for the time range you provide. diff --git a/content/reference/services/SoftLayer_Account/getDisplaySupportRepresentativeAssignments.md b/content/reference/services/SoftLayer_Account/getDisplaySupportRepresentativeAssignments.md index cb11212281..ef859fe905 100644 --- a/content/reference/services/SoftLayer_Account/getDisplaySupportRepresentativeAssignments.md +++ b/content/reference/services/SoftLayer_Account/getDisplaySupportRepresentativeAssignments.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getDisplaySupportRepresentativeAssignments + Retrieve the SoftLayer employees that an account is assigned to. diff --git a/content/reference/services/SoftLayer_Account/getDomainRegistrations.md b/content/reference/services/SoftLayer_Account/getDomainRegistrations.md index 98c25af8e7..8a0a5b588c 100644 --- a/content/reference/services/SoftLayer_Account/getDomainRegistrations.md +++ b/content/reference/services/SoftLayer_Account/getDomainRegistrations.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getDomains.md b/content/reference/services/SoftLayer_Account/getDomains.md index b309040913..c438d13b05 100644 --- a/content/reference/services/SoftLayer_Account/getDomains.md +++ b/content/reference/services/SoftLayer_Account/getDomains.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getDomains + Retrieve the DNS domains associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getDomainsWithoutSecondaryDnsRecords.md b/content/reference/services/SoftLayer_Account/getDomainsWithoutSecondaryDnsRecords.md index 7e7041ec3d..ec9418a666 100644 --- a/content/reference/services/SoftLayer_Account/getDomainsWithoutSecondaryDnsRecords.md +++ b/content/reference/services/SoftLayer_Account/getDomainsWithoutSecondaryDnsRecords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getDomainsWithoutSecondaryDnsRecords + Retrieve the DNS domains associated with an account that were not created as a result of a secondary DNS zone transfer. diff --git a/content/reference/services/SoftLayer_Account/getEuSupportedFlag.md b/content/reference/services/SoftLayer_Account/getEuSupportedFlag.md index 09298683b7..004b75bece 100644 --- a/content/reference/services/SoftLayer_Account/getEuSupportedFlag.md +++ b/content/reference/services/SoftLayer_Account/getEuSupportedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getEuSupportedFlag + Retrieve boolean flag dictating whether or not this account has the EU Supported flag. This flag indicates that this account uses IBM Cloud services to process EU citizen's personal data. diff --git a/content/reference/services/SoftLayer_Account/getEvaultCapacityGB.md b/content/reference/services/SoftLayer_Account/getEvaultCapacityGB.md index d282187974..6b0b1dd44b 100644 --- a/content/reference/services/SoftLayer_Account/getEvaultCapacityGB.md +++ b/content/reference/services/SoftLayer_Account/getEvaultCapacityGB.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getEvaultCapacityGB + Retrieve the total capacity of Legacy EVault Volumes on an account, in GB. diff --git a/content/reference/services/SoftLayer_Account/getEvaultMasterUsers.md b/content/reference/services/SoftLayer_Account/getEvaultMasterUsers.md index 17f235c358..3b9bb9774b 100644 --- a/content/reference/services/SoftLayer_Account/getEvaultMasterUsers.md +++ b/content/reference/services/SoftLayer_Account/getEvaultMasterUsers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getEvaultMasterUsers + Retrieve an account's master EVault user. This is only used when an account has EVault service. diff --git a/content/reference/services/SoftLayer_Account/getEvaultNetworkStorage.md b/content/reference/services/SoftLayer_Account/getEvaultNetworkStorage.md index bf668e2861..c8ab357b96 100644 --- a/content/reference/services/SoftLayer_Account/getEvaultNetworkStorage.md +++ b/content/reference/services/SoftLayer_Account/getEvaultNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getEvaultNetworkStorage + Retrieve an account's associated EVault storage volumes. diff --git a/content/reference/services/SoftLayer_Account/getExecutiveSummaryPdf.md b/content/reference/services/SoftLayer_Account/getExecutiveSummaryPdf.md index ce67f8d028..51c5dc31fd 100644 --- a/content/reference/services/SoftLayer_Account/getExecutiveSummaryPdf.md +++ b/content/reference/services/SoftLayer_Account/getExecutiveSummaryPdf.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getExecutiveSummaryPdf + This method provides an executive summary PDF for managed hosting services. diff --git a/content/reference/services/SoftLayer_Account/getExpiredSecurityCertificates.md b/content/reference/services/SoftLayer_Account/getExpiredSecurityCertificates.md index 5b10aeb0bb..07a48743a5 100644 --- a/content/reference/services/SoftLayer_Account/getExpiredSecurityCertificates.md +++ b/content/reference/services/SoftLayer_Account/getExpiredSecurityCertificates.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getExpiredSecurityCertificates + Retrieve stored security certificates that are expired (ie. SSL) diff --git a/content/reference/services/SoftLayer_Account/getFacilityLogs.md b/content/reference/services/SoftLayer_Account/getFacilityLogs.md index 7b3b135ac5..5bc51aeaee 100644 --- a/content/reference/services/SoftLayer_Account/getFacilityLogs.md +++ b/content/reference/services/SoftLayer_Account/getFacilityLogs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getFacilityLogs + Retrieve logs of who entered a colocation area which is assigned to this account, or when a user under this account enters a datacenter. diff --git a/content/reference/services/SoftLayer_Account/getFileBlockBetaAccessFlag.md b/content/reference/services/SoftLayer_Account/getFileBlockBetaAccessFlag.md index 5919fe8b87..e6c54c3ef3 100644 --- a/content/reference/services/SoftLayer_Account/getFileBlockBetaAccessFlag.md +++ b/content/reference/services/SoftLayer_Account/getFileBlockBetaAccessFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getFlexibleCreditEnrollments.md b/content/reference/services/SoftLayer_Account/getFlexibleCreditEnrollments.md index 42133c98cb..5cc26d9aa4 100644 --- a/content/reference/services/SoftLayer_Account/getFlexibleCreditEnrollments.md +++ b/content/reference/services/SoftLayer_Account/getFlexibleCreditEnrollments.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getFlexibleCreditEnrollments + Retrieve all of the account's current and former Flexible Credit enrollments. diff --git a/content/reference/services/SoftLayer_Account/getFlexibleCreditProgramInfo.md b/content/reference/services/SoftLayer_Account/getFlexibleCreditProgramInfo.md index a3383ff975..8c4ab96402 100644 --- a/content/reference/services/SoftLayer_Account/getFlexibleCreditProgramInfo.md +++ b/content/reference/services/SoftLayer_Account/getFlexibleCreditProgramInfo.md @@ -15,6 +15,8 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getFlexibleCreditProgramInfo +
              Deprecated
              + [DEPRECATED] Please use SoftLayer_Account::getFlexibleCreditProgramsInfo. This is no longer an accurate representation of discounts. diff --git a/content/reference/services/SoftLayer_Account/getFlexibleCreditProgramsInfo.md b/content/reference/services/SoftLayer_Account/getFlexibleCreditProgramsInfo.md index fc72e5271d..6f9a296e9b 100644 --- a/content/reference/services/SoftLayer_Account/getFlexibleCreditProgramsInfo.md +++ b/content/reference/services/SoftLayer_Account/getFlexibleCreditProgramsInfo.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getFlexibleCreditProgramsInfo + This method retrieves information on all of your Flexible Credit Program enrollments for your account. diff --git a/content/reference/services/SoftLayer_Account/getForcePaasAccountLinkDate.md b/content/reference/services/SoftLayer_Account/getForcePaasAccountLinkDate.md index c65c65ce02..c8268a6827 100644 --- a/content/reference/services/SoftLayer_Account/getForcePaasAccountLinkDate.md +++ b/content/reference/services/SoftLayer_Account/getForcePaasAccountLinkDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getForcePaasAccountLinkDate + Retrieve timestamp representing the point in time when an account is required to link with PaaS. diff --git a/content/reference/services/SoftLayer_Account/getGlobalIpRecords.md b/content/reference/services/SoftLayer_Account/getGlobalIpRecords.md index 92f857845e..5446b69593 100644 --- a/content/reference/services/SoftLayer_Account/getGlobalIpRecords.md +++ b/content/reference/services/SoftLayer_Account/getGlobalIpRecords.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getGlobalIpv4Records.md b/content/reference/services/SoftLayer_Account/getGlobalIpv4Records.md index 2d1ffa43ef..865f0b212b 100644 --- a/content/reference/services/SoftLayer_Account/getGlobalIpv4Records.md +++ b/content/reference/services/SoftLayer_Account/getGlobalIpv4Records.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getGlobalIpv6Records.md b/content/reference/services/SoftLayer_Account/getGlobalIpv6Records.md index 86be515ee6..79d7f9f681 100644 --- a/content/reference/services/SoftLayer_Account/getGlobalIpv6Records.md +++ b/content/reference/services/SoftLayer_Account/getGlobalIpv6Records.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getGlobalLoadBalancerAccounts.md b/content/reference/services/SoftLayer_Account/getGlobalLoadBalancerAccounts.md index 300cb0020c..e8b79fb094 100644 --- a/content/reference/services/SoftLayer_Account/getGlobalLoadBalancerAccounts.md +++ b/content/reference/services/SoftLayer_Account/getGlobalLoadBalancerAccounts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getGlobalLoadBalancerAccounts + Retrieve [Deprecated] The global load balancer accounts for a softlayer customer account. diff --git a/content/reference/services/SoftLayer_Account/getHardware.md b/content/reference/services/SoftLayer_Account/getHardware.md index 5ff5ae7dfa..77f0e5f5b8 100644 --- a/content/reference/services/SoftLayer_Account/getHardware.md +++ b/content/reference/services/SoftLayer_Account/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHardware + Retrieve an account's associated hardware objects. diff --git a/content/reference/services/SoftLayer_Account/getHardwareOverBandwidthAllocation.md b/content/reference/services/SoftLayer_Account/getHardwareOverBandwidthAllocation.md index 77c1de8c1b..d0f3de6173 100644 --- a/content/reference/services/SoftLayer_Account/getHardwareOverBandwidthAllocation.md +++ b/content/reference/services/SoftLayer_Account/getHardwareOverBandwidthAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHardwareOverBandwidthAllocation + Retrieve an account's associated hardware objects currently over bandwidth allocation. diff --git a/content/reference/services/SoftLayer_Account/getHardwarePools.md b/content/reference/services/SoftLayer_Account/getHardwarePools.md index 3ce49eacd0..09136df9c6 100644 --- a/content/reference/services/SoftLayer_Account/getHardwarePools.md +++ b/content/reference/services/SoftLayer_Account/getHardwarePools.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHardwarePools + Get a collection of managed hardware pools. diff --git a/content/reference/services/SoftLayer_Account/getHardwareProjectedOverBandwidthAllocation.md b/content/reference/services/SoftLayer_Account/getHardwareProjectedOverBandwidthAllocation.md index 906074a59b..4cc17c73cb 100644 --- a/content/reference/services/SoftLayer_Account/getHardwareProjectedOverBandwidthAllocation.md +++ b/content/reference/services/SoftLayer_Account/getHardwareProjectedOverBandwidthAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHardwareProjectedOverBandwidthAllocation + Retrieve an account's associated hardware objects projected to go over bandwidth allocation. diff --git a/content/reference/services/SoftLayer_Account/getHardwareWithCpanel.md b/content/reference/services/SoftLayer_Account/getHardwareWithCpanel.md index 97e1031500..2ab3c96c30 100644 --- a/content/reference/services/SoftLayer_Account/getHardwareWithCpanel.md +++ b/content/reference/services/SoftLayer_Account/getHardwareWithCpanel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHardwareWithCpanel + Retrieve all hardware associated with an account that has the cPanel web hosting control panel installed. diff --git a/content/reference/services/SoftLayer_Account/getHardwareWithHelm.md b/content/reference/services/SoftLayer_Account/getHardwareWithHelm.md index 34b8122165..cb56932637 100644 --- a/content/reference/services/SoftLayer_Account/getHardwareWithHelm.md +++ b/content/reference/services/SoftLayer_Account/getHardwareWithHelm.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHardwareWithHelm + Retrieve all hardware associated with an account that has the Helm web hosting control panel installed. diff --git a/content/reference/services/SoftLayer_Account/getHardwareWithMcafee.md b/content/reference/services/SoftLayer_Account/getHardwareWithMcafee.md index 99a67c82d8..5590e0a349 100644 --- a/content/reference/services/SoftLayer_Account/getHardwareWithMcafee.md +++ b/content/reference/services/SoftLayer_Account/getHardwareWithMcafee.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHardwareWithMcafee + Retrieve all hardware associated with an account that has McAfee Secure software components. diff --git a/content/reference/services/SoftLayer_Account/getHardwareWithMcafeeAntivirusRedhat.md b/content/reference/services/SoftLayer_Account/getHardwareWithMcafeeAntivirusRedhat.md index cc3bdb28d7..036241bb16 100644 --- a/content/reference/services/SoftLayer_Account/getHardwareWithMcafeeAntivirusRedhat.md +++ b/content/reference/services/SoftLayer_Account/getHardwareWithMcafeeAntivirusRedhat.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHardwareWithMcafeeAntivirusRedhat + Retrieve all hardware associated with an account that has McAfee Secure AntiVirus for Redhat software components. diff --git a/content/reference/services/SoftLayer_Account/getHardwareWithMcafeeAntivirusWindows.md b/content/reference/services/SoftLayer_Account/getHardwareWithMcafeeAntivirusWindows.md index 9d856fecd6..405bd835de 100644 --- a/content/reference/services/SoftLayer_Account/getHardwareWithMcafeeAntivirusWindows.md +++ b/content/reference/services/SoftLayer_Account/getHardwareWithMcafeeAntivirusWindows.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHardwareWithMcafeeAntivirusWindows + Retrieve all hardware associated with an account that has McAfee Secure AntiVirus for Windows software components. diff --git a/content/reference/services/SoftLayer_Account/getHardwareWithMcafeeIntrusionDetectionSystem.md b/content/reference/services/SoftLayer_Account/getHardwareWithMcafeeIntrusionDetectionSystem.md index 9b016c25dc..33588c211d 100644 --- a/content/reference/services/SoftLayer_Account/getHardwareWithMcafeeIntrusionDetectionSystem.md +++ b/content/reference/services/SoftLayer_Account/getHardwareWithMcafeeIntrusionDetectionSystem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHardwareWithMcafeeIntrusionDetectionSystem + Retrieve all hardware associated with an account that has McAfee Secure Intrusion Detection System software components. diff --git a/content/reference/services/SoftLayer_Account/getHardwareWithPlesk.md b/content/reference/services/SoftLayer_Account/getHardwareWithPlesk.md index 61aee25e66..7fd8765e4e 100644 --- a/content/reference/services/SoftLayer_Account/getHardwareWithPlesk.md +++ b/content/reference/services/SoftLayer_Account/getHardwareWithPlesk.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHardwareWithPlesk + Retrieve all hardware associated with an account that has the Plesk web hosting control panel installed. diff --git a/content/reference/services/SoftLayer_Account/getHardwareWithQuantastor.md b/content/reference/services/SoftLayer_Account/getHardwareWithQuantastor.md index 0739136d1c..4437677f6b 100644 --- a/content/reference/services/SoftLayer_Account/getHardwareWithQuantastor.md +++ b/content/reference/services/SoftLayer_Account/getHardwareWithQuantastor.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHardwareWithQuantastor + Retrieve all hardware associated with an account that has the QuantaStor storage system installed. diff --git a/content/reference/services/SoftLayer_Account/getHardwareWithUrchin.md b/content/reference/services/SoftLayer_Account/getHardwareWithUrchin.md index c57433d22d..b3aff686d8 100644 --- a/content/reference/services/SoftLayer_Account/getHardwareWithUrchin.md +++ b/content/reference/services/SoftLayer_Account/getHardwareWithUrchin.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHardwareWithUrchin + Retrieve all hardware associated with an account that has the Urchin web traffic analytics package installed. diff --git a/content/reference/services/SoftLayer_Account/getHardwareWithWindows.md b/content/reference/services/SoftLayer_Account/getHardwareWithWindows.md index a599f5608f..d097d44164 100644 --- a/content/reference/services/SoftLayer_Account/getHardwareWithWindows.md +++ b/content/reference/services/SoftLayer_Account/getHardwareWithWindows.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHardwareWithWindows + Retrieve all hardware associated with an account that is running a version of the Microsoft Windows operating system. diff --git a/content/reference/services/SoftLayer_Account/getHasEvaultBareMetalRestorePluginFlag.md b/content/reference/services/SoftLayer_Account/getHasEvaultBareMetalRestorePluginFlag.md index 3442c2be68..e065853018 100644 --- a/content/reference/services/SoftLayer_Account/getHasEvaultBareMetalRestorePluginFlag.md +++ b/content/reference/services/SoftLayer_Account/getHasEvaultBareMetalRestorePluginFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHasEvaultBareMetalRestorePluginFlag + Retrieve return 1 if one of the account's hardware has the EVault Bare Metal Server Restore Plugin otherwise 0. diff --git a/content/reference/services/SoftLayer_Account/getHasIderaBareMetalRestorePluginFlag.md b/content/reference/services/SoftLayer_Account/getHasIderaBareMetalRestorePluginFlag.md index d3aa912889..b042da99e2 100644 --- a/content/reference/services/SoftLayer_Account/getHasIderaBareMetalRestorePluginFlag.md +++ b/content/reference/services/SoftLayer_Account/getHasIderaBareMetalRestorePluginFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHasIderaBareMetalRestorePluginFlag + Retrieve return 1 if one of the account's hardware has an installation of Idera Server Backup otherwise 0. diff --git a/content/reference/services/SoftLayer_Account/getHasPendingOrder.md b/content/reference/services/SoftLayer_Account/getHasPendingOrder.md index db1c72050c..15a02aa9b3 100644 --- a/content/reference/services/SoftLayer_Account/getHasPendingOrder.md +++ b/content/reference/services/SoftLayer_Account/getHasPendingOrder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHasPendingOrder + Retrieve the number of orders in a PENDING status for a SoftLayer customer account. diff --git a/content/reference/services/SoftLayer_Account/getHasR1softBareMetalRestorePluginFlag.md b/content/reference/services/SoftLayer_Account/getHasR1softBareMetalRestorePluginFlag.md index fa67554f10..d8d2bd9146 100644 --- a/content/reference/services/SoftLayer_Account/getHasR1softBareMetalRestorePluginFlag.md +++ b/content/reference/services/SoftLayer_Account/getHasR1softBareMetalRestorePluginFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHasR1softBareMetalRestorePluginFlag + Retrieve return 1 if one of the account's hardware has an installation of R1Soft CDP otherwise 0. diff --git a/content/reference/services/SoftLayer_Account/getHistoricalBackupGraph.md b/content/reference/services/SoftLayer_Account/getHistoricalBackupGraph.md index e6eb721cb7..4dfc6655a1 100644 --- a/content/reference/services/SoftLayer_Account/getHistoricalBackupGraph.md +++ b/content/reference/services/SoftLayer_Account/getHistoricalBackupGraph.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getHistoricalBandwidthGraph.md b/content/reference/services/SoftLayer_Account/getHistoricalBandwidthGraph.md index cb8d243c55..8f1bba6123 100644 --- a/content/reference/services/SoftLayer_Account/getHistoricalBandwidthGraph.md +++ b/content/reference/services/SoftLayer_Account/getHistoricalBandwidthGraph.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHistoricalBandwidthGraph +
              Deprecated
              + [DEPRECATED] This method returns a line graph of bandwidth statistics. diff --git a/content/reference/services/SoftLayer_Account/getHistoricalTicketGraph.md b/content/reference/services/SoftLayer_Account/getHistoricalTicketGraph.md index 5e3efebf7c..976c728f9b 100644 --- a/content/reference/services/SoftLayer_Account/getHistoricalTicketGraph.md +++ b/content/reference/services/SoftLayer_Account/getHistoricalTicketGraph.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHistoricalTicketGraph + This method returns a pie chart of ticket statistics for the given dates. diff --git a/content/reference/services/SoftLayer_Account/getHistoricalUptimeGraph.md b/content/reference/services/SoftLayer_Account/getHistoricalUptimeGraph.md index d1e8a47b70..c82a68e00c 100644 --- a/content/reference/services/SoftLayer_Account/getHistoricalUptimeGraph.md +++ b/content/reference/services/SoftLayer_Account/getHistoricalUptimeGraph.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHistoricalUptimeGraph + This method returns a SoftLayer_Container_Account_Graph_Outputs object for the specified date range. diff --git a/content/reference/services/SoftLayer_Account/getHourlyBareMetalInstances.md b/content/reference/services/SoftLayer_Account/getHourlyBareMetalInstances.md index 5ad32a1451..1fa1d6f5a3 100644 --- a/content/reference/services/SoftLayer_Account/getHourlyBareMetalInstances.md +++ b/content/reference/services/SoftLayer_Account/getHourlyBareMetalInstances.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHourlyBareMetalInstances + Retrieve an account's associated hourly bare metal server objects. diff --git a/content/reference/services/SoftLayer_Account/getHourlyServiceBillingItems.md b/content/reference/services/SoftLayer_Account/getHourlyServiceBillingItems.md index baa866abfd..5b89a13400 100644 --- a/content/reference/services/SoftLayer_Account/getHourlyServiceBillingItems.md +++ b/content/reference/services/SoftLayer_Account/getHourlyServiceBillingItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHourlyServiceBillingItems + Retrieve hourly service billing items that will be on an account's next invoice. diff --git a/content/reference/services/SoftLayer_Account/getHourlyVirtualGuests.md b/content/reference/services/SoftLayer_Account/getHourlyVirtualGuests.md index a56192272f..aea4d170da 100644 --- a/content/reference/services/SoftLayer_Account/getHourlyVirtualGuests.md +++ b/content/reference/services/SoftLayer_Account/getHourlyVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHourlyVirtualGuests + Retrieve an account's associated hourly virtual guest objects. diff --git a/content/reference/services/SoftLayer_Account/getHubNetworkStorage.md b/content/reference/services/SoftLayer_Account/getHubNetworkStorage.md index 289b5c6458..5e3632220d 100644 --- a/content/reference/services/SoftLayer_Account/getHubNetworkStorage.md +++ b/content/reference/services/SoftLayer_Account/getHubNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getHubNetworkStorage + Retrieve an account's associated Virtual Storage volumes. diff --git a/content/reference/services/SoftLayer_Account/getIbmCustomerNumber.md b/content/reference/services/SoftLayer_Account/getIbmCustomerNumber.md index e2266c7b88..8715119998 100644 --- a/content/reference/services/SoftLayer_Account/getIbmCustomerNumber.md +++ b/content/reference/services/SoftLayer_Account/getIbmCustomerNumber.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getIbmCustomerNumber + Retrieve unique identifier for a customer used throughout IBM. diff --git a/content/reference/services/SoftLayer_Account/getIbmIdAuthenticationRequiredFlag.md b/content/reference/services/SoftLayer_Account/getIbmIdAuthenticationRequiredFlag.md index 19618a0ebe..e1fe1da842 100644 --- a/content/reference/services/SoftLayer_Account/getIbmIdAuthenticationRequiredFlag.md +++ b/content/reference/services/SoftLayer_Account/getIbmIdAuthenticationRequiredFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getIbmIdAuthenticationRequiredFlag + Retrieve indicates whether this account requires IBMid authentication. diff --git a/content/reference/services/SoftLayer_Account/getIbmIdMigrationExpirationTimestamp.md b/content/reference/services/SoftLayer_Account/getIbmIdMigrationExpirationTimestamp.md index 99bfd355ac..bd49fceb54 100644 --- a/content/reference/services/SoftLayer_Account/getIbmIdMigrationExpirationTimestamp.md +++ b/content/reference/services/SoftLayer_Account/getIbmIdMigrationExpirationTimestamp.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getIbmIdMigrationExpirationTimestamp + Retrieve this key is deprecated and should not be used. diff --git a/content/reference/services/SoftLayer_Account/getInProgressExternalAccountSetup.md b/content/reference/services/SoftLayer_Account/getInProgressExternalAccountSetup.md index 08c33f2a50..e585b1718e 100644 --- a/content/reference/services/SoftLayer_Account/getInProgressExternalAccountSetup.md +++ b/content/reference/services/SoftLayer_Account/getInProgressExternalAccountSetup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getInProgressExternalAccountSetup + Retrieve an in progress request to switch billing systems. diff --git a/content/reference/services/SoftLayer_Account/getInternalNotes.md b/content/reference/services/SoftLayer_Account/getInternalNotes.md index 7353f86ac5..740e1eda74 100644 --- a/content/reference/services/SoftLayer_Account/getInternalNotes.md +++ b/content/reference/services/SoftLayer_Account/getInternalNotes.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getInvoices.md b/content/reference/services/SoftLayer_Account/getInvoices.md index 998f7b690a..0cd025106e 100644 --- a/content/reference/services/SoftLayer_Account/getInvoices.md +++ b/content/reference/services/SoftLayer_Account/getInvoices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getInvoices + Retrieve an account's associated billing invoices. diff --git a/content/reference/services/SoftLayer_Account/getIpAddresses.md b/content/reference/services/SoftLayer_Account/getIpAddresses.md index ae93447349..1976e875e5 100644 --- a/content/reference/services/SoftLayer_Account/getIpAddresses.md +++ b/content/reference/services/SoftLayer_Account/getIpAddresses.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getIscsiIsolationDisabled.md b/content/reference/services/SoftLayer_Account/getIscsiIsolationDisabled.md index 756e313028..97d2547030 100644 --- a/content/reference/services/SoftLayer_Account/getIscsiIsolationDisabled.md +++ b/content/reference/services/SoftLayer_Account/getIscsiIsolationDisabled.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getIscsiNetworkStorage.md b/content/reference/services/SoftLayer_Account/getIscsiNetworkStorage.md index e2325e29f0..634bb5f21b 100644 --- a/content/reference/services/SoftLayer_Account/getIscsiNetworkStorage.md +++ b/content/reference/services/SoftLayer_Account/getIscsiNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getIscsiNetworkStorage + Retrieve an account's associated iSCSI storage volumes. diff --git a/content/reference/services/SoftLayer_Account/getLargestAllowedSubnetCidr.md b/content/reference/services/SoftLayer_Account/getLargestAllowedSubnetCidr.md index 9375104e23..bf31f419bd 100644 --- a/content/reference/services/SoftLayer_Account/getLargestAllowedSubnetCidr.md +++ b/content/reference/services/SoftLayer_Account/getLargestAllowedSubnetCidr.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getLargestAllowedSubnetCidr + Computes the number of available public secondary IP addresses, augmented by the provided number of hosts, before overflow of the allowed host to IP address ratio occurs. The result is aligned to the nearest subnet size that could be accommodated in full. 0 is returned if an overflow is detected. diff --git a/content/reference/services/SoftLayer_Account/getLastCanceledBillingItem.md b/content/reference/services/SoftLayer_Account/getLastCanceledBillingItem.md index 9d55faa3b3..0db0a8b62e 100644 --- a/content/reference/services/SoftLayer_Account/getLastCanceledBillingItem.md +++ b/content/reference/services/SoftLayer_Account/getLastCanceledBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getLastCanceledBillingItem + Retrieve the most recently canceled billing item. diff --git a/content/reference/services/SoftLayer_Account/getLastCancelledServerBillingItem.md b/content/reference/services/SoftLayer_Account/getLastCancelledServerBillingItem.md index 737cc2be76..2ea50dcabc 100644 --- a/content/reference/services/SoftLayer_Account/getLastCancelledServerBillingItem.md +++ b/content/reference/services/SoftLayer_Account/getLastCancelledServerBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getLastCancelledServerBillingItem + Retrieve the most recent cancelled server billing item. diff --git a/content/reference/services/SoftLayer_Account/getLastFiveClosedAbuseTickets.md b/content/reference/services/SoftLayer_Account/getLastFiveClosedAbuseTickets.md index 570bc4f623..b2dd5daa37 100644 --- a/content/reference/services/SoftLayer_Account/getLastFiveClosedAbuseTickets.md +++ b/content/reference/services/SoftLayer_Account/getLastFiveClosedAbuseTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getLastFiveClosedAbuseTickets + Retrieve the five most recently closed abuse tickets associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getLastFiveClosedAccountingTickets.md b/content/reference/services/SoftLayer_Account/getLastFiveClosedAccountingTickets.md index 740c5e3fde..fbf5468c0b 100644 --- a/content/reference/services/SoftLayer_Account/getLastFiveClosedAccountingTickets.md +++ b/content/reference/services/SoftLayer_Account/getLastFiveClosedAccountingTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getLastFiveClosedAccountingTickets + Retrieve the five most recently closed accounting tickets associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getLastFiveClosedOtherTickets.md b/content/reference/services/SoftLayer_Account/getLastFiveClosedOtherTickets.md index 8387348180..f97aaced2d 100644 --- a/content/reference/services/SoftLayer_Account/getLastFiveClosedOtherTickets.md +++ b/content/reference/services/SoftLayer_Account/getLastFiveClosedOtherTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getLastFiveClosedOtherTickets + Retrieve the five most recently closed tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getLastFiveClosedSalesTickets.md b/content/reference/services/SoftLayer_Account/getLastFiveClosedSalesTickets.md index e303589083..501d26a194 100644 --- a/content/reference/services/SoftLayer_Account/getLastFiveClosedSalesTickets.md +++ b/content/reference/services/SoftLayer_Account/getLastFiveClosedSalesTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getLastFiveClosedSalesTickets + Retrieve the five most recently closed sales tickets associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getLastFiveClosedSupportTickets.md b/content/reference/services/SoftLayer_Account/getLastFiveClosedSupportTickets.md index 9ff1386f72..862d82e498 100644 --- a/content/reference/services/SoftLayer_Account/getLastFiveClosedSupportTickets.md +++ b/content/reference/services/SoftLayer_Account/getLastFiveClosedSupportTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getLastFiveClosedSupportTickets + Retrieve the five most recently closed support tickets associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getLastFiveClosedTickets.md b/content/reference/services/SoftLayer_Account/getLastFiveClosedTickets.md index 9a438754d4..629d6a34dd 100644 --- a/content/reference/services/SoftLayer_Account/getLastFiveClosedTickets.md +++ b/content/reference/services/SoftLayer_Account/getLastFiveClosedTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getLastFiveClosedTickets + Retrieve the five most recently closed tickets associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getLatestBillDate.md b/content/reference/services/SoftLayer_Account/getLatestBillDate.md index 9e09156033..99667f2aaf 100644 --- a/content/reference/services/SoftLayer_Account/getLatestBillDate.md +++ b/content/reference/services/SoftLayer_Account/getLatestBillDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getLatestBillDate + Retrieve an account's most recent billing date. diff --git a/content/reference/services/SoftLayer_Account/getLatestRecurringInvoice.md b/content/reference/services/SoftLayer_Account/getLatestRecurringInvoice.md index b495fd14c7..e7e6ad59bc 100644 --- a/content/reference/services/SoftLayer_Account/getLatestRecurringInvoice.md +++ b/content/reference/services/SoftLayer_Account/getLatestRecurringInvoice.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getLatestRecurringInvoice + Retrieve an account's latest recurring invoice. diff --git a/content/reference/services/SoftLayer_Account/getLatestRecurringPendingInvoice.md b/content/reference/services/SoftLayer_Account/getLatestRecurringPendingInvoice.md index e5575f17b8..682aab06d8 100644 --- a/content/reference/services/SoftLayer_Account/getLatestRecurringPendingInvoice.md +++ b/content/reference/services/SoftLayer_Account/getLatestRecurringPendingInvoice.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getLatestRecurringPendingInvoice + Retrieve an account's latest recurring pending invoice. diff --git a/content/reference/services/SoftLayer_Account/getLegacyBandwidthAllotments.md b/content/reference/services/SoftLayer_Account/getLegacyBandwidthAllotments.md index b21228dc91..31276d5312 100644 --- a/content/reference/services/SoftLayer_Account/getLegacyBandwidthAllotments.md +++ b/content/reference/services/SoftLayer_Account/getLegacyBandwidthAllotments.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getLegacyBandwidthAllotments + Retrieve the legacy bandwidth allotments for an account. diff --git a/content/reference/services/SoftLayer_Account/getLegacyIscsiCapacityGB.md b/content/reference/services/SoftLayer_Account/getLegacyIscsiCapacityGB.md index 19e78a0ad8..62f13475de 100644 --- a/content/reference/services/SoftLayer_Account/getLegacyIscsiCapacityGB.md +++ b/content/reference/services/SoftLayer_Account/getLegacyIscsiCapacityGB.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getLegacyIscsiCapacityGB + Retrieve the total capacity of Legacy iSCSI Volumes on an account, in GB. diff --git a/content/reference/services/SoftLayer_Account/getLoadBalancers.md b/content/reference/services/SoftLayer_Account/getLoadBalancers.md index 38879894af..dfdc7e12d1 100644 --- a/content/reference/services/SoftLayer_Account/getLoadBalancers.md +++ b/content/reference/services/SoftLayer_Account/getLoadBalancers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getLoadBalancers + Retrieve an account's associated load balancers. diff --git a/content/reference/services/SoftLayer_Account/getLockboxCapacityGB.md b/content/reference/services/SoftLayer_Account/getLockboxCapacityGB.md index c07bc5b65e..fea7267e01 100644 --- a/content/reference/services/SoftLayer_Account/getLockboxCapacityGB.md +++ b/content/reference/services/SoftLayer_Account/getLockboxCapacityGB.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getLockboxCapacityGB + Retrieve the total capacity of Legacy lockbox Volumes on an account, in GB. diff --git a/content/reference/services/SoftLayer_Account/getLockboxNetworkStorage.md b/content/reference/services/SoftLayer_Account/getLockboxNetworkStorage.md index 9090a6ca32..6fa184448b 100644 --- a/content/reference/services/SoftLayer_Account/getLockboxNetworkStorage.md +++ b/content/reference/services/SoftLayer_Account/getLockboxNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getLockboxNetworkStorage + Retrieve an account's associated Lockbox storage volumes. diff --git a/content/reference/services/SoftLayer_Account/getManualPaymentsUnderReview.md b/content/reference/services/SoftLayer_Account/getManualPaymentsUnderReview.md index 7514853f9e..30f190b858 100644 --- a/content/reference/services/SoftLayer_Account/getManualPaymentsUnderReview.md +++ b/content/reference/services/SoftLayer_Account/getManualPaymentsUnderReview.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getMasterUser.md b/content/reference/services/SoftLayer_Account/getMasterUser.md index 84ddaeb8af..45689c8486 100644 --- a/content/reference/services/SoftLayer_Account/getMasterUser.md +++ b/content/reference/services/SoftLayer_Account/getMasterUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getMasterUser + Retrieve an account's master user. diff --git a/content/reference/services/SoftLayer_Account/getMediaDataTransferRequests.md b/content/reference/services/SoftLayer_Account/getMediaDataTransferRequests.md index aa8881d7d1..12b7554c66 100644 --- a/content/reference/services/SoftLayer_Account/getMediaDataTransferRequests.md +++ b/content/reference/services/SoftLayer_Account/getMediaDataTransferRequests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getMediaDataTransferRequests + Retrieve an account's media transfer service requests. diff --git a/content/reference/services/SoftLayer_Account/getMigratedToIbmCloudPortalFlag.md b/content/reference/services/SoftLayer_Account/getMigratedToIbmCloudPortalFlag.md index 90fef15863..9cf464aaa8 100644 --- a/content/reference/services/SoftLayer_Account/getMigratedToIbmCloudPortalFlag.md +++ b/content/reference/services/SoftLayer_Account/getMigratedToIbmCloudPortalFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getMigratedToIbmCloudPortalFlag + Retrieve flag indicating whether this account is restricted to the IBM Cloud portal. diff --git a/content/reference/services/SoftLayer_Account/getMonthlyBareMetalInstances.md b/content/reference/services/SoftLayer_Account/getMonthlyBareMetalInstances.md index 19540455b6..270ae000ef 100644 --- a/content/reference/services/SoftLayer_Account/getMonthlyBareMetalInstances.md +++ b/content/reference/services/SoftLayer_Account/getMonthlyBareMetalInstances.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getMonthlyBareMetalInstances + Retrieve an account's associated monthly bare metal server objects. diff --git a/content/reference/services/SoftLayer_Account/getMonthlyVirtualGuests.md b/content/reference/services/SoftLayer_Account/getMonthlyVirtualGuests.md index 14a3703219..cc9eb2a8ce 100644 --- a/content/reference/services/SoftLayer_Account/getMonthlyVirtualGuests.md +++ b/content/reference/services/SoftLayer_Account/getMonthlyVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getMonthlyVirtualGuests + Retrieve an account's associated monthly virtual guest objects. diff --git a/content/reference/services/SoftLayer_Account/getNasNetworkStorage.md b/content/reference/services/SoftLayer_Account/getNasNetworkStorage.md index 88c87922df..6f1e5359c2 100644 --- a/content/reference/services/SoftLayer_Account/getNasNetworkStorage.md +++ b/content/reference/services/SoftLayer_Account/getNasNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNasNetworkStorage + Retrieve an account's associated NAS storage volumes. diff --git a/content/reference/services/SoftLayer_Account/getNetAppActiveAccountLicenseKeys.md b/content/reference/services/SoftLayer_Account/getNetAppActiveAccountLicenseKeys.md index 00ef649821..38c65d3a43 100644 --- a/content/reference/services/SoftLayer_Account/getNetAppActiveAccountLicenseKeys.md +++ b/content/reference/services/SoftLayer_Account/getNetAppActiveAccountLicenseKeys.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNetAppActiveAccountLicenseKeys + Get a collection of active NetApp software account license keys. diff --git a/content/reference/services/SoftLayer_Account/getNetworkCreationFlag.md b/content/reference/services/SoftLayer_Account/getNetworkCreationFlag.md index c834fbdaef..d620a3f03e 100644 --- a/content/reference/services/SoftLayer_Account/getNetworkCreationFlag.md +++ b/content/reference/services/SoftLayer_Account/getNetworkCreationFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNetworkCreationFlag + Retrieve [Deprecated] Whether or not this account can define their own networks. diff --git a/content/reference/services/SoftLayer_Account/getNetworkGateways.md b/content/reference/services/SoftLayer_Account/getNetworkGateways.md index 494a03dd4b..3a2c8950c3 100644 --- a/content/reference/services/SoftLayer_Account/getNetworkGateways.md +++ b/content/reference/services/SoftLayer_Account/getNetworkGateways.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNetworkGateways + Retrieve all network gateway devices on this account. diff --git a/content/reference/services/SoftLayer_Account/getNetworkHardware.md b/content/reference/services/SoftLayer_Account/getNetworkHardware.md index b23c2fe5cb..b0d8a39c0a 100644 --- a/content/reference/services/SoftLayer_Account/getNetworkHardware.md +++ b/content/reference/services/SoftLayer_Account/getNetworkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNetworkHardware + Retrieve an account's associated network hardware. diff --git a/content/reference/services/SoftLayer_Account/getNetworkMessageDeliveryAccounts.md b/content/reference/services/SoftLayer_Account/getNetworkMessageDeliveryAccounts.md index 6916792978..690772ac1f 100644 --- a/content/reference/services/SoftLayer_Account/getNetworkMessageDeliveryAccounts.md +++ b/content/reference/services/SoftLayer_Account/getNetworkMessageDeliveryAccounts.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getNetworkMonitorDownHardware.md b/content/reference/services/SoftLayer_Account/getNetworkMonitorDownHardware.md index 82182c7385..7c14fc7209 100644 --- a/content/reference/services/SoftLayer_Account/getNetworkMonitorDownHardware.md +++ b/content/reference/services/SoftLayer_Account/getNetworkMonitorDownHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNetworkMonitorDownHardware + Retrieve hardware which is currently experiencing a service failure. diff --git a/content/reference/services/SoftLayer_Account/getNetworkMonitorDownVirtualGuests.md b/content/reference/services/SoftLayer_Account/getNetworkMonitorDownVirtualGuests.md index 01d63f25a2..ea40d342d6 100644 --- a/content/reference/services/SoftLayer_Account/getNetworkMonitorDownVirtualGuests.md +++ b/content/reference/services/SoftLayer_Account/getNetworkMonitorDownVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNetworkMonitorDownVirtualGuests + Retrieve virtual guest which is currently experiencing a service failure. diff --git a/content/reference/services/SoftLayer_Account/getNetworkMonitorRecoveringHardware.md b/content/reference/services/SoftLayer_Account/getNetworkMonitorRecoveringHardware.md index 9f88855857..3bb53f5868 100644 --- a/content/reference/services/SoftLayer_Account/getNetworkMonitorRecoveringHardware.md +++ b/content/reference/services/SoftLayer_Account/getNetworkMonitorRecoveringHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNetworkMonitorRecoveringHardware + Retrieve hardware which is currently recovering from a service failure. diff --git a/content/reference/services/SoftLayer_Account/getNetworkMonitorRecoveringVirtualGuests.md b/content/reference/services/SoftLayer_Account/getNetworkMonitorRecoveringVirtualGuests.md index b075f3869a..bac0d2dd6d 100644 --- a/content/reference/services/SoftLayer_Account/getNetworkMonitorRecoveringVirtualGuests.md +++ b/content/reference/services/SoftLayer_Account/getNetworkMonitorRecoveringVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNetworkMonitorRecoveringVirtualGuests + Retrieve virtual guest which is currently recovering from a service failure. diff --git a/content/reference/services/SoftLayer_Account/getNetworkMonitorUpHardware.md b/content/reference/services/SoftLayer_Account/getNetworkMonitorUpHardware.md index b04a8fe36c..26bb745271 100644 --- a/content/reference/services/SoftLayer_Account/getNetworkMonitorUpHardware.md +++ b/content/reference/services/SoftLayer_Account/getNetworkMonitorUpHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNetworkMonitorUpHardware + Retrieve hardware which is currently online. diff --git a/content/reference/services/SoftLayer_Account/getNetworkMonitorUpVirtualGuests.md b/content/reference/services/SoftLayer_Account/getNetworkMonitorUpVirtualGuests.md index 6b3abe72ae..13486fee57 100644 --- a/content/reference/services/SoftLayer_Account/getNetworkMonitorUpVirtualGuests.md +++ b/content/reference/services/SoftLayer_Account/getNetworkMonitorUpVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNetworkMonitorUpVirtualGuests + Retrieve virtual guest which is currently online. diff --git a/content/reference/services/SoftLayer_Account/getNetworkStorage.md b/content/reference/services/SoftLayer_Account/getNetworkStorage.md index ae7b3b034c..c236ef9290 100644 --- a/content/reference/services/SoftLayer_Account/getNetworkStorage.md +++ b/content/reference/services/SoftLayer_Account/getNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNetworkStorage + Retrieve an account's associated storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes. diff --git a/content/reference/services/SoftLayer_Account/getNetworkStorageGroups.md b/content/reference/services/SoftLayer_Account/getNetworkStorageGroups.md index 4939045dbc..9f805dbeaa 100644 --- a/content/reference/services/SoftLayer_Account/getNetworkStorageGroups.md +++ b/content/reference/services/SoftLayer_Account/getNetworkStorageGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNetworkStorageGroups + Retrieve an account's Network Storage groups. diff --git a/content/reference/services/SoftLayer_Account/getNetworkTunnelContexts.md b/content/reference/services/SoftLayer_Account/getNetworkTunnelContexts.md index 740bfbe242..2339fb02ff 100644 --- a/content/reference/services/SoftLayer_Account/getNetworkTunnelContexts.md +++ b/content/reference/services/SoftLayer_Account/getNetworkTunnelContexts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNetworkTunnelContexts + Retrieve iPSec network tunnels for an account. diff --git a/content/reference/services/SoftLayer_Account/getNetworkVlanSpan.md b/content/reference/services/SoftLayer_Account/getNetworkVlanSpan.md index 7d430e72e5..b575813a1c 100644 --- a/content/reference/services/SoftLayer_Account/getNetworkVlanSpan.md +++ b/content/reference/services/SoftLayer_Account/getNetworkVlanSpan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNetworkVlanSpan + Retrieve whether or not an account has automatic private VLAN spanning enabled. diff --git a/content/reference/services/SoftLayer_Account/getNetworkVlans.md b/content/reference/services/SoftLayer_Account/getNetworkVlans.md index 8d9603c958..2bb7bd5647 100644 --- a/content/reference/services/SoftLayer_Account/getNetworkVlans.md +++ b/content/reference/services/SoftLayer_Account/getNetworkVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNetworkVlans + Retrieve all network VLANs assigned to an account. diff --git a/content/reference/services/SoftLayer_Account/getNextBillingPublicAllotmentHardwareBandwidthDetails.md b/content/reference/services/SoftLayer_Account/getNextBillingPublicAllotmentHardwareBandwidthDetails.md index 52ece8f7c0..7acd3fc87e 100644 --- a/content/reference/services/SoftLayer_Account/getNextBillingPublicAllotmentHardwareBandwidthDetails.md +++ b/content/reference/services/SoftLayer_Account/getNextBillingPublicAllotmentHardwareBandwidthDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNextBillingPublicAllotmentHardwareBandwidthDetails + Retrieval: DEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED. The allotments for this account and their servers for the next billing cycle. The public inbound and outbound bandwidth is calculated for each server in addition to the daily average network traffic since the last billing date. diff --git a/content/reference/services/SoftLayer_Account/getNextInvoiceExcel.md b/content/reference/services/SoftLayer_Account/getNextInvoiceExcel.md index 7ac5b27916..d04ed45125 100644 --- a/content/reference/services/SoftLayer_Account/getNextInvoiceExcel.md +++ b/content/reference/services/SoftLayer_Account/getNextInvoiceExcel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNextInvoiceExcel + Retrieve the next billing period's invoice. Note, this should be considered preliminary as you may add, remove, change billing items on your account. diff --git a/content/reference/services/SoftLayer_Account/getNextInvoiceIncubatorExemptTotal.md b/content/reference/services/SoftLayer_Account/getNextInvoiceIncubatorExemptTotal.md index c49b39535a..6b7fe91f90 100644 --- a/content/reference/services/SoftLayer_Account/getNextInvoiceIncubatorExemptTotal.md +++ b/content/reference/services/SoftLayer_Account/getNextInvoiceIncubatorExemptTotal.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNextInvoiceIncubatorExemptTotal + Retrieve the pre-tax total amount exempt from incubator credit for the account's next invoice. This field is now deprecated and will soon be removed. Please update all references to instead use nextInvoiceTotalAmount diff --git a/content/reference/services/SoftLayer_Account/getNextInvoicePdf.md b/content/reference/services/SoftLayer_Account/getNextInvoicePdf.md index f25aa649cd..3e943ea651 100644 --- a/content/reference/services/SoftLayer_Account/getNextInvoicePdf.md +++ b/content/reference/services/SoftLayer_Account/getNextInvoicePdf.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNextInvoicePdf + Retrieve the next billing period's invoice. Note, this should be considered preliminary as you may add, remove, change billing items on your account. diff --git a/content/reference/services/SoftLayer_Account/getNextInvoicePdfDetailed.md b/content/reference/services/SoftLayer_Account/getNextInvoicePdfDetailed.md index 3dbe13f33e..99889ba807 100644 --- a/content/reference/services/SoftLayer_Account/getNextInvoicePdfDetailed.md +++ b/content/reference/services/SoftLayer_Account/getNextInvoicePdfDetailed.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNextInvoicePdfDetailed + Retrieve the next billing period's detailed invoice. Note, this should be considered preliminary as you may add, remove, change billing items on your account. diff --git a/content/reference/services/SoftLayer_Account/getNextInvoiceRecurringAmountEligibleForAccountDiscount.md b/content/reference/services/SoftLayer_Account/getNextInvoiceRecurringAmountEligibleForAccountDiscount.md index ba3993b592..367c727a0e 100644 --- a/content/reference/services/SoftLayer_Account/getNextInvoiceRecurringAmountEligibleForAccountDiscount.md +++ b/content/reference/services/SoftLayer_Account/getNextInvoiceRecurringAmountEligibleForAccountDiscount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNextInvoiceRecurringAmountEligibleForAccountDiscount + Retrieve the total recurring charge amount of an account's next invoice eligible for account discount measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. diff --git a/content/reference/services/SoftLayer_Account/getNextInvoiceTopLevelBillingItems.md b/content/reference/services/SoftLayer_Account/getNextInvoiceTopLevelBillingItems.md index 2da98b0082..ce11723b17 100644 --- a/content/reference/services/SoftLayer_Account/getNextInvoiceTopLevelBillingItems.md +++ b/content/reference/services/SoftLayer_Account/getNextInvoiceTopLevelBillingItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNextInvoiceTopLevelBillingItems + Retrieve the billing items that will be on an account's next invoice. diff --git a/content/reference/services/SoftLayer_Account/getNextInvoiceTotalAmount.md b/content/reference/services/SoftLayer_Account/getNextInvoiceTotalAmount.md index 8c83542f29..87a3e7701f 100644 --- a/content/reference/services/SoftLayer_Account/getNextInvoiceTotalAmount.md +++ b/content/reference/services/SoftLayer_Account/getNextInvoiceTotalAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNextInvoiceTotalAmount + Retrieve the pre-tax total amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. diff --git a/content/reference/services/SoftLayer_Account/getNextInvoiceTotalOneTimeAmount.md b/content/reference/services/SoftLayer_Account/getNextInvoiceTotalOneTimeAmount.md index 6d3af6365b..f4b839ce6a 100644 --- a/content/reference/services/SoftLayer_Account/getNextInvoiceTotalOneTimeAmount.md +++ b/content/reference/services/SoftLayer_Account/getNextInvoiceTotalOneTimeAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNextInvoiceTotalOneTimeAmount + Retrieve the total one-time charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. diff --git a/content/reference/services/SoftLayer_Account/getNextInvoiceTotalOneTimeTaxAmount.md b/content/reference/services/SoftLayer_Account/getNextInvoiceTotalOneTimeTaxAmount.md index 3f73455463..da3664b7fd 100644 --- a/content/reference/services/SoftLayer_Account/getNextInvoiceTotalOneTimeTaxAmount.md +++ b/content/reference/services/SoftLayer_Account/getNextInvoiceTotalOneTimeTaxAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNextInvoiceTotalOneTimeTaxAmount + Retrieve the total one-time tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. diff --git a/content/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringAmount.md b/content/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringAmount.md index 04572f5318..ceababa66a 100644 --- a/content/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringAmount.md +++ b/content/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNextInvoiceTotalRecurringAmount + Retrieve the total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. diff --git a/content/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringAmountBeforeAccountDiscount.md b/content/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringAmountBeforeAccountDiscount.md index 6790b8d603..da9db3fc71 100644 --- a/content/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringAmountBeforeAccountDiscount.md +++ b/content/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringAmountBeforeAccountDiscount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNextInvoiceTotalRecurringAmountBeforeAccountDiscount + Retrieve the total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. diff --git a/content/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringTaxAmount.md b/content/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringTaxAmount.md index 008b0fe020..8cb784e066 100644 --- a/content/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringTaxAmount.md +++ b/content/reference/services/SoftLayer_Account/getNextInvoiceTotalRecurringTaxAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNextInvoiceTotalRecurringTaxAmount + Retrieve the total recurring tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. diff --git a/content/reference/services/SoftLayer_Account/getNextInvoiceTotalTaxableRecurringAmount.md b/content/reference/services/SoftLayer_Account/getNextInvoiceTotalTaxableRecurringAmount.md index b017473845..ff88aca80e 100644 --- a/content/reference/services/SoftLayer_Account/getNextInvoiceTotalTaxableRecurringAmount.md +++ b/content/reference/services/SoftLayer_Account/getNextInvoiceTotalTaxableRecurringAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getNextInvoiceTotalTaxableRecurringAmount + Retrieve the total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing. diff --git a/content/reference/services/SoftLayer_Account/getNextInvoiceZeroFeeItemCounts.md b/content/reference/services/SoftLayer_Account/getNextInvoiceZeroFeeItemCounts.md index aa4ab85c72..3420062fe0 100644 --- a/content/reference/services/SoftLayer_Account/getNextInvoiceZeroFeeItemCounts.md +++ b/content/reference/services/SoftLayer_Account/getNextInvoiceZeroFeeItemCounts.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getNotificationSubscribers.md b/content/reference/services/SoftLayer_Account/getNotificationSubscribers.md index bb0af997fb..e4098272f4 100644 --- a/content/reference/services/SoftLayer_Account/getNotificationSubscribers.md +++ b/content/reference/services/SoftLayer_Account/getNotificationSubscribers.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getObject.md b/content/reference/services/SoftLayer_Account/getObject.md index 0e3993c538..09734f1a50 100644 --- a/content/reference/services/SoftLayer_Account/getObject.md +++ b/content/reference/services/SoftLayer_Account/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getObject + Retrieve a SoftLayer_Account record. diff --git a/content/reference/services/SoftLayer_Account/getOpenAbuseTickets.md b/content/reference/services/SoftLayer_Account/getOpenAbuseTickets.md index 420425d0cb..75e33c3993 100644 --- a/content/reference/services/SoftLayer_Account/getOpenAbuseTickets.md +++ b/content/reference/services/SoftLayer_Account/getOpenAbuseTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getOpenAbuseTickets + Retrieve the open abuse tickets associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getOpenAccountingTickets.md b/content/reference/services/SoftLayer_Account/getOpenAccountingTickets.md index 534bcc0aa4..ba523f8c7e 100644 --- a/content/reference/services/SoftLayer_Account/getOpenAccountingTickets.md +++ b/content/reference/services/SoftLayer_Account/getOpenAccountingTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getOpenAccountingTickets + Retrieve the open accounting tickets associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getOpenBillingTickets.md b/content/reference/services/SoftLayer_Account/getOpenBillingTickets.md index c480d01dcf..d0f8590c80 100644 --- a/content/reference/services/SoftLayer_Account/getOpenBillingTickets.md +++ b/content/reference/services/SoftLayer_Account/getOpenBillingTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getOpenBillingTickets + Retrieve the open billing tickets associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getOpenCancellationRequests.md b/content/reference/services/SoftLayer_Account/getOpenCancellationRequests.md index a748c8f6e4..120b147163 100644 --- a/content/reference/services/SoftLayer_Account/getOpenCancellationRequests.md +++ b/content/reference/services/SoftLayer_Account/getOpenCancellationRequests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getOpenCancellationRequests + Retrieve an open ticket requesting cancellation of this server, if one exists. diff --git a/content/reference/services/SoftLayer_Account/getOpenOtherTickets.md b/content/reference/services/SoftLayer_Account/getOpenOtherTickets.md index 94747d5810..79fa02a313 100644 --- a/content/reference/services/SoftLayer_Account/getOpenOtherTickets.md +++ b/content/reference/services/SoftLayer_Account/getOpenOtherTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getOpenOtherTickets + Retrieve the open tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getOpenRecurringInvoices.md b/content/reference/services/SoftLayer_Account/getOpenRecurringInvoices.md index ceec070e9d..7e7c545592 100644 --- a/content/reference/services/SoftLayer_Account/getOpenRecurringInvoices.md +++ b/content/reference/services/SoftLayer_Account/getOpenRecurringInvoices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getOpenRecurringInvoices + Retrieve an account's recurring invoices. diff --git a/content/reference/services/SoftLayer_Account/getOpenSalesTickets.md b/content/reference/services/SoftLayer_Account/getOpenSalesTickets.md index 99930c185f..e32ba0e04c 100644 --- a/content/reference/services/SoftLayer_Account/getOpenSalesTickets.md +++ b/content/reference/services/SoftLayer_Account/getOpenSalesTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getOpenSalesTickets + Retrieve the open sales tickets associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getOpenStackAccountLinks.md b/content/reference/services/SoftLayer_Account/getOpenStackAccountLinks.md index 5bd83fc5a4..b7af8972c7 100644 --- a/content/reference/services/SoftLayer_Account/getOpenStackAccountLinks.md +++ b/content/reference/services/SoftLayer_Account/getOpenStackAccountLinks.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getOpenStackObjectStorage.md b/content/reference/services/SoftLayer_Account/getOpenStackObjectStorage.md index 0dd4849b5a..d724e59358 100644 --- a/content/reference/services/SoftLayer_Account/getOpenStackObjectStorage.md +++ b/content/reference/services/SoftLayer_Account/getOpenStackObjectStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getOpenStackObjectStorage + Retrieve an account's associated Openstack related Object Storage accounts. diff --git a/content/reference/services/SoftLayer_Account/getOpenSupportTickets.md b/content/reference/services/SoftLayer_Account/getOpenSupportTickets.md index dcd7f0b19e..cdb91df1ec 100644 --- a/content/reference/services/SoftLayer_Account/getOpenSupportTickets.md +++ b/content/reference/services/SoftLayer_Account/getOpenSupportTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getOpenSupportTickets + Retrieve the open support tickets associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getOpenTickets.md b/content/reference/services/SoftLayer_Account/getOpenTickets.md index 316454fb6e..4bd2a43b50 100644 --- a/content/reference/services/SoftLayer_Account/getOpenTickets.md +++ b/content/reference/services/SoftLayer_Account/getOpenTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getOpenTickets + Retrieve all open tickets associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getOpenTicketsWaitingOnCustomer.md b/content/reference/services/SoftLayer_Account/getOpenTicketsWaitingOnCustomer.md index a2b85a49fe..d516fe32f9 100644 --- a/content/reference/services/SoftLayer_Account/getOpenTicketsWaitingOnCustomer.md +++ b/content/reference/services/SoftLayer_Account/getOpenTicketsWaitingOnCustomer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getOpenTicketsWaitingOnCustomer + Retrieve all open tickets associated with an account last edited by an employee. diff --git a/content/reference/services/SoftLayer_Account/getOrders.md b/content/reference/services/SoftLayer_Account/getOrders.md index e5ac1fe83c..44904e4eff 100644 --- a/content/reference/services/SoftLayer_Account/getOrders.md +++ b/content/reference/services/SoftLayer_Account/getOrders.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getOrders + Retrieve an account's associated billing orders excluding upgrades. diff --git a/content/reference/services/SoftLayer_Account/getOrphanBillingItems.md b/content/reference/services/SoftLayer_Account/getOrphanBillingItems.md index 922a21b093..cca393506d 100644 --- a/content/reference/services/SoftLayer_Account/getOrphanBillingItems.md +++ b/content/reference/services/SoftLayer_Account/getOrphanBillingItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getOrphanBillingItems + Retrieve the billing items that have no parent billing item. These are items that don't necessarily belong to a single server. diff --git a/content/reference/services/SoftLayer_Account/getOwnedBrands.md b/content/reference/services/SoftLayer_Account/getOwnedBrands.md index 211e585387..16a055decb 100644 --- a/content/reference/services/SoftLayer_Account/getOwnedBrands.md +++ b/content/reference/services/SoftLayer_Account/getOwnedBrands.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getOwnedHardwareGenericComponentModels.md b/content/reference/services/SoftLayer_Account/getOwnedHardwareGenericComponentModels.md index 3615c22e48..19f3e6ac26 100644 --- a/content/reference/services/SoftLayer_Account/getOwnedHardwareGenericComponentModels.md +++ b/content/reference/services/SoftLayer_Account/getOwnedHardwareGenericComponentModels.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getPaymentProcessors.md b/content/reference/services/SoftLayer_Account/getPaymentProcessors.md index 939e047a96..2f85c6d97c 100644 --- a/content/reference/services/SoftLayer_Account/getPaymentProcessors.md +++ b/content/reference/services/SoftLayer_Account/getPaymentProcessors.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getPendingCreditCardChangeRequestData.md b/content/reference/services/SoftLayer_Account/getPendingCreditCardChangeRequestData.md index 2f81c14a20..fed619b1aa 100644 --- a/content/reference/services/SoftLayer_Account/getPendingCreditCardChangeRequestData.md +++ b/content/reference/services/SoftLayer_Account/getPendingCreditCardChangeRequestData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPendingCreditCardChangeRequestData + Retrieve details of all credit card change requests which have not been processed by a SoftLayer agent. diff --git a/content/reference/services/SoftLayer_Account/getPendingEvents.md b/content/reference/services/SoftLayer_Account/getPendingEvents.md index 802003955e..d157fc83e0 100644 --- a/content/reference/services/SoftLayer_Account/getPendingEvents.md +++ b/content/reference/services/SoftLayer_Account/getPendingEvents.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getPendingInvoice.md b/content/reference/services/SoftLayer_Account/getPendingInvoice.md index 5920a60728..33f5bafcd3 100644 --- a/content/reference/services/SoftLayer_Account/getPendingInvoice.md +++ b/content/reference/services/SoftLayer_Account/getPendingInvoice.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPendingInvoice + Retrieve an account's latest open (pending) invoice. diff --git a/content/reference/services/SoftLayer_Account/getPendingInvoiceTopLevelItems.md b/content/reference/services/SoftLayer_Account/getPendingInvoiceTopLevelItems.md index d53b3f467f..29aa3ed16a 100644 --- a/content/reference/services/SoftLayer_Account/getPendingInvoiceTopLevelItems.md +++ b/content/reference/services/SoftLayer_Account/getPendingInvoiceTopLevelItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPendingInvoiceTopLevelItems + Retrieve a list of top-level invoice items that are on an account's currently pending invoice. diff --git a/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalAmount.md b/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalAmount.md index d5457702f4..260dcbf3bd 100644 --- a/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalAmount.md +++ b/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPendingInvoiceTotalAmount + Retrieve the total amount of an account's pending invoice, if one exists. diff --git a/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalOneTimeAmount.md b/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalOneTimeAmount.md index 8bd351d6bd..4c0d75caf5 100644 --- a/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalOneTimeAmount.md +++ b/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalOneTimeAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPendingInvoiceTotalOneTimeAmount + Retrieve the total one-time charges for an account's pending invoice, if one exists. In other words, it is the sum of one-time charges, setup fees, and labor fees. It does not include taxes. diff --git a/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalOneTimeTaxAmount.md b/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalOneTimeTaxAmount.md index d500d53ed5..9c67482c15 100644 --- a/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalOneTimeTaxAmount.md +++ b/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalOneTimeTaxAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPendingInvoiceTotalOneTimeTaxAmount + Retrieve the sum of all the taxes related to one time charges for an account's pending invoice, if one exists. diff --git a/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalRecurringAmount.md b/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalRecurringAmount.md index ca0d2fa3cf..6150369447 100644 --- a/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalRecurringAmount.md +++ b/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalRecurringAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPendingInvoiceTotalRecurringAmount + Retrieve the total recurring amount of an account's pending invoice, if one exists. diff --git a/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalRecurringTaxAmount.md b/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalRecurringTaxAmount.md index c981740463..248cf46c3c 100644 --- a/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalRecurringTaxAmount.md +++ b/content/reference/services/SoftLayer_Account/getPendingInvoiceTotalRecurringTaxAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPendingInvoiceTotalRecurringTaxAmount + Retrieve the total amount of the recurring taxes on an account's pending invoice, if one exists. diff --git a/content/reference/services/SoftLayer_Account/getPermissionGroups.md b/content/reference/services/SoftLayer_Account/getPermissionGroups.md index 73b7894841..ba0d6671a5 100644 --- a/content/reference/services/SoftLayer_Account/getPermissionGroups.md +++ b/content/reference/services/SoftLayer_Account/getPermissionGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPermissionGroups + Retrieve an account's permission groups. diff --git a/content/reference/services/SoftLayer_Account/getPermissionRoles.md b/content/reference/services/SoftLayer_Account/getPermissionRoles.md index eb53b376b1..a00087ca7d 100644 --- a/content/reference/services/SoftLayer_Account/getPermissionRoles.md +++ b/content/reference/services/SoftLayer_Account/getPermissionRoles.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPermissionRoles + Retrieve an account's user roles. diff --git a/content/reference/services/SoftLayer_Account/getPlacementGroups.md b/content/reference/services/SoftLayer_Account/getPlacementGroups.md index 0114347a28..c9cd15ed38 100644 --- a/content/reference/services/SoftLayer_Account/getPlacementGroups.md +++ b/content/reference/services/SoftLayer_Account/getPlacementGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPlacementGroups + Retrieve an account's associated virtual placement groups. diff --git a/content/reference/services/SoftLayer_Account/getPortableStorageVolumes.md b/content/reference/services/SoftLayer_Account/getPortableStorageVolumes.md index 083de5c802..11f9441bcb 100644 --- a/content/reference/services/SoftLayer_Account/getPortableStorageVolumes.md +++ b/content/reference/services/SoftLayer_Account/getPortableStorageVolumes.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getPostProvisioningHooks.md b/content/reference/services/SoftLayer_Account/getPostProvisioningHooks.md index 289d2dbc1b..d150b4e83e 100644 --- a/content/reference/services/SoftLayer_Account/getPostProvisioningHooks.md +++ b/content/reference/services/SoftLayer_Account/getPostProvisioningHooks.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPostProvisioningHooks + Retrieve customer specified URIs that are downloaded onto a newly provisioned or reloaded server. If the URI is sent over https it will be executed directly on the server. diff --git a/content/reference/services/SoftLayer_Account/getPptpVpnAllowedFlag.md b/content/reference/services/SoftLayer_Account/getPptpVpnAllowedFlag.md index 17897fb130..55f2f839f0 100644 --- a/content/reference/services/SoftLayer_Account/getPptpVpnAllowedFlag.md +++ b/content/reference/services/SoftLayer_Account/getPptpVpnAllowedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPptpVpnAllowedFlag + Retrieve (Deprecated) Boolean flag dictating whether or not this account supports PPTP VPN Access. diff --git a/content/reference/services/SoftLayer_Account/getPptpVpnUsers.md b/content/reference/services/SoftLayer_Account/getPptpVpnUsers.md index 975ba4ceb6..afa6ca7daa 100644 --- a/content/reference/services/SoftLayer_Account/getPptpVpnUsers.md +++ b/content/reference/services/SoftLayer_Account/getPptpVpnUsers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPptpVpnUsers + Retrieve an account's associated portal users with PPTP VPN access. (Deprecated) diff --git a/content/reference/services/SoftLayer_Account/getPreviousRecurringRevenue.md b/content/reference/services/SoftLayer_Account/getPreviousRecurringRevenue.md index 379cd90219..c6cf03c516 100644 --- a/content/reference/services/SoftLayer_Account/getPreviousRecurringRevenue.md +++ b/content/reference/services/SoftLayer_Account/getPreviousRecurringRevenue.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPreviousRecurringRevenue + Retrieve the total recurring amount for an accounts previous revenue. diff --git a/content/reference/services/SoftLayer_Account/getPriceRestrictions.md b/content/reference/services/SoftLayer_Account/getPriceRestrictions.md index d05cb8c0de..b9e7c65790 100644 --- a/content/reference/services/SoftLayer_Account/getPriceRestrictions.md +++ b/content/reference/services/SoftLayer_Account/getPriceRestrictions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPriceRestrictions + Retrieve the item price that an account is restricted to. diff --git a/content/reference/services/SoftLayer_Account/getPriorityOneTickets.md b/content/reference/services/SoftLayer_Account/getPriorityOneTickets.md index ba3d526bf5..f325aae832 100644 --- a/content/reference/services/SoftLayer_Account/getPriorityOneTickets.md +++ b/content/reference/services/SoftLayer_Account/getPriorityOneTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPriorityOneTickets + Retrieve all priority one tickets associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getPrivateAllotmentHardwareBandwidthDetails.md b/content/reference/services/SoftLayer_Account/getPrivateAllotmentHardwareBandwidthDetails.md index 39d2a5359c..71e25eca9d 100644 --- a/content/reference/services/SoftLayer_Account/getPrivateAllotmentHardwareBandwidthDetails.md +++ b/content/reference/services/SoftLayer_Account/getPrivateAllotmentHardwareBandwidthDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPrivateAllotmentHardwareBandwidthDetails + Retrieval: DEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED. The allotments for this account and their servers. The private inbound and outbound bandwidth is calculated for each server in addition to the daily average network traffic since the last billing date. diff --git a/content/reference/services/SoftLayer_Account/getPrivateBlockDeviceTemplateGroups.md b/content/reference/services/SoftLayer_Account/getPrivateBlockDeviceTemplateGroups.md index a07d776a0b..6082872836 100644 --- a/content/reference/services/SoftLayer_Account/getPrivateBlockDeviceTemplateGroups.md +++ b/content/reference/services/SoftLayer_Account/getPrivateBlockDeviceTemplateGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPrivateBlockDeviceTemplateGroups + Retrieve private and shared template group objects (parent only) for an account. diff --git a/content/reference/services/SoftLayer_Account/getPrivateIpAddresses.md b/content/reference/services/SoftLayer_Account/getPrivateIpAddresses.md index 66fba3c0dd..7b0299f5cd 100644 --- a/content/reference/services/SoftLayer_Account/getPrivateIpAddresses.md +++ b/content/reference/services/SoftLayer_Account/getPrivateIpAddresses.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getPrivateNetworkVlans.md b/content/reference/services/SoftLayer_Account/getPrivateNetworkVlans.md index 17a4934c5d..2fbd72972f 100644 --- a/content/reference/services/SoftLayer_Account/getPrivateNetworkVlans.md +++ b/content/reference/services/SoftLayer_Account/getPrivateNetworkVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPrivateNetworkVlans + Retrieve the private network VLANs assigned to an account. diff --git a/content/reference/services/SoftLayer_Account/getPrivateSubnets.md b/content/reference/services/SoftLayer_Account/getPrivateSubnets.md index 73ec9a7b09..b5fca8de6c 100644 --- a/content/reference/services/SoftLayer_Account/getPrivateSubnets.md +++ b/content/reference/services/SoftLayer_Account/getPrivateSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPrivateSubnets + Retrieve all private subnets associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getProofOfConceptAccountFlag.md b/content/reference/services/SoftLayer_Account/getProofOfConceptAccountFlag.md index 7163fa0d1f..825a6395be 100644 --- a/content/reference/services/SoftLayer_Account/getProofOfConceptAccountFlag.md +++ b/content/reference/services/SoftLayer_Account/getProofOfConceptAccountFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getProofOfConceptAccountFlag + Retrieve boolean flag indicating whether or not this account is a Proof of Concept account. diff --git a/content/reference/services/SoftLayer_Account/getPublicAllotmentHardwareBandwidthDetails.md b/content/reference/services/SoftLayer_Account/getPublicAllotmentHardwareBandwidthDetails.md index c79cd91ef8..318050ca20 100644 --- a/content/reference/services/SoftLayer_Account/getPublicAllotmentHardwareBandwidthDetails.md +++ b/content/reference/services/SoftLayer_Account/getPublicAllotmentHardwareBandwidthDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPublicAllotmentHardwareBandwidthDetails + Retrieval: DEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED. The allotments for this account and their servers. The public inbound and outbound bandwidth is calculated for each server in addition to the daily average network traffic since the last billing date. diff --git a/content/reference/services/SoftLayer_Account/getPublicIpAddresses.md b/content/reference/services/SoftLayer_Account/getPublicIpAddresses.md index 39aee82f27..4927f43ba2 100644 --- a/content/reference/services/SoftLayer_Account/getPublicIpAddresses.md +++ b/content/reference/services/SoftLayer_Account/getPublicIpAddresses.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getPublicNetworkVlans.md b/content/reference/services/SoftLayer_Account/getPublicNetworkVlans.md index 6f50d04594..d8e1288b79 100644 --- a/content/reference/services/SoftLayer_Account/getPublicNetworkVlans.md +++ b/content/reference/services/SoftLayer_Account/getPublicNetworkVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPublicNetworkVlans + Retrieve the public network VLANs assigned to an account. diff --git a/content/reference/services/SoftLayer_Account/getPublicSubnets.md b/content/reference/services/SoftLayer_Account/getPublicSubnets.md index cbb3c4da5f..f93ce8c23c 100644 --- a/content/reference/services/SoftLayer_Account/getPublicSubnets.md +++ b/content/reference/services/SoftLayer_Account/getPublicSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getPublicSubnets + Retrieve all public network subnets associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getQuotes.md b/content/reference/services/SoftLayer_Account/getQuotes.md index 7870070ae6..0fd16dcd81 100644 --- a/content/reference/services/SoftLayer_Account/getQuotes.md +++ b/content/reference/services/SoftLayer_Account/getQuotes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getQuotes + Retrieve an account's quotes. diff --git a/content/reference/services/SoftLayer_Account/getRecentEvents.md b/content/reference/services/SoftLayer_Account/getRecentEvents.md index 6441b48051..c3c41ad3e8 100644 --- a/content/reference/services/SoftLayer_Account/getRecentEvents.md +++ b/content/reference/services/SoftLayer_Account/getRecentEvents.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getReferralPartner.md b/content/reference/services/SoftLayer_Account/getReferralPartner.md index 23d449a11b..5f76d80e6d 100644 --- a/content/reference/services/SoftLayer_Account/getReferralPartner.md +++ b/content/reference/services/SoftLayer_Account/getReferralPartner.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getReferralPartner + Retrieve the Referral Partner for this account, if any. diff --git a/content/reference/services/SoftLayer_Account/getReferralPartnerCommissionForecast.md b/content/reference/services/SoftLayer_Account/getReferralPartnerCommissionForecast.md index 3bce3503a6..132e66ae89 100644 --- a/content/reference/services/SoftLayer_Account/getReferralPartnerCommissionForecast.md +++ b/content/reference/services/SoftLayer_Account/getReferralPartnerCommissionForecast.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getReferralPartnerCommissionHistory.md b/content/reference/services/SoftLayer_Account/getReferralPartnerCommissionHistory.md index b8914d9684..a83270e64a 100644 --- a/content/reference/services/SoftLayer_Account/getReferralPartnerCommissionHistory.md +++ b/content/reference/services/SoftLayer_Account/getReferralPartnerCommissionHistory.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getReferralPartnerCommissionPending.md b/content/reference/services/SoftLayer_Account/getReferralPartnerCommissionPending.md index ec1fca2c27..dcf22f1b45 100644 --- a/content/reference/services/SoftLayer_Account/getReferralPartnerCommissionPending.md +++ b/content/reference/services/SoftLayer_Account/getReferralPartnerCommissionPending.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getReferredAccounts.md b/content/reference/services/SoftLayer_Account/getReferredAccounts.md index 1e0a160685..48e1c625aa 100644 --- a/content/reference/services/SoftLayer_Account/getReferredAccounts.md +++ b/content/reference/services/SoftLayer_Account/getReferredAccounts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getReferredAccounts + Retrieve if this is a account is a referral partner, the accounts this referral partner has referred diff --git a/content/reference/services/SoftLayer_Account/getRegulatedWorkloads.md b/content/reference/services/SoftLayer_Account/getRegulatedWorkloads.md index df02e4f3f5..18c88fe223 100644 --- a/content/reference/services/SoftLayer_Account/getRegulatedWorkloads.md +++ b/content/reference/services/SoftLayer_Account/getRegulatedWorkloads.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getRemoteManagementCommandRequests.md b/content/reference/services/SoftLayer_Account/getRemoteManagementCommandRequests.md index 02718cde0e..8bd0329eee 100644 --- a/content/reference/services/SoftLayer_Account/getRemoteManagementCommandRequests.md +++ b/content/reference/services/SoftLayer_Account/getRemoteManagementCommandRequests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getRemoteManagementCommandRequests + Retrieve remote management command requests for an account diff --git a/content/reference/services/SoftLayer_Account/getReplicationEvents.md b/content/reference/services/SoftLayer_Account/getReplicationEvents.md index 92a6352ae8..4aca9c00ca 100644 --- a/content/reference/services/SoftLayer_Account/getReplicationEvents.md +++ b/content/reference/services/SoftLayer_Account/getReplicationEvents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getReplicationEvents + Retrieve the Replication events for all Network Storage volumes on an account. diff --git a/content/reference/services/SoftLayer_Account/getRequireSilentIBMidUserCreation.md b/content/reference/services/SoftLayer_Account/getRequireSilentIBMidUserCreation.md index 728cfb0584..052d50b843 100644 --- a/content/reference/services/SoftLayer_Account/getRequireSilentIBMidUserCreation.md +++ b/content/reference/services/SoftLayer_Account/getRequireSilentIBMidUserCreation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getRequireSilentIBMidUserCreation + Retrieve indicates whether newly created users under this account will be associated with IBMid via an email requiring a response, or not. diff --git a/content/reference/services/SoftLayer_Account/getReservedCapacityAgreements.md b/content/reference/services/SoftLayer_Account/getReservedCapacityAgreements.md index 1ca76aecfd..8557fe22fc 100644 --- a/content/reference/services/SoftLayer_Account/getReservedCapacityAgreements.md +++ b/content/reference/services/SoftLayer_Account/getReservedCapacityAgreements.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getReservedCapacityAgreements + Retrieve all reserved capacity agreements for an account diff --git a/content/reference/services/SoftLayer_Account/getReservedCapacityGroups.md b/content/reference/services/SoftLayer_Account/getReservedCapacityGroups.md index 2a7c4c5af4..30e507f651 100644 --- a/content/reference/services/SoftLayer_Account/getReservedCapacityGroups.md +++ b/content/reference/services/SoftLayer_Account/getReservedCapacityGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getReservedCapacityGroups + Retrieve the reserved capacity groups owned by this account. diff --git a/content/reference/services/SoftLayer_Account/getResourceGroups.md b/content/reference/services/SoftLayer_Account/getResourceGroups.md index 92901890f2..18820668d3 100644 --- a/content/reference/services/SoftLayer_Account/getResourceGroups.md +++ b/content/reference/services/SoftLayer_Account/getResourceGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getResourceGroups + Retrieve an account's associated top-level resource groups. diff --git a/content/reference/services/SoftLayer_Account/getRouters.md b/content/reference/services/SoftLayer_Account/getRouters.md index fcada0d397..9acfea40b9 100644 --- a/content/reference/services/SoftLayer_Account/getRouters.md +++ b/content/reference/services/SoftLayer_Account/getRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getRouters + Retrieve all Routers that an accounts VLANs reside on diff --git a/content/reference/services/SoftLayer_Account/getRwhoisData.md b/content/reference/services/SoftLayer_Account/getRwhoisData.md index ea0ca7086e..193be2c67f 100644 --- a/content/reference/services/SoftLayer_Account/getRwhoisData.md +++ b/content/reference/services/SoftLayer_Account/getRwhoisData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getRwhoisData + Retrieval: DEPRECATED diff --git a/content/reference/services/SoftLayer_Account/getSamlAuthentication.md b/content/reference/services/SoftLayer_Account/getSamlAuthentication.md index 7fab1155e8..d07952d0b1 100644 --- a/content/reference/services/SoftLayer_Account/getSamlAuthentication.md +++ b/content/reference/services/SoftLayer_Account/getSamlAuthentication.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getSamlAuthentication + Retrieve the SAML configuration for this account. diff --git a/content/reference/services/SoftLayer_Account/getScaleGroups.md b/content/reference/services/SoftLayer_Account/getScaleGroups.md index c118749bc9..1d7ec1298f 100644 --- a/content/reference/services/SoftLayer_Account/getScaleGroups.md +++ b/content/reference/services/SoftLayer_Account/getScaleGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getScaleGroups + Retrieve all scale groups on this account. diff --git a/content/reference/services/SoftLayer_Account/getSecondaryDomains.md b/content/reference/services/SoftLayer_Account/getSecondaryDomains.md index 49a5d0fb73..5a9fba95ff 100644 --- a/content/reference/services/SoftLayer_Account/getSecondaryDomains.md +++ b/content/reference/services/SoftLayer_Account/getSecondaryDomains.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getSecondaryDomains + Retrieve the secondary DNS records for a SoftLayer customer account. diff --git a/content/reference/services/SoftLayer_Account/getSecurityCertificates.md b/content/reference/services/SoftLayer_Account/getSecurityCertificates.md index 89eb290bf9..0038ed4405 100644 --- a/content/reference/services/SoftLayer_Account/getSecurityCertificates.md +++ b/content/reference/services/SoftLayer_Account/getSecurityCertificates.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getSecurityCertificates + Retrieve stored security certificates (ie. SSL) diff --git a/content/reference/services/SoftLayer_Account/getSecurityGroups.md b/content/reference/services/SoftLayer_Account/getSecurityGroups.md index 73d9384666..6b1debdec9 100644 --- a/content/reference/services/SoftLayer_Account/getSecurityGroups.md +++ b/content/reference/services/SoftLayer_Account/getSecurityGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getSecurityGroups + Retrieve the security groups belonging to this account. diff --git a/content/reference/services/SoftLayer_Account/getSecurityLevel.md b/content/reference/services/SoftLayer_Account/getSecurityLevel.md index b67a613f5b..6fd797d6a0 100644 --- a/content/reference/services/SoftLayer_Account/getSecurityLevel.md +++ b/content/reference/services/SoftLayer_Account/getSecurityLevel.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getSecurityScanRequests.md b/content/reference/services/SoftLayer_Account/getSecurityScanRequests.md index 0d28874875..ed45425fa5 100644 --- a/content/reference/services/SoftLayer_Account/getSecurityScanRequests.md +++ b/content/reference/services/SoftLayer_Account/getSecurityScanRequests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getSecurityScanRequests + Retrieve an account's vulnerability scan requests. diff --git a/content/reference/services/SoftLayer_Account/getServiceBillingItems.md b/content/reference/services/SoftLayer_Account/getServiceBillingItems.md index 8986da2e0a..203a726719 100644 --- a/content/reference/services/SoftLayer_Account/getServiceBillingItems.md +++ b/content/reference/services/SoftLayer_Account/getServiceBillingItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getServiceBillingItems + Retrieve the service billing items that will be on an account's next invoice. diff --git a/content/reference/services/SoftLayer_Account/getSharedBlockDeviceTemplateGroups.md b/content/reference/services/SoftLayer_Account/getSharedBlockDeviceTemplateGroups.md index 1326ef84a2..c5b21b1371 100644 --- a/content/reference/services/SoftLayer_Account/getSharedBlockDeviceTemplateGroups.md +++ b/content/reference/services/SoftLayer_Account/getSharedBlockDeviceTemplateGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getSharedBlockDeviceTemplateGroups + Get the collection of template group objects that have been shared with this account. diff --git a/content/reference/services/SoftLayer_Account/getShipments.md b/content/reference/services/SoftLayer_Account/getShipments.md index ca1762b98f..47bf97a4d7 100644 --- a/content/reference/services/SoftLayer_Account/getShipments.md +++ b/content/reference/services/SoftLayer_Account/getShipments.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getShipments + Retrieve shipments that belong to the customer's account. diff --git a/content/reference/services/SoftLayer_Account/getSshKeys.md b/content/reference/services/SoftLayer_Account/getSshKeys.md index 01fb49cbbc..51e49c4690 100644 --- a/content/reference/services/SoftLayer_Account/getSshKeys.md +++ b/content/reference/services/SoftLayer_Account/getSshKeys.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getSshKeys + Retrieve customer specified SSH keys that can be implemented onto a newly provisioned or reloaded server. diff --git a/content/reference/services/SoftLayer_Account/getSslVpnUsers.md b/content/reference/services/SoftLayer_Account/getSslVpnUsers.md index 31340008b8..6e0db29367 100644 --- a/content/reference/services/SoftLayer_Account/getSslVpnUsers.md +++ b/content/reference/services/SoftLayer_Account/getSslVpnUsers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getSslVpnUsers + Retrieve an account's associated portal users with SSL VPN access. diff --git a/content/reference/services/SoftLayer_Account/getStandardPoolVirtualGuests.md b/content/reference/services/SoftLayer_Account/getStandardPoolVirtualGuests.md index a7fc76f1c3..ef23a67b43 100644 --- a/content/reference/services/SoftLayer_Account/getStandardPoolVirtualGuests.md +++ b/content/reference/services/SoftLayer_Account/getStandardPoolVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getStandardPoolVirtualGuests + Retrieve an account's virtual guest objects that are hosted on a user provisioned hypervisor. diff --git a/content/reference/services/SoftLayer_Account/getSubnetRegistrationDetails.md b/content/reference/services/SoftLayer_Account/getSubnetRegistrationDetails.md index a6c776f2db..cf607f2352 100644 --- a/content/reference/services/SoftLayer_Account/getSubnetRegistrationDetails.md +++ b/content/reference/services/SoftLayer_Account/getSubnetRegistrationDetails.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getSubnetRegistrations.md b/content/reference/services/SoftLayer_Account/getSubnetRegistrations.md index ce95bb99fb..ddf641fdc8 100644 --- a/content/reference/services/SoftLayer_Account/getSubnetRegistrations.md +++ b/content/reference/services/SoftLayer_Account/getSubnetRegistrations.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getSubnets.md b/content/reference/services/SoftLayer_Account/getSubnets.md index bff159ec0d..989ee7256d 100644 --- a/content/reference/services/SoftLayer_Account/getSubnets.md +++ b/content/reference/services/SoftLayer_Account/getSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getSubnets + Retrieve all network subnets associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getSupportRepresentatives.md b/content/reference/services/SoftLayer_Account/getSupportRepresentatives.md index 9abe91460f..403383ab4b 100644 --- a/content/reference/services/SoftLayer_Account/getSupportRepresentatives.md +++ b/content/reference/services/SoftLayer_Account/getSupportRepresentatives.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getSupportRepresentatives + Retrieve the SoftLayer employees that an account is assigned to. diff --git a/content/reference/services/SoftLayer_Account/getSupportSubscriptions.md b/content/reference/services/SoftLayer_Account/getSupportSubscriptions.md index dfaedc5b87..22c0b53d40 100644 --- a/content/reference/services/SoftLayer_Account/getSupportSubscriptions.md +++ b/content/reference/services/SoftLayer_Account/getSupportSubscriptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getSupportSubscriptions + Retrieve the active support subscriptions for this account. diff --git a/content/reference/services/SoftLayer_Account/getSupportTier.md b/content/reference/services/SoftLayer_Account/getSupportTier.md index 5c88c90db6..21d90ebd78 100644 --- a/content/reference/services/SoftLayer_Account/getSupportTier.md +++ b/content/reference/services/SoftLayer_Account/getSupportTier.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getSuppressInvoicesFlag.md b/content/reference/services/SoftLayer_Account/getSuppressInvoicesFlag.md index e947e4872e..95d9c84c2a 100644 --- a/content/reference/services/SoftLayer_Account/getSuppressInvoicesFlag.md +++ b/content/reference/services/SoftLayer_Account/getSuppressInvoicesFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getSuppressInvoicesFlag + Retrieve a flag indicating to suppress invoices. diff --git a/content/reference/services/SoftLayer_Account/getTags.md b/content/reference/services/SoftLayer_Account/getTags.md index 361a39632c..bd8da34017 100644 --- a/content/reference/services/SoftLayer_Account/getTags.md +++ b/content/reference/services/SoftLayer_Account/getTags.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getTechIncubatorProgramInfo.md b/content/reference/services/SoftLayer_Account/getTechIncubatorProgramInfo.md index af735a91fd..94fbc64742 100644 --- a/content/reference/services/SoftLayer_Account/getTechIncubatorProgramInfo.md +++ b/content/reference/services/SoftLayer_Account/getTechIncubatorProgramInfo.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getTechIncubatorProgramInfo + This method retrieves the Technology Incubator Program information for your account. diff --git a/content/reference/services/SoftLayer_Account/getThirdPartyPoliciesAcceptanceStatus.md b/content/reference/services/SoftLayer_Account/getThirdPartyPoliciesAcceptanceStatus.md index c5c363728e..15fa6ceb14 100644 --- a/content/reference/services/SoftLayer_Account/getThirdPartyPoliciesAcceptanceStatus.md +++ b/content/reference/services/SoftLayer_Account/getThirdPartyPoliciesAcceptanceStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getThirdPartyPoliciesAcceptanceStatus + Get the acceptance status of the applicable third-party policies. diff --git a/content/reference/services/SoftLayer_Account/getTickets.md b/content/reference/services/SoftLayer_Account/getTickets.md index 848a145259..165ad49c29 100644 --- a/content/reference/services/SoftLayer_Account/getTickets.md +++ b/content/reference/services/SoftLayer_Account/getTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getTickets + Retrieve an account's associated tickets. diff --git a/content/reference/services/SoftLayer_Account/getTicketsClosedInTheLastThreeDays.md b/content/reference/services/SoftLayer_Account/getTicketsClosedInTheLastThreeDays.md index c5488597dc..a5b24dc814 100644 --- a/content/reference/services/SoftLayer_Account/getTicketsClosedInTheLastThreeDays.md +++ b/content/reference/services/SoftLayer_Account/getTicketsClosedInTheLastThreeDays.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getTicketsClosedInTheLastThreeDays + Retrieve tickets closed within the last 72 hours or last 10 tickets, whichever is less, associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getTicketsClosedToday.md b/content/reference/services/SoftLayer_Account/getTicketsClosedToday.md index 24d5aaf9c2..3ebac7173f 100644 --- a/content/reference/services/SoftLayer_Account/getTicketsClosedToday.md +++ b/content/reference/services/SoftLayer_Account/getTicketsClosedToday.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getTicketsClosedToday + Retrieve tickets closed today associated with an account. diff --git a/content/reference/services/SoftLayer_Account/getTranscodeAccounts.md b/content/reference/services/SoftLayer_Account/getTranscodeAccounts.md index 73c4e474ff..b520a27ac5 100644 --- a/content/reference/services/SoftLayer_Account/getTranscodeAccounts.md +++ b/content/reference/services/SoftLayer_Account/getTranscodeAccounts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getTranscodeAccounts + Retrieve an account's associated Transcode account. diff --git a/content/reference/services/SoftLayer_Account/getUpgradeRequests.md b/content/reference/services/SoftLayer_Account/getUpgradeRequests.md index 563d0e80c6..5d7a5c7cf8 100644 --- a/content/reference/services/SoftLayer_Account/getUpgradeRequests.md +++ b/content/reference/services/SoftLayer_Account/getUpgradeRequests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getUpgradeRequests + Retrieve an account's associated upgrade requests. diff --git a/content/reference/services/SoftLayer_Account/getUsers.md b/content/reference/services/SoftLayer_Account/getUsers.md index 4737e003c3..1bbe557091 100644 --- a/content/reference/services/SoftLayer_Account/getUsers.md +++ b/content/reference/services/SoftLayer_Account/getUsers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getUsers + Retrieve an account's portal users. diff --git a/content/reference/services/SoftLayer_Account/getValidSecurityCertificateEntries.md b/content/reference/services/SoftLayer_Account/getValidSecurityCertificateEntries.md index 322dab6c1e..f5584e8966 100644 --- a/content/reference/services/SoftLayer_Account/getValidSecurityCertificateEntries.md +++ b/content/reference/services/SoftLayer_Account/getValidSecurityCertificateEntries.md @@ -16,6 +16,7 @@ aliases: + ## Overview Retrieve a list of valid (non-expired) security certificates without the sensitive certificate information. This allows non-privileged users to view and select security certificates when configuring associated services. diff --git a/content/reference/services/SoftLayer_Account/getValidSecurityCertificates.md b/content/reference/services/SoftLayer_Account/getValidSecurityCertificates.md index 300a67a1ec..ea662d4eb5 100644 --- a/content/reference/services/SoftLayer_Account/getValidSecurityCertificates.md +++ b/content/reference/services/SoftLayer_Account/getValidSecurityCertificates.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getValidSecurityCertificates + Retrieve stored security certificates that are not expired (ie. SSL) diff --git a/content/reference/services/SoftLayer_Account/getVdrUpdatesInProgressFlag.md b/content/reference/services/SoftLayer_Account/getVdrUpdatesInProgressFlag.md index c0ca350ab3..8367eaa8ee 100644 --- a/content/reference/services/SoftLayer_Account/getVdrUpdatesInProgressFlag.md +++ b/content/reference/services/SoftLayer_Account/getVdrUpdatesInProgressFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVdrUpdatesInProgressFlag + Retrieve return 0 if vpn updates are currently in progress on this account otherwise 1. diff --git a/content/reference/services/SoftLayer_Account/getVirtualDedicatedRacks.md b/content/reference/services/SoftLayer_Account/getVirtualDedicatedRacks.md index 14e32a53d3..7d207adfea 100644 --- a/content/reference/services/SoftLayer_Account/getVirtualDedicatedRacks.md +++ b/content/reference/services/SoftLayer_Account/getVirtualDedicatedRacks.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVirtualDedicatedRacks + Retrieve the bandwidth pooling for this account. diff --git a/content/reference/services/SoftLayer_Account/getVirtualDiskImages.md b/content/reference/services/SoftLayer_Account/getVirtualDiskImages.md index e25a22998c..e525cf9227 100644 --- a/content/reference/services/SoftLayer_Account/getVirtualDiskImages.md +++ b/content/reference/services/SoftLayer_Account/getVirtualDiskImages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVirtualDiskImages + Retrieve an account's associated virtual server virtual disk images. diff --git a/content/reference/services/SoftLayer_Account/getVirtualGuests.md b/content/reference/services/SoftLayer_Account/getVirtualGuests.md index 72bde87a6a..970c204f4a 100644 --- a/content/reference/services/SoftLayer_Account/getVirtualGuests.md +++ b/content/reference/services/SoftLayer_Account/getVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVirtualGuests + Retrieve an account's associated virtual guest objects. diff --git a/content/reference/services/SoftLayer_Account/getVirtualGuestsOverBandwidthAllocation.md b/content/reference/services/SoftLayer_Account/getVirtualGuestsOverBandwidthAllocation.md index 9734db3291..81a0a22748 100644 --- a/content/reference/services/SoftLayer_Account/getVirtualGuestsOverBandwidthAllocation.md +++ b/content/reference/services/SoftLayer_Account/getVirtualGuestsOverBandwidthAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVirtualGuestsOverBandwidthAllocation + Retrieve an account's associated virtual guest objects currently over bandwidth allocation. diff --git a/content/reference/services/SoftLayer_Account/getVirtualGuestsProjectedOverBandwidthAllocation.md b/content/reference/services/SoftLayer_Account/getVirtualGuestsProjectedOverBandwidthAllocation.md index 230b9c67b0..da47db55d7 100644 --- a/content/reference/services/SoftLayer_Account/getVirtualGuestsProjectedOverBandwidthAllocation.md +++ b/content/reference/services/SoftLayer_Account/getVirtualGuestsProjectedOverBandwidthAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVirtualGuestsProjectedOverBandwidthAllocation + Retrieve an account's associated virtual guest objects currently over bandwidth allocation. diff --git a/content/reference/services/SoftLayer_Account/getVirtualGuestsWithCpanel.md b/content/reference/services/SoftLayer_Account/getVirtualGuestsWithCpanel.md index 779804b44a..1e4e350fd3 100644 --- a/content/reference/services/SoftLayer_Account/getVirtualGuestsWithCpanel.md +++ b/content/reference/services/SoftLayer_Account/getVirtualGuestsWithCpanel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVirtualGuestsWithCpanel + Retrieve all virtual guests associated with an account that has the cPanel web hosting control panel installed. diff --git a/content/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafee.md b/content/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafee.md index 2d8f770bfd..ffe9db67b5 100644 --- a/content/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafee.md +++ b/content/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafee.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVirtualGuestsWithMcafee + Retrieve all virtual guests associated with an account that have McAfee Secure software components. diff --git a/content/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafeeAntivirusRedhat.md b/content/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafeeAntivirusRedhat.md index 3da2c9006f..206bb272a7 100644 --- a/content/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafeeAntivirusRedhat.md +++ b/content/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafeeAntivirusRedhat.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVirtualGuestsWithMcafeeAntivirusRedhat + Retrieve all virtual guests associated with an account that have McAfee Secure AntiVirus for Redhat software components. diff --git a/content/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafeeAntivirusWindows.md b/content/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafeeAntivirusWindows.md index 795241090a..efe6f03179 100644 --- a/content/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafeeAntivirusWindows.md +++ b/content/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafeeAntivirusWindows.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVirtualGuestsWithMcafeeAntivirusWindows + Retrieve all virtual guests associated with an account that has McAfee Secure AntiVirus for Windows software components. diff --git a/content/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafeeIntrusionDetectionSystem.md b/content/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafeeIntrusionDetectionSystem.md index 2bab999d33..7564cb86cc 100644 --- a/content/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafeeIntrusionDetectionSystem.md +++ b/content/reference/services/SoftLayer_Account/getVirtualGuestsWithMcafeeIntrusionDetectionSystem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVirtualGuestsWithMcafeeIntrusionDetectionSystem + Retrieve all virtual guests associated with an account that has McAfee Secure Intrusion Detection System software components. diff --git a/content/reference/services/SoftLayer_Account/getVirtualGuestsWithPlesk.md b/content/reference/services/SoftLayer_Account/getVirtualGuestsWithPlesk.md index 215b23bd75..bc930366fa 100644 --- a/content/reference/services/SoftLayer_Account/getVirtualGuestsWithPlesk.md +++ b/content/reference/services/SoftLayer_Account/getVirtualGuestsWithPlesk.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVirtualGuestsWithPlesk + Retrieve all virtual guests associated with an account that has the Plesk web hosting control panel installed. diff --git a/content/reference/services/SoftLayer_Account/getVirtualGuestsWithQuantastor.md b/content/reference/services/SoftLayer_Account/getVirtualGuestsWithQuantastor.md index d24c33941a..881a800a15 100644 --- a/content/reference/services/SoftLayer_Account/getVirtualGuestsWithQuantastor.md +++ b/content/reference/services/SoftLayer_Account/getVirtualGuestsWithQuantastor.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVirtualGuestsWithQuantastor + Retrieve all virtual guests associated with an account that have the QuantaStor storage system installed. diff --git a/content/reference/services/SoftLayer_Account/getVirtualGuestsWithUrchin.md b/content/reference/services/SoftLayer_Account/getVirtualGuestsWithUrchin.md index 3032c64569..2483c77e2e 100644 --- a/content/reference/services/SoftLayer_Account/getVirtualGuestsWithUrchin.md +++ b/content/reference/services/SoftLayer_Account/getVirtualGuestsWithUrchin.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVirtualGuestsWithUrchin + Retrieve all virtual guests associated with an account that has the Urchin web traffic analytics package installed. diff --git a/content/reference/services/SoftLayer_Account/getVirtualPrivateRack.md b/content/reference/services/SoftLayer_Account/getVirtualPrivateRack.md index 08587afc3e..b27a31712b 100644 --- a/content/reference/services/SoftLayer_Account/getVirtualPrivateRack.md +++ b/content/reference/services/SoftLayer_Account/getVirtualPrivateRack.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVirtualPrivateRack + Retrieve the bandwidth pooling for this account. diff --git a/content/reference/services/SoftLayer_Account/getVirtualStorageArchiveRepositories.md b/content/reference/services/SoftLayer_Account/getVirtualStorageArchiveRepositories.md index cdb76c69e2..90dde6569c 100644 --- a/content/reference/services/SoftLayer_Account/getVirtualStorageArchiveRepositories.md +++ b/content/reference/services/SoftLayer_Account/getVirtualStorageArchiveRepositories.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVirtualStorageArchiveRepositories + Retrieve an account's associated virtual server archived storage repositories. diff --git a/content/reference/services/SoftLayer_Account/getVirtualStoragePublicRepositories.md b/content/reference/services/SoftLayer_Account/getVirtualStoragePublicRepositories.md index 595c186f65..4dc74f2b51 100644 --- a/content/reference/services/SoftLayer_Account/getVirtualStoragePublicRepositories.md +++ b/content/reference/services/SoftLayer_Account/getVirtualStoragePublicRepositories.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVirtualStoragePublicRepositories + Retrieve an account's associated virtual server public storage repositories. diff --git a/content/reference/services/SoftLayer_Account/getVmWareActiveAccountLicenseKeys.md b/content/reference/services/SoftLayer_Account/getVmWareActiveAccountLicenseKeys.md index b349e50f86..f066f38b41 100644 --- a/content/reference/services/SoftLayer_Account/getVmWareActiveAccountLicenseKeys.md +++ b/content/reference/services/SoftLayer_Account/getVmWareActiveAccountLicenseKeys.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVmWareActiveAccountLicenseKeys + Get a collection of active VMware software account license keys. diff --git a/content/reference/services/SoftLayer_Account/getVpcVirtualGuests.md b/content/reference/services/SoftLayer_Account/getVpcVirtualGuests.md index aa46fec990..7adfcde34b 100644 --- a/content/reference/services/SoftLayer_Account/getVpcVirtualGuests.md +++ b/content/reference/services/SoftLayer_Account/getVpcVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getVpcVirtualGuests + Retrieve an account's associated VPC configured virtual guest objects. diff --git a/content/reference/services/SoftLayer_Account/getVpnConfigRequiresVPNManageFlag.md b/content/reference/services/SoftLayer_Account/getVpnConfigRequiresVPNManageFlag.md index ef81807963..d9037ce2a1 100644 --- a/content/reference/services/SoftLayer_Account/getVpnConfigRequiresVPNManageFlag.md +++ b/content/reference/services/SoftLayer_Account/getVpnConfigRequiresVPNManageFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/getWindowsUpdateStatus.md b/content/reference/services/SoftLayer_Account/getWindowsUpdateStatus.md index 1ec03e0d05..6218c2a30d 100644 --- a/content/reference/services/SoftLayer_Account/getWindowsUpdateStatus.md +++ b/content/reference/services/SoftLayer_Account/getWindowsUpdateStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::getWindowsUpdateStatus + Retrieve a list of an account's hardware's Windows Update status. diff --git a/content/reference/services/SoftLayer_Account/hasAttribute.md b/content/reference/services/SoftLayer_Account/hasAttribute.md index a104518b8f..4c0c3aeb53 100644 --- a/content/reference/services/SoftLayer_Account/hasAttribute.md +++ b/content/reference/services/SoftLayer_Account/hasAttribute.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::hasAttribute + Determine if an account has a given attribute. diff --git a/content/reference/services/SoftLayer_Account/hourlyInstanceLimit.md b/content/reference/services/SoftLayer_Account/hourlyInstanceLimit.md index 510d70b544..9d3c277e41 100644 --- a/content/reference/services/SoftLayer_Account/hourlyInstanceLimit.md +++ b/content/reference/services/SoftLayer_Account/hourlyInstanceLimit.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::hourlyInstanceLimit + Retrieve the number of hourly services that an account is allowed to have diff --git a/content/reference/services/SoftLayer_Account/hourlyServerLimit.md b/content/reference/services/SoftLayer_Account/hourlyServerLimit.md index 57269a047c..642c21e175 100644 --- a/content/reference/services/SoftLayer_Account/hourlyServerLimit.md +++ b/content/reference/services/SoftLayer_Account/hourlyServerLimit.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::hourlyServerLimit + Retrieve the number of hourly bare metal servers that an account is allowed to have diff --git a/content/reference/services/SoftLayer_Account/isActiveVmwareCustomer.md b/content/reference/services/SoftLayer_Account/isActiveVmwareCustomer.md index f16b728869..3210b5c8ba 100644 --- a/content/reference/services/SoftLayer_Account/isActiveVmwareCustomer.md +++ b/content/reference/services/SoftLayer_Account/isActiveVmwareCustomer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::isActiveVmwareCustomer + Determines if the account is considered an active VMware customer and as such eligible to order VMware restricted products. This result is cached for up to 60 seconds. diff --git a/content/reference/services/SoftLayer_Account/isEligibleForLocalCurrencyProgram.md b/content/reference/services/SoftLayer_Account/isEligibleForLocalCurrencyProgram.md index a4df24dcd4..ed7bcf7b0f 100644 --- a/content/reference/services/SoftLayer_Account/isEligibleForLocalCurrencyProgram.md +++ b/content/reference/services/SoftLayer_Account/isEligibleForLocalCurrencyProgram.md @@ -16,6 +16,7 @@ aliases: + ## Overview Returns true if this account is eligible for the local currency program, false otherwise. diff --git a/content/reference/services/SoftLayer_Account/isEligibleToLinkWithPaas.md b/content/reference/services/SoftLayer_Account/isEligibleToLinkWithPaas.md index 39fe90f158..ddf3ba8923 100644 --- a/content/reference/services/SoftLayer_Account/isEligibleToLinkWithPaas.md +++ b/content/reference/services/SoftLayer_Account/isEligibleToLinkWithPaas.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::isEligibleToLinkWithPaas + Returns true if this account is eligible to link with PaaS. False otherwise. diff --git a/content/reference/services/SoftLayer_Account/linkExternalAccount.md b/content/reference/services/SoftLayer_Account/linkExternalAccount.md index 5c44442ced..0c9c4895c3 100644 --- a/content/reference/services/SoftLayer_Account/linkExternalAccount.md +++ b/content/reference/services/SoftLayer_Account/linkExternalAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::linkExternalAccount + This method will link this SoftLayer account with the provided external account. diff --git a/content/reference/services/SoftLayer_Account/removeAlternateCreditCard.md b/content/reference/services/SoftLayer_Account/removeAlternateCreditCard.md index 39fd4f036d..0e0fc01998 100644 --- a/content/reference/services/SoftLayer_Account/removeAlternateCreditCard.md +++ b/content/reference/services/SoftLayer_Account/removeAlternateCreditCard.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/requestCreditCardChange.md b/content/reference/services/SoftLayer_Account/requestCreditCardChange.md index f2da8956dd..a0818f9205 100644 --- a/content/reference/services/SoftLayer_Account/requestCreditCardChange.md +++ b/content/reference/services/SoftLayer_Account/requestCreditCardChange.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::requestCreditCardChange + Retrieve the record data associated with the submission of a Credit Card Change Request. diff --git a/content/reference/services/SoftLayer_Account/requestManualPayment.md b/content/reference/services/SoftLayer_Account/requestManualPayment.md index f65a710516..03cff2aaff 100644 --- a/content/reference/services/SoftLayer_Account/requestManualPayment.md +++ b/content/reference/services/SoftLayer_Account/requestManualPayment.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::requestManualPayment + Retrieve the record data associated with the submission of a Manual Payment Request. diff --git a/content/reference/services/SoftLayer_Account/requestManualPaymentUsingCreditCardOnFile.md b/content/reference/services/SoftLayer_Account/requestManualPaymentUsingCreditCardOnFile.md index d186c33ad4..7c4567b6c4 100644 --- a/content/reference/services/SoftLayer_Account/requestManualPaymentUsingCreditCardOnFile.md +++ b/content/reference/services/SoftLayer_Account/requestManualPaymentUsingCreditCardOnFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::requestManualPaymentUsingCreditCardOnFile + Retrieve the record data associated with the submission of a Manual Payment Request which charges the manual payment to a credit card already on file. diff --git a/content/reference/services/SoftLayer_Account/setAbuseEmails.md b/content/reference/services/SoftLayer_Account/setAbuseEmails.md index fcebc4fe50..3e2ed0db38 100644 --- a/content/reference/services/SoftLayer_Account/setAbuseEmails.md +++ b/content/reference/services/SoftLayer_Account/setAbuseEmails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::setAbuseEmails + Set this account's abuse emails. diff --git a/content/reference/services/SoftLayer_Account/setManagedPoolQuantity.md b/content/reference/services/SoftLayer_Account/setManagedPoolQuantity.md index 3e317b279b..18cc17d7ce 100644 --- a/content/reference/services/SoftLayer_Account/setManagedPoolQuantity.md +++ b/content/reference/services/SoftLayer_Account/setManagedPoolQuantity.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::setManagedPoolQuantity + Set the number of desired servers in the pool diff --git a/content/reference/services/SoftLayer_Account/setVlanSpan.md b/content/reference/services/SoftLayer_Account/setVlanSpan.md index 5968e30ec4..a44fc579bd 100644 --- a/content/reference/services/SoftLayer_Account/setVlanSpan.md +++ b/content/reference/services/SoftLayer_Account/setVlanSpan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::setVlanSpan + Set the flag that enables or disables automatic private network VLAN spanning for a SoftLayer customer account. diff --git a/content/reference/services/SoftLayer_Account/swapCreditCards.md b/content/reference/services/SoftLayer_Account/swapCreditCards.md index 64106b6dc0..58b25ab505 100644 --- a/content/reference/services/SoftLayer_Account/swapCreditCards.md +++ b/content/reference/services/SoftLayer_Account/swapCreditCards.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account/syncCurrentUserPopulationWithPaas.md b/content/reference/services/SoftLayer_Account/syncCurrentUserPopulationWithPaas.md index ce17ee4a8e..159b4dac3c 100644 --- a/content/reference/services/SoftLayer_Account/syncCurrentUserPopulationWithPaas.md +++ b/content/reference/services/SoftLayer_Account/syncCurrentUserPopulationWithPaas.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::syncCurrentUserPopulationWithPaas + This method manually starts a synchronize operation for the current IBMid-authenticated user population of a linked account pair. "Manually" means "independent of an account link operation". diff --git a/content/reference/services/SoftLayer_Account/updateVpnUsersForResource.md b/content/reference/services/SoftLayer_Account/updateVpnUsersForResource.md index b0a7558dab..477e458bd1 100644 --- a/content/reference/services/SoftLayer_Account/updateVpnUsersForResource.md +++ b/content/reference/services/SoftLayer_Account/updateVpnUsersForResource.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::updateVpnUsersForResource +
              Deprecated
              + [DEPRECATED] Creates or updates a user VPN access privileges for a server on account. diff --git a/content/reference/services/SoftLayer_Account/validate.md b/content/reference/services/SoftLayer_Account/validate.md index 21f33b4155..02874ee70f 100644 --- a/content/reference/services/SoftLayer_Account/validate.md +++ b/content/reference/services/SoftLayer_Account/validate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::validate + Validates SoftLayer account information. Will return an error if any field is not valid. diff --git a/content/reference/services/SoftLayer_Account/validateManualPaymentAmount.md b/content/reference/services/SoftLayer_Account/validateManualPaymentAmount.md index d3e9101eba..7a16643bdc 100644 --- a/content/reference/services/SoftLayer_Account/validateManualPaymentAmount.md +++ b/content/reference/services/SoftLayer_Account/validateManualPaymentAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account](/reference/services/SoftLayer_Account)::validateManualPaymentAmount + Ensure the amount requested for a manual payment is valid. diff --git a/content/reference/services/SoftLayer_Account_Address/_index.md b/content/reference/services/SoftLayer_Account_Address/_index.md index 8f41d53d85..b269cb1277 100644 --- a/content/reference/services/SoftLayer_Account_Address/_index.md +++ b/content/reference/services/SoftLayer_Account_Address/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + SoftLayer's address service allows you to access and manage addresses associated with your account. @@ -42,66 +44,77 @@ SoftLayer's address service allows you to access and manage addresses associated #### [createObject](/reference/services/SoftLayer_Account_Address/createObject) Create a new address record. +
              #### [editObject](/reference/services/SoftLayer_Account_Address/editObject) Edit an address record. +
              #### [getAccount](/reference/services/SoftLayer_Account_Address/getAccount) Retrieve the account to which this address belongs. +
              #### [getAllDataCenters](/reference/services/SoftLayer_Account_Address/getAllDataCenters) Retrieve a list of SoftLayer datacenter addresses. +
              #### [getCreateUser](/reference/services/SoftLayer_Account_Address/getCreateUser) Retrieve the customer user who created this address. +
              #### [getLocation](/reference/services/SoftLayer_Account_Address/getLocation) Retrieve the location of this address. +
              #### [getModifyEmployee](/reference/services/SoftLayer_Account_Address/getModifyEmployee) Retrieve the employee who last modified this address. +
              #### [getModifyUser](/reference/services/SoftLayer_Account_Address/getModifyUser) Retrieve the customer user who last modified this address. +
              #### [getNetworkAddress](/reference/services/SoftLayer_Account_Address/getNetworkAddress) Retrieve a list of SoftLayer datacenter addresses. +
              #### [getObject](/reference/services/SoftLayer_Account_Address/getObject) Retrieve a SoftLayer_Account_Address record. +
              #### [getType](/reference/services/SoftLayer_Account_Address/getType) Retrieve an account address' type. +
              diff --git a/content/reference/services/SoftLayer_Account_Address/createObject.md b/content/reference/services/SoftLayer_Account_Address/createObject.md index b198a919f5..5543ecbcf5 100644 --- a/content/reference/services/SoftLayer_Account_Address/createObject.md +++ b/content/reference/services/SoftLayer_Account_Address/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Address](/reference/services/SoftLayer_Account_Address)::createObject + Create a new address record. diff --git a/content/reference/services/SoftLayer_Account_Address/editObject.md b/content/reference/services/SoftLayer_Account_Address/editObject.md index 3f2d5666a9..0d43823981 100644 --- a/content/reference/services/SoftLayer_Account_Address/editObject.md +++ b/content/reference/services/SoftLayer_Account_Address/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Address](/reference/services/SoftLayer_Account_Address)::editObject + Edit an address record. diff --git a/content/reference/services/SoftLayer_Account_Address/getAccount.md b/content/reference/services/SoftLayer_Account_Address/getAccount.md index 56ffdfe591..40b70caeb3 100644 --- a/content/reference/services/SoftLayer_Account_Address/getAccount.md +++ b/content/reference/services/SoftLayer_Account_Address/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Address](/reference/services/SoftLayer_Account_Address)::getAccount + Retrieve the account to which this address belongs. diff --git a/content/reference/services/SoftLayer_Account_Address/getAllDataCenters.md b/content/reference/services/SoftLayer_Account_Address/getAllDataCenters.md index 2c1ca63f5f..0254dbd5c6 100644 --- a/content/reference/services/SoftLayer_Account_Address/getAllDataCenters.md +++ b/content/reference/services/SoftLayer_Account_Address/getAllDataCenters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Address](/reference/services/SoftLayer_Account_Address)::getAllDataCenters + Retrieve a list of SoftLayer datacenter addresses. diff --git a/content/reference/services/SoftLayer_Account_Address/getCreateUser.md b/content/reference/services/SoftLayer_Account_Address/getCreateUser.md index ff52c99b4a..7837d0a2c8 100644 --- a/content/reference/services/SoftLayer_Account_Address/getCreateUser.md +++ b/content/reference/services/SoftLayer_Account_Address/getCreateUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Address](/reference/services/SoftLayer_Account_Address)::getCreateUser + Retrieve the customer user who created this address. diff --git a/content/reference/services/SoftLayer_Account_Address/getLocation.md b/content/reference/services/SoftLayer_Account_Address/getLocation.md index 85dd095194..f9be240190 100644 --- a/content/reference/services/SoftLayer_Account_Address/getLocation.md +++ b/content/reference/services/SoftLayer_Account_Address/getLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Address](/reference/services/SoftLayer_Account_Address)::getLocation + Retrieve the location of this address. diff --git a/content/reference/services/SoftLayer_Account_Address/getModifyEmployee.md b/content/reference/services/SoftLayer_Account_Address/getModifyEmployee.md index d909fd9828..8c8e38a9b2 100644 --- a/content/reference/services/SoftLayer_Account_Address/getModifyEmployee.md +++ b/content/reference/services/SoftLayer_Account_Address/getModifyEmployee.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Address](/reference/services/SoftLayer_Account_Address)::getModifyEmployee + Retrieve the employee who last modified this address. diff --git a/content/reference/services/SoftLayer_Account_Address/getModifyUser.md b/content/reference/services/SoftLayer_Account_Address/getModifyUser.md index cb15dfd738..644839b51a 100644 --- a/content/reference/services/SoftLayer_Account_Address/getModifyUser.md +++ b/content/reference/services/SoftLayer_Account_Address/getModifyUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Address](/reference/services/SoftLayer_Account_Address)::getModifyUser + Retrieve the customer user who last modified this address. diff --git a/content/reference/services/SoftLayer_Account_Address/getNetworkAddress.md b/content/reference/services/SoftLayer_Account_Address/getNetworkAddress.md index 1decb3b49f..06bc2d2434 100644 --- a/content/reference/services/SoftLayer_Account_Address/getNetworkAddress.md +++ b/content/reference/services/SoftLayer_Account_Address/getNetworkAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Address](/reference/services/SoftLayer_Account_Address)::getNetworkAddress + Retrieve a list of SoftLayer datacenter addresses. diff --git a/content/reference/services/SoftLayer_Account_Address/getObject.md b/content/reference/services/SoftLayer_Account_Address/getObject.md index 599a50826a..8f5fcc0759 100644 --- a/content/reference/services/SoftLayer_Account_Address/getObject.md +++ b/content/reference/services/SoftLayer_Account_Address/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Address](/reference/services/SoftLayer_Account_Address)::getObject + Retrieve a SoftLayer_Account_Address record. diff --git a/content/reference/services/SoftLayer_Account_Address/getType.md b/content/reference/services/SoftLayer_Account_Address/getType.md index 08f1481e08..fa40fef902 100644 --- a/content/reference/services/SoftLayer_Account_Address/getType.md +++ b/content/reference/services/SoftLayer_Account_Address/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Address](/reference/services/SoftLayer_Account_Address)::getType + Retrieve an account address' type. diff --git a/content/reference/services/SoftLayer_Account_Address_Type/_index.md b/content/reference/services/SoftLayer_Account_Address_Type/_index.md index 1263c180fd..75099d1c9d 100644 --- a/content/reference/services/SoftLayer_Account_Address_Type/_index.md +++ b/content/reference/services/SoftLayer_Account_Address_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,6 +44,7 @@ classes: #### [getObject](/reference/services/SoftLayer_Account_Address_Type/getObject) Retrieve a SoftLayer_Account_Address_Type record. +
              diff --git a/content/reference/services/SoftLayer_Account_Address_Type/getObject.md b/content/reference/services/SoftLayer_Account_Address_Type/getObject.md index 4221e97795..3b03b6f5a7 100644 --- a/content/reference/services/SoftLayer_Account_Address_Type/getObject.md +++ b/content/reference/services/SoftLayer_Account_Address_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Address_Type](/reference/services/SoftLayer_Account_Address_Type)::getObject + Retrieve a SoftLayer_Account_Address_Type record. diff --git a/content/reference/services/SoftLayer_Account_Affiliation/_index.md b/content/reference/services/SoftLayer_Account_Affiliation/_index.md index e57c6352e0..e5bc2ff879 100644 --- a/content/reference/services/SoftLayer_Account_Affiliation/_index.md +++ b/content/reference/services/SoftLayer_Account_Affiliation/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,36 +44,42 @@ classes: #### [createObject](/reference/services/SoftLayer_Account_Affiliation/createObject) Create a new affiliation. +
              #### [deleteObject](/reference/services/SoftLayer_Account_Affiliation/deleteObject) Delete an account affiliation +
              #### [editObject](/reference/services/SoftLayer_Account_Affiliation/editObject) Update an account affiliation information. +
              #### [getAccount](/reference/services/SoftLayer_Account_Affiliation/getAccount) Retrieve the account that an affiliation belongs to. +
              #### [getAccountAffiliationsByAffiliateId](/reference/services/SoftLayer_Account_Affiliation/getAccountAffiliationsByAffiliateId) Get account affiliation information associated with affiliate id. +
              #### [getObject](/reference/services/SoftLayer_Account_Affiliation/getObject) Retrieve a SoftLayer_Account_Affiliation record. +
              diff --git a/content/reference/services/SoftLayer_Account_Affiliation/createObject.md b/content/reference/services/SoftLayer_Account_Affiliation/createObject.md index fb6b954cd2..89585901a4 100644 --- a/content/reference/services/SoftLayer_Account_Affiliation/createObject.md +++ b/content/reference/services/SoftLayer_Account_Affiliation/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Affiliation](/reference/services/SoftLayer_Account_Affiliation)::createObject + Create a new affiliation. diff --git a/content/reference/services/SoftLayer_Account_Affiliation/deleteObject.md b/content/reference/services/SoftLayer_Account_Affiliation/deleteObject.md index 4f876a8177..163babe54a 100644 --- a/content/reference/services/SoftLayer_Account_Affiliation/deleteObject.md +++ b/content/reference/services/SoftLayer_Account_Affiliation/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Affiliation](/reference/services/SoftLayer_Account_Affiliation)::deleteObject + Delete an account affiliation diff --git a/content/reference/services/SoftLayer_Account_Affiliation/editObject.md b/content/reference/services/SoftLayer_Account_Affiliation/editObject.md index d621474374..cd4d159ace 100644 --- a/content/reference/services/SoftLayer_Account_Affiliation/editObject.md +++ b/content/reference/services/SoftLayer_Account_Affiliation/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Affiliation](/reference/services/SoftLayer_Account_Affiliation)::editObject + Update an account affiliation information. diff --git a/content/reference/services/SoftLayer_Account_Affiliation/getAccount.md b/content/reference/services/SoftLayer_Account_Affiliation/getAccount.md index 944c3f916d..64ec84e68a 100644 --- a/content/reference/services/SoftLayer_Account_Affiliation/getAccount.md +++ b/content/reference/services/SoftLayer_Account_Affiliation/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Affiliation](/reference/services/SoftLayer_Account_Affiliation)::getAccount + Retrieve the account that an affiliation belongs to. diff --git a/content/reference/services/SoftLayer_Account_Affiliation/getAccountAffiliationsByAffiliateId.md b/content/reference/services/SoftLayer_Account_Affiliation/getAccountAffiliationsByAffiliateId.md index 4fcd931453..fd78343dc2 100644 --- a/content/reference/services/SoftLayer_Account_Affiliation/getAccountAffiliationsByAffiliateId.md +++ b/content/reference/services/SoftLayer_Account_Affiliation/getAccountAffiliationsByAffiliateId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Affiliation](/reference/services/SoftLayer_Account_Affiliation)::getAccountAffiliationsByAffiliateId + Get account affiliation information associated with affiliate id. diff --git a/content/reference/services/SoftLayer_Account_Affiliation/getObject.md b/content/reference/services/SoftLayer_Account_Affiliation/getObject.md index 1601d9ac5e..2ac528badd 100644 --- a/content/reference/services/SoftLayer_Account_Affiliation/getObject.md +++ b/content/reference/services/SoftLayer_Account_Affiliation/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Affiliation](/reference/services/SoftLayer_Account_Affiliation)::getObject + Retrieve a SoftLayer_Account_Affiliation record. diff --git a/content/reference/services/SoftLayer_Account_Agreement/_index.md b/content/reference/services/SoftLayer_Account_Agreement/_index.md index 246afa3a9c..5a5227410c 100644 --- a/content/reference/services/SoftLayer_Account_Agreement/_index.md +++ b/content/reference/services/SoftLayer_Account_Agreement/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,42 +44,49 @@ classes: #### [getAccount](/reference/services/SoftLayer_Account_Agreement/getAccount) +
              #### [getAgreementType](/reference/services/SoftLayer_Account_Agreement/getAgreementType) Retrieve the type of agreement. +
              #### [getAttachedBillingAgreementFiles](/reference/services/SoftLayer_Account_Agreement/getAttachedBillingAgreementFiles) Retrieve the files attached to an agreement. +
              #### [getBillingItems](/reference/services/SoftLayer_Account_Agreement/getBillingItems) Retrieve the billing items associated with an agreement. +
              #### [getObject](/reference/services/SoftLayer_Account_Agreement/getObject) Retrieve a SoftLayer_Account_Agreement record. +
              #### [getStatus](/reference/services/SoftLayer_Account_Agreement/getStatus) Retrieve the status of the agreement. +
              #### [getTopLevelBillingItems](/reference/services/SoftLayer_Account_Agreement/getTopLevelBillingItems) Retrieve the top level billing item associated with an agreement. +
              diff --git a/content/reference/services/SoftLayer_Account_Agreement/getAccount.md b/content/reference/services/SoftLayer_Account_Agreement/getAccount.md index bee401ea2d..275cc3d511 100644 --- a/content/reference/services/SoftLayer_Account_Agreement/getAccount.md +++ b/content/reference/services/SoftLayer_Account_Agreement/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Agreement/getAgreementType.md b/content/reference/services/SoftLayer_Account_Agreement/getAgreementType.md index d287df49cd..2531cf3153 100644 --- a/content/reference/services/SoftLayer_Account_Agreement/getAgreementType.md +++ b/content/reference/services/SoftLayer_Account_Agreement/getAgreementType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Agreement](/reference/services/SoftLayer_Account_Agreement)::getAgreementType + Retrieve the type of agreement. diff --git a/content/reference/services/SoftLayer_Account_Agreement/getAttachedBillingAgreementFiles.md b/content/reference/services/SoftLayer_Account_Agreement/getAttachedBillingAgreementFiles.md index 4933ccdc18..80633081f0 100644 --- a/content/reference/services/SoftLayer_Account_Agreement/getAttachedBillingAgreementFiles.md +++ b/content/reference/services/SoftLayer_Account_Agreement/getAttachedBillingAgreementFiles.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Agreement](/reference/services/SoftLayer_Account_Agreement)::getAttachedBillingAgreementFiles + Retrieve the files attached to an agreement. diff --git a/content/reference/services/SoftLayer_Account_Agreement/getBillingItems.md b/content/reference/services/SoftLayer_Account_Agreement/getBillingItems.md index 68b25a2288..0dc3630601 100644 --- a/content/reference/services/SoftLayer_Account_Agreement/getBillingItems.md +++ b/content/reference/services/SoftLayer_Account_Agreement/getBillingItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Agreement](/reference/services/SoftLayer_Account_Agreement)::getBillingItems + Retrieve the billing items associated with an agreement. diff --git a/content/reference/services/SoftLayer_Account_Agreement/getObject.md b/content/reference/services/SoftLayer_Account_Agreement/getObject.md index f51e7221bf..141ccabcc3 100644 --- a/content/reference/services/SoftLayer_Account_Agreement/getObject.md +++ b/content/reference/services/SoftLayer_Account_Agreement/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Agreement](/reference/services/SoftLayer_Account_Agreement)::getObject + Retrieve a SoftLayer_Account_Agreement record. diff --git a/content/reference/services/SoftLayer_Account_Agreement/getStatus.md b/content/reference/services/SoftLayer_Account_Agreement/getStatus.md index fdb2e90182..8b56f95585 100644 --- a/content/reference/services/SoftLayer_Account_Agreement/getStatus.md +++ b/content/reference/services/SoftLayer_Account_Agreement/getStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Agreement](/reference/services/SoftLayer_Account_Agreement)::getStatus + Retrieve the status of the agreement. diff --git a/content/reference/services/SoftLayer_Account_Agreement/getTopLevelBillingItems.md b/content/reference/services/SoftLayer_Account_Agreement/getTopLevelBillingItems.md index 20ff346ac5..b9106c1c1a 100644 --- a/content/reference/services/SoftLayer_Account_Agreement/getTopLevelBillingItems.md +++ b/content/reference/services/SoftLayer_Account_Agreement/getTopLevelBillingItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Agreement](/reference/services/SoftLayer_Account_Agreement)::getTopLevelBillingItems + Retrieve the top level billing item associated with an agreement. diff --git a/content/reference/services/SoftLayer_Account_Authentication_Attribute/_index.md b/content/reference/services/SoftLayer_Account_Authentication_Attribute/_index.md index 2bfc997945..08b0fa428b 100644 --- a/content/reference/services/SoftLayer_Account_Authentication_Attribute/_index.md +++ b/content/reference/services/SoftLayer_Account_Authentication_Attribute/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,24 +44,28 @@ classes: #### [getAccount](/reference/services/SoftLayer_Account_Authentication_Attribute/getAccount) Retrieve the SoftLayer customer account. +
              #### [getAuthenticationRecord](/reference/services/SoftLayer_Account_Authentication_Attribute/getAuthenticationRecord) Retrieve the SoftLayer account authentication that has an attribute. +
              #### [getObject](/reference/services/SoftLayer_Account_Authentication_Attribute/getObject) Retrieve a SoftLayer_Account_Authentication_Attribute record. +
              #### [getType](/reference/services/SoftLayer_Account_Authentication_Attribute/getType) Retrieve the type of attribute assigned to a SoftLayer account authentication. +
              diff --git a/content/reference/services/SoftLayer_Account_Authentication_Attribute/getAccount.md b/content/reference/services/SoftLayer_Account_Authentication_Attribute/getAccount.md index 6576aabd8f..46922307dd 100644 --- a/content/reference/services/SoftLayer_Account_Authentication_Attribute/getAccount.md +++ b/content/reference/services/SoftLayer_Account_Authentication_Attribute/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Authentication_Attribute](/reference/services/SoftLayer_Account_Authentication_Attribute)::getAccount + Retrieve the SoftLayer customer account. diff --git a/content/reference/services/SoftLayer_Account_Authentication_Attribute/getAuthenticationRecord.md b/content/reference/services/SoftLayer_Account_Authentication_Attribute/getAuthenticationRecord.md index f4112a49e9..33680fd04b 100644 --- a/content/reference/services/SoftLayer_Account_Authentication_Attribute/getAuthenticationRecord.md +++ b/content/reference/services/SoftLayer_Account_Authentication_Attribute/getAuthenticationRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Authentication_Attribute](/reference/services/SoftLayer_Account_Authentication_Attribute)::getAuthenticationRecord + Retrieve the SoftLayer account authentication that has an attribute. diff --git a/content/reference/services/SoftLayer_Account_Authentication_Attribute/getObject.md b/content/reference/services/SoftLayer_Account_Authentication_Attribute/getObject.md index 81fb8f3b56..ca59d25c68 100644 --- a/content/reference/services/SoftLayer_Account_Authentication_Attribute/getObject.md +++ b/content/reference/services/SoftLayer_Account_Authentication_Attribute/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Authentication_Attribute](/reference/services/SoftLayer_Account_Authentication_Attribute)::getObject + Retrieve a SoftLayer_Account_Authentication_Attribute record. diff --git a/content/reference/services/SoftLayer_Account_Authentication_Attribute/getType.md b/content/reference/services/SoftLayer_Account_Authentication_Attribute/getType.md index c8e4c7cfe8..e7197ef163 100644 --- a/content/reference/services/SoftLayer_Account_Authentication_Attribute/getType.md +++ b/content/reference/services/SoftLayer_Account_Authentication_Attribute/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Authentication_Attribute](/reference/services/SoftLayer_Account_Authentication_Attribute)::getType + Retrieve the type of attribute assigned to a SoftLayer account authentication. diff --git a/content/reference/services/SoftLayer_Account_Authentication_Attribute_Type/_index.md b/content/reference/services/SoftLayer_Account_Authentication_Attribute_Type/_index.md index b19247fa5a..47011ff7c3 100644 --- a/content/reference/services/SoftLayer_Account_Authentication_Attribute_Type/_index.md +++ b/content/reference/services/SoftLayer_Account_Authentication_Attribute_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Account_Authentication_Attribute_Type/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_Account_Authentication_Attribute_Type/getObject) Retrieve a SoftLayer_Account_Authentication_Attribute_Type record. +
              diff --git a/content/reference/services/SoftLayer_Account_Authentication_Attribute_Type/getAllObjects.md b/content/reference/services/SoftLayer_Account_Authentication_Attribute_Type/getAllObjects.md index 85f8e7c071..182f53bfef 100644 --- a/content/reference/services/SoftLayer_Account_Authentication_Attribute_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_Account_Authentication_Attribute_Type/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Authentication_Attribute_Type/getObject.md b/content/reference/services/SoftLayer_Account_Authentication_Attribute_Type/getObject.md index 543163e4aa..c96ae12e37 100644 --- a/content/reference/services/SoftLayer_Account_Authentication_Attribute_Type/getObject.md +++ b/content/reference/services/SoftLayer_Account_Authentication_Attribute_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Authentication_Attribute_Type](/reference/services/SoftLayer_Account_Authentication_Attribute_Type)::getObject + Retrieve a SoftLayer_Account_Authentication_Attribute_Type record. diff --git a/content/reference/services/SoftLayer_Account_Authentication_Saml/_index.md b/content/reference/services/SoftLayer_Account_Authentication_Saml/_index.md index 884c108f57..1556e2d2d6 100644 --- a/content/reference/services/SoftLayer_Account_Authentication_Saml/_index.md +++ b/content/reference/services/SoftLayer_Account_Authentication_Saml/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,42 +44,49 @@ classes: #### [createObject](/reference/services/SoftLayer_Account_Authentication_Saml/createObject) +
              #### [deleteObject](/reference/services/SoftLayer_Account_Authentication_Saml/deleteObject) +
              #### [editObject](/reference/services/SoftLayer_Account_Authentication_Saml/editObject) Edit the object by passing in a modified instance of the object. +
              #### [getAccount](/reference/services/SoftLayer_Account_Authentication_Saml/getAccount) Retrieve the account associated with this saml configuration. +
              #### [getAttributes](/reference/services/SoftLayer_Account_Authentication_Saml/getAttributes) Retrieve the saml attribute values for a SoftLayer customer account. +
              #### [getMetadata](/reference/services/SoftLayer_Account_Authentication_Saml/getMetadata) Get the service provider meta data. +
              #### [getObject](/reference/services/SoftLayer_Account_Authentication_Saml/getObject) Retrieve a SoftLayer_Account_Authentication_Saml record. +
              diff --git a/content/reference/services/SoftLayer_Account_Authentication_Saml/createObject.md b/content/reference/services/SoftLayer_Account_Authentication_Saml/createObject.md index 550e62b982..d64d521568 100644 --- a/content/reference/services/SoftLayer_Account_Authentication_Saml/createObject.md +++ b/content/reference/services/SoftLayer_Account_Authentication_Saml/createObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Authentication_Saml/deleteObject.md b/content/reference/services/SoftLayer_Account_Authentication_Saml/deleteObject.md index 63383521c8..d24c878dca 100644 --- a/content/reference/services/SoftLayer_Account_Authentication_Saml/deleteObject.md +++ b/content/reference/services/SoftLayer_Account_Authentication_Saml/deleteObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Authentication_Saml/editObject.md b/content/reference/services/SoftLayer_Account_Authentication_Saml/editObject.md index aaaffa80dd..d43527c78a 100644 --- a/content/reference/services/SoftLayer_Account_Authentication_Saml/editObject.md +++ b/content/reference/services/SoftLayer_Account_Authentication_Saml/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Authentication_Saml](/reference/services/SoftLayer_Account_Authentication_Saml)::editObject + Edit the object by passing in a modified instance of the object. diff --git a/content/reference/services/SoftLayer_Account_Authentication_Saml/getAccount.md b/content/reference/services/SoftLayer_Account_Authentication_Saml/getAccount.md index 9c2214c55f..6da6a700a8 100644 --- a/content/reference/services/SoftLayer_Account_Authentication_Saml/getAccount.md +++ b/content/reference/services/SoftLayer_Account_Authentication_Saml/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Authentication_Saml](/reference/services/SoftLayer_Account_Authentication_Saml)::getAccount + Retrieve the account associated with this saml configuration. diff --git a/content/reference/services/SoftLayer_Account_Authentication_Saml/getAttributes.md b/content/reference/services/SoftLayer_Account_Authentication_Saml/getAttributes.md index e4d2f568f3..1ebf503df9 100644 --- a/content/reference/services/SoftLayer_Account_Authentication_Saml/getAttributes.md +++ b/content/reference/services/SoftLayer_Account_Authentication_Saml/getAttributes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Authentication_Saml](/reference/services/SoftLayer_Account_Authentication_Saml)::getAttributes + Retrieve the saml attribute values for a SoftLayer customer account. diff --git a/content/reference/services/SoftLayer_Account_Authentication_Saml/getMetadata.md b/content/reference/services/SoftLayer_Account_Authentication_Saml/getMetadata.md index f3cb08766d..14eb949415 100644 --- a/content/reference/services/SoftLayer_Account_Authentication_Saml/getMetadata.md +++ b/content/reference/services/SoftLayer_Account_Authentication_Saml/getMetadata.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Authentication_Saml](/reference/services/SoftLayer_Account_Authentication_Saml)::getMetadata + Get the service provider meta data. diff --git a/content/reference/services/SoftLayer_Account_Authentication_Saml/getObject.md b/content/reference/services/SoftLayer_Account_Authentication_Saml/getObject.md index 7b0f9e823e..733d749682 100644 --- a/content/reference/services/SoftLayer_Account_Authentication_Saml/getObject.md +++ b/content/reference/services/SoftLayer_Account_Authentication_Saml/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Authentication_Saml](/reference/services/SoftLayer_Account_Authentication_Saml)::getObject + Retrieve a SoftLayer_Account_Authentication_Saml record. diff --git a/content/reference/services/SoftLayer_Account_Business_Partner/_index.md b/content/reference/services/SoftLayer_Account_Business_Partner/_index.md index 4589b7a4f3..b789e8a688 100644 --- a/content/reference/services/SoftLayer_Account_Business_Partner/_index.md +++ b/content/reference/services/SoftLayer_Account_Business_Partner/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,24 +44,28 @@ classes: #### [getAccount](/reference/services/SoftLayer_Account_Business_Partner/getAccount) Retrieve account associated with the business partner data +
              #### [getChannel](/reference/services/SoftLayer_Account_Business_Partner/getChannel) Retrieve channel indicator used to categorize business partner revenue. +
              #### [getObject](/reference/services/SoftLayer_Account_Business_Partner/getObject) Retrieve a SoftLayer_Account_Business_Partner record. +
              #### [getSegment](/reference/services/SoftLayer_Account_Business_Partner/getSegment) Retrieve segment indicator used to categorize business partner revenue. +
              diff --git a/content/reference/services/SoftLayer_Account_Business_Partner/getAccount.md b/content/reference/services/SoftLayer_Account_Business_Partner/getAccount.md index b1ece0a91a..ada5de95e2 100644 --- a/content/reference/services/SoftLayer_Account_Business_Partner/getAccount.md +++ b/content/reference/services/SoftLayer_Account_Business_Partner/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Business_Partner](/reference/services/SoftLayer_Account_Business_Partner)::getAccount + Retrieve account associated with the business partner data diff --git a/content/reference/services/SoftLayer_Account_Business_Partner/getChannel.md b/content/reference/services/SoftLayer_Account_Business_Partner/getChannel.md index f130256f94..8d02882aa2 100644 --- a/content/reference/services/SoftLayer_Account_Business_Partner/getChannel.md +++ b/content/reference/services/SoftLayer_Account_Business_Partner/getChannel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Business_Partner](/reference/services/SoftLayer_Account_Business_Partner)::getChannel + Retrieve channel indicator used to categorize business partner revenue. diff --git a/content/reference/services/SoftLayer_Account_Business_Partner/getObject.md b/content/reference/services/SoftLayer_Account_Business_Partner/getObject.md index 4e011f09d0..1843d6baf1 100644 --- a/content/reference/services/SoftLayer_Account_Business_Partner/getObject.md +++ b/content/reference/services/SoftLayer_Account_Business_Partner/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Business_Partner](/reference/services/SoftLayer_Account_Business_Partner)::getObject + Retrieve a SoftLayer_Account_Business_Partner record. diff --git a/content/reference/services/SoftLayer_Account_Business_Partner/getSegment.md b/content/reference/services/SoftLayer_Account_Business_Partner/getSegment.md index 56405038ab..93715cd60e 100644 --- a/content/reference/services/SoftLayer_Account_Business_Partner/getSegment.md +++ b/content/reference/services/SoftLayer_Account_Business_Partner/getSegment.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Business_Partner](/reference/services/SoftLayer_Account_Business_Partner)::getSegment + Retrieve segment indicator used to categorize business partner revenue. diff --git a/content/reference/services/SoftLayer_Account_Contact/_index.md b/content/reference/services/SoftLayer_Account_Contact/_index.md index c5a9c8e8dc..9175410c07 100644 --- a/content/reference/services/SoftLayer_Account_Contact/_index.md +++ b/content/reference/services/SoftLayer_Account_Contact/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,48 +44,56 @@ classes: #### [createComplianceReportRequestorContact](/reference/services/SoftLayer_Account_Contact/createComplianceReportRequestorContact) +
              #### [createObject](/reference/services/SoftLayer_Account_Contact/createObject) This method creates an account contact. +
              #### [deleteObject](/reference/services/SoftLayer_Account_Contact/deleteObject) Delete an account contact +
              #### [editObject](/reference/services/SoftLayer_Account_Contact/editObject) Edit an existing account contact. +
              #### [getAccount](/reference/services/SoftLayer_Account_Contact/getAccount) +
              #### [getAllContactTypes](/reference/services/SoftLayer_Account_Contact/getAllContactTypes) This method retrieves available contact types. +
              #### [getObject](/reference/services/SoftLayer_Account_Contact/getObject) Retrieve a SoftLayer_Account_Contact record. +
              #### [getType](/reference/services/SoftLayer_Account_Contact/getType) +
              diff --git a/content/reference/services/SoftLayer_Account_Contact/createComplianceReportRequestorContact.md b/content/reference/services/SoftLayer_Account_Contact/createComplianceReportRequestorContact.md index 30df29b791..e9ab742ea4 100644 --- a/content/reference/services/SoftLayer_Account_Contact/createComplianceReportRequestorContact.md +++ b/content/reference/services/SoftLayer_Account_Contact/createComplianceReportRequestorContact.md @@ -16,6 +16,7 @@ aliases: + ## Overview < ## Description + + This service class allows the user to set up an account to be billed by an external billing system. @@ -42,18 +44,21 @@ This service class allows the user to set up an account to be billed by an exter #### [finalizeExternalBillingForAccount](/reference/services/SoftLayer_Account_External_Setup/finalizeExternalBillingForAccount) +
              #### [getObject](/reference/services/SoftLayer_Account_External_Setup/getObject) Retrieve a SoftLayer_Account_External_Setup record. +
              #### [getVerifyCardTransaction](/reference/services/SoftLayer_Account_External_Setup/getVerifyCardTransaction) Retrieve the transaction information related to verifying the customer credit card. +
              diff --git a/content/reference/services/SoftLayer_Account_External_Setup/finalizeExternalBillingForAccount.md b/content/reference/services/SoftLayer_Account_External_Setup/finalizeExternalBillingForAccount.md index 5544da53b3..6f4110f4c0 100644 --- a/content/reference/services/SoftLayer_Account_External_Setup/finalizeExternalBillingForAccount.md +++ b/content/reference/services/SoftLayer_Account_External_Setup/finalizeExternalBillingForAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview Calling this method signals that the account with the provided account id is ready to be billed by the external billing system. diff --git a/content/reference/services/SoftLayer_Account_External_Setup/getObject.md b/content/reference/services/SoftLayer_Account_External_Setup/getObject.md index b8fc746310..db59565f31 100644 --- a/content/reference/services/SoftLayer_Account_External_Setup/getObject.md +++ b/content/reference/services/SoftLayer_Account_External_Setup/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_External_Setup](/reference/services/SoftLayer_Account_External_Setup)::getObject + Retrieve a SoftLayer_Account_External_Setup record. diff --git a/content/reference/services/SoftLayer_Account_External_Setup/getVerifyCardTransaction.md b/content/reference/services/SoftLayer_Account_External_Setup/getVerifyCardTransaction.md index 9bb85a6e0b..34475c29e7 100644 --- a/content/reference/services/SoftLayer_Account_External_Setup/getVerifyCardTransaction.md +++ b/content/reference/services/SoftLayer_Account_External_Setup/getVerifyCardTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_External_Setup](/reference/services/SoftLayer_Account_External_Setup)::getVerifyCardTransaction + Retrieve the transaction information related to verifying the customer credit card. diff --git a/content/reference/services/SoftLayer_Account_Historical_Report/_index.md b/content/reference/services/SoftLayer_Account_Historical_Report/_index.md index d0d8365331..5feb43ed1c 100644 --- a/content/reference/services/SoftLayer_Account_Historical_Report/_index.md +++ b/content/reference/services/SoftLayer_Account_Historical_Report/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -42,48 +44,68 @@ SoftLayer's account historical report service allows users to access a broad ove #### [getAccountHostUptimeGraphData](/reference/services/SoftLayer_Account_Historical_Report/getAccountHostUptimeGraphData) + -
              +
              #### [getAccountHostUptimeSummary](/reference/services/SoftLayer_Account_Historical_Report/getAccountHostUptimeSummary) + +Deprecated + +
              #### [getAccountUrlUptimeGraphData](/reference/services/SoftLayer_Account_Historical_Report/getAccountUrlUptimeGraphData) +
              -
              +
              #### [getAccountUrlUptimeSummary](/reference/services/SoftLayer_Account_Historical_Report/getAccountUrlUptimeSummary) + +Deprecated + +
              -
              +
              #### [getHostUptimeDetail](/reference/services/SoftLayer_Account_Historical_Report/getHostUptimeDetail) + +Deprecated + +
              #### [getHostUptimeGraphData](/reference/services/SoftLayer_Account_Historical_Report/getHostUptimeGraphData) +
              -
              +
              #### [getUrlUptimeDetail](/reference/services/SoftLayer_Account_Historical_Report/getUrlUptimeDetail) + +Deprecated + +
              #### [getUrlUptimeGraphData](/reference/services/SoftLayer_Account_Historical_Report/getUrlUptimeGraphData) +
              diff --git a/content/reference/services/SoftLayer_Account_Historical_Report/getAccountHostUptimeGraphData.md b/content/reference/services/SoftLayer_Account_Historical_Report/getAccountHostUptimeGraphData.md index 6c3d18de62..f2996609a8 100644 --- a/content/reference/services/SoftLayer_Account_Historical_Report/getAccountHostUptimeGraphData.md +++ b/content/reference/services/SoftLayer_Account_Historical_Report/getAccountHostUptimeGraphData.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Historical_Report/getAccountHostUptimeSummary.md b/content/reference/services/SoftLayer_Account_Historical_Report/getAccountHostUptimeSummary.md index 5ecaf3cd1f..6757d516e6 100644 --- a/content/reference/services/SoftLayer_Account_Historical_Report/getAccountHostUptimeSummary.md +++ b/content/reference/services/SoftLayer_Account_Historical_Report/getAccountHostUptimeSummary.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Account_Historical_Report](/reference/services/SoftLayer_Account_Historical_Report)::getAccountHostUptimeSummary +
              Deprecated
              + diff --git a/content/reference/services/SoftLayer_Account_Historical_Report/getAccountUrlUptimeGraphData.md b/content/reference/services/SoftLayer_Account_Historical_Report/getAccountUrlUptimeGraphData.md index 43a1c826b9..b4bd45d6a2 100644 --- a/content/reference/services/SoftLayer_Account_Historical_Report/getAccountUrlUptimeGraphData.md +++ b/content/reference/services/SoftLayer_Account_Historical_Report/getAccountUrlUptimeGraphData.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Historical_Report/getAccountUrlUptimeSummary.md b/content/reference/services/SoftLayer_Account_Historical_Report/getAccountUrlUptimeSummary.md index 527d3d2525..a10ef23155 100644 --- a/content/reference/services/SoftLayer_Account_Historical_Report/getAccountUrlUptimeSummary.md +++ b/content/reference/services/SoftLayer_Account_Historical_Report/getAccountUrlUptimeSummary.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Account_Historical_Report](/reference/services/SoftLayer_Account_Historical_Report)::getAccountUrlUptimeSummary +
              Deprecated
              + diff --git a/content/reference/services/SoftLayer_Account_Historical_Report/getHostUptimeDetail.md b/content/reference/services/SoftLayer_Account_Historical_Report/getHostUptimeDetail.md index f5eb2092d1..c2d1020bc8 100644 --- a/content/reference/services/SoftLayer_Account_Historical_Report/getHostUptimeDetail.md +++ b/content/reference/services/SoftLayer_Account_Historical_Report/getHostUptimeDetail.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Account_Historical_Report](/reference/services/SoftLayer_Account_Historical_Report)::getHostUptimeDetail +
              Deprecated
              + diff --git a/content/reference/services/SoftLayer_Account_Historical_Report/getHostUptimeGraphData.md b/content/reference/services/SoftLayer_Account_Historical_Report/getHostUptimeGraphData.md index 52bbafeb29..bdd1abcf5f 100644 --- a/content/reference/services/SoftLayer_Account_Historical_Report/getHostUptimeGraphData.md +++ b/content/reference/services/SoftLayer_Account_Historical_Report/getHostUptimeGraphData.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Historical_Report/getUrlUptimeDetail.md b/content/reference/services/SoftLayer_Account_Historical_Report/getUrlUptimeDetail.md index e160046f7f..3f0a406505 100644 --- a/content/reference/services/SoftLayer_Account_Historical_Report/getUrlUptimeDetail.md +++ b/content/reference/services/SoftLayer_Account_Historical_Report/getUrlUptimeDetail.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Account_Historical_Report](/reference/services/SoftLayer_Account_Historical_Report)::getUrlUptimeDetail +
              Deprecated
              + diff --git a/content/reference/services/SoftLayer_Account_Historical_Report/getUrlUptimeGraphData.md b/content/reference/services/SoftLayer_Account_Historical_Report/getUrlUptimeGraphData.md index d48790de56..b0af3d0d81 100644 --- a/content/reference/services/SoftLayer_Account_Historical_Report/getUrlUptimeGraphData.md +++ b/content/reference/services/SoftLayer_Account_Historical_Report/getUrlUptimeGraphData.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Internal_Ibm/_index.md b/content/reference/services/SoftLayer_Account_Internal_Ibm/_index.md index 7a0b34cae6..262a34d92f 100644 --- a/content/reference/services/SoftLayer_Account_Internal_Ibm/_index.md +++ b/content/reference/services/SoftLayer_Account_Internal_Ibm/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + 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. @@ -42,54 +44,63 @@ Processes requests by IBM employees to create an IaaS account tied to their emai #### [getAccountTypes](/reference/services/SoftLayer_Account_Internal_Ibm/getAccountTypes) Retrieves allowed internal IBM account categories +
              #### [getAuthorizationUrl](/reference/services/SoftLayer_Account_Internal_Ibm/getAuthorizationUrl) Gets the redirect URL for manager validation +
              #### [getBmsCountryList](/reference/services/SoftLayer_Account_Internal_Ibm/getBmsCountryList) +
              #### [getEmployeeAccessToken](/reference/services/SoftLayer_Account_Internal_Ibm/getEmployeeAccessToken) Exchanges a token +
              #### [getManagerPreview](/reference/services/SoftLayer_Account_Internal_Ibm/getManagerPreview) Gets a container representing the pending request +
              #### [hasExistingRequest](/reference/services/SoftLayer_Account_Internal_Ibm/hasExistingRequest) Checks for an existing request which would block an IBMer application +
              #### [managerApprove](/reference/services/SoftLayer_Account_Internal_Ibm/managerApprove) Applies manager approval to a pending internal IBM account request +
              #### [managerDeny](/reference/services/SoftLayer_Account_Internal_Ibm/managerDeny) Applies manager denial to a pending request +
              #### [requestAccount](/reference/services/SoftLayer_Account_Internal_Ibm/requestAccount) Processes IBMer requests for new IaaS/PaaS accounts +
              diff --git a/content/reference/services/SoftLayer_Account_Internal_Ibm/getAccountTypes.md b/content/reference/services/SoftLayer_Account_Internal_Ibm/getAccountTypes.md index cd14fadd1c..5385cc99b0 100644 --- a/content/reference/services/SoftLayer_Account_Internal_Ibm/getAccountTypes.md +++ b/content/reference/services/SoftLayer_Account_Internal_Ibm/getAccountTypes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Internal_Ibm](/reference/services/SoftLayer_Account_Internal_Ibm)::getAccountTypes + Retrieves allowed internal IBM account categories diff --git a/content/reference/services/SoftLayer_Account_Internal_Ibm/getAuthorizationUrl.md b/content/reference/services/SoftLayer_Account_Internal_Ibm/getAuthorizationUrl.md index 0b9918b000..f3d623f71b 100644 --- a/content/reference/services/SoftLayer_Account_Internal_Ibm/getAuthorizationUrl.md +++ b/content/reference/services/SoftLayer_Account_Internal_Ibm/getAuthorizationUrl.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Internal_Ibm](/reference/services/SoftLayer_Account_Internal_Ibm)::getAuthorizationUrl + Gets the redirect URL for manager validation diff --git a/content/reference/services/SoftLayer_Account_Internal_Ibm/getBmsCountryList.md b/content/reference/services/SoftLayer_Account_Internal_Ibm/getBmsCountryList.md index 7ed54ad7c9..90dace4216 100644 --- a/content/reference/services/SoftLayer_Account_Internal_Ibm/getBmsCountryList.md +++ b/content/reference/services/SoftLayer_Account_Internal_Ibm/getBmsCountryList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Internal_Ibm/getEmployeeAccessToken.md b/content/reference/services/SoftLayer_Account_Internal_Ibm/getEmployeeAccessToken.md index c5866a326c..60194edab9 100644 --- a/content/reference/services/SoftLayer_Account_Internal_Ibm/getEmployeeAccessToken.md +++ b/content/reference/services/SoftLayer_Account_Internal_Ibm/getEmployeeAccessToken.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Internal_Ibm](/reference/services/SoftLayer_Account_Internal_Ibm)::getEmployeeAccessToken + Exchanges a token diff --git a/content/reference/services/SoftLayer_Account_Internal_Ibm/getManagerPreview.md b/content/reference/services/SoftLayer_Account_Internal_Ibm/getManagerPreview.md index a3e430f399..ef0822b5de 100644 --- a/content/reference/services/SoftLayer_Account_Internal_Ibm/getManagerPreview.md +++ b/content/reference/services/SoftLayer_Account_Internal_Ibm/getManagerPreview.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Internal_Ibm](/reference/services/SoftLayer_Account_Internal_Ibm)::getManagerPreview + Gets a container representing the pending request diff --git a/content/reference/services/SoftLayer_Account_Internal_Ibm/hasExistingRequest.md b/content/reference/services/SoftLayer_Account_Internal_Ibm/hasExistingRequest.md index bbae58b94e..9a714147b4 100644 --- a/content/reference/services/SoftLayer_Account_Internal_Ibm/hasExistingRequest.md +++ b/content/reference/services/SoftLayer_Account_Internal_Ibm/hasExistingRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Internal_Ibm](/reference/services/SoftLayer_Account_Internal_Ibm)::hasExistingRequest + Checks for an existing request which would block an IBMer application diff --git a/content/reference/services/SoftLayer_Account_Internal_Ibm/managerApprove.md b/content/reference/services/SoftLayer_Account_Internal_Ibm/managerApprove.md index 1777a0705d..2173fb4cb6 100644 --- a/content/reference/services/SoftLayer_Account_Internal_Ibm/managerApprove.md +++ b/content/reference/services/SoftLayer_Account_Internal_Ibm/managerApprove.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Internal_Ibm](/reference/services/SoftLayer_Account_Internal_Ibm)::managerApprove + Applies manager approval to a pending internal IBM account request diff --git a/content/reference/services/SoftLayer_Account_Internal_Ibm/managerDeny.md b/content/reference/services/SoftLayer_Account_Internal_Ibm/managerDeny.md index 995c9388ed..71263fbc11 100644 --- a/content/reference/services/SoftLayer_Account_Internal_Ibm/managerDeny.md +++ b/content/reference/services/SoftLayer_Account_Internal_Ibm/managerDeny.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Internal_Ibm](/reference/services/SoftLayer_Account_Internal_Ibm)::managerDeny + Applies manager denial to a pending request diff --git a/content/reference/services/SoftLayer_Account_Internal_Ibm/requestAccount.md b/content/reference/services/SoftLayer_Account_Internal_Ibm/requestAccount.md index c306b7fb2d..5eab8ccc70 100644 --- a/content/reference/services/SoftLayer_Account_Internal_Ibm/requestAccount.md +++ b/content/reference/services/SoftLayer_Account_Internal_Ibm/requestAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Internal_Ibm](/reference/services/SoftLayer_Account_Internal_Ibm)::requestAccount + Processes IBMer requests for new IaaS/PaaS accounts diff --git a/content/reference/services/SoftLayer_Account_Link_Bluemix/_index.md b/content/reference/services/SoftLayer_Account_Link_Bluemix/_index.md index c463cc75a3..370d3c978d 100644 --- a/content/reference/services/SoftLayer_Account_Link_Bluemix/_index.md +++ b/content/reference/services/SoftLayer_Account_Link_Bluemix/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,24 +44,28 @@ classes: #### [getAccount](/reference/services/SoftLayer_Account_Link_Bluemix/getAccount) +
              #### [getObject](/reference/services/SoftLayer_Account_Link_Bluemix/getObject) Retrieve a SoftLayer_Account_Link_Bluemix record. +
              #### [getServiceProvider](/reference/services/SoftLayer_Account_Link_Bluemix/getServiceProvider) +
              #### [getSupportTierType](/reference/services/SoftLayer_Account_Link_Bluemix/getSupportTierType) +
              diff --git a/content/reference/services/SoftLayer_Account_Link_Bluemix/getAccount.md b/content/reference/services/SoftLayer_Account_Link_Bluemix/getAccount.md index 66653d5453..e5d9871a80 100644 --- a/content/reference/services/SoftLayer_Account_Link_Bluemix/getAccount.md +++ b/content/reference/services/SoftLayer_Account_Link_Bluemix/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Link_Bluemix/getObject.md b/content/reference/services/SoftLayer_Account_Link_Bluemix/getObject.md index ac6358de47..cd0d8033c0 100644 --- a/content/reference/services/SoftLayer_Account_Link_Bluemix/getObject.md +++ b/content/reference/services/SoftLayer_Account_Link_Bluemix/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Link_Bluemix](/reference/services/SoftLayer_Account_Link_Bluemix)::getObject + Retrieve a SoftLayer_Account_Link_Bluemix record. diff --git a/content/reference/services/SoftLayer_Account_Link_Bluemix/getServiceProvider.md b/content/reference/services/SoftLayer_Account_Link_Bluemix/getServiceProvider.md index c542feee32..3902f314ce 100644 --- a/content/reference/services/SoftLayer_Account_Link_Bluemix/getServiceProvider.md +++ b/content/reference/services/SoftLayer_Account_Link_Bluemix/getServiceProvider.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Link_Bluemix/getSupportTierType.md b/content/reference/services/SoftLayer_Account_Link_Bluemix/getSupportTierType.md index 9e0c77fc02..354855996a 100644 --- a/content/reference/services/SoftLayer_Account_Link_Bluemix/getSupportTierType.md +++ b/content/reference/services/SoftLayer_Account_Link_Bluemix/getSupportTierType.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Link_OpenStack/_index.md b/content/reference/services/SoftLayer_Account_Link_OpenStack/_index.md index 13fbbf8b19..1902806d14 100644 --- a/content/reference/services/SoftLayer_Account_Link_OpenStack/_index.md +++ b/content/reference/services/SoftLayer_Account_Link_OpenStack/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Service for linking account to OpenStack project @@ -42,60 +44,70 @@ Service for linking account to OpenStack project #### [createOSDomain](/reference/services/SoftLayer_Account_Link_OpenStack/createOSDomain) +
              #### [createOSProject](/reference/services/SoftLayer_Account_Link_OpenStack/createOSProject) +
              #### [deleteOSDomain](/reference/services/SoftLayer_Account_Link_OpenStack/deleteOSDomain) +
              #### [deleteOSProject](/reference/services/SoftLayer_Account_Link_OpenStack/deleteOSProject) +
              #### [deleteObject](/reference/services/SoftLayer_Account_Link_OpenStack/deleteObject) Remove an account link. +
              #### [getAccount](/reference/services/SoftLayer_Account_Link_OpenStack/getAccount) +
              #### [getOSProject](/reference/services/SoftLayer_Account_Link_OpenStack/getOSProject) +
              #### [getObject](/reference/services/SoftLayer_Account_Link_OpenStack/getObject) Retrieve a SoftLayer_Account_Link_OpenStack record. +
              #### [getServiceProvider](/reference/services/SoftLayer_Account_Link_OpenStack/getServiceProvider) +
              #### [listOSProjects](/reference/services/SoftLayer_Account_Link_OpenStack/listOSProjects) +
              diff --git a/content/reference/services/SoftLayer_Account_Link_OpenStack/createOSDomain.md b/content/reference/services/SoftLayer_Account_Link_OpenStack/createOSDomain.md index 0106edab83..45ba51af80 100644 --- a/content/reference/services/SoftLayer_Account_Link_OpenStack/createOSDomain.md +++ b/content/reference/services/SoftLayer_Account_Link_OpenStack/createOSDomain.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Link_OpenStack/createOSProject.md b/content/reference/services/SoftLayer_Account_Link_OpenStack/createOSProject.md index 295fc22d46..fe38e17e22 100644 --- a/content/reference/services/SoftLayer_Account_Link_OpenStack/createOSProject.md +++ b/content/reference/services/SoftLayer_Account_Link_OpenStack/createOSProject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Link_OpenStack/deleteOSDomain.md b/content/reference/services/SoftLayer_Account_Link_OpenStack/deleteOSDomain.md index 7ce38ae447..a5995befc6 100644 --- a/content/reference/services/SoftLayer_Account_Link_OpenStack/deleteOSDomain.md +++ b/content/reference/services/SoftLayer_Account_Link_OpenStack/deleteOSDomain.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Link_OpenStack/deleteOSProject.md b/content/reference/services/SoftLayer_Account_Link_OpenStack/deleteOSProject.md index bdf52c96d1..a9ce94ba98 100644 --- a/content/reference/services/SoftLayer_Account_Link_OpenStack/deleteOSProject.md +++ b/content/reference/services/SoftLayer_Account_Link_OpenStack/deleteOSProject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Link_OpenStack/deleteObject.md b/content/reference/services/SoftLayer_Account_Link_OpenStack/deleteObject.md index 760ca37873..948c63c4c0 100644 --- a/content/reference/services/SoftLayer_Account_Link_OpenStack/deleteObject.md +++ b/content/reference/services/SoftLayer_Account_Link_OpenStack/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Link_OpenStack](/reference/services/SoftLayer_Account_Link_OpenStack)::deleteObject + Remove an account link. diff --git a/content/reference/services/SoftLayer_Account_Link_OpenStack/getAccount.md b/content/reference/services/SoftLayer_Account_Link_OpenStack/getAccount.md index ec716e4d54..88d239f04e 100644 --- a/content/reference/services/SoftLayer_Account_Link_OpenStack/getAccount.md +++ b/content/reference/services/SoftLayer_Account_Link_OpenStack/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Link_OpenStack/getOSProject.md b/content/reference/services/SoftLayer_Account_Link_OpenStack/getOSProject.md index 6afed7e747..1c12b7066e 100644 --- a/content/reference/services/SoftLayer_Account_Link_OpenStack/getOSProject.md +++ b/content/reference/services/SoftLayer_Account_Link_OpenStack/getOSProject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Link_OpenStack/getObject.md b/content/reference/services/SoftLayer_Account_Link_OpenStack/getObject.md index c95cf86df2..0dd63b91f4 100644 --- a/content/reference/services/SoftLayer_Account_Link_OpenStack/getObject.md +++ b/content/reference/services/SoftLayer_Account_Link_OpenStack/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Link_OpenStack](/reference/services/SoftLayer_Account_Link_OpenStack)::getObject + Retrieve a SoftLayer_Account_Link_OpenStack record. diff --git a/content/reference/services/SoftLayer_Account_Link_OpenStack/getServiceProvider.md b/content/reference/services/SoftLayer_Account_Link_OpenStack/getServiceProvider.md index 70a65d64c4..4d6b3d461f 100644 --- a/content/reference/services/SoftLayer_Account_Link_OpenStack/getServiceProvider.md +++ b/content/reference/services/SoftLayer_Account_Link_OpenStack/getServiceProvider.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Link_OpenStack/listOSProjects.md b/content/reference/services/SoftLayer_Account_Link_OpenStack/listOSProjects.md index c703cfa65b..f172f04ddc 100644 --- a/content/reference/services/SoftLayer_Account_Link_OpenStack/listOSProjects.md +++ b/content/reference/services/SoftLayer_Account_Link_OpenStack/listOSProjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Lockdown_Request/_index.md b/content/reference/services/SoftLayer_Account_Lockdown_Request/_index.md index 94e684edfc..b343fa77cb 100644 --- a/content/reference/services/SoftLayer_Account_Lockdown_Request/_index.md +++ b/content/reference/services/SoftLayer_Account_Lockdown_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -48,36 +50,42 @@ Disabling an account is a PERMANENT action. All billable items under the account #### [cancelRequest](/reference/services/SoftLayer_Account_Lockdown_Request/cancelRequest) Allows approved brands to cancel a previously scheduled lockdown request. +
              #### [disableLockedAccount](/reference/services/SoftLayer_Account_Lockdown_Request/disableLockedAccount) Disabling an account is a PERMANENT action. All billable items associated +
              #### [disconnectCompute](/reference/services/SoftLayer_Account_Lockdown_Request/disconnectCompute) Disconnecting a customer will disable all hardware resources (servers and +
              #### [getAccountHistory](/reference/services/SoftLayer_Account_Lockdown_Request/getAccountHistory) Provides a history of an account's lockdown requests and their status. +
              #### [getObject](/reference/services/SoftLayer_Account_Lockdown_Request/getObject) Retrieve a SoftLayer_Account_Lockdown_Request record. +
              #### [reconnectCompute](/reference/services/SoftLayer_Account_Lockdown_Request/reconnectCompute) Reconnecting a customer will reconnect all previously disconnected +
              diff --git a/content/reference/services/SoftLayer_Account_Lockdown_Request/cancelRequest.md b/content/reference/services/SoftLayer_Account_Lockdown_Request/cancelRequest.md index af4bca5049..0b56cb1fcc 100644 --- a/content/reference/services/SoftLayer_Account_Lockdown_Request/cancelRequest.md +++ b/content/reference/services/SoftLayer_Account_Lockdown_Request/cancelRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Lockdown_Request](/reference/services/SoftLayer_Account_Lockdown_Request)::cancelRequest + Allows approved brands to cancel a previously scheduled lockdown request. diff --git a/content/reference/services/SoftLayer_Account_Lockdown_Request/disableLockedAccount.md b/content/reference/services/SoftLayer_Account_Lockdown_Request/disableLockedAccount.md index 670d5cf74d..5846b8f536 100644 --- a/content/reference/services/SoftLayer_Account_Lockdown_Request/disableLockedAccount.md +++ b/content/reference/services/SoftLayer_Account_Lockdown_Request/disableLockedAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Lockdown_Request](/reference/services/SoftLayer_Account_Lockdown_Request)::disableLockedAccount + Disabling an account is a PERMANENT action. All billable items associated diff --git a/content/reference/services/SoftLayer_Account_Lockdown_Request/disconnectCompute.md b/content/reference/services/SoftLayer_Account_Lockdown_Request/disconnectCompute.md index 36a5e663f9..ad5551c504 100644 --- a/content/reference/services/SoftLayer_Account_Lockdown_Request/disconnectCompute.md +++ b/content/reference/services/SoftLayer_Account_Lockdown_Request/disconnectCompute.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Lockdown_Request](/reference/services/SoftLayer_Account_Lockdown_Request)::disconnectCompute + Disconnecting a customer will disable all hardware resources (servers and diff --git a/content/reference/services/SoftLayer_Account_Lockdown_Request/getAccountHistory.md b/content/reference/services/SoftLayer_Account_Lockdown_Request/getAccountHistory.md index 98f3267d7a..26a87a9054 100644 --- a/content/reference/services/SoftLayer_Account_Lockdown_Request/getAccountHistory.md +++ b/content/reference/services/SoftLayer_Account_Lockdown_Request/getAccountHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Lockdown_Request](/reference/services/SoftLayer_Account_Lockdown_Request)::getAccountHistory + Provides a history of an account's lockdown requests and their status. diff --git a/content/reference/services/SoftLayer_Account_Lockdown_Request/getObject.md b/content/reference/services/SoftLayer_Account_Lockdown_Request/getObject.md index 8ed4246ae5..eaf89c3fd6 100644 --- a/content/reference/services/SoftLayer_Account_Lockdown_Request/getObject.md +++ b/content/reference/services/SoftLayer_Account_Lockdown_Request/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Lockdown_Request](/reference/services/SoftLayer_Account_Lockdown_Request)::getObject + Retrieve a SoftLayer_Account_Lockdown_Request record. diff --git a/content/reference/services/SoftLayer_Account_Lockdown_Request/reconnectCompute.md b/content/reference/services/SoftLayer_Account_Lockdown_Request/reconnectCompute.md index eeda6f4967..0efc06bdb9 100644 --- a/content/reference/services/SoftLayer_Account_Lockdown_Request/reconnectCompute.md +++ b/content/reference/services/SoftLayer_Account_Lockdown_Request/reconnectCompute.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Lockdown_Request](/reference/services/SoftLayer_Account_Lockdown_Request)::reconnectCompute + Reconnecting a customer will reconnect all previously disconnected diff --git a/content/reference/services/SoftLayer_Account_MasterServiceAgreement/_index.md b/content/reference/services/SoftLayer_Account_MasterServiceAgreement/_index.md index 6428584329..350d5d2791 100644 --- a/content/reference/services/SoftLayer_Account_MasterServiceAgreement/_index.md +++ b/content/reference/services/SoftLayer_Account_MasterServiceAgreement/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,18 +44,21 @@ classes: #### [getAccount](/reference/services/SoftLayer_Account_MasterServiceAgreement/getAccount) +
              #### [getFile](/reference/services/SoftLayer_Account_MasterServiceAgreement/getFile) Get the user's accounts current MSA +
              #### [getObject](/reference/services/SoftLayer_Account_MasterServiceAgreement/getObject) Retrieve a SoftLayer_Account_MasterServiceAgreement record. +
              diff --git a/content/reference/services/SoftLayer_Account_MasterServiceAgreement/getAccount.md b/content/reference/services/SoftLayer_Account_MasterServiceAgreement/getAccount.md index 1da907c8ad..93deffc301 100644 --- a/content/reference/services/SoftLayer_Account_MasterServiceAgreement/getAccount.md +++ b/content/reference/services/SoftLayer_Account_MasterServiceAgreement/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_MasterServiceAgreement/getFile.md b/content/reference/services/SoftLayer_Account_MasterServiceAgreement/getFile.md index 86aae1f4ec..2ca168c329 100644 --- a/content/reference/services/SoftLayer_Account_MasterServiceAgreement/getFile.md +++ b/content/reference/services/SoftLayer_Account_MasterServiceAgreement/getFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_MasterServiceAgreement](/reference/services/SoftLayer_Account_MasterServiceAgreement)::getFile + Get the user's accounts current MSA diff --git a/content/reference/services/SoftLayer_Account_MasterServiceAgreement/getObject.md b/content/reference/services/SoftLayer_Account_MasterServiceAgreement/getObject.md index 6d2be80b7b..8fa830ac6c 100644 --- a/content/reference/services/SoftLayer_Account_MasterServiceAgreement/getObject.md +++ b/content/reference/services/SoftLayer_Account_MasterServiceAgreement/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_MasterServiceAgreement](/reference/services/SoftLayer_Account_MasterServiceAgreement)::getObject + Retrieve a SoftLayer_Account_MasterServiceAgreement record. diff --git a/content/reference/services/SoftLayer_Account_Media/_index.md b/content/reference/services/SoftLayer_Account_Media/_index.md index 714c364dbf..8ea4a86304 100644 --- a/content/reference/services/SoftLayer_Account_Media/_index.md +++ b/content/reference/services/SoftLayer_Account_Media/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer's data transfer request media service allows users to access and manage their media devices that they have submitted through SoftLayer's Data Transfer Service. @@ -42,72 +44,84 @@ SoftLayer's data transfer request media service allows users to access and manag #### [editObject](/reference/services/SoftLayer_Account_Media/editObject) Edit a media. +
              #### [getAccount](/reference/services/SoftLayer_Account_Media/getAccount) Retrieve the account to which the media belongs. +
              #### [getAllMediaTypes](/reference/services/SoftLayer_Account_Media/getAllMediaTypes) Retrieve a list supported media types. +
              #### [getCreateUser](/reference/services/SoftLayer_Account_Media/getCreateUser) Retrieve the customer user who created the media object. +
              #### [getDatacenter](/reference/services/SoftLayer_Account_Media/getDatacenter) Retrieve the datacenter where the media resides. +
              #### [getModifyEmployee](/reference/services/SoftLayer_Account_Media/getModifyEmployee) Retrieve the employee who last modified the media. +
              #### [getModifyUser](/reference/services/SoftLayer_Account_Media/getModifyUser) Retrieve the customer user who last modified the media. +
              #### [getObject](/reference/services/SoftLayer_Account_Media/getObject) Retrieve a SoftLayer_Account_Media record. +
              #### [getRequest](/reference/services/SoftLayer_Account_Media/getRequest) Retrieve the request to which the media belongs. +
              #### [getType](/reference/services/SoftLayer_Account_Media/getType) Retrieve the media's type. +
              #### [getVolume](/reference/services/SoftLayer_Account_Media/getVolume) Retrieve a guest's associated EVault network storage service account. +
              #### [removeMediaFromList](/reference/services/SoftLayer_Account_Media/removeMediaFromList) Remove a media from a SoftLayer account's list of media. +
              diff --git a/content/reference/services/SoftLayer_Account_Media/editObject.md b/content/reference/services/SoftLayer_Account_Media/editObject.md index 6b4edfa3ee..470b59708d 100644 --- a/content/reference/services/SoftLayer_Account_Media/editObject.md +++ b/content/reference/services/SoftLayer_Account_Media/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media](/reference/services/SoftLayer_Account_Media)::editObject + Edit a media. diff --git a/content/reference/services/SoftLayer_Account_Media/getAccount.md b/content/reference/services/SoftLayer_Account_Media/getAccount.md index d83345d486..304a066e1f 100644 --- a/content/reference/services/SoftLayer_Account_Media/getAccount.md +++ b/content/reference/services/SoftLayer_Account_Media/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media](/reference/services/SoftLayer_Account_Media)::getAccount + Retrieve the account to which the media belongs. diff --git a/content/reference/services/SoftLayer_Account_Media/getAllMediaTypes.md b/content/reference/services/SoftLayer_Account_Media/getAllMediaTypes.md index 86943f9ea0..e964b8f7c2 100644 --- a/content/reference/services/SoftLayer_Account_Media/getAllMediaTypes.md +++ b/content/reference/services/SoftLayer_Account_Media/getAllMediaTypes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media](/reference/services/SoftLayer_Account_Media)::getAllMediaTypes + Retrieve a list supported media types. diff --git a/content/reference/services/SoftLayer_Account_Media/getCreateUser.md b/content/reference/services/SoftLayer_Account_Media/getCreateUser.md index 9052f278a3..467e2b08d3 100644 --- a/content/reference/services/SoftLayer_Account_Media/getCreateUser.md +++ b/content/reference/services/SoftLayer_Account_Media/getCreateUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media](/reference/services/SoftLayer_Account_Media)::getCreateUser + Retrieve the customer user who created the media object. diff --git a/content/reference/services/SoftLayer_Account_Media/getDatacenter.md b/content/reference/services/SoftLayer_Account_Media/getDatacenter.md index ed98a73e09..ef43348ede 100644 --- a/content/reference/services/SoftLayer_Account_Media/getDatacenter.md +++ b/content/reference/services/SoftLayer_Account_Media/getDatacenter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media](/reference/services/SoftLayer_Account_Media)::getDatacenter + Retrieve the datacenter where the media resides. diff --git a/content/reference/services/SoftLayer_Account_Media/getModifyEmployee.md b/content/reference/services/SoftLayer_Account_Media/getModifyEmployee.md index d1a1d085c2..1aec25f4ec 100644 --- a/content/reference/services/SoftLayer_Account_Media/getModifyEmployee.md +++ b/content/reference/services/SoftLayer_Account_Media/getModifyEmployee.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media](/reference/services/SoftLayer_Account_Media)::getModifyEmployee + Retrieve the employee who last modified the media. diff --git a/content/reference/services/SoftLayer_Account_Media/getModifyUser.md b/content/reference/services/SoftLayer_Account_Media/getModifyUser.md index 666cd06d1f..e14bcf66b8 100644 --- a/content/reference/services/SoftLayer_Account_Media/getModifyUser.md +++ b/content/reference/services/SoftLayer_Account_Media/getModifyUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media](/reference/services/SoftLayer_Account_Media)::getModifyUser + Retrieve the customer user who last modified the media. diff --git a/content/reference/services/SoftLayer_Account_Media/getObject.md b/content/reference/services/SoftLayer_Account_Media/getObject.md index a2efd3ff36..a1d6c661d3 100644 --- a/content/reference/services/SoftLayer_Account_Media/getObject.md +++ b/content/reference/services/SoftLayer_Account_Media/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media](/reference/services/SoftLayer_Account_Media)::getObject + Retrieve a SoftLayer_Account_Media record. diff --git a/content/reference/services/SoftLayer_Account_Media/getRequest.md b/content/reference/services/SoftLayer_Account_Media/getRequest.md index d515da0005..87072a8747 100644 --- a/content/reference/services/SoftLayer_Account_Media/getRequest.md +++ b/content/reference/services/SoftLayer_Account_Media/getRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media](/reference/services/SoftLayer_Account_Media)::getRequest + Retrieve the request to which the media belongs. diff --git a/content/reference/services/SoftLayer_Account_Media/getType.md b/content/reference/services/SoftLayer_Account_Media/getType.md index 92c2bf3899..63c135d593 100644 --- a/content/reference/services/SoftLayer_Account_Media/getType.md +++ b/content/reference/services/SoftLayer_Account_Media/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media](/reference/services/SoftLayer_Account_Media)::getType + Retrieve the media's type. diff --git a/content/reference/services/SoftLayer_Account_Media/getVolume.md b/content/reference/services/SoftLayer_Account_Media/getVolume.md index 39f9ba419f..62df635e56 100644 --- a/content/reference/services/SoftLayer_Account_Media/getVolume.md +++ b/content/reference/services/SoftLayer_Account_Media/getVolume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media](/reference/services/SoftLayer_Account_Media)::getVolume + Retrieve a guest's associated EVault network storage service account. diff --git a/content/reference/services/SoftLayer_Account_Media/removeMediaFromList.md b/content/reference/services/SoftLayer_Account_Media/removeMediaFromList.md index 5e3b3bbbd6..347009c470 100644 --- a/content/reference/services/SoftLayer_Account_Media/removeMediaFromList.md +++ b/content/reference/services/SoftLayer_Account_Media/removeMediaFromList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media](/reference/services/SoftLayer_Account_Media)::removeMediaFromList + Remove a media from a SoftLayer account's list of media. diff --git a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/_index.md b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/_index.md index 80875e529b..67f04da904 100644 --- a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/_index.md +++ b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer's Data Transfer Request Service allows users to send SoftLayer media devices such as DVDs, CDs, USB hard drives or USB flash/thumb drives. These media can be connected to SoftLayer servers and presented as ISCSI targets for use by the user. Currently, the initial usage period is two weeks and there is no charge for this service. Additional time for maintaining the media for continued may be purchased. Please contact sales for additional information regarding this. Once the usage period has elapsed. SoftLayer will disconnect the media and return it to the user. @@ -42,78 +44,91 @@ SoftLayer's Data Transfer Request Service allows users to send SoftLayer media d #### [editObject](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/editObject) Edit a data transfer request. +
              #### [getAccount](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getAccount) Retrieve the account to which the request belongs. +
              #### [getActiveTickets](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getActiveTickets) Retrieve the active tickets that are attached to the data transfer request. +
              #### [getAllRequestStatuses](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getAllRequestStatuses) Retrieves a list of all the possible statuses to which a request may be set. +
              #### [getBillingItem](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getBillingItem) Retrieve the billing item for the original request. +
              #### [getCreateUser](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getCreateUser) Retrieve the customer user who created the request. +
              #### [getMedia](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getMedia) Retrieve the media of the request. +
              #### [getModifyEmployee](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getModifyEmployee) Retrieve the employee who last modified the request. +
              #### [getModifyUser](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getModifyUser) Retrieve the customer user who last modified the request. +
              #### [getObject](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getObject) Retrieve a SoftLayer_Account_Media_Data_Transfer_Request record. +
              #### [getShipments](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getShipments) Retrieve the shipments of the request. +
              #### [getStatus](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getStatus) Retrieve the status of the request. +
              #### [getTickets](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getTickets) Retrieve all tickets that are attached to the data transfer request. +
              diff --git a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/editObject.md b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/editObject.md index ab78710af8..0035c403b3 100644 --- a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/editObject.md +++ b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media_Data_Transfer_Request](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request)::editObject + Edit a data transfer request. diff --git a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getAccount.md b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getAccount.md index 94b9dfd1ac..ec9443a8ac 100644 --- a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getAccount.md +++ b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media_Data_Transfer_Request](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request)::getAccount + Retrieve the account to which the request belongs. diff --git a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getActiveTickets.md b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getActiveTickets.md index fff8dbe58f..f3b2f5200d 100644 --- a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getActiveTickets.md +++ b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getActiveTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media_Data_Transfer_Request](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request)::getActiveTickets + Retrieve the active tickets that are attached to the data transfer request. diff --git a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getAllRequestStatuses.md b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getAllRequestStatuses.md index 58e7a9d71d..35e377e2aa 100644 --- a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getAllRequestStatuses.md +++ b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getAllRequestStatuses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media_Data_Transfer_Request](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request)::getAllRequestStatuses + Retrieves a list of all the possible statuses to which a request may be set. diff --git a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getBillingItem.md b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getBillingItem.md index ffea67dcbc..5d5da4ff66 100644 --- a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getBillingItem.md +++ b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media_Data_Transfer_Request](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request)::getBillingItem + Retrieve the billing item for the original request. diff --git a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getCreateUser.md b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getCreateUser.md index d057bbf277..e22ac09359 100644 --- a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getCreateUser.md +++ b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getCreateUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media_Data_Transfer_Request](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request)::getCreateUser + Retrieve the customer user who created the request. diff --git a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getMedia.md b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getMedia.md index b4fcfc51ce..0f5dc40f71 100644 --- a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getMedia.md +++ b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getMedia.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media_Data_Transfer_Request](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request)::getMedia + Retrieve the media of the request. diff --git a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getModifyEmployee.md b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getModifyEmployee.md index a0cf8d04dd..a29040a611 100644 --- a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getModifyEmployee.md +++ b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getModifyEmployee.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media_Data_Transfer_Request](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request)::getModifyEmployee + Retrieve the employee who last modified the request. diff --git a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getModifyUser.md b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getModifyUser.md index 3d73e2a670..8807fe5d81 100644 --- a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getModifyUser.md +++ b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getModifyUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media_Data_Transfer_Request](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request)::getModifyUser + Retrieve the customer user who last modified the request. diff --git a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getObject.md b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getObject.md index d2277fbecc..2c27ed0ab5 100644 --- a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getObject.md +++ b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media_Data_Transfer_Request](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request)::getObject + Retrieve a SoftLayer_Account_Media_Data_Transfer_Request record. diff --git a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getShipments.md b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getShipments.md index a6da84e38e..2e2ae9cda8 100644 --- a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getShipments.md +++ b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getShipments.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media_Data_Transfer_Request](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request)::getShipments + Retrieve the shipments of the request. diff --git a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getStatus.md b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getStatus.md index d97a71acc5..0286451e62 100644 --- a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getStatus.md +++ b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media_Data_Transfer_Request](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request)::getStatus + Retrieve the status of the request. diff --git a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getTickets.md b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getTickets.md index c506d14a81..048a1cc4a7 100644 --- a/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getTickets.md +++ b/content/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Media_Data_Transfer_Request](/reference/services/SoftLayer_Account_Media_Data_Transfer_Request)::getTickets + Retrieve all tickets that are attached to the data transfer request. diff --git a/content/reference/services/SoftLayer_Account_Note/_index.md b/content/reference/services/SoftLayer_Account_Note/_index.md index 34f8d74a29..eabee59f07 100644 --- a/content/reference/services/SoftLayer_Account_Note/_index.md +++ b/content/reference/services/SoftLayer_Account_Note/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,42 +44,49 @@ classes: #### [createObject](/reference/services/SoftLayer_Account_Note/createObject) +
              #### [deleteObject](/reference/services/SoftLayer_Account_Note/deleteObject) +
              #### [editObject](/reference/services/SoftLayer_Account_Note/editObject) +
              #### [getAccount](/reference/services/SoftLayer_Account_Note/getAccount) +
              #### [getCustomer](/reference/services/SoftLayer_Account_Note/getCustomer) +
              #### [getNoteHistory](/reference/services/SoftLayer_Account_Note/getNoteHistory) +
              #### [getObject](/reference/services/SoftLayer_Account_Note/getObject) Retrieve a SoftLayer_Account_Note record. +
              diff --git a/content/reference/services/SoftLayer_Account_Note/createObject.md b/content/reference/services/SoftLayer_Account_Note/createObject.md index c4cc9333b9..349664afea 100644 --- a/content/reference/services/SoftLayer_Account_Note/createObject.md +++ b/content/reference/services/SoftLayer_Account_Note/createObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Note/deleteObject.md b/content/reference/services/SoftLayer_Account_Note/deleteObject.md index 8c37709f13..856851fd5a 100644 --- a/content/reference/services/SoftLayer_Account_Note/deleteObject.md +++ b/content/reference/services/SoftLayer_Account_Note/deleteObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Note/editObject.md b/content/reference/services/SoftLayer_Account_Note/editObject.md index 2eb3d18773..8226d82251 100644 --- a/content/reference/services/SoftLayer_Account_Note/editObject.md +++ b/content/reference/services/SoftLayer_Account_Note/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Note/getAccount.md b/content/reference/services/SoftLayer_Account_Note/getAccount.md index 6c610d4b76..5abd914b26 100644 --- a/content/reference/services/SoftLayer_Account_Note/getAccount.md +++ b/content/reference/services/SoftLayer_Account_Note/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Note/getCustomer.md b/content/reference/services/SoftLayer_Account_Note/getCustomer.md index ab11252bd0..f17f216036 100644 --- a/content/reference/services/SoftLayer_Account_Note/getCustomer.md +++ b/content/reference/services/SoftLayer_Account_Note/getCustomer.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Note/getNoteHistory.md b/content/reference/services/SoftLayer_Account_Note/getNoteHistory.md index c0236cd0db..63f92dcabb 100644 --- a/content/reference/services/SoftLayer_Account_Note/getNoteHistory.md +++ b/content/reference/services/SoftLayer_Account_Note/getNoteHistory.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Note/getObject.md b/content/reference/services/SoftLayer_Account_Note/getObject.md index 38ee501304..eaac3b0a59 100644 --- a/content/reference/services/SoftLayer_Account_Note/getObject.md +++ b/content/reference/services/SoftLayer_Account_Note/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Note](/reference/services/SoftLayer_Account_Note)::getObject + Retrieve a SoftLayer_Account_Note record. diff --git a/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/_index.md b/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/_index.md index 094aa0ead1..ac753c497c 100644 --- a/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/_index.md +++ b/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,42 +44,49 @@ classes: #### [createProspect](/reference/services/SoftLayer_Account_Partner_Referral_Prospect/createProspect) Creates a new Referral Partner Prospect +
              #### [getAccount](/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getAccount) +
              #### [getAssignedEmployees](/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getAssignedEmployees) +
              #### [getObject](/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getObject) Retrieve a SoftLayer_Account_Partner_Referral_Prospect record. +
              #### [getQuotes](/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getQuotes) +
              #### [getSurveyQuestions](/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getSurveyQuestions) Retrieves Questions for a Referral Partner Survey +
              #### [getType](/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getType) +
              diff --git a/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/createProspect.md b/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/createProspect.md index 114711e22a..9270f4d6ca 100644 --- a/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/createProspect.md +++ b/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/createProspect.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Partner_Referral_Prospect](/reference/services/SoftLayer_Account_Partner_Referral_Prospect)::createProspect + Creates a new Referral Partner Prospect diff --git a/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getAccount.md b/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getAccount.md index 8fb73c0245..fa4231ada7 100644 --- a/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getAccount.md +++ b/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getAssignedEmployees.md b/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getAssignedEmployees.md index e146ac4d1a..ab77d252a9 100644 --- a/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getAssignedEmployees.md +++ b/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getAssignedEmployees.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getObject.md b/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getObject.md index 850e585b79..9a1dd24251 100644 --- a/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getObject.md +++ b/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Partner_Referral_Prospect](/reference/services/SoftLayer_Account_Partner_Referral_Prospect)::getObject + Retrieve a SoftLayer_Account_Partner_Referral_Prospect record. diff --git a/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getQuotes.md b/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getQuotes.md index 6cc8b8d469..1a8281a113 100644 --- a/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getQuotes.md +++ b/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getQuotes.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getSurveyQuestions.md b/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getSurveyQuestions.md index b97aa10c8d..6b9d07506b 100644 --- a/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getSurveyQuestions.md +++ b/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getSurveyQuestions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Partner_Referral_Prospect](/reference/services/SoftLayer_Account_Partner_Referral_Prospect)::getSurveyQuestions + Retrieves Questions for a Referral Partner Survey diff --git a/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getType.md b/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getType.md index dfea89f079..2061fe1a8c 100644 --- a/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getType.md +++ b/content/reference/services/SoftLayer_Account_Partner_Referral_Prospect/getType.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Password/_index.md b/content/reference/services/SoftLayer_Account_Password/_index.md index 2704f0cf4f..a6e55cfd51 100644 --- a/content/reference/services/SoftLayer_Account_Password/_index.md +++ b/content/reference/services/SoftLayer_Account_Password/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -44,24 +46,28 @@ For instance, an account's EVault WebCC information is kept in a SoftLayer_Accou #### [editObject](/reference/services/SoftLayer_Account_Password/editObject) Edit the password and/or notes for an account password. +
              #### [getAccount](/reference/services/SoftLayer_Account_Password/getAccount) +
              #### [getObject](/reference/services/SoftLayer_Account_Password/getObject) Retrieve a SoftLayer_Account_Password record. +
              #### [getType](/reference/services/SoftLayer_Account_Password/getType) Retrieve the service that an account/password combination is tied to. +
              diff --git a/content/reference/services/SoftLayer_Account_Password/editObject.md b/content/reference/services/SoftLayer_Account_Password/editObject.md index 858874f883..6ee6454c16 100644 --- a/content/reference/services/SoftLayer_Account_Password/editObject.md +++ b/content/reference/services/SoftLayer_Account_Password/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Password](/reference/services/SoftLayer_Account_Password)::editObject + Edit the password and/or notes for an account password. diff --git a/content/reference/services/SoftLayer_Account_Password/getAccount.md b/content/reference/services/SoftLayer_Account_Password/getAccount.md index becaca5242..2aa83ba435 100644 --- a/content/reference/services/SoftLayer_Account_Password/getAccount.md +++ b/content/reference/services/SoftLayer_Account_Password/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Password/getObject.md b/content/reference/services/SoftLayer_Account_Password/getObject.md index 9743c93405..114da1a7bb 100644 --- a/content/reference/services/SoftLayer_Account_Password/getObject.md +++ b/content/reference/services/SoftLayer_Account_Password/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Password](/reference/services/SoftLayer_Account_Password)::getObject + Retrieve a SoftLayer_Account_Password record. diff --git a/content/reference/services/SoftLayer_Account_Password/getType.md b/content/reference/services/SoftLayer_Account_Password/getType.md index 78c26cf6c9..1d939c02ed 100644 --- a/content/reference/services/SoftLayer_Account_Password/getType.md +++ b/content/reference/services/SoftLayer_Account_Password/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Password](/reference/services/SoftLayer_Account_Password)::getType + Retrieve the service that an account/password combination is tied to. diff --git a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/_index.md b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/_index.md index 1193e4260f..4ea772ad91 100644 --- a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/_index.md +++ b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,54 +44,63 @@ classes: #### [approveRequest](/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/approveRequest) Approve a personal information removal request. +
              #### [getAccount](/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getAccount) +
              #### [getApprovedFlag](/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getApprovedFlag) +
              #### [getAuthorizationUrl](/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getAuthorizationUrl) Gets the redirect URL for GDPR removal review. +
              #### [getObject](/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getObject) Retrieve a SoftLayer_Account_PersonalData_RemoveRequestReview record. +
              #### [getPendingRequests](/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getPendingRequests) Gets information removal requests to review. +
              #### [getReviewerAccessToken](/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getReviewerAccessToken) Retrieves an access token. +
              #### [getReviewerEmailFromAccessToken](/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getReviewerEmailFromAccessToken) Fetches an email address using a token +
              #### [getTotalPendingRequests](/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getTotalPendingRequests) +
              diff --git a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/approveRequest.md b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/approveRequest.md index 291b8c4732..1b27da7c57 100644 --- a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/approveRequest.md +++ b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/approveRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_PersonalData_RemoveRequestReview](/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview)::approveRequest + Approve a personal information removal request. diff --git a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getAccount.md b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getAccount.md index e91eef4a89..76a62f98ab 100644 --- a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getAccount.md +++ b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getApprovedFlag.md b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getApprovedFlag.md index 0a5946579e..6ae2ac0848 100644 --- a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getApprovedFlag.md +++ b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getApprovedFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getAuthorizationUrl.md b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getAuthorizationUrl.md index 6bfcb89fa7..7601c0a610 100644 --- a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getAuthorizationUrl.md +++ b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getAuthorizationUrl.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_PersonalData_RemoveRequestReview](/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview)::getAuthorizationUrl + Gets the redirect URL for GDPR removal review. diff --git a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getObject.md b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getObject.md index 56798c200f..27dd42e9dd 100644 --- a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getObject.md +++ b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_PersonalData_RemoveRequestReview](/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview)::getObject + Retrieve a SoftLayer_Account_PersonalData_RemoveRequestReview record. diff --git a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getPendingRequests.md b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getPendingRequests.md index f839e59835..8db5fd353c 100644 --- a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getPendingRequests.md +++ b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getPendingRequests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_PersonalData_RemoveRequestReview](/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview)::getPendingRequests + Gets information removal requests to review. diff --git a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getReviewerAccessToken.md b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getReviewerAccessToken.md index 41d8ea8485..79d00b0c4e 100644 --- a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getReviewerAccessToken.md +++ b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getReviewerAccessToken.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_PersonalData_RemoveRequestReview](/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview)::getReviewerAccessToken + Retrieves an access token. diff --git a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getReviewerEmailFromAccessToken.md b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getReviewerEmailFromAccessToken.md index c49de23875..6f7c76bf55 100644 --- a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getReviewerEmailFromAccessToken.md +++ b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getReviewerEmailFromAccessToken.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_PersonalData_RemoveRequestReview](/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview)::getReviewerEmailFromAccessToken + Fetches an email address using a token diff --git a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getTotalPendingRequests.md b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getTotalPendingRequests.md index d3c0038ac1..c1ce7492c5 100644 --- a/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getTotalPendingRequests.md +++ b/content/reference/services/SoftLayer_Account_PersonalData_RemoveRequestReview/getTotalPendingRequests.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/_index.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/_index.md index e5378dc3eb..3fba3c8419 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/_index.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -44,108 +46,126 @@ This service is unavailable to users outside of IBM and is not applicable to the #### [approveReview](/reference/services/SoftLayer_Account_ProofOfConcept/approveReview) Allows a reviewer to approve a request +
              #### [denyReview](/reference/services/SoftLayer_Account_ProofOfConcept/denyReview) Allows reviewer to deny a request +
              #### [getAuthenticationUrl](/reference/services/SoftLayer_Account_ProofOfConcept/getAuthenticationUrl) Gets authentication URL +
              #### [getRequestsPendingIntegratedOfferingTeamReview](/reference/services/SoftLayer_Account_ProofOfConcept/getRequestsPendingIntegratedOfferingTeamReview) Retrieves a list of requests pending IOT review in the specified regions +
              #### [getRequestsPendingOverThresholdReview](/reference/services/SoftLayer_Account_ProofOfConcept/getRequestsPendingOverThresholdReview) Retrieves a list of requests pending over threshold review +
              #### [getReviewerAccessToken](/reference/services/SoftLayer_Account_ProofOfConcept/getReviewerAccessToken) Exchanges a token +
              #### [getReviewerEmailFromAccessToken](/reference/services/SoftLayer_Account_ProofOfConcept/getReviewerEmailFromAccessToken) Fetches an email address using a token +
              #### [getSubmittedRequest](/reference/services/SoftLayer_Account_ProofOfConcept/getSubmittedRequest) Retrieves full details of one PoC request submitted by an IBMer. +
              #### [getSubmittedRequests](/reference/services/SoftLayer_Account_ProofOfConcept/getSubmittedRequests) Retrieves a summary of proof of concept requests submitted by an IBMer. +
              #### [getSupportEmailAddress](/reference/services/SoftLayer_Account_ProofOfConcept/getSupportEmailAddress) Gets email address users can use to ask for help/support +
              #### [getTotalRequestsPendingIntegratedOfferingTeamReview](/reference/services/SoftLayer_Account_ProofOfConcept/getTotalRequestsPendingIntegratedOfferingTeamReview) +
              #### [getTotalRequestsPendingOverThresholdReviewCount](/reference/services/SoftLayer_Account_ProofOfConcept/getTotalRequestsPendingOverThresholdReviewCount) +
              #### [isCurrentReviewer](/reference/services/SoftLayer_Account_ProofOfConcept/isCurrentReviewer) Determines if the user is one of the reviewers currently able to act +
              #### [isIntegratedOfferingTeamReviewer](/reference/services/SoftLayer_Account_ProofOfConcept/isIntegratedOfferingTeamReviewer) Retrieves Verifies a reviewer +
              #### [isOverThresholdReviewer](/reference/services/SoftLayer_Account_ProofOfConcept/isOverThresholdReviewer) Verifies a reviewer +
              #### [requestAccountTeamFundedAccount](/reference/services/SoftLayer_Account_ProofOfConcept/requestAccountTeamFundedAccount) Accepts new proof of concept requests +
              #### [requestGlobalFundedAccount](/reference/services/SoftLayer_Account_ProofOfConcept/requestGlobalFundedAccount) Accepts new proof of concept requests +
              #### [verifyReviewer](/reference/services/SoftLayer_Account_ProofOfConcept/verifyReviewer) Validates a reviewer +
              diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/approveReview.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/approveReview.md index 51f1754104..1529ec7be0 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/approveReview.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/approveReview.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept](/reference/services/SoftLayer_Account_ProofOfConcept)::approveReview + Allows a reviewer to approve a request diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/denyReview.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/denyReview.md index 994bfcf97f..8adc9c997a 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/denyReview.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/denyReview.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept](/reference/services/SoftLayer_Account_ProofOfConcept)::denyReview + Allows reviewer to deny a request diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/getAuthenticationUrl.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/getAuthenticationUrl.md index 07526c67ec..86b4288250 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/getAuthenticationUrl.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/getAuthenticationUrl.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept](/reference/services/SoftLayer_Account_ProofOfConcept)::getAuthenticationUrl + Gets authentication URL diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/getRequestsPendingIntegratedOfferingTeamReview.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/getRequestsPendingIntegratedOfferingTeamReview.md index 1ca8b4d705..b1ba8db147 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/getRequestsPendingIntegratedOfferingTeamReview.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/getRequestsPendingIntegratedOfferingTeamReview.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept](/reference/services/SoftLayer_Account_ProofOfConcept)::getRequestsPendingIntegratedOfferingTeamReview + Retrieves a list of requests pending IOT review in the specified regions diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/getRequestsPendingOverThresholdReview.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/getRequestsPendingOverThresholdReview.md index fea6a02dad..b12691d37e 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/getRequestsPendingOverThresholdReview.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/getRequestsPendingOverThresholdReview.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept](/reference/services/SoftLayer_Account_ProofOfConcept)::getRequestsPendingOverThresholdReview + Retrieves a list of requests pending over threshold review diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/getReviewerAccessToken.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/getReviewerAccessToken.md index 8dc534b304..0962add22a 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/getReviewerAccessToken.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/getReviewerAccessToken.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept](/reference/services/SoftLayer_Account_ProofOfConcept)::getReviewerAccessToken + Exchanges a token diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/getReviewerEmailFromAccessToken.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/getReviewerEmailFromAccessToken.md index d868430114..6451bb9c7d 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/getReviewerEmailFromAccessToken.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/getReviewerEmailFromAccessToken.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept](/reference/services/SoftLayer_Account_ProofOfConcept)::getReviewerEmailFromAccessToken + Fetches an email address using a token diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/getSubmittedRequest.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/getSubmittedRequest.md index 572c0125a2..2f5c3a9c91 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/getSubmittedRequest.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/getSubmittedRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept](/reference/services/SoftLayer_Account_ProofOfConcept)::getSubmittedRequest + Retrieves full details of one PoC request submitted by an IBMer. diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/getSubmittedRequests.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/getSubmittedRequests.md index 0d8dd0acbe..19d690cffa 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/getSubmittedRequests.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/getSubmittedRequests.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept](/reference/services/SoftLayer_Account_ProofOfConcept)::getSubmittedRequests + Retrieves a summary of proof of concept requests submitted by an IBMer. diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/getSupportEmailAddress.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/getSupportEmailAddress.md index ca24766295..9476157c26 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/getSupportEmailAddress.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/getSupportEmailAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept](/reference/services/SoftLayer_Account_ProofOfConcept)::getSupportEmailAddress + Gets email address users can use to ask for help/support diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/getTotalRequestsPendingIntegratedOfferingTeamReview.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/getTotalRequestsPendingIntegratedOfferingTeamReview.md index 0dd6a89204..ad8d3f6bf2 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/getTotalRequestsPendingIntegratedOfferingTeamReview.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/getTotalRequestsPendingIntegratedOfferingTeamReview.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/getTotalRequestsPendingOverThresholdReviewCount.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/getTotalRequestsPendingOverThresholdReviewCount.md index b875e52085..832063daba 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/getTotalRequestsPendingOverThresholdReviewCount.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/getTotalRequestsPendingOverThresholdReviewCount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/isCurrentReviewer.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/isCurrentReviewer.md index 7904de91da..beef7d07e5 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/isCurrentReviewer.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/isCurrentReviewer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept](/reference/services/SoftLayer_Account_ProofOfConcept)::isCurrentReviewer + Determines if the user is one of the reviewers currently able to act diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/isIntegratedOfferingTeamReviewer.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/isIntegratedOfferingTeamReviewer.md index 53e2fc92d7..6bfa78adaa 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/isIntegratedOfferingTeamReviewer.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/isIntegratedOfferingTeamReviewer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept](/reference/services/SoftLayer_Account_ProofOfConcept)::isIntegratedOfferingTeamReviewer + Retrieves Verifies a reviewer diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/isOverThresholdReviewer.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/isOverThresholdReviewer.md index 7290c9227d..53bb175429 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/isOverThresholdReviewer.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/isOverThresholdReviewer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept](/reference/services/SoftLayer_Account_ProofOfConcept)::isOverThresholdReviewer + Verifies a reviewer diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/requestAccountTeamFundedAccount.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/requestAccountTeamFundedAccount.md index 321cac6fca..514b7d37e8 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/requestAccountTeamFundedAccount.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/requestAccountTeamFundedAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept](/reference/services/SoftLayer_Account_ProofOfConcept)::requestAccountTeamFundedAccount + Accepts new proof of concept requests diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/requestGlobalFundedAccount.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/requestGlobalFundedAccount.md index 61da77fb99..8228356c3f 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/requestGlobalFundedAccount.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/requestGlobalFundedAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept](/reference/services/SoftLayer_Account_ProofOfConcept)::requestGlobalFundedAccount + Accepts new proof of concept requests diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept/verifyReviewer.md b/content/reference/services/SoftLayer_Account_ProofOfConcept/verifyReviewer.md index 059508f974..9b50728277 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept/verifyReviewer.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept/verifyReviewer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept](/reference/services/SoftLayer_Account_ProofOfConcept)::verifyReviewer + Validates a reviewer diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/_index.md b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/_index.md index 6323f9f9f8..5acf86c567 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/_index.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class represents a Proof of Concept account approver. @@ -42,24 +44,28 @@ This class represents a Proof of Concept account approver. #### [getAllObjects](/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getAllObjects) Retrieves a list of reviewers +
              #### [getObject](/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getObject) Retrieve a SoftLayer_Account_ProofOfConcept_Approver record. +
              #### [getRole](/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getRole) +
              #### [getType](/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getType) +
              diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getAllObjects.md b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getAllObjects.md index 703f31db8e..2751f2efd9 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getAllObjects.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept_Approver](/reference/services/SoftLayer_Account_ProofOfConcept_Approver)::getAllObjects + Retrieves a list of reviewers diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getObject.md b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getObject.md index d740e8e410..06a7eccf1f 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getObject.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept_Approver](/reference/services/SoftLayer_Account_ProofOfConcept_Approver)::getObject + Retrieve a SoftLayer_Account_ProofOfConcept_Approver record. diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getRole.md b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getRole.md index 55df67b29e..3b5ee04020 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getRole.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getRole.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getType.md b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getType.md index a450b3e759..02463df1dd 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getType.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver/getType.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Role/_index.md b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Role/_index.md index 908ba8bb1b..957f507c5b 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Role/_index.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Role/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class represents a Proof of Concept account approver role. The current roles are Primary and Backup approvers. @@ -42,6 +44,7 @@ This class represents a Proof of Concept account approver role. The current role #### [getObject](/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Role/getObject) Retrieve a SoftLayer_Account_ProofOfConcept_Approver_Role record. + diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Role/getObject.md b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Role/getObject.md index 7a610a4a90..4a52124a4e 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Role/getObject.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Role/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept_Approver_Role](/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Role)::getObject + Retrieve a SoftLayer_Account_ProofOfConcept_Approver_Role record. diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Type/_index.md b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Type/_index.md index 685121d65e..381220678f 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Type/_index.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class represents a Proof of Concept account approver type. @@ -42,12 +44,14 @@ This class represents a Proof of Concept account approver type. #### [getApprovers](/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Type/getApprovers) +
              #### [getObject](/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Type/getObject) Retrieve a SoftLayer_Account_ProofOfConcept_Approver_Type record. +
              diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Type/getApprovers.md b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Type/getApprovers.md index e919ee1536..20d178705c 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Type/getApprovers.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Type/getApprovers.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Type/getObject.md b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Type/getObject.md index 2afb8a12f4..cfe47fdb74 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Type/getObject.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept_Approver_Type](/reference/services/SoftLayer_Account_ProofOfConcept_Approver_Type)::getObject + Retrieve a SoftLayer_Account_ProofOfConcept_Approver_Type record. diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept_Campaign_Code/_index.md b/content/reference/services/SoftLayer_Account_ProofOfConcept_Campaign_Code/_index.md index 866d62e76a..7875eea20c 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept_Campaign_Code/_index.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept_Campaign_Code/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This service provides Internal IBM Proof of Concept account campaign or promotion codes. @@ -42,12 +44,14 @@ This service provides Internal IBM Proof of Concept account campaign or promotio #### [getAllObjects](/reference/services/SoftLayer_Account_ProofOfConcept_Campaign_Code/getAllObjects) Get all Proof of Concept campaign codes. +
              #### [getObject](/reference/services/SoftLayer_Account_ProofOfConcept_Campaign_Code/getObject) Retrieve a SoftLayer_Account_ProofOfConcept_Campaign_Code record. +
              diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept_Campaign_Code/getAllObjects.md b/content/reference/services/SoftLayer_Account_ProofOfConcept_Campaign_Code/getAllObjects.md index f8e86f0030..afa7e4b2ca 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept_Campaign_Code/getAllObjects.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept_Campaign_Code/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept_Campaign_Code](/reference/services/SoftLayer_Account_ProofOfConcept_Campaign_Code)::getAllObjects + Get all Proof of Concept campaign codes. diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept_Campaign_Code/getObject.md b/content/reference/services/SoftLayer_Account_ProofOfConcept_Campaign_Code/getObject.md index 42c90c7782..b841dc36ce 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept_Campaign_Code/getObject.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept_Campaign_Code/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept_Campaign_Code](/reference/services/SoftLayer_Account_ProofOfConcept_Campaign_Code)::getObject + Retrieve a SoftLayer_Account_ProofOfConcept_Campaign_Code record. diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/_index.md b/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/_index.md index 687a0413a5..2f7f085d8f 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/_index.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,24 +44,28 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getAllObjects) +
              #### [getApproverTypes](/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getApproverTypes) +
              #### [getApprovers](/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getApprovers) +
              #### [getObject](/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getObject) Retrieve a SoftLayer_Account_ProofOfConcept_Funding_Type record. +
              diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getAllObjects.md b/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getAllObjects.md index ccf3aedc5e..f2fbaff552 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getApproverTypes.md b/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getApproverTypes.md index c953df62b3..fa72f1eddc 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getApproverTypes.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getApproverTypes.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getApprovers.md b/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getApprovers.md index 73e382d824..ff3c923a09 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getApprovers.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getApprovers.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getObject.md b/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getObject.md index 8cedf937dd..005f2cdc9f 100644 --- a/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getObject.md +++ b/content/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_ProofOfConcept_Funding_Type](/reference/services/SoftLayer_Account_ProofOfConcept_Funding_Type)::getObject + Retrieve a SoftLayer_Account_ProofOfConcept_Funding_Type record. diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/_index.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/_index.md index db86cd1350..84507642e5 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/_index.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Regional Registry Detail objects are used to specify the information you wish to use when registering subnets with the appropriate Regional Internet Registries. @@ -42,66 +44,77 @@ Regional Registry Detail objects are used to specify the information you wish to #### [createObject](/reference/services/SoftLayer_Account_Regional_Registry_Detail/createObject) Create a new detail object +
              #### [deleteObject](/reference/services/SoftLayer_Account_Regional_Registry_Detail/deleteObject) Delete an existing detail object +
              #### [editObject](/reference/services/SoftLayer_Account_Regional_Registry_Detail/editObject) Edit an existing detail object +
              #### [getAccount](/reference/services/SoftLayer_Account_Regional_Registry_Detail/getAccount) Retrieve the account that this detail object belongs to. +
              #### [getDetailType](/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetailType) Retrieve the associated type of this detail object. +
              #### [getDetails](/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetails) Retrieve references to the [SoftLayer_Network_Subnet_Registration]({{}}) that consume this detail object. +
              #### [getObject](/reference/services/SoftLayer_Account_Regional_Registry_Detail/getObject) Retrieve a SoftLayer_Account_Regional_Registry_Detail record. +
              #### [getProperties](/reference/services/SoftLayer_Account_Regional_Registry_Detail/getProperties) Retrieve the individual properties that define this detail object's values. +
              #### [getRegionalInternetRegistryHandle](/reference/services/SoftLayer_Account_Regional_Registry_Detail/getRegionalInternetRegistryHandle) Retrieve the associated RWhois handle of this detail object. Used only when detailed reassignments are necessary. +
              #### [updateReferencedRegistrations](/reference/services/SoftLayer_Account_Regional_Registry_Detail/updateReferencedRegistrations) Create a transaction to update the registrations that reference this detail object. +
              #### [validatePersonForAllRegistrars](/reference/services/SoftLayer_Account_Regional_Registry_Detail/validatePersonForAllRegistrars) Validate an existing person detail object. +
              diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/createObject.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/createObject.md index 32b90484b4..983968d942 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/createObject.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail](/reference/services/SoftLayer_Account_Regional_Registry_Detail)::createObject + Create a new detail object diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/deleteObject.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/deleteObject.md index 164ccf29b2..6c173aa198 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/deleteObject.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail](/reference/services/SoftLayer_Account_Regional_Registry_Detail)::deleteObject + Delete an existing detail object diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/editObject.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/editObject.md index 63c5eade5a..9278877852 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/editObject.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail](/reference/services/SoftLayer_Account_Regional_Registry_Detail)::editObject + Edit an existing detail object diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getAccount.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getAccount.md index 6f44a0fad2..e997dfc7a2 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getAccount.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail](/reference/services/SoftLayer_Account_Regional_Registry_Detail)::getAccount + Retrieve the account that this detail object belongs to. diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetailType.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetailType.md index 66e809a807..af8e731326 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetailType.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetailType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail](/reference/services/SoftLayer_Account_Regional_Registry_Detail)::getDetailType + Retrieve the associated type of this detail object. diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetails.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetails.md index ff8bdbc45c..e600b93417 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetails.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail](/reference/services/SoftLayer_Account_Regional_Registry_Detail)::getDetails + Retrieve references to the [SoftLayer_Network_Subnet_Registration]({{}}) that consume this detail object. diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getObject.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getObject.md index 503d072eb7..772b0d3ee7 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getObject.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail](/reference/services/SoftLayer_Account_Regional_Registry_Detail)::getObject + Retrieve a SoftLayer_Account_Regional_Registry_Detail record. diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getProperties.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getProperties.md index 4a83dcc0f5..c7d704b05a 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getProperties.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getProperties.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail](/reference/services/SoftLayer_Account_Regional_Registry_Detail)::getProperties + Retrieve the individual properties that define this detail object's values. diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getRegionalInternetRegistryHandle.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getRegionalInternetRegistryHandle.md index 7f2c4a4065..9b6fcdc2e2 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getRegionalInternetRegistryHandle.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/getRegionalInternetRegistryHandle.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail](/reference/services/SoftLayer_Account_Regional_Registry_Detail)::getRegionalInternetRegistryHandle + Retrieve the associated RWhois handle of this detail object. Used only when detailed reassignments are necessary. diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/updateReferencedRegistrations.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/updateReferencedRegistrations.md index 96215e500a..40488dba40 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/updateReferencedRegistrations.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/updateReferencedRegistrations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail](/reference/services/SoftLayer_Account_Regional_Registry_Detail)::updateReferencedRegistrations + Create a transaction to update the registrations that reference this detail object. diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/validatePersonForAllRegistrars.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/validatePersonForAllRegistrars.md index 19c1ff7437..a75db6d080 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/validatePersonForAllRegistrars.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail/validatePersonForAllRegistrars.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail](/reference/services/SoftLayer_Account_Regional_Registry_Detail)::validatePersonForAllRegistrars + Validate an existing person detail object. diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/_index.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/_index.md index 3acd8158ad..08db8a0242 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/_index.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The subnet registration property is used to define various attributes of [SoftLayer_Account_Regional_Registry_Detail]({{}}). @@ -42,48 +44,56 @@ The subnet registration property is used to define various attributes of [SoftLa #### [createObject](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObject) Create a new property object +
              #### [createObjects](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObjects) Create multiple property objects. +
              #### [deleteObject](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/deleteObject) Delete an existing property object +
              #### [editObject](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObject) Edit an existing property object +
              #### [editObjects](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObjects) Edit multiple property objects. +
              #### [getDetail](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getDetail) Retrieve the [SoftLayer_Account_Regional_Registry_Detail]({{}}) object this property belongs to +
              #### [getObject](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getObject) Retrieve a SoftLayer_Account_Regional_Registry_Detail_Property record. +
              #### [getPropertyType](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getPropertyType) Retrieve the [SoftLayer_Account_Regional_Registry_Detail_Property_Type]({{}}) object this property belongs to +
              diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObject.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObject.md index 86a09d082f..5194d541fc 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObject.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property)::createObject + Create a new property object diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObjects.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObjects.md index 0cf7d60e0c..eb92b60822 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObjects.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property)::createObjects + Create multiple property objects. diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/deleteObject.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/deleteObject.md index 03a093d6a2..72a9f1b544 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/deleteObject.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property)::deleteObject + Delete an existing property object diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObject.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObject.md index d2817ea59d..395892ed2f 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObject.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property)::editObject + Edit an existing property object diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObjects.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObjects.md index 68de6b0ff0..6afbd444aa 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObjects.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property)::editObjects + Edit multiple property objects. diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getDetail.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getDetail.md index 54bbd16959..8282442eb9 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getDetail.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property)::getDetail + Retrieve the [SoftLayer_Account_Regional_Registry_Detail]({{}}) object this property belongs to diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getObject.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getObject.md index ce414d9363..b1a40c7e79 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getObject.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property)::getObject + Retrieve a SoftLayer_Account_Regional_Registry_Detail_Property record. diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getPropertyType.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getPropertyType.md index 5b8cc93f15..6141665cf3 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getPropertyType.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getPropertyType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property)::getPropertyType + Retrieve the [SoftLayer_Account_Regional_Registry_Detail_Property_Type]({{}}) object this property belongs to diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/_index.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/_index.md index 57b45e56f6..9b9ddfd275 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/_index.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getObject) Retrieve a SoftLayer_Account_Regional_Registry_Detail_Property_Type record. +
              diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getAllObjects.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getAllObjects.md index c7177742b9..ba22c2f66d 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getObject.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getObject.md index f350a4b6d9..82712d6e31 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getObject.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail_Property_Type](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type)::getObject + Retrieve a SoftLayer_Account_Regional_Registry_Detail_Property_Type record. diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/_index.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/_index.md index 2af5e1d546..30130ac7f9 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/_index.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/getObject) Retrieve a SoftLayer_Account_Regional_Registry_Detail_Type record. +
              diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/getAllObjects.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/getAllObjects.md index c1ea6d8ab9..d75a69a691 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/getObject.md b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/getObject.md index 8195177fed..c46e1c819e 100644 --- a/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/getObject.md +++ b/content/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Regional_Registry_Detail_Type](/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type)::getObject + Retrieve a SoftLayer_Account_Regional_Registry_Detail_Type record. diff --git a/content/reference/services/SoftLayer_Account_Reports_Request/_index.md b/content/reference/services/SoftLayer_Account_Reports_Request/_index.md index 5b124aa29c..b0e0912bae 100644 --- a/content/reference/services/SoftLayer_Account_Reports_Request/_index.md +++ b/content/reference/services/SoftLayer_Account_Reports_Request/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,72 +44,84 @@ classes: #### [createRequest](/reference/services/SoftLayer_Account_Reports_Request/createRequest) +
              #### [getAccount](/reference/services/SoftLayer_Account_Reports_Request/getAccount) +
              #### [getAccountContact](/reference/services/SoftLayer_Account_Reports_Request/getAccountContact) Retrieve a request's corresponding external contact, if one exists. +
              #### [getAllObjects](/reference/services/SoftLayer_Account_Reports_Request/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_Account_Reports_Request/getObject) Retrieve a SoftLayer_Account_Reports_Request record. +
              #### [getReportType](/reference/services/SoftLayer_Account_Reports_Request/getReportType) Retrieve type of the report customer is requesting for. +
              #### [getRequestByRequestKey](/reference/services/SoftLayer_Account_Reports_Request/getRequestByRequestKey) +
              #### [getRequestorContact](/reference/services/SoftLayer_Account_Reports_Request/getRequestorContact) Retrieve a request's corresponding requestor contact, if one exists. +
              #### [getTicket](/reference/services/SoftLayer_Account_Reports_Request/getTicket) +
              #### [getUser](/reference/services/SoftLayer_Account_Reports_Request/getUser) Retrieve the customer user that initiated a report request. +
              #### [sendReportEmail](/reference/services/SoftLayer_Account_Reports_Request/sendReportEmail) +
              #### [updateTicketOnDecline](/reference/services/SoftLayer_Account_Reports_Request/updateTicketOnDecline) +
              diff --git a/content/reference/services/SoftLayer_Account_Reports_Request/createRequest.md b/content/reference/services/SoftLayer_Account_Reports_Request/createRequest.md index 75722a887d..67e98a3f3d 100644 --- a/content/reference/services/SoftLayer_Account_Reports_Request/createRequest.md +++ b/content/reference/services/SoftLayer_Account_Reports_Request/createRequest.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Reports_Request/getAccount.md b/content/reference/services/SoftLayer_Account_Reports_Request/getAccount.md index 9d4386dd92..2e2db5639e 100644 --- a/content/reference/services/SoftLayer_Account_Reports_Request/getAccount.md +++ b/content/reference/services/SoftLayer_Account_Reports_Request/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Reports_Request/getAccountContact.md b/content/reference/services/SoftLayer_Account_Reports_Request/getAccountContact.md index 1145a33b82..ebd9f6a0f0 100644 --- a/content/reference/services/SoftLayer_Account_Reports_Request/getAccountContact.md +++ b/content/reference/services/SoftLayer_Account_Reports_Request/getAccountContact.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Reports_Request](/reference/services/SoftLayer_Account_Reports_Request)::getAccountContact + Retrieve a request's corresponding external contact, if one exists. diff --git a/content/reference/services/SoftLayer_Account_Reports_Request/getAllObjects.md b/content/reference/services/SoftLayer_Account_Reports_Request/getAllObjects.md index dd621f4cb1..a2b05f5ee1 100644 --- a/content/reference/services/SoftLayer_Account_Reports_Request/getAllObjects.md +++ b/content/reference/services/SoftLayer_Account_Reports_Request/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Reports_Request/getObject.md b/content/reference/services/SoftLayer_Account_Reports_Request/getObject.md index 519661e1ca..78e6c8edc8 100644 --- a/content/reference/services/SoftLayer_Account_Reports_Request/getObject.md +++ b/content/reference/services/SoftLayer_Account_Reports_Request/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Reports_Request](/reference/services/SoftLayer_Account_Reports_Request)::getObject + Retrieve a SoftLayer_Account_Reports_Request record. diff --git a/content/reference/services/SoftLayer_Account_Reports_Request/getReportType.md b/content/reference/services/SoftLayer_Account_Reports_Request/getReportType.md index c31d2bbaa3..e198fc4604 100644 --- a/content/reference/services/SoftLayer_Account_Reports_Request/getReportType.md +++ b/content/reference/services/SoftLayer_Account_Reports_Request/getReportType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Reports_Request](/reference/services/SoftLayer_Account_Reports_Request)::getReportType + Retrieve type of the report customer is requesting for. diff --git a/content/reference/services/SoftLayer_Account_Reports_Request/getRequestByRequestKey.md b/content/reference/services/SoftLayer_Account_Reports_Request/getRequestByRequestKey.md index f032e62c77..5bdaf9276b 100644 --- a/content/reference/services/SoftLayer_Account_Reports_Request/getRequestByRequestKey.md +++ b/content/reference/services/SoftLayer_Account_Reports_Request/getRequestByRequestKey.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Reports_Request/getRequestorContact.md b/content/reference/services/SoftLayer_Account_Reports_Request/getRequestorContact.md index 6c23637094..5b49840c27 100644 --- a/content/reference/services/SoftLayer_Account_Reports_Request/getRequestorContact.md +++ b/content/reference/services/SoftLayer_Account_Reports_Request/getRequestorContact.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Reports_Request](/reference/services/SoftLayer_Account_Reports_Request)::getRequestorContact + Retrieve a request's corresponding requestor contact, if one exists. diff --git a/content/reference/services/SoftLayer_Account_Reports_Request/getTicket.md b/content/reference/services/SoftLayer_Account_Reports_Request/getTicket.md index 75133fccf0..a81cf2284c 100644 --- a/content/reference/services/SoftLayer_Account_Reports_Request/getTicket.md +++ b/content/reference/services/SoftLayer_Account_Reports_Request/getTicket.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Reports_Request/getUser.md b/content/reference/services/SoftLayer_Account_Reports_Request/getUser.md index 2564b21d3d..c76d61e2aa 100644 --- a/content/reference/services/SoftLayer_Account_Reports_Request/getUser.md +++ b/content/reference/services/SoftLayer_Account_Reports_Request/getUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Reports_Request](/reference/services/SoftLayer_Account_Reports_Request)::getUser + Retrieve the customer user that initiated a report request. diff --git a/content/reference/services/SoftLayer_Account_Reports_Request/sendReportEmail.md b/content/reference/services/SoftLayer_Account_Reports_Request/sendReportEmail.md index 5e933dc7eb..c323a0f972 100644 --- a/content/reference/services/SoftLayer_Account_Reports_Request/sendReportEmail.md +++ b/content/reference/services/SoftLayer_Account_Reports_Request/sendReportEmail.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Reports_Request/updateTicketOnDecline.md b/content/reference/services/SoftLayer_Account_Reports_Request/updateTicketOnDecline.md index 8f5843d89e..6725b978b1 100644 --- a/content/reference/services/SoftLayer_Account_Reports_Request/updateTicketOnDecline.md +++ b/content/reference/services/SoftLayer_Account_Reports_Request/updateTicketOnDecline.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Shipment/_index.md b/content/reference/services/SoftLayer_Account_Shipment/_index.md index 62166df139..da21f27761 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/_index.md +++ b/content/reference/services/SoftLayer_Account_Shipment/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,126 +44,147 @@ SoftLayer's shipment service allows the user to access information pertaining to #### [editObject](/reference/services/SoftLayer_Account_Shipment/editObject) Edit a shipment record. +
              #### [getAccount](/reference/services/SoftLayer_Account_Shipment/getAccount) Retrieve the account to which the shipment belongs. +
              #### [getAllCouriers](/reference/services/SoftLayer_Account_Shipment/getAllCouriers) Retrieve a list of available shipping couriers. +
              #### [getAllCouriersByType](/reference/services/SoftLayer_Account_Shipment/getAllCouriersByType) Retrieve a list of couriers for a given courier type +
              #### [getAllShipmentStatuses](/reference/services/SoftLayer_Account_Shipment/getAllShipmentStatuses) Retrieve a list of shipment statuses. +
              #### [getAllShipmentTypes](/reference/services/SoftLayer_Account_Shipment/getAllShipmentTypes) Retrieve a list of shipment types. +
              #### [getCourier](/reference/services/SoftLayer_Account_Shipment/getCourier) Retrieve the courier handling the shipment. +
              #### [getCreateEmployee](/reference/services/SoftLayer_Account_Shipment/getCreateEmployee) Retrieve the employee who created the shipment. +
              #### [getCreateUser](/reference/services/SoftLayer_Account_Shipment/getCreateUser) Retrieve the customer user who created the shipment. +
              #### [getCurrency](/reference/services/SoftLayer_Account_Shipment/getCurrency) +
              #### [getDestinationAddress](/reference/services/SoftLayer_Account_Shipment/getDestinationAddress) Retrieve the address at which the shipment is received. +
              #### [getMasterTrackingData](/reference/services/SoftLayer_Account_Shipment/getMasterTrackingData) Retrieve the one master tracking data for the shipment. +
              #### [getModifyEmployee](/reference/services/SoftLayer_Account_Shipment/getModifyEmployee) Retrieve the employee who last modified the shipment. +
              #### [getModifyUser](/reference/services/SoftLayer_Account_Shipment/getModifyUser) Retrieve the customer user who last modified the shipment. +
              #### [getObject](/reference/services/SoftLayer_Account_Shipment/getObject) Retrieve a SoftLayer_Account_Shipment record. +
              #### [getOriginationAddress](/reference/services/SoftLayer_Account_Shipment/getOriginationAddress) Retrieve the address from which the shipment is sent. +
              #### [getShipmentItems](/reference/services/SoftLayer_Account_Shipment/getShipmentItems) Retrieve the items in the shipment. +
              #### [getStatus](/reference/services/SoftLayer_Account_Shipment/getStatus) Retrieve the status of the shipment. +
              #### [getTrackingData](/reference/services/SoftLayer_Account_Shipment/getTrackingData) Retrieve all tracking data for the shipment and packages. +
              #### [getType](/reference/services/SoftLayer_Account_Shipment/getType) Retrieve the type of shipment (e.g. for Data Transfer Service or Colocation Service). +
              #### [getViaAddress](/reference/services/SoftLayer_Account_Shipment/getViaAddress) Retrieve the address at which the shipment is received. +
              diff --git a/content/reference/services/SoftLayer_Account_Shipment/editObject.md b/content/reference/services/SoftLayer_Account_Shipment/editObject.md index cf5f1d89c4..3f8b9b8f40 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/editObject.md +++ b/content/reference/services/SoftLayer_Account_Shipment/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::editObject + Edit a shipment record. diff --git a/content/reference/services/SoftLayer_Account_Shipment/getAccount.md b/content/reference/services/SoftLayer_Account_Shipment/getAccount.md index c55f434b91..bdbe63c58e 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getAccount.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getAccount + Retrieve the account to which the shipment belongs. diff --git a/content/reference/services/SoftLayer_Account_Shipment/getAllCouriers.md b/content/reference/services/SoftLayer_Account_Shipment/getAllCouriers.md index 3af291b8ed..edc56a1fa6 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getAllCouriers.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getAllCouriers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getAllCouriers + Retrieve a list of available shipping couriers. diff --git a/content/reference/services/SoftLayer_Account_Shipment/getAllCouriersByType.md b/content/reference/services/SoftLayer_Account_Shipment/getAllCouriersByType.md index c58124a965..067a943524 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getAllCouriersByType.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getAllCouriersByType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getAllCouriersByType + Retrieve a list of couriers for a given courier type diff --git a/content/reference/services/SoftLayer_Account_Shipment/getAllShipmentStatuses.md b/content/reference/services/SoftLayer_Account_Shipment/getAllShipmentStatuses.md index 7c8465f2d9..44465f4a6b 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getAllShipmentStatuses.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getAllShipmentStatuses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getAllShipmentStatuses + Retrieve a list of shipment statuses. diff --git a/content/reference/services/SoftLayer_Account_Shipment/getAllShipmentTypes.md b/content/reference/services/SoftLayer_Account_Shipment/getAllShipmentTypes.md index 5d8e896903..afd447ec43 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getAllShipmentTypes.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getAllShipmentTypes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getAllShipmentTypes + Retrieve a list of shipment types. diff --git a/content/reference/services/SoftLayer_Account_Shipment/getCourier.md b/content/reference/services/SoftLayer_Account_Shipment/getCourier.md index 6e68bd5c1e..2657fdbf51 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getCourier.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getCourier.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getCourier + Retrieve the courier handling the shipment. diff --git a/content/reference/services/SoftLayer_Account_Shipment/getCreateEmployee.md b/content/reference/services/SoftLayer_Account_Shipment/getCreateEmployee.md index e1c53b5520..45b68020e6 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getCreateEmployee.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getCreateEmployee.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getCreateEmployee + Retrieve the employee who created the shipment. diff --git a/content/reference/services/SoftLayer_Account_Shipment/getCreateUser.md b/content/reference/services/SoftLayer_Account_Shipment/getCreateUser.md index 23b909c246..c0a2c15d5a 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getCreateUser.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getCreateUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getCreateUser + Retrieve the customer user who created the shipment. diff --git a/content/reference/services/SoftLayer_Account_Shipment/getCurrency.md b/content/reference/services/SoftLayer_Account_Shipment/getCurrency.md index bb9413a1d5..80e9a5eb3d 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getCurrency.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getCurrency.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Account_Shipment/getDestinationAddress.md b/content/reference/services/SoftLayer_Account_Shipment/getDestinationAddress.md index bd98417a20..d92fd7b0f5 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getDestinationAddress.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getDestinationAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getDestinationAddress + Retrieve the address at which the shipment is received. diff --git a/content/reference/services/SoftLayer_Account_Shipment/getMasterTrackingData.md b/content/reference/services/SoftLayer_Account_Shipment/getMasterTrackingData.md index bcdecf55ac..cc1f628560 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getMasterTrackingData.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getMasterTrackingData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getMasterTrackingData + Retrieve the one master tracking data for the shipment. diff --git a/content/reference/services/SoftLayer_Account_Shipment/getModifyEmployee.md b/content/reference/services/SoftLayer_Account_Shipment/getModifyEmployee.md index a32cc2a3e6..cdaa328096 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getModifyEmployee.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getModifyEmployee.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getModifyEmployee + Retrieve the employee who last modified the shipment. diff --git a/content/reference/services/SoftLayer_Account_Shipment/getModifyUser.md b/content/reference/services/SoftLayer_Account_Shipment/getModifyUser.md index 81f348a42b..78382df269 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getModifyUser.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getModifyUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getModifyUser + Retrieve the customer user who last modified the shipment. diff --git a/content/reference/services/SoftLayer_Account_Shipment/getObject.md b/content/reference/services/SoftLayer_Account_Shipment/getObject.md index 37693ccc49..383e9024ad 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getObject.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getObject + Retrieve a SoftLayer_Account_Shipment record. diff --git a/content/reference/services/SoftLayer_Account_Shipment/getOriginationAddress.md b/content/reference/services/SoftLayer_Account_Shipment/getOriginationAddress.md index 6aa1a0913a..1428adf350 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getOriginationAddress.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getOriginationAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getOriginationAddress + Retrieve the address from which the shipment is sent. diff --git a/content/reference/services/SoftLayer_Account_Shipment/getShipmentItems.md b/content/reference/services/SoftLayer_Account_Shipment/getShipmentItems.md index 8c9ffd8bb6..20a4f9ae62 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getShipmentItems.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getShipmentItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getShipmentItems + Retrieve the items in the shipment. diff --git a/content/reference/services/SoftLayer_Account_Shipment/getStatus.md b/content/reference/services/SoftLayer_Account_Shipment/getStatus.md index 4cb99ba78d..ea55813295 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getStatus.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getStatus + Retrieve the status of the shipment. diff --git a/content/reference/services/SoftLayer_Account_Shipment/getTrackingData.md b/content/reference/services/SoftLayer_Account_Shipment/getTrackingData.md index 7b7808ea5c..b3181dc849 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getTrackingData.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getTrackingData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getTrackingData + Retrieve all tracking data for the shipment and packages. diff --git a/content/reference/services/SoftLayer_Account_Shipment/getType.md b/content/reference/services/SoftLayer_Account_Shipment/getType.md index 11f02c52d4..67bc78aee1 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getType.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getType + Retrieve the type of shipment (e.g. for Data Transfer Service or Colocation Service). diff --git a/content/reference/services/SoftLayer_Account_Shipment/getViaAddress.md b/content/reference/services/SoftLayer_Account_Shipment/getViaAddress.md index 58e949b807..3fec940115 100644 --- a/content/reference/services/SoftLayer_Account_Shipment/getViaAddress.md +++ b/content/reference/services/SoftLayer_Account_Shipment/getViaAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment](/reference/services/SoftLayer_Account_Shipment)::getViaAddress + Retrieve the address at which the shipment is received. diff --git a/content/reference/services/SoftLayer_Account_Shipment_Item/_index.md b/content/reference/services/SoftLayer_Account_Shipment_Item/_index.md index b8ef737d4c..d3cff42681 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Item/_index.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Item/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,24 +44,28 @@ SoftLayer's shipment item service allows the user to access information pertaini #### [editObject](/reference/services/SoftLayer_Account_Shipment_Item/editObject) Edit a shipment record. +
              #### [getObject](/reference/services/SoftLayer_Account_Shipment_Item/getObject) Retrieve a SoftLayer_Account_Shipment_Item record. +
              #### [getShipment](/reference/services/SoftLayer_Account_Shipment_Item/getShipment) Retrieve the shipment to which this item belongs. +
              #### [getShipmentItemType](/reference/services/SoftLayer_Account_Shipment_Item/getShipmentItemType) Retrieve the type of this shipment item. +
              diff --git a/content/reference/services/SoftLayer_Account_Shipment_Item/editObject.md b/content/reference/services/SoftLayer_Account_Shipment_Item/editObject.md index db2075b1c6..09fd2863da 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Item/editObject.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Item/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment_Item](/reference/services/SoftLayer_Account_Shipment_Item)::editObject + Edit a shipment record. diff --git a/content/reference/services/SoftLayer_Account_Shipment_Item/getObject.md b/content/reference/services/SoftLayer_Account_Shipment_Item/getObject.md index cabc6bde29..135ad3c55a 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Item/getObject.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Item/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment_Item](/reference/services/SoftLayer_Account_Shipment_Item)::getObject + Retrieve a SoftLayer_Account_Shipment_Item record. diff --git a/content/reference/services/SoftLayer_Account_Shipment_Item/getShipment.md b/content/reference/services/SoftLayer_Account_Shipment_Item/getShipment.md index f2e0ff9425..548c32eb77 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Item/getShipment.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Item/getShipment.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment_Item](/reference/services/SoftLayer_Account_Shipment_Item)::getShipment + Retrieve the shipment to which this item belongs. diff --git a/content/reference/services/SoftLayer_Account_Shipment_Item/getShipmentItemType.md b/content/reference/services/SoftLayer_Account_Shipment_Item/getShipmentItemType.md index b2eadb4749..afc69074d4 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Item/getShipmentItemType.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Item/getShipmentItemType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment_Item](/reference/services/SoftLayer_Account_Shipment_Item)::getShipmentItemType + Retrieve the type of this shipment item. diff --git a/content/reference/services/SoftLayer_Account_Shipment_Item_Type/_index.md b/content/reference/services/SoftLayer_Account_Shipment_Item_Type/_index.md index 3381258a91..a902b64c99 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Item_Type/_index.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Item_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,6 +44,7 @@ classes: #### [getObject](/reference/services/SoftLayer_Account_Shipment_Item_Type/getObject) Retrieve a SoftLayer_Account_Shipment_Item_Type record. +
              diff --git a/content/reference/services/SoftLayer_Account_Shipment_Item_Type/getObject.md b/content/reference/services/SoftLayer_Account_Shipment_Item_Type/getObject.md index 3b048c6e62..ccd56be198 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Item_Type/getObject.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Item_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment_Item_Type](/reference/services/SoftLayer_Account_Shipment_Item_Type)::getObject + Retrieve a SoftLayer_Account_Shipment_Item_Type record. diff --git a/content/reference/services/SoftLayer_Account_Shipment_Resource_Type/_index.md b/content/reference/services/SoftLayer_Account_Shipment_Resource_Type/_index.md index a65bc1b552..905904220f 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Resource_Type/_index.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Resource_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,6 +44,7 @@ classes: #### [getObject](/reference/services/SoftLayer_Account_Shipment_Resource_Type/getObject) Retrieve a SoftLayer_Account_Shipment_Resource_Type record. +
              diff --git a/content/reference/services/SoftLayer_Account_Shipment_Resource_Type/getObject.md b/content/reference/services/SoftLayer_Account_Shipment_Resource_Type/getObject.md index 888fae7f93..7854ee822b 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Resource_Type/getObject.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Resource_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment_Resource_Type](/reference/services/SoftLayer_Account_Shipment_Resource_Type)::getObject + Retrieve a SoftLayer_Account_Shipment_Resource_Type record. diff --git a/content/reference/services/SoftLayer_Account_Shipment_Status/_index.md b/content/reference/services/SoftLayer_Account_Shipment_Status/_index.md index 415353994a..d3a0cdd288 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Status/_index.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Status/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,6 +44,7 @@ classes: #### [getObject](/reference/services/SoftLayer_Account_Shipment_Status/getObject) Retrieve a SoftLayer_Account_Shipment_Status record. +
              diff --git a/content/reference/services/SoftLayer_Account_Shipment_Status/getObject.md b/content/reference/services/SoftLayer_Account_Shipment_Status/getObject.md index 069a0339b6..724d480af5 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Status/getObject.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Status/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment_Status](/reference/services/SoftLayer_Account_Shipment_Status)::getObject + Retrieve a SoftLayer_Account_Shipment_Status record. diff --git a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/_index.md b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/_index.md index e6c1f8cb89..081827e9d2 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/_index.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,60 +44,70 @@ SoftLayer's tracking data service allows the user to access and manage tracking #### [createObject](/reference/services/SoftLayer_Account_Shipment_Tracking_Data/createObject) Create a new shipment tracking data. +
              #### [createObjects](/reference/services/SoftLayer_Account_Shipment_Tracking_Data/createObjects) Create multiple tracking data records. +
              #### [deleteObject](/reference/services/SoftLayer_Account_Shipment_Tracking_Data/deleteObject) Delete a shipment tracking datum (number) +
              #### [editObject](/reference/services/SoftLayer_Account_Shipment_Tracking_Data/editObject) Edit a tracking data. +
              #### [getCreateEmployee](/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getCreateEmployee) Retrieve the employee who created the tracking datum. +
              #### [getCreateUser](/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getCreateUser) Retrieve the customer user who created the tracking datum. +
              #### [getModifyEmployee](/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getModifyEmployee) Retrieve the employee who last modified the tracking datum. +
              #### [getModifyUser](/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getModifyUser) Retrieve the customer user who last modified the tracking datum. +
              #### [getObject](/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getObject) Retrieve a SoftLayer_Account_Shipment_Tracking_Data record. +
              #### [getShipment](/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getShipment) Retrieve the shipment of the tracking datum. +
              diff --git a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/createObject.md b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/createObject.md index 2be3031473..b62e1f7039 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/createObject.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment_Tracking_Data](/reference/services/SoftLayer_Account_Shipment_Tracking_Data)::createObject + Create a new shipment tracking data. diff --git a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/createObjects.md b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/createObjects.md index 8b0f2901bf..8e77de5de2 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/createObjects.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/createObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment_Tracking_Data](/reference/services/SoftLayer_Account_Shipment_Tracking_Data)::createObjects + Create multiple tracking data records. diff --git a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/deleteObject.md b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/deleteObject.md index 2b9cb34fc8..004eb0047e 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/deleteObject.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment_Tracking_Data](/reference/services/SoftLayer_Account_Shipment_Tracking_Data)::deleteObject + Delete a shipment tracking datum (number) diff --git a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/editObject.md b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/editObject.md index 3b67275ee8..a62051564f 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/editObject.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment_Tracking_Data](/reference/services/SoftLayer_Account_Shipment_Tracking_Data)::editObject + Edit a tracking data. diff --git a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getCreateEmployee.md b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getCreateEmployee.md index 297ca35bad..3a768b52e1 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getCreateEmployee.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getCreateEmployee.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment_Tracking_Data](/reference/services/SoftLayer_Account_Shipment_Tracking_Data)::getCreateEmployee + Retrieve the employee who created the tracking datum. diff --git a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getCreateUser.md b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getCreateUser.md index bfc68394f8..e30281323a 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getCreateUser.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getCreateUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment_Tracking_Data](/reference/services/SoftLayer_Account_Shipment_Tracking_Data)::getCreateUser + Retrieve the customer user who created the tracking datum. diff --git a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getModifyEmployee.md b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getModifyEmployee.md index e8bdc15c6a..a0189a1035 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getModifyEmployee.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getModifyEmployee.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment_Tracking_Data](/reference/services/SoftLayer_Account_Shipment_Tracking_Data)::getModifyEmployee + Retrieve the employee who last modified the tracking datum. diff --git a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getModifyUser.md b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getModifyUser.md index 5e0e878102..a57fb9e3a5 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getModifyUser.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getModifyUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment_Tracking_Data](/reference/services/SoftLayer_Account_Shipment_Tracking_Data)::getModifyUser + Retrieve the customer user who last modified the tracking datum. diff --git a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getObject.md b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getObject.md index 72a3232010..8508d746ed 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getObject.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment_Tracking_Data](/reference/services/SoftLayer_Account_Shipment_Tracking_Data)::getObject + Retrieve a SoftLayer_Account_Shipment_Tracking_Data record. diff --git a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getShipment.md b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getShipment.md index 90636db3ce..cc8f261ed0 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getShipment.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Tracking_Data/getShipment.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment_Tracking_Data](/reference/services/SoftLayer_Account_Shipment_Tracking_Data)::getShipment + Retrieve the shipment of the tracking datum. diff --git a/content/reference/services/SoftLayer_Account_Shipment_Type/_index.md b/content/reference/services/SoftLayer_Account_Shipment_Type/_index.md index f181ca2155..cab9cda4b2 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Type/_index.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,6 +44,7 @@ classes: #### [getObject](/reference/services/SoftLayer_Account_Shipment_Type/getObject) Retrieve a SoftLayer_Account_Shipment_Type record. +
              diff --git a/content/reference/services/SoftLayer_Account_Shipment_Type/getObject.md b/content/reference/services/SoftLayer_Account_Shipment_Type/getObject.md index 5a98c21563..738cf4b6dd 100644 --- a/content/reference/services/SoftLayer_Account_Shipment_Type/getObject.md +++ b/content/reference/services/SoftLayer_Account_Shipment_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Account_Shipment_Type](/reference/services/SoftLayer_Account_Shipment_Type)::getObject + Retrieve a SoftLayer_Account_Shipment_Type record. diff --git a/content/reference/services/SoftLayer_Auxiliary_Marketing_Event/_index.md b/content/reference/services/SoftLayer_Auxiliary_Marketing_Event/_index.md index 2e4e1f92e8..ef967b2847 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Marketing_Event/_index.md +++ b/content/reference/services/SoftLayer_Auxiliary_Marketing_Event/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getMarketingEvents](/reference/services/SoftLayer_Auxiliary_Marketing_Event/getMarketingEvents) This method retrieves marketing events. +
              #### [getObject](/reference/services/SoftLayer_Auxiliary_Marketing_Event/getObject) Retrieve a SoftLayer_Auxiliary_Marketing_Event record. +
              diff --git a/content/reference/services/SoftLayer_Auxiliary_Marketing_Event/getMarketingEvents.md b/content/reference/services/SoftLayer_Auxiliary_Marketing_Event/getMarketingEvents.md index d6b031eebc..fe2d4e1fb7 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Marketing_Event/getMarketingEvents.md +++ b/content/reference/services/SoftLayer_Auxiliary_Marketing_Event/getMarketingEvents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Marketing_Event](/reference/services/SoftLayer_Auxiliary_Marketing_Event)::getMarketingEvents + This method retrieves marketing events. diff --git a/content/reference/services/SoftLayer_Auxiliary_Marketing_Event/getObject.md b/content/reference/services/SoftLayer_Auxiliary_Marketing_Event/getObject.md index d5f522d763..ce58f24e62 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Marketing_Event/getObject.md +++ b/content/reference/services/SoftLayer_Auxiliary_Marketing_Event/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Marketing_Event](/reference/services/SoftLayer_Auxiliary_Marketing_Event)::getObject + Retrieve a SoftLayer_Auxiliary_Marketing_Event record. diff --git a/content/reference/services/SoftLayer_Auxiliary_Network_Status/_index.md b/content/reference/services/SoftLayer_Auxiliary_Network_Status/_index.md index ad73185584..6f00cc243b 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Network_Status/_index.md +++ b/content/reference/services/SoftLayer_Auxiliary_Network_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This service provides a way for a SoftLayer customer to obtain current latency information from around the world to our datacenters, and segments of our network both public and private. There are a few valid targets. Currently the valid targets are as follows: * ALL * NETWORK_DALLAS @@ -61,6 +63,7 @@ Information #### [getNetworkStatus](/reference/services/SoftLayer_Auxiliary_Network_Status/getNetworkStatus) return current network status for a given target. + diff --git a/content/reference/services/SoftLayer_Auxiliary_Network_Status/getNetworkStatus.md b/content/reference/services/SoftLayer_Auxiliary_Network_Status/getNetworkStatus.md index fbe64b94dd..7e83ad043d 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Network_Status/getNetworkStatus.md +++ b/content/reference/services/SoftLayer_Auxiliary_Network_Status/getNetworkStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Network_Status](/reference/services/SoftLayer_Auxiliary_Network_Status)::getNetworkStatus + return current network status for a given target. diff --git a/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/_index.md b/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/_index.md index 60b5a731a1..04a235c07b 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/_index.md +++ b/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,30 +44,35 @@ The SoftLayer_Auxiliary_Notification_Emergency service is associated with all ac #### [getAllObjects](/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getAllObjects) Retrieve all notification events. +
              #### [getCurrentNotifications](/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getCurrentNotifications) Retrieve current notification events. +
              #### [getObject](/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getObject) Retrieve a SoftLayer_Auxiliary_Notification_Emergency record. +
              #### [getSignature](/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getSignature) Retrieve the signature of the SoftLayer employee department associated with this notification. +
              #### [getStatus](/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getStatus) Retrieve the status of this notification. +
              diff --git a/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getAllObjects.md b/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getAllObjects.md index 271638bb0f..2394ac0560 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getAllObjects.md +++ b/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Notification_Emergency](/reference/services/SoftLayer_Auxiliary_Notification_Emergency)::getAllObjects + Retrieve all notification events. diff --git a/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getCurrentNotifications.md b/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getCurrentNotifications.md index 4362b61a5e..dadeddb711 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getCurrentNotifications.md +++ b/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getCurrentNotifications.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Notification_Emergency](/reference/services/SoftLayer_Auxiliary_Notification_Emergency)::getCurrentNotifications + Retrieve current notification events. diff --git a/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getObject.md b/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getObject.md index bd4d8140aa..1bf631ec43 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getObject.md +++ b/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Notification_Emergency](/reference/services/SoftLayer_Auxiliary_Notification_Emergency)::getObject + Retrieve a SoftLayer_Auxiliary_Notification_Emergency record. diff --git a/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getSignature.md b/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getSignature.md index 2c72b7f286..dd1cb33410 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getSignature.md +++ b/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getSignature.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Notification_Emergency](/reference/services/SoftLayer_Auxiliary_Notification_Emergency)::getSignature + Retrieve the signature of the SoftLayer employee department associated with this notification. diff --git a/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getStatus.md b/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getStatus.md index 0311bbc1ad..4af2b94dd4 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getStatus.md +++ b/content/reference/services/SoftLayer_Auxiliary_Notification_Emergency/getStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Notification_Emergency](/reference/services/SoftLayer_Auxiliary_Notification_Emergency)::getStatus + Retrieve the status of this notification. diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release/_index.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release/_index.md index 7a46817a8b..8e8c2fe3c3 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release/_index.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Auxiliary_Press_Release service is associated with all actions pertaining to the press release management tool. It can be used to obtain a single press release, all press releases, press releases for a given year and highlighted press releases. @@ -42,54 +44,63 @@ The SoftLayer_Auxiliary_Press_Release service is associated with all actions per #### [getAbout](/reference/services/SoftLayer_Auxiliary_Press_Release/getAbout) +
              #### [getAllObjects](/reference/services/SoftLayer_Auxiliary_Press_Release/getAllObjects) Retrieve all press releases. +
              #### [getContacts](/reference/services/SoftLayer_Auxiliary_Press_Release/getContacts) +
              #### [getMediaPartners](/reference/services/SoftLayer_Auxiliary_Press_Release/getMediaPartners) +
              #### [getObject](/reference/services/SoftLayer_Auxiliary_Press_Release/getObject) Retrieve a SoftLayer_Auxiliary_Press_Release record. +
              #### [getPressReleaseContent](/reference/services/SoftLayer_Auxiliary_Press_Release/getPressReleaseContent) +
              #### [getRenderedPressRelease](/reference/services/SoftLayer_Auxiliary_Press_Release/getRenderedPressRelease) Retrieve a press release. +
              #### [getRenderedPressReleases](/reference/services/SoftLayer_Auxiliary_Press_Release/getRenderedPressReleases) Retrieve a press release for a +
              #### [getWebsiteHighlightPressReleases](/reference/services/SoftLayer_Auxiliary_Press_Release/getWebsiteHighlightPressReleases) Retrieve press releases with the +
              diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release/getAbout.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release/getAbout.md index e9e6f1946e..1e04938202 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release/getAbout.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release/getAbout.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release/getAllObjects.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release/getAllObjects.md index 8fc9c33f28..c31de71487 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release/getAllObjects.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Press_Release](/reference/services/SoftLayer_Auxiliary_Press_Release)::getAllObjects + Retrieve all press releases. diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release/getContacts.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release/getContacts.md index 2440400540..6dc3060d2f 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release/getContacts.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release/getContacts.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release/getMediaPartners.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release/getMediaPartners.md index 0b7fa6dba9..6e82832acd 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release/getMediaPartners.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release/getMediaPartners.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release/getObject.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release/getObject.md index b19c775573..bfbceb79b3 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release/getObject.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Press_Release](/reference/services/SoftLayer_Auxiliary_Press_Release)::getObject + Retrieve a SoftLayer_Auxiliary_Press_Release record. diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release/getPressReleaseContent.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release/getPressReleaseContent.md index 2c4b539414..2bb7d9c47c 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release/getPressReleaseContent.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release/getPressReleaseContent.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release/getRenderedPressRelease.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release/getRenderedPressRelease.md index d9add08186..cb0431f612 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release/getRenderedPressRelease.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release/getRenderedPressRelease.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Press_Release](/reference/services/SoftLayer_Auxiliary_Press_Release)::getRenderedPressRelease + Retrieve a press release. diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release/getRenderedPressReleases.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release/getRenderedPressReleases.md index ac88d96e04..130823f332 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release/getRenderedPressReleases.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release/getRenderedPressReleases.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Press_Release](/reference/services/SoftLayer_Auxiliary_Press_Release)::getRenderedPressReleases + Retrieve a press release for a diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release/getWebsiteHighlightPressReleases.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release/getWebsiteHighlightPressReleases.md index ceda5f04ac..65a80aa9b0 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release/getWebsiteHighlightPressReleases.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release/getWebsiteHighlightPressReleases.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Press_Release](/reference/services/SoftLayer_Auxiliary_Press_Release)::getWebsiteHighlightPressReleases + Retrieve press releases with the diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_About/_index.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_About/_index.md index 24d8c8b2b6..aaa2723b26 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_About/_index.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_About/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Auxiliary_Press_Release_About service provides all the about paragraphs associated to a press release. @@ -42,6 +44,7 @@ The SoftLayer_Auxiliary_Press_Release_About service provides all the about parag #### [getObject](/reference/services/SoftLayer_Auxiliary_Press_Release_About/getObject) Retrieve a SoftLayer_Auxiliary_Press_Release_About record. + diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_About/getObject.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_About/getObject.md index a0cedef7a1..b06cceb670 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_About/getObject.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_About/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Press_Release_About](/reference/services/SoftLayer_Auxiliary_Press_Release_About)::getObject + Retrieve a SoftLayer_Auxiliary_Press_Release_About record. diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/_index.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/_index.md index 3f3821f6b6..78ed1609e9 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/_index.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Auxiliary_Press_Release_About_Press_Release service associates a press release to one or more about paragraphs. @@ -42,18 +44,21 @@ The SoftLayer_Auxiliary_Press_Release_About_Press_Release service associates a p #### [getAboutParagraphs](/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/getAboutParagraphs) +
              #### [getObject](/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/getObject) Retrieve a SoftLayer_Auxiliary_Press_Release_About_Press_Release record. +
              #### [getPressReleases](/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/getPressReleases) +
              diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/getAboutParagraphs.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/getAboutParagraphs.md index cfb636ec63..18625be3bf 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/getAboutParagraphs.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/getAboutParagraphs.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/getObject.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/getObject.md index ba83751173..d848063160 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/getObject.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Press_Release_About_Press_Release](/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release)::getObject + Retrieve a SoftLayer_Auxiliary_Press_Release_About_Press_Release record. diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/getPressReleases.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/getPressReleases.md index dd50e5966b..89b4790242 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/getPressReleases.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_About_Press_Release/getPressReleases.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact/_index.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact/_index.md index 989e87d639..b35a22f92c 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact/_index.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Auxiliary_Press_Release_Contact service provides all contacts associated to a press release. @@ -42,6 +44,7 @@ The SoftLayer_Auxiliary_Press_Release_Contact service provides all contacts asso #### [getObject](/reference/services/SoftLayer_Auxiliary_Press_Release_Contact/getObject) Retrieve a SoftLayer_Auxiliary_Press_Release_Contact record. + diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact/getObject.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact/getObject.md index 6865c4d2db..23c0aa09f2 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact/getObject.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Press_Release_Contact](/reference/services/SoftLayer_Auxiliary_Press_Release_Contact)::getObject + Retrieve a SoftLayer_Auxiliary_Press_Release_Contact record. diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/_index.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/_index.md index 54c1f7ccb6..b7388ff69a 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/_index.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Auxiliary_Press_Release_Contact_Press_Release service associates a press release to one or more contacts. @@ -42,18 +44,21 @@ The SoftLayer_Auxiliary_Press_Release_Contact_Press_Release service associates a #### [getContacts](/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/getContacts) +
              #### [getObject](/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/getObject) Retrieve a SoftLayer_Auxiliary_Press_Release_Contact_Press_Release record. +
              #### [getPressReleases](/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/getPressReleases) +
              diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/getContacts.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/getContacts.md index 221b5e2070..30613551dc 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/getContacts.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/getContacts.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/getObject.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/getObject.md index 0b3b14bf75..43ae53866b 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/getObject.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Press_Release_Contact_Press_Release](/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release)::getObject + Retrieve a SoftLayer_Auxiliary_Press_Release_Contact_Press_Release record. diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/getPressReleases.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/getPressReleases.md index 067a39a0f3..ba5f5d4626 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/getPressReleases.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Contact_Press_Release/getPressReleases.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Content/_index.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Content/_index.md index 4da35d166b..7c4b3d1a3a 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Content/_index.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Content/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Auxiliary_Press_Release_Content service is associated with all actions pertaining to the press release management tool. It can be used to obtain a the press release content for a given press release. @@ -42,6 +44,7 @@ The SoftLayer_Auxiliary_Press_Release_Content service is associated with all act #### [getObject](/reference/services/SoftLayer_Auxiliary_Press_Release_Content/getObject) Retrieve a SoftLayer_Auxiliary_Press_Release_Content record. + diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Content/getObject.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Content/getObject.md index 475fcacd11..fd907c1766 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Content/getObject.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Content/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Press_Release_Content](/reference/services/SoftLayer_Auxiliary_Press_Release_Content)::getObject + Retrieve a SoftLayer_Auxiliary_Press_Release_Content record. diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner/_index.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner/_index.md index 1c6b5cdc26..843c00ef40 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner/_index.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Auxiliary_Press_Release_Media_Partner service provides all media partners associated to a press release. @@ -42,6 +44,7 @@ The SoftLayer_Auxiliary_Press_Release_Media_Partner service provides all media p #### [getObject](/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner/getObject) Retrieve a SoftLayer_Auxiliary_Press_Release_Media_Partner record. + diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner/getObject.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner/getObject.md index 635006c817..3eaad0528e 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner/getObject.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Press_Release_Media_Partner](/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner)::getObject + Retrieve a SoftLayer_Auxiliary_Press_Release_Media_Partner record. diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/_index.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/_index.md index 179b3b4438..4d1fd4ec73 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/_index.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release service associates a press release to one or more media partners. @@ -42,18 +44,21 @@ The SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release service associ #### [getMediaPartners](/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/getMediaPartners) +
              #### [getObject](/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/getObject) Retrieve a SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release record. +
              #### [getPressReleases](/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/getPressReleases) +
              diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/getMediaPartners.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/getMediaPartners.md index baf346bc99..1e8557a135 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/getMediaPartners.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/getMediaPartners.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/getObject.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/getObject.md index c87be4f30c..c043cc8935 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/getObject.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release](/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release)::getObject + Retrieve a SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release record. diff --git a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/getPressReleases.md b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/getPressReleases.md index a95ccd74c6..8ce68a8090 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/getPressReleases.md +++ b/content/reference/services/SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release/getPressReleases.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/_index.md b/content/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/_index.md index cd087b8c77..41745929c4 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/_index.md +++ b/content/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,18 +44,21 @@ classes: #### [getCourier](/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/getCourier) +
              #### [getObject](/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/getObject) Retrieve a SoftLayer_Auxiliary_Shipping_Courier_Type record. +
              #### [getTypeByKeyName](/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/getTypeByKeyName) +
              diff --git a/content/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/getCourier.md b/content/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/getCourier.md index a18a84d8c6..725e3dfe0f 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/getCourier.md +++ b/content/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/getCourier.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/getObject.md b/content/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/getObject.md index 7b6f876755..b4d2e82324 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/getObject.md +++ b/content/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Auxiliary_Shipping_Courier_Type](/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type)::getObject + Retrieve a SoftLayer_Auxiliary_Shipping_Courier_Type record. diff --git a/content/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/getTypeByKeyName.md b/content/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/getTypeByKeyName.md index 1c4e811eee..8ff8ff9cfc 100644 --- a/content/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/getTypeByKeyName.md +++ b/content/reference/services/SoftLayer_Auxiliary_Shipping_Courier_Type/getTypeByKeyName.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Currency/_index.md b/content/reference/services/SoftLayer_Billing_Currency/_index.md index 0f75c0ebef..b6bb306fe7 100644 --- a/content/reference/services/SoftLayer_Billing_Currency/_index.md +++ b/content/reference/services/SoftLayer_Billing_Currency/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,24 +44,28 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Billing_Currency/getAllObjects) +
              #### [getCurrentExchangeRate](/reference/services/SoftLayer_Billing_Currency/getCurrentExchangeRate) Retrieve the current exchange rate +
              #### [getObject](/reference/services/SoftLayer_Billing_Currency/getObject) Retrieve a SoftLayer_Billing_Currency record. +
              #### [getPrice](/reference/services/SoftLayer_Billing_Currency/getPrice) +
              diff --git a/content/reference/services/SoftLayer_Billing_Currency/getAllObjects.md b/content/reference/services/SoftLayer_Billing_Currency/getAllObjects.md index d1d47ec2fc..5ca13a91fe 100644 --- a/content/reference/services/SoftLayer_Billing_Currency/getAllObjects.md +++ b/content/reference/services/SoftLayer_Billing_Currency/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Currency/getCurrentExchangeRate.md b/content/reference/services/SoftLayer_Billing_Currency/getCurrentExchangeRate.md index 3e670c6956..dacdf5c658 100644 --- a/content/reference/services/SoftLayer_Billing_Currency/getCurrentExchangeRate.md +++ b/content/reference/services/SoftLayer_Billing_Currency/getCurrentExchangeRate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Currency](/reference/services/SoftLayer_Billing_Currency)::getCurrentExchangeRate + Retrieve the current exchange rate diff --git a/content/reference/services/SoftLayer_Billing_Currency/getObject.md b/content/reference/services/SoftLayer_Billing_Currency/getObject.md index 6fc61759f3..25011baede 100644 --- a/content/reference/services/SoftLayer_Billing_Currency/getObject.md +++ b/content/reference/services/SoftLayer_Billing_Currency/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Currency](/reference/services/SoftLayer_Billing_Currency)::getObject + Retrieve a SoftLayer_Billing_Currency record. diff --git a/content/reference/services/SoftLayer_Billing_Currency/getPrice.md b/content/reference/services/SoftLayer_Billing_Currency/getPrice.md index 0762f99307..d7b2bd5872 100644 --- a/content/reference/services/SoftLayer_Billing_Currency/getPrice.md +++ b/content/reference/services/SoftLayer_Billing_Currency/getPrice.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Currency_Country/_index.md b/content/reference/services/SoftLayer_Billing_Currency_Country/_index.md index c768c7675a..ffddcf8c92 100644 --- a/content/reference/services/SoftLayer_Billing_Currency_Country/_index.md +++ b/content/reference/services/SoftLayer_Billing_Currency_Country/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Billing_Currency_Country service provides information about what currencies a customer in a specific country is eligible to use. @@ -42,12 +44,14 @@ The SoftLayer_Billing_Currency_Country service provides information about what c #### [getCountriesWithListOfEligibleCurrencies](/reference/services/SoftLayer_Billing_Currency_Country/getCountriesWithListOfEligibleCurrencies) Get map between countries and what currencies can be supported for customers in that country. +
              #### [getObject](/reference/services/SoftLayer_Billing_Currency_Country/getObject) Retrieve a SoftLayer_Billing_Currency_Country record. +
              diff --git a/content/reference/services/SoftLayer_Billing_Currency_Country/getCountriesWithListOfEligibleCurrencies.md b/content/reference/services/SoftLayer_Billing_Currency_Country/getCountriesWithListOfEligibleCurrencies.md index 39cddbba78..dbe642728f 100644 --- a/content/reference/services/SoftLayer_Billing_Currency_Country/getCountriesWithListOfEligibleCurrencies.md +++ b/content/reference/services/SoftLayer_Billing_Currency_Country/getCountriesWithListOfEligibleCurrencies.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Currency_Country](/reference/services/SoftLayer_Billing_Currency_Country)::getCountriesWithListOfEligibleCurrencies + Get map between countries and what currencies can be supported for customers in that country. diff --git a/content/reference/services/SoftLayer_Billing_Currency_Country/getObject.md b/content/reference/services/SoftLayer_Billing_Currency_Country/getObject.md index 76f5575d75..6ef114a9ac 100644 --- a/content/reference/services/SoftLayer_Billing_Currency_Country/getObject.md +++ b/content/reference/services/SoftLayer_Billing_Currency_Country/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Currency_Country](/reference/services/SoftLayer_Billing_Currency_Country)::getObject + Retrieve a SoftLayer_Billing_Currency_Country record. diff --git a/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/_index.md b/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/_index.md index 14d74438d3..04407768b6 100644 --- a/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/_index.md +++ b/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,42 +44,49 @@ classes: #### [getAllCurrencyExchangeRates](/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getAllCurrencyExchangeRates) +
              #### [getCurrencies](/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getCurrencies) +
              #### [getExchangeRate](/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getExchangeRate) +
              #### [getFundingCurrency](/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getFundingCurrency) +
              #### [getLocalCurrency](/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getLocalCurrency) +
              #### [getObject](/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getObject) Retrieve a SoftLayer_Billing_Currency_ExchangeRate record. +
              #### [getPrice](/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getPrice) +
              diff --git a/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getAllCurrencyExchangeRates.md b/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getAllCurrencyExchangeRates.md index ebe3cc1ea4..d144018a6a 100644 --- a/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getAllCurrencyExchangeRates.md +++ b/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getAllCurrencyExchangeRates.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getCurrencies.md b/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getCurrencies.md index f86bbcc205..22b4ec911c 100644 --- a/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getCurrencies.md +++ b/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getCurrencies.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getExchangeRate.md b/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getExchangeRate.md index f60416024b..5021cad8a2 100644 --- a/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getExchangeRate.md +++ b/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getExchangeRate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getFundingCurrency.md b/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getFundingCurrency.md index b692eae12f..07e5197f16 100644 --- a/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getFundingCurrency.md +++ b/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getFundingCurrency.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getLocalCurrency.md b/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getLocalCurrency.md index 3f358990f0..3921105c31 100644 --- a/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getLocalCurrency.md +++ b/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getLocalCurrency.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getObject.md b/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getObject.md index dd119fb2dd..ecf5729c97 100644 --- a/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getObject.md +++ b/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Currency_ExchangeRate](/reference/services/SoftLayer_Billing_Currency_ExchangeRate)::getObject + Retrieve a SoftLayer_Billing_Currency_ExchangeRate record. diff --git a/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getPrice.md b/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getPrice.md index c675c524de..63e7caccfb 100644 --- a/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getPrice.md +++ b/content/reference/services/SoftLayer_Billing_Currency_ExchangeRate/getPrice.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Info/_index.md b/content/reference/services/SoftLayer_Billing_Info/_index.md index e1a80468df..38c73d66ac 100644 --- a/content/reference/services/SoftLayer_Billing_Info/_index.md +++ b/content/reference/services/SoftLayer_Billing_Info/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -44,42 +46,49 @@ Due to the sensitivity of your billing information we don't allow changing this #### [getAccount](/reference/services/SoftLayer_Billing_Info/getAccount) Retrieve the SoftLayer customer account associated with this billing information. +
              #### [getAchInformation](/reference/services/SoftLayer_Billing_Info/getAchInformation) +
              #### [getCurrency](/reference/services/SoftLayer_Billing_Info/getCurrency) Retrieve currency to be used by this customer account. +
              #### [getCurrentBillingCycle](/reference/services/SoftLayer_Billing_Info/getCurrentBillingCycle) Retrieve information related to an account's current and previous billing cycles. +
              #### [getLastBillDate](/reference/services/SoftLayer_Billing_Info/getLastBillDate) Retrieve the date on which an account was last billed. +
              #### [getNextBillDate](/reference/services/SoftLayer_Billing_Info/getNextBillDate) Retrieve the date on which an account will be billed next. +
              #### [getObject](/reference/services/SoftLayer_Billing_Info/getObject) Retrieve a SoftLayer_Billing_Info record. +
              diff --git a/content/reference/services/SoftLayer_Billing_Info/getAccount.md b/content/reference/services/SoftLayer_Billing_Info/getAccount.md index f39b82fce9..00c0c347b9 100644 --- a/content/reference/services/SoftLayer_Billing_Info/getAccount.md +++ b/content/reference/services/SoftLayer_Billing_Info/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Info](/reference/services/SoftLayer_Billing_Info)::getAccount + Retrieve the SoftLayer customer account associated with this billing information. diff --git a/content/reference/services/SoftLayer_Billing_Info/getAchInformation.md b/content/reference/services/SoftLayer_Billing_Info/getAchInformation.md index e6b54e91ca..2e0818ea58 100644 --- a/content/reference/services/SoftLayer_Billing_Info/getAchInformation.md +++ b/content/reference/services/SoftLayer_Billing_Info/getAchInformation.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Info/getCurrency.md b/content/reference/services/SoftLayer_Billing_Info/getCurrency.md index 249f874d64..7cc5a68a3d 100644 --- a/content/reference/services/SoftLayer_Billing_Info/getCurrency.md +++ b/content/reference/services/SoftLayer_Billing_Info/getCurrency.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Info](/reference/services/SoftLayer_Billing_Info)::getCurrency + Retrieve currency to be used by this customer account. diff --git a/content/reference/services/SoftLayer_Billing_Info/getCurrentBillingCycle.md b/content/reference/services/SoftLayer_Billing_Info/getCurrentBillingCycle.md index 75788e06e3..3cb368ef43 100644 --- a/content/reference/services/SoftLayer_Billing_Info/getCurrentBillingCycle.md +++ b/content/reference/services/SoftLayer_Billing_Info/getCurrentBillingCycle.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Info](/reference/services/SoftLayer_Billing_Info)::getCurrentBillingCycle + Retrieve information related to an account's current and previous billing cycles. diff --git a/content/reference/services/SoftLayer_Billing_Info/getLastBillDate.md b/content/reference/services/SoftLayer_Billing_Info/getLastBillDate.md index 82d64d3704..95ca1c7aa9 100644 --- a/content/reference/services/SoftLayer_Billing_Info/getLastBillDate.md +++ b/content/reference/services/SoftLayer_Billing_Info/getLastBillDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Info](/reference/services/SoftLayer_Billing_Info)::getLastBillDate + Retrieve the date on which an account was last billed. diff --git a/content/reference/services/SoftLayer_Billing_Info/getNextBillDate.md b/content/reference/services/SoftLayer_Billing_Info/getNextBillDate.md index c7e78b0ce2..2316d7f74b 100644 --- a/content/reference/services/SoftLayer_Billing_Info/getNextBillDate.md +++ b/content/reference/services/SoftLayer_Billing_Info/getNextBillDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Info](/reference/services/SoftLayer_Billing_Info)::getNextBillDate + Retrieve the date on which an account will be billed next. diff --git a/content/reference/services/SoftLayer_Billing_Info/getObject.md b/content/reference/services/SoftLayer_Billing_Info/getObject.md index 20ff240515..75689de880 100644 --- a/content/reference/services/SoftLayer_Billing_Info/getObject.md +++ b/content/reference/services/SoftLayer_Billing_Info/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Info](/reference/services/SoftLayer_Billing_Info)::getObject + Retrieve a SoftLayer_Billing_Info record. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/_index.md b/content/reference/services/SoftLayer_Billing_Invoice/_index.md index 9c5e5da099..d44c810e5e 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/_index.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -65,198 +67,231 @@ Query the [SoftLayer_Account]({{}}) #### [emailInvoices](/reference/services/SoftLayer_Billing_Invoice/emailInvoices) Create a transaction to email invoice links. +
              #### [getAccount](/reference/services/SoftLayer_Billing_Invoice/getAccount) Retrieve the account that an invoice belongs to. +
              #### [getAmount](/reference/services/SoftLayer_Billing_Invoice/getAmount) Retrieve this is the amount of this invoice. +
              #### [getBrandAtInvoiceCreation](/reference/services/SoftLayer_Billing_Invoice/getBrandAtInvoiceCreation) +
              #### [getDetailedPdfGeneratedFlag](/reference/services/SoftLayer_Billing_Invoice/getDetailedPdfGeneratedFlag) Retrieve a flag that will reflect whether the detailed version of the pdf has been generated. +
              #### [getExcel](/reference/services/SoftLayer_Billing_Invoice/getExcel) Retrieve a Microsoft Excel copy of an invoice. +
              #### [getInvoiceTopLevelItems](/reference/services/SoftLayer_Billing_Invoice/getInvoiceTopLevelItems) Retrieve a list of top-level invoice items that are on the currently pending invoice. +
              #### [getInvoiceTotalAmount](/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalAmount) Retrieve the total amount of this invoice. +
              #### [getInvoiceTotalOneTimeAmount](/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalOneTimeAmount) Retrieve the total one-time charges for this invoice. This is the sum of one-time charges + setup fees + labor fees. This does not include taxes. +
              #### [getInvoiceTotalOneTimeTaxAmount](/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalOneTimeTaxAmount) Retrieve a sum of all the taxes related to one time charges for this invoice. +
              #### [getInvoiceTotalPreTaxAmount](/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalPreTaxAmount) Retrieve the total amount of this invoice. This does not include taxes. +
              #### [getInvoiceTotalRecurringAmount](/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalRecurringAmount) Retrieve the total Recurring amount of this invoice. This amount does not include taxes or one time charges. +
              #### [getInvoiceTotalRecurringTaxAmount](/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalRecurringTaxAmount) Retrieve the total amount of the recurring taxes on this invoice. +
              #### [getItems](/reference/services/SoftLayer_Billing_Invoice/getItems) Retrieve the items that belong to this invoice. +
              #### [getLocalCurrencyExchangeRate](/reference/services/SoftLayer_Billing_Invoice/getLocalCurrencyExchangeRate) Retrieve exchange rate used for billing this invoice. +
              #### [getObject](/reference/services/SoftLayer_Billing_Invoice/getObject) Retrieve a SoftLayer_Billing_Invoice record. +
              #### [getPayment](/reference/services/SoftLayer_Billing_Invoice/getPayment) Retrieve this is the total payment made on this invoice. +
              #### [getPayments](/reference/services/SoftLayer_Billing_Invoice/getPayments) Retrieve the payments for the invoice. +
              #### [getPdf](/reference/services/SoftLayer_Billing_Invoice/getPdf) Retrieve a PDF copy of an invoice. +
              #### [getPdfDetailed](/reference/services/SoftLayer_Billing_Invoice/getPdfDetailed) Retrieve a PDF copy of the detailed invoice summary. +
              #### [getPdfDetailedFilename](/reference/services/SoftLayer_Billing_Invoice/getPdfDetailedFilename) Get the name of the detailed version of the PDF. +
              #### [getPdfFileSize](/reference/services/SoftLayer_Billing_Invoice/getPdfFileSize) Retrieve the size of a PDF copy of an invoice. +
              #### [getPdfFilename](/reference/services/SoftLayer_Billing_Invoice/getPdfFilename) +
              #### [getPreliminaryExcel](/reference/services/SoftLayer_Billing_Invoice/getPreliminaryExcel) Retrieve a Microsoft Excel copy of an invoice. +
              #### [getPreliminaryPdf](/reference/services/SoftLayer_Billing_Invoice/getPreliminaryPdf) Retrieve a PDF copy of an invoice. +
              #### [getPreliminaryPdfDetailed](/reference/services/SoftLayer_Billing_Invoice/getPreliminaryPdfDetailed) Retrieve a PDF copy of the detailed version of an invoice. +
              #### [getSellerRegistration](/reference/services/SoftLayer_Billing_Invoice/getSellerRegistration) Retrieve this is the seller's tax registration. +
              #### [getTaxInfo](/reference/services/SoftLayer_Billing_Invoice/getTaxInfo) Retrieve this is the tax information that applies to tax auditing. This is the official tax record for this invoice. +
              #### [getTaxInfoHistory](/reference/services/SoftLayer_Billing_Invoice/getTaxInfoHistory) Retrieve this is the set of tax information for any tax calculation for this invoice. Note that not all of these are necessarily official, so use the taxInfo key to get the final information. +
              #### [getTaxMessage](/reference/services/SoftLayer_Billing_Invoice/getTaxMessage) Retrieve this is a message explaining the tax treatment for this invoice. +
              #### [getTaxType](/reference/services/SoftLayer_Billing_Invoice/getTaxType) Retrieve this is the strategy used to calculate tax on this invoice. +
              #### [getXlsFilename](/reference/services/SoftLayer_Billing_Invoice/getXlsFilename) +
              #### [getZeroFeeItemCounts](/reference/services/SoftLayer_Billing_Invoice/getZeroFeeItemCounts) +
              diff --git a/content/reference/services/SoftLayer_Billing_Invoice/emailInvoices.md b/content/reference/services/SoftLayer_Billing_Invoice/emailInvoices.md index a1413eab7b..e9248a1e06 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/emailInvoices.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/emailInvoices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::emailInvoices + Create a transaction to email invoice links. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getAccount.md b/content/reference/services/SoftLayer_Billing_Invoice/getAccount.md index 03a8676a3e..6a20a5233c 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getAccount.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getAccount + Retrieve the account that an invoice belongs to. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getAmount.md b/content/reference/services/SoftLayer_Billing_Invoice/getAmount.md index 3c6eef3145..33bc73ca09 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getAmount.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getAmount + Retrieve this is the amount of this invoice. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getBrandAtInvoiceCreation.md b/content/reference/services/SoftLayer_Billing_Invoice/getBrandAtInvoiceCreation.md index 14b3ca305c..95df108e8e 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getBrandAtInvoiceCreation.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getBrandAtInvoiceCreation.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getDetailedPdfGeneratedFlag.md b/content/reference/services/SoftLayer_Billing_Invoice/getDetailedPdfGeneratedFlag.md index 02ceccef90..ea4ff75f15 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getDetailedPdfGeneratedFlag.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getDetailedPdfGeneratedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getDetailedPdfGeneratedFlag + Retrieve a flag that will reflect whether the detailed version of the pdf has been generated. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getExcel.md b/content/reference/services/SoftLayer_Billing_Invoice/getExcel.md index b4ccc9f454..624fff6456 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getExcel.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getExcel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getExcel + Retrieve a Microsoft Excel copy of an invoice. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTopLevelItems.md b/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTopLevelItems.md index f5c47f7805..74d7eb29fb 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTopLevelItems.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTopLevelItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getInvoiceTopLevelItems + Retrieve a list of top-level invoice items that are on the currently pending invoice. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalAmount.md b/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalAmount.md index 6d2cb4a89e..d94505bb47 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalAmount.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getInvoiceTotalAmount + Retrieve the total amount of this invoice. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalOneTimeAmount.md b/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalOneTimeAmount.md index 3b89d023ef..f7cf52d481 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalOneTimeAmount.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalOneTimeAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getInvoiceTotalOneTimeAmount + Retrieve the total one-time charges for this invoice. This is the sum of one-time charges + setup fees + labor fees. This does not include taxes. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalOneTimeTaxAmount.md b/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalOneTimeTaxAmount.md index 0f16e9bd36..f0c5dc5492 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalOneTimeTaxAmount.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalOneTimeTaxAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getInvoiceTotalOneTimeTaxAmount + Retrieve a sum of all the taxes related to one time charges for this invoice. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalPreTaxAmount.md b/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalPreTaxAmount.md index d2e8377c56..6723de450a 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalPreTaxAmount.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalPreTaxAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getInvoiceTotalPreTaxAmount + Retrieve the total amount of this invoice. This does not include taxes. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalRecurringAmount.md b/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalRecurringAmount.md index 849dedb138..be19efbbf6 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalRecurringAmount.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalRecurringAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getInvoiceTotalRecurringAmount + Retrieve the total Recurring amount of this invoice. This amount does not include taxes or one time charges. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalRecurringTaxAmount.md b/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalRecurringTaxAmount.md index 608d000443..7f80cb5bc5 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalRecurringTaxAmount.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getInvoiceTotalRecurringTaxAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getInvoiceTotalRecurringTaxAmount + Retrieve the total amount of the recurring taxes on this invoice. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getItems.md b/content/reference/services/SoftLayer_Billing_Invoice/getItems.md index 32937d5e71..6e47bd9512 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getItems.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getItems + Retrieve the items that belong to this invoice. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getLocalCurrencyExchangeRate.md b/content/reference/services/SoftLayer_Billing_Invoice/getLocalCurrencyExchangeRate.md index e4555a9d2a..16b6fd48d1 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getLocalCurrencyExchangeRate.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getLocalCurrencyExchangeRate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getLocalCurrencyExchangeRate + Retrieve exchange rate used for billing this invoice. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getObject.md b/content/reference/services/SoftLayer_Billing_Invoice/getObject.md index 22c0bc3923..76d4a29cb5 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getObject.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getObject + Retrieve a SoftLayer_Billing_Invoice record. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getPayment.md b/content/reference/services/SoftLayer_Billing_Invoice/getPayment.md index ae5009d239..b1e035376b 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getPayment.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getPayment.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getPayment + Retrieve this is the total payment made on this invoice. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getPayments.md b/content/reference/services/SoftLayer_Billing_Invoice/getPayments.md index 8e447caad2..4063faf2fb 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getPayments.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getPayments.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getPayments + Retrieve the payments for the invoice. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getPdf.md b/content/reference/services/SoftLayer_Billing_Invoice/getPdf.md index ce078c2a07..e1ff9d2d9c 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getPdf.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getPdf.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getPdf + Retrieve a PDF copy of an invoice. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getPdfDetailed.md b/content/reference/services/SoftLayer_Billing_Invoice/getPdfDetailed.md index 8b5950464f..99bd777707 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getPdfDetailed.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getPdfDetailed.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getPdfDetailed + Retrieve a PDF copy of the detailed invoice summary. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getPdfDetailedFilename.md b/content/reference/services/SoftLayer_Billing_Invoice/getPdfDetailedFilename.md index 97a06720b3..7160f6862e 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getPdfDetailedFilename.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getPdfDetailedFilename.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getPdfDetailedFilename + Get the name of the detailed version of the PDF. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getPdfFileSize.md b/content/reference/services/SoftLayer_Billing_Invoice/getPdfFileSize.md index 14820ad22d..1692fa2f36 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getPdfFileSize.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getPdfFileSize.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getPdfFileSize + Retrieve the size of a PDF copy of an invoice. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getPdfFilename.md b/content/reference/services/SoftLayer_Billing_Invoice/getPdfFilename.md index 2a2fadad05..35cfa90280 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getPdfFilename.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getPdfFilename.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getPreliminaryExcel.md b/content/reference/services/SoftLayer_Billing_Invoice/getPreliminaryExcel.md index 4eeaeb6d5c..d0c45ef7cd 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getPreliminaryExcel.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getPreliminaryExcel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getPreliminaryExcel + Retrieve a Microsoft Excel copy of an invoice. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getPreliminaryPdf.md b/content/reference/services/SoftLayer_Billing_Invoice/getPreliminaryPdf.md index 28c09170a6..1d2f41c105 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getPreliminaryPdf.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getPreliminaryPdf.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getPreliminaryPdf + Retrieve a PDF copy of an invoice. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getPreliminaryPdfDetailed.md b/content/reference/services/SoftLayer_Billing_Invoice/getPreliminaryPdfDetailed.md index cf7cfbff50..2ff7a7745e 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getPreliminaryPdfDetailed.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getPreliminaryPdfDetailed.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getPreliminaryPdfDetailed + Retrieve a PDF copy of the detailed version of an invoice. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getSellerRegistration.md b/content/reference/services/SoftLayer_Billing_Invoice/getSellerRegistration.md index 1e658bb47c..b66a960234 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getSellerRegistration.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getSellerRegistration.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getSellerRegistration + Retrieve this is the seller's tax registration. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getTaxInfo.md b/content/reference/services/SoftLayer_Billing_Invoice/getTaxInfo.md index d5ed4ad745..5cfea3d60c 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getTaxInfo.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getTaxInfo.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getTaxInfo + Retrieve this is the tax information that applies to tax auditing. This is the official tax record for this invoice. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getTaxInfoHistory.md b/content/reference/services/SoftLayer_Billing_Invoice/getTaxInfoHistory.md index 7e5f7fa45e..b51d035eaa 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getTaxInfoHistory.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getTaxInfoHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getTaxInfoHistory + Retrieve this is the set of tax information for any tax calculation for this invoice. Note that not all of these are necessarily official, so use the taxInfo key to get the final information. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getTaxMessage.md b/content/reference/services/SoftLayer_Billing_Invoice/getTaxMessage.md index 1febf54ecd..98150afc15 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getTaxMessage.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getTaxMessage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getTaxMessage + Retrieve this is a message explaining the tax treatment for this invoice. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getTaxType.md b/content/reference/services/SoftLayer_Billing_Invoice/getTaxType.md index cb46f39bf6..e1612f65b6 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getTaxType.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getTaxType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice](/reference/services/SoftLayer_Billing_Invoice)::getTaxType + Retrieve this is the strategy used to calculate tax on this invoice. diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getXlsFilename.md b/content/reference/services/SoftLayer_Billing_Invoice/getXlsFilename.md index d86a08e11e..c6fa7a2b2c 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getXlsFilename.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getXlsFilename.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Invoice/getZeroFeeItemCounts.md b/content/reference/services/SoftLayer_Billing_Invoice/getZeroFeeItemCounts.md index c635251062..8a867bc2d8 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice/getZeroFeeItemCounts.md +++ b/content/reference/services/SoftLayer_Billing_Invoice/getZeroFeeItemCounts.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/_index.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/_index.md index a0ba245c11..74f72e640b 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/_index.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,114 +44,133 @@ Every invoice item is defined in the SoftLayer_Billing_Invoice_Item service. Sof #### [getAssociatedChildren](/reference/services/SoftLayer_Billing_Invoice_Item/getAssociatedChildren) Retrieve an Invoice Item's associated child invoice items. Only parent invoice items have associated children. For instance, a server invoice item may have associated children. +
              #### [getAssociatedInvoiceItem](/reference/services/SoftLayer_Billing_Invoice_Item/getAssociatedInvoiceItem) Retrieve an Invoice Item's associated invoice item. If this is populated, it means this is an orphaned invoice item, but logically belongs to the associated invoice item. +
              #### [getBillingItem](/reference/services/SoftLayer_Billing_Invoice_Item/getBillingItem) Retrieve an Invoice Item's billing item, from which this item was generated. +
              #### [getCategory](/reference/services/SoftLayer_Billing_Invoice_Item/getCategory) Retrieve this invoice item's "item category". +
              #### [getChildren](/reference/services/SoftLayer_Billing_Invoice_Item/getChildren) Retrieve an Invoice Item's child invoice items. Only parent invoice items have children. For instance, a server invoice item will have children. +
              #### [getFilteredAssociatedChildren](/reference/services/SoftLayer_Billing_Invoice_Item/getFilteredAssociatedChildren) Retrieve an Invoice Item's associated child invoice items, excluding some items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children. +
              #### [getHourlyFlag](/reference/services/SoftLayer_Billing_Invoice_Item/getHourlyFlag) Retrieve indicating whether this invoice item is billed on an hourly basis. +
              #### [getInvoice](/reference/services/SoftLayer_Billing_Invoice_Item/getInvoice) Retrieve the invoice to which this item belongs. +
              #### [getLocation](/reference/services/SoftLayer_Billing_Invoice_Item/getLocation) Retrieve an invoice item's location, if one exists.' +
              #### [getNonZeroAssociatedChildren](/reference/services/SoftLayer_Billing_Invoice_Item/getNonZeroAssociatedChildren) Retrieve an Invoice Item's associated child invoice items, excluding ALL items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children. +
              #### [getObject](/reference/services/SoftLayer_Billing_Invoice_Item/getObject) Retrieve a SoftLayer_Billing_Invoice_Item record. +
              #### [getParent](/reference/services/SoftLayer_Billing_Invoice_Item/getParent) Retrieve every item tied to a server should have a parent invoice item which is the server line item. This is how we associate items to a server. +
              #### [getProduct](/reference/services/SoftLayer_Billing_Invoice_Item/getProduct) Retrieve the entry in the product catalog that a invoice item is based upon. +
              #### [getTopLevelProductGroupName](/reference/services/SoftLayer_Billing_Invoice_Item/getTopLevelProductGroupName) Retrieve a string representing the name of parent level product group of an invoice item. +
              #### [getTotalOneTimeAmount](/reference/services/SoftLayer_Billing_Invoice_Item/getTotalOneTimeAmount) Retrieve an invoice Item's total, including any child invoice items if they exist. +
              #### [getTotalOneTimeTaxAmount](/reference/services/SoftLayer_Billing_Invoice_Item/getTotalOneTimeTaxAmount) Retrieve an invoice Item's total, including any child invoice items if they exist. +
              #### [getTotalRecurringAmount](/reference/services/SoftLayer_Billing_Invoice_Item/getTotalRecurringAmount) Retrieve an invoice Item's total, including any child invoice items if they exist. +
              #### [getTotalRecurringTaxAmount](/reference/services/SoftLayer_Billing_Invoice_Item/getTotalRecurringTaxAmount) Retrieve a Billing Item's total, including any child billing items if they exist.' +
              #### [getUsageChargeFlag](/reference/services/SoftLayer_Billing_Invoice_Item/getUsageChargeFlag) Retrieve indicating whether this invoice item is for the usage charge. +
              diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getAssociatedChildren.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getAssociatedChildren.md index fef08c2a64..4e6b1b2322 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getAssociatedChildren.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getAssociatedChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getAssociatedChildren + Retrieve an Invoice Item's associated child invoice items. Only parent invoice items have associated children. For instance, a server invoice item may have associated children. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getAssociatedInvoiceItem.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getAssociatedInvoiceItem.md index a6b7f55f0d..e08014b5ba 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getAssociatedInvoiceItem.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getAssociatedInvoiceItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getAssociatedInvoiceItem + Retrieve an Invoice Item's associated invoice item. If this is populated, it means this is an orphaned invoice item, but logically belongs to the associated invoice item. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getBillingItem.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getBillingItem.md index ee9b53a038..327e7c7c6b 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getBillingItem.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getBillingItem + Retrieve an Invoice Item's billing item, from which this item was generated. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getCategory.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getCategory.md index cd2a3be8fc..0e232e150d 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getCategory.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getCategory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getCategory + Retrieve this invoice item's "item category". diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getChildren.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getChildren.md index 3fb11cce7f..99363b2aa0 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getChildren.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getChildren + Retrieve an Invoice Item's child invoice items. Only parent invoice items have children. For instance, a server invoice item will have children. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getFilteredAssociatedChildren.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getFilteredAssociatedChildren.md index 28209737a5..941eafd9d5 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getFilteredAssociatedChildren.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getFilteredAssociatedChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getFilteredAssociatedChildren + Retrieve an Invoice Item's associated child invoice items, excluding some items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getHourlyFlag.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getHourlyFlag.md index 6f9387207b..c3d3c8260f 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getHourlyFlag.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getHourlyFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getHourlyFlag + Retrieve indicating whether this invoice item is billed on an hourly basis. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getInvoice.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getInvoice.md index 1b6ffc41b3..086db341d8 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getInvoice.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getInvoice.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getInvoice + Retrieve the invoice to which this item belongs. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getLocation.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getLocation.md index 8734b669c3..262910cfbb 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getLocation.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getLocation + Retrieve an invoice item's location, if one exists.' diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getNonZeroAssociatedChildren.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getNonZeroAssociatedChildren.md index 48bbeb21d7..a3d65be730 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getNonZeroAssociatedChildren.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getNonZeroAssociatedChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getNonZeroAssociatedChildren + Retrieve an Invoice Item's associated child invoice items, excluding ALL items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getObject.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getObject.md index c0f135ff45..16dd92f631 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getObject.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getObject + Retrieve a SoftLayer_Billing_Invoice_Item record. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getParent.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getParent.md index 83ed37f3aa..5e43a142be 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getParent.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getParent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getParent + Retrieve every item tied to a server should have a parent invoice item which is the server line item. This is how we associate items to a server. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getProduct.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getProduct.md index 1ebdbefd30..aedce45cdc 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getProduct.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getProduct.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getProduct + Retrieve the entry in the product catalog that a invoice item is based upon. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getTopLevelProductGroupName.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getTopLevelProductGroupName.md index 92b11e3e88..8b3316ac0f 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getTopLevelProductGroupName.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getTopLevelProductGroupName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getTopLevelProductGroupName + Retrieve a string representing the name of parent level product group of an invoice item. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getTotalOneTimeAmount.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getTotalOneTimeAmount.md index 3ae15a9e34..01d81ba8fd 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getTotalOneTimeAmount.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getTotalOneTimeAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getTotalOneTimeAmount + Retrieve an invoice Item's total, including any child invoice items if they exist. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getTotalOneTimeTaxAmount.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getTotalOneTimeTaxAmount.md index 8b78c544fe..1066710570 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getTotalOneTimeTaxAmount.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getTotalOneTimeTaxAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getTotalOneTimeTaxAmount + Retrieve an invoice Item's total, including any child invoice items if they exist. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getTotalRecurringAmount.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getTotalRecurringAmount.md index a9cb575511..e9ce04318d 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getTotalRecurringAmount.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getTotalRecurringAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getTotalRecurringAmount + Retrieve an invoice Item's total, including any child invoice items if they exist. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getTotalRecurringTaxAmount.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getTotalRecurringTaxAmount.md index c9d91f3f01..4b90688093 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getTotalRecurringTaxAmount.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getTotalRecurringTaxAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getTotalRecurringTaxAmount + Retrieve a Billing Item's total, including any child billing items if they exist.' diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Item/getUsageChargeFlag.md b/content/reference/services/SoftLayer_Billing_Invoice_Item/getUsageChargeFlag.md index b6d4b99346..1c1292cf4d 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Item/getUsageChargeFlag.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Item/getUsageChargeFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Item](/reference/services/SoftLayer_Billing_Invoice_Item)::getUsageChargeFlag + Retrieve indicating whether this invoice item is for the usage charge. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Next/_index.md b/content/reference/services/SoftLayer_Billing_Invoice_Next/_index.md index b8d47c0f8c..02b8e76323 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Next/_index.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Next/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,18 +44,21 @@ Service for an account's next invoice. The "next invoice" is what a customer wil #### [getExcel](/reference/services/SoftLayer_Billing_Invoice_Next/getExcel) Retrieve the next billing period's invoice as an Excel. +
              #### [getPdf](/reference/services/SoftLayer_Billing_Invoice_Next/getPdf) Retrieve the next billing period's invoice as a PDF. +
              #### [getPdfDetailed](/reference/services/SoftLayer_Billing_Invoice_Next/getPdfDetailed) Retrieve the next billing period's detailed invoice as a PDF. +
              diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Next/getExcel.md b/content/reference/services/SoftLayer_Billing_Invoice_Next/getExcel.md index bbc92c2f2a..b42cbfe972 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Next/getExcel.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Next/getExcel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Next](/reference/services/SoftLayer_Billing_Invoice_Next)::getExcel + Retrieve the next billing period's invoice as an Excel. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Next/getPdf.md b/content/reference/services/SoftLayer_Billing_Invoice_Next/getPdf.md index a77971c6ca..a8a0f17dcb 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Next/getPdf.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Next/getPdf.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Next](/reference/services/SoftLayer_Billing_Invoice_Next)::getPdf + Retrieve the next billing period's invoice as a PDF. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Next/getPdfDetailed.md b/content/reference/services/SoftLayer_Billing_Invoice_Next/getPdfDetailed.md index 28f30a305b..eb98932c1a 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Next/getPdfDetailed.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Next/getPdfDetailed.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Next](/reference/services/SoftLayer_Billing_Invoice_Next)::getPdfDetailed + Retrieve the next billing period's detailed invoice as a PDF. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Tax_Status/_index.md b/content/reference/services/SoftLayer_Billing_Invoice_Tax_Status/_index.md index 54dd4a4f15..322f215c92 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Tax_Status/_index.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Tax_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,12 +52,14 @@ Invoice tax status allows the SoftLayer system to track the status of an invoice #### [getAllObjects](/reference/services/SoftLayer_Billing_Invoice_Tax_Status/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_Billing_Invoice_Tax_Status/getObject) Retrieve a SoftLayer_Billing_Invoice_Tax_Status record. +
              diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Tax_Status/getAllObjects.md b/content/reference/services/SoftLayer_Billing_Invoice_Tax_Status/getAllObjects.md index 22694fbb44..933af3229a 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Tax_Status/getAllObjects.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Tax_Status/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Tax_Status/getObject.md b/content/reference/services/SoftLayer_Billing_Invoice_Tax_Status/getObject.md index b59edab028..36f6cae625 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Tax_Status/getObject.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Tax_Status/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Tax_Status](/reference/services/SoftLayer_Billing_Invoice_Tax_Status)::getObject + Retrieve a SoftLayer_Billing_Invoice_Tax_Status record. diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Tax_Type/_index.md b/content/reference/services/SoftLayer_Billing_Invoice_Tax_Type/_index.md index 5d98d7a143..425e6ff564 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Tax_Type/_index.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Tax_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,12 +52,14 @@ Invoice tax types allows the SoftLayer system to categorize the different strate #### [getAllObjects](/reference/services/SoftLayer_Billing_Invoice_Tax_Type/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_Billing_Invoice_Tax_Type/getObject) Retrieve a SoftLayer_Billing_Invoice_Tax_Type record. +
              diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Tax_Type/getAllObjects.md b/content/reference/services/SoftLayer_Billing_Invoice_Tax_Type/getAllObjects.md index 48f96a0342..f64a729ba4 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Tax_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Tax_Type/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Invoice_Tax_Type/getObject.md b/content/reference/services/SoftLayer_Billing_Invoice_Tax_Type/getObject.md index fc179f7f1a..8420388722 100644 --- a/content/reference/services/SoftLayer_Billing_Invoice_Tax_Type/getObject.md +++ b/content/reference/services/SoftLayer_Billing_Invoice_Tax_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Invoice_Tax_Type](/reference/services/SoftLayer_Billing_Invoice_Tax_Type)::getObject + Retrieve a SoftLayer_Billing_Invoice_Tax_Type record. diff --git a/content/reference/services/SoftLayer_Billing_Item/_index.md b/content/reference/services/SoftLayer_Billing_Item/_index.md index 6b1637652d..861574570f 100644 --- a/content/reference/services/SoftLayer_Billing_Item/_index.md +++ b/content/reference/services/SoftLayer_Billing_Item/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) 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. @@ -44,348 +46,406 @@ Billing items exist in a tree relationship. Items are associated with each other #### [cancelItem](/reference/services/SoftLayer_Billing_Item/cancelItem) Cancel a service or resource. +
              #### [cancelService](/reference/services/SoftLayer_Billing_Item/cancelService) Cancel a service or resource immediately. This does not include bare metal servers. +
              #### [cancelServiceOnAnniversaryDate](/reference/services/SoftLayer_Billing_Item/cancelServiceOnAnniversaryDate) Cancel a service or resource on the next bill date +
              #### [getAccount](/reference/services/SoftLayer_Billing_Item/getAccount) Retrieve the account that a billing item belongs to. +
              #### [getActiveAgreement](/reference/services/SoftLayer_Billing_Item/getActiveAgreement) +
              #### [getActiveAgreementFlag](/reference/services/SoftLayer_Billing_Item/getActiveAgreementFlag) Retrieve a flag indicating that the billing item is under an active agreement. +
              #### [getActiveAssociatedChildren](/reference/services/SoftLayer_Billing_Item/getActiveAssociatedChildren) Retrieve a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. +
              #### [getActiveAssociatedGuestDiskBillingItems](/reference/services/SoftLayer_Billing_Item/getActiveAssociatedGuestDiskBillingItems) +
              #### [getActiveBundledItems](/reference/services/SoftLayer_Billing_Item/getActiveBundledItems) Retrieve a Billing Item's active bundled billing items. +
              #### [getActiveCancellationItem](/reference/services/SoftLayer_Billing_Item/getActiveCancellationItem) Retrieve a service cancellation request item that corresponds to the billing item. +
              #### [getActiveChildren](/reference/services/SoftLayer_Billing_Item/getActiveChildren) Retrieve a Billing Item's active child billing items. +
              #### [getActiveFlag](/reference/services/SoftLayer_Billing_Item/getActiveFlag) +
              #### [getActiveSparePoolAssociatedGuestDiskBillingItems](/reference/services/SoftLayer_Billing_Item/getActiveSparePoolAssociatedGuestDiskBillingItems) +
              #### [getActiveSparePoolBundledItems](/reference/services/SoftLayer_Billing_Item/getActiveSparePoolBundledItems) Retrieve a Billing Item's spare pool bundled billing items. +
              #### [getAssociatedBillingItem](/reference/services/SoftLayer_Billing_Item/getAssociatedBillingItem) Retrieve a billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. +
              #### [getAssociatedBillingItemHistory](/reference/services/SoftLayer_Billing_Item/getAssociatedBillingItemHistory) Retrieve a history of billing items which a billing item has been associated with. +
              #### [getAssociatedChildren](/reference/services/SoftLayer_Billing_Item/getAssociatedChildren) Retrieve a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. +
              #### [getAssociatedParent](/reference/services/SoftLayer_Billing_Item/getAssociatedParent) Retrieve a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. +
              #### [getAvailableMatchingVlans](/reference/services/SoftLayer_Billing_Item/getAvailableMatchingVlans) +
              #### [getBandwidthAllocation](/reference/services/SoftLayer_Billing_Item/getBandwidthAllocation) Retrieve the bandwidth allocation for a billing item. +
              #### [getBillableChildren](/reference/services/SoftLayer_Billing_Item/getBillableChildren) Retrieve a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. +
              #### [getBundleItems](/reference/services/SoftLayer_Billing_Item/getBundleItems) Retrieve a Billing Item's bundled billing items +
              #### [getBundledItems](/reference/services/SoftLayer_Billing_Item/getBundledItems) Retrieve a Billing Item's bundled billing items' +
              #### [getCanceledChildren](/reference/services/SoftLayer_Billing_Item/getCanceledChildren) Retrieve a Billing Item's active child billing items. +
              #### [getCancellationReason](/reference/services/SoftLayer_Billing_Item/getCancellationReason) Retrieve the billing item's cancellation reason. +
              #### [getCancellationRequests](/reference/services/SoftLayer_Billing_Item/getCancellationRequests) Retrieve this will return any cancellation requests that are associated with this billing item. +
              #### [getCategory](/reference/services/SoftLayer_Billing_Item/getCategory) Retrieve the item category to which the billing item's item belongs. +
              #### [getChildren](/reference/services/SoftLayer_Billing_Item/getChildren) Retrieve a Billing Item's child billing items' +
              #### [getChildrenWithActiveAgreement](/reference/services/SoftLayer_Billing_Item/getChildrenWithActiveAgreement) Retrieve a Billing Item's active child billing items. +
              #### [getDowngradeItems](/reference/services/SoftLayer_Billing_Item/getDowngradeItems) Retrieve for product items which have a downgrade path defined, this will return those product items. +
              #### [getFilteredNextInvoiceChildren](/reference/services/SoftLayer_Billing_Item/getFilteredNextInvoiceChildren) Retrieve a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. +
              #### [getHourlyFlag](/reference/services/SoftLayer_Billing_Item/getHourlyFlag) Retrieve a flag that will reflect whether this billing item is billed on an hourly basis or not. +
              #### [getInvoiceItem](/reference/services/SoftLayer_Billing_Item/getInvoiceItem) Retrieve invoice items associated with this billing item +
              #### [getInvoiceItems](/reference/services/SoftLayer_Billing_Item/getInvoiceItems) Retrieve all invoice items associated with the billing item +
              #### [getItem](/reference/services/SoftLayer_Billing_Item/getItem) Retrieve the entry in the SoftLayer product catalog that a billing item is based upon. +
              #### [getLocation](/reference/services/SoftLayer_Billing_Item/getLocation) Retrieve the location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. +
              #### [getNextInvoiceChildren](/reference/services/SoftLayer_Billing_Item/getNextInvoiceChildren) Retrieve a Billing Item's child billing items and associated items' +
              #### [getNextInvoiceTotalOneTimeAmount](/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalOneTimeAmount) Retrieve a Billing Item's total, including any child billing items if they exist.' +
              #### [getNextInvoiceTotalOneTimeTaxAmount](/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalOneTimeTaxAmount) Retrieve a Billing Item's total, including any child billing items if they exist.' +
              #### [getNextInvoiceTotalRecurringAmount](/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalRecurringAmount) Retrieve a Billing Item's total, including any child billing items and associated billing items if they exist.' +
              #### [getNextInvoiceTotalRecurringTaxAmount](/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalRecurringTaxAmount) Retrieve this is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. +
              #### [getNonZeroNextInvoiceChildren](/reference/services/SoftLayer_Billing_Item/getNonZeroNextInvoiceChildren) Retrieve a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. +
              #### [getObject](/reference/services/SoftLayer_Billing_Item/getObject) Retrieve a SoftLayer_Billing_Item record. +
              #### [getOrderItem](/reference/services/SoftLayer_Billing_Item/getOrderItem) Retrieve a billing item's original order item. Simply a reference to the original order from which this billing item was created. +
              #### [getOriginalLocation](/reference/services/SoftLayer_Billing_Item/getOriginalLocation) Retrieve the original physical location for this billing item--may differ from current. +
              #### [getPackage](/reference/services/SoftLayer_Billing_Item/getPackage) Retrieve the package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. +
              #### [getParent](/reference/services/SoftLayer_Billing_Item/getParent) Retrieve a billing item's parent item. If a billing item has no parent item then this value is null. +
              #### [getParentVirtualGuestBillingItem](/reference/services/SoftLayer_Billing_Item/getParentVirtualGuestBillingItem) Retrieve a billing item's parent item. If a billing item has no parent item then this value is null. +
              #### [getPendingCancellationFlag](/reference/services/SoftLayer_Billing_Item/getPendingCancellationFlag) Retrieve this flag indicates whether a billing item is scheduled to be canceled or not. +
              #### [getPendingOrderItem](/reference/services/SoftLayer_Billing_Item/getPendingOrderItem) Retrieve the new order item that will replace this billing item. +
              #### [getProvisionTransaction](/reference/services/SoftLayer_Billing_Item/getProvisionTransaction) Retrieve provisioning transaction for this billing item +
              #### [getServiceBillingItemsByCategory](/reference/services/SoftLayer_Billing_Item/getServiceBillingItemsByCategory) Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel. +
              #### [getSoftwareDescription](/reference/services/SoftLayer_Billing_Item/getSoftwareDescription) Retrieve a friendly description of software component +
              #### [getUpgradeItem](/reference/services/SoftLayer_Billing_Item/getUpgradeItem) Retrieve billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. +
              #### [getUpgradeItems](/reference/services/SoftLayer_Billing_Item/getUpgradeItems) Retrieve billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. +
              #### [removeAssociationId](/reference/services/SoftLayer_Billing_Item/removeAssociationId) Remove an association from an orphan billing item. +
              #### [setAssociationId](/reference/services/SoftLayer_Billing_Item/setAssociationId) Set the associated billing item for an orphan billing item. +
              #### [voidCancelService](/reference/services/SoftLayer_Billing_Item/voidCancelService) Void a service cancellation that was previously made. +
              diff --git a/content/reference/services/SoftLayer_Billing_Item/cancelItem.md b/content/reference/services/SoftLayer_Billing_Item/cancelItem.md index 65b5eaed53..b84342c0eb 100644 --- a/content/reference/services/SoftLayer_Billing_Item/cancelItem.md +++ b/content/reference/services/SoftLayer_Billing_Item/cancelItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::cancelItem + Cancel a service or resource. diff --git a/content/reference/services/SoftLayer_Billing_Item/cancelService.md b/content/reference/services/SoftLayer_Billing_Item/cancelService.md index 5dc38ef276..8fc77edb3d 100644 --- a/content/reference/services/SoftLayer_Billing_Item/cancelService.md +++ b/content/reference/services/SoftLayer_Billing_Item/cancelService.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::cancelService + Cancel a service or resource immediately. This does not include bare metal servers. diff --git a/content/reference/services/SoftLayer_Billing_Item/cancelServiceOnAnniversaryDate.md b/content/reference/services/SoftLayer_Billing_Item/cancelServiceOnAnniversaryDate.md index ec77fcc837..d24e8a2a83 100644 --- a/content/reference/services/SoftLayer_Billing_Item/cancelServiceOnAnniversaryDate.md +++ b/content/reference/services/SoftLayer_Billing_Item/cancelServiceOnAnniversaryDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::cancelServiceOnAnniversaryDate + Cancel a service or resource on the next bill date diff --git a/content/reference/services/SoftLayer_Billing_Item/getAccount.md b/content/reference/services/SoftLayer_Billing_Item/getAccount.md index 8be5358038..67516827a2 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getAccount.md +++ b/content/reference/services/SoftLayer_Billing_Item/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getAccount + Retrieve the account that a billing item belongs to. diff --git a/content/reference/services/SoftLayer_Billing_Item/getActiveAgreement.md b/content/reference/services/SoftLayer_Billing_Item/getActiveAgreement.md index e85b7c26b2..643a60b8aa 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getActiveAgreement.md +++ b/content/reference/services/SoftLayer_Billing_Item/getActiveAgreement.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Item/getActiveAgreementFlag.md b/content/reference/services/SoftLayer_Billing_Item/getActiveAgreementFlag.md index 8ea96b6296..fa251f8533 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getActiveAgreementFlag.md +++ b/content/reference/services/SoftLayer_Billing_Item/getActiveAgreementFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getActiveAgreementFlag + Retrieve a flag indicating that the billing item is under an active agreement. diff --git a/content/reference/services/SoftLayer_Billing_Item/getActiveAssociatedChildren.md b/content/reference/services/SoftLayer_Billing_Item/getActiveAssociatedChildren.md index 0d26742ab9..5c062a8876 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getActiveAssociatedChildren.md +++ b/content/reference/services/SoftLayer_Billing_Item/getActiveAssociatedChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getActiveAssociatedChildren + Retrieve a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. diff --git a/content/reference/services/SoftLayer_Billing_Item/getActiveAssociatedGuestDiskBillingItems.md b/content/reference/services/SoftLayer_Billing_Item/getActiveAssociatedGuestDiskBillingItems.md index 7da705d7fc..80698b4dd4 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getActiveAssociatedGuestDiskBillingItems.md +++ b/content/reference/services/SoftLayer_Billing_Item/getActiveAssociatedGuestDiskBillingItems.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Item/getActiveBundledItems.md b/content/reference/services/SoftLayer_Billing_Item/getActiveBundledItems.md index bc7849f2df..c34849e127 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getActiveBundledItems.md +++ b/content/reference/services/SoftLayer_Billing_Item/getActiveBundledItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getActiveBundledItems + Retrieve a Billing Item's active bundled billing items. diff --git a/content/reference/services/SoftLayer_Billing_Item/getActiveCancellationItem.md b/content/reference/services/SoftLayer_Billing_Item/getActiveCancellationItem.md index a46091318d..dc8286e9c2 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getActiveCancellationItem.md +++ b/content/reference/services/SoftLayer_Billing_Item/getActiveCancellationItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getActiveCancellationItem + Retrieve a service cancellation request item that corresponds to the billing item. diff --git a/content/reference/services/SoftLayer_Billing_Item/getActiveChildren.md b/content/reference/services/SoftLayer_Billing_Item/getActiveChildren.md index 21d8720f17..9cc935ce5e 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getActiveChildren.md +++ b/content/reference/services/SoftLayer_Billing_Item/getActiveChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getActiveChildren + Retrieve a Billing Item's active child billing items. diff --git a/content/reference/services/SoftLayer_Billing_Item/getActiveFlag.md b/content/reference/services/SoftLayer_Billing_Item/getActiveFlag.md index ef86a37415..f265cdf359 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getActiveFlag.md +++ b/content/reference/services/SoftLayer_Billing_Item/getActiveFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Item/getActiveSparePoolAssociatedGuestDiskBillingItems.md b/content/reference/services/SoftLayer_Billing_Item/getActiveSparePoolAssociatedGuestDiskBillingItems.md index 35ca8d14e7..bd2f05d904 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getActiveSparePoolAssociatedGuestDiskBillingItems.md +++ b/content/reference/services/SoftLayer_Billing_Item/getActiveSparePoolAssociatedGuestDiskBillingItems.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Item/getActiveSparePoolBundledItems.md b/content/reference/services/SoftLayer_Billing_Item/getActiveSparePoolBundledItems.md index 9c539e6acb..ba35916e42 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getActiveSparePoolBundledItems.md +++ b/content/reference/services/SoftLayer_Billing_Item/getActiveSparePoolBundledItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getActiveSparePoolBundledItems + Retrieve a Billing Item's spare pool bundled billing items. diff --git a/content/reference/services/SoftLayer_Billing_Item/getAssociatedBillingItem.md b/content/reference/services/SoftLayer_Billing_Item/getAssociatedBillingItem.md index 29b592071f..b6771adda6 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getAssociatedBillingItem.md +++ b/content/reference/services/SoftLayer_Billing_Item/getAssociatedBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getAssociatedBillingItem + Retrieve a billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. diff --git a/content/reference/services/SoftLayer_Billing_Item/getAssociatedBillingItemHistory.md b/content/reference/services/SoftLayer_Billing_Item/getAssociatedBillingItemHistory.md index 2108dc03e0..0edecfe025 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getAssociatedBillingItemHistory.md +++ b/content/reference/services/SoftLayer_Billing_Item/getAssociatedBillingItemHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getAssociatedBillingItemHistory + Retrieve a history of billing items which a billing item has been associated with. diff --git a/content/reference/services/SoftLayer_Billing_Item/getAssociatedChildren.md b/content/reference/services/SoftLayer_Billing_Item/getAssociatedChildren.md index e764573dbf..ffb40e6ad6 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getAssociatedChildren.md +++ b/content/reference/services/SoftLayer_Billing_Item/getAssociatedChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getAssociatedChildren + Retrieve a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. diff --git a/content/reference/services/SoftLayer_Billing_Item/getAssociatedParent.md b/content/reference/services/SoftLayer_Billing_Item/getAssociatedParent.md index a2e86cfac6..68d8a84a3d 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getAssociatedParent.md +++ b/content/reference/services/SoftLayer_Billing_Item/getAssociatedParent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getAssociatedParent + Retrieve a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. diff --git a/content/reference/services/SoftLayer_Billing_Item/getAvailableMatchingVlans.md b/content/reference/services/SoftLayer_Billing_Item/getAvailableMatchingVlans.md index 3e79b1b66c..776046e2cb 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getAvailableMatchingVlans.md +++ b/content/reference/services/SoftLayer_Billing_Item/getAvailableMatchingVlans.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Item/getBandwidthAllocation.md b/content/reference/services/SoftLayer_Billing_Item/getBandwidthAllocation.md index bdc9eb09bd..cb91029613 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getBandwidthAllocation.md +++ b/content/reference/services/SoftLayer_Billing_Item/getBandwidthAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getBandwidthAllocation + Retrieve the bandwidth allocation for a billing item. diff --git a/content/reference/services/SoftLayer_Billing_Item/getBillableChildren.md b/content/reference/services/SoftLayer_Billing_Item/getBillableChildren.md index 02c33885e9..35469a45ac 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getBillableChildren.md +++ b/content/reference/services/SoftLayer_Billing_Item/getBillableChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getBillableChildren + Retrieve a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. diff --git a/content/reference/services/SoftLayer_Billing_Item/getBundleItems.md b/content/reference/services/SoftLayer_Billing_Item/getBundleItems.md index 5cc083de54..f6702b7c31 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getBundleItems.md +++ b/content/reference/services/SoftLayer_Billing_Item/getBundleItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getBundleItems + Retrieve a Billing Item's bundled billing items diff --git a/content/reference/services/SoftLayer_Billing_Item/getBundledItems.md b/content/reference/services/SoftLayer_Billing_Item/getBundledItems.md index 56e8df95af..ed07a72fe1 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getBundledItems.md +++ b/content/reference/services/SoftLayer_Billing_Item/getBundledItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getBundledItems + Retrieve a Billing Item's bundled billing items' diff --git a/content/reference/services/SoftLayer_Billing_Item/getCanceledChildren.md b/content/reference/services/SoftLayer_Billing_Item/getCanceledChildren.md index 690a42484d..9d8d7e87b8 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getCanceledChildren.md +++ b/content/reference/services/SoftLayer_Billing_Item/getCanceledChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getCanceledChildren + Retrieve a Billing Item's active child billing items. diff --git a/content/reference/services/SoftLayer_Billing_Item/getCancellationReason.md b/content/reference/services/SoftLayer_Billing_Item/getCancellationReason.md index 5001a03082..8bff336573 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getCancellationReason.md +++ b/content/reference/services/SoftLayer_Billing_Item/getCancellationReason.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getCancellationReason + Retrieve the billing item's cancellation reason. diff --git a/content/reference/services/SoftLayer_Billing_Item/getCancellationRequests.md b/content/reference/services/SoftLayer_Billing_Item/getCancellationRequests.md index 0698dabd21..392d705a9c 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getCancellationRequests.md +++ b/content/reference/services/SoftLayer_Billing_Item/getCancellationRequests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getCancellationRequests + Retrieve this will return any cancellation requests that are associated with this billing item. diff --git a/content/reference/services/SoftLayer_Billing_Item/getCategory.md b/content/reference/services/SoftLayer_Billing_Item/getCategory.md index 37da3ebcb9..c70749a495 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getCategory.md +++ b/content/reference/services/SoftLayer_Billing_Item/getCategory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getCategory + Retrieve the item category to which the billing item's item belongs. diff --git a/content/reference/services/SoftLayer_Billing_Item/getChildren.md b/content/reference/services/SoftLayer_Billing_Item/getChildren.md index 6f57f6eb60..fbe7338371 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getChildren.md +++ b/content/reference/services/SoftLayer_Billing_Item/getChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getChildren + Retrieve a Billing Item's child billing items' diff --git a/content/reference/services/SoftLayer_Billing_Item/getChildrenWithActiveAgreement.md b/content/reference/services/SoftLayer_Billing_Item/getChildrenWithActiveAgreement.md index d2de173a63..313db1852d 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getChildrenWithActiveAgreement.md +++ b/content/reference/services/SoftLayer_Billing_Item/getChildrenWithActiveAgreement.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getChildrenWithActiveAgreement + Retrieve a Billing Item's active child billing items. diff --git a/content/reference/services/SoftLayer_Billing_Item/getDowngradeItems.md b/content/reference/services/SoftLayer_Billing_Item/getDowngradeItems.md index 75db4bc276..d59cc125ae 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getDowngradeItems.md +++ b/content/reference/services/SoftLayer_Billing_Item/getDowngradeItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getDowngradeItems + Retrieve for product items which have a downgrade path defined, this will return those product items. diff --git a/content/reference/services/SoftLayer_Billing_Item/getFilteredNextInvoiceChildren.md b/content/reference/services/SoftLayer_Billing_Item/getFilteredNextInvoiceChildren.md index 31f121b957..38b23854bc 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getFilteredNextInvoiceChildren.md +++ b/content/reference/services/SoftLayer_Billing_Item/getFilteredNextInvoiceChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getFilteredNextInvoiceChildren + Retrieve a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. diff --git a/content/reference/services/SoftLayer_Billing_Item/getHourlyFlag.md b/content/reference/services/SoftLayer_Billing_Item/getHourlyFlag.md index bbc714d8be..f2ec8c57e3 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getHourlyFlag.md +++ b/content/reference/services/SoftLayer_Billing_Item/getHourlyFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getHourlyFlag + Retrieve a flag that will reflect whether this billing item is billed on an hourly basis or not. diff --git a/content/reference/services/SoftLayer_Billing_Item/getInvoiceItem.md b/content/reference/services/SoftLayer_Billing_Item/getInvoiceItem.md index 5e858912d4..800ac9c95c 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getInvoiceItem.md +++ b/content/reference/services/SoftLayer_Billing_Item/getInvoiceItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getInvoiceItem + Retrieve invoice items associated with this billing item diff --git a/content/reference/services/SoftLayer_Billing_Item/getInvoiceItems.md b/content/reference/services/SoftLayer_Billing_Item/getInvoiceItems.md index b4cf9a92b0..2d79b70dac 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getInvoiceItems.md +++ b/content/reference/services/SoftLayer_Billing_Item/getInvoiceItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getInvoiceItems + Retrieve all invoice items associated with the billing item diff --git a/content/reference/services/SoftLayer_Billing_Item/getItem.md b/content/reference/services/SoftLayer_Billing_Item/getItem.md index ac11d43c4a..2e67351f13 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getItem.md +++ b/content/reference/services/SoftLayer_Billing_Item/getItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getItem + Retrieve the entry in the SoftLayer product catalog that a billing item is based upon. diff --git a/content/reference/services/SoftLayer_Billing_Item/getLocation.md b/content/reference/services/SoftLayer_Billing_Item/getLocation.md index 394c62d955..2e037d68e1 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getLocation.md +++ b/content/reference/services/SoftLayer_Billing_Item/getLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getLocation + Retrieve the location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. diff --git a/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceChildren.md b/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceChildren.md index fcd1439a7e..df03bddc65 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceChildren.md +++ b/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getNextInvoiceChildren + Retrieve a Billing Item's child billing items and associated items' diff --git a/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalOneTimeAmount.md b/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalOneTimeAmount.md index 92132adb1b..66a5b29d45 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalOneTimeAmount.md +++ b/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalOneTimeAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getNextInvoiceTotalOneTimeAmount + Retrieve a Billing Item's total, including any child billing items if they exist.' diff --git a/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalOneTimeTaxAmount.md b/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalOneTimeTaxAmount.md index 58676b4313..f7050c254a 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalOneTimeTaxAmount.md +++ b/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalOneTimeTaxAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getNextInvoiceTotalOneTimeTaxAmount + Retrieve a Billing Item's total, including any child billing items if they exist.' diff --git a/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalRecurringAmount.md b/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalRecurringAmount.md index b0969d4787..2789215e44 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalRecurringAmount.md +++ b/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalRecurringAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getNextInvoiceTotalRecurringAmount + Retrieve a Billing Item's total, including any child billing items and associated billing items if they exist.' diff --git a/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalRecurringTaxAmount.md b/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalRecurringTaxAmount.md index 3e20669c24..569508b0f0 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalRecurringTaxAmount.md +++ b/content/reference/services/SoftLayer_Billing_Item/getNextInvoiceTotalRecurringTaxAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getNextInvoiceTotalRecurringTaxAmount + Retrieve this is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. diff --git a/content/reference/services/SoftLayer_Billing_Item/getNonZeroNextInvoiceChildren.md b/content/reference/services/SoftLayer_Billing_Item/getNonZeroNextInvoiceChildren.md index ee02b1f0b9..dcb05e04f3 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getNonZeroNextInvoiceChildren.md +++ b/content/reference/services/SoftLayer_Billing_Item/getNonZeroNextInvoiceChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getNonZeroNextInvoiceChildren + Retrieve a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. diff --git a/content/reference/services/SoftLayer_Billing_Item/getObject.md b/content/reference/services/SoftLayer_Billing_Item/getObject.md index f4bc7d22a0..9ae5c60dd1 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getObject.md +++ b/content/reference/services/SoftLayer_Billing_Item/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getObject + Retrieve a SoftLayer_Billing_Item record. diff --git a/content/reference/services/SoftLayer_Billing_Item/getOrderItem.md b/content/reference/services/SoftLayer_Billing_Item/getOrderItem.md index 3b37bd0e45..f6369d06e1 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getOrderItem.md +++ b/content/reference/services/SoftLayer_Billing_Item/getOrderItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getOrderItem + Retrieve a billing item's original order item. Simply a reference to the original order from which this billing item was created. diff --git a/content/reference/services/SoftLayer_Billing_Item/getOriginalLocation.md b/content/reference/services/SoftLayer_Billing_Item/getOriginalLocation.md index 07c04939cb..a18e0c33c1 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getOriginalLocation.md +++ b/content/reference/services/SoftLayer_Billing_Item/getOriginalLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getOriginalLocation + Retrieve the original physical location for this billing item--may differ from current. diff --git a/content/reference/services/SoftLayer_Billing_Item/getPackage.md b/content/reference/services/SoftLayer_Billing_Item/getPackage.md index 7e713ede85..9c2c0d73db 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getPackage.md +++ b/content/reference/services/SoftLayer_Billing_Item/getPackage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getPackage + Retrieve the package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. diff --git a/content/reference/services/SoftLayer_Billing_Item/getParent.md b/content/reference/services/SoftLayer_Billing_Item/getParent.md index ff4d2435e3..9dc87c3385 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getParent.md +++ b/content/reference/services/SoftLayer_Billing_Item/getParent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getParent + Retrieve a billing item's parent item. If a billing item has no parent item then this value is null. diff --git a/content/reference/services/SoftLayer_Billing_Item/getParentVirtualGuestBillingItem.md b/content/reference/services/SoftLayer_Billing_Item/getParentVirtualGuestBillingItem.md index 92ecf1c26e..1d7492755c 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getParentVirtualGuestBillingItem.md +++ b/content/reference/services/SoftLayer_Billing_Item/getParentVirtualGuestBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getParentVirtualGuestBillingItem + Retrieve a billing item's parent item. If a billing item has no parent item then this value is null. diff --git a/content/reference/services/SoftLayer_Billing_Item/getPendingCancellationFlag.md b/content/reference/services/SoftLayer_Billing_Item/getPendingCancellationFlag.md index aec3e0ed8a..fd57182257 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getPendingCancellationFlag.md +++ b/content/reference/services/SoftLayer_Billing_Item/getPendingCancellationFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getPendingCancellationFlag + Retrieve this flag indicates whether a billing item is scheduled to be canceled or not. diff --git a/content/reference/services/SoftLayer_Billing_Item/getPendingOrderItem.md b/content/reference/services/SoftLayer_Billing_Item/getPendingOrderItem.md index 96a8bf799f..d6fb04c3f9 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getPendingOrderItem.md +++ b/content/reference/services/SoftLayer_Billing_Item/getPendingOrderItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getPendingOrderItem + Retrieve the new order item that will replace this billing item. diff --git a/content/reference/services/SoftLayer_Billing_Item/getProvisionTransaction.md b/content/reference/services/SoftLayer_Billing_Item/getProvisionTransaction.md index 35185f1387..40173dbaa7 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getProvisionTransaction.md +++ b/content/reference/services/SoftLayer_Billing_Item/getProvisionTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getProvisionTransaction + Retrieve provisioning transaction for this billing item diff --git a/content/reference/services/SoftLayer_Billing_Item/getServiceBillingItemsByCategory.md b/content/reference/services/SoftLayer_Billing_Item/getServiceBillingItemsByCategory.md index 0367927d0a..47bfb576de 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getServiceBillingItemsByCategory.md +++ b/content/reference/services/SoftLayer_Billing_Item/getServiceBillingItemsByCategory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getServiceBillingItemsByCategory + Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel. diff --git a/content/reference/services/SoftLayer_Billing_Item/getSoftwareDescription.md b/content/reference/services/SoftLayer_Billing_Item/getSoftwareDescription.md index edf4246051..3a19e9737b 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getSoftwareDescription.md +++ b/content/reference/services/SoftLayer_Billing_Item/getSoftwareDescription.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getSoftwareDescription + Retrieve a friendly description of software component diff --git a/content/reference/services/SoftLayer_Billing_Item/getUpgradeItem.md b/content/reference/services/SoftLayer_Billing_Item/getUpgradeItem.md index 7074ced9ac..d45ac7f849 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getUpgradeItem.md +++ b/content/reference/services/SoftLayer_Billing_Item/getUpgradeItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getUpgradeItem + Retrieve billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. diff --git a/content/reference/services/SoftLayer_Billing_Item/getUpgradeItems.md b/content/reference/services/SoftLayer_Billing_Item/getUpgradeItems.md index 810525d653..955910d74f 100644 --- a/content/reference/services/SoftLayer_Billing_Item/getUpgradeItems.md +++ b/content/reference/services/SoftLayer_Billing_Item/getUpgradeItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::getUpgradeItems + Retrieve billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. diff --git a/content/reference/services/SoftLayer_Billing_Item/removeAssociationId.md b/content/reference/services/SoftLayer_Billing_Item/removeAssociationId.md index dac2d43fb0..b54888c61e 100644 --- a/content/reference/services/SoftLayer_Billing_Item/removeAssociationId.md +++ b/content/reference/services/SoftLayer_Billing_Item/removeAssociationId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::removeAssociationId + Remove an association from an orphan billing item. diff --git a/content/reference/services/SoftLayer_Billing_Item/setAssociationId.md b/content/reference/services/SoftLayer_Billing_Item/setAssociationId.md index e972fbfbf0..19972681c4 100644 --- a/content/reference/services/SoftLayer_Billing_Item/setAssociationId.md +++ b/content/reference/services/SoftLayer_Billing_Item/setAssociationId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::setAssociationId + Set the associated billing item for an orphan billing item. diff --git a/content/reference/services/SoftLayer_Billing_Item/voidCancelService.md b/content/reference/services/SoftLayer_Billing_Item/voidCancelService.md index 305693f7ad..4960fc652b 100644 --- a/content/reference/services/SoftLayer_Billing_Item/voidCancelService.md +++ b/content/reference/services/SoftLayer_Billing_Item/voidCancelService.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item](/reference/services/SoftLayer_Billing_Item)::voidCancelService + Void a service cancellation that was previously made. diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/_index.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/_index.md index 21ded95151..ef09c8ec68 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/_index.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,30 +44,35 @@ classes: #### [getAllCancellationReasons](/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getAllCancellationReasons) Retrieve all available cancellation reasons. +
              #### [getBillingCancellationReasonCategory](/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getBillingCancellationReasonCategory) Retrieve an billing cancellation reason category. +
              #### [getBillingItems](/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getBillingItems) Retrieve the corresponding billing items having the specific cancellation reason. +
              #### [getObject](/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getObject) Retrieve a SoftLayer_Billing_Item_Cancellation_Reason record. +
              #### [getTranslatedReason](/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getTranslatedReason) +
              diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getAllCancellationReasons.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getAllCancellationReasons.md index de61666228..76d12ce31d 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getAllCancellationReasons.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getAllCancellationReasons.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Reason](/reference/services/SoftLayer_Billing_Item_Cancellation_Reason)::getAllCancellationReasons + Retrieve all available cancellation reasons. diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getBillingCancellationReasonCategory.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getBillingCancellationReasonCategory.md index f69bab7eac..9bf262aca5 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getBillingCancellationReasonCategory.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getBillingCancellationReasonCategory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Reason](/reference/services/SoftLayer_Billing_Item_Cancellation_Reason)::getBillingCancellationReasonCategory + Retrieve an billing cancellation reason category. diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getBillingItems.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getBillingItems.md index 95975ea277..2ec8fc3ce8 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getBillingItems.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getBillingItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Reason](/reference/services/SoftLayer_Billing_Item_Cancellation_Reason)::getBillingItems + Retrieve the corresponding billing items having the specific cancellation reason. diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getObject.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getObject.md index 79837c02c8..93f98fd601 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getObject.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Reason](/reference/services/SoftLayer_Billing_Item_Cancellation_Reason)::getObject + Retrieve a SoftLayer_Billing_Item_Cancellation_Reason record. diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getTranslatedReason.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getTranslatedReason.md index bdff61de42..5a5a06d290 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getTranslatedReason.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason/getTranslatedReason.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/_index.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/_index.md index 70602fa68b..f62bfebd71 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/_index.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,18 +44,21 @@ classes: #### [getAllCancellationReasonCategories](/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/getAllCancellationReasonCategories) Retrieve all available cancellation reason categories. +
              #### [getBillingCancellationReasons](/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/getBillingCancellationReasons) Retrieve the corresponding billing cancellation reasons having the specific billing cancellation reason category. +
              #### [getObject](/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/getObject) Retrieve a SoftLayer_Billing_Item_Cancellation_Reason_Category record. +
              diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/getAllCancellationReasonCategories.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/getAllCancellationReasonCategories.md index 000931c85f..b6381f40f3 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/getAllCancellationReasonCategories.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/getAllCancellationReasonCategories.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Reason_Category](/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category)::getAllCancellationReasonCategories + Retrieve all available cancellation reason categories. diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/getBillingCancellationReasons.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/getBillingCancellationReasons.md index 422762e7fc..7354acec72 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/getBillingCancellationReasons.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/getBillingCancellationReasons.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Reason_Category](/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category)::getBillingCancellationReasons + Retrieve the corresponding billing cancellation reasons having the specific billing cancellation reason category. diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/getObject.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/getObject.md index 2d99862d30..9845a1bee1 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/getObject.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Reason_Category](/reference/services/SoftLayer_Billing_Item_Cancellation_Reason_Category)::getObject + Retrieve a SoftLayer_Billing_Item_Cancellation_Reason_Category record. diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/_index.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/_index.md index ab8f8fad98..671ae3c797 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/_index.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,72 +44,84 @@ SoftLayer customers can use this API to submit a cancellation request. A single #### [createObject](/reference/services/SoftLayer_Billing_Item_Cancellation_Request/createObject) Creates a cancellation request. +
              #### [getAccount](/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getAccount) Retrieve the SoftLayer account that a service cancellation request belongs to. +
              #### [getAllCancellationRequests](/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getAllCancellationRequests) Returns all service cancellation requests +
              #### [getCancellationCutoffDate](/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getCancellationCutoffDate) Returns service cancellation cut off date. +
              #### [getItems](/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getItems) Retrieve a collection of service cancellation items. +
              #### [getObject](/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getObject) Retrieve a SoftLayer_Billing_Item_Cancellation_Request record. +
              #### [getStatus](/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getStatus) Retrieve the status of a service cancellation request. +
              #### [getTicket](/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getTicket) Retrieve the ticket that is associated with the service cancellation request. +
              #### [getUser](/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getUser) Retrieve the user that initiated a service cancellation request. +
              #### [removeCancellationItem](/reference/services/SoftLayer_Billing_Item_Cancellation_Request/removeCancellationItem) Removes a cancellation item +
              #### [validateBillingItemForCancellation](/reference/services/SoftLayer_Billing_Item_Cancellation_Request/validateBillingItemForCancellation) Examined if a billing item can be canceled or not. +
              #### [void](/reference/services/SoftLayer_Billing_Item_Cancellation_Request/void) Voids a pending or approved cancellation request +
              diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/createObject.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/createObject.md index 2f407b8bb8..a49e68c665 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/createObject.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/createObject.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Request](/reference/services/SoftLayer_Billing_Item_Cancellation_Request)::createObject + Creates a cancellation request. diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getAccount.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getAccount.md index b2767cedc3..bca20b6fd9 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getAccount.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Request](/reference/services/SoftLayer_Billing_Item_Cancellation_Request)::getAccount + Retrieve the SoftLayer account that a service cancellation request belongs to. diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getAllCancellationRequests.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getAllCancellationRequests.md index e715604855..51c4c70bdb 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getAllCancellationRequests.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getAllCancellationRequests.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Request](/reference/services/SoftLayer_Billing_Item_Cancellation_Request)::getAllCancellationRequests + Returns all service cancellation requests diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getCancellationCutoffDate.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getCancellationCutoffDate.md index c38ba3bf59..1e2eedbf85 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getCancellationCutoffDate.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getCancellationCutoffDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Request](/reference/services/SoftLayer_Billing_Item_Cancellation_Request)::getCancellationCutoffDate + Returns service cancellation cut off date. diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getItems.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getItems.md index 8ee699c649..565c30b3d6 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getItems.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Request](/reference/services/SoftLayer_Billing_Item_Cancellation_Request)::getItems + Retrieve a collection of service cancellation items. diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getObject.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getObject.md index 1d10720064..d41731dfe8 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getObject.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Request](/reference/services/SoftLayer_Billing_Item_Cancellation_Request)::getObject + Retrieve a SoftLayer_Billing_Item_Cancellation_Request record. diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getStatus.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getStatus.md index af5ed97b4a..d61bba5bd0 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getStatus.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Request](/reference/services/SoftLayer_Billing_Item_Cancellation_Request)::getStatus + Retrieve the status of a service cancellation request. diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getTicket.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getTicket.md index a1ad6646da..f424ca2979 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getTicket.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getTicket.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Request](/reference/services/SoftLayer_Billing_Item_Cancellation_Request)::getTicket + Retrieve the ticket that is associated with the service cancellation request. diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getUser.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getUser.md index 8f4d5713dc..b6f86ba3d0 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getUser.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/getUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Request](/reference/services/SoftLayer_Billing_Item_Cancellation_Request)::getUser + Retrieve the user that initiated a service cancellation request. diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/removeCancellationItem.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/removeCancellationItem.md index b588341da7..99b81bcb26 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/removeCancellationItem.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/removeCancellationItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Request](/reference/services/SoftLayer_Billing_Item_Cancellation_Request)::removeCancellationItem + Removes a cancellation item diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/validateBillingItemForCancellation.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/validateBillingItemForCancellation.md index 44d60d640a..70ad8f74bc 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/validateBillingItemForCancellation.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/validateBillingItemForCancellation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Request](/reference/services/SoftLayer_Billing_Item_Cancellation_Request)::validateBillingItemForCancellation + Examined if a billing item can be canceled or not. diff --git a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/void.md b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/void.md index 00452bd545..ac4f151b49 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/void.md +++ b/content/reference/services/SoftLayer_Billing_Item_Cancellation_Request/void.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Cancellation_Request](/reference/services/SoftLayer_Billing_Item_Cancellation_Request)::void + Voids a pending or approved cancellation request diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/_index.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/_index.md index c786773410..9bd0673f48 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/_index.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,354 +44,413 @@ classes: #### [cancelItem](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/cancelItem) Cancel a service or resource. +
              #### [cancelService](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/cancelService) Cancel a service or resource immediately. This does not include bare metal servers. +
              #### [cancelServiceOnAnniversaryDate](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/cancelServiceOnAnniversaryDate) Cancel a service or resource on the next bill date +
              #### [getAccount](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAccount) Retrieve the account that a billing item belongs to. +
              #### [getActiveAgreement](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAgreement) +
              #### [getActiveAgreementFlag](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAgreementFlag) Retrieve a flag indicating that the billing item is under an active agreement. +
              #### [getActiveAssociatedChildren](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAssociatedChildren) Retrieve a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. +
              #### [getActiveAssociatedGuestDiskBillingItems](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAssociatedGuestDiskBillingItems) +
              #### [getActiveBundledItems](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveBundledItems) Retrieve a Billing Item's active bundled billing items. +
              #### [getActiveCancellationItem](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveCancellationItem) Retrieve a service cancellation request item that corresponds to the billing item. +
              #### [getActiveChildren](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveChildren) Retrieve a Billing Item's active child billing items. +
              #### [getActiveFlag](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveFlag) +
              #### [getActiveSparePoolAssociatedGuestDiskBillingItems](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveSparePoolAssociatedGuestDiskBillingItems) +
              #### [getActiveSparePoolBundledItems](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveSparePoolBundledItems) Retrieve a Billing Item's spare pool bundled billing items. +
              #### [getAssociatedBillingItem](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedBillingItem) Retrieve a billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. +
              #### [getAssociatedBillingItemHistory](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedBillingItemHistory) Retrieve a history of billing items which a billing item has been associated with. +
              #### [getAssociatedChildren](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedChildren) Retrieve a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. +
              #### [getAssociatedParent](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedParent) Retrieve a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. +
              #### [getAvailableMatchingVlans](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAvailableMatchingVlans) +
              #### [getBandwidthAllocation](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBandwidthAllocation) Retrieve the bandwidth allocation for a billing item. +
              #### [getBillableChildren](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBillableChildren) Retrieve a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. +
              #### [getBundleItems](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBundleItems) Retrieve a Billing Item's bundled billing items +
              #### [getBundledItems](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBundledItems) Retrieve a Billing Item's bundled billing items' +
              #### [getCanceledChildren](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCanceledChildren) Retrieve a Billing Item's active child billing items. +
              #### [getCancellationReason](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCancellationReason) Retrieve the billing item's cancellation reason. +
              #### [getCancellationRequests](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCancellationRequests) Retrieve this will return any cancellation requests that are associated with this billing item. +
              #### [getCategory](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCategory) Retrieve the item category to which the billing item's item belongs. +
              #### [getChildren](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getChildren) Retrieve a Billing Item's child billing items' +
              #### [getChildrenWithActiveAgreement](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getChildrenWithActiveAgreement) Retrieve a Billing Item's active child billing items. +
              #### [getDowngradeItems](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getDowngradeItems) Retrieve for product items which have a downgrade path defined, this will return those product items. +
              #### [getFilteredNextInvoiceChildren](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getFilteredNextInvoiceChildren) Retrieve a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. +
              #### [getHourlyFlag](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getHourlyFlag) Retrieve a flag that will reflect whether this billing item is billed on an hourly basis or not. +
              #### [getInvoiceItem](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getInvoiceItem) Retrieve invoice items associated with this billing item +
              #### [getInvoiceItems](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getInvoiceItems) Retrieve all invoice items associated with the billing item +
              #### [getItem](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getItem) Retrieve the entry in the SoftLayer product catalog that a billing item is based upon. +
              #### [getLocation](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getLocation) Retrieve the location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. +
              #### [getNextInvoiceChildren](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceChildren) Retrieve a Billing Item's child billing items and associated items' +
              #### [getNextInvoiceTotalOneTimeAmount](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalOneTimeAmount) Retrieve a Billing Item's total, including any child billing items if they exist.' +
              #### [getNextInvoiceTotalOneTimeTaxAmount](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalOneTimeTaxAmount) Retrieve a Billing Item's total, including any child billing items if they exist.' +
              #### [getNextInvoiceTotalRecurringAmount](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalRecurringAmount) Retrieve a Billing Item's total, including any child billing items and associated billing items if they exist.' +
              #### [getNextInvoiceTotalRecurringTaxAmount](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalRecurringTaxAmount) Retrieve this is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. +
              #### [getNonZeroNextInvoiceChildren](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNonZeroNextInvoiceChildren) Retrieve a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. +
              #### [getObject](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getObject) Retrieve a SoftLayer_Billing_Item_Virtual_DedicatedHost record. +
              #### [getOrderItem](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getOrderItem) Retrieve a billing item's original order item. Simply a reference to the original order from which this billing item was created. +
              #### [getOriginalLocation](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getOriginalLocation) Retrieve the original physical location for this billing item--may differ from current. +
              #### [getPackage](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getPackage) Retrieve the package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. +
              #### [getParent](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getParent) Retrieve a billing item's parent item. If a billing item has no parent item then this value is null. +
              #### [getParentVirtualGuestBillingItem](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getParentVirtualGuestBillingItem) Retrieve a billing item's parent item. If a billing item has no parent item then this value is null. +
              #### [getPendingCancellationFlag](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getPendingCancellationFlag) Retrieve this flag indicates whether a billing item is scheduled to be canceled or not. +
              #### [getPendingOrderItem](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getPendingOrderItem) Retrieve the new order item that will replace this billing item. +
              #### [getProvisionTransaction](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getProvisionTransaction) Retrieve provisioning transaction for this billing item +
              #### [getResource](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getResource) Retrieve the resource for a virtual dedicated host billing item. +
              #### [getServiceBillingItemsByCategory](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getServiceBillingItemsByCategory) Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel. +
              #### [getSoftwareDescription](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getSoftwareDescription) Retrieve a friendly description of software component +
              #### [getUpgradeItem](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getUpgradeItem) Retrieve billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. +
              #### [getUpgradeItems](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getUpgradeItems) Retrieve billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. +
              #### [removeAssociationId](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/removeAssociationId) Remove an association from an orphan billing item. +
              #### [setAssociationId](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/setAssociationId) Set the associated billing item for an orphan billing item. +
              #### [voidCancelService](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/voidCancelService) Void a service cancellation that was previously made. +
              diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/cancelItem.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/cancelItem.md index 9ee7fcd42e..aa7000781d 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/cancelItem.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/cancelItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::cancelItem + Cancel a service or resource. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/cancelService.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/cancelService.md index 077daeb276..3b16b8ac6d 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/cancelService.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/cancelService.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::cancelService + Cancel a service or resource immediately. This does not include bare metal servers. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/cancelServiceOnAnniversaryDate.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/cancelServiceOnAnniversaryDate.md index 4a171307ed..97dd729e7a 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/cancelServiceOnAnniversaryDate.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/cancelServiceOnAnniversaryDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::cancelServiceOnAnniversaryDate + Cancel a service or resource on the next bill date diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAccount.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAccount.md index 018ca49d36..28c7faa79e 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAccount.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getAccount + Retrieve the account that a billing item belongs to. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAgreement.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAgreement.md index ea19a6e7a5..b7ed4e0df9 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAgreement.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAgreement.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAgreementFlag.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAgreementFlag.md index 4d95527937..6d26d20f7e 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAgreementFlag.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAgreementFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getActiveAgreementFlag + Retrieve a flag indicating that the billing item is under an active agreement. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAssociatedChildren.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAssociatedChildren.md index 77fee37a40..86dd77b4a3 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAssociatedChildren.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAssociatedChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getActiveAssociatedChildren + Retrieve a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAssociatedGuestDiskBillingItems.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAssociatedGuestDiskBillingItems.md index 342b875e76..a482a8161d 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAssociatedGuestDiskBillingItems.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveAssociatedGuestDiskBillingItems.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveBundledItems.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveBundledItems.md index d20843d4b6..858b639876 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveBundledItems.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveBundledItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getActiveBundledItems + Retrieve a Billing Item's active bundled billing items. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveCancellationItem.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveCancellationItem.md index 8d7143b8c0..ec2137379c 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveCancellationItem.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveCancellationItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getActiveCancellationItem + Retrieve a service cancellation request item that corresponds to the billing item. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveChildren.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveChildren.md index 13f4976ea3..0ed0b99e8c 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveChildren.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getActiveChildren + Retrieve a Billing Item's active child billing items. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveFlag.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveFlag.md index 8c609efdd3..967be8370d 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveFlag.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveSparePoolAssociatedGuestDiskBillingItems.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveSparePoolAssociatedGuestDiskBillingItems.md index 69b7f1ce38..c7cad83417 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveSparePoolAssociatedGuestDiskBillingItems.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveSparePoolAssociatedGuestDiskBillingItems.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveSparePoolBundledItems.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveSparePoolBundledItems.md index 7eb5a17331..4502ebed1f 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveSparePoolBundledItems.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getActiveSparePoolBundledItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getActiveSparePoolBundledItems + Retrieve a Billing Item's spare pool bundled billing items. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedBillingItem.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedBillingItem.md index 2958bd5b01..10ac93db48 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedBillingItem.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getAssociatedBillingItem + Retrieve a billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedBillingItemHistory.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedBillingItemHistory.md index 78a33e0665..ece37c3613 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedBillingItemHistory.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedBillingItemHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getAssociatedBillingItemHistory + Retrieve a history of billing items which a billing item has been associated with. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedChildren.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedChildren.md index d2008910f9..71bf6b41d4 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedChildren.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getAssociatedChildren + Retrieve a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedParent.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedParent.md index b5752f2af1..ce52c6d5f6 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedParent.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAssociatedParent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getAssociatedParent + Retrieve a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAvailableMatchingVlans.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAvailableMatchingVlans.md index e6bb08686b..4058e84a9e 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAvailableMatchingVlans.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getAvailableMatchingVlans.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBandwidthAllocation.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBandwidthAllocation.md index bc4baf5fb7..f2ff882b29 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBandwidthAllocation.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBandwidthAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getBandwidthAllocation + Retrieve the bandwidth allocation for a billing item. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBillableChildren.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBillableChildren.md index 6bd7c2ce3f..f2f5ccab1c 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBillableChildren.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBillableChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getBillableChildren + Retrieve a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBundleItems.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBundleItems.md index 83ed07dabe..e6a9891168 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBundleItems.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBundleItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getBundleItems + Retrieve a Billing Item's bundled billing items diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBundledItems.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBundledItems.md index 0fcec91175..05943ae7e0 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBundledItems.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getBundledItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getBundledItems + Retrieve a Billing Item's bundled billing items' diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCanceledChildren.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCanceledChildren.md index 6f98b6fb3a..4fcc7a0210 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCanceledChildren.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCanceledChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getCanceledChildren + Retrieve a Billing Item's active child billing items. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCancellationReason.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCancellationReason.md index cbc4f38376..79223c8dd2 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCancellationReason.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCancellationReason.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getCancellationReason + Retrieve the billing item's cancellation reason. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCancellationRequests.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCancellationRequests.md index 8e33b31e64..60a261de3c 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCancellationRequests.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCancellationRequests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getCancellationRequests + Retrieve this will return any cancellation requests that are associated with this billing item. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCategory.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCategory.md index b9f8632538..5e0d92d170 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCategory.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getCategory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getCategory + Retrieve the item category to which the billing item's item belongs. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getChildren.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getChildren.md index ac56d56cbe..bb3f01528b 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getChildren.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getChildren + Retrieve a Billing Item's child billing items' diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getChildrenWithActiveAgreement.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getChildrenWithActiveAgreement.md index 187e945e94..94002fe58b 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getChildrenWithActiveAgreement.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getChildrenWithActiveAgreement.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getChildrenWithActiveAgreement + Retrieve a Billing Item's active child billing items. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getDowngradeItems.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getDowngradeItems.md index d45e78a19d..3f528a814e 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getDowngradeItems.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getDowngradeItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getDowngradeItems + Retrieve for product items which have a downgrade path defined, this will return those product items. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getFilteredNextInvoiceChildren.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getFilteredNextInvoiceChildren.md index 5b2dac8f1a..9ef27552be 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getFilteredNextInvoiceChildren.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getFilteredNextInvoiceChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getFilteredNextInvoiceChildren + Retrieve a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getHourlyFlag.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getHourlyFlag.md index d9c40f99fc..d3bd575100 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getHourlyFlag.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getHourlyFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getHourlyFlag + Retrieve a flag that will reflect whether this billing item is billed on an hourly basis or not. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getInvoiceItem.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getInvoiceItem.md index 4b67ac1aff..8ab91af26a 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getInvoiceItem.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getInvoiceItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getInvoiceItem + Retrieve invoice items associated with this billing item diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getInvoiceItems.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getInvoiceItems.md index 52ac88165c..5fa15d1459 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getInvoiceItems.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getInvoiceItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getInvoiceItems + Retrieve all invoice items associated with the billing item diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getItem.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getItem.md index 715fef3707..61e135dc23 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getItem.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getItem + Retrieve the entry in the SoftLayer product catalog that a billing item is based upon. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getLocation.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getLocation.md index 773319153e..cf62566f78 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getLocation.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getLocation + Retrieve the location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceChildren.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceChildren.md index 080de35bc2..854c2fd606 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceChildren.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getNextInvoiceChildren + Retrieve a Billing Item's child billing items and associated items' diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalOneTimeAmount.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalOneTimeAmount.md index 8fd95b68d9..c982f998c4 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalOneTimeAmount.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalOneTimeAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getNextInvoiceTotalOneTimeAmount + Retrieve a Billing Item's total, including any child billing items if they exist.' diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalOneTimeTaxAmount.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalOneTimeTaxAmount.md index 26be3086cf..376cc899ae 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalOneTimeTaxAmount.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalOneTimeTaxAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getNextInvoiceTotalOneTimeTaxAmount + Retrieve a Billing Item's total, including any child billing items if they exist.' diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalRecurringAmount.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalRecurringAmount.md index 1298e71e2e..2b12b0405c 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalRecurringAmount.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalRecurringAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getNextInvoiceTotalRecurringAmount + Retrieve a Billing Item's total, including any child billing items and associated billing items if they exist.' diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalRecurringTaxAmount.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalRecurringTaxAmount.md index 2bd636eca2..49ca9d6779 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalRecurringTaxAmount.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNextInvoiceTotalRecurringTaxAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getNextInvoiceTotalRecurringTaxAmount + Retrieve this is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNonZeroNextInvoiceChildren.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNonZeroNextInvoiceChildren.md index 0362b06790..ef69b0cda5 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNonZeroNextInvoiceChildren.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getNonZeroNextInvoiceChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getNonZeroNextInvoiceChildren + Retrieve a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getObject.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getObject.md index ad6ef967a3..e2382d1b99 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getObject.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getObject + Retrieve a SoftLayer_Billing_Item_Virtual_DedicatedHost record. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getOrderItem.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getOrderItem.md index f5e8cc64f1..da0c4f5559 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getOrderItem.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getOrderItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getOrderItem + Retrieve a billing item's original order item. Simply a reference to the original order from which this billing item was created. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getOriginalLocation.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getOriginalLocation.md index 90456a08e5..56cd14bb33 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getOriginalLocation.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getOriginalLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getOriginalLocation + Retrieve the original physical location for this billing item--may differ from current. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getPackage.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getPackage.md index 2ab1b0592a..b4c050c157 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getPackage.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getPackage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getPackage + Retrieve the package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getParent.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getParent.md index a60bf04db8..47c8b18b03 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getParent.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getParent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getParent + Retrieve a billing item's parent item. If a billing item has no parent item then this value is null. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getParentVirtualGuestBillingItem.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getParentVirtualGuestBillingItem.md index 2aebb9d8c0..20f9a72c54 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getParentVirtualGuestBillingItem.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getParentVirtualGuestBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getParentVirtualGuestBillingItem + Retrieve a billing item's parent item. If a billing item has no parent item then this value is null. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getPendingCancellationFlag.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getPendingCancellationFlag.md index 5d9e03795d..4f4e37ea7e 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getPendingCancellationFlag.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getPendingCancellationFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getPendingCancellationFlag + Retrieve this flag indicates whether a billing item is scheduled to be canceled or not. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getPendingOrderItem.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getPendingOrderItem.md index 04e297dbac..d7f76d276e 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getPendingOrderItem.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getPendingOrderItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getPendingOrderItem + Retrieve the new order item that will replace this billing item. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getProvisionTransaction.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getProvisionTransaction.md index 7d8fa2507c..c9a9ab94cb 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getProvisionTransaction.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getProvisionTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getProvisionTransaction + Retrieve provisioning transaction for this billing item diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getResource.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getResource.md index a99bba61ba..fae214ae89 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getResource.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getResource.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getResource + Retrieve the resource for a virtual dedicated host billing item. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getServiceBillingItemsByCategory.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getServiceBillingItemsByCategory.md index 5f8e39d42d..7863ee3079 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getServiceBillingItemsByCategory.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getServiceBillingItemsByCategory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getServiceBillingItemsByCategory + Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getSoftwareDescription.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getSoftwareDescription.md index 243ab2ef35..6798f78117 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getSoftwareDescription.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getSoftwareDescription.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getSoftwareDescription + Retrieve a friendly description of software component diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getUpgradeItem.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getUpgradeItem.md index bfe1287a6a..d5fd6bee0a 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getUpgradeItem.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getUpgradeItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getUpgradeItem + Retrieve billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getUpgradeItems.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getUpgradeItems.md index d2a3ba1c46..d55623aea5 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getUpgradeItems.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/getUpgradeItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::getUpgradeItems + Retrieve billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/removeAssociationId.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/removeAssociationId.md index 6071db5e67..d1df0656e4 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/removeAssociationId.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/removeAssociationId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::removeAssociationId + Remove an association from an orphan billing item. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/setAssociationId.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/setAssociationId.md index 364d13b53a..229c572766 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/setAssociationId.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/setAssociationId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::setAssociationId + Set the associated billing item for an orphan billing item. diff --git a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/voidCancelService.md b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/voidCancelService.md index c9be7e1f59..cfed57a084 100644 --- a/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/voidCancelService.md +++ b/content/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost/voidCancelService.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Item_Virtual_DedicatedHost](/reference/services/SoftLayer_Billing_Item_Virtual_DedicatedHost)::voidCancelService + Void a service cancellation that was previously made. diff --git a/content/reference/services/SoftLayer_Billing_Order/_index.md b/content/reference/services/SoftLayer_Billing_Order/_index.md index 535858ebaf..90da3bf10e 100644 --- a/content/reference/services/SoftLayer_Billing_Order/_index.md +++ b/content/reference/services/SoftLayer_Billing_Order/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -56,216 +58,252 @@ Query the [SoftLayer_Account]({{}}) #### [approveModifiedOrder](/reference/services/SoftLayer_Billing_Order/approveModifiedOrder) Approve the changes of a modified order +
              #### [getAccount](/reference/services/SoftLayer_Billing_Order/getAccount) Retrieve the [SoftLayer_Account]({{}}) to which an order belongs. +
              #### [getAllObjects](/reference/services/SoftLayer_Billing_Order/getAllObjects) Get all billing orders for your account +
              #### [getBrand](/reference/services/SoftLayer_Billing_Order/getBrand) +
              #### [getCart](/reference/services/SoftLayer_Billing_Order/getCart) Retrieve a cart is similar to a quote, except that it can be continually modified by the customer and does not have locked-in prices. Not all orders will have a cart associated with them. See [SoftLayer_Billing_Order_Cart]({{}}) for more information. +
              #### [getCoreRestrictedItems](/reference/services/SoftLayer_Billing_Order/getCoreRestrictedItems) Retrieve the [SoftLayer_Billing_Order_Item]({{}}) that are core restricted +
              #### [getCreditCardTransactions](/reference/services/SoftLayer_Billing_Order/getCreditCardTransactions) Retrieve all credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty. +
              #### [getExchangeRate](/reference/services/SoftLayer_Billing_Order/getExchangeRate) +
              #### [getInitialInvoice](/reference/services/SoftLayer_Billing_Order/getInitialInvoice) +
              #### [getItems](/reference/services/SoftLayer_Billing_Order/getItems) Retrieve the SoftLayer_Billing_Order_items included in an order. +
              #### [getObject](/reference/services/SoftLayer_Billing_Order/getObject) Retrieve a SoftLayer_Billing_Order record. +
              #### [getOrderApprovalDate](/reference/services/SoftLayer_Billing_Order/getOrderApprovalDate) +
              #### [getOrderNonServerMonthlyAmount](/reference/services/SoftLayer_Billing_Order/getOrderNonServerMonthlyAmount) Retrieve an order's non-server items total monthly fee. +
              #### [getOrderServerMonthlyAmount](/reference/services/SoftLayer_Billing_Order/getOrderServerMonthlyAmount) Retrieve an order's server items total monthly fee. +
              #### [getOrderStatuses](/reference/services/SoftLayer_Billing_Order/getOrderStatuses) Get a list of SoftLayer_Container_Billing_Order_Status objects. +
              #### [getOrderTopLevelItems](/reference/services/SoftLayer_Billing_Order/getOrderTopLevelItems) Retrieve an order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI. +
              #### [getOrderTotalAmount](/reference/services/SoftLayer_Billing_Order/getOrderTotalAmount) Retrieve this amount represents the order's initial charge including set up fee and taxes. +
              #### [getOrderTotalOneTime](/reference/services/SoftLayer_Billing_Order/getOrderTotalOneTime) Retrieve an order's total one time amount summing all the set up fees, the labor fees and the one time fees. Taxes will be applied for non-tax-exempt. This amount represents the initial fees that will be charged. +
              #### [getOrderTotalOneTimeAmount](/reference/services/SoftLayer_Billing_Order/getOrderTotalOneTimeAmount) Retrieve an order's total one time amount. This amount represents the initial fees before tax. +
              #### [getOrderTotalOneTimeTaxAmount](/reference/services/SoftLayer_Billing_Order/getOrderTotalOneTimeTaxAmount) Retrieve an order's total one time tax amount. This amount represents the tax that will be applied to the total charge, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account. +
              #### [getOrderTotalRecurring](/reference/services/SoftLayer_Billing_Order/getOrderTotalRecurring) Retrieve an order's total recurring amount. Taxes will be applied for non-tax-exempt. This amount represents the fees that will be charged on a recurring (usually monthly) basis. +
              #### [getOrderTotalRecurringAmount](/reference/services/SoftLayer_Billing_Order/getOrderTotalRecurringAmount) Retrieve an order's total recurring amount. This amount represents the fees that will be charged on a recurring (usually monthly) basis. +
              #### [getOrderTotalRecurringTaxAmount](/reference/services/SoftLayer_Billing_Order/getOrderTotalRecurringTaxAmount) Retrieve the total tax amount of the recurring fees, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account. +
              #### [getOrderTotalSetupAmount](/reference/services/SoftLayer_Billing_Order/getOrderTotalSetupAmount) Retrieve an order's total setup fee. +
              #### [getOrderType](/reference/services/SoftLayer_Billing_Order/getOrderType) Retrieve the type of an order. This lets you know where this order was generated from. +
              #### [getPaypalTransactions](/reference/services/SoftLayer_Billing_Order/getPaypalTransactions) Retrieve all PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty. +
              #### [getPdf](/reference/services/SoftLayer_Billing_Order/getPdf) Retrieve a PDF copy of a quote. +
              #### [getPdfFilename](/reference/services/SoftLayer_Billing_Order/getPdfFilename) Retrieve the default name of the PDF +
              #### [getPresaleEvent](/reference/services/SoftLayer_Billing_Order/getPresaleEvent) +
              #### [getQuote](/reference/services/SoftLayer_Billing_Order/getQuote) Retrieve the quote of an order. This quote holds information about its expiration date, creation date, name and status. This information is tied to an order having the status 'QUOTE' +
              #### [getRecalculatedOrderContainer](/reference/services/SoftLayer_Billing_Order/getRecalculatedOrderContainer) Generate an [SoftLayer_Container_Product_Order]({{}}) from a billing order. +
              #### [getReceipt](/reference/services/SoftLayer_Billing_Order/getReceipt) Generate and return an order receipt. +
              #### [getReferralPartner](/reference/services/SoftLayer_Billing_Order/getReferralPartner) Retrieve the Referral Partner who referred this order. (Only necessary for new customer orders) +
              #### [getUpgradeRequestFlag](/reference/services/SoftLayer_Billing_Order/getUpgradeRequestFlag) Retrieve this flag indicates an order is an upgrade. +
              #### [getUserRecord](/reference/services/SoftLayer_Billing_Order/getUserRecord) Retrieve the SoftLayer_User_Customer object tied to an order. +
              #### [isPendingEditApproval](/reference/services/SoftLayer_Billing_Order/isPendingEditApproval) Determine if the existing order is pending edit approval +
              diff --git a/content/reference/services/SoftLayer_Billing_Order/approveModifiedOrder.md b/content/reference/services/SoftLayer_Billing_Order/approveModifiedOrder.md index 4ebdcb840a..62167007bd 100644 --- a/content/reference/services/SoftLayer_Billing_Order/approveModifiedOrder.md +++ b/content/reference/services/SoftLayer_Billing_Order/approveModifiedOrder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::approveModifiedOrder + Approve the changes of a modified order diff --git a/content/reference/services/SoftLayer_Billing_Order/getAccount.md b/content/reference/services/SoftLayer_Billing_Order/getAccount.md index 96efe92673..10d9b2107b 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getAccount.md +++ b/content/reference/services/SoftLayer_Billing_Order/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getAccount + Retrieve the [SoftLayer_Account]({{}}) to which an order belongs. diff --git a/content/reference/services/SoftLayer_Billing_Order/getAllObjects.md b/content/reference/services/SoftLayer_Billing_Order/getAllObjects.md index e0e53aeecd..ab571c9bb0 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getAllObjects.md +++ b/content/reference/services/SoftLayer_Billing_Order/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getAllObjects + Get all billing orders for your account diff --git a/content/reference/services/SoftLayer_Billing_Order/getBrand.md b/content/reference/services/SoftLayer_Billing_Order/getBrand.md index 4009d09641..36bf4a05f3 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getBrand.md +++ b/content/reference/services/SoftLayer_Billing_Order/getBrand.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Order/getCart.md b/content/reference/services/SoftLayer_Billing_Order/getCart.md index ffc3655366..c9d7760876 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getCart.md +++ b/content/reference/services/SoftLayer_Billing_Order/getCart.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getCart + Retrieve a cart is similar to a quote, except that it can be continually modified by the customer and does not have locked-in prices. Not all orders will have a cart associated with them. See [SoftLayer_Billing_Order_Cart]({{}}) for more information. diff --git a/content/reference/services/SoftLayer_Billing_Order/getCoreRestrictedItems.md b/content/reference/services/SoftLayer_Billing_Order/getCoreRestrictedItems.md index 8dd148bfa0..384bf9c6ed 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getCoreRestrictedItems.md +++ b/content/reference/services/SoftLayer_Billing_Order/getCoreRestrictedItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getCoreRestrictedItems + Retrieve the [SoftLayer_Billing_Order_Item]({{}}) that are core restricted diff --git a/content/reference/services/SoftLayer_Billing_Order/getCreditCardTransactions.md b/content/reference/services/SoftLayer_Billing_Order/getCreditCardTransactions.md index 5fed197112..db060e35eb 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getCreditCardTransactions.md +++ b/content/reference/services/SoftLayer_Billing_Order/getCreditCardTransactions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getCreditCardTransactions + Retrieve all credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty. diff --git a/content/reference/services/SoftLayer_Billing_Order/getExchangeRate.md b/content/reference/services/SoftLayer_Billing_Order/getExchangeRate.md index 8dee857573..4f2db52f53 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getExchangeRate.md +++ b/content/reference/services/SoftLayer_Billing_Order/getExchangeRate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Order/getInitialInvoice.md b/content/reference/services/SoftLayer_Billing_Order/getInitialInvoice.md index 4446682b0e..021c0d0cf3 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getInitialInvoice.md +++ b/content/reference/services/SoftLayer_Billing_Order/getInitialInvoice.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Order/getItems.md b/content/reference/services/SoftLayer_Billing_Order/getItems.md index 3d358775e7..31598d260d 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getItems.md +++ b/content/reference/services/SoftLayer_Billing_Order/getItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getItems + Retrieve the SoftLayer_Billing_Order_items included in an order. diff --git a/content/reference/services/SoftLayer_Billing_Order/getObject.md b/content/reference/services/SoftLayer_Billing_Order/getObject.md index c351ccf66c..09398250a1 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getObject.md +++ b/content/reference/services/SoftLayer_Billing_Order/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getObject + Retrieve a SoftLayer_Billing_Order record. diff --git a/content/reference/services/SoftLayer_Billing_Order/getOrderApprovalDate.md b/content/reference/services/SoftLayer_Billing_Order/getOrderApprovalDate.md index 1c9d4cdfb7..37a49084f8 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getOrderApprovalDate.md +++ b/content/reference/services/SoftLayer_Billing_Order/getOrderApprovalDate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Order/getOrderNonServerMonthlyAmount.md b/content/reference/services/SoftLayer_Billing_Order/getOrderNonServerMonthlyAmount.md index 9b37811ebd..1f9dc9ac6f 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getOrderNonServerMonthlyAmount.md +++ b/content/reference/services/SoftLayer_Billing_Order/getOrderNonServerMonthlyAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getOrderNonServerMonthlyAmount + Retrieve an order's non-server items total monthly fee. diff --git a/content/reference/services/SoftLayer_Billing_Order/getOrderServerMonthlyAmount.md b/content/reference/services/SoftLayer_Billing_Order/getOrderServerMonthlyAmount.md index 8603ff69df..93f5e91abd 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getOrderServerMonthlyAmount.md +++ b/content/reference/services/SoftLayer_Billing_Order/getOrderServerMonthlyAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getOrderServerMonthlyAmount + Retrieve an order's server items total monthly fee. diff --git a/content/reference/services/SoftLayer_Billing_Order/getOrderStatuses.md b/content/reference/services/SoftLayer_Billing_Order/getOrderStatuses.md index f25c663cda..9da105c4c3 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getOrderStatuses.md +++ b/content/reference/services/SoftLayer_Billing_Order/getOrderStatuses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getOrderStatuses + Get a list of SoftLayer_Container_Billing_Order_Status objects. diff --git a/content/reference/services/SoftLayer_Billing_Order/getOrderTopLevelItems.md b/content/reference/services/SoftLayer_Billing_Order/getOrderTopLevelItems.md index 243032ec4a..c300cf1fdf 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getOrderTopLevelItems.md +++ b/content/reference/services/SoftLayer_Billing_Order/getOrderTopLevelItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getOrderTopLevelItems + Retrieve an order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI. diff --git a/content/reference/services/SoftLayer_Billing_Order/getOrderTotalAmount.md b/content/reference/services/SoftLayer_Billing_Order/getOrderTotalAmount.md index e4292ba6e3..f9b99938dd 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getOrderTotalAmount.md +++ b/content/reference/services/SoftLayer_Billing_Order/getOrderTotalAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getOrderTotalAmount + Retrieve this amount represents the order's initial charge including set up fee and taxes. diff --git a/content/reference/services/SoftLayer_Billing_Order/getOrderTotalOneTime.md b/content/reference/services/SoftLayer_Billing_Order/getOrderTotalOneTime.md index 7dbdad5000..996633fd76 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getOrderTotalOneTime.md +++ b/content/reference/services/SoftLayer_Billing_Order/getOrderTotalOneTime.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getOrderTotalOneTime + Retrieve an order's total one time amount summing all the set up fees, the labor fees and the one time fees. Taxes will be applied for non-tax-exempt. This amount represents the initial fees that will be charged. diff --git a/content/reference/services/SoftLayer_Billing_Order/getOrderTotalOneTimeAmount.md b/content/reference/services/SoftLayer_Billing_Order/getOrderTotalOneTimeAmount.md index cfe826c28e..ab9ac3be5b 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getOrderTotalOneTimeAmount.md +++ b/content/reference/services/SoftLayer_Billing_Order/getOrderTotalOneTimeAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getOrderTotalOneTimeAmount + Retrieve an order's total one time amount. This amount represents the initial fees before tax. diff --git a/content/reference/services/SoftLayer_Billing_Order/getOrderTotalOneTimeTaxAmount.md b/content/reference/services/SoftLayer_Billing_Order/getOrderTotalOneTimeTaxAmount.md index 17b76481a6..d4934105f5 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getOrderTotalOneTimeTaxAmount.md +++ b/content/reference/services/SoftLayer_Billing_Order/getOrderTotalOneTimeTaxAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getOrderTotalOneTimeTaxAmount + Retrieve an order's total one time tax amount. This amount represents the tax that will be applied to the total charge, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account. diff --git a/content/reference/services/SoftLayer_Billing_Order/getOrderTotalRecurring.md b/content/reference/services/SoftLayer_Billing_Order/getOrderTotalRecurring.md index 0f19ed4893..65081b5a77 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getOrderTotalRecurring.md +++ b/content/reference/services/SoftLayer_Billing_Order/getOrderTotalRecurring.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getOrderTotalRecurring + Retrieve an order's total recurring amount. Taxes will be applied for non-tax-exempt. This amount represents the fees that will be charged on a recurring (usually monthly) basis. diff --git a/content/reference/services/SoftLayer_Billing_Order/getOrderTotalRecurringAmount.md b/content/reference/services/SoftLayer_Billing_Order/getOrderTotalRecurringAmount.md index 201a30f267..7a9b5d1fe2 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getOrderTotalRecurringAmount.md +++ b/content/reference/services/SoftLayer_Billing_Order/getOrderTotalRecurringAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getOrderTotalRecurringAmount + Retrieve an order's total recurring amount. This amount represents the fees that will be charged on a recurring (usually monthly) basis. diff --git a/content/reference/services/SoftLayer_Billing_Order/getOrderTotalRecurringTaxAmount.md b/content/reference/services/SoftLayer_Billing_Order/getOrderTotalRecurringTaxAmount.md index 955d52e4bc..74e94f3220 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getOrderTotalRecurringTaxAmount.md +++ b/content/reference/services/SoftLayer_Billing_Order/getOrderTotalRecurringTaxAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getOrderTotalRecurringTaxAmount + Retrieve the total tax amount of the recurring fees, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account. diff --git a/content/reference/services/SoftLayer_Billing_Order/getOrderTotalSetupAmount.md b/content/reference/services/SoftLayer_Billing_Order/getOrderTotalSetupAmount.md index 32782cb6fc..13d6784133 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getOrderTotalSetupAmount.md +++ b/content/reference/services/SoftLayer_Billing_Order/getOrderTotalSetupAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getOrderTotalSetupAmount + Retrieve an order's total setup fee. diff --git a/content/reference/services/SoftLayer_Billing_Order/getOrderType.md b/content/reference/services/SoftLayer_Billing_Order/getOrderType.md index 5331f93da5..dacbedadfb 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getOrderType.md +++ b/content/reference/services/SoftLayer_Billing_Order/getOrderType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getOrderType + Retrieve the type of an order. This lets you know where this order was generated from. diff --git a/content/reference/services/SoftLayer_Billing_Order/getPaypalTransactions.md b/content/reference/services/SoftLayer_Billing_Order/getPaypalTransactions.md index cec7f510f3..511e1f95fd 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getPaypalTransactions.md +++ b/content/reference/services/SoftLayer_Billing_Order/getPaypalTransactions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getPaypalTransactions + Retrieve all PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty. diff --git a/content/reference/services/SoftLayer_Billing_Order/getPdf.md b/content/reference/services/SoftLayer_Billing_Order/getPdf.md index c30353cd12..f5a18755ce 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getPdf.md +++ b/content/reference/services/SoftLayer_Billing_Order/getPdf.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getPdf + Retrieve a PDF copy of a quote. diff --git a/content/reference/services/SoftLayer_Billing_Order/getPdfFilename.md b/content/reference/services/SoftLayer_Billing_Order/getPdfFilename.md index 20ed48202f..cd1bf98d59 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getPdfFilename.md +++ b/content/reference/services/SoftLayer_Billing_Order/getPdfFilename.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getPdfFilename + Retrieve the default name of the PDF diff --git a/content/reference/services/SoftLayer_Billing_Order/getPresaleEvent.md b/content/reference/services/SoftLayer_Billing_Order/getPresaleEvent.md index 91f5fd1d13..997ac1ae85 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getPresaleEvent.md +++ b/content/reference/services/SoftLayer_Billing_Order/getPresaleEvent.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Order/getQuote.md b/content/reference/services/SoftLayer_Billing_Order/getQuote.md index 33f9200fc9..175c9a1157 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getQuote.md +++ b/content/reference/services/SoftLayer_Billing_Order/getQuote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getQuote + Retrieve the quote of an order. This quote holds information about its expiration date, creation date, name and status. This information is tied to an order having the status 'QUOTE' diff --git a/content/reference/services/SoftLayer_Billing_Order/getRecalculatedOrderContainer.md b/content/reference/services/SoftLayer_Billing_Order/getRecalculatedOrderContainer.md index 534e2e40b1..fd0e850b91 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getRecalculatedOrderContainer.md +++ b/content/reference/services/SoftLayer_Billing_Order/getRecalculatedOrderContainer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getRecalculatedOrderContainer + Generate an [SoftLayer_Container_Product_Order]({{}}) from a billing order. diff --git a/content/reference/services/SoftLayer_Billing_Order/getReceipt.md b/content/reference/services/SoftLayer_Billing_Order/getReceipt.md index 34402e6923..94726132b6 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getReceipt.md +++ b/content/reference/services/SoftLayer_Billing_Order/getReceipt.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getReceipt + Generate and return an order receipt. diff --git a/content/reference/services/SoftLayer_Billing_Order/getReferralPartner.md b/content/reference/services/SoftLayer_Billing_Order/getReferralPartner.md index e9cd520a08..5a641443ef 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getReferralPartner.md +++ b/content/reference/services/SoftLayer_Billing_Order/getReferralPartner.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getReferralPartner + Retrieve the Referral Partner who referred this order. (Only necessary for new customer orders) diff --git a/content/reference/services/SoftLayer_Billing_Order/getUpgradeRequestFlag.md b/content/reference/services/SoftLayer_Billing_Order/getUpgradeRequestFlag.md index e3a5f5c6a7..a2d39d1bf5 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getUpgradeRequestFlag.md +++ b/content/reference/services/SoftLayer_Billing_Order/getUpgradeRequestFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getUpgradeRequestFlag + Retrieve this flag indicates an order is an upgrade. diff --git a/content/reference/services/SoftLayer_Billing_Order/getUserRecord.md b/content/reference/services/SoftLayer_Billing_Order/getUserRecord.md index dc66db8286..2f996aa2b7 100644 --- a/content/reference/services/SoftLayer_Billing_Order/getUserRecord.md +++ b/content/reference/services/SoftLayer_Billing_Order/getUserRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::getUserRecord + Retrieve the SoftLayer_User_Customer object tied to an order. diff --git a/content/reference/services/SoftLayer_Billing_Order/isPendingEditApproval.md b/content/reference/services/SoftLayer_Billing_Order/isPendingEditApproval.md index afa7129758..ca64e1f439 100644 --- a/content/reference/services/SoftLayer_Billing_Order/isPendingEditApproval.md +++ b/content/reference/services/SoftLayer_Billing_Order/isPendingEditApproval.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order](/reference/services/SoftLayer_Billing_Order)::isPendingEditApproval + Determine if the existing order is pending edit approval diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/_index.md b/content/reference/services/SoftLayer_Billing_Order_Cart/_index.md index 1483925589..1cd6c76ba1 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/_index.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The [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. @@ -42,114 +44,133 @@ The [SoftLayer_Billing_Order_Cart]({{
              #### [createCart](/reference/services/SoftLayer_Billing_Order_Cart/createCart) Create a new cart from the order data provided +
              #### [deleteCart](/reference/services/SoftLayer_Billing_Order_Cart/deleteCart) Delete an existing cart +
              #### [deleteQuote](/reference/services/SoftLayer_Billing_Order_Cart/deleteQuote) Delete the quote of an order +
              #### [getAccount](/reference/services/SoftLayer_Billing_Order_Cart/getAccount) Retrieve a quote's corresponding account. +
              #### [getCartByCartKey](/reference/services/SoftLayer_Billing_Order_Cart/getCartByCartKey) Retrieve a cart. +
              #### [getDoNotContactFlag](/reference/services/SoftLayer_Billing_Order_Cart/getDoNotContactFlag) Retrieve indicates whether the owner of the quote chosen to no longer be contacted. +
              #### [getObject](/reference/services/SoftLayer_Billing_Order_Cart/getObject) Retrieve a SoftLayer_Billing_Order_Cart record. +
              #### [getOrder](/reference/services/SoftLayer_Billing_Order_Cart/getOrder) Retrieve this order contains the records for which products were selected for this quote. +
              #### [getOrdersFromQuote](/reference/services/SoftLayer_Billing_Order_Cart/getOrdersFromQuote) Retrieve these are all the orders that were created from this quote. +
              #### [getPdf](/reference/services/SoftLayer_Billing_Order_Cart/getPdf) Retrieve a PDF copy of the cart. +
              #### [getQuoteByQuoteKey](/reference/services/SoftLayer_Billing_Order_Cart/getQuoteByQuoteKey) Retrieve a [SoftLayer_Billing_Order_Quote]({{}}) by the quote key specified. +
              #### [getRecalculatedOrderContainer](/reference/services/SoftLayer_Billing_Order_Cart/getRecalculatedOrderContainer) Retrieve order container from a saved cart +
              #### [placeOrder](/reference/services/SoftLayer_Billing_Order_Cart/placeOrder) Place an order +
              #### [placeQuote](/reference/services/SoftLayer_Billing_Order_Cart/placeQuote) Saves changes to a quote +
              #### [saveQuote](/reference/services/SoftLayer_Billing_Order_Cart/saveQuote) Save the quote of an order +
              #### [updateCart](/reference/services/SoftLayer_Billing_Order_Cart/updateCart) Update an existing cart with the modified order data +
              #### [verifyOrder](/reference/services/SoftLayer_Billing_Order_Cart/verifyOrder) Verify an order +
              #### [withdrawGdprAcceptance](/reference/services/SoftLayer_Billing_Order_Cart/withdrawGdprAcceptance) Withdraws the users acceptance of the GDPR terms. +
              diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/claim.md b/content/reference/services/SoftLayer_Billing_Order_Cart/claim.md index 2c9942aeb9..3608570c69 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/claim.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/claim.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::claim + Claim an anonymous quote diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/createCart.md b/content/reference/services/SoftLayer_Billing_Order_Cart/createCart.md index 7b6939f9d1..243996229e 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/createCart.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/createCart.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::createCart + Create a new cart from the order data provided diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/deleteCart.md b/content/reference/services/SoftLayer_Billing_Order_Cart/deleteCart.md index eaaa3dc454..186ba8adbc 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/deleteCart.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/deleteCart.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::deleteCart + Delete an existing cart diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/deleteQuote.md b/content/reference/services/SoftLayer_Billing_Order_Cart/deleteQuote.md index ae4d51067c..b12d811285 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/deleteQuote.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/deleteQuote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::deleteQuote + Delete the quote of an order diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/getAccount.md b/content/reference/services/SoftLayer_Billing_Order_Cart/getAccount.md index dee9ecbf45..257cbad113 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/getAccount.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::getAccount + Retrieve a quote's corresponding account. diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/getCartByCartKey.md b/content/reference/services/SoftLayer_Billing_Order_Cart/getCartByCartKey.md index 82207f9b15..904f390b68 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/getCartByCartKey.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/getCartByCartKey.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::getCartByCartKey + Retrieve a cart. diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/getDoNotContactFlag.md b/content/reference/services/SoftLayer_Billing_Order_Cart/getDoNotContactFlag.md index 3671a9ac62..36e2d47327 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/getDoNotContactFlag.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/getDoNotContactFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::getDoNotContactFlag + Retrieve indicates whether the owner of the quote chosen to no longer be contacted. diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/getObject.md b/content/reference/services/SoftLayer_Billing_Order_Cart/getObject.md index 59a6f24849..e99ba51687 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/getObject.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::getObject + Retrieve a SoftLayer_Billing_Order_Cart record. diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/getOrder.md b/content/reference/services/SoftLayer_Billing_Order_Cart/getOrder.md index 58873841a7..8d0022dd5a 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/getOrder.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/getOrder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::getOrder + Retrieve this order contains the records for which products were selected for this quote. diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/getOrdersFromQuote.md b/content/reference/services/SoftLayer_Billing_Order_Cart/getOrdersFromQuote.md index b718517cc5..bc2ff764ae 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/getOrdersFromQuote.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/getOrdersFromQuote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::getOrdersFromQuote + Retrieve these are all the orders that were created from this quote. diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/getPdf.md b/content/reference/services/SoftLayer_Billing_Order_Cart/getPdf.md index 27e53b74c9..e5964d74d2 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/getPdf.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/getPdf.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::getPdf + Retrieve a PDF copy of the cart. diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/getQuoteByQuoteKey.md b/content/reference/services/SoftLayer_Billing_Order_Cart/getQuoteByQuoteKey.md index 80ec3ee8b1..5ec2e6da7c 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/getQuoteByQuoteKey.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/getQuoteByQuoteKey.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::getQuoteByQuoteKey + Retrieve a [SoftLayer_Billing_Order_Quote]({{}}) by the quote key specified. diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/getRecalculatedOrderContainer.md b/content/reference/services/SoftLayer_Billing_Order_Cart/getRecalculatedOrderContainer.md index 8bc09a9796..8e1612dbd4 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/getRecalculatedOrderContainer.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/getRecalculatedOrderContainer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::getRecalculatedOrderContainer + Retrieve order container from a saved cart diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/placeOrder.md b/content/reference/services/SoftLayer_Billing_Order_Cart/placeOrder.md index c94db31d2f..ad17c86b48 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/placeOrder.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/placeOrder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::placeOrder + Place an order diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/placeQuote.md b/content/reference/services/SoftLayer_Billing_Order_Cart/placeQuote.md index c67da34eda..f54f3e0f67 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/placeQuote.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/placeQuote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::placeQuote + Saves changes to a quote diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/saveQuote.md b/content/reference/services/SoftLayer_Billing_Order_Cart/saveQuote.md index 104a217820..24e748962a 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/saveQuote.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/saveQuote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::saveQuote + Save the quote of an order diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/updateCart.md b/content/reference/services/SoftLayer_Billing_Order_Cart/updateCart.md index 5a30c87cf5..b7bfd0cac5 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/updateCart.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/updateCart.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::updateCart + Update an existing cart with the modified order data diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/verifyOrder.md b/content/reference/services/SoftLayer_Billing_Order_Cart/verifyOrder.md index 06398cd78d..d2d928e6e0 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/verifyOrder.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/verifyOrder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::verifyOrder + Verify an order diff --git a/content/reference/services/SoftLayer_Billing_Order_Cart/withdrawGdprAcceptance.md b/content/reference/services/SoftLayer_Billing_Order_Cart/withdrawGdprAcceptance.md index a53a96936d..c7de37e075 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Cart/withdrawGdprAcceptance.md +++ b/content/reference/services/SoftLayer_Billing_Order_Cart/withdrawGdprAcceptance.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Cart](/reference/services/SoftLayer_Billing_Order_Cart)::withdrawGdprAcceptance + Withdraws the users acceptance of the GDPR terms. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/_index.md b/content/reference/services/SoftLayer_Billing_Order_Item/_index.md index 53d902ef9d..57aa811321 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/_index.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -44,144 +46,168 @@ This also provides information about software or hardware related to an ordered #### [getBillingItem](/reference/services/SoftLayer_Billing_Order_Item/getBillingItem) Retrieve the SoftLayer_Billing_Item tied to the order item. +
              #### [getBundledItems](/reference/services/SoftLayer_Billing_Order_Item/getBundledItems) Retrieve the other items included with an ordered item. +
              #### [getCategory](/reference/services/SoftLayer_Billing_Order_Item/getCategory) Retrieve the item category tied to an order item. +
              #### [getChildren](/reference/services/SoftLayer_Billing_Order_Item/getChildren) Retrieve the child order items for an order item. All server order items should have children. These children are considered a part of the server. +
              #### [getGlobalIdentifier](/reference/services/SoftLayer_Billing_Order_Item/getGlobalIdentifier) Retrieve a hardware's universally unique identifier. +
              #### [getHardwareGenericComponent](/reference/services/SoftLayer_Billing_Order_Item/getHardwareGenericComponent) Retrieve the component type tied to an order item. All hardware-specific items should have a generic hardware component. +
              #### [getItem](/reference/services/SoftLayer_Billing_Order_Item/getItem) Retrieve the SoftLayer_Product_Item tied to an order item. The item is the actual definition of the product being sold. +
              #### [getItemCategoryAnswers](/reference/services/SoftLayer_Billing_Order_Item/getItemCategoryAnswers) Retrieve this is an item's category answers. +
              #### [getItemPrice](/reference/services/SoftLayer_Billing_Order_Item/getItemPrice) Retrieve the SoftLayer_Product_Item_Price tied to an order item. The item price object describes the cost of an item. +
              #### [getLocation](/reference/services/SoftLayer_Billing_Order_Item/getLocation) Retrieve the location of an ordered item. This is usually the same as the server it is being ordered with. Otherwise it describes the location of the additional service being ordered. +
              #### [getNextOrderChildren](/reference/services/SoftLayer_Billing_Order_Item/getNextOrderChildren) +
              #### [getObject](/reference/services/SoftLayer_Billing_Order_Item/getObject) Retrieve a SoftLayer_Billing_Order_Item record. +
              #### [getOldBillingItem](/reference/services/SoftLayer_Billing_Order_Item/getOldBillingItem) Retrieve this is only populated when an upgrade order is placed. The old billing item represents what the billing was before the upgrade happened. +
              #### [getOrder](/reference/services/SoftLayer_Billing_Order_Item/getOrder) Retrieve the order to which this item belongs. The order contains all the information related to the items included in an order +
              #### [getOrderApprovalDate](/reference/services/SoftLayer_Billing_Order_Item/getOrderApprovalDate) +
              #### [getPackage](/reference/services/SoftLayer_Billing_Order_Item/getPackage) Retrieve the SoftLayer_Product_Package an order item is a part of. +
              #### [getParent](/reference/services/SoftLayer_Billing_Order_Item/getParent) Retrieve the parent order item ID for an item. Items that are associated with a server will have a parent. The parent will be the server item itself. +
              #### [getPreset](/reference/services/SoftLayer_Billing_Order_Item/getPreset) Retrieve the SoftLayer_Product_Package_Preset related to this order item. +
              #### [getPromoCode](/reference/services/SoftLayer_Billing_Order_Item/getPromoCode) +
              #### [getRedundantPowerSupplyCount](/reference/services/SoftLayer_Billing_Order_Item/getRedundantPowerSupplyCount) Retrieve a count of power supplies contained within this SoftLayer_Billing_Order +
              #### [getSoftwareDescription](/reference/services/SoftLayer_Billing_Order_Item/getSoftwareDescription) Retrieve for ordered items that are software items, a full description of that software can be found with this property. +
              #### [getStorageGroups](/reference/services/SoftLayer_Billing_Order_Item/getStorageGroups) Retrieve the drive storage groups that are attached to this billing order item. +
              #### [getTotalRecurringAmount](/reference/services/SoftLayer_Billing_Order_Item/getTotalRecurringAmount) Retrieve the recurring fee of an ordered item. This amount represents the fees that will be charged on a recurring (usually monthly) basis. +
              #### [getUpgradeItem](/reference/services/SoftLayer_Billing_Order_Item/getUpgradeItem) Retrieve the next SoftLayer_Product_Item in the upgrade path for this order item. +
              diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getBillingItem.md b/content/reference/services/SoftLayer_Billing_Order_Item/getBillingItem.md index 6f7631e63a..902ba8cd92 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getBillingItem.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getBillingItem + Retrieve the SoftLayer_Billing_Item tied to the order item. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getBundledItems.md b/content/reference/services/SoftLayer_Billing_Order_Item/getBundledItems.md index f6bf57cfbd..8f76caabcf 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getBundledItems.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getBundledItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getBundledItems + Retrieve the other items included with an ordered item. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getCategory.md b/content/reference/services/SoftLayer_Billing_Order_Item/getCategory.md index ff9f544ee3..96d29e6be2 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getCategory.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getCategory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getCategory + Retrieve the item category tied to an order item. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getChildren.md b/content/reference/services/SoftLayer_Billing_Order_Item/getChildren.md index 1f0565e251..091e2d40c0 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getChildren.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getChildren + Retrieve the child order items for an order item. All server order items should have children. These children are considered a part of the server. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getGlobalIdentifier.md b/content/reference/services/SoftLayer_Billing_Order_Item/getGlobalIdentifier.md index acb8f43dd9..13c3c31d7a 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getGlobalIdentifier.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getGlobalIdentifier.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getGlobalIdentifier + Retrieve a hardware's universally unique identifier. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getHardwareGenericComponent.md b/content/reference/services/SoftLayer_Billing_Order_Item/getHardwareGenericComponent.md index b35dba84c8..cfaec302eb 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getHardwareGenericComponent.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getHardwareGenericComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getHardwareGenericComponent + Retrieve the component type tied to an order item. All hardware-specific items should have a generic hardware component. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getItem.md b/content/reference/services/SoftLayer_Billing_Order_Item/getItem.md index 2f654dbc97..9f5c11a691 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getItem.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getItem + Retrieve the SoftLayer_Product_Item tied to an order item. The item is the actual definition of the product being sold. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getItemCategoryAnswers.md b/content/reference/services/SoftLayer_Billing_Order_Item/getItemCategoryAnswers.md index 66b790b240..67935540a5 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getItemCategoryAnswers.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getItemCategoryAnswers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getItemCategoryAnswers + Retrieve this is an item's category answers. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getItemPrice.md b/content/reference/services/SoftLayer_Billing_Order_Item/getItemPrice.md index 84d3381078..65fd791829 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getItemPrice.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getItemPrice.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getItemPrice + Retrieve the SoftLayer_Product_Item_Price tied to an order item. The item price object describes the cost of an item. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getLocation.md b/content/reference/services/SoftLayer_Billing_Order_Item/getLocation.md index 7e812938c2..2be7c795c2 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getLocation.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getLocation + Retrieve the location of an ordered item. This is usually the same as the server it is being ordered with. Otherwise it describes the location of the additional service being ordered. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getNextOrderChildren.md b/content/reference/services/SoftLayer_Billing_Order_Item/getNextOrderChildren.md index d54a9ec13e..557743397e 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getNextOrderChildren.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getNextOrderChildren.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getObject.md b/content/reference/services/SoftLayer_Billing_Order_Item/getObject.md index 7a0f6b182a..6b375bfb8b 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getObject.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getObject + Retrieve a SoftLayer_Billing_Order_Item record. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getOldBillingItem.md b/content/reference/services/SoftLayer_Billing_Order_Item/getOldBillingItem.md index 82f2504d19..e1ff15d698 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getOldBillingItem.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getOldBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getOldBillingItem + Retrieve this is only populated when an upgrade order is placed. The old billing item represents what the billing was before the upgrade happened. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getOrder.md b/content/reference/services/SoftLayer_Billing_Order_Item/getOrder.md index 0a7fe762a4..fcc3d3dbc8 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getOrder.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getOrder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getOrder + Retrieve the order to which this item belongs. The order contains all the information related to the items included in an order diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getOrderApprovalDate.md b/content/reference/services/SoftLayer_Billing_Order_Item/getOrderApprovalDate.md index 9dfb552ab4..01405446d6 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getOrderApprovalDate.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getOrderApprovalDate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getPackage.md b/content/reference/services/SoftLayer_Billing_Order_Item/getPackage.md index e0438d1133..56f5002843 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getPackage.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getPackage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getPackage + Retrieve the SoftLayer_Product_Package an order item is a part of. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getParent.md b/content/reference/services/SoftLayer_Billing_Order_Item/getParent.md index c9f1731c0e..8ad6d0ba6a 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getParent.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getParent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getParent + Retrieve the parent order item ID for an item. Items that are associated with a server will have a parent. The parent will be the server item itself. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getPreset.md b/content/reference/services/SoftLayer_Billing_Order_Item/getPreset.md index 197dc75165..421cb506e8 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getPreset.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getPreset.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getPreset + Retrieve the SoftLayer_Product_Package_Preset related to this order item. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getPromoCode.md b/content/reference/services/SoftLayer_Billing_Order_Item/getPromoCode.md index c57c557f3c..1c8eba2da2 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getPromoCode.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getPromoCode.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getRedundantPowerSupplyCount.md b/content/reference/services/SoftLayer_Billing_Order_Item/getRedundantPowerSupplyCount.md index 436d60f642..869fb2b9e4 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getRedundantPowerSupplyCount.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getRedundantPowerSupplyCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getRedundantPowerSupplyCount + Retrieve a count of power supplies contained within this SoftLayer_Billing_Order diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getSoftwareDescription.md b/content/reference/services/SoftLayer_Billing_Order_Item/getSoftwareDescription.md index be003ef004..f5533468fd 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getSoftwareDescription.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getSoftwareDescription.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getSoftwareDescription + Retrieve for ordered items that are software items, a full description of that software can be found with this property. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getStorageGroups.md b/content/reference/services/SoftLayer_Billing_Order_Item/getStorageGroups.md index dafce5ab3a..ddf244e76a 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getStorageGroups.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getStorageGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getStorageGroups + Retrieve the drive storage groups that are attached to this billing order item. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getTotalRecurringAmount.md b/content/reference/services/SoftLayer_Billing_Order_Item/getTotalRecurringAmount.md index 5092128de4..1ae4a84046 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getTotalRecurringAmount.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getTotalRecurringAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getTotalRecurringAmount + Retrieve the recurring fee of an ordered item. This amount represents the fees that will be charged on a recurring (usually monthly) basis. diff --git a/content/reference/services/SoftLayer_Billing_Order_Item/getUpgradeItem.md b/content/reference/services/SoftLayer_Billing_Order_Item/getUpgradeItem.md index a8d3bb6a06..e23851c6fe 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Item/getUpgradeItem.md +++ b/content/reference/services/SoftLayer_Billing_Order_Item/getUpgradeItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Item](/reference/services/SoftLayer_Billing_Order_Item)::getUpgradeItem + Retrieve the next SoftLayer_Product_Item in the upgrade path for this order item. diff --git a/content/reference/services/SoftLayer_Billing_Order_Quote/_index.md b/content/reference/services/SoftLayer_Billing_Order_Quote/_index.md index 7110095c4d..2cfa92e4e5 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Quote/_index.md +++ b/content/reference/services/SoftLayer_Billing_Order_Quote/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,90 +52,105 @@ Query the [SoftLayer_Account]({{}}) #### [claim](/reference/services/SoftLayer_Billing_Order_Quote/claim) Claim an anonymous quote +
              #### [deleteQuote](/reference/services/SoftLayer_Billing_Order_Quote/deleteQuote) Delete the quote of an order +
              #### [getAccount](/reference/services/SoftLayer_Billing_Order_Quote/getAccount) Retrieve a quote's corresponding account. +
              #### [getDoNotContactFlag](/reference/services/SoftLayer_Billing_Order_Quote/getDoNotContactFlag) Retrieve indicates whether the owner of the quote chosen to no longer be contacted. +
              #### [getObject](/reference/services/SoftLayer_Billing_Order_Quote/getObject) Retrieve a SoftLayer_Billing_Order_Quote record. +
              #### [getOrder](/reference/services/SoftLayer_Billing_Order_Quote/getOrder) Retrieve this order contains the records for which products were selected for this quote. +
              #### [getOrdersFromQuote](/reference/services/SoftLayer_Billing_Order_Quote/getOrdersFromQuote) Retrieve these are all the orders that were created from this quote. +
              #### [getPdf](/reference/services/SoftLayer_Billing_Order_Quote/getPdf) Retrieve a PDF copy of a quote. +
              #### [getQuoteByQuoteKey](/reference/services/SoftLayer_Billing_Order_Quote/getQuoteByQuoteKey) Retrieve a [SoftLayer_Billing_Order_Quote]({{}}) by the quote key specified. +
              #### [getRecalculatedOrderContainer](/reference/services/SoftLayer_Billing_Order_Quote/getRecalculatedOrderContainer) Generate an [SoftLayer_Container_Product_Order]({{}}) from the previously-created quote. +
              #### [placeOrder](/reference/services/SoftLayer_Billing_Order_Quote/placeOrder) Place an order +
              #### [placeQuote](/reference/services/SoftLayer_Billing_Order_Quote/placeQuote) Saves changes to a quote +
              #### [saveQuote](/reference/services/SoftLayer_Billing_Order_Quote/saveQuote) Save the quote of an order +
              #### [verifyOrder](/reference/services/SoftLayer_Billing_Order_Quote/verifyOrder) Verify an order +
              #### [withdrawGdprAcceptance](/reference/services/SoftLayer_Billing_Order_Quote/withdrawGdprAcceptance) Withdraws the users acceptance of the GDPR terms. +
              diff --git a/content/reference/services/SoftLayer_Billing_Order_Quote/claim.md b/content/reference/services/SoftLayer_Billing_Order_Quote/claim.md index 5a6b96847d..b6488aeb7b 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Quote/claim.md +++ b/content/reference/services/SoftLayer_Billing_Order_Quote/claim.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Quote](/reference/services/SoftLayer_Billing_Order_Quote)::claim + Claim an anonymous quote diff --git a/content/reference/services/SoftLayer_Billing_Order_Quote/deleteQuote.md b/content/reference/services/SoftLayer_Billing_Order_Quote/deleteQuote.md index 3bafc5e45a..b30a28e573 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Quote/deleteQuote.md +++ b/content/reference/services/SoftLayer_Billing_Order_Quote/deleteQuote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Quote](/reference/services/SoftLayer_Billing_Order_Quote)::deleteQuote + Delete the quote of an order diff --git a/content/reference/services/SoftLayer_Billing_Order_Quote/getAccount.md b/content/reference/services/SoftLayer_Billing_Order_Quote/getAccount.md index a63a4cef00..107e3d378e 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Quote/getAccount.md +++ b/content/reference/services/SoftLayer_Billing_Order_Quote/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Quote](/reference/services/SoftLayer_Billing_Order_Quote)::getAccount + Retrieve a quote's corresponding account. diff --git a/content/reference/services/SoftLayer_Billing_Order_Quote/getDoNotContactFlag.md b/content/reference/services/SoftLayer_Billing_Order_Quote/getDoNotContactFlag.md index f74251328c..c754e44b8e 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Quote/getDoNotContactFlag.md +++ b/content/reference/services/SoftLayer_Billing_Order_Quote/getDoNotContactFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Quote](/reference/services/SoftLayer_Billing_Order_Quote)::getDoNotContactFlag + Retrieve indicates whether the owner of the quote chosen to no longer be contacted. diff --git a/content/reference/services/SoftLayer_Billing_Order_Quote/getObject.md b/content/reference/services/SoftLayer_Billing_Order_Quote/getObject.md index 3be54806ad..626380546b 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Quote/getObject.md +++ b/content/reference/services/SoftLayer_Billing_Order_Quote/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Quote](/reference/services/SoftLayer_Billing_Order_Quote)::getObject + Retrieve a SoftLayer_Billing_Order_Quote record. diff --git a/content/reference/services/SoftLayer_Billing_Order_Quote/getOrder.md b/content/reference/services/SoftLayer_Billing_Order_Quote/getOrder.md index 550841dd88..6cc49fb29d 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Quote/getOrder.md +++ b/content/reference/services/SoftLayer_Billing_Order_Quote/getOrder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Quote](/reference/services/SoftLayer_Billing_Order_Quote)::getOrder + Retrieve this order contains the records for which products were selected for this quote. diff --git a/content/reference/services/SoftLayer_Billing_Order_Quote/getOrdersFromQuote.md b/content/reference/services/SoftLayer_Billing_Order_Quote/getOrdersFromQuote.md index 4074cf29c5..ab8fce1200 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Quote/getOrdersFromQuote.md +++ b/content/reference/services/SoftLayer_Billing_Order_Quote/getOrdersFromQuote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Quote](/reference/services/SoftLayer_Billing_Order_Quote)::getOrdersFromQuote + Retrieve these are all the orders that were created from this quote. diff --git a/content/reference/services/SoftLayer_Billing_Order_Quote/getPdf.md b/content/reference/services/SoftLayer_Billing_Order_Quote/getPdf.md index 37ddefdd03..d018edba3b 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Quote/getPdf.md +++ b/content/reference/services/SoftLayer_Billing_Order_Quote/getPdf.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Quote](/reference/services/SoftLayer_Billing_Order_Quote)::getPdf + Retrieve a PDF copy of a quote. diff --git a/content/reference/services/SoftLayer_Billing_Order_Quote/getQuoteByQuoteKey.md b/content/reference/services/SoftLayer_Billing_Order_Quote/getQuoteByQuoteKey.md index ba46babea3..14d21eee33 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Quote/getQuoteByQuoteKey.md +++ b/content/reference/services/SoftLayer_Billing_Order_Quote/getQuoteByQuoteKey.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Quote](/reference/services/SoftLayer_Billing_Order_Quote)::getQuoteByQuoteKey + Retrieve a [SoftLayer_Billing_Order_Quote]({{}}) by the quote key specified. diff --git a/content/reference/services/SoftLayer_Billing_Order_Quote/getRecalculatedOrderContainer.md b/content/reference/services/SoftLayer_Billing_Order_Quote/getRecalculatedOrderContainer.md index a0389df4f8..ddf566af96 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Quote/getRecalculatedOrderContainer.md +++ b/content/reference/services/SoftLayer_Billing_Order_Quote/getRecalculatedOrderContainer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Quote](/reference/services/SoftLayer_Billing_Order_Quote)::getRecalculatedOrderContainer + Generate an [SoftLayer_Container_Product_Order]({{}}) from the previously-created quote. diff --git a/content/reference/services/SoftLayer_Billing_Order_Quote/placeOrder.md b/content/reference/services/SoftLayer_Billing_Order_Quote/placeOrder.md index a0a51d07f8..69f114c3d4 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Quote/placeOrder.md +++ b/content/reference/services/SoftLayer_Billing_Order_Quote/placeOrder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Quote](/reference/services/SoftLayer_Billing_Order_Quote)::placeOrder + Place an order diff --git a/content/reference/services/SoftLayer_Billing_Order_Quote/placeQuote.md b/content/reference/services/SoftLayer_Billing_Order_Quote/placeQuote.md index 5beb094016..b55b430435 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Quote/placeQuote.md +++ b/content/reference/services/SoftLayer_Billing_Order_Quote/placeQuote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Quote](/reference/services/SoftLayer_Billing_Order_Quote)::placeQuote + Saves changes to a quote diff --git a/content/reference/services/SoftLayer_Billing_Order_Quote/saveQuote.md b/content/reference/services/SoftLayer_Billing_Order_Quote/saveQuote.md index fe8e6d627c..49b2cfcd32 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Quote/saveQuote.md +++ b/content/reference/services/SoftLayer_Billing_Order_Quote/saveQuote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Quote](/reference/services/SoftLayer_Billing_Order_Quote)::saveQuote + Save the quote of an order diff --git a/content/reference/services/SoftLayer_Billing_Order_Quote/verifyOrder.md b/content/reference/services/SoftLayer_Billing_Order_Quote/verifyOrder.md index 421cb95133..d9a5291214 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Quote/verifyOrder.md +++ b/content/reference/services/SoftLayer_Billing_Order_Quote/verifyOrder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Quote](/reference/services/SoftLayer_Billing_Order_Quote)::verifyOrder + Verify an order diff --git a/content/reference/services/SoftLayer_Billing_Order_Quote/withdrawGdprAcceptance.md b/content/reference/services/SoftLayer_Billing_Order_Quote/withdrawGdprAcceptance.md index d2f941f541..9bcf69a5ae 100644 --- a/content/reference/services/SoftLayer_Billing_Order_Quote/withdrawGdprAcceptance.md +++ b/content/reference/services/SoftLayer_Billing_Order_Quote/withdrawGdprAcceptance.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Billing_Order_Quote](/reference/services/SoftLayer_Billing_Order_Quote)::withdrawGdprAcceptance + Withdraws the users acceptance of the GDPR terms. diff --git a/content/reference/services/SoftLayer_Brand/_index.md b/content/reference/services/SoftLayer_Brand/_index.md index 93ff319f05..8f2febef73 100644 --- a/content/reference/services/SoftLayer_Brand/_index.md +++ b/content/reference/services/SoftLayer_Brand/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + 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. @@ -46,204 +48,241 @@ IBM Cloud Infrastructure customers are unable to change their brand information #### [createCustomerAccount](/reference/services/SoftLayer_Brand/createCustomerAccount) Create a new customer account record. +
              #### [createObject](/reference/services/SoftLayer_Brand/createObject) Create a new brand. +
              #### [disableAccount](/reference/services/SoftLayer_Brand/disableAccount) +
              #### [getAccount](/reference/services/SoftLayer_Brand/getAccount) +
              #### [getAllOwnedAccounts](/reference/services/SoftLayer_Brand/getAllOwnedAccounts) Retrieve all accounts owned by the brand. +
              -
              +
              #### [getAllTicketSubjects](/reference/services/SoftLayer_Brand/getAllTicketSubjects) + +Deprecated + +
              #### [getAllowAccountCreationFlag](/reference/services/SoftLayer_Brand/getAllowAccountCreationFlag) Retrieve this flag indicates if creation of accounts is allowed. +
              #### [getBusinessPartner](/reference/services/SoftLayer_Brand/getBusinessPartner) Retrieve business Partner details for the brand. Country Enterprise Code, Channel, Segment, Reseller Level. +
              #### [getBusinessPartnerFlag](/reference/services/SoftLayer_Brand/getBusinessPartnerFlag) Retrieve flag indicating if the brand is a business partner. +
              #### [getCatalog](/reference/services/SoftLayer_Brand/getCatalog) Retrieve the Product Catalog for the Brand +
              #### [getContactInformation](/reference/services/SoftLayer_Brand/getContactInformation) Retrieve the contact information for the customer account brand. +
              #### [getContacts](/reference/services/SoftLayer_Brand/getContacts) Retrieve the contacts for the brand. +
              #### [getCustomerCountryLocationRestrictions](/reference/services/SoftLayer_Brand/getCustomerCountryLocationRestrictions) Retrieve this references 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 this brand for customers that live in Great Britain. +
              #### [getDistributor](/reference/services/SoftLayer_Brand/getDistributor) +
              #### [getDistributorChildFlag](/reference/services/SoftLayer_Brand/getDistributorChildFlag) +
              #### [getDistributorFlag](/reference/services/SoftLayer_Brand/getDistributorFlag) +
              #### [getHardware](/reference/services/SoftLayer_Brand/getHardware) Retrieve an account's associated hardware objects. +
              #### [getHasAgentAdvancedSupportFlag](/reference/services/SoftLayer_Brand/getHasAgentAdvancedSupportFlag) +
              #### [getHasAgentSupportFlag](/reference/services/SoftLayer_Brand/getHasAgentSupportFlag) +
              #### [getMerchantName](/reference/services/SoftLayer_Brand/getMerchantName) +
              #### [getObject](/reference/services/SoftLayer_Brand/getObject) Retrieve a SoftLayer_Brand record. +
              #### [getOpenTickets](/reference/services/SoftLayer_Brand/getOpenTickets) +
              #### [getOwnedAccounts](/reference/services/SoftLayer_Brand/getOwnedAccounts) Retrieve active accounts owned by the brand. +
              #### [getSecurityLevel](/reference/services/SoftLayer_Brand/getSecurityLevel) +
              #### [getTicketGroups](/reference/services/SoftLayer_Brand/getTicketGroups) +
              #### [getTickets](/reference/services/SoftLayer_Brand/getTickets) +
              #### [getToken](/reference/services/SoftLayer_Brand/getToken) +
              #### [getUsers](/reference/services/SoftLayer_Brand/getUsers) +
              #### [getVirtualGuests](/reference/services/SoftLayer_Brand/getVirtualGuests) Retrieve an account's associated virtual guest objects. +
              #### [isIbmSlicBrand](/reference/services/SoftLayer_Brand/isIbmSlicBrand) Check if the brand is IBM SLIC top level brand or sub brand. +
              #### [isPlatformServicesBrand](/reference/services/SoftLayer_Brand/isPlatformServicesBrand) Check if the alternate billing system of brand is Bluemix. +
              #### [reactivateAccount](/reference/services/SoftLayer_Brand/reactivateAccount) +
              #### [verifyCanDisableAccount](/reference/services/SoftLayer_Brand/verifyCanDisableAccount) +
              #### [verifyCanReactivateAccount](/reference/services/SoftLayer_Brand/verifyCanReactivateAccount) +
              diff --git a/content/reference/services/SoftLayer_Brand/createCustomerAccount.md b/content/reference/services/SoftLayer_Brand/createCustomerAccount.md index 2198c6721a..a449ce4a53 100644 --- a/content/reference/services/SoftLayer_Brand/createCustomerAccount.md +++ b/content/reference/services/SoftLayer_Brand/createCustomerAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand](/reference/services/SoftLayer_Brand)::createCustomerAccount + Create a new customer account record. diff --git a/content/reference/services/SoftLayer_Brand/createObject.md b/content/reference/services/SoftLayer_Brand/createObject.md index 6b152577cf..b054067495 100644 --- a/content/reference/services/SoftLayer_Brand/createObject.md +++ b/content/reference/services/SoftLayer_Brand/createObject.md @@ -14,6 +14,7 @@ aliases: --- # [SoftLayer_Brand](/reference/services/SoftLayer_Brand)::createObject + Create a new brand. diff --git a/content/reference/services/SoftLayer_Brand/disableAccount.md b/content/reference/services/SoftLayer_Brand/disableAccount.md index 545c45351b..d3b3488707 100644 --- a/content/reference/services/SoftLayer_Brand/disableAccount.md +++ b/content/reference/services/SoftLayer_Brand/disableAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview Disable an account associated with this Brand. Anything that would disqualify the account from being disabled will cause an exception to be raised. diff --git a/content/reference/services/SoftLayer_Brand/getAccount.md b/content/reference/services/SoftLayer_Brand/getAccount.md index e28331e369..1eddd3c802 100644 --- a/content/reference/services/SoftLayer_Brand/getAccount.md +++ b/content/reference/services/SoftLayer_Brand/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Brand/getAllOwnedAccounts.md b/content/reference/services/SoftLayer_Brand/getAllOwnedAccounts.md index ae4b5f0ae6..30e2f5ac77 100644 --- a/content/reference/services/SoftLayer_Brand/getAllOwnedAccounts.md +++ b/content/reference/services/SoftLayer_Brand/getAllOwnedAccounts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand](/reference/services/SoftLayer_Brand)::getAllOwnedAccounts + Retrieve all accounts owned by the brand. diff --git a/content/reference/services/SoftLayer_Brand/getAllTicketSubjects.md b/content/reference/services/SoftLayer_Brand/getAllTicketSubjects.md index a5a299414d..5771cd20f8 100644 --- a/content/reference/services/SoftLayer_Brand/getAllTicketSubjects.md +++ b/content/reference/services/SoftLayer_Brand/getAllTicketSubjects.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Brand](/reference/services/SoftLayer_Brand)::getAllTicketSubjects +
              Deprecated
              + diff --git a/content/reference/services/SoftLayer_Brand/getAllowAccountCreationFlag.md b/content/reference/services/SoftLayer_Brand/getAllowAccountCreationFlag.md index b4c39fcd16..6188dd5647 100644 --- a/content/reference/services/SoftLayer_Brand/getAllowAccountCreationFlag.md +++ b/content/reference/services/SoftLayer_Brand/getAllowAccountCreationFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand](/reference/services/SoftLayer_Brand)::getAllowAccountCreationFlag + Retrieve this flag indicates if creation of accounts is allowed. diff --git a/content/reference/services/SoftLayer_Brand/getBusinessPartner.md b/content/reference/services/SoftLayer_Brand/getBusinessPartner.md index b6fb048326..2819753e47 100644 --- a/content/reference/services/SoftLayer_Brand/getBusinessPartner.md +++ b/content/reference/services/SoftLayer_Brand/getBusinessPartner.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand](/reference/services/SoftLayer_Brand)::getBusinessPartner + Retrieve business Partner details for the brand. Country Enterprise Code, Channel, Segment, Reseller Level. diff --git a/content/reference/services/SoftLayer_Brand/getBusinessPartnerFlag.md b/content/reference/services/SoftLayer_Brand/getBusinessPartnerFlag.md index 1ab7dd5e2d..4f962bb41e 100644 --- a/content/reference/services/SoftLayer_Brand/getBusinessPartnerFlag.md +++ b/content/reference/services/SoftLayer_Brand/getBusinessPartnerFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand](/reference/services/SoftLayer_Brand)::getBusinessPartnerFlag + Retrieve flag indicating if the brand is a business partner. diff --git a/content/reference/services/SoftLayer_Brand/getCatalog.md b/content/reference/services/SoftLayer_Brand/getCatalog.md index d525856ae4..9ae21d0018 100644 --- a/content/reference/services/SoftLayer_Brand/getCatalog.md +++ b/content/reference/services/SoftLayer_Brand/getCatalog.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand](/reference/services/SoftLayer_Brand)::getCatalog + Retrieve the Product Catalog for the Brand diff --git a/content/reference/services/SoftLayer_Brand/getContactInformation.md b/content/reference/services/SoftLayer_Brand/getContactInformation.md index 03a627fa7f..ba75b0905f 100644 --- a/content/reference/services/SoftLayer_Brand/getContactInformation.md +++ b/content/reference/services/SoftLayer_Brand/getContactInformation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand](/reference/services/SoftLayer_Brand)::getContactInformation + Retrieve the contact information for the customer account brand. diff --git a/content/reference/services/SoftLayer_Brand/getContacts.md b/content/reference/services/SoftLayer_Brand/getContacts.md index 1533e90752..959c6b6be9 100644 --- a/content/reference/services/SoftLayer_Brand/getContacts.md +++ b/content/reference/services/SoftLayer_Brand/getContacts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand](/reference/services/SoftLayer_Brand)::getContacts + Retrieve the contacts for the brand. diff --git a/content/reference/services/SoftLayer_Brand/getCustomerCountryLocationRestrictions.md b/content/reference/services/SoftLayer_Brand/getCustomerCountryLocationRestrictions.md index bea0f031ae..5f2f820824 100644 --- a/content/reference/services/SoftLayer_Brand/getCustomerCountryLocationRestrictions.md +++ b/content/reference/services/SoftLayer_Brand/getCustomerCountryLocationRestrictions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand](/reference/services/SoftLayer_Brand)::getCustomerCountryLocationRestrictions + Retrieve this references 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 this brand for customers that live in Great Britain. diff --git a/content/reference/services/SoftLayer_Brand/getDistributor.md b/content/reference/services/SoftLayer_Brand/getDistributor.md index 5756d240ff..efb13ce7ad 100644 --- a/content/reference/services/SoftLayer_Brand/getDistributor.md +++ b/content/reference/services/SoftLayer_Brand/getDistributor.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Brand/getDistributorChildFlag.md b/content/reference/services/SoftLayer_Brand/getDistributorChildFlag.md index 438d1f3508..f233371a2d 100644 --- a/content/reference/services/SoftLayer_Brand/getDistributorChildFlag.md +++ b/content/reference/services/SoftLayer_Brand/getDistributorChildFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Brand/getDistributorFlag.md b/content/reference/services/SoftLayer_Brand/getDistributorFlag.md index 7469dfa67e..92a81d08d4 100644 --- a/content/reference/services/SoftLayer_Brand/getDistributorFlag.md +++ b/content/reference/services/SoftLayer_Brand/getDistributorFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Brand/getHardware.md b/content/reference/services/SoftLayer_Brand/getHardware.md index 98992b5107..5689abdfe6 100644 --- a/content/reference/services/SoftLayer_Brand/getHardware.md +++ b/content/reference/services/SoftLayer_Brand/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand](/reference/services/SoftLayer_Brand)::getHardware + Retrieve an account's associated hardware objects. diff --git a/content/reference/services/SoftLayer_Brand/getHasAgentAdvancedSupportFlag.md b/content/reference/services/SoftLayer_Brand/getHasAgentAdvancedSupportFlag.md index 5c233869bf..5710799c27 100644 --- a/content/reference/services/SoftLayer_Brand/getHasAgentAdvancedSupportFlag.md +++ b/content/reference/services/SoftLayer_Brand/getHasAgentAdvancedSupportFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Brand/getHasAgentSupportFlag.md b/content/reference/services/SoftLayer_Brand/getHasAgentSupportFlag.md index a25c8aa70c..45a67c132c 100644 --- a/content/reference/services/SoftLayer_Brand/getHasAgentSupportFlag.md +++ b/content/reference/services/SoftLayer_Brand/getHasAgentSupportFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Brand/getMerchantName.md b/content/reference/services/SoftLayer_Brand/getMerchantName.md index b1382cf522..8732c303fa 100644 --- a/content/reference/services/SoftLayer_Brand/getMerchantName.md +++ b/content/reference/services/SoftLayer_Brand/getMerchantName.md @@ -16,6 +16,7 @@ aliases: + ## Overview Get the payment processor merchant name. diff --git a/content/reference/services/SoftLayer_Brand/getObject.md b/content/reference/services/SoftLayer_Brand/getObject.md index 06f4e9a422..6ffcd14465 100644 --- a/content/reference/services/SoftLayer_Brand/getObject.md +++ b/content/reference/services/SoftLayer_Brand/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand](/reference/services/SoftLayer_Brand)::getObject + Retrieve a SoftLayer_Brand record. diff --git a/content/reference/services/SoftLayer_Brand/getOpenTickets.md b/content/reference/services/SoftLayer_Brand/getOpenTickets.md index 10d13f8d30..8b519361c4 100644 --- a/content/reference/services/SoftLayer_Brand/getOpenTickets.md +++ b/content/reference/services/SoftLayer_Brand/getOpenTickets.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Brand/getOwnedAccounts.md b/content/reference/services/SoftLayer_Brand/getOwnedAccounts.md index 398f8093fb..5f3471d23b 100644 --- a/content/reference/services/SoftLayer_Brand/getOwnedAccounts.md +++ b/content/reference/services/SoftLayer_Brand/getOwnedAccounts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand](/reference/services/SoftLayer_Brand)::getOwnedAccounts + Retrieve active accounts owned by the brand. diff --git a/content/reference/services/SoftLayer_Brand/getSecurityLevel.md b/content/reference/services/SoftLayer_Brand/getSecurityLevel.md index 6f762e048a..8d92794855 100644 --- a/content/reference/services/SoftLayer_Brand/getSecurityLevel.md +++ b/content/reference/services/SoftLayer_Brand/getSecurityLevel.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Brand/getTicketGroups.md b/content/reference/services/SoftLayer_Brand/getTicketGroups.md index ac49eabd39..43f12e47a1 100644 --- a/content/reference/services/SoftLayer_Brand/getTicketGroups.md +++ b/content/reference/services/SoftLayer_Brand/getTicketGroups.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Brand/getTickets.md b/content/reference/services/SoftLayer_Brand/getTickets.md index e2c817fdb8..3a8fc637f5 100644 --- a/content/reference/services/SoftLayer_Brand/getTickets.md +++ b/content/reference/services/SoftLayer_Brand/getTickets.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Brand/getToken.md b/content/reference/services/SoftLayer_Brand/getToken.md index 5586b75b8d..be5d703117 100644 --- a/content/reference/services/SoftLayer_Brand/getToken.md +++ b/content/reference/services/SoftLayer_Brand/getToken.md @@ -16,6 +16,7 @@ aliases: + ## Overview (DEPRECATED) Use [SoftLayer_User_Customer::getImpersonationToken]({{}}) method. diff --git a/content/reference/services/SoftLayer_Brand/getUsers.md b/content/reference/services/SoftLayer_Brand/getUsers.md index dc9438c410..6efba7c23a 100644 --- a/content/reference/services/SoftLayer_Brand/getUsers.md +++ b/content/reference/services/SoftLayer_Brand/getUsers.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Brand/getVirtualGuests.md b/content/reference/services/SoftLayer_Brand/getVirtualGuests.md index 7b68ebf88b..0b61a8fcc4 100644 --- a/content/reference/services/SoftLayer_Brand/getVirtualGuests.md +++ b/content/reference/services/SoftLayer_Brand/getVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand](/reference/services/SoftLayer_Brand)::getVirtualGuests + Retrieve an account's associated virtual guest objects. diff --git a/content/reference/services/SoftLayer_Brand/isIbmSlicBrand.md b/content/reference/services/SoftLayer_Brand/isIbmSlicBrand.md index 2f27be30d8..09165d52c4 100644 --- a/content/reference/services/SoftLayer_Brand/isIbmSlicBrand.md +++ b/content/reference/services/SoftLayer_Brand/isIbmSlicBrand.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand](/reference/services/SoftLayer_Brand)::isIbmSlicBrand + Check if the brand is IBM SLIC top level brand or sub brand. diff --git a/content/reference/services/SoftLayer_Brand/isPlatformServicesBrand.md b/content/reference/services/SoftLayer_Brand/isPlatformServicesBrand.md index 4b4702a63e..d57e2aac34 100644 --- a/content/reference/services/SoftLayer_Brand/isPlatformServicesBrand.md +++ b/content/reference/services/SoftLayer_Brand/isPlatformServicesBrand.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand](/reference/services/SoftLayer_Brand)::isPlatformServicesBrand + Check if the alternate billing system of brand is Bluemix. diff --git a/content/reference/services/SoftLayer_Brand/reactivateAccount.md b/content/reference/services/SoftLayer_Brand/reactivateAccount.md index 33cca01eba..f93b5944bc 100644 --- a/content/reference/services/SoftLayer_Brand/reactivateAccount.md +++ b/content/reference/services/SoftLayer_Brand/reactivateAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview Reactivate an account associated with this Brand. Anything that would disqualify the account from being reactivated will cause an exception to be raised. diff --git a/content/reference/services/SoftLayer_Brand/verifyCanDisableAccount.md b/content/reference/services/SoftLayer_Brand/verifyCanDisableAccount.md index f8d9a3c6e8..6565edcf72 100644 --- a/content/reference/services/SoftLayer_Brand/verifyCanDisableAccount.md +++ b/content/reference/services/SoftLayer_Brand/verifyCanDisableAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview Verify that an account may be disabled by a Brand Agent. Anything that would disqualify the account from being disabled will cause an exception to be raised. diff --git a/content/reference/services/SoftLayer_Brand/verifyCanReactivateAccount.md b/content/reference/services/SoftLayer_Brand/verifyCanReactivateAccount.md index 0df5c57156..c93ea1527d 100644 --- a/content/reference/services/SoftLayer_Brand/verifyCanReactivateAccount.md +++ b/content/reference/services/SoftLayer_Brand/verifyCanReactivateAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview Verify that an account may be reactivated by a Brand Agent. Anything that would disqualify the account from being reactivated will cause an exception to be raised. diff --git a/content/reference/services/SoftLayer_Brand_Business_Partner/_index.md b/content/reference/services/SoftLayer_Brand_Business_Partner/_index.md index 1737e7bc92..74d22e8f21 100644 --- a/content/reference/services/SoftLayer_Brand_Business_Partner/_index.md +++ b/content/reference/services/SoftLayer_Brand_Business_Partner/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,24 +44,28 @@ classes: #### [getBrand](/reference/services/SoftLayer_Brand_Business_Partner/getBrand) Retrieve brand associated with the business partner data +
              #### [getChannel](/reference/services/SoftLayer_Brand_Business_Partner/getChannel) Retrieve channel indicator used to categorize business partner revenue. +
              #### [getObject](/reference/services/SoftLayer_Brand_Business_Partner/getObject) Retrieve a SoftLayer_Brand_Business_Partner record. +
              #### [getSegment](/reference/services/SoftLayer_Brand_Business_Partner/getSegment) Retrieve segment indicator used to categorize business partner revenue. +
              diff --git a/content/reference/services/SoftLayer_Brand_Business_Partner/getBrand.md b/content/reference/services/SoftLayer_Brand_Business_Partner/getBrand.md index 6d0c2a8348..1a0797e085 100644 --- a/content/reference/services/SoftLayer_Brand_Business_Partner/getBrand.md +++ b/content/reference/services/SoftLayer_Brand_Business_Partner/getBrand.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand_Business_Partner](/reference/services/SoftLayer_Brand_Business_Partner)::getBrand + Retrieve brand associated with the business partner data diff --git a/content/reference/services/SoftLayer_Brand_Business_Partner/getChannel.md b/content/reference/services/SoftLayer_Brand_Business_Partner/getChannel.md index d7f1a247ba..cc07883596 100644 --- a/content/reference/services/SoftLayer_Brand_Business_Partner/getChannel.md +++ b/content/reference/services/SoftLayer_Brand_Business_Partner/getChannel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand_Business_Partner](/reference/services/SoftLayer_Brand_Business_Partner)::getChannel + Retrieve channel indicator used to categorize business partner revenue. diff --git a/content/reference/services/SoftLayer_Brand_Business_Partner/getObject.md b/content/reference/services/SoftLayer_Brand_Business_Partner/getObject.md index d2d6204c2c..bf27f3e49e 100644 --- a/content/reference/services/SoftLayer_Brand_Business_Partner/getObject.md +++ b/content/reference/services/SoftLayer_Brand_Business_Partner/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand_Business_Partner](/reference/services/SoftLayer_Brand_Business_Partner)::getObject + Retrieve a SoftLayer_Brand_Business_Partner record. diff --git a/content/reference/services/SoftLayer_Brand_Business_Partner/getSegment.md b/content/reference/services/SoftLayer_Brand_Business_Partner/getSegment.md index f1341f9369..52392d88b6 100644 --- a/content/reference/services/SoftLayer_Brand_Business_Partner/getSegment.md +++ b/content/reference/services/SoftLayer_Brand_Business_Partner/getSegment.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand_Business_Partner](/reference/services/SoftLayer_Brand_Business_Partner)::getSegment + Retrieve segment indicator used to categorize business partner revenue. diff --git a/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/_index.md b/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/_index.md index 374469aeeb..7a95a70c55 100644 --- a/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/_index.md +++ b/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The [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. @@ -42,24 +44,28 @@ The [SoftLayer_Brand_Restriction_Location_CustomerCountry]({{
              #### [getBrand](/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getBrand) Retrieve this references the brand that has a brand-location-country restriction setup. +
              #### [getLocation](/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getLocation) Retrieve this references the datacenter that has a brand-location-country restriction setup. For example, if a datacenter is listed with a restriction for Canada, a Canadian customer may not be eligible to order services at that location. +
              #### [getObject](/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getObject) Retrieve a SoftLayer_Brand_Restriction_Location_CustomerCountry record. +
              diff --git a/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getAllObjects.md b/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getAllObjects.md index 7c922b3d5f..cae56ca4f9 100644 --- a/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getAllObjects.md +++ b/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getBrand.md b/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getBrand.md index c5a934546b..0e56d1bf33 100644 --- a/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getBrand.md +++ b/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getBrand.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand_Restriction_Location_CustomerCountry](/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry)::getBrand + Retrieve this references the brand that has a brand-location-country restriction setup. diff --git a/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getLocation.md b/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getLocation.md index 966f3c10bb..ef8bdd418a 100644 --- a/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getLocation.md +++ b/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand_Restriction_Location_CustomerCountry](/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry)::getLocation + Retrieve this references the datacenter that has a brand-location-country restriction setup. For example, if a datacenter is listed with a restriction for Canada, a Canadian customer may not be eligible to order services at that location. diff --git a/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getObject.md b/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getObject.md index d30531afb4..f205ae9b5f 100644 --- a/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getObject.md +++ b/content/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Brand_Restriction_Location_CustomerCountry](/reference/services/SoftLayer_Brand_Restriction_Location_CustomerCountry)::getObject + Retrieve a SoftLayer_Brand_Restriction_Location_CustomerCountry record. diff --git a/content/reference/services/SoftLayer_Business_Partner_Channel/_index.md b/content/reference/services/SoftLayer_Business_Partner_Channel/_index.md index 46f87fc9d6..6cbf7beb31 100644 --- a/content/reference/services/SoftLayer_Business_Partner_Channel/_index.md +++ b/content/reference/services/SoftLayer_Business_Partner_Channel/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,6 +44,7 @@ classes: #### [getObject](/reference/services/SoftLayer_Business_Partner_Channel/getObject) Retrieve a SoftLayer_Business_Partner_Channel record. +
              diff --git a/content/reference/services/SoftLayer_Business_Partner_Channel/getObject.md b/content/reference/services/SoftLayer_Business_Partner_Channel/getObject.md index ff172d08f8..62a7b55902 100644 --- a/content/reference/services/SoftLayer_Business_Partner_Channel/getObject.md +++ b/content/reference/services/SoftLayer_Business_Partner_Channel/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Business_Partner_Channel](/reference/services/SoftLayer_Business_Partner_Channel)::getObject + Retrieve a SoftLayer_Business_Partner_Channel record. diff --git a/content/reference/services/SoftLayer_Business_Partner_Segment/_index.md b/content/reference/services/SoftLayer_Business_Partner_Segment/_index.md index d668e02175..577bcd9405 100644 --- a/content/reference/services/SoftLayer_Business_Partner_Segment/_index.md +++ b/content/reference/services/SoftLayer_Business_Partner_Segment/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,6 +44,7 @@ classes: #### [getObject](/reference/services/SoftLayer_Business_Partner_Segment/getObject) Retrieve a SoftLayer_Business_Partner_Segment record. +
              diff --git a/content/reference/services/SoftLayer_Business_Partner_Segment/getObject.md b/content/reference/services/SoftLayer_Business_Partner_Segment/getObject.md index 25ecb81fb6..1a79017d12 100644 --- a/content/reference/services/SoftLayer_Business_Partner_Segment/getObject.md +++ b/content/reference/services/SoftLayer_Business_Partner_Segment/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Business_Partner_Segment](/reference/services/SoftLayer_Business_Partner_Segment)::getObject + Retrieve a SoftLayer_Business_Partner_Segment record. diff --git a/content/reference/services/SoftLayer_Catalyst_Company_Type/_index.md b/content/reference/services/SoftLayer_Catalyst_Company_Type/_index.md index 2223fd4794..6ef3174fb0 100644 --- a/content/reference/services/SoftLayer_Catalyst_Company_Type/_index.md +++ b/content/reference/services/SoftLayer_Catalyst_Company_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Catalyst_Company_Type/getAllObjects) Get all catalyst company types +
              #### [getObject](/reference/services/SoftLayer_Catalyst_Company_Type/getObject) Retrieve a SoftLayer_Catalyst_Company_Type record. +
              diff --git a/content/reference/services/SoftLayer_Catalyst_Company_Type/getAllObjects.md b/content/reference/services/SoftLayer_Catalyst_Company_Type/getAllObjects.md index 4b4f8c3510..5333aac7cc 100644 --- a/content/reference/services/SoftLayer_Catalyst_Company_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_Catalyst_Company_Type/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Catalyst_Company_Type](/reference/services/SoftLayer_Catalyst_Company_Type)::getAllObjects + Get all catalyst company types diff --git a/content/reference/services/SoftLayer_Catalyst_Company_Type/getObject.md b/content/reference/services/SoftLayer_Catalyst_Company_Type/getObject.md index be3589435d..eba24697af 100644 --- a/content/reference/services/SoftLayer_Catalyst_Company_Type/getObject.md +++ b/content/reference/services/SoftLayer_Catalyst_Company_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Catalyst_Company_Type](/reference/services/SoftLayer_Catalyst_Company_Type)::getObject + Retrieve a SoftLayer_Catalyst_Company_Type record. diff --git a/content/reference/services/SoftLayer_Catalyst_Enrollment/_index.md b/content/reference/services/SoftLayer_Catalyst_Enrollment/_index.md index 7e07e75040..ae4e17ea4e 100644 --- a/content/reference/services/SoftLayer_Catalyst_Enrollment/_index.md +++ b/content/reference/services/SoftLayer_Catalyst_Enrollment/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,78 +44,91 @@ classes: #### [getAccount](/reference/services/SoftLayer_Catalyst_Enrollment/getAccount) +
              #### [getAffiliate](/reference/services/SoftLayer_Catalyst_Enrollment/getAffiliate) +
              #### [getAffiliates](/reference/services/SoftLayer_Catalyst_Enrollment/getAffiliates) +
              #### [getCompanyType](/reference/services/SoftLayer_Catalyst_Enrollment/getCompanyType) +
              #### [getCompanyTypes](/reference/services/SoftLayer_Catalyst_Enrollment/getCompanyTypes) +
              #### [getEnrollmentRequestAnnualRevenueOptions](/reference/services/SoftLayer_Catalyst_Enrollment/getEnrollmentRequestAnnualRevenueOptions) +
              #### [getEnrollmentRequestUserCountOptions](/reference/services/SoftLayer_Catalyst_Enrollment/getEnrollmentRequestUserCountOptions) +
              #### [getEnrollmentRequestYearsInOperationOptions](/reference/services/SoftLayer_Catalyst_Enrollment/getEnrollmentRequestYearsInOperationOptions) +
              #### [getIsActiveFlag](/reference/services/SoftLayer_Catalyst_Enrollment/getIsActiveFlag) +
              #### [getObject](/reference/services/SoftLayer_Catalyst_Enrollment/getObject) Retrieve a SoftLayer_Catalyst_Enrollment record. +
              #### [getRepresentative](/reference/services/SoftLayer_Catalyst_Enrollment/getRepresentative) +
              #### [requestManualEnrollment](/reference/services/SoftLayer_Catalyst_Enrollment/requestManualEnrollment) +
              #### [requestSelfEnrollment](/reference/services/SoftLayer_Catalyst_Enrollment/requestSelfEnrollment) +
              diff --git a/content/reference/services/SoftLayer_Catalyst_Enrollment/getAccount.md b/content/reference/services/SoftLayer_Catalyst_Enrollment/getAccount.md index 2512d89de8..705c1d1a45 100644 --- a/content/reference/services/SoftLayer_Catalyst_Enrollment/getAccount.md +++ b/content/reference/services/SoftLayer_Catalyst_Enrollment/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Catalyst_Enrollment/getAffiliate.md b/content/reference/services/SoftLayer_Catalyst_Enrollment/getAffiliate.md index ba0b4753cb..0e4eb2f1eb 100644 --- a/content/reference/services/SoftLayer_Catalyst_Enrollment/getAffiliate.md +++ b/content/reference/services/SoftLayer_Catalyst_Enrollment/getAffiliate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Catalyst_Enrollment/getAffiliates.md b/content/reference/services/SoftLayer_Catalyst_Enrollment/getAffiliates.md index 3d33a36ff1..c07018ad22 100644 --- a/content/reference/services/SoftLayer_Catalyst_Enrollment/getAffiliates.md +++ b/content/reference/services/SoftLayer_Catalyst_Enrollment/getAffiliates.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Catalyst_Enrollment/getCompanyType.md b/content/reference/services/SoftLayer_Catalyst_Enrollment/getCompanyType.md index 92357b8a1c..6b37123a80 100644 --- a/content/reference/services/SoftLayer_Catalyst_Enrollment/getCompanyType.md +++ b/content/reference/services/SoftLayer_Catalyst_Enrollment/getCompanyType.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Catalyst_Enrollment/getCompanyTypes.md b/content/reference/services/SoftLayer_Catalyst_Enrollment/getCompanyTypes.md index bbc907cc2c..77a89bbb3a 100644 --- a/content/reference/services/SoftLayer_Catalyst_Enrollment/getCompanyTypes.md +++ b/content/reference/services/SoftLayer_Catalyst_Enrollment/getCompanyTypes.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Catalyst_Enrollment/getEnrollmentRequestAnnualRevenueOptions.md b/content/reference/services/SoftLayer_Catalyst_Enrollment/getEnrollmentRequestAnnualRevenueOptions.md index 1602630517..e0cbd108fe 100644 --- a/content/reference/services/SoftLayer_Catalyst_Enrollment/getEnrollmentRequestAnnualRevenueOptions.md +++ b/content/reference/services/SoftLayer_Catalyst_Enrollment/getEnrollmentRequestAnnualRevenueOptions.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Catalyst_Enrollment/getEnrollmentRequestUserCountOptions.md b/content/reference/services/SoftLayer_Catalyst_Enrollment/getEnrollmentRequestUserCountOptions.md index cbb6e37119..90c1612919 100644 --- a/content/reference/services/SoftLayer_Catalyst_Enrollment/getEnrollmentRequestUserCountOptions.md +++ b/content/reference/services/SoftLayer_Catalyst_Enrollment/getEnrollmentRequestUserCountOptions.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Catalyst_Enrollment/getEnrollmentRequestYearsInOperationOptions.md b/content/reference/services/SoftLayer_Catalyst_Enrollment/getEnrollmentRequestYearsInOperationOptions.md index 04dd6aa7e3..b9de6c3105 100644 --- a/content/reference/services/SoftLayer_Catalyst_Enrollment/getEnrollmentRequestYearsInOperationOptions.md +++ b/content/reference/services/SoftLayer_Catalyst_Enrollment/getEnrollmentRequestYearsInOperationOptions.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Catalyst_Enrollment/getIsActiveFlag.md b/content/reference/services/SoftLayer_Catalyst_Enrollment/getIsActiveFlag.md index b6be46c9e9..d3c33522c3 100644 --- a/content/reference/services/SoftLayer_Catalyst_Enrollment/getIsActiveFlag.md +++ b/content/reference/services/SoftLayer_Catalyst_Enrollment/getIsActiveFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Catalyst_Enrollment/getObject.md b/content/reference/services/SoftLayer_Catalyst_Enrollment/getObject.md index 23cec565d1..7a3bb3f230 100644 --- a/content/reference/services/SoftLayer_Catalyst_Enrollment/getObject.md +++ b/content/reference/services/SoftLayer_Catalyst_Enrollment/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Catalyst_Enrollment](/reference/services/SoftLayer_Catalyst_Enrollment)::getObject + Retrieve a SoftLayer_Catalyst_Enrollment record. diff --git a/content/reference/services/SoftLayer_Catalyst_Enrollment/getRepresentative.md b/content/reference/services/SoftLayer_Catalyst_Enrollment/getRepresentative.md index 6a1cfef260..9791913f3f 100644 --- a/content/reference/services/SoftLayer_Catalyst_Enrollment/getRepresentative.md +++ b/content/reference/services/SoftLayer_Catalyst_Enrollment/getRepresentative.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Catalyst_Enrollment/requestManualEnrollment.md b/content/reference/services/SoftLayer_Catalyst_Enrollment/requestManualEnrollment.md index e1322348a3..1cf67a2e13 100644 --- a/content/reference/services/SoftLayer_Catalyst_Enrollment/requestManualEnrollment.md +++ b/content/reference/services/SoftLayer_Catalyst_Enrollment/requestManualEnrollment.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Catalyst_Enrollment/requestSelfEnrollment.md b/content/reference/services/SoftLayer_Catalyst_Enrollment/requestSelfEnrollment.md index d4453f5201..a6524dd4f5 100644 --- a/content/reference/services/SoftLayer_Catalyst_Enrollment/requestSelfEnrollment.md +++ b/content/reference/services/SoftLayer_Catalyst_Enrollment/requestSelfEnrollment.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Compliance_Report_Type/_index.md b/content/reference/services/SoftLayer_Compliance_Report_Type/_index.md index ec312c7016..043698559c 100644 --- a/content/reference/services/SoftLayer_Compliance_Report_Type/_index.md +++ b/content/reference/services/SoftLayer_Compliance_Report_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Compliance_Report_Type/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_Compliance_Report_Type/getObject) Retrieve a SoftLayer_Compliance_Report_Type record. +
              diff --git a/content/reference/services/SoftLayer_Compliance_Report_Type/getAllObjects.md b/content/reference/services/SoftLayer_Compliance_Report_Type/getAllObjects.md index 87183c93bc..021e951cb3 100644 --- a/content/reference/services/SoftLayer_Compliance_Report_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_Compliance_Report_Type/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Compliance_Report_Type/getObject.md b/content/reference/services/SoftLayer_Compliance_Report_Type/getObject.md index 99fbeac975..5f606e3aa7 100644 --- a/content/reference/services/SoftLayer_Compliance_Report_Type/getObject.md +++ b/content/reference/services/SoftLayer_Compliance_Report_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Compliance_Report_Type](/reference/services/SoftLayer_Compliance_Report_Type)::getObject + Retrieve a SoftLayer_Compliance_Report_Type record. diff --git a/content/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/_index.md b/content/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/_index.md index 38c98ba93a..7a13da880d 100644 --- a/content/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/_index.md +++ b/content/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Supported hardware raid modes @@ -42,18 +44,21 @@ Supported hardware raid modes #### [getAllObjects](/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/getAllObjects) +
              #### [getHardwareComponentModels](/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/getHardwareComponentModels) +
              #### [getObject](/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/getObject) Retrieve a SoftLayer_Configuration_Storage_Group_Array_Type record. +
              diff --git a/content/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/getAllObjects.md b/content/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/getAllObjects.md index 0e708d439a..3d0bde1811 100644 --- a/content/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/getHardwareComponentModels.md b/content/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/getHardwareComponentModels.md index 4c34ba481a..953849a9fa 100644 --- a/content/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/getHardwareComponentModels.md +++ b/content/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/getHardwareComponentModels.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/getObject.md b/content/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/getObject.md index 7089517678..88beb3cf62 100644 --- a/content/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/getObject.md +++ b/content/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Configuration_Storage_Group_Array_Type](/reference/services/SoftLayer_Configuration_Storage_Group_Array_Type)::getObject + Retrieve a SoftLayer_Configuration_Storage_Group_Array_Type record. diff --git a/content/reference/services/SoftLayer_Configuration_Template/_index.md b/content/reference/services/SoftLayer_Configuration_Template/_index.md index 2c8cd3c125..ac4114a09e 100644 --- a/content/reference/services/SoftLayer_Configuration_Template/_index.md +++ b/content/reference/services/SoftLayer_Configuration_Template/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Configuration template class encapsulated an arbitrary configuration values for various resources. @@ -42,84 +44,98 @@ Configuration template class encapsulated an arbitrary configuration values for #### [copyTemplate](/reference/services/SoftLayer_Configuration_Template/copyTemplate) Copy a configuration template and returns a newly created template copy +
              #### [deleteObject](/reference/services/SoftLayer_Configuration_Template/deleteObject) Deletes a customer configuration template. +
              #### [editObject](/reference/services/SoftLayer_Configuration_Template/editObject) Edit the object by passing in a modified instance of the object +
              #### [getAccount](/reference/services/SoftLayer_Configuration_Template/getAccount) +
              #### [getAllObjects](/reference/services/SoftLayer_Configuration_Template/getAllObjects) Retrieves all available configuration templates. +
              #### [getConfigurationSections](/reference/services/SoftLayer_Configuration_Template/getConfigurationSections) +
              #### [getDefaultValues](/reference/services/SoftLayer_Configuration_Template/getDefaultValues) +
              #### [getDefinitions](/reference/services/SoftLayer_Configuration_Template/getDefinitions) +
              #### [getItem](/reference/services/SoftLayer_Configuration_Template/getItem) +
              #### [getLinkedSectionReferences](/reference/services/SoftLayer_Configuration_Template/getLinkedSectionReferences) +
              #### [getObject](/reference/services/SoftLayer_Configuration_Template/getObject) Retrieve a SoftLayer_Configuration_Template record. +
              #### [getParent](/reference/services/SoftLayer_Configuration_Template/getParent) +
              #### [getUser](/reference/services/SoftLayer_Configuration_Template/getUser) +
              #### [updateDefaultValues](/reference/services/SoftLayer_Configuration_Template/updateDefaultValues) Updates default configuration values. +
              diff --git a/content/reference/services/SoftLayer_Configuration_Template/copyTemplate.md b/content/reference/services/SoftLayer_Configuration_Template/copyTemplate.md index 7accd8a78b..143d6c575a 100644 --- a/content/reference/services/SoftLayer_Configuration_Template/copyTemplate.md +++ b/content/reference/services/SoftLayer_Configuration_Template/copyTemplate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Configuration_Template](/reference/services/SoftLayer_Configuration_Template)::copyTemplate + Copy a configuration template and returns a newly created template copy diff --git a/content/reference/services/SoftLayer_Configuration_Template/deleteObject.md b/content/reference/services/SoftLayer_Configuration_Template/deleteObject.md index bfecb35067..1eb865cd25 100644 --- a/content/reference/services/SoftLayer_Configuration_Template/deleteObject.md +++ b/content/reference/services/SoftLayer_Configuration_Template/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Configuration_Template](/reference/services/SoftLayer_Configuration_Template)::deleteObject + Deletes a customer configuration template. diff --git a/content/reference/services/SoftLayer_Configuration_Template/editObject.md b/content/reference/services/SoftLayer_Configuration_Template/editObject.md index 83bc745e3e..05eb6abef3 100644 --- a/content/reference/services/SoftLayer_Configuration_Template/editObject.md +++ b/content/reference/services/SoftLayer_Configuration_Template/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Configuration_Template](/reference/services/SoftLayer_Configuration_Template)::editObject + Edit the object by passing in a modified instance of the object diff --git a/content/reference/services/SoftLayer_Configuration_Template/getAccount.md b/content/reference/services/SoftLayer_Configuration_Template/getAccount.md index 9333b492e7..862e81c5a9 100644 --- a/content/reference/services/SoftLayer_Configuration_Template/getAccount.md +++ b/content/reference/services/SoftLayer_Configuration_Template/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template/getAllObjects.md b/content/reference/services/SoftLayer_Configuration_Template/getAllObjects.md index 083944b4e7..80d1734e62 100644 --- a/content/reference/services/SoftLayer_Configuration_Template/getAllObjects.md +++ b/content/reference/services/SoftLayer_Configuration_Template/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Configuration_Template](/reference/services/SoftLayer_Configuration_Template)::getAllObjects + Retrieves all available configuration templates. diff --git a/content/reference/services/SoftLayer_Configuration_Template/getConfigurationSections.md b/content/reference/services/SoftLayer_Configuration_Template/getConfigurationSections.md index 5768f883f8..cdb1c9600f 100644 --- a/content/reference/services/SoftLayer_Configuration_Template/getConfigurationSections.md +++ b/content/reference/services/SoftLayer_Configuration_Template/getConfigurationSections.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template/getDefaultValues.md b/content/reference/services/SoftLayer_Configuration_Template/getDefaultValues.md index fc855c0154..8817d6277f 100644 --- a/content/reference/services/SoftLayer_Configuration_Template/getDefaultValues.md +++ b/content/reference/services/SoftLayer_Configuration_Template/getDefaultValues.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template/getDefinitions.md b/content/reference/services/SoftLayer_Configuration_Template/getDefinitions.md index 852d150c2f..e3d808be86 100644 --- a/content/reference/services/SoftLayer_Configuration_Template/getDefinitions.md +++ b/content/reference/services/SoftLayer_Configuration_Template/getDefinitions.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template/getItem.md b/content/reference/services/SoftLayer_Configuration_Template/getItem.md index 15c841a481..63ae9808fa 100644 --- a/content/reference/services/SoftLayer_Configuration_Template/getItem.md +++ b/content/reference/services/SoftLayer_Configuration_Template/getItem.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template/getLinkedSectionReferences.md b/content/reference/services/SoftLayer_Configuration_Template/getLinkedSectionReferences.md index 964696ee83..45b2f40ef5 100644 --- a/content/reference/services/SoftLayer_Configuration_Template/getLinkedSectionReferences.md +++ b/content/reference/services/SoftLayer_Configuration_Template/getLinkedSectionReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template/getObject.md b/content/reference/services/SoftLayer_Configuration_Template/getObject.md index 858ec005e4..07c6b3e97e 100644 --- a/content/reference/services/SoftLayer_Configuration_Template/getObject.md +++ b/content/reference/services/SoftLayer_Configuration_Template/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Configuration_Template](/reference/services/SoftLayer_Configuration_Template)::getObject + Retrieve a SoftLayer_Configuration_Template record. diff --git a/content/reference/services/SoftLayer_Configuration_Template/getParent.md b/content/reference/services/SoftLayer_Configuration_Template/getParent.md index 43857363e8..9436ddf53c 100644 --- a/content/reference/services/SoftLayer_Configuration_Template/getParent.md +++ b/content/reference/services/SoftLayer_Configuration_Template/getParent.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template/getUser.md b/content/reference/services/SoftLayer_Configuration_Template/getUser.md index 9d7ccf6221..b9565773d1 100644 --- a/content/reference/services/SoftLayer_Configuration_Template/getUser.md +++ b/content/reference/services/SoftLayer_Configuration_Template/getUser.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template/updateDefaultValues.md b/content/reference/services/SoftLayer_Configuration_Template/updateDefaultValues.md index a764074527..29342af11c 100644 --- a/content/reference/services/SoftLayer_Configuration_Template/updateDefaultValues.md +++ b/content/reference/services/SoftLayer_Configuration_Template/updateDefaultValues.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Configuration_Template](/reference/services/SoftLayer_Configuration_Template)::updateDefaultValues + Updates default configuration values. diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section/_index.md b/content/reference/services/SoftLayer_Configuration_Template_Section/_index.md index 470b0fb98f..aa1111a70d 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section/_index.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Configuration section allow you to divide a large configuration values into a smaller pieces. @@ -42,66 +44,77 @@ Configuration section allow you to divide a large configuration values into a sm #### [getDefinitions](/reference/services/SoftLayer_Configuration_Template_Section/getDefinitions) +
              #### [getDisallowedDeletionFlag](/reference/services/SoftLayer_Configuration_Template_Section/getDisallowedDeletionFlag) +
              #### [getLinkedTemplate](/reference/services/SoftLayer_Configuration_Template_Section/getLinkedTemplate) +
              #### [getLinkedTemplateReference](/reference/services/SoftLayer_Configuration_Template_Section/getLinkedTemplateReference) +
              #### [getObject](/reference/services/SoftLayer_Configuration_Template_Section/getObject) Retrieve a SoftLayer_Configuration_Template_Section record. +
              #### [getProfiles](/reference/services/SoftLayer_Configuration_Template_Section/getProfiles) +
              #### [getSectionType](/reference/services/SoftLayer_Configuration_Template_Section/getSectionType) +
              #### [getSectionTypeName](/reference/services/SoftLayer_Configuration_Template_Section/getSectionTypeName) +
              #### [getSubSections](/reference/services/SoftLayer_Configuration_Template_Section/getSubSections) +
              #### [getTemplate](/reference/services/SoftLayer_Configuration_Template_Section/getTemplate) +
              #### [hasSubSections](/reference/services/SoftLayer_Configuration_Template_Section/hasSubSections) Check if object has sub-sections +
              diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section/getDefinitions.md b/content/reference/services/SoftLayer_Configuration_Template_Section/getDefinitions.md index aa72ac2337..347f230e2d 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section/getDefinitions.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section/getDefinitions.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section/getDisallowedDeletionFlag.md b/content/reference/services/SoftLayer_Configuration_Template_Section/getDisallowedDeletionFlag.md index d7e54ec5a1..bc722b8fc2 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section/getDisallowedDeletionFlag.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section/getDisallowedDeletionFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section/getLinkedTemplate.md b/content/reference/services/SoftLayer_Configuration_Template_Section/getLinkedTemplate.md index eb75370319..fcfbb04123 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section/getLinkedTemplate.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section/getLinkedTemplate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section/getLinkedTemplateReference.md b/content/reference/services/SoftLayer_Configuration_Template_Section/getLinkedTemplateReference.md index 29c1a54b6b..953c10eb1a 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section/getLinkedTemplateReference.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section/getLinkedTemplateReference.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section/getObject.md b/content/reference/services/SoftLayer_Configuration_Template_Section/getObject.md index b86a274aca..c1e2606f77 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section/getObject.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Configuration_Template_Section](/reference/services/SoftLayer_Configuration_Template_Section)::getObject + Retrieve a SoftLayer_Configuration_Template_Section record. diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section/getProfiles.md b/content/reference/services/SoftLayer_Configuration_Template_Section/getProfiles.md index 0902230fe7..156b55c714 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section/getProfiles.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section/getProfiles.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section/getSectionType.md b/content/reference/services/SoftLayer_Configuration_Template_Section/getSectionType.md index 33b3c46f62..f657a30466 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section/getSectionType.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section/getSectionType.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section/getSectionTypeName.md b/content/reference/services/SoftLayer_Configuration_Template_Section/getSectionTypeName.md index c5939b19dc..4b20655e70 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section/getSectionTypeName.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section/getSectionTypeName.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section/getSubSections.md b/content/reference/services/SoftLayer_Configuration_Template_Section/getSubSections.md index 33f0ead38e..f894a59448 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section/getSubSections.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section/getSubSections.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section/getTemplate.md b/content/reference/services/SoftLayer_Configuration_Template_Section/getTemplate.md index 51b8f692c2..5a15cc1c29 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section/getTemplate.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section/getTemplate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section/hasSubSections.md b/content/reference/services/SoftLayer_Configuration_Template_Section/hasSubSections.md index 4d16b2e1c4..e5ed88ac4a 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section/hasSubSections.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section/hasSubSections.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Configuration_Template_Section](/reference/services/SoftLayer_Configuration_Template_Section)::hasSubSections + Check if object has sub-sections diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/_index.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/_index.md index f5466d217a..1e220a1b15 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/_index.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Configuration definition gives you details of the value that you're setting. @@ -42,42 +44,49 @@ Configuration definition gives you details of the value that you're setting. #### [getAttributes](/reference/services/SoftLayer_Configuration_Template_Section_Definition/getAttributes) +
              #### [getDefaultValue](/reference/services/SoftLayer_Configuration_Template_Section_Definition/getDefaultValue) +
              #### [getGroup](/reference/services/SoftLayer_Configuration_Template_Section_Definition/getGroup) +
              #### [getMonitoringDataFlag](/reference/services/SoftLayer_Configuration_Template_Section_Definition/getMonitoringDataFlag) +
              #### [getObject](/reference/services/SoftLayer_Configuration_Template_Section_Definition/getObject) Retrieve a SoftLayer_Configuration_Template_Section_Definition record. +
              #### [getSection](/reference/services/SoftLayer_Configuration_Template_Section_Definition/getSection) +
              #### [getValueType](/reference/services/SoftLayer_Configuration_Template_Section_Definition/getValueType) +
              diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getAttributes.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getAttributes.md index b7e6ff12c4..209a51d8e5 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getAttributes.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getAttributes.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getDefaultValue.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getDefaultValue.md index 1045cd9bae..10cf03ccf3 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getDefaultValue.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getDefaultValue.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getGroup.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getGroup.md index ad9e5c915b..4e78523d91 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getGroup.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getGroup.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getMonitoringDataFlag.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getMonitoringDataFlag.md index 6565d58392..6a229471be 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getMonitoringDataFlag.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getMonitoringDataFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getObject.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getObject.md index e748f1af84..355d950bbb 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getObject.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Configuration_Template_Section_Definition](/reference/services/SoftLayer_Configuration_Template_Section_Definition)::getObject + Retrieve a SoftLayer_Configuration_Template_Section_Definition record. diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getSection.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getSection.md index 3e4ae4e91e..b60c0fa68e 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getSection.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getSection.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getValueType.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getValueType.md index ec6443ea25..7c0eab5041 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getValueType.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition/getValueType.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/_index.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/_index.md index 5a7185791e..a4a8ac4aa5 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/_index.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Configuration definition groups help categorize definitions. @@ -42,18 +44,21 @@ Configuration definition groups help categorize definitions. #### [getAllGroups](/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/getAllGroups) +
              #### [getObject](/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/getObject) Retrieve a SoftLayer_Configuration_Template_Section_Definition_Group record. +
              #### [getParent](/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/getParent) +
              diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/getAllGroups.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/getAllGroups.md index 0571281a01..815dae20bb 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/getAllGroups.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/getAllGroups.md @@ -18,6 +18,7 @@ aliases: + ## Overview Get all configuration definition group objects. diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/getObject.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/getObject.md index abedb35e2e..f3aa41fdd0 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/getObject.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Configuration_Template_Section_Definition_Group](/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group)::getObject + Retrieve a SoftLayer_Configuration_Template_Section_Definition_Group record. diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/getParent.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/getParent.md index 00ba02f0fd..cc589a3d0f 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/getParent.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Group/getParent.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Type/_index.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Type/_index.md index 397cd34c33..b9886d11b8 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Type/_index.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Configuration_Template_Section_Definition_Type further defines the value of a configuration definition. @@ -42,6 +44,7 @@ SoftLayer_Configuration_Template_Section_Definition_Type further defines the val #### [getObject](/reference/services/SoftLayer_Configuration_Template_Section_Definition_Type/getObject) Retrieve a SoftLayer_Configuration_Template_Section_Definition_Type record. + diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Type/getObject.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Type/getObject.md index 57c61821cd..cd5f4cacdf 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Type/getObject.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Configuration_Template_Section_Definition_Type](/reference/services/SoftLayer_Configuration_Template_Section_Definition_Type)::getObject + Retrieve a SoftLayer_Configuration_Template_Section_Definition_Type record. diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/_index.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/_index.md index 9e5d91e938..6ce67c7678 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/_index.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Configuration_Section_Value is used to set the value for a configuration definition @@ -42,18 +44,21 @@ SoftLayer_Configuration_Section_Value is used to set the value for a configurati #### [getDefinition](/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/getDefinition) +
              #### [getObject](/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/getObject) Retrieve a SoftLayer_Configuration_Template_Section_Definition_Value record. +
              #### [getTemplate](/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/getTemplate) +
              diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/getDefinition.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/getDefinition.md index 3482413753..05f04d9385 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/getDefinition.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/getDefinition.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/getObject.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/getObject.md index b612b10897..68926a16b0 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/getObject.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Configuration_Template_Section_Definition_Value](/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value)::getObject + Retrieve a SoftLayer_Configuration_Template_Section_Definition_Value record. diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/getTemplate.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/getTemplate.md index 3233893f6b..f569e2ca7f 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/getTemplate.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Definition_Value/getTemplate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Profile/_index.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Profile/_index.md index d6af4d432f..0038baa619 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Profile/_index.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Profile/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Configuration_Template_Section_Profile help you keep track of custom configuration profiles. @@ -42,12 +44,14 @@ SoftLayer_Configuration_Template_Section_Profile help you keep track of custom c #### [getConfigurationSection](/reference/services/SoftLayer_Configuration_Template_Section_Profile/getConfigurationSection) +
              #### [getObject](/reference/services/SoftLayer_Configuration_Template_Section_Profile/getObject) Retrieve a SoftLayer_Configuration_Template_Section_Profile record. +
              diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Profile/getConfigurationSection.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Profile/getConfigurationSection.md index a23d87ae8e..7df3b40ea4 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Profile/getConfigurationSection.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Profile/getConfigurationSection.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Profile/getObject.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Profile/getObject.md index bef97c8125..b94e9cb560 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Profile/getObject.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Profile/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Configuration_Template_Section_Profile](/reference/services/SoftLayer_Configuration_Template_Section_Profile)::getObject + Retrieve a SoftLayer_Configuration_Template_Section_Profile record. diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Reference/_index.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Reference/_index.md index 7568922c5e..1d58cff0f8 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Reference/_index.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Reference/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Configuration section reference allow you to reuse a configuration section from another configuration template. @@ -42,18 +44,21 @@ Configuration section reference allow you to reuse a configuration section from #### [getObject](/reference/services/SoftLayer_Configuration_Template_Section_Reference/getObject) Retrieve a SoftLayer_Configuration_Template_Section_Reference record. +
              #### [getSection](/reference/services/SoftLayer_Configuration_Template_Section_Reference/getSection) +
              #### [getTemplate](/reference/services/SoftLayer_Configuration_Template_Section_Reference/getTemplate) +
              diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Reference/getObject.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Reference/getObject.md index 0cdd9704ef..61293e4f39 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Reference/getObject.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Reference/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Configuration_Template_Section_Reference](/reference/services/SoftLayer_Configuration_Template_Section_Reference)::getObject + Retrieve a SoftLayer_Configuration_Template_Section_Reference record. diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Reference/getSection.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Reference/getSection.md index 90d5a8f1c2..a1aa8319a2 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Reference/getSection.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Reference/getSection.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Reference/getTemplate.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Reference/getTemplate.md index 3a474ee6dd..d33eee146b 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Reference/getTemplate.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Reference/getTemplate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Type/_index.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Type/_index.md index 9017753e0d..89ddb99523 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Type/_index.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Configuration section type @@ -42,6 +44,7 @@ Configuration section type #### [getObject](/reference/services/SoftLayer_Configuration_Template_Section_Type/getObject) Retrieve a SoftLayer_Configuration_Template_Section_Type record. + diff --git a/content/reference/services/SoftLayer_Configuration_Template_Section_Type/getObject.md b/content/reference/services/SoftLayer_Configuration_Template_Section_Type/getObject.md index 2b454afe7c..cc0b39c58c 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Section_Type/getObject.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Section_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Configuration_Template_Section_Type](/reference/services/SoftLayer_Configuration_Template_Section_Type)::getObject + Retrieve a SoftLayer_Configuration_Template_Section_Type record. diff --git a/content/reference/services/SoftLayer_Configuration_Template_Type/_index.md b/content/reference/services/SoftLayer_Configuration_Template_Type/_index.md index 655512815d..cc9bb217ac 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Type/_index.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Type/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + SoftLayer_Configuration_Template_Type defines the types of configuration template. Template types can be custom, default and so on. @@ -46,6 +48,7 @@ Template types can be custom, default and so on. #### [getObject](/reference/services/SoftLayer_Configuration_Template_Type/getObject) Retrieve a SoftLayer_Configuration_Template_Type record. + diff --git a/content/reference/services/SoftLayer_Configuration_Template_Type/getObject.md b/content/reference/services/SoftLayer_Configuration_Template_Type/getObject.md index b547bf6e5a..5a4db8ff50 100644 --- a/content/reference/services/SoftLayer_Configuration_Template_Type/getObject.md +++ b/content/reference/services/SoftLayer_Configuration_Template_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Configuration_Template_Type](/reference/services/SoftLayer_Configuration_Template_Type)::getObject + Retrieve a SoftLayer_Configuration_Template_Type record. diff --git a/content/reference/services/SoftLayer_Dns_Domain/_index.md b/content/reference/services/SoftLayer_Dns_Domain/_index.md index be03692dbd..8665f2c78c 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/_index.md +++ b/content/reference/services/SoftLayer_Dns_Domain/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -66,114 +68,133 @@ SoftLayer provides secondary DNS hosting services if you wish to maintain DNS re #### [createARecord](/reference/services/SoftLayer_Dns_Domain/createARecord) Create an A record on a domain. +
              #### [createAaaaRecord](/reference/services/SoftLayer_Dns_Domain/createAaaaRecord) Create an AAAA record on a domain. +
              #### [createCnameRecord](/reference/services/SoftLayer_Dns_Domain/createCnameRecord) Create a CNAME record on a domain. +
              #### [createMxRecord](/reference/services/SoftLayer_Dns_Domain/createMxRecord) Create an MX record on a domain. +
              #### [createNsRecord](/reference/services/SoftLayer_Dns_Domain/createNsRecord) Create an NS record on a domain. +
              #### [createObject](/reference/services/SoftLayer_Dns_Domain/createObject) Create a new domain. +
              #### [createObjects](/reference/services/SoftLayer_Dns_Domain/createObjects) Create multiple domains at once. +
              #### [createPtrRecord](/reference/services/SoftLayer_Dns_Domain/createPtrRecord) Edit the PTR record for a single IP address. +
              #### [createSpfRecord](/reference/services/SoftLayer_Dns_Domain/createSpfRecord) Create an SPF record on a domain. +
              #### [createTxtRecord](/reference/services/SoftLayer_Dns_Domain/createTxtRecord) Create a TXT record on a domain. +
              #### [deleteObject](/reference/services/SoftLayer_Dns_Domain/deleteObject) Remove a domain. +
              #### [getAccount](/reference/services/SoftLayer_Dns_Domain/getAccount) Retrieve the SoftLayer customer account that owns a domain. +
              #### [getByDomainName](/reference/services/SoftLayer_Dns_Domain/getByDomainName) Search for domains by name. +
              #### [getManagedResourceFlag](/reference/services/SoftLayer_Dns_Domain/getManagedResourceFlag) Retrieve a flag indicating that the dns domain record is a managed resource. +
              #### [getObject](/reference/services/SoftLayer_Dns_Domain/getObject) Retrieve a SoftLayer_Dns_Domain record. +
              #### [getResourceRecords](/reference/services/SoftLayer_Dns_Domain/getResourceRecords) Retrieve the individual records contained within a domain record. These include but are not limited to A, AAAA, MX, CTYPE, SPF and TXT records. +
              #### [getSecondary](/reference/services/SoftLayer_Dns_Domain/getSecondary) Retrieve the secondary DNS record that defines this domain as being managed through zone transfers. +
              #### [getSoaResourceRecord](/reference/services/SoftLayer_Dns_Domain/getSoaResourceRecord) Retrieve the start of authority (SOA) record contains authoritative and propagation details for a DNS zone. This property is not considered in requests to createObject and editObject. +
              #### [getZoneFileContents](/reference/services/SoftLayer_Dns_Domain/getZoneFileContents) Return a domain's data formatted as zone file text. +
              diff --git a/content/reference/services/SoftLayer_Dns_Domain/createARecord.md b/content/reference/services/SoftLayer_Dns_Domain/createARecord.md index 55b859c864..16ad6e2701 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/createARecord.md +++ b/content/reference/services/SoftLayer_Dns_Domain/createARecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::createARecord + Create an A record on a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain/createAaaaRecord.md b/content/reference/services/SoftLayer_Dns_Domain/createAaaaRecord.md index 833d4386e9..02d79902fa 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/createAaaaRecord.md +++ b/content/reference/services/SoftLayer_Dns_Domain/createAaaaRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::createAaaaRecord + Create an AAAA record on a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain/createCnameRecord.md b/content/reference/services/SoftLayer_Dns_Domain/createCnameRecord.md index 02c57be8b2..6d8f68054f 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/createCnameRecord.md +++ b/content/reference/services/SoftLayer_Dns_Domain/createCnameRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::createCnameRecord + Create a CNAME record on a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain/createMxRecord.md b/content/reference/services/SoftLayer_Dns_Domain/createMxRecord.md index d2e9509717..fc2345c1c6 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/createMxRecord.md +++ b/content/reference/services/SoftLayer_Dns_Domain/createMxRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::createMxRecord + Create an MX record on a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain/createNsRecord.md b/content/reference/services/SoftLayer_Dns_Domain/createNsRecord.md index a1ddd793c4..69ec31d223 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/createNsRecord.md +++ b/content/reference/services/SoftLayer_Dns_Domain/createNsRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::createNsRecord + Create an NS record on a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain/createObject.md b/content/reference/services/SoftLayer_Dns_Domain/createObject.md index 923a6654e3..488b2a9bbd 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/createObject.md +++ b/content/reference/services/SoftLayer_Dns_Domain/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::createObject + Create a new domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain/createObjects.md b/content/reference/services/SoftLayer_Dns_Domain/createObjects.md index 86b49c37a7..2a9905573c 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/createObjects.md +++ b/content/reference/services/SoftLayer_Dns_Domain/createObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::createObjects + Create multiple domains at once. diff --git a/content/reference/services/SoftLayer_Dns_Domain/createPtrRecord.md b/content/reference/services/SoftLayer_Dns_Domain/createPtrRecord.md index d521601344..f42cd1a96c 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/createPtrRecord.md +++ b/content/reference/services/SoftLayer_Dns_Domain/createPtrRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::createPtrRecord + Edit the PTR record for a single IP address. diff --git a/content/reference/services/SoftLayer_Dns_Domain/createSpfRecord.md b/content/reference/services/SoftLayer_Dns_Domain/createSpfRecord.md index 1a3ffdb6a6..9ede14523b 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/createSpfRecord.md +++ b/content/reference/services/SoftLayer_Dns_Domain/createSpfRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::createSpfRecord + Create an SPF record on a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain/createTxtRecord.md b/content/reference/services/SoftLayer_Dns_Domain/createTxtRecord.md index 650b4646c2..a2f6f883fd 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/createTxtRecord.md +++ b/content/reference/services/SoftLayer_Dns_Domain/createTxtRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::createTxtRecord + Create a TXT record on a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain/deleteObject.md b/content/reference/services/SoftLayer_Dns_Domain/deleteObject.md index d8b2b15585..2a581b6599 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/deleteObject.md +++ b/content/reference/services/SoftLayer_Dns_Domain/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::deleteObject + Remove a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain/getAccount.md b/content/reference/services/SoftLayer_Dns_Domain/getAccount.md index 0069b38e5f..9400a65c28 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/getAccount.md +++ b/content/reference/services/SoftLayer_Dns_Domain/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::getAccount + Retrieve the SoftLayer customer account that owns a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain/getByDomainName.md b/content/reference/services/SoftLayer_Dns_Domain/getByDomainName.md index b3e61eb26c..be77bc033f 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/getByDomainName.md +++ b/content/reference/services/SoftLayer_Dns_Domain/getByDomainName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::getByDomainName + Search for domains by name. diff --git a/content/reference/services/SoftLayer_Dns_Domain/getManagedResourceFlag.md b/content/reference/services/SoftLayer_Dns_Domain/getManagedResourceFlag.md index be2135477e..531ecdf190 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/getManagedResourceFlag.md +++ b/content/reference/services/SoftLayer_Dns_Domain/getManagedResourceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::getManagedResourceFlag + Retrieve a flag indicating that the dns domain record is a managed resource. diff --git a/content/reference/services/SoftLayer_Dns_Domain/getObject.md b/content/reference/services/SoftLayer_Dns_Domain/getObject.md index d6a39e96f0..42fecb73ee 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/getObject.md +++ b/content/reference/services/SoftLayer_Dns_Domain/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::getObject + Retrieve a SoftLayer_Dns_Domain record. diff --git a/content/reference/services/SoftLayer_Dns_Domain/getResourceRecords.md b/content/reference/services/SoftLayer_Dns_Domain/getResourceRecords.md index c02df91253..8f5a068859 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/getResourceRecords.md +++ b/content/reference/services/SoftLayer_Dns_Domain/getResourceRecords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::getResourceRecords + Retrieve the individual records contained within a domain record. These include but are not limited to A, AAAA, MX, CTYPE, SPF and TXT records. diff --git a/content/reference/services/SoftLayer_Dns_Domain/getSecondary.md b/content/reference/services/SoftLayer_Dns_Domain/getSecondary.md index b247e0db7e..7c20a65868 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/getSecondary.md +++ b/content/reference/services/SoftLayer_Dns_Domain/getSecondary.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::getSecondary + Retrieve the secondary DNS record that defines this domain as being managed through zone transfers. diff --git a/content/reference/services/SoftLayer_Dns_Domain/getSoaResourceRecord.md b/content/reference/services/SoftLayer_Dns_Domain/getSoaResourceRecord.md index 480995b024..87a3ff26e4 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/getSoaResourceRecord.md +++ b/content/reference/services/SoftLayer_Dns_Domain/getSoaResourceRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::getSoaResourceRecord + Retrieve the start of authority (SOA) record contains authoritative and propagation details for a DNS zone. This property is not considered in requests to createObject and editObject. diff --git a/content/reference/services/SoftLayer_Dns_Domain/getZoneFileContents.md b/content/reference/services/SoftLayer_Dns_Domain/getZoneFileContents.md index b117f33bee..278e8a7fa8 100644 --- a/content/reference/services/SoftLayer_Dns_Domain/getZoneFileContents.md +++ b/content/reference/services/SoftLayer_Dns_Domain/getZoneFileContents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain](/reference/services/SoftLayer_Dns_Domain)::getZoneFileContents + Return a domain's data formatted as zone file text. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/_index.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/_index.md index dcb973b485..cfa58f27a6 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/_index.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Registration and management of domain names and domain related services. @@ -42,150 +44,175 @@ Registration and management of domain names and domain related services. #### [addNameserversToDomain](/reference/services/SoftLayer_Dns_Domain_Registration/addNameserversToDomain) Adds nameservers to a domain. +
              #### [deleteRegisteredNameserver](/reference/services/SoftLayer_Dns_Domain_Registration/deleteRegisteredNameserver) Deletes a registered nameserver. +
              #### [getAccount](/reference/services/SoftLayer_Dns_Domain_Registration/getAccount) Retrieve the SoftLayer customer account that the domain is registered to. +
              #### [getAuthenticationCode](/reference/services/SoftLayer_Dns_Domain_Registration/getAuthenticationCode) Get the authentication code for a domain. +
              #### [getDomainInformation](/reference/services/SoftLayer_Dns_Domain_Registration/getDomainInformation) Retrieve all domain information. +
              #### [getDomainNameservers](/reference/services/SoftLayer_Dns_Domain_Registration/getDomainNameservers) Retrieve domain nameservers. +
              #### [getDomainRegistrationStatus](/reference/services/SoftLayer_Dns_Domain_Registration/getDomainRegistrationStatus) Retrieve the domain registration status. +
              #### [getExtendedAttributes](/reference/services/SoftLayer_Dns_Domain_Registration/getExtendedAttributes) Retrieves extended attributes. +
              #### [getObject](/reference/services/SoftLayer_Dns_Domain_Registration/getObject) Retrieve a SoftLayer_Dns_Domain_Registration record. +
              #### [getRegisteredNameserver](/reference/services/SoftLayer_Dns_Domain_Registration/getRegisteredNameserver) Retrieves a registered nameserver. +
              #### [getRegistrantVerificationStatus](/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatus) Retrieve the registrant verification status. +
              #### [getRegistrantVerificationStatusDetail](/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatusDetail) Retrieves registrant verification status. +
              #### [getServiceProvider](/reference/services/SoftLayer_Dns_Domain_Registration/getServiceProvider) +
              #### [getTransferInformation](/reference/services/SoftLayer_Dns_Domain_Registration/getTransferInformation) Retrieve domain transfer information. +
              #### [lockDomain](/reference/services/SoftLayer_Dns_Domain_Registration/lockDomain) Locks a domain. +
              #### [lookupDomain](/reference/services/SoftLayer_Dns_Domain_Registration/lookupDomain) Lookup available domains and suggests other similar domain names +
              #### [modifyContact](/reference/services/SoftLayer_Dns_Domain_Registration/modifyContact) Modifies contact information for a domain. +
              #### [modifyRegisteredNameserver](/reference/services/SoftLayer_Dns_Domain_Registration/modifyRegisteredNameserver) Modifies a registered nameserver. +
              #### [registerNameserver](/reference/services/SoftLayer_Dns_Domain_Registration/registerNameserver) Creates a nameserver. +
              #### [removeNameserversFromDomain](/reference/services/SoftLayer_Dns_Domain_Registration/removeNameserversFromDomain) Removes nameservers from a domain. +
              #### [sendAuthenticationCode](/reference/services/SoftLayer_Dns_Domain_Registration/sendAuthenticationCode) Sends the authentication code +
              #### [sendRegistrantVerificationEmail](/reference/services/SoftLayer_Dns_Domain_Registration/sendRegistrantVerificationEmail) Sends verification email to the registrant. +
              #### [sendTransferApprovalEmail](/reference/services/SoftLayer_Dns_Domain_Registration/sendTransferApprovalEmail) Resends a transfer approval email message. +
              #### [setAuthenticationCode](/reference/services/SoftLayer_Dns_Domain_Registration/setAuthenticationCode) Sets the authentication code for a domain. +
              #### [unlockDomain](/reference/services/SoftLayer_Dns_Domain_Registration/unlockDomain) Unlocks a domain. +
              diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/addNameserversToDomain.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/addNameserversToDomain.md index a7bff5d4d0..f2ad5ad28e 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/addNameserversToDomain.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/addNameserversToDomain.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::addNameserversToDomain + Adds nameservers to a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/deleteRegisteredNameserver.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/deleteRegisteredNameserver.md index cac974ab71..59b83577fe 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/deleteRegisteredNameserver.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/deleteRegisteredNameserver.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::deleteRegisteredNameserver + Deletes a registered nameserver. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getAccount.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getAccount.md index f60a2f3e2e..bdd7a67990 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getAccount.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::getAccount + Retrieve the SoftLayer customer account that the domain is registered to. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getAuthenticationCode.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getAuthenticationCode.md index f7b9ee2f9b..8ac6e8f4b1 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getAuthenticationCode.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/getAuthenticationCode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::getAuthenticationCode + Get the authentication code for a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainInformation.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainInformation.md index 27ffa644f8..178277636d 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainInformation.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainInformation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::getDomainInformation + Retrieve all domain information. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainNameservers.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainNameservers.md index 733333f6ef..a8c1c44eb1 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainNameservers.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainNameservers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::getDomainNameservers + Retrieve domain nameservers. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainRegistrationStatus.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainRegistrationStatus.md index c05d619650..978b16297c 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainRegistrationStatus.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/getDomainRegistrationStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::getDomainRegistrationStatus + Retrieve the domain registration status. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getExtendedAttributes.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getExtendedAttributes.md index 2b0cc943ef..9cb4696df1 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getExtendedAttributes.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/getExtendedAttributes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::getExtendedAttributes + Retrieves extended attributes. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getObject.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getObject.md index b3be6fe629..eed0b84b7a 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getObject.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::getObject + Retrieve a SoftLayer_Dns_Domain_Registration record. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegisteredNameserver.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegisteredNameserver.md index de97d3ae3a..b36e0e10f0 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegisteredNameserver.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegisteredNameserver.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::getRegisteredNameserver + Retrieves a registered nameserver. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatus.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatus.md index f1b0439436..bf923731be 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatus.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::getRegistrantVerificationStatus + Retrieve the registrant verification status. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatusDetail.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatusDetail.md index 89076d2c1a..b6c322b5f7 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatusDetail.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatusDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::getRegistrantVerificationStatusDetail + Retrieves registrant verification status. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getServiceProvider.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getServiceProvider.md index a2d6373d3c..1f59b9d03c 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getServiceProvider.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/getServiceProvider.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/getTransferInformation.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/getTransferInformation.md index 3211d2473f..05c3bef4b1 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/getTransferInformation.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/getTransferInformation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::getTransferInformation + Retrieve domain transfer information. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/lockDomain.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/lockDomain.md index 20d709ae91..e0f98dcdbc 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/lockDomain.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/lockDomain.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::lockDomain + Locks a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/lookupDomain.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/lookupDomain.md index 2e4868c862..7612c73185 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/lookupDomain.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/lookupDomain.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::lookupDomain + Lookup available domains and suggests other similar domain names diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/modifyContact.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/modifyContact.md index dfa48a795e..c6509c1d5d 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/modifyContact.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/modifyContact.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::modifyContact + Modifies contact information for a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/modifyRegisteredNameserver.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/modifyRegisteredNameserver.md index ae9aad0db2..4055b65c39 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/modifyRegisteredNameserver.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/modifyRegisteredNameserver.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::modifyRegisteredNameserver + Modifies a registered nameserver. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/registerNameserver.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/registerNameserver.md index 9304e19db0..bd8a95603b 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/registerNameserver.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/registerNameserver.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::registerNameserver + Creates a nameserver. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/removeNameserversFromDomain.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/removeNameserversFromDomain.md index 63230a946d..670a30a75c 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/removeNameserversFromDomain.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/removeNameserversFromDomain.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::removeNameserversFromDomain + Removes nameservers from a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/sendAuthenticationCode.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/sendAuthenticationCode.md index 391e9fddc5..42531ba025 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/sendAuthenticationCode.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/sendAuthenticationCode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::sendAuthenticationCode + Sends the authentication code diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/sendRegistrantVerificationEmail.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/sendRegistrantVerificationEmail.md index 835ed03c9e..8199f7fab4 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/sendRegistrantVerificationEmail.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/sendRegistrantVerificationEmail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::sendRegistrantVerificationEmail + Sends verification email to the registrant. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/sendTransferApprovalEmail.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/sendTransferApprovalEmail.md index effe546f79..ecd86af1f3 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/sendTransferApprovalEmail.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/sendTransferApprovalEmail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::sendTransferApprovalEmail + Resends a transfer approval email message. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/setAuthenticationCode.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/setAuthenticationCode.md index c665cf3007..991ae67102 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/setAuthenticationCode.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/setAuthenticationCode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::setAuthenticationCode + Sets the authentication code for a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration/unlockDomain.md b/content/reference/services/SoftLayer_Dns_Domain_Registration/unlockDomain.md index 1c4df1ad30..35fda34bad 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration/unlockDomain.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration/unlockDomain.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration](/reference/services/SoftLayer_Dns_Domain_Registration)::unlockDomain + Unlocks a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/_index.md b/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/_index.md index d03202319d..6cb0e0565c 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/_index.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getObject) Retrieve a SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status record. +
              diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getAllObjects.md b/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getAllObjects.md index 43de0b33b2..fe692e9c8e 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getAllObjects.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getObject.md b/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getObject.md index ea8d9d4639..eaa062df22 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getObject.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status](/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status)::getObject + Retrieve a SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status record. diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/_index.md b/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/_index.md index ea0ed43083..2efd6a4dc8 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/_index.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Dns_Domain_Registration_Status/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_Dns_Domain_Registration_Status/getObject) Retrieve a SoftLayer_Dns_Domain_Registration_Status record. +
              diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/getAllObjects.md b/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/getAllObjects.md index 439e9c20b4..77f3ab2052 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/getAllObjects.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/getObject.md b/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/getObject.md index 218248f838..a86727c130 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/getObject.md +++ b/content/reference/services/SoftLayer_Dns_Domain_Registration_Status/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_Registration_Status](/reference/services/SoftLayer_Dns_Domain_Registration_Status)::getObject + Retrieve a SoftLayer_Dns_Domain_Registration_Status record. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/_index.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/_index.md index d97b233ee6..c27fe18b23 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/_index.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -99,48 +101,56 @@ As with domain changes, resource record changes happen immediately, but may take #### [createObject](/reference/services/SoftLayer_Dns_Domain_ResourceRecord/createObject) Create a domain's resource record. +
              #### [createObjects](/reference/services/SoftLayer_Dns_Domain_ResourceRecord/createObjects) Create multiple domain resource records. +
              #### [deleteObject](/reference/services/SoftLayer_Dns_Domain_ResourceRecord/deleteObject) Delete a domain's resource record. +
              #### [deleteObjects](/reference/services/SoftLayer_Dns_Domain_ResourceRecord/deleteObjects) Delete multiple resource records from a domain. +
              #### [editObject](/reference/services/SoftLayer_Dns_Domain_ResourceRecord/editObject) Edit a domain's resource record. +
              #### [editObjects](/reference/services/SoftLayer_Dns_Domain_ResourceRecord/editObjects) Edit multiple domain resource records. +
              #### [getDomain](/reference/services/SoftLayer_Dns_Domain_ResourceRecord/getDomain) Retrieve the domain that a resource record belongs to. +
              #### [getObject](/reference/services/SoftLayer_Dns_Domain_ResourceRecord/getObject) Retrieve a SoftLayer_Dns_Domain_ResourceRecord record. +
              diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/createObject.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/createObject.md index 80ac931601..a7c99e4227 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/createObject.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord](/reference/services/SoftLayer_Dns_Domain_ResourceRecord)::createObject + Create a domain's resource record. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/createObjects.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/createObjects.md index a8d126474b..2154872f0a 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/createObjects.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/createObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord](/reference/services/SoftLayer_Dns_Domain_ResourceRecord)::createObjects + Create multiple domain resource records. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/deleteObject.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/deleteObject.md index e96a1165c4..bf065ad92b 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/deleteObject.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord](/reference/services/SoftLayer_Dns_Domain_ResourceRecord)::deleteObject + Delete a domain's resource record. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/deleteObjects.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/deleteObjects.md index a2adc02c9a..2174722bad 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/deleteObjects.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/deleteObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord](/reference/services/SoftLayer_Dns_Domain_ResourceRecord)::deleteObjects + Delete multiple resource records from a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/editObject.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/editObject.md index 7109bbabf5..6a83fb56aa 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/editObject.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord](/reference/services/SoftLayer_Dns_Domain_ResourceRecord)::editObject + Edit a domain's resource record. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/editObjects.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/editObjects.md index e4ef44ac94..92c63fc854 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/editObjects.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/editObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord](/reference/services/SoftLayer_Dns_Domain_ResourceRecord)::editObjects + Edit multiple domain resource records. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/getDomain.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/getDomain.md index 59a95ed158..2f679500ca 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/getDomain.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/getDomain.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord](/reference/services/SoftLayer_Dns_Domain_ResourceRecord)::getDomain + Retrieve the domain that a resource record belongs to. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/getObject.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/getObject.md index 295be6a583..54b666e128 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/getObject.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord](/reference/services/SoftLayer_Dns_Domain_ResourceRecord)::getObject + Retrieve a SoftLayer_Dns_Domain_ResourceRecord record. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/_index.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/_index.md index 455db1c832..b4733b6ac4 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/_index.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -56,48 +58,56 @@ The SoftLayer_Dns_Domain_ResourceRecord_MxType service controls the creation, mo #### [createObject](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/createObject) Create an MX record. +
              #### [createObjects](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/createObjects) Create multiple MX records. +
              #### [deleteObject](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/deleteObject) Delete a domain's MX record. +
              #### [deleteObjects](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/deleteObjects) Delete multiple MX records from a domain. +
              #### [editObject](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/editObject) Edit a domain's MX record. +
              #### [editObjects](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/editObjects) Edit multiple domain MX records. +
              #### [getDomain](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/getDomain) Retrieve the domain that a resource record belongs to. +
              #### [getObject](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/getObject) Retrieve a SoftLayer_Dns_Domain_ResourceRecord_MxType record. +
              diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/createObject.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/createObject.md index 48bff6f31f..62162d904d 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/createObject.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord_MxType](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType)::createObject + Create an MX record. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/createObjects.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/createObjects.md index 444c49a81e..63014a26bf 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/createObjects.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/createObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord_MxType](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType)::createObjects + Create multiple MX records. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/deleteObject.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/deleteObject.md index 7be9b84645..10fce1ac1a 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/deleteObject.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord_MxType](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType)::deleteObject + Delete a domain's MX record. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/deleteObjects.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/deleteObjects.md index 34063c20c7..641afa6b66 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/deleteObjects.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/deleteObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord_MxType](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType)::deleteObjects + Delete multiple MX records from a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/editObject.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/editObject.md index 942c5e640a..320f053b76 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/editObject.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord_MxType](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType)::editObject + Edit a domain's MX record. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/editObjects.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/editObjects.md index 7eaf07ce61..fbe2f05b23 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/editObjects.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/editObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord_MxType](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType)::editObjects + Edit multiple domain MX records. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/getDomain.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/getDomain.md index d27ad5a8b4..e27e5c503a 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/getDomain.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/getDomain.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord_MxType](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType)::getDomain + Retrieve the domain that a resource record belongs to. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/getObject.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/getObject.md index 7d281b3156..ccba362890 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/getObject.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord_MxType](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_MxType)::getObject + Retrieve a SoftLayer_Dns_Domain_ResourceRecord_MxType record. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/_index.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/_index.md index c12685fded..19b52079fc 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/_index.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -56,48 +58,56 @@ The SoftLayer_Dns_Domain_ResourceRecord_SrvType service controls the creation, m #### [createObject](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/createObject) Create an SRV record. +
              #### [createObjects](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/createObjects) Create multiple SRV records. +
              #### [deleteObject](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/deleteObject) Delete a domain's SRV record. +
              #### [deleteObjects](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/deleteObjects) Delete multiple SRV records from a domain. +
              #### [editObject](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/editObject) Edit a domain's SRV record. +
              #### [editObjects](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/editObjects) Edit multiple domain SRV records. +
              #### [getDomain](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/getDomain) Retrieve the domain that a resource record belongs to. +
              #### [getObject](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/getObject) Retrieve a SoftLayer_Dns_Domain_ResourceRecord_SrvType record. +
              diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/createObject.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/createObject.md index 646b5dc886..1203f8c5a7 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/createObject.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord_SrvType](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType)::createObject + Create an SRV record. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/createObjects.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/createObjects.md index b4f4c0d187..0ba19d8e1c 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/createObjects.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/createObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord_SrvType](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType)::createObjects + Create multiple SRV records. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/deleteObject.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/deleteObject.md index e6bd40de13..a6f57b2a85 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/deleteObject.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord_SrvType](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType)::deleteObject + Delete a domain's SRV record. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/deleteObjects.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/deleteObjects.md index 1cff7b851e..77e06fc4ca 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/deleteObjects.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/deleteObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord_SrvType](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType)::deleteObjects + Delete multiple SRV records from a domain. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/editObject.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/editObject.md index 56fb0fccd4..f12419e1f4 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/editObject.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord_SrvType](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType)::editObject + Edit a domain's SRV record. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/editObjects.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/editObjects.md index 3b24f6da9c..97b6f85fd2 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/editObjects.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/editObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord_SrvType](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType)::editObjects + Edit multiple domain SRV records. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/getDomain.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/getDomain.md index 50d227321a..086bb74fcf 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/getDomain.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/getDomain.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord_SrvType](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType)::getDomain + Retrieve the domain that a resource record belongs to. diff --git a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/getObject.md b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/getObject.md index 1a0f3cd9a9..f5aefed0b2 100644 --- a/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/getObject.md +++ b/content/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Domain_ResourceRecord_SrvType](/reference/services/SoftLayer_Dns_Domain_ResourceRecord_SrvType)::getObject + Retrieve a SoftLayer_Dns_Domain_ResourceRecord_SrvType record. diff --git a/content/reference/services/SoftLayer_Dns_Secondary/_index.md b/content/reference/services/SoftLayer_Dns_Secondary/_index.md index 55a3af3bab..a0703f4be3 100644 --- a/content/reference/services/SoftLayer_Dns_Secondary/_index.md +++ b/content/reference/services/SoftLayer_Dns_Secondary/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) 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. @@ -63,72 +65,84 @@ Secondary DNS transfers may periodically generate notification or error messages #### [convertToPrimary](/reference/services/SoftLayer_Dns_Secondary/convertToPrimary) Convert a secondary DNS record into a primary DNS record. +
              #### [createObject](/reference/services/SoftLayer_Dns_Secondary/createObject) Create a secondary DNS record. +
              #### [createObjects](/reference/services/SoftLayer_Dns_Secondary/createObjects) Create multiple secondary DNS records. +
              #### [deleteObject](/reference/services/SoftLayer_Dns_Secondary/deleteObject) Delete a secondary DNS record +
              #### [editObject](/reference/services/SoftLayer_Dns_Secondary/editObject) Edit a secondary DNS record. +
              #### [getAccount](/reference/services/SoftLayer_Dns_Secondary/getAccount) Retrieve the SoftLayer account that owns a secondary DNS record. +
              #### [getByDomainName](/reference/services/SoftLayer_Dns_Secondary/getByDomainName) Search for secondary domains by name. +
              #### [getDomain](/reference/services/SoftLayer_Dns_Secondary/getDomain) Retrieve the domain record created by zone transfer from a secondary DNS record. +
              #### [getErrorMessages](/reference/services/SoftLayer_Dns_Secondary/getErrorMessages) Retrieve the error messages created during secondary DNS record transfer. +
              #### [getObject](/reference/services/SoftLayer_Dns_Secondary/getObject) Retrieve a SoftLayer_Dns_Secondary record. +
              #### [getStatus](/reference/services/SoftLayer_Dns_Secondary/getStatus) Retrieve the current status of the secondary DNS zone. +
              #### [transferNow](/reference/services/SoftLayer_Dns_Secondary/transferNow) Initiate a zone transfer for a secondary DNS record. +
              diff --git a/content/reference/services/SoftLayer_Dns_Secondary/convertToPrimary.md b/content/reference/services/SoftLayer_Dns_Secondary/convertToPrimary.md index ab1f9a8b2f..a21cefdc8b 100644 --- a/content/reference/services/SoftLayer_Dns_Secondary/convertToPrimary.md +++ b/content/reference/services/SoftLayer_Dns_Secondary/convertToPrimary.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Secondary](/reference/services/SoftLayer_Dns_Secondary)::convertToPrimary + Convert a secondary DNS record into a primary DNS record. diff --git a/content/reference/services/SoftLayer_Dns_Secondary/createObject.md b/content/reference/services/SoftLayer_Dns_Secondary/createObject.md index 9a75550962..5d3280b735 100644 --- a/content/reference/services/SoftLayer_Dns_Secondary/createObject.md +++ b/content/reference/services/SoftLayer_Dns_Secondary/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Secondary](/reference/services/SoftLayer_Dns_Secondary)::createObject + Create a secondary DNS record. diff --git a/content/reference/services/SoftLayer_Dns_Secondary/createObjects.md b/content/reference/services/SoftLayer_Dns_Secondary/createObjects.md index dfa5794429..4099848591 100644 --- a/content/reference/services/SoftLayer_Dns_Secondary/createObjects.md +++ b/content/reference/services/SoftLayer_Dns_Secondary/createObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Secondary](/reference/services/SoftLayer_Dns_Secondary)::createObjects + Create multiple secondary DNS records. diff --git a/content/reference/services/SoftLayer_Dns_Secondary/deleteObject.md b/content/reference/services/SoftLayer_Dns_Secondary/deleteObject.md index 8b2bb44355..dad735fd87 100644 --- a/content/reference/services/SoftLayer_Dns_Secondary/deleteObject.md +++ b/content/reference/services/SoftLayer_Dns_Secondary/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Secondary](/reference/services/SoftLayer_Dns_Secondary)::deleteObject + Delete a secondary DNS record diff --git a/content/reference/services/SoftLayer_Dns_Secondary/editObject.md b/content/reference/services/SoftLayer_Dns_Secondary/editObject.md index e1f096d317..89c7b8a39c 100644 --- a/content/reference/services/SoftLayer_Dns_Secondary/editObject.md +++ b/content/reference/services/SoftLayer_Dns_Secondary/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Secondary](/reference/services/SoftLayer_Dns_Secondary)::editObject + Edit a secondary DNS record. diff --git a/content/reference/services/SoftLayer_Dns_Secondary/getAccount.md b/content/reference/services/SoftLayer_Dns_Secondary/getAccount.md index 34c22e9cf5..c5e98bf7e0 100644 --- a/content/reference/services/SoftLayer_Dns_Secondary/getAccount.md +++ b/content/reference/services/SoftLayer_Dns_Secondary/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Secondary](/reference/services/SoftLayer_Dns_Secondary)::getAccount + Retrieve the SoftLayer account that owns a secondary DNS record. diff --git a/content/reference/services/SoftLayer_Dns_Secondary/getByDomainName.md b/content/reference/services/SoftLayer_Dns_Secondary/getByDomainName.md index d473b76027..30ac61b8df 100644 --- a/content/reference/services/SoftLayer_Dns_Secondary/getByDomainName.md +++ b/content/reference/services/SoftLayer_Dns_Secondary/getByDomainName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Secondary](/reference/services/SoftLayer_Dns_Secondary)::getByDomainName + Search for secondary domains by name. diff --git a/content/reference/services/SoftLayer_Dns_Secondary/getDomain.md b/content/reference/services/SoftLayer_Dns_Secondary/getDomain.md index 0d67f167e9..f9fe044955 100644 --- a/content/reference/services/SoftLayer_Dns_Secondary/getDomain.md +++ b/content/reference/services/SoftLayer_Dns_Secondary/getDomain.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Secondary](/reference/services/SoftLayer_Dns_Secondary)::getDomain + Retrieve the domain record created by zone transfer from a secondary DNS record. diff --git a/content/reference/services/SoftLayer_Dns_Secondary/getErrorMessages.md b/content/reference/services/SoftLayer_Dns_Secondary/getErrorMessages.md index e8ec59b224..d8c578ee4c 100644 --- a/content/reference/services/SoftLayer_Dns_Secondary/getErrorMessages.md +++ b/content/reference/services/SoftLayer_Dns_Secondary/getErrorMessages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Secondary](/reference/services/SoftLayer_Dns_Secondary)::getErrorMessages + Retrieve the error messages created during secondary DNS record transfer. diff --git a/content/reference/services/SoftLayer_Dns_Secondary/getObject.md b/content/reference/services/SoftLayer_Dns_Secondary/getObject.md index dd99619897..42ed7fea84 100644 --- a/content/reference/services/SoftLayer_Dns_Secondary/getObject.md +++ b/content/reference/services/SoftLayer_Dns_Secondary/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Secondary](/reference/services/SoftLayer_Dns_Secondary)::getObject + Retrieve a SoftLayer_Dns_Secondary record. diff --git a/content/reference/services/SoftLayer_Dns_Secondary/getStatus.md b/content/reference/services/SoftLayer_Dns_Secondary/getStatus.md index 3e5980640d..ca83fd87cf 100644 --- a/content/reference/services/SoftLayer_Dns_Secondary/getStatus.md +++ b/content/reference/services/SoftLayer_Dns_Secondary/getStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Secondary](/reference/services/SoftLayer_Dns_Secondary)::getStatus + Retrieve the current status of the secondary DNS zone. diff --git a/content/reference/services/SoftLayer_Dns_Secondary/transferNow.md b/content/reference/services/SoftLayer_Dns_Secondary/transferNow.md index 79873efdbe..2bcea819f2 100644 --- a/content/reference/services/SoftLayer_Dns_Secondary/transferNow.md +++ b/content/reference/services/SoftLayer_Dns_Secondary/transferNow.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Dns_Secondary](/reference/services/SoftLayer_Dns_Secondary)::transferNow + Initiate a zone transfer for a secondary DNS record. diff --git a/content/reference/services/SoftLayer_Email_Subscription/_index.md b/content/reference/services/SoftLayer_Email_Subscription/_index.md index 760776a56b..f7b0b36ed6 100644 --- a/content/reference/services/SoftLayer_Email_Subscription/_index.md +++ b/content/reference/services/SoftLayer_Email_Subscription/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer customers can use this service to manage or view all of the available email subscriptions that they can suppress. @@ -42,30 +44,35 @@ SoftLayer customers can use this service to manage or view all of the available #### [disable](/reference/services/SoftLayer_Email_Subscription/disable) Disable email subscription. +
              #### [enable](/reference/services/SoftLayer_Email_Subscription/enable) Enable email subscription. +
              #### [getAllObjects](/reference/services/SoftLayer_Email_Subscription/getAllObjects) +
              #### [getEnabled](/reference/services/SoftLayer_Email_Subscription/getEnabled) +
              #### [getObject](/reference/services/SoftLayer_Email_Subscription/getObject) Retrieve a SoftLayer_Email_Subscription record. +
              diff --git a/content/reference/services/SoftLayer_Email_Subscription/disable.md b/content/reference/services/SoftLayer_Email_Subscription/disable.md index 5ab6eb6666..6190b49fb2 100644 --- a/content/reference/services/SoftLayer_Email_Subscription/disable.md +++ b/content/reference/services/SoftLayer_Email_Subscription/disable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Email_Subscription](/reference/services/SoftLayer_Email_Subscription)::disable + Disable email subscription. diff --git a/content/reference/services/SoftLayer_Email_Subscription/enable.md b/content/reference/services/SoftLayer_Email_Subscription/enable.md index 75732bb18e..45362e48aa 100644 --- a/content/reference/services/SoftLayer_Email_Subscription/enable.md +++ b/content/reference/services/SoftLayer_Email_Subscription/enable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Email_Subscription](/reference/services/SoftLayer_Email_Subscription)::enable + Enable email subscription. diff --git a/content/reference/services/SoftLayer_Email_Subscription/getAllObjects.md b/content/reference/services/SoftLayer_Email_Subscription/getAllObjects.md index d4a8a9eba0..4e880445c4 100644 --- a/content/reference/services/SoftLayer_Email_Subscription/getAllObjects.md +++ b/content/reference/services/SoftLayer_Email_Subscription/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Email_Subscription/getEnabled.md b/content/reference/services/SoftLayer_Email_Subscription/getEnabled.md index d84750e544..a0503baf92 100644 --- a/content/reference/services/SoftLayer_Email_Subscription/getEnabled.md +++ b/content/reference/services/SoftLayer_Email_Subscription/getEnabled.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Email_Subscription/getObject.md b/content/reference/services/SoftLayer_Email_Subscription/getObject.md index fffac5550a..090699f07b 100644 --- a/content/reference/services/SoftLayer_Email_Subscription/getObject.md +++ b/content/reference/services/SoftLayer_Email_Subscription/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Email_Subscription](/reference/services/SoftLayer_Email_Subscription)::getObject + Retrieve a SoftLayer_Email_Subscription record. diff --git a/content/reference/services/SoftLayer_Email_Subscription_Group/_index.md b/content/reference/services/SoftLayer_Email_Subscription_Group/_index.md index c6cda9cfec..fa93c54d1a 100644 --- a/content/reference/services/SoftLayer_Email_Subscription_Group/_index.md +++ b/content/reference/services/SoftLayer_Email_Subscription_Group/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer customers can use this service to view the parent groups of the email subscriptions @@ -42,18 +44,21 @@ SoftLayer customers can use this service to view the parent groups of the email #### [getAllObjects](/reference/services/SoftLayer_Email_Subscription_Group/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_Email_Subscription_Group/getObject) Retrieve a SoftLayer_Email_Subscription_Group record. +
              #### [getSubscriptions](/reference/services/SoftLayer_Email_Subscription_Group/getSubscriptions) Retrieve all email subscriptions associated with this group. +
              diff --git a/content/reference/services/SoftLayer_Email_Subscription_Group/getAllObjects.md b/content/reference/services/SoftLayer_Email_Subscription_Group/getAllObjects.md index 3957509ec4..8b8f6f6758 100644 --- a/content/reference/services/SoftLayer_Email_Subscription_Group/getAllObjects.md +++ b/content/reference/services/SoftLayer_Email_Subscription_Group/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Email_Subscription_Group/getObject.md b/content/reference/services/SoftLayer_Email_Subscription_Group/getObject.md index 71d65e4adb..8e2618e83c 100644 --- a/content/reference/services/SoftLayer_Email_Subscription_Group/getObject.md +++ b/content/reference/services/SoftLayer_Email_Subscription_Group/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Email_Subscription_Group](/reference/services/SoftLayer_Email_Subscription_Group)::getObject + Retrieve a SoftLayer_Email_Subscription_Group record. diff --git a/content/reference/services/SoftLayer_Email_Subscription_Group/getSubscriptions.md b/content/reference/services/SoftLayer_Email_Subscription_Group/getSubscriptions.md index 1f837c5a90..3811cfd4d5 100644 --- a/content/reference/services/SoftLayer_Email_Subscription_Group/getSubscriptions.md +++ b/content/reference/services/SoftLayer_Email_Subscription_Group/getSubscriptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Email_Subscription_Group](/reference/services/SoftLayer_Email_Subscription_Group)::getSubscriptions + Retrieve all email subscriptions associated with this group. diff --git a/content/reference/services/SoftLayer_Event_Log/_index.md b/content/reference/services/SoftLayer_Event_Log/_index.md index 4815aacfd2..d4c5c2b7f3 100644 --- a/content/reference/services/SoftLayer_Event_Log/_index.md +++ b/content/reference/services/SoftLayer_Event_Log/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Event Log service lets you find interesting events related to various SoftLayer products and services such as hardware, virtual server or DNS. @@ -42,30 +44,35 @@ Event Log service lets you find interesting events related to various SoftLayer #### [getAllEventNames](/reference/services/SoftLayer_Event_Log/getAllEventNames) Return all indexed event names. +
              #### [getAllEventObjectNames](/reference/services/SoftLayer_Event_Log/getAllEventObjectNames) Return all indexed event object names. +
              #### [getAllObjects](/reference/services/SoftLayer_Event_Log/getAllObjects) Return the event log data +
              #### [getAllUserTypes](/reference/services/SoftLayer_Event_Log/getAllUserTypes) Returns all possible event log user types +
              #### [getUser](/reference/services/SoftLayer_Event_Log/getUser) +
              diff --git a/content/reference/services/SoftLayer_Event_Log/getAllEventNames.md b/content/reference/services/SoftLayer_Event_Log/getAllEventNames.md index 4c22e17ad1..c013e7b9e2 100644 --- a/content/reference/services/SoftLayer_Event_Log/getAllEventNames.md +++ b/content/reference/services/SoftLayer_Event_Log/getAllEventNames.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Event_Log](/reference/services/SoftLayer_Event_Log)::getAllEventNames + Return all indexed event names. diff --git a/content/reference/services/SoftLayer_Event_Log/getAllEventObjectNames.md b/content/reference/services/SoftLayer_Event_Log/getAllEventObjectNames.md index 991a8e77e2..56f045aca5 100644 --- a/content/reference/services/SoftLayer_Event_Log/getAllEventObjectNames.md +++ b/content/reference/services/SoftLayer_Event_Log/getAllEventObjectNames.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Event_Log](/reference/services/SoftLayer_Event_Log)::getAllEventObjectNames + Return all indexed event object names. diff --git a/content/reference/services/SoftLayer_Event_Log/getAllObjects.md b/content/reference/services/SoftLayer_Event_Log/getAllObjects.md index 28c7577cf9..43a56072ae 100644 --- a/content/reference/services/SoftLayer_Event_Log/getAllObjects.md +++ b/content/reference/services/SoftLayer_Event_Log/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Event_Log](/reference/services/SoftLayer_Event_Log)::getAllObjects + Return the event log data diff --git a/content/reference/services/SoftLayer_Event_Log/getAllUserTypes.md b/content/reference/services/SoftLayer_Event_Log/getAllUserTypes.md index 6169eb01d5..e3aa39410a 100644 --- a/content/reference/services/SoftLayer_Event_Log/getAllUserTypes.md +++ b/content/reference/services/SoftLayer_Event_Log/getAllUserTypes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Event_Log](/reference/services/SoftLayer_Event_Log)::getAllUserTypes + Returns all possible event log user types diff --git a/content/reference/services/SoftLayer_Event_Log/getUser.md b/content/reference/services/SoftLayer_Event_Log/getUser.md index 6be128a2a4..c741459f67 100644 --- a/content/reference/services/SoftLayer_Event_Log/getUser.md +++ b/content/reference/services/SoftLayer_Event_Log/getUser.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Exception_Brand_Creation/_index.md b/content/reference/services/SoftLayer_Exception_Brand_Creation/_index.md index e90788be1e..b349a8fb09 100644 --- a/content/reference/services/SoftLayer_Exception_Brand_Creation/_index.md +++ b/content/reference/services/SoftLayer_Exception_Brand_Creation/_index.md @@ -22,6 +22,8 @@ classes: + +
              diff --git a/content/reference/services/SoftLayer_FlexibleCredit_Program/_index.md b/content/reference/services/SoftLayer_FlexibleCredit_Program/_index.md index 56ba05d924..c698f6cab8 100644 --- a/content/reference/services/SoftLayer_FlexibleCredit_Program/_index.md +++ b/content/reference/services/SoftLayer_FlexibleCredit_Program/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,24 +44,28 @@ classes: #### [getAffiliatesAvailableForSelfEnrollmentByVerificationType](/reference/services/SoftLayer_FlexibleCredit_Program/getAffiliatesAvailableForSelfEnrollmentByVerificationType) +
              #### [getCompanyTypes](/reference/services/SoftLayer_FlexibleCredit_Program/getCompanyTypes) +
              #### [getObject](/reference/services/SoftLayer_FlexibleCredit_Program/getObject) Retrieve a SoftLayer_FlexibleCredit_Program record. +
              #### [selfEnrollNewAccount](/reference/services/SoftLayer_FlexibleCredit_Program/selfEnrollNewAccount) +
              diff --git a/content/reference/services/SoftLayer_FlexibleCredit_Program/getAffiliatesAvailableForSelfEnrollmentByVerificationType.md b/content/reference/services/SoftLayer_FlexibleCredit_Program/getAffiliatesAvailableForSelfEnrollmentByVerificationType.md index f652fea47a..b169b33edb 100644 --- a/content/reference/services/SoftLayer_FlexibleCredit_Program/getAffiliatesAvailableForSelfEnrollmentByVerificationType.md +++ b/content/reference/services/SoftLayer_FlexibleCredit_Program/getAffiliatesAvailableForSelfEnrollmentByVerificationType.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_FlexibleCredit_Program/getCompanyTypes.md b/content/reference/services/SoftLayer_FlexibleCredit_Program/getCompanyTypes.md index ea07a2f645..5521377211 100644 --- a/content/reference/services/SoftLayer_FlexibleCredit_Program/getCompanyTypes.md +++ b/content/reference/services/SoftLayer_FlexibleCredit_Program/getCompanyTypes.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_FlexibleCredit_Program/getObject.md b/content/reference/services/SoftLayer_FlexibleCredit_Program/getObject.md index 8e08317697..916362397c 100644 --- a/content/reference/services/SoftLayer_FlexibleCredit_Program/getObject.md +++ b/content/reference/services/SoftLayer_FlexibleCredit_Program/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_FlexibleCredit_Program](/reference/services/SoftLayer_FlexibleCredit_Program)::getObject + Retrieve a SoftLayer_FlexibleCredit_Program record. diff --git a/content/reference/services/SoftLayer_FlexibleCredit_Program/selfEnrollNewAccount.md b/content/reference/services/SoftLayer_FlexibleCredit_Program/selfEnrollNewAccount.md index a131fcf1d2..dabb301808 100644 --- a/content/reference/services/SoftLayer_FlexibleCredit_Program/selfEnrollNewAccount.md +++ b/content/reference/services/SoftLayer_FlexibleCredit_Program/selfEnrollNewAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware/_index.md b/content/reference/services/SoftLayer_Hardware/_index.md index 749a16ff1f..790506d798 100644 --- a/content/reference/services/SoftLayer_Hardware/_index.md +++ b/content/reference/services/SoftLayer_Hardware/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,1098 +44,1281 @@ Every SoftLayer hardware is defined in the SoftLayer_Hardware service. SoftLayer #### [allowAccessToNetworkStorage](/reference/services/SoftLayer_Hardware/allowAccessToNetworkStorage) Allow access to a SoftLayer_Network_Storage volume from this device. +
              #### [allowAccessToNetworkStorageList](/reference/services/SoftLayer_Hardware/allowAccessToNetworkStorageList) Allow access to multiple SoftLayer_Network_Storage volumes from this device. +
              #### [captureImage](/reference/services/SoftLayer_Hardware/captureImage) Captures an Image of the hard disk on the physical machine. +
              #### [createObject](/reference/services/SoftLayer_Hardware/createObject) Create a new server +
              #### [deleteObject](/reference/services/SoftLayer_Hardware/deleteObject) Delete a server +
              #### [deleteSoftwareComponentPasswords](/reference/services/SoftLayer_Hardware/deleteSoftwareComponentPasswords) Delete software component passwords. +
              #### [deleteTag](/reference/services/SoftLayer_Hardware/deleteTag) Delete a tag +
              #### [editSoftwareComponentPasswords](/reference/services/SoftLayer_Hardware/editSoftwareComponentPasswords) Edit the properties of software component passwords. +
              #### [executeRemoteScript](/reference/services/SoftLayer_Hardware/executeRemoteScript) Download and run remote script from uri on the hardware. Requires https for script to be executed after download. +
              #### [findByIpAddress](/reference/services/SoftLayer_Hardware/findByIpAddress) Find hardware by its primary public or private IP (ipv4) address. +
              #### [generateOrderTemplate](/reference/services/SoftLayer_Hardware/generateOrderTemplate) Obtain an order container for a given template object +
              #### [getAccount](/reference/services/SoftLayer_Hardware/getAccount) Retrieve the account associated with a piece of hardware. +
              #### [getActiveComponents](/reference/services/SoftLayer_Hardware/getActiveComponents) Retrieve a piece of hardware's active physical components. +
              #### [getActiveNetworkMonitorIncident](/reference/services/SoftLayer_Hardware/getActiveNetworkMonitorIncident) Retrieve a piece of hardware's active network monitoring incidents. +
              #### [getAllPowerComponents](/reference/services/SoftLayer_Hardware/getAllPowerComponents) +
              #### [getAllowedHost](/reference/services/SoftLayer_Hardware/getAllowedHost) Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. +
              #### [getAllowedNetworkStorage](/reference/services/SoftLayer_Hardware/getAllowedNetworkStorage) Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. +
              #### [getAllowedNetworkStorageReplicas](/reference/services/SoftLayer_Hardware/getAllowedNetworkStorageReplicas) Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. +
              #### [getAntivirusSpywareSoftwareComponent](/reference/services/SoftLayer_Hardware/getAntivirusSpywareSoftwareComponent) Retrieve information regarding an antivirus/spyware software component object. +
              #### [getAttachedNetworkStorages](/reference/services/SoftLayer_Hardware/getAttachedNetworkStorages) Return a list of SoftLayer_Network_Storage volumes authorized to this device. +
              #### [getAttributes](/reference/services/SoftLayer_Hardware/getAttributes) Retrieve information regarding a piece of hardware's specific attributes. +
              #### [getAvailableBillingTermChangePrices](/reference/services/SoftLayer_Hardware/getAvailableBillingTermChangePrices) Retrieves a list of available term prices available to this of hardware. +
              #### [getAvailableNetworkStorages](/reference/services/SoftLayer_Hardware/getAvailableNetworkStorages) Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. +
              #### [getAverageDailyPublicBandwidthUsage](/reference/services/SoftLayer_Hardware/getAverageDailyPublicBandwidthUsage) Retrieve the average daily public bandwidth usage for the current billing cycle. +
              #### [getBackendIncomingBandwidth](/reference/services/SoftLayer_Hardware/getBackendIncomingBandwidth) Retrieve the amount of incoming private network bandwidth used by a server over a period of time. +
              #### [getBackendNetworkComponents](/reference/services/SoftLayer_Hardware/getBackendNetworkComponents) Retrieve a piece of hardware's back-end or private network components. +
              #### [getBackendOutgoingBandwidth](/reference/services/SoftLayer_Hardware/getBackendOutgoingBandwidth) Retrieve the amount of outgoing private network bandwidth used by a server over a period of time. +
              #### [getBackendRouters](/reference/services/SoftLayer_Hardware/getBackendRouters) Retrieve a hardware's backend or private router. +
              #### [getBandwidthAllocation](/reference/services/SoftLayer_Hardware/getBandwidthAllocation) Retrieve a hardware's allotted bandwidth (measured in GB). +
              #### [getBandwidthAllotmentDetail](/reference/services/SoftLayer_Hardware/getBandwidthAllotmentDetail) Retrieve a hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. +
              #### [getBenchmarkCertifications](/reference/services/SoftLayer_Hardware/getBenchmarkCertifications) Retrieve information regarding a piece of hardware's benchmark certifications. +
              #### [getBillingItem](/reference/services/SoftLayer_Hardware/getBillingItem) Retrieve information regarding the billing item for a server. +
              #### [getBillingItemFlag](/reference/services/SoftLayer_Hardware/getBillingItemFlag) Retrieve a flag indicating that a billing item exists. +
              #### [getBlockCancelBecauseDisconnectedFlag](/reference/services/SoftLayer_Hardware/getBlockCancelBecauseDisconnectedFlag) Retrieve determines whether the hardware is ineligible for cancellation because it is disconnected. +
              #### [getBusinessContinuanceInsuranceFlag](/reference/services/SoftLayer_Hardware/getBusinessContinuanceInsuranceFlag) Retrieve status indicating whether or not a piece of hardware has business continuance insurance. +
              #### [getChildrenHardware](/reference/services/SoftLayer_Hardware/getChildrenHardware) Retrieve child hardware. +
              #### [getComponentDetailsXML](/reference/services/SoftLayer_Hardware/getComponentDetailsXML) +
              #### [getComponents](/reference/services/SoftLayer_Hardware/getComponents) Retrieve a piece of hardware's components. +
              #### [getContinuousDataProtectionSoftwareComponent](/reference/services/SoftLayer_Hardware/getContinuousDataProtectionSoftwareComponent) Retrieve a continuous data protection/server backup software component object. +
              #### [getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) Determine options available when creating a server +
              #### [getCurrentBillableBandwidthUsage](/reference/services/SoftLayer_Hardware/getCurrentBillableBandwidthUsage) Retrieve the current billable public outbound bandwidth for this hardware for the current billing cycle. +
              #### [getCurrentBillingDetail](/reference/services/SoftLayer_Hardware/getCurrentBillingDetail) << EOT +
              #### [getCurrentBillingTotal](/reference/services/SoftLayer_Hardware/getCurrentBillingTotal) Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges. +
              #### [getDailyAverage](/reference/services/SoftLayer_Hardware/getDailyAverage) calculate the average daily network traffic used by a server in gigabytes. +
              #### [getDatacenter](/reference/services/SoftLayer_Hardware/getDatacenter) Retrieve information regarding the datacenter in which a piece of hardware resides. +
              #### [getDatacenterName](/reference/services/SoftLayer_Hardware/getDatacenterName) Retrieve the name of the datacenter in which a piece of hardware resides. +
              #### [getDaysInSparePool](/reference/services/SoftLayer_Hardware/getDaysInSparePool) Retrieve number of day(s) a server have been in spare pool. +
              #### [getDownlinkHardware](/reference/services/SoftLayer_Hardware/getDownlinkHardware) Retrieve all hardware that has uplink network connections to a piece of hardware. +
              #### [getDownlinkNetworkHardware](/reference/services/SoftLayer_Hardware/getDownlinkNetworkHardware) Retrieve all hardware that has uplink network connections to a piece of hardware. +
              #### [getDownlinkServers](/reference/services/SoftLayer_Hardware/getDownlinkServers) Retrieve information regarding all servers attached to a piece of network hardware. +
              #### [getDownlinkVirtualGuests](/reference/services/SoftLayer_Hardware/getDownlinkVirtualGuests) Retrieve information regarding all virtual guests attached to a piece of network hardware. +
              #### [getDownstreamHardwareBindings](/reference/services/SoftLayer_Hardware/getDownstreamHardwareBindings) Retrieve all hardware downstream from a network device. +
              #### [getDownstreamNetworkHardware](/reference/services/SoftLayer_Hardware/getDownstreamNetworkHardware) Retrieve all network hardware downstream from the selected piece of hardware. +
              #### [getDownstreamNetworkHardwareWithIncidents](/reference/services/SoftLayer_Hardware/getDownstreamNetworkHardwareWithIncidents) Retrieve all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. +
              #### [getDownstreamServers](/reference/services/SoftLayer_Hardware/getDownstreamServers) Retrieve information regarding all servers attached downstream to a piece of network hardware. +
              #### [getDownstreamVirtualGuests](/reference/services/SoftLayer_Hardware/getDownstreamVirtualGuests) Retrieve information regarding all virtual guests attached to a piece of network hardware. +
              #### [getDriveControllers](/reference/services/SoftLayer_Hardware/getDriveControllers) Retrieve the drive controllers contained within a piece of hardware. +
              #### [getEvaultNetworkStorage](/reference/services/SoftLayer_Hardware/getEvaultNetworkStorage) Retrieve information regarding a piece of hardware's associated EVault network storage service account. +
              #### [getFirewallServiceComponent](/reference/services/SoftLayer_Hardware/getFirewallServiceComponent) Retrieve information regarding a piece of hardware's firewall services. +
              #### [getFixedConfigurationPreset](/reference/services/SoftLayer_Hardware/getFixedConfigurationPreset) Retrieve defines the fixed components in a fixed configuration bare metal server. +
              #### [getFrontendIncomingBandwidth](/reference/services/SoftLayer_Hardware/getFrontendIncomingBandwidth) Retrieve the amount of incoming public network bandwidth used by a server over a period of time. +
              #### [getFrontendNetworkComponents](/reference/services/SoftLayer_Hardware/getFrontendNetworkComponents) Retrieve a piece of hardware's front-end or public network components. +
              #### [getFrontendOutgoingBandwidth](/reference/services/SoftLayer_Hardware/getFrontendOutgoingBandwidth) Retrieve the amount of outgoing public network bandwidth used by a server over a period of time. +
              #### [getFrontendRouters](/reference/services/SoftLayer_Hardware/getFrontendRouters) Retrieve a hardware's frontend or public router. +
              #### [getFutureBillingItem](/reference/services/SoftLayer_Hardware/getFutureBillingItem) Retrieve information regarding the future billing item for a server. +
              #### [getGlobalIdentifier](/reference/services/SoftLayer_Hardware/getGlobalIdentifier) Retrieve a hardware's universally unique identifier. +
              #### [getHardDrives](/reference/services/SoftLayer_Hardware/getHardDrives) Retrieve the hard drives contained within a piece of hardware. +
              #### [getHardwareChassis](/reference/services/SoftLayer_Hardware/getHardwareChassis) Retrieve the chassis that a piece of hardware is housed in. +
              #### [getHardwareFunction](/reference/services/SoftLayer_Hardware/getHardwareFunction) Retrieve a hardware's function. +
              #### [getHardwareFunctionDescription](/reference/services/SoftLayer_Hardware/getHardwareFunctionDescription) Retrieve a hardware's function. +
              #### [getHardwareStatus](/reference/services/SoftLayer_Hardware/getHardwareStatus) Retrieve a hardware's status. +
              #### [getHasTrustedPlatformModuleBillingItemFlag](/reference/services/SoftLayer_Hardware/getHasTrustedPlatformModuleBillingItemFlag) Retrieve determine in hardware object has TPM enabled. +
              #### [getHostIpsSoftwareComponent](/reference/services/SoftLayer_Hardware/getHostIpsSoftwareComponent) Retrieve information regarding a host IPS software component object. +
              #### [getHourlyBandwidth](/reference/services/SoftLayer_Hardware/getHourlyBandwidth) Retrieves bandwidth hourly over a 24-hour period for the specified hardware. +
              #### [getHourlyBillingFlag](/reference/services/SoftLayer_Hardware/getHourlyBillingFlag) Retrieve a server's hourly billing status. +
              #### [getInboundBandwidthUsage](/reference/services/SoftLayer_Hardware/getInboundBandwidthUsage) Retrieve the sum of all the inbound network traffic data for the last 30 days. +
              #### [getInboundPublicBandwidthUsage](/reference/services/SoftLayer_Hardware/getInboundPublicBandwidthUsage) Retrieve the total public inbound bandwidth for this hardware for the current billing cycle. +
              #### [getIsBillingTermChangeAvailableFlag](/reference/services/SoftLayer_Hardware/getIsBillingTermChangeAvailableFlag) Retrieve whether or not this hardware object is eligible to change to term billing. +
              #### [getLastTransaction](/reference/services/SoftLayer_Hardware/getLastTransaction) Retrieve information regarding the last transaction a server performed. +
              #### [getLatestNetworkMonitorIncident](/reference/services/SoftLayer_Hardware/getLatestNetworkMonitorIncident) Retrieve a piece of hardware's latest network monitoring incident. +
              #### [getLocation](/reference/services/SoftLayer_Hardware/getLocation) Retrieve where a piece of hardware is located within SoftLayer's location hierarchy. +
              #### [getLocationPathString](/reference/services/SoftLayer_Hardware/getLocationPathString) +
              #### [getLockboxNetworkStorage](/reference/services/SoftLayer_Hardware/getLockboxNetworkStorage) Retrieve information regarding a lockbox account associated with a server. +
              #### [getManagedResourceFlag](/reference/services/SoftLayer_Hardware/getManagedResourceFlag) Retrieve a flag indicating that the hardware is a managed resource. +
              #### [getMemory](/reference/services/SoftLayer_Hardware/getMemory) Retrieve information regarding a piece of hardware's memory. +
              #### [getMemoryCapacity](/reference/services/SoftLayer_Hardware/getMemoryCapacity) Retrieve the amount of memory a piece of hardware has, measured in gigabytes. +
              #### [getMetricTrackingObject](/reference/services/SoftLayer_Hardware/getMetricTrackingObject) Retrieve a piece of hardware's metric tracking object. +
              #### [getModules](/reference/services/SoftLayer_Hardware/getModules) +
              #### [getMonitoringRobot](/reference/services/SoftLayer_Hardware/getMonitoringRobot) +
              #### [getMonitoringServiceComponent](/reference/services/SoftLayer_Hardware/getMonitoringServiceComponent) Retrieve information regarding a piece of hardware's network monitoring services. +
              #### [getMonitoringServiceEligibilityFlag](/reference/services/SoftLayer_Hardware/getMonitoringServiceEligibilityFlag) +
              #### [getMotherboard](/reference/services/SoftLayer_Hardware/getMotherboard) Retrieve information regarding a piece of hardware's motherboard. +
              #### [getNetworkCards](/reference/services/SoftLayer_Hardware/getNetworkCards) Retrieve information regarding a piece of hardware's network cards. +
              #### [getNetworkComponents](/reference/services/SoftLayer_Hardware/getNetworkComponents) Retrieve returns a hardware's network components. +
              #### [getNetworkGatewayMember](/reference/services/SoftLayer_Hardware/getNetworkGatewayMember) Retrieve the gateway member if this device is part of a network gateway. +
              #### [getNetworkGatewayMemberFlag](/reference/services/SoftLayer_Hardware/getNetworkGatewayMemberFlag) Retrieve whether or not this device is part of a network gateway. +
              #### [getNetworkManagementIpAddress](/reference/services/SoftLayer_Hardware/getNetworkManagementIpAddress) Retrieve a piece of hardware's network management IP address. +
              #### [getNetworkMonitorAttachedDownHardware](/reference/services/SoftLayer_Hardware/getNetworkMonitorAttachedDownHardware) Retrieve all servers with failed monitoring that are attached downstream to a piece of hardware. +
              #### [getNetworkMonitorAttachedDownVirtualGuests](/reference/services/SoftLayer_Hardware/getNetworkMonitorAttachedDownVirtualGuests) Retrieve virtual guests that are attached downstream to a hardware that have failed monitoring +
              #### [getNetworkMonitorIncidents](/reference/services/SoftLayer_Hardware/getNetworkMonitorIncidents) Retrieve the status of all of a piece of hardware's network monitoring incidents. +
              #### [getNetworkMonitors](/reference/services/SoftLayer_Hardware/getNetworkMonitors) Retrieve information regarding a piece of hardware's network monitors. +
              #### [getNetworkStatus](/reference/services/SoftLayer_Hardware/getNetworkStatus) Retrieve the value of a hardware's network status attribute. +
              #### [getNetworkStatusAttribute](/reference/services/SoftLayer_Hardware/getNetworkStatusAttribute) Retrieve the hardware's related network status attribute. +
              #### [getNetworkStorage](/reference/services/SoftLayer_Hardware/getNetworkStorage) Retrieve information regarding a piece of hardware's associated network storage service account. +
              #### [getNetworkVlans](/reference/services/SoftLayer_Hardware/getNetworkVlans) Retrieve the network virtual LANs (VLANs) associated with a piece of hardware's network components. +
              #### [getNextBillingCycleBandwidthAllocation](/reference/services/SoftLayer_Hardware/getNextBillingCycleBandwidthAllocation) Retrieve a hardware's allotted bandwidth for the next billing cycle (measured in GB). +
              #### [getNotesHistory](/reference/services/SoftLayer_Hardware/getNotesHistory) +
              #### [getNvRamCapacity](/reference/services/SoftLayer_Hardware/getNvRamCapacity) Retrieve the amount of non-volatile memory a piece of hardware has, measured in gigabytes. +
              #### [getNvRamComponentModels](/reference/services/SoftLayer_Hardware/getNvRamComponentModels) +
              #### [getObject](/reference/services/SoftLayer_Hardware/getObject) Retrieve a SoftLayer_Hardware record. +
              #### [getOperatingSystem](/reference/services/SoftLayer_Hardware/getOperatingSystem) Retrieve information regarding a piece of hardware's operating system. +
              #### [getOperatingSystemReferenceCode](/reference/services/SoftLayer_Hardware/getOperatingSystemReferenceCode) Retrieve a hardware's operating system software description. +
              #### [getOutboundBandwidthUsage](/reference/services/SoftLayer_Hardware/getOutboundBandwidthUsage) Retrieve the sum of all the outbound network traffic data for the last 30 days. +
              #### [getOutboundPublicBandwidthUsage](/reference/services/SoftLayer_Hardware/getOutboundPublicBandwidthUsage) Retrieve the total public outbound bandwidth for this hardware for the current billing cycle. +
              #### [getParentBay](/reference/services/SoftLayer_Hardware/getParentBay) Retrieve blade Bay +
              #### [getParentHardware](/reference/services/SoftLayer_Hardware/getParentHardware) Retrieve parent Hardware. +
              #### [getPointOfPresenceLocation](/reference/services/SoftLayer_Hardware/getPointOfPresenceLocation) Retrieve information regarding the Point of Presence (PoP) location in which a piece of hardware resides. +
              #### [getPowerComponents](/reference/services/SoftLayer_Hardware/getPowerComponents) Retrieve the power components for a hardware object. +
              #### [getPowerSupply](/reference/services/SoftLayer_Hardware/getPowerSupply) Retrieve information regarding a piece of hardware's power supply. +
              #### [getPrimaryBackendIpAddress](/reference/services/SoftLayer_Hardware/getPrimaryBackendIpAddress) Retrieve the hardware's primary private IP address. +
              #### [getPrimaryBackendNetworkComponent](/reference/services/SoftLayer_Hardware/getPrimaryBackendNetworkComponent) Retrieve information regarding the hardware's primary back-end network component. +
              #### [getPrimaryIpAddress](/reference/services/SoftLayer_Hardware/getPrimaryIpAddress) Retrieve the hardware's primary public IP address. +
              #### [getPrimaryNetworkComponent](/reference/services/SoftLayer_Hardware/getPrimaryNetworkComponent) Retrieve information regarding the hardware's primary public network component. +
              #### [getPrivateBandwidthData](/reference/services/SoftLayer_Hardware/getPrivateBandwidthData) Retrieve a graph of a server's private network usage. +
              #### [getPrivateNetworkOnlyFlag](/reference/services/SoftLayer_Hardware/getPrivateNetworkOnlyFlag) Retrieve whether the hardware only has access to the private network. +
              #### [getProcessorCoreAmount](/reference/services/SoftLayer_Hardware/getProcessorCoreAmount) Retrieve the total number of processor cores, summed from all processors that are attached to a piece of hardware +
              #### [getProcessorPhysicalCoreAmount](/reference/services/SoftLayer_Hardware/getProcessorPhysicalCoreAmount) Retrieve the total number of physical processor cores, summed from all processors that are attached to a piece of hardware +
              #### [getProcessors](/reference/services/SoftLayer_Hardware/getProcessors) Retrieve information regarding a piece of hardware's processors. +
              #### [getPublicBandwidthData](/reference/services/SoftLayer_Hardware/getPublicBandwidthData) Retrieve a graph of a server's public network usage. +
              #### [getRack](/reference/services/SoftLayer_Hardware/getRack) +
              #### [getRaidControllers](/reference/services/SoftLayer_Hardware/getRaidControllers) Retrieve the RAID controllers contained within a piece of hardware. +
              #### [getRecentEvents](/reference/services/SoftLayer_Hardware/getRecentEvents) Retrieve recent events that impact this hardware. +
              #### [getRemoteManagementAccounts](/reference/services/SoftLayer_Hardware/getRemoteManagementAccounts) Retrieve user credentials to issue commands and/or interact with the server's remote management card. +
              #### [getRemoteManagementComponent](/reference/services/SoftLayer_Hardware/getRemoteManagementComponent) Retrieve a hardware's associated remote management component. This is normally IPMI. +
              #### [getResourceConfigurations](/reference/services/SoftLayer_Hardware/getResourceConfigurations) +
              #### [getResourceGroupMemberReferences](/reference/services/SoftLayer_Hardware/getResourceGroupMemberReferences) +
              #### [getResourceGroupRoles](/reference/services/SoftLayer_Hardware/getResourceGroupRoles) +
              #### [getResourceGroups](/reference/services/SoftLayer_Hardware/getResourceGroups) Retrieve the resource groups in which this hardware is a member. +
              #### [getRouters](/reference/services/SoftLayer_Hardware/getRouters) Retrieve a hardware's routers. +
              #### [getScaleAssets](/reference/services/SoftLayer_Hardware/getScaleAssets) Retrieve collection of scale assets this hardware corresponds to. +
              #### [getSecurityScanRequests](/reference/services/SoftLayer_Hardware/getSecurityScanRequests) Retrieve information regarding a piece of hardware's vulnerability scan requests. +
              #### [getSensorData](/reference/services/SoftLayer_Hardware/getSensorData) Retrieve a server's hardware state via its internal sensors +
              #### [getSensorDataWithGraphs](/reference/services/SoftLayer_Hardware/getSensorDataWithGraphs) Retrieve server's temperature and fan speed graphs as well the sensor raw data. +
              #### [getServerFanSpeedGraphs](/reference/services/SoftLayer_Hardware/getServerFanSpeedGraphs) Retrieve a server's fan speed graphs. +
              #### [getServerPowerState](/reference/services/SoftLayer_Hardware/getServerPowerState) Retrieves a server's power state. +
              #### [getServerRoom](/reference/services/SoftLayer_Hardware/getServerRoom) Retrieve information regarding the server room in which the hardware is located. +
              #### [getServerTemperatureGraphs](/reference/services/SoftLayer_Hardware/getServerTemperatureGraphs) Retrieve server's temperature graphs +
              #### [getServiceProvider](/reference/services/SoftLayer_Hardware/getServiceProvider) Retrieve information regarding the piece of hardware's service provider. +
              #### [getSoftwareComponents](/reference/services/SoftLayer_Hardware/getSoftwareComponents) Retrieve information regarding a piece of hardware's installed software. +
              #### [getSparePoolBillingItem](/reference/services/SoftLayer_Hardware/getSparePoolBillingItem) Retrieve information regarding the billing item for a spare pool server. +
              #### [getSshKeys](/reference/services/SoftLayer_Hardware/getSshKeys) Retrieve sSH keys to be installed on the server during provisioning or an OS reload. +
              #### [getStorageGroups](/reference/services/SoftLayer_Hardware/getStorageGroups) +
              #### [getStorageNetworkComponents](/reference/services/SoftLayer_Hardware/getStorageNetworkComponents) Retrieve a piece of hardware's private storage network components. [Deprecated] +
              #### [getTagReferences](/reference/services/SoftLayer_Hardware/getTagReferences) +
              #### [getTopLevelLocation](/reference/services/SoftLayer_Hardware/getTopLevelLocation) +
              #### [getTransactionHistory](/reference/services/SoftLayer_Hardware/getTransactionHistory) Get transaction history for a piece of hardware. +
              #### [getUpgradeItemPrices](/reference/services/SoftLayer_Hardware/getUpgradeItemPrices) Retrieve a list of upgradable items available to a piece of hardware. +
              #### [getUpgradeRequest](/reference/services/SoftLayer_Hardware/getUpgradeRequest) Retrieve an account's associated upgrade request object, if any. +
              #### [getUplinkHardware](/reference/services/SoftLayer_Hardware/getUplinkHardware) Retrieve the network device connected to a piece of hardware. +
              #### [getUplinkNetworkComponents](/reference/services/SoftLayer_Hardware/getUplinkNetworkComponents) Retrieve information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. +
              #### [getUserData](/reference/services/SoftLayer_Hardware/getUserData) Retrieve an array containing a single string of custom user data for a hardware order. Max size is 16 kb. +
              #### [getVirtualChassis](/reference/services/SoftLayer_Hardware/getVirtualChassis) Retrieve information regarding the virtual chassis for a piece of hardware. +
              #### [getVirtualChassisSiblings](/reference/services/SoftLayer_Hardware/getVirtualChassisSiblings) Retrieve information regarding the virtual chassis siblings for a piece of hardware. +
              #### [getVirtualHost](/reference/services/SoftLayer_Hardware/getVirtualHost) Retrieve a piece of hardware's virtual host record. +
              #### [getVirtualLicenses](/reference/services/SoftLayer_Hardware/getVirtualLicenses) Retrieve information regarding a piece of hardware's virtual software licenses. +
              #### [getVirtualRack](/reference/services/SoftLayer_Hardware/getVirtualRack) Retrieve information regarding the bandwidth allotment to which a piece of hardware belongs. +
              #### [getVirtualRackId](/reference/services/SoftLayer_Hardware/getVirtualRackId) Retrieve the name of the bandwidth allotment belonging to a piece of hardware. +
              #### [getVirtualRackName](/reference/services/SoftLayer_Hardware/getVirtualRackName) Retrieve the name of the bandwidth allotment belonging to a piece of hardware. +
              #### [getVirtualizationPlatform](/reference/services/SoftLayer_Hardware/getVirtualizationPlatform) Retrieve a piece of hardware's virtualization platform software. +
              #### [importVirtualHost](/reference/services/SoftLayer_Hardware/importVirtualHost) attempt to import the host record for the virtualization platform running on a server +
              #### [isPingable](/reference/services/SoftLayer_Hardware/isPingable) Verifies whether or not a server is pingable. +
              #### [ping](/reference/services/SoftLayer_Hardware/ping) Issues ping command. +
              #### [powerCycle](/reference/services/SoftLayer_Hardware/powerCycle) Issues power cycle to server. +
              #### [powerOff](/reference/services/SoftLayer_Hardware/powerOff) Power off server. +
              #### [powerOn](/reference/services/SoftLayer_Hardware/powerOn) Power on server. +
              #### [rebootDefault](/reference/services/SoftLayer_Hardware/rebootDefault) Reboot the server via the default method. +
              #### [rebootHard](/reference/services/SoftLayer_Hardware/rebootHard) Reboot the server via "hard" reboot. +
              #### [rebootSoft](/reference/services/SoftLayer_Hardware/rebootSoft) Execute a soft reboot to the server. +
              #### [removeAccessToNetworkStorage](/reference/services/SoftLayer_Hardware/removeAccessToNetworkStorage) Remove access to a SoftLayer_Network_Storage volume from this device. +
              #### [removeAccessToNetworkStorageList](/reference/services/SoftLayer_Hardware/removeAccessToNetworkStorageList) Remove access to multiple SoftLayer_Network_Storage volumes from this device. +
              #### [removeTags](/reference/services/SoftLayer_Hardware/removeTags) Remove a tag reference +
              #### [setTags](/reference/services/SoftLayer_Hardware/setTags) +
              #### [updateIpmiPassword](/reference/services/SoftLayer_Hardware/updateIpmiPassword) Update the root IPMI user password +
              diff --git a/content/reference/services/SoftLayer_Hardware/allowAccessToNetworkStorage.md b/content/reference/services/SoftLayer_Hardware/allowAccessToNetworkStorage.md index 7733388f62..71ce5cf7f7 100644 --- a/content/reference/services/SoftLayer_Hardware/allowAccessToNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware/allowAccessToNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::allowAccessToNetworkStorage + Allow access to a SoftLayer_Network_Storage volume from this device. diff --git a/content/reference/services/SoftLayer_Hardware/allowAccessToNetworkStorageList.md b/content/reference/services/SoftLayer_Hardware/allowAccessToNetworkStorageList.md index 69b3414d1e..b210862cfa 100644 --- a/content/reference/services/SoftLayer_Hardware/allowAccessToNetworkStorageList.md +++ b/content/reference/services/SoftLayer_Hardware/allowAccessToNetworkStorageList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::allowAccessToNetworkStorageList + Allow access to multiple SoftLayer_Network_Storage volumes from this device. diff --git a/content/reference/services/SoftLayer_Hardware/captureImage.md b/content/reference/services/SoftLayer_Hardware/captureImage.md index 0296bf4b65..37bdc5e852 100644 --- a/content/reference/services/SoftLayer_Hardware/captureImage.md +++ b/content/reference/services/SoftLayer_Hardware/captureImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::captureImage + Captures an Image of the hard disk on the physical machine. diff --git a/content/reference/services/SoftLayer_Hardware/createObject.md b/content/reference/services/SoftLayer_Hardware/createObject.md index 1ab2c394e1..e58be5d4a1 100644 --- a/content/reference/services/SoftLayer_Hardware/createObject.md +++ b/content/reference/services/SoftLayer_Hardware/createObject.md @@ -14,6 +14,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::createObject + Create a new server diff --git a/content/reference/services/SoftLayer_Hardware/deleteObject.md b/content/reference/services/SoftLayer_Hardware/deleteObject.md index ff3572c902..86a1293683 100644 --- a/content/reference/services/SoftLayer_Hardware/deleteObject.md +++ b/content/reference/services/SoftLayer_Hardware/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::deleteObject + Delete a server diff --git a/content/reference/services/SoftLayer_Hardware/deleteSoftwareComponentPasswords.md b/content/reference/services/SoftLayer_Hardware/deleteSoftwareComponentPasswords.md index 6f7d3f7f39..fde8ef48e6 100644 --- a/content/reference/services/SoftLayer_Hardware/deleteSoftwareComponentPasswords.md +++ b/content/reference/services/SoftLayer_Hardware/deleteSoftwareComponentPasswords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::deleteSoftwareComponentPasswords + Delete software component passwords. diff --git a/content/reference/services/SoftLayer_Hardware/deleteTag.md b/content/reference/services/SoftLayer_Hardware/deleteTag.md index b0974cc92c..d114bc986f 100644 --- a/content/reference/services/SoftLayer_Hardware/deleteTag.md +++ b/content/reference/services/SoftLayer_Hardware/deleteTag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::deleteTag + Delete a tag diff --git a/content/reference/services/SoftLayer_Hardware/editSoftwareComponentPasswords.md b/content/reference/services/SoftLayer_Hardware/editSoftwareComponentPasswords.md index 58c6dc1c55..b0542f53a0 100644 --- a/content/reference/services/SoftLayer_Hardware/editSoftwareComponentPasswords.md +++ b/content/reference/services/SoftLayer_Hardware/editSoftwareComponentPasswords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::editSoftwareComponentPasswords + Edit the properties of software component passwords. diff --git a/content/reference/services/SoftLayer_Hardware/executeRemoteScript.md b/content/reference/services/SoftLayer_Hardware/executeRemoteScript.md index f044596a30..51aadb1bf3 100644 --- a/content/reference/services/SoftLayer_Hardware/executeRemoteScript.md +++ b/content/reference/services/SoftLayer_Hardware/executeRemoteScript.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::executeRemoteScript + Download and run remote script from uri on the hardware. Requires https for script to be executed after download. diff --git a/content/reference/services/SoftLayer_Hardware/findByIpAddress.md b/content/reference/services/SoftLayer_Hardware/findByIpAddress.md index 5ea7cc3f9f..f406024353 100644 --- a/content/reference/services/SoftLayer_Hardware/findByIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware/findByIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::findByIpAddress + Find hardware by its primary public or private IP (ipv4) address. diff --git a/content/reference/services/SoftLayer_Hardware/generateOrderTemplate.md b/content/reference/services/SoftLayer_Hardware/generateOrderTemplate.md index 41835746e3..2db55175d6 100644 --- a/content/reference/services/SoftLayer_Hardware/generateOrderTemplate.md +++ b/content/reference/services/SoftLayer_Hardware/generateOrderTemplate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::generateOrderTemplate + Obtain an order container for a given template object diff --git a/content/reference/services/SoftLayer_Hardware/getAccount.md b/content/reference/services/SoftLayer_Hardware/getAccount.md index 6d41a02352..4cf0a2edf6 100644 --- a/content/reference/services/SoftLayer_Hardware/getAccount.md +++ b/content/reference/services/SoftLayer_Hardware/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getAccount + Retrieve the account associated with a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getActiveComponents.md b/content/reference/services/SoftLayer_Hardware/getActiveComponents.md index 24f4ec20c5..8bd95f5f34 100644 --- a/content/reference/services/SoftLayer_Hardware/getActiveComponents.md +++ b/content/reference/services/SoftLayer_Hardware/getActiveComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getActiveComponents + Retrieve a piece of hardware's active physical components. diff --git a/content/reference/services/SoftLayer_Hardware/getActiveNetworkMonitorIncident.md b/content/reference/services/SoftLayer_Hardware/getActiveNetworkMonitorIncident.md index 8f930d94b6..87d458295e 100644 --- a/content/reference/services/SoftLayer_Hardware/getActiveNetworkMonitorIncident.md +++ b/content/reference/services/SoftLayer_Hardware/getActiveNetworkMonitorIncident.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getActiveNetworkMonitorIncident + Retrieve a piece of hardware's active network monitoring incidents. diff --git a/content/reference/services/SoftLayer_Hardware/getAllPowerComponents.md b/content/reference/services/SoftLayer_Hardware/getAllPowerComponents.md index 2a317dd317..8309b5b996 100644 --- a/content/reference/services/SoftLayer_Hardware/getAllPowerComponents.md +++ b/content/reference/services/SoftLayer_Hardware/getAllPowerComponents.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware/getAllowedHost.md b/content/reference/services/SoftLayer_Hardware/getAllowedHost.md index 3844f2d819..08a221a7c3 100644 --- a/content/reference/services/SoftLayer_Hardware/getAllowedHost.md +++ b/content/reference/services/SoftLayer_Hardware/getAllowedHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getAllowedHost + Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. diff --git a/content/reference/services/SoftLayer_Hardware/getAllowedNetworkStorage.md b/content/reference/services/SoftLayer_Hardware/getAllowedNetworkStorage.md index ed5cbd25d1..7732fd118e 100644 --- a/content/reference/services/SoftLayer_Hardware/getAllowedNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware/getAllowedNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getAllowedNetworkStorage + Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. diff --git a/content/reference/services/SoftLayer_Hardware/getAllowedNetworkStorageReplicas.md b/content/reference/services/SoftLayer_Hardware/getAllowedNetworkStorageReplicas.md index e7b7a3c47c..aef0c7ca77 100644 --- a/content/reference/services/SoftLayer_Hardware/getAllowedNetworkStorageReplicas.md +++ b/content/reference/services/SoftLayer_Hardware/getAllowedNetworkStorageReplicas.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getAllowedNetworkStorageReplicas + Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. diff --git a/content/reference/services/SoftLayer_Hardware/getAntivirusSpywareSoftwareComponent.md b/content/reference/services/SoftLayer_Hardware/getAntivirusSpywareSoftwareComponent.md index 344242a7a8..015d74f9aa 100644 --- a/content/reference/services/SoftLayer_Hardware/getAntivirusSpywareSoftwareComponent.md +++ b/content/reference/services/SoftLayer_Hardware/getAntivirusSpywareSoftwareComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getAntivirusSpywareSoftwareComponent + Retrieve information regarding an antivirus/spyware software component object. diff --git a/content/reference/services/SoftLayer_Hardware/getAttachedNetworkStorages.md b/content/reference/services/SoftLayer_Hardware/getAttachedNetworkStorages.md index 2b51807bee..d92facfa7f 100644 --- a/content/reference/services/SoftLayer_Hardware/getAttachedNetworkStorages.md +++ b/content/reference/services/SoftLayer_Hardware/getAttachedNetworkStorages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getAttachedNetworkStorages + Return a list of SoftLayer_Network_Storage volumes authorized to this device. diff --git a/content/reference/services/SoftLayer_Hardware/getAttributes.md b/content/reference/services/SoftLayer_Hardware/getAttributes.md index 3f53b0220e..c19375c5e7 100644 --- a/content/reference/services/SoftLayer_Hardware/getAttributes.md +++ b/content/reference/services/SoftLayer_Hardware/getAttributes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getAttributes + Retrieve information regarding a piece of hardware's specific attributes. diff --git a/content/reference/services/SoftLayer_Hardware/getAvailableBillingTermChangePrices.md b/content/reference/services/SoftLayer_Hardware/getAvailableBillingTermChangePrices.md index 0c03630104..c8463f0cec 100644 --- a/content/reference/services/SoftLayer_Hardware/getAvailableBillingTermChangePrices.md +++ b/content/reference/services/SoftLayer_Hardware/getAvailableBillingTermChangePrices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getAvailableBillingTermChangePrices + Retrieves a list of available term prices available to this of hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getAvailableNetworkStorages.md b/content/reference/services/SoftLayer_Hardware/getAvailableNetworkStorages.md index 6085856159..71b190e579 100644 --- a/content/reference/services/SoftLayer_Hardware/getAvailableNetworkStorages.md +++ b/content/reference/services/SoftLayer_Hardware/getAvailableNetworkStorages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getAvailableNetworkStorages + Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. diff --git a/content/reference/services/SoftLayer_Hardware/getAverageDailyPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware/getAverageDailyPublicBandwidthUsage.md index 7cab9658bb..f24d96757d 100644 --- a/content/reference/services/SoftLayer_Hardware/getAverageDailyPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware/getAverageDailyPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getAverageDailyPublicBandwidthUsage + Retrieve the average daily public bandwidth usage for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware/getBackendIncomingBandwidth.md b/content/reference/services/SoftLayer_Hardware/getBackendIncomingBandwidth.md index 3238d580bf..c395b0e8e3 100644 --- a/content/reference/services/SoftLayer_Hardware/getBackendIncomingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware/getBackendIncomingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getBackendIncomingBandwidth + Retrieve the amount of incoming private network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware/getBackendNetworkComponents.md b/content/reference/services/SoftLayer_Hardware/getBackendNetworkComponents.md index 6ee3d813af..6cc4cb9938 100644 --- a/content/reference/services/SoftLayer_Hardware/getBackendNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware/getBackendNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getBackendNetworkComponents + Retrieve a piece of hardware's back-end or private network components. diff --git a/content/reference/services/SoftLayer_Hardware/getBackendOutgoingBandwidth.md b/content/reference/services/SoftLayer_Hardware/getBackendOutgoingBandwidth.md index ed521fe4f2..0abdb40cb0 100644 --- a/content/reference/services/SoftLayer_Hardware/getBackendOutgoingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware/getBackendOutgoingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getBackendOutgoingBandwidth + Retrieve the amount of outgoing private network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware/getBackendRouters.md b/content/reference/services/SoftLayer_Hardware/getBackendRouters.md index 0bc2bfd52c..34e2d83d23 100644 --- a/content/reference/services/SoftLayer_Hardware/getBackendRouters.md +++ b/content/reference/services/SoftLayer_Hardware/getBackendRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getBackendRouters + Retrieve a hardware's backend or private router. diff --git a/content/reference/services/SoftLayer_Hardware/getBandwidthAllocation.md b/content/reference/services/SoftLayer_Hardware/getBandwidthAllocation.md index c8ee2a2460..25aeab345e 100644 --- a/content/reference/services/SoftLayer_Hardware/getBandwidthAllocation.md +++ b/content/reference/services/SoftLayer_Hardware/getBandwidthAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getBandwidthAllocation + Retrieve a hardware's allotted bandwidth (measured in GB). diff --git a/content/reference/services/SoftLayer_Hardware/getBandwidthAllotmentDetail.md b/content/reference/services/SoftLayer_Hardware/getBandwidthAllotmentDetail.md index 5fb3447ff0..7fd3b631bf 100644 --- a/content/reference/services/SoftLayer_Hardware/getBandwidthAllotmentDetail.md +++ b/content/reference/services/SoftLayer_Hardware/getBandwidthAllotmentDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getBandwidthAllotmentDetail + Retrieve a hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. diff --git a/content/reference/services/SoftLayer_Hardware/getBenchmarkCertifications.md b/content/reference/services/SoftLayer_Hardware/getBenchmarkCertifications.md index 3f6d152155..4673a6f825 100644 --- a/content/reference/services/SoftLayer_Hardware/getBenchmarkCertifications.md +++ b/content/reference/services/SoftLayer_Hardware/getBenchmarkCertifications.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getBenchmarkCertifications + Retrieve information regarding a piece of hardware's benchmark certifications. diff --git a/content/reference/services/SoftLayer_Hardware/getBillingItem.md b/content/reference/services/SoftLayer_Hardware/getBillingItem.md index 2be575777f..dba28395c4 100644 --- a/content/reference/services/SoftLayer_Hardware/getBillingItem.md +++ b/content/reference/services/SoftLayer_Hardware/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getBillingItem + Retrieve information regarding the billing item for a server. diff --git a/content/reference/services/SoftLayer_Hardware/getBillingItemFlag.md b/content/reference/services/SoftLayer_Hardware/getBillingItemFlag.md index e0f324cbe3..bd508846b1 100644 --- a/content/reference/services/SoftLayer_Hardware/getBillingItemFlag.md +++ b/content/reference/services/SoftLayer_Hardware/getBillingItemFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getBillingItemFlag + Retrieve a flag indicating that a billing item exists. diff --git a/content/reference/services/SoftLayer_Hardware/getBlockCancelBecauseDisconnectedFlag.md b/content/reference/services/SoftLayer_Hardware/getBlockCancelBecauseDisconnectedFlag.md index 44e8410de9..8021df90bc 100644 --- a/content/reference/services/SoftLayer_Hardware/getBlockCancelBecauseDisconnectedFlag.md +++ b/content/reference/services/SoftLayer_Hardware/getBlockCancelBecauseDisconnectedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getBlockCancelBecauseDisconnectedFlag + Retrieve determines whether the hardware is ineligible for cancellation because it is disconnected. diff --git a/content/reference/services/SoftLayer_Hardware/getBusinessContinuanceInsuranceFlag.md b/content/reference/services/SoftLayer_Hardware/getBusinessContinuanceInsuranceFlag.md index 2036d291b2..9859c697f3 100644 --- a/content/reference/services/SoftLayer_Hardware/getBusinessContinuanceInsuranceFlag.md +++ b/content/reference/services/SoftLayer_Hardware/getBusinessContinuanceInsuranceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getBusinessContinuanceInsuranceFlag + Retrieve status indicating whether or not a piece of hardware has business continuance insurance. diff --git a/content/reference/services/SoftLayer_Hardware/getChildrenHardware.md b/content/reference/services/SoftLayer_Hardware/getChildrenHardware.md index 4cc3e0a10d..f96095a5da 100644 --- a/content/reference/services/SoftLayer_Hardware/getChildrenHardware.md +++ b/content/reference/services/SoftLayer_Hardware/getChildrenHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getChildrenHardware + Retrieve child hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getComponentDetailsXML.md b/content/reference/services/SoftLayer_Hardware/getComponentDetailsXML.md index 09ebb96534..45944e90a9 100644 --- a/content/reference/services/SoftLayer_Hardware/getComponentDetailsXML.md +++ b/content/reference/services/SoftLayer_Hardware/getComponentDetailsXML.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware/getComponents.md b/content/reference/services/SoftLayer_Hardware/getComponents.md index acd59959ff..f7f0510472 100644 --- a/content/reference/services/SoftLayer_Hardware/getComponents.md +++ b/content/reference/services/SoftLayer_Hardware/getComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getComponents + Retrieve a piece of hardware's components. diff --git a/content/reference/services/SoftLayer_Hardware/getContinuousDataProtectionSoftwareComponent.md b/content/reference/services/SoftLayer_Hardware/getContinuousDataProtectionSoftwareComponent.md index b34f6ab565..d8c459b25f 100644 --- a/content/reference/services/SoftLayer_Hardware/getContinuousDataProtectionSoftwareComponent.md +++ b/content/reference/services/SoftLayer_Hardware/getContinuousDataProtectionSoftwareComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getContinuousDataProtectionSoftwareComponent + Retrieve a continuous data protection/server backup software component object. diff --git a/content/reference/services/SoftLayer_Hardware/getCreateObjectOptions.md b/content/reference/services/SoftLayer_Hardware/getCreateObjectOptions.md index a58b2d89c2..14a01e8394 100644 --- a/content/reference/services/SoftLayer_Hardware/getCreateObjectOptions.md +++ b/content/reference/services/SoftLayer_Hardware/getCreateObjectOptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getCreateObjectOptions + Determine options available when creating a server diff --git a/content/reference/services/SoftLayer_Hardware/getCurrentBillableBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware/getCurrentBillableBandwidthUsage.md index f55c1bd44d..bbceabceeb 100644 --- a/content/reference/services/SoftLayer_Hardware/getCurrentBillableBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware/getCurrentBillableBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getCurrentBillableBandwidthUsage + Retrieve the current billable public outbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware/getCurrentBillingDetail.md b/content/reference/services/SoftLayer_Hardware/getCurrentBillingDetail.md index f6138a0a1e..9c852c16aa 100644 --- a/content/reference/services/SoftLayer_Hardware/getCurrentBillingDetail.md +++ b/content/reference/services/SoftLayer_Hardware/getCurrentBillingDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getCurrentBillingDetail + << EOT diff --git a/content/reference/services/SoftLayer_Hardware/getCurrentBillingTotal.md b/content/reference/services/SoftLayer_Hardware/getCurrentBillingTotal.md index 3e21ccf4b0..297bb7b612 100644 --- a/content/reference/services/SoftLayer_Hardware/getCurrentBillingTotal.md +++ b/content/reference/services/SoftLayer_Hardware/getCurrentBillingTotal.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getCurrentBillingTotal + Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges. diff --git a/content/reference/services/SoftLayer_Hardware/getDailyAverage.md b/content/reference/services/SoftLayer_Hardware/getDailyAverage.md index c215b02d88..3c8d4e3d36 100644 --- a/content/reference/services/SoftLayer_Hardware/getDailyAverage.md +++ b/content/reference/services/SoftLayer_Hardware/getDailyAverage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getDailyAverage + calculate the average daily network traffic used by a server in gigabytes. diff --git a/content/reference/services/SoftLayer_Hardware/getDatacenter.md b/content/reference/services/SoftLayer_Hardware/getDatacenter.md index 765604ea22..5154b67a14 100644 --- a/content/reference/services/SoftLayer_Hardware/getDatacenter.md +++ b/content/reference/services/SoftLayer_Hardware/getDatacenter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getDatacenter + Retrieve information regarding the datacenter in which a piece of hardware resides. diff --git a/content/reference/services/SoftLayer_Hardware/getDatacenterName.md b/content/reference/services/SoftLayer_Hardware/getDatacenterName.md index 640c59d7f4..0d741ec2a9 100644 --- a/content/reference/services/SoftLayer_Hardware/getDatacenterName.md +++ b/content/reference/services/SoftLayer_Hardware/getDatacenterName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getDatacenterName + Retrieve the name of the datacenter in which a piece of hardware resides. diff --git a/content/reference/services/SoftLayer_Hardware/getDaysInSparePool.md b/content/reference/services/SoftLayer_Hardware/getDaysInSparePool.md index a201e6cfe2..4424777b6e 100644 --- a/content/reference/services/SoftLayer_Hardware/getDaysInSparePool.md +++ b/content/reference/services/SoftLayer_Hardware/getDaysInSparePool.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getDaysInSparePool + Retrieve number of day(s) a server have been in spare pool. diff --git a/content/reference/services/SoftLayer_Hardware/getDownlinkHardware.md b/content/reference/services/SoftLayer_Hardware/getDownlinkHardware.md index e8879ad422..1a8b3acedf 100644 --- a/content/reference/services/SoftLayer_Hardware/getDownlinkHardware.md +++ b/content/reference/services/SoftLayer_Hardware/getDownlinkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getDownlinkHardware + Retrieve all hardware that has uplink network connections to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getDownlinkNetworkHardware.md b/content/reference/services/SoftLayer_Hardware/getDownlinkNetworkHardware.md index 9ad9a4d7b8..cfcbc3f042 100644 --- a/content/reference/services/SoftLayer_Hardware/getDownlinkNetworkHardware.md +++ b/content/reference/services/SoftLayer_Hardware/getDownlinkNetworkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getDownlinkNetworkHardware + Retrieve all hardware that has uplink network connections to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getDownlinkServers.md b/content/reference/services/SoftLayer_Hardware/getDownlinkServers.md index 38f5912f56..203c1e82ae 100644 --- a/content/reference/services/SoftLayer_Hardware/getDownlinkServers.md +++ b/content/reference/services/SoftLayer_Hardware/getDownlinkServers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getDownlinkServers + Retrieve information regarding all servers attached to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getDownlinkVirtualGuests.md b/content/reference/services/SoftLayer_Hardware/getDownlinkVirtualGuests.md index 1e6eed58b9..e6fcb19911 100644 --- a/content/reference/services/SoftLayer_Hardware/getDownlinkVirtualGuests.md +++ b/content/reference/services/SoftLayer_Hardware/getDownlinkVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getDownlinkVirtualGuests + Retrieve information regarding all virtual guests attached to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getDownstreamHardwareBindings.md b/content/reference/services/SoftLayer_Hardware/getDownstreamHardwareBindings.md index a0fb7c8d47..f951ace0b4 100644 --- a/content/reference/services/SoftLayer_Hardware/getDownstreamHardwareBindings.md +++ b/content/reference/services/SoftLayer_Hardware/getDownstreamHardwareBindings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getDownstreamHardwareBindings + Retrieve all hardware downstream from a network device. diff --git a/content/reference/services/SoftLayer_Hardware/getDownstreamNetworkHardware.md b/content/reference/services/SoftLayer_Hardware/getDownstreamNetworkHardware.md index 758f79d90d..ec90e069cd 100644 --- a/content/reference/services/SoftLayer_Hardware/getDownstreamNetworkHardware.md +++ b/content/reference/services/SoftLayer_Hardware/getDownstreamNetworkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getDownstreamNetworkHardware + Retrieve all network hardware downstream from the selected piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getDownstreamNetworkHardwareWithIncidents.md b/content/reference/services/SoftLayer_Hardware/getDownstreamNetworkHardwareWithIncidents.md index 6804ea3c36..c434aeac3d 100644 --- a/content/reference/services/SoftLayer_Hardware/getDownstreamNetworkHardwareWithIncidents.md +++ b/content/reference/services/SoftLayer_Hardware/getDownstreamNetworkHardwareWithIncidents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getDownstreamNetworkHardwareWithIncidents + Retrieve all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getDownstreamServers.md b/content/reference/services/SoftLayer_Hardware/getDownstreamServers.md index 7e340a2649..c31a94c3cb 100644 --- a/content/reference/services/SoftLayer_Hardware/getDownstreamServers.md +++ b/content/reference/services/SoftLayer_Hardware/getDownstreamServers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getDownstreamServers + Retrieve information regarding all servers attached downstream to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getDownstreamVirtualGuests.md b/content/reference/services/SoftLayer_Hardware/getDownstreamVirtualGuests.md index 58174bfdd4..fca64e3452 100644 --- a/content/reference/services/SoftLayer_Hardware/getDownstreamVirtualGuests.md +++ b/content/reference/services/SoftLayer_Hardware/getDownstreamVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getDownstreamVirtualGuests + Retrieve information regarding all virtual guests attached to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getDriveControllers.md b/content/reference/services/SoftLayer_Hardware/getDriveControllers.md index 7393e7fbaa..bd48e8a156 100644 --- a/content/reference/services/SoftLayer_Hardware/getDriveControllers.md +++ b/content/reference/services/SoftLayer_Hardware/getDriveControllers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getDriveControllers + Retrieve the drive controllers contained within a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getEvaultNetworkStorage.md b/content/reference/services/SoftLayer_Hardware/getEvaultNetworkStorage.md index b7010b9e7d..05ad67fb4b 100644 --- a/content/reference/services/SoftLayer_Hardware/getEvaultNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware/getEvaultNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getEvaultNetworkStorage + Retrieve information regarding a piece of hardware's associated EVault network storage service account. diff --git a/content/reference/services/SoftLayer_Hardware/getFirewallServiceComponent.md b/content/reference/services/SoftLayer_Hardware/getFirewallServiceComponent.md index dba1c8cdc9..de25259102 100644 --- a/content/reference/services/SoftLayer_Hardware/getFirewallServiceComponent.md +++ b/content/reference/services/SoftLayer_Hardware/getFirewallServiceComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getFirewallServiceComponent + Retrieve information regarding a piece of hardware's firewall services. diff --git a/content/reference/services/SoftLayer_Hardware/getFixedConfigurationPreset.md b/content/reference/services/SoftLayer_Hardware/getFixedConfigurationPreset.md index 0360f97c6c..3b6b42a8bb 100644 --- a/content/reference/services/SoftLayer_Hardware/getFixedConfigurationPreset.md +++ b/content/reference/services/SoftLayer_Hardware/getFixedConfigurationPreset.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getFixedConfigurationPreset + Retrieve defines the fixed components in a fixed configuration bare metal server. diff --git a/content/reference/services/SoftLayer_Hardware/getFrontendIncomingBandwidth.md b/content/reference/services/SoftLayer_Hardware/getFrontendIncomingBandwidth.md index 4b9d082bc6..a20a862b30 100644 --- a/content/reference/services/SoftLayer_Hardware/getFrontendIncomingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware/getFrontendIncomingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getFrontendIncomingBandwidth + Retrieve the amount of incoming public network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware/getFrontendNetworkComponents.md b/content/reference/services/SoftLayer_Hardware/getFrontendNetworkComponents.md index 5956d62a9f..643be54a4f 100644 --- a/content/reference/services/SoftLayer_Hardware/getFrontendNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware/getFrontendNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getFrontendNetworkComponents + Retrieve a piece of hardware's front-end or public network components. diff --git a/content/reference/services/SoftLayer_Hardware/getFrontendOutgoingBandwidth.md b/content/reference/services/SoftLayer_Hardware/getFrontendOutgoingBandwidth.md index cfe5015563..f7d6fc705b 100644 --- a/content/reference/services/SoftLayer_Hardware/getFrontendOutgoingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware/getFrontendOutgoingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getFrontendOutgoingBandwidth + Retrieve the amount of outgoing public network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware/getFrontendRouters.md b/content/reference/services/SoftLayer_Hardware/getFrontendRouters.md index 3b23656436..712f54cac7 100644 --- a/content/reference/services/SoftLayer_Hardware/getFrontendRouters.md +++ b/content/reference/services/SoftLayer_Hardware/getFrontendRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getFrontendRouters + Retrieve a hardware's frontend or public router. diff --git a/content/reference/services/SoftLayer_Hardware/getFutureBillingItem.md b/content/reference/services/SoftLayer_Hardware/getFutureBillingItem.md index 4e21fe4c4a..1f2afec498 100644 --- a/content/reference/services/SoftLayer_Hardware/getFutureBillingItem.md +++ b/content/reference/services/SoftLayer_Hardware/getFutureBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getFutureBillingItem + Retrieve information regarding the future billing item for a server. diff --git a/content/reference/services/SoftLayer_Hardware/getGlobalIdentifier.md b/content/reference/services/SoftLayer_Hardware/getGlobalIdentifier.md index c4e22aeae4..cc9f72a86b 100644 --- a/content/reference/services/SoftLayer_Hardware/getGlobalIdentifier.md +++ b/content/reference/services/SoftLayer_Hardware/getGlobalIdentifier.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getGlobalIdentifier + Retrieve a hardware's universally unique identifier. diff --git a/content/reference/services/SoftLayer_Hardware/getHardDrives.md b/content/reference/services/SoftLayer_Hardware/getHardDrives.md index 864005d275..8dd6d12902 100644 --- a/content/reference/services/SoftLayer_Hardware/getHardDrives.md +++ b/content/reference/services/SoftLayer_Hardware/getHardDrives.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getHardDrives + Retrieve the hard drives contained within a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getHardwareChassis.md b/content/reference/services/SoftLayer_Hardware/getHardwareChassis.md index 45c78931ba..79b0b9093b 100644 --- a/content/reference/services/SoftLayer_Hardware/getHardwareChassis.md +++ b/content/reference/services/SoftLayer_Hardware/getHardwareChassis.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getHardwareChassis + Retrieve the chassis that a piece of hardware is housed in. diff --git a/content/reference/services/SoftLayer_Hardware/getHardwareFunction.md b/content/reference/services/SoftLayer_Hardware/getHardwareFunction.md index 3d11696db2..7b889631b3 100644 --- a/content/reference/services/SoftLayer_Hardware/getHardwareFunction.md +++ b/content/reference/services/SoftLayer_Hardware/getHardwareFunction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getHardwareFunction + Retrieve a hardware's function. diff --git a/content/reference/services/SoftLayer_Hardware/getHardwareFunctionDescription.md b/content/reference/services/SoftLayer_Hardware/getHardwareFunctionDescription.md index 9106f2a66d..bf2f8de95b 100644 --- a/content/reference/services/SoftLayer_Hardware/getHardwareFunctionDescription.md +++ b/content/reference/services/SoftLayer_Hardware/getHardwareFunctionDescription.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getHardwareFunctionDescription + Retrieve a hardware's function. diff --git a/content/reference/services/SoftLayer_Hardware/getHardwareStatus.md b/content/reference/services/SoftLayer_Hardware/getHardwareStatus.md index 0f9d4e3cb1..09952297a3 100644 --- a/content/reference/services/SoftLayer_Hardware/getHardwareStatus.md +++ b/content/reference/services/SoftLayer_Hardware/getHardwareStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getHardwareStatus + Retrieve a hardware's status. diff --git a/content/reference/services/SoftLayer_Hardware/getHasTrustedPlatformModuleBillingItemFlag.md b/content/reference/services/SoftLayer_Hardware/getHasTrustedPlatformModuleBillingItemFlag.md index 6653f2b83f..6c88da55df 100644 --- a/content/reference/services/SoftLayer_Hardware/getHasTrustedPlatformModuleBillingItemFlag.md +++ b/content/reference/services/SoftLayer_Hardware/getHasTrustedPlatformModuleBillingItemFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getHasTrustedPlatformModuleBillingItemFlag + Retrieve determine in hardware object has TPM enabled. diff --git a/content/reference/services/SoftLayer_Hardware/getHostIpsSoftwareComponent.md b/content/reference/services/SoftLayer_Hardware/getHostIpsSoftwareComponent.md index 2c98feb58a..3e4a5a7b96 100644 --- a/content/reference/services/SoftLayer_Hardware/getHostIpsSoftwareComponent.md +++ b/content/reference/services/SoftLayer_Hardware/getHostIpsSoftwareComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getHostIpsSoftwareComponent + Retrieve information regarding a host IPS software component object. diff --git a/content/reference/services/SoftLayer_Hardware/getHourlyBandwidth.md b/content/reference/services/SoftLayer_Hardware/getHourlyBandwidth.md index 7422db73b3..06fcefe9ab 100644 --- a/content/reference/services/SoftLayer_Hardware/getHourlyBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware/getHourlyBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getHourlyBandwidth + Retrieves bandwidth hourly over a 24-hour period for the specified hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getHourlyBillingFlag.md b/content/reference/services/SoftLayer_Hardware/getHourlyBillingFlag.md index 59b29d676a..1cc3ac8e0b 100644 --- a/content/reference/services/SoftLayer_Hardware/getHourlyBillingFlag.md +++ b/content/reference/services/SoftLayer_Hardware/getHourlyBillingFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getHourlyBillingFlag + Retrieve a server's hourly billing status. diff --git a/content/reference/services/SoftLayer_Hardware/getInboundBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware/getInboundBandwidthUsage.md index d48e22bbc0..8e6860f8ee 100644 --- a/content/reference/services/SoftLayer_Hardware/getInboundBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware/getInboundBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getInboundBandwidthUsage + Retrieve the sum of all the inbound network traffic data for the last 30 days. diff --git a/content/reference/services/SoftLayer_Hardware/getInboundPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware/getInboundPublicBandwidthUsage.md index 6b62de60c2..d5a539cf84 100644 --- a/content/reference/services/SoftLayer_Hardware/getInboundPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware/getInboundPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getInboundPublicBandwidthUsage + Retrieve the total public inbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware/getIsBillingTermChangeAvailableFlag.md b/content/reference/services/SoftLayer_Hardware/getIsBillingTermChangeAvailableFlag.md index 485fb9839d..43341bebfc 100644 --- a/content/reference/services/SoftLayer_Hardware/getIsBillingTermChangeAvailableFlag.md +++ b/content/reference/services/SoftLayer_Hardware/getIsBillingTermChangeAvailableFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getIsBillingTermChangeAvailableFlag + Retrieve whether or not this hardware object is eligible to change to term billing. diff --git a/content/reference/services/SoftLayer_Hardware/getLastTransaction.md b/content/reference/services/SoftLayer_Hardware/getLastTransaction.md index 5c64aae1c0..fcbd3c63c1 100644 --- a/content/reference/services/SoftLayer_Hardware/getLastTransaction.md +++ b/content/reference/services/SoftLayer_Hardware/getLastTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getLastTransaction + Retrieve information regarding the last transaction a server performed. diff --git a/content/reference/services/SoftLayer_Hardware/getLatestNetworkMonitorIncident.md b/content/reference/services/SoftLayer_Hardware/getLatestNetworkMonitorIncident.md index a8baf14e56..a6be88c3bc 100644 --- a/content/reference/services/SoftLayer_Hardware/getLatestNetworkMonitorIncident.md +++ b/content/reference/services/SoftLayer_Hardware/getLatestNetworkMonitorIncident.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getLatestNetworkMonitorIncident + Retrieve a piece of hardware's latest network monitoring incident. diff --git a/content/reference/services/SoftLayer_Hardware/getLocation.md b/content/reference/services/SoftLayer_Hardware/getLocation.md index 799e43f750..7c92673db8 100644 --- a/content/reference/services/SoftLayer_Hardware/getLocation.md +++ b/content/reference/services/SoftLayer_Hardware/getLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getLocation + Retrieve where a piece of hardware is located within SoftLayer's location hierarchy. diff --git a/content/reference/services/SoftLayer_Hardware/getLocationPathString.md b/content/reference/services/SoftLayer_Hardware/getLocationPathString.md index 4697af927b..5106e2a855 100644 --- a/content/reference/services/SoftLayer_Hardware/getLocationPathString.md +++ b/content/reference/services/SoftLayer_Hardware/getLocationPathString.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware/getLockboxNetworkStorage.md b/content/reference/services/SoftLayer_Hardware/getLockboxNetworkStorage.md index 4e87de1086..7cb3bad4d5 100644 --- a/content/reference/services/SoftLayer_Hardware/getLockboxNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware/getLockboxNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getLockboxNetworkStorage + Retrieve information regarding a lockbox account associated with a server. diff --git a/content/reference/services/SoftLayer_Hardware/getManagedResourceFlag.md b/content/reference/services/SoftLayer_Hardware/getManagedResourceFlag.md index 921c32c9c8..6b1d872fab 100644 --- a/content/reference/services/SoftLayer_Hardware/getManagedResourceFlag.md +++ b/content/reference/services/SoftLayer_Hardware/getManagedResourceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getManagedResourceFlag + Retrieve a flag indicating that the hardware is a managed resource. diff --git a/content/reference/services/SoftLayer_Hardware/getMemory.md b/content/reference/services/SoftLayer_Hardware/getMemory.md index 726165e4e4..d350d853f7 100644 --- a/content/reference/services/SoftLayer_Hardware/getMemory.md +++ b/content/reference/services/SoftLayer_Hardware/getMemory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getMemory + Retrieve information regarding a piece of hardware's memory. diff --git a/content/reference/services/SoftLayer_Hardware/getMemoryCapacity.md b/content/reference/services/SoftLayer_Hardware/getMemoryCapacity.md index 8c9088db7b..a0d3b76244 100644 --- a/content/reference/services/SoftLayer_Hardware/getMemoryCapacity.md +++ b/content/reference/services/SoftLayer_Hardware/getMemoryCapacity.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getMemoryCapacity + Retrieve the amount of memory a piece of hardware has, measured in gigabytes. diff --git a/content/reference/services/SoftLayer_Hardware/getMetricTrackingObject.md b/content/reference/services/SoftLayer_Hardware/getMetricTrackingObject.md index 8820710d13..d49da42287 100644 --- a/content/reference/services/SoftLayer_Hardware/getMetricTrackingObject.md +++ b/content/reference/services/SoftLayer_Hardware/getMetricTrackingObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getMetricTrackingObject + Retrieve a piece of hardware's metric tracking object. diff --git a/content/reference/services/SoftLayer_Hardware/getModules.md b/content/reference/services/SoftLayer_Hardware/getModules.md index 6a027075f0..54213f461a 100644 --- a/content/reference/services/SoftLayer_Hardware/getModules.md +++ b/content/reference/services/SoftLayer_Hardware/getModules.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware/getMonitoringRobot.md b/content/reference/services/SoftLayer_Hardware/getMonitoringRobot.md index 5c71e48a02..f5c68c04d0 100644 --- a/content/reference/services/SoftLayer_Hardware/getMonitoringRobot.md +++ b/content/reference/services/SoftLayer_Hardware/getMonitoringRobot.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware/getMonitoringServiceComponent.md b/content/reference/services/SoftLayer_Hardware/getMonitoringServiceComponent.md index d5ce07d40e..e7c04bcf17 100644 --- a/content/reference/services/SoftLayer_Hardware/getMonitoringServiceComponent.md +++ b/content/reference/services/SoftLayer_Hardware/getMonitoringServiceComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getMonitoringServiceComponent + Retrieve information regarding a piece of hardware's network monitoring services. diff --git a/content/reference/services/SoftLayer_Hardware/getMonitoringServiceEligibilityFlag.md b/content/reference/services/SoftLayer_Hardware/getMonitoringServiceEligibilityFlag.md index c0e83b0639..436d926200 100644 --- a/content/reference/services/SoftLayer_Hardware/getMonitoringServiceEligibilityFlag.md +++ b/content/reference/services/SoftLayer_Hardware/getMonitoringServiceEligibilityFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware/getMotherboard.md b/content/reference/services/SoftLayer_Hardware/getMotherboard.md index 5f39618444..13abd67940 100644 --- a/content/reference/services/SoftLayer_Hardware/getMotherboard.md +++ b/content/reference/services/SoftLayer_Hardware/getMotherboard.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getMotherboard + Retrieve information regarding a piece of hardware's motherboard. diff --git a/content/reference/services/SoftLayer_Hardware/getNetworkCards.md b/content/reference/services/SoftLayer_Hardware/getNetworkCards.md index 970f83dc2b..dad881cd53 100644 --- a/content/reference/services/SoftLayer_Hardware/getNetworkCards.md +++ b/content/reference/services/SoftLayer_Hardware/getNetworkCards.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getNetworkCards + Retrieve information regarding a piece of hardware's network cards. diff --git a/content/reference/services/SoftLayer_Hardware/getNetworkComponents.md b/content/reference/services/SoftLayer_Hardware/getNetworkComponents.md index 2739807226..98316d226a 100644 --- a/content/reference/services/SoftLayer_Hardware/getNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware/getNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getNetworkComponents + Retrieve returns a hardware's network components. diff --git a/content/reference/services/SoftLayer_Hardware/getNetworkGatewayMember.md b/content/reference/services/SoftLayer_Hardware/getNetworkGatewayMember.md index 7f41f403ed..4a0492fe9c 100644 --- a/content/reference/services/SoftLayer_Hardware/getNetworkGatewayMember.md +++ b/content/reference/services/SoftLayer_Hardware/getNetworkGatewayMember.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getNetworkGatewayMember + Retrieve the gateway member if this device is part of a network gateway. diff --git a/content/reference/services/SoftLayer_Hardware/getNetworkGatewayMemberFlag.md b/content/reference/services/SoftLayer_Hardware/getNetworkGatewayMemberFlag.md index ec3f25bd38..b7d1a65a9f 100644 --- a/content/reference/services/SoftLayer_Hardware/getNetworkGatewayMemberFlag.md +++ b/content/reference/services/SoftLayer_Hardware/getNetworkGatewayMemberFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getNetworkGatewayMemberFlag + Retrieve whether or not this device is part of a network gateway. diff --git a/content/reference/services/SoftLayer_Hardware/getNetworkManagementIpAddress.md b/content/reference/services/SoftLayer_Hardware/getNetworkManagementIpAddress.md index 6fe0e81775..7d048adcbc 100644 --- a/content/reference/services/SoftLayer_Hardware/getNetworkManagementIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware/getNetworkManagementIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getNetworkManagementIpAddress + Retrieve a piece of hardware's network management IP address. diff --git a/content/reference/services/SoftLayer_Hardware/getNetworkMonitorAttachedDownHardware.md b/content/reference/services/SoftLayer_Hardware/getNetworkMonitorAttachedDownHardware.md index 8199ef2472..56eacfe437 100644 --- a/content/reference/services/SoftLayer_Hardware/getNetworkMonitorAttachedDownHardware.md +++ b/content/reference/services/SoftLayer_Hardware/getNetworkMonitorAttachedDownHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getNetworkMonitorAttachedDownHardware + Retrieve all servers with failed monitoring that are attached downstream to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getNetworkMonitorAttachedDownVirtualGuests.md b/content/reference/services/SoftLayer_Hardware/getNetworkMonitorAttachedDownVirtualGuests.md index 75216bee81..e27836f652 100644 --- a/content/reference/services/SoftLayer_Hardware/getNetworkMonitorAttachedDownVirtualGuests.md +++ b/content/reference/services/SoftLayer_Hardware/getNetworkMonitorAttachedDownVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getNetworkMonitorAttachedDownVirtualGuests + Retrieve virtual guests that are attached downstream to a hardware that have failed monitoring diff --git a/content/reference/services/SoftLayer_Hardware/getNetworkMonitorIncidents.md b/content/reference/services/SoftLayer_Hardware/getNetworkMonitorIncidents.md index f854ef82d8..91f8223f22 100644 --- a/content/reference/services/SoftLayer_Hardware/getNetworkMonitorIncidents.md +++ b/content/reference/services/SoftLayer_Hardware/getNetworkMonitorIncidents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getNetworkMonitorIncidents + Retrieve the status of all of a piece of hardware's network monitoring incidents. diff --git a/content/reference/services/SoftLayer_Hardware/getNetworkMonitors.md b/content/reference/services/SoftLayer_Hardware/getNetworkMonitors.md index 23efa7a7ef..7f682d46ef 100644 --- a/content/reference/services/SoftLayer_Hardware/getNetworkMonitors.md +++ b/content/reference/services/SoftLayer_Hardware/getNetworkMonitors.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getNetworkMonitors + Retrieve information regarding a piece of hardware's network monitors. diff --git a/content/reference/services/SoftLayer_Hardware/getNetworkStatus.md b/content/reference/services/SoftLayer_Hardware/getNetworkStatus.md index 6309344065..3c33bbac08 100644 --- a/content/reference/services/SoftLayer_Hardware/getNetworkStatus.md +++ b/content/reference/services/SoftLayer_Hardware/getNetworkStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getNetworkStatus + Retrieve the value of a hardware's network status attribute. diff --git a/content/reference/services/SoftLayer_Hardware/getNetworkStatusAttribute.md b/content/reference/services/SoftLayer_Hardware/getNetworkStatusAttribute.md index 0e53b94486..1dde29d987 100644 --- a/content/reference/services/SoftLayer_Hardware/getNetworkStatusAttribute.md +++ b/content/reference/services/SoftLayer_Hardware/getNetworkStatusAttribute.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getNetworkStatusAttribute + Retrieve the hardware's related network status attribute. diff --git a/content/reference/services/SoftLayer_Hardware/getNetworkStorage.md b/content/reference/services/SoftLayer_Hardware/getNetworkStorage.md index 1809789837..46484c37b5 100644 --- a/content/reference/services/SoftLayer_Hardware/getNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware/getNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getNetworkStorage + Retrieve information regarding a piece of hardware's associated network storage service account. diff --git a/content/reference/services/SoftLayer_Hardware/getNetworkVlans.md b/content/reference/services/SoftLayer_Hardware/getNetworkVlans.md index 34bb52c412..b9635a4b8e 100644 --- a/content/reference/services/SoftLayer_Hardware/getNetworkVlans.md +++ b/content/reference/services/SoftLayer_Hardware/getNetworkVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getNetworkVlans + Retrieve the network virtual LANs (VLANs) associated with a piece of hardware's network components. diff --git a/content/reference/services/SoftLayer_Hardware/getNextBillingCycleBandwidthAllocation.md b/content/reference/services/SoftLayer_Hardware/getNextBillingCycleBandwidthAllocation.md index 7a46975af4..6eeeded498 100644 --- a/content/reference/services/SoftLayer_Hardware/getNextBillingCycleBandwidthAllocation.md +++ b/content/reference/services/SoftLayer_Hardware/getNextBillingCycleBandwidthAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getNextBillingCycleBandwidthAllocation + Retrieve a hardware's allotted bandwidth for the next billing cycle (measured in GB). diff --git a/content/reference/services/SoftLayer_Hardware/getNotesHistory.md b/content/reference/services/SoftLayer_Hardware/getNotesHistory.md index f07fc83876..69504bc5f3 100644 --- a/content/reference/services/SoftLayer_Hardware/getNotesHistory.md +++ b/content/reference/services/SoftLayer_Hardware/getNotesHistory.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware/getNvRamCapacity.md b/content/reference/services/SoftLayer_Hardware/getNvRamCapacity.md index 9ca10c0d77..8bf18cba02 100644 --- a/content/reference/services/SoftLayer_Hardware/getNvRamCapacity.md +++ b/content/reference/services/SoftLayer_Hardware/getNvRamCapacity.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getNvRamCapacity + Retrieve the amount of non-volatile memory a piece of hardware has, measured in gigabytes. diff --git a/content/reference/services/SoftLayer_Hardware/getNvRamComponentModels.md b/content/reference/services/SoftLayer_Hardware/getNvRamComponentModels.md index 729d161608..42ebfb22f2 100644 --- a/content/reference/services/SoftLayer_Hardware/getNvRamComponentModels.md +++ b/content/reference/services/SoftLayer_Hardware/getNvRamComponentModels.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware/getObject.md b/content/reference/services/SoftLayer_Hardware/getObject.md index 294ca82453..7fee787e7b 100644 --- a/content/reference/services/SoftLayer_Hardware/getObject.md +++ b/content/reference/services/SoftLayer_Hardware/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getObject + Retrieve a SoftLayer_Hardware record. diff --git a/content/reference/services/SoftLayer_Hardware/getOperatingSystem.md b/content/reference/services/SoftLayer_Hardware/getOperatingSystem.md index f00526149a..c71377a4af 100644 --- a/content/reference/services/SoftLayer_Hardware/getOperatingSystem.md +++ b/content/reference/services/SoftLayer_Hardware/getOperatingSystem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getOperatingSystem + Retrieve information regarding a piece of hardware's operating system. diff --git a/content/reference/services/SoftLayer_Hardware/getOperatingSystemReferenceCode.md b/content/reference/services/SoftLayer_Hardware/getOperatingSystemReferenceCode.md index 0aa0b7620a..0989f4e573 100644 --- a/content/reference/services/SoftLayer_Hardware/getOperatingSystemReferenceCode.md +++ b/content/reference/services/SoftLayer_Hardware/getOperatingSystemReferenceCode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getOperatingSystemReferenceCode + Retrieve a hardware's operating system software description. diff --git a/content/reference/services/SoftLayer_Hardware/getOutboundBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware/getOutboundBandwidthUsage.md index 5da9fa07da..cd09911377 100644 --- a/content/reference/services/SoftLayer_Hardware/getOutboundBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware/getOutboundBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getOutboundBandwidthUsage + Retrieve the sum of all the outbound network traffic data for the last 30 days. diff --git a/content/reference/services/SoftLayer_Hardware/getOutboundPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware/getOutboundPublicBandwidthUsage.md index c41edb5de5..ad5a8d15ec 100644 --- a/content/reference/services/SoftLayer_Hardware/getOutboundPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware/getOutboundPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getOutboundPublicBandwidthUsage + Retrieve the total public outbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware/getParentBay.md b/content/reference/services/SoftLayer_Hardware/getParentBay.md index b67c925d34..3b302f7838 100644 --- a/content/reference/services/SoftLayer_Hardware/getParentBay.md +++ b/content/reference/services/SoftLayer_Hardware/getParentBay.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getParentBay + Retrieve blade Bay diff --git a/content/reference/services/SoftLayer_Hardware/getParentHardware.md b/content/reference/services/SoftLayer_Hardware/getParentHardware.md index edabf24f6d..c67ba0f0ce 100644 --- a/content/reference/services/SoftLayer_Hardware/getParentHardware.md +++ b/content/reference/services/SoftLayer_Hardware/getParentHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getParentHardware + Retrieve parent Hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getPointOfPresenceLocation.md b/content/reference/services/SoftLayer_Hardware/getPointOfPresenceLocation.md index 27abba9ae5..cf999c3193 100644 --- a/content/reference/services/SoftLayer_Hardware/getPointOfPresenceLocation.md +++ b/content/reference/services/SoftLayer_Hardware/getPointOfPresenceLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getPointOfPresenceLocation + Retrieve information regarding the Point of Presence (PoP) location in which a piece of hardware resides. diff --git a/content/reference/services/SoftLayer_Hardware/getPowerComponents.md b/content/reference/services/SoftLayer_Hardware/getPowerComponents.md index 658317aa70..5fc290271c 100644 --- a/content/reference/services/SoftLayer_Hardware/getPowerComponents.md +++ b/content/reference/services/SoftLayer_Hardware/getPowerComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getPowerComponents + Retrieve the power components for a hardware object. diff --git a/content/reference/services/SoftLayer_Hardware/getPowerSupply.md b/content/reference/services/SoftLayer_Hardware/getPowerSupply.md index ef4e13325f..cd072a91a5 100644 --- a/content/reference/services/SoftLayer_Hardware/getPowerSupply.md +++ b/content/reference/services/SoftLayer_Hardware/getPowerSupply.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getPowerSupply + Retrieve information regarding a piece of hardware's power supply. diff --git a/content/reference/services/SoftLayer_Hardware/getPrimaryBackendIpAddress.md b/content/reference/services/SoftLayer_Hardware/getPrimaryBackendIpAddress.md index c729848720..6260d50e62 100644 --- a/content/reference/services/SoftLayer_Hardware/getPrimaryBackendIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware/getPrimaryBackendIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getPrimaryBackendIpAddress + Retrieve the hardware's primary private IP address. diff --git a/content/reference/services/SoftLayer_Hardware/getPrimaryBackendNetworkComponent.md b/content/reference/services/SoftLayer_Hardware/getPrimaryBackendNetworkComponent.md index f1032b4fec..bb90411ffd 100644 --- a/content/reference/services/SoftLayer_Hardware/getPrimaryBackendNetworkComponent.md +++ b/content/reference/services/SoftLayer_Hardware/getPrimaryBackendNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getPrimaryBackendNetworkComponent + Retrieve information regarding the hardware's primary back-end network component. diff --git a/content/reference/services/SoftLayer_Hardware/getPrimaryIpAddress.md b/content/reference/services/SoftLayer_Hardware/getPrimaryIpAddress.md index 65819c0f2c..8f6133c1b7 100644 --- a/content/reference/services/SoftLayer_Hardware/getPrimaryIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware/getPrimaryIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getPrimaryIpAddress + Retrieve the hardware's primary public IP address. diff --git a/content/reference/services/SoftLayer_Hardware/getPrimaryNetworkComponent.md b/content/reference/services/SoftLayer_Hardware/getPrimaryNetworkComponent.md index cfe36f666d..5bcfc7fb50 100644 --- a/content/reference/services/SoftLayer_Hardware/getPrimaryNetworkComponent.md +++ b/content/reference/services/SoftLayer_Hardware/getPrimaryNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getPrimaryNetworkComponent + Retrieve information regarding the hardware's primary public network component. diff --git a/content/reference/services/SoftLayer_Hardware/getPrivateBandwidthData.md b/content/reference/services/SoftLayer_Hardware/getPrivateBandwidthData.md index 13d4148b0f..7117e94113 100644 --- a/content/reference/services/SoftLayer_Hardware/getPrivateBandwidthData.md +++ b/content/reference/services/SoftLayer_Hardware/getPrivateBandwidthData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getPrivateBandwidthData + Retrieve a graph of a server's private network usage. diff --git a/content/reference/services/SoftLayer_Hardware/getPrivateNetworkOnlyFlag.md b/content/reference/services/SoftLayer_Hardware/getPrivateNetworkOnlyFlag.md index de5df2266b..cabc06cfd5 100644 --- a/content/reference/services/SoftLayer_Hardware/getPrivateNetworkOnlyFlag.md +++ b/content/reference/services/SoftLayer_Hardware/getPrivateNetworkOnlyFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getPrivateNetworkOnlyFlag + Retrieve whether the hardware only has access to the private network. diff --git a/content/reference/services/SoftLayer_Hardware/getProcessorCoreAmount.md b/content/reference/services/SoftLayer_Hardware/getProcessorCoreAmount.md index 3830c79851..8b86447b9c 100644 --- a/content/reference/services/SoftLayer_Hardware/getProcessorCoreAmount.md +++ b/content/reference/services/SoftLayer_Hardware/getProcessorCoreAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getProcessorCoreAmount + Retrieve the total number of processor cores, summed from all processors that are attached to a piece of hardware diff --git a/content/reference/services/SoftLayer_Hardware/getProcessorPhysicalCoreAmount.md b/content/reference/services/SoftLayer_Hardware/getProcessorPhysicalCoreAmount.md index 251baab199..6131b5b575 100644 --- a/content/reference/services/SoftLayer_Hardware/getProcessorPhysicalCoreAmount.md +++ b/content/reference/services/SoftLayer_Hardware/getProcessorPhysicalCoreAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getProcessorPhysicalCoreAmount + Retrieve the total number of physical processor cores, summed from all processors that are attached to a piece of hardware diff --git a/content/reference/services/SoftLayer_Hardware/getProcessors.md b/content/reference/services/SoftLayer_Hardware/getProcessors.md index 062bd5e519..ddb9576d9b 100644 --- a/content/reference/services/SoftLayer_Hardware/getProcessors.md +++ b/content/reference/services/SoftLayer_Hardware/getProcessors.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getProcessors + Retrieve information regarding a piece of hardware's processors. diff --git a/content/reference/services/SoftLayer_Hardware/getPublicBandwidthData.md b/content/reference/services/SoftLayer_Hardware/getPublicBandwidthData.md index e13dd41a55..d8cfaf79ee 100644 --- a/content/reference/services/SoftLayer_Hardware/getPublicBandwidthData.md +++ b/content/reference/services/SoftLayer_Hardware/getPublicBandwidthData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getPublicBandwidthData + Retrieve a graph of a server's public network usage. diff --git a/content/reference/services/SoftLayer_Hardware/getRack.md b/content/reference/services/SoftLayer_Hardware/getRack.md index 49616b3202..ce9b6e6418 100644 --- a/content/reference/services/SoftLayer_Hardware/getRack.md +++ b/content/reference/services/SoftLayer_Hardware/getRack.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware/getRaidControllers.md b/content/reference/services/SoftLayer_Hardware/getRaidControllers.md index 9bc394356e..3882c7a562 100644 --- a/content/reference/services/SoftLayer_Hardware/getRaidControllers.md +++ b/content/reference/services/SoftLayer_Hardware/getRaidControllers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getRaidControllers + Retrieve the RAID controllers contained within a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getRecentEvents.md b/content/reference/services/SoftLayer_Hardware/getRecentEvents.md index d556cedcb1..095e21fae8 100644 --- a/content/reference/services/SoftLayer_Hardware/getRecentEvents.md +++ b/content/reference/services/SoftLayer_Hardware/getRecentEvents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getRecentEvents + Retrieve recent events that impact this hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getRemoteManagementAccounts.md b/content/reference/services/SoftLayer_Hardware/getRemoteManagementAccounts.md index 776165b299..9ec5a22a93 100644 --- a/content/reference/services/SoftLayer_Hardware/getRemoteManagementAccounts.md +++ b/content/reference/services/SoftLayer_Hardware/getRemoteManagementAccounts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getRemoteManagementAccounts + Retrieve user credentials to issue commands and/or interact with the server's remote management card. diff --git a/content/reference/services/SoftLayer_Hardware/getRemoteManagementComponent.md b/content/reference/services/SoftLayer_Hardware/getRemoteManagementComponent.md index c87a637e3e..638ed5d358 100644 --- a/content/reference/services/SoftLayer_Hardware/getRemoteManagementComponent.md +++ b/content/reference/services/SoftLayer_Hardware/getRemoteManagementComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getRemoteManagementComponent + Retrieve a hardware's associated remote management component. This is normally IPMI. diff --git a/content/reference/services/SoftLayer_Hardware/getResourceConfigurations.md b/content/reference/services/SoftLayer_Hardware/getResourceConfigurations.md index f5d1d8f976..68d93b765e 100644 --- a/content/reference/services/SoftLayer_Hardware/getResourceConfigurations.md +++ b/content/reference/services/SoftLayer_Hardware/getResourceConfigurations.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware/getResourceGroupMemberReferences.md b/content/reference/services/SoftLayer_Hardware/getResourceGroupMemberReferences.md index a8fa161277..7078709d56 100644 --- a/content/reference/services/SoftLayer_Hardware/getResourceGroupMemberReferences.md +++ b/content/reference/services/SoftLayer_Hardware/getResourceGroupMemberReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware/getResourceGroupRoles.md b/content/reference/services/SoftLayer_Hardware/getResourceGroupRoles.md index de8dd10aa3..fa1c239784 100644 --- a/content/reference/services/SoftLayer_Hardware/getResourceGroupRoles.md +++ b/content/reference/services/SoftLayer_Hardware/getResourceGroupRoles.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware/getResourceGroups.md b/content/reference/services/SoftLayer_Hardware/getResourceGroups.md index f419b71fec..d4cf9a88e2 100644 --- a/content/reference/services/SoftLayer_Hardware/getResourceGroups.md +++ b/content/reference/services/SoftLayer_Hardware/getResourceGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getResourceGroups + Retrieve the resource groups in which this hardware is a member. diff --git a/content/reference/services/SoftLayer_Hardware/getRouters.md b/content/reference/services/SoftLayer_Hardware/getRouters.md index 4cf0038021..076c58d8f8 100644 --- a/content/reference/services/SoftLayer_Hardware/getRouters.md +++ b/content/reference/services/SoftLayer_Hardware/getRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getRouters + Retrieve a hardware's routers. diff --git a/content/reference/services/SoftLayer_Hardware/getScaleAssets.md b/content/reference/services/SoftLayer_Hardware/getScaleAssets.md index 912661e8dc..2242229270 100644 --- a/content/reference/services/SoftLayer_Hardware/getScaleAssets.md +++ b/content/reference/services/SoftLayer_Hardware/getScaleAssets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getScaleAssets + Retrieve collection of scale assets this hardware corresponds to. diff --git a/content/reference/services/SoftLayer_Hardware/getSecurityScanRequests.md b/content/reference/services/SoftLayer_Hardware/getSecurityScanRequests.md index 7c8366e941..514acbe57e 100644 --- a/content/reference/services/SoftLayer_Hardware/getSecurityScanRequests.md +++ b/content/reference/services/SoftLayer_Hardware/getSecurityScanRequests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getSecurityScanRequests + Retrieve information regarding a piece of hardware's vulnerability scan requests. diff --git a/content/reference/services/SoftLayer_Hardware/getSensorData.md b/content/reference/services/SoftLayer_Hardware/getSensorData.md index 9bbeadffe7..ed9c8dcc17 100644 --- a/content/reference/services/SoftLayer_Hardware/getSensorData.md +++ b/content/reference/services/SoftLayer_Hardware/getSensorData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getSensorData + Retrieve a server's hardware state via its internal sensors diff --git a/content/reference/services/SoftLayer_Hardware/getSensorDataWithGraphs.md b/content/reference/services/SoftLayer_Hardware/getSensorDataWithGraphs.md index f2d674c5d0..b608352747 100644 --- a/content/reference/services/SoftLayer_Hardware/getSensorDataWithGraphs.md +++ b/content/reference/services/SoftLayer_Hardware/getSensorDataWithGraphs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getSensorDataWithGraphs + Retrieve server's temperature and fan speed graphs as well the sensor raw data. diff --git a/content/reference/services/SoftLayer_Hardware/getServerFanSpeedGraphs.md b/content/reference/services/SoftLayer_Hardware/getServerFanSpeedGraphs.md index 2d9848354b..7d265430b5 100644 --- a/content/reference/services/SoftLayer_Hardware/getServerFanSpeedGraphs.md +++ b/content/reference/services/SoftLayer_Hardware/getServerFanSpeedGraphs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getServerFanSpeedGraphs + Retrieve a server's fan speed graphs. diff --git a/content/reference/services/SoftLayer_Hardware/getServerPowerState.md b/content/reference/services/SoftLayer_Hardware/getServerPowerState.md index 03f22c7072..6db1257c91 100644 --- a/content/reference/services/SoftLayer_Hardware/getServerPowerState.md +++ b/content/reference/services/SoftLayer_Hardware/getServerPowerState.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getServerPowerState + Retrieves a server's power state. diff --git a/content/reference/services/SoftLayer_Hardware/getServerRoom.md b/content/reference/services/SoftLayer_Hardware/getServerRoom.md index 67998c3dc3..1dfecede96 100644 --- a/content/reference/services/SoftLayer_Hardware/getServerRoom.md +++ b/content/reference/services/SoftLayer_Hardware/getServerRoom.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getServerRoom + Retrieve information regarding the server room in which the hardware is located. diff --git a/content/reference/services/SoftLayer_Hardware/getServerTemperatureGraphs.md b/content/reference/services/SoftLayer_Hardware/getServerTemperatureGraphs.md index 09eff90c14..7a58c295c4 100644 --- a/content/reference/services/SoftLayer_Hardware/getServerTemperatureGraphs.md +++ b/content/reference/services/SoftLayer_Hardware/getServerTemperatureGraphs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getServerTemperatureGraphs + Retrieve server's temperature graphs diff --git a/content/reference/services/SoftLayer_Hardware/getServiceProvider.md b/content/reference/services/SoftLayer_Hardware/getServiceProvider.md index b1d225900a..eb88f8c92d 100644 --- a/content/reference/services/SoftLayer_Hardware/getServiceProvider.md +++ b/content/reference/services/SoftLayer_Hardware/getServiceProvider.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getServiceProvider + Retrieve information regarding the piece of hardware's service provider. diff --git a/content/reference/services/SoftLayer_Hardware/getSoftwareComponents.md b/content/reference/services/SoftLayer_Hardware/getSoftwareComponents.md index 739d400880..0929fbeae7 100644 --- a/content/reference/services/SoftLayer_Hardware/getSoftwareComponents.md +++ b/content/reference/services/SoftLayer_Hardware/getSoftwareComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getSoftwareComponents + Retrieve information regarding a piece of hardware's installed software. diff --git a/content/reference/services/SoftLayer_Hardware/getSparePoolBillingItem.md b/content/reference/services/SoftLayer_Hardware/getSparePoolBillingItem.md index 975c00e05d..b17453604f 100644 --- a/content/reference/services/SoftLayer_Hardware/getSparePoolBillingItem.md +++ b/content/reference/services/SoftLayer_Hardware/getSparePoolBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getSparePoolBillingItem + Retrieve information regarding the billing item for a spare pool server. diff --git a/content/reference/services/SoftLayer_Hardware/getSshKeys.md b/content/reference/services/SoftLayer_Hardware/getSshKeys.md index 0a2069e62e..b00841924b 100644 --- a/content/reference/services/SoftLayer_Hardware/getSshKeys.md +++ b/content/reference/services/SoftLayer_Hardware/getSshKeys.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getSshKeys + Retrieve sSH keys to be installed on the server during provisioning or an OS reload. diff --git a/content/reference/services/SoftLayer_Hardware/getStorageGroups.md b/content/reference/services/SoftLayer_Hardware/getStorageGroups.md index 65d1cd72be..175dbadc9d 100644 --- a/content/reference/services/SoftLayer_Hardware/getStorageGroups.md +++ b/content/reference/services/SoftLayer_Hardware/getStorageGroups.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware/getStorageNetworkComponents.md b/content/reference/services/SoftLayer_Hardware/getStorageNetworkComponents.md index 1d5ab97d3b..f065338035 100644 --- a/content/reference/services/SoftLayer_Hardware/getStorageNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware/getStorageNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getStorageNetworkComponents + Retrieve a piece of hardware's private storage network components. [Deprecated] diff --git a/content/reference/services/SoftLayer_Hardware/getTagReferences.md b/content/reference/services/SoftLayer_Hardware/getTagReferences.md index c138fae291..2a6ae1f3fe 100644 --- a/content/reference/services/SoftLayer_Hardware/getTagReferences.md +++ b/content/reference/services/SoftLayer_Hardware/getTagReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware/getTopLevelLocation.md b/content/reference/services/SoftLayer_Hardware/getTopLevelLocation.md index 15faf558c8..2007e08609 100644 --- a/content/reference/services/SoftLayer_Hardware/getTopLevelLocation.md +++ b/content/reference/services/SoftLayer_Hardware/getTopLevelLocation.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware/getTransactionHistory.md b/content/reference/services/SoftLayer_Hardware/getTransactionHistory.md index 3d93e6c62d..d41980fe52 100644 --- a/content/reference/services/SoftLayer_Hardware/getTransactionHistory.md +++ b/content/reference/services/SoftLayer_Hardware/getTransactionHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getTransactionHistory + Get transaction history for a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getUpgradeItemPrices.md b/content/reference/services/SoftLayer_Hardware/getUpgradeItemPrices.md index 0ee68913f5..fbcf46a56d 100644 --- a/content/reference/services/SoftLayer_Hardware/getUpgradeItemPrices.md +++ b/content/reference/services/SoftLayer_Hardware/getUpgradeItemPrices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getUpgradeItemPrices + Retrieve a list of upgradable items available to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getUpgradeRequest.md b/content/reference/services/SoftLayer_Hardware/getUpgradeRequest.md index 5776ae1f06..a5e050be69 100644 --- a/content/reference/services/SoftLayer_Hardware/getUpgradeRequest.md +++ b/content/reference/services/SoftLayer_Hardware/getUpgradeRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getUpgradeRequest + Retrieve an account's associated upgrade request object, if any. diff --git a/content/reference/services/SoftLayer_Hardware/getUplinkHardware.md b/content/reference/services/SoftLayer_Hardware/getUplinkHardware.md index 2e17144084..1947d5527b 100644 --- a/content/reference/services/SoftLayer_Hardware/getUplinkHardware.md +++ b/content/reference/services/SoftLayer_Hardware/getUplinkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getUplinkHardware + Retrieve the network device connected to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getUplinkNetworkComponents.md b/content/reference/services/SoftLayer_Hardware/getUplinkNetworkComponents.md index 9468a32715..ff17a8f861 100644 --- a/content/reference/services/SoftLayer_Hardware/getUplinkNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware/getUplinkNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getUplinkNetworkComponents + Retrieve information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. diff --git a/content/reference/services/SoftLayer_Hardware/getUserData.md b/content/reference/services/SoftLayer_Hardware/getUserData.md index bb1f063965..95513c1413 100644 --- a/content/reference/services/SoftLayer_Hardware/getUserData.md +++ b/content/reference/services/SoftLayer_Hardware/getUserData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getUserData + Retrieve an array containing a single string of custom user data for a hardware order. Max size is 16 kb. diff --git a/content/reference/services/SoftLayer_Hardware/getVirtualChassis.md b/content/reference/services/SoftLayer_Hardware/getVirtualChassis.md index 90759e2e3b..70a369cc3e 100644 --- a/content/reference/services/SoftLayer_Hardware/getVirtualChassis.md +++ b/content/reference/services/SoftLayer_Hardware/getVirtualChassis.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getVirtualChassis + Retrieve information regarding the virtual chassis for a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getVirtualChassisSiblings.md b/content/reference/services/SoftLayer_Hardware/getVirtualChassisSiblings.md index 04c9e77bf8..b7bcc5a322 100644 --- a/content/reference/services/SoftLayer_Hardware/getVirtualChassisSiblings.md +++ b/content/reference/services/SoftLayer_Hardware/getVirtualChassisSiblings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getVirtualChassisSiblings + Retrieve information regarding the virtual chassis siblings for a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getVirtualHost.md b/content/reference/services/SoftLayer_Hardware/getVirtualHost.md index 5052660409..885591019d 100644 --- a/content/reference/services/SoftLayer_Hardware/getVirtualHost.md +++ b/content/reference/services/SoftLayer_Hardware/getVirtualHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getVirtualHost + Retrieve a piece of hardware's virtual host record. diff --git a/content/reference/services/SoftLayer_Hardware/getVirtualLicenses.md b/content/reference/services/SoftLayer_Hardware/getVirtualLicenses.md index c499834055..1d71bdc810 100644 --- a/content/reference/services/SoftLayer_Hardware/getVirtualLicenses.md +++ b/content/reference/services/SoftLayer_Hardware/getVirtualLicenses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getVirtualLicenses + Retrieve information regarding a piece of hardware's virtual software licenses. diff --git a/content/reference/services/SoftLayer_Hardware/getVirtualRack.md b/content/reference/services/SoftLayer_Hardware/getVirtualRack.md index 3a126ac74d..4a870b0790 100644 --- a/content/reference/services/SoftLayer_Hardware/getVirtualRack.md +++ b/content/reference/services/SoftLayer_Hardware/getVirtualRack.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getVirtualRack + Retrieve information regarding the bandwidth allotment to which a piece of hardware belongs. diff --git a/content/reference/services/SoftLayer_Hardware/getVirtualRackId.md b/content/reference/services/SoftLayer_Hardware/getVirtualRackId.md index f92a5a7634..f92b54f33d 100644 --- a/content/reference/services/SoftLayer_Hardware/getVirtualRackId.md +++ b/content/reference/services/SoftLayer_Hardware/getVirtualRackId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getVirtualRackId + Retrieve the name of the bandwidth allotment belonging to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getVirtualRackName.md b/content/reference/services/SoftLayer_Hardware/getVirtualRackName.md index c33dadd9a7..571d325286 100644 --- a/content/reference/services/SoftLayer_Hardware/getVirtualRackName.md +++ b/content/reference/services/SoftLayer_Hardware/getVirtualRackName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getVirtualRackName + Retrieve the name of the bandwidth allotment belonging to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware/getVirtualizationPlatform.md b/content/reference/services/SoftLayer_Hardware/getVirtualizationPlatform.md index ee11d610e4..36da8a2084 100644 --- a/content/reference/services/SoftLayer_Hardware/getVirtualizationPlatform.md +++ b/content/reference/services/SoftLayer_Hardware/getVirtualizationPlatform.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::getVirtualizationPlatform + Retrieve a piece of hardware's virtualization platform software. diff --git a/content/reference/services/SoftLayer_Hardware/importVirtualHost.md b/content/reference/services/SoftLayer_Hardware/importVirtualHost.md index 999dc7500b..4332f4982b 100644 --- a/content/reference/services/SoftLayer_Hardware/importVirtualHost.md +++ b/content/reference/services/SoftLayer_Hardware/importVirtualHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::importVirtualHost + attempt to import the host record for the virtualization platform running on a server diff --git a/content/reference/services/SoftLayer_Hardware/isPingable.md b/content/reference/services/SoftLayer_Hardware/isPingable.md index b072a10378..4c01e9f7c6 100644 --- a/content/reference/services/SoftLayer_Hardware/isPingable.md +++ b/content/reference/services/SoftLayer_Hardware/isPingable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::isPingable + Verifies whether or not a server is pingable. diff --git a/content/reference/services/SoftLayer_Hardware/ping.md b/content/reference/services/SoftLayer_Hardware/ping.md index ce6b9aea65..350b260c17 100644 --- a/content/reference/services/SoftLayer_Hardware/ping.md +++ b/content/reference/services/SoftLayer_Hardware/ping.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::ping + Issues ping command. diff --git a/content/reference/services/SoftLayer_Hardware/powerCycle.md b/content/reference/services/SoftLayer_Hardware/powerCycle.md index e3cac7461c..be14f9c0b9 100644 --- a/content/reference/services/SoftLayer_Hardware/powerCycle.md +++ b/content/reference/services/SoftLayer_Hardware/powerCycle.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::powerCycle + Issues power cycle to server. diff --git a/content/reference/services/SoftLayer_Hardware/powerOff.md b/content/reference/services/SoftLayer_Hardware/powerOff.md index 697bb1af70..d2d782c5c8 100644 --- a/content/reference/services/SoftLayer_Hardware/powerOff.md +++ b/content/reference/services/SoftLayer_Hardware/powerOff.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::powerOff + Power off server. diff --git a/content/reference/services/SoftLayer_Hardware/powerOn.md b/content/reference/services/SoftLayer_Hardware/powerOn.md index 30c5508363..ae51a29b41 100644 --- a/content/reference/services/SoftLayer_Hardware/powerOn.md +++ b/content/reference/services/SoftLayer_Hardware/powerOn.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::powerOn + Power on server. diff --git a/content/reference/services/SoftLayer_Hardware/rebootDefault.md b/content/reference/services/SoftLayer_Hardware/rebootDefault.md index 784a3273e7..ab4a175b25 100644 --- a/content/reference/services/SoftLayer_Hardware/rebootDefault.md +++ b/content/reference/services/SoftLayer_Hardware/rebootDefault.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::rebootDefault + Reboot the server via the default method. diff --git a/content/reference/services/SoftLayer_Hardware/rebootHard.md b/content/reference/services/SoftLayer_Hardware/rebootHard.md index c027e6bb7b..ca12365c0a 100644 --- a/content/reference/services/SoftLayer_Hardware/rebootHard.md +++ b/content/reference/services/SoftLayer_Hardware/rebootHard.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::rebootHard + Reboot the server via "hard" reboot. diff --git a/content/reference/services/SoftLayer_Hardware/rebootSoft.md b/content/reference/services/SoftLayer_Hardware/rebootSoft.md index 33f2b6f0fb..634dd36d2e 100644 --- a/content/reference/services/SoftLayer_Hardware/rebootSoft.md +++ b/content/reference/services/SoftLayer_Hardware/rebootSoft.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::rebootSoft + Execute a soft reboot to the server. diff --git a/content/reference/services/SoftLayer_Hardware/removeAccessToNetworkStorage.md b/content/reference/services/SoftLayer_Hardware/removeAccessToNetworkStorage.md index 133ceae5aa..231a74dd36 100644 --- a/content/reference/services/SoftLayer_Hardware/removeAccessToNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware/removeAccessToNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::removeAccessToNetworkStorage + Remove access to a SoftLayer_Network_Storage volume from this device. diff --git a/content/reference/services/SoftLayer_Hardware/removeAccessToNetworkStorageList.md b/content/reference/services/SoftLayer_Hardware/removeAccessToNetworkStorageList.md index c4894003a5..b7cdb6002c 100644 --- a/content/reference/services/SoftLayer_Hardware/removeAccessToNetworkStorageList.md +++ b/content/reference/services/SoftLayer_Hardware/removeAccessToNetworkStorageList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::removeAccessToNetworkStorageList + Remove access to multiple SoftLayer_Network_Storage volumes from this device. diff --git a/content/reference/services/SoftLayer_Hardware/removeTags.md b/content/reference/services/SoftLayer_Hardware/removeTags.md index 05be8cfe4a..f9ff553f67 100644 --- a/content/reference/services/SoftLayer_Hardware/removeTags.md +++ b/content/reference/services/SoftLayer_Hardware/removeTags.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::removeTags + Remove a tag reference diff --git a/content/reference/services/SoftLayer_Hardware/setTags.md b/content/reference/services/SoftLayer_Hardware/setTags.md index e0f672ecc7..821f6641f2 100644 --- a/content/reference/services/SoftLayer_Hardware/setTags.md +++ b/content/reference/services/SoftLayer_Hardware/setTags.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware/updateIpmiPassword.md b/content/reference/services/SoftLayer_Hardware/updateIpmiPassword.md index eafbe09b81..bff44753dc 100644 --- a/content/reference/services/SoftLayer_Hardware/updateIpmiPassword.md +++ b/content/reference/services/SoftLayer_Hardware/updateIpmiPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware)::updateIpmiPassword + Update the root IPMI user password diff --git a/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/_index.md b/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/_index.md index d4c2cdfef5..53583e62dd 100644 --- a/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/_index.md +++ b/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,24 +44,28 @@ This certification is used to indicate the date, time and validity of the benchm #### [getAccount](/reference/services/SoftLayer_Hardware_Benchmark_Certification/getAccount) Retrieve information regarding a benchmark certification result's associated SoftLayer customer account. +
              #### [getHardware](/reference/services/SoftLayer_Hardware_Benchmark_Certification/getHardware) Retrieve information regarding the piece of hardware on which a benchmark certification test was performed. +
              #### [getObject](/reference/services/SoftLayer_Hardware_Benchmark_Certification/getObject) Retrieve a SoftLayer_Hardware_Benchmark_Certification record. +
              #### [getResultFile](/reference/services/SoftLayer_Hardware_Benchmark_Certification/getResultFile) Retrieve the file for a benchmark certification result, if is exists. +
              diff --git a/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/getAccount.md b/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/getAccount.md index 3793f41ccc..dbb2de4b0c 100644 --- a/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/getAccount.md +++ b/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Benchmark_Certification](/reference/services/SoftLayer_Hardware_Benchmark_Certification)::getAccount + Retrieve information regarding a benchmark certification result's associated SoftLayer customer account. diff --git a/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/getHardware.md b/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/getHardware.md index ce286c8916..d2d3cea337 100644 --- a/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/getHardware.md +++ b/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Benchmark_Certification](/reference/services/SoftLayer_Hardware_Benchmark_Certification)::getHardware + Retrieve information regarding the piece of hardware on which a benchmark certification test was performed. diff --git a/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/getObject.md b/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/getObject.md index 98f1915fd1..726d889813 100644 --- a/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/getObject.md +++ b/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Benchmark_Certification](/reference/services/SoftLayer_Hardware_Benchmark_Certification)::getObject + Retrieve a SoftLayer_Hardware_Benchmark_Certification record. diff --git a/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/getResultFile.md b/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/getResultFile.md index d53210257c..ec57610447 100644 --- a/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/getResultFile.md +++ b/content/reference/services/SoftLayer_Hardware_Benchmark_Certification/getResultFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Benchmark_Certification](/reference/services/SoftLayer_Hardware_Benchmark_Certification)::getResultFile + Retrieve the file for a benchmark certification result, if is exists. diff --git a/content/reference/services/SoftLayer_Hardware_Blade/_index.md b/content/reference/services/SoftLayer_Hardware_Blade/_index.md index 8718a77b40..6b15fa7276 100644 --- a/content/reference/services/SoftLayer_Hardware_Blade/_index.md +++ b/content/reference/services/SoftLayer_Hardware_Blade/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Hardware_Blade service provides specific information about blade servers. @@ -42,18 +44,21 @@ The SoftLayer_Hardware_Blade service provides specific information about blade s #### [getHardwareChild](/reference/services/SoftLayer_Hardware_Blade/getHardwareChild) +
              #### [getHardwareParent](/reference/services/SoftLayer_Hardware_Blade/getHardwareParent) +
              #### [getObject](/reference/services/SoftLayer_Hardware_Blade/getObject) Retrieve a SoftLayer_Hardware_Blade record. +
              diff --git a/content/reference/services/SoftLayer_Hardware_Blade/getHardwareChild.md b/content/reference/services/SoftLayer_Hardware_Blade/getHardwareChild.md index 3344d329e4..b4baa7e7f4 100644 --- a/content/reference/services/SoftLayer_Hardware_Blade/getHardwareChild.md +++ b/content/reference/services/SoftLayer_Hardware_Blade/getHardwareChild.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Blade/getHardwareParent.md b/content/reference/services/SoftLayer_Hardware_Blade/getHardwareParent.md index c112d2a68c..ce72d69dfe 100644 --- a/content/reference/services/SoftLayer_Hardware_Blade/getHardwareParent.md +++ b/content/reference/services/SoftLayer_Hardware_Blade/getHardwareParent.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Blade/getObject.md b/content/reference/services/SoftLayer_Hardware_Blade/getObject.md index d6c00cb592..23a4ccf4e0 100644 --- a/content/reference/services/SoftLayer_Hardware_Blade/getObject.md +++ b/content/reference/services/SoftLayer_Hardware_Blade/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Blade](/reference/services/SoftLayer_Hardware_Blade)::getObject + Retrieve a SoftLayer_Hardware_Blade record. diff --git a/content/reference/services/SoftLayer_Hardware_Component_Locator/_index.md b/content/reference/services/SoftLayer_Hardware_Component_Locator/_index.md index 2bd7841093..e3d53fc644 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Locator/_index.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Locator/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer public API to determine the availability of generic hardware component models at data centers @@ -42,18 +44,21 @@ SoftLayer public API to determine the availability of generic hardware component #### [getGenericComponentModelAvailability](/reference/services/SoftLayer_Hardware_Component_Locator/getGenericComponentModelAvailability) An API to retrieve Generic Components Model availability at data centers +
              #### [getPackageItemsAvailability](/reference/services/SoftLayer_Hardware_Component_Locator/getPackageItemsAvailability) Retrieve availability of specified product package's GPUs and drives +
              #### [getServerPackageAvailability](/reference/services/SoftLayer_Hardware_Component_Locator/getServerPackageAvailability) An API to retrieve server package availability at data centers +
              diff --git a/content/reference/services/SoftLayer_Hardware_Component_Locator/getGenericComponentModelAvailability.md b/content/reference/services/SoftLayer_Hardware_Component_Locator/getGenericComponentModelAvailability.md index 0497fa680f..329d4ef657 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Locator/getGenericComponentModelAvailability.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Locator/getGenericComponentModelAvailability.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Locator](/reference/services/SoftLayer_Hardware_Component_Locator)::getGenericComponentModelAvailability + An API to retrieve Generic Components Model availability at data centers diff --git a/content/reference/services/SoftLayer_Hardware_Component_Locator/getPackageItemsAvailability.md b/content/reference/services/SoftLayer_Hardware_Component_Locator/getPackageItemsAvailability.md index ee23b20238..cee23b299c 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Locator/getPackageItemsAvailability.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Locator/getPackageItemsAvailability.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Locator](/reference/services/SoftLayer_Hardware_Component_Locator)::getPackageItemsAvailability + Retrieve availability of specified product package's GPUs and drives diff --git a/content/reference/services/SoftLayer_Hardware_Component_Locator/getServerPackageAvailability.md b/content/reference/services/SoftLayer_Hardware_Component_Locator/getServerPackageAvailability.md index 9caec9f0b0..51c55ab09b 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Locator/getServerPackageAvailability.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Locator/getServerPackageAvailability.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Locator](/reference/services/SoftLayer_Hardware_Component_Locator)::getServerPackageAvailability + An API to retrieve server package availability at data centers diff --git a/content/reference/services/SoftLayer_Hardware_Component_Model/_index.md b/content/reference/services/SoftLayer_Hardware_Component_Model/_index.md index 6b0b8dcf97..886ffd469a 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Model/_index.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Model/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,96 +44,112 @@ Every hardware component is associated with a model. A hardware component model #### [getArchitectureType](/reference/services/SoftLayer_Hardware_Component_Model/getArchitectureType) +
              #### [getAttributes](/reference/services/SoftLayer_Hardware_Component_Model/getAttributes) +
              #### [getCompatibleArrayTypes](/reference/services/SoftLayer_Hardware_Component_Model/getCompatibleArrayTypes) +
              #### [getCompatibleChildComponentModels](/reference/services/SoftLayer_Hardware_Component_Model/getCompatibleChildComponentModels) Retrieve all the component models that are compatible with a hardware component model. +
              #### [getCompatibleParentComponentModels](/reference/services/SoftLayer_Hardware_Component_Model/getCompatibleParentComponentModels) Retrieve all the component models that a hardware component model is compatible with. +
              #### [getFirmwareQuantity](/reference/services/SoftLayer_Hardware_Component_Model/getFirmwareQuantity) +
              #### [getFirmwares](/reference/services/SoftLayer_Hardware_Component_Model/getFirmwares) +
              #### [getHardwareComponents](/reference/services/SoftLayer_Hardware_Component_Model/getHardwareComponents) Retrieve a hardware component model's physical components in inventory. +
              #### [getHardwareGenericComponentModel](/reference/services/SoftLayer_Hardware_Component_Model/getHardwareGenericComponentModel) Retrieve the non-vendor specific generic component model for a hardware component model. +
              #### [getInfinibandCompatibleAttribute](/reference/services/SoftLayer_Hardware_Component_Model/getInfinibandCompatibleAttribute) +
              #### [getIsFlexSkuCompatible](/reference/services/SoftLayer_Hardware_Component_Model/getIsFlexSkuCompatible) +
              #### [getIsInfinibandCompatible](/reference/services/SoftLayer_Hardware_Component_Model/getIsInfinibandCompatible) +
              #### [getObject](/reference/services/SoftLayer_Hardware_Component_Model/getObject) Retrieve a SoftLayer_Hardware_Component_Model record. +
              #### [getRebootTime](/reference/services/SoftLayer_Hardware_Component_Model/getRebootTime) Retrieve a motherboard's average reboot time. +
              #### [getType](/reference/services/SoftLayer_Hardware_Component_Model/getType) Retrieve a hardware component model's type. +
              #### [getValidAttributeTypes](/reference/services/SoftLayer_Hardware_Component_Model/getValidAttributeTypes) Retrieve the types of attributes that are allowed for a given hardware component model. +
              diff --git a/content/reference/services/SoftLayer_Hardware_Component_Model/getArchitectureType.md b/content/reference/services/SoftLayer_Hardware_Component_Model/getArchitectureType.md index 23728ad2aa..4933678e5e 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Model/getArchitectureType.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Model/getArchitectureType.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Component_Model/getAttributes.md b/content/reference/services/SoftLayer_Hardware_Component_Model/getAttributes.md index 9c904a3425..9e386f1fe3 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Model/getAttributes.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Model/getAttributes.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Component_Model/getCompatibleArrayTypes.md b/content/reference/services/SoftLayer_Hardware_Component_Model/getCompatibleArrayTypes.md index 9473c146da..b11c3b6c0e 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Model/getCompatibleArrayTypes.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Model/getCompatibleArrayTypes.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Component_Model/getCompatibleChildComponentModels.md b/content/reference/services/SoftLayer_Hardware_Component_Model/getCompatibleChildComponentModels.md index 747d2c8261..9d8b9b420b 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Model/getCompatibleChildComponentModels.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Model/getCompatibleChildComponentModels.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Model](/reference/services/SoftLayer_Hardware_Component_Model)::getCompatibleChildComponentModels + Retrieve all the component models that are compatible with a hardware component model. diff --git a/content/reference/services/SoftLayer_Hardware_Component_Model/getCompatibleParentComponentModels.md b/content/reference/services/SoftLayer_Hardware_Component_Model/getCompatibleParentComponentModels.md index 189f868c55..24205d9138 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Model/getCompatibleParentComponentModels.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Model/getCompatibleParentComponentModels.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Model](/reference/services/SoftLayer_Hardware_Component_Model)::getCompatibleParentComponentModels + Retrieve all the component models that a hardware component model is compatible with. diff --git a/content/reference/services/SoftLayer_Hardware_Component_Model/getFirmwareQuantity.md b/content/reference/services/SoftLayer_Hardware_Component_Model/getFirmwareQuantity.md index 1dcabcad34..690b2859e5 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Model/getFirmwareQuantity.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Model/getFirmwareQuantity.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Component_Model/getFirmwares.md b/content/reference/services/SoftLayer_Hardware_Component_Model/getFirmwares.md index 6758efef55..9da2fd7c83 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Model/getFirmwares.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Model/getFirmwares.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Component_Model/getHardwareComponents.md b/content/reference/services/SoftLayer_Hardware_Component_Model/getHardwareComponents.md index 40dd4ee176..11075d6646 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Model/getHardwareComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Model/getHardwareComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Model](/reference/services/SoftLayer_Hardware_Component_Model)::getHardwareComponents + Retrieve a hardware component model's physical components in inventory. diff --git a/content/reference/services/SoftLayer_Hardware_Component_Model/getHardwareGenericComponentModel.md b/content/reference/services/SoftLayer_Hardware_Component_Model/getHardwareGenericComponentModel.md index 0f09d98c44..ed8e4d09eb 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Model/getHardwareGenericComponentModel.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Model/getHardwareGenericComponentModel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Model](/reference/services/SoftLayer_Hardware_Component_Model)::getHardwareGenericComponentModel + Retrieve the non-vendor specific generic component model for a hardware component model. diff --git a/content/reference/services/SoftLayer_Hardware_Component_Model/getInfinibandCompatibleAttribute.md b/content/reference/services/SoftLayer_Hardware_Component_Model/getInfinibandCompatibleAttribute.md index f2eff319c8..93401e9095 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Model/getInfinibandCompatibleAttribute.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Model/getInfinibandCompatibleAttribute.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Component_Model/getIsFlexSkuCompatible.md b/content/reference/services/SoftLayer_Hardware_Component_Model/getIsFlexSkuCompatible.md index f5b4fd7985..05bf0bda6d 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Model/getIsFlexSkuCompatible.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Model/getIsFlexSkuCompatible.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Component_Model/getIsInfinibandCompatible.md b/content/reference/services/SoftLayer_Hardware_Component_Model/getIsInfinibandCompatible.md index 4122e754d8..130de88e81 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Model/getIsInfinibandCompatible.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Model/getIsInfinibandCompatible.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Component_Model/getObject.md b/content/reference/services/SoftLayer_Hardware_Component_Model/getObject.md index fc4d8ca689..8ea20eab9f 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Model/getObject.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Model/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Model](/reference/services/SoftLayer_Hardware_Component_Model)::getObject + Retrieve a SoftLayer_Hardware_Component_Model record. diff --git a/content/reference/services/SoftLayer_Hardware_Component_Model/getRebootTime.md b/content/reference/services/SoftLayer_Hardware_Component_Model/getRebootTime.md index a6bc173f46..54faa47c01 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Model/getRebootTime.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Model/getRebootTime.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Model](/reference/services/SoftLayer_Hardware_Component_Model)::getRebootTime + Retrieve a motherboard's average reboot time. diff --git a/content/reference/services/SoftLayer_Hardware_Component_Model/getType.md b/content/reference/services/SoftLayer_Hardware_Component_Model/getType.md index d491d65a41..1289f1a9f1 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Model/getType.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Model/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Model](/reference/services/SoftLayer_Hardware_Component_Model)::getType + Retrieve a hardware component model's type. diff --git a/content/reference/services/SoftLayer_Hardware_Component_Model/getValidAttributeTypes.md b/content/reference/services/SoftLayer_Hardware_Component_Model/getValidAttributeTypes.md index c66f3fb099..a19ad5b58b 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Model/getValidAttributeTypes.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Model/getValidAttributeTypes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Model](/reference/services/SoftLayer_Hardware_Component_Model)::getValidAttributeTypes + Retrieve the types of attributes that are allowed for a given hardware component model. diff --git a/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/_index.md b/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/_index.md index e7a3eb89d1..2024a3df01 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/_index.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,24 +44,28 @@ Every SoftLayer Operating System Partition Template is defined in the '''SoftLay #### [getAllObjects](/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getAllObjects) +
              #### [getByDescription](/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getByDescription) Retrieves a list of all partition templates that match a certain description. +
              #### [getObject](/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getObject) Retrieve a SoftLayer_Hardware_Component_Partition_OperatingSystem record. +
              #### [getPartitionTemplates](/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getPartitionTemplates) Retrieve information regarding an operating system's [SoftLayer_Hardware_Component_Partition_Template]({{}}). +
              diff --git a/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getAllObjects.md b/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getAllObjects.md index af132a9edf..b32a7e7fcb 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getAllObjects.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getByDescription.md b/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getByDescription.md index 77eeaf9cf8..3856eb213d 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getByDescription.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getByDescription.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Partition_OperatingSystem](/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem)::getByDescription + Retrieves a list of all partition templates that match a certain description. diff --git a/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getObject.md b/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getObject.md index dbeb2b7517..a8bf142a36 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getObject.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Partition_OperatingSystem](/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem)::getObject + Retrieve a SoftLayer_Hardware_Component_Partition_OperatingSystem record. diff --git a/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getPartitionTemplates.md b/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getPartitionTemplates.md index b67897b139..d0ca889a28 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getPartitionTemplates.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem/getPartitionTemplates.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Partition_OperatingSystem](/reference/services/SoftLayer_Hardware_Component_Partition_OperatingSystem)::getPartitionTemplates + Retrieve information regarding an operating system's [SoftLayer_Hardware_Component_Partition_Template]({{}}). diff --git a/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/_index.md b/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/_index.md index 7bc37af300..c29d3aa2c1 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/_index.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,36 +44,42 @@ Every SoftLayer Partition Template is defined in the SoftLayer_Hardware_Componen #### [getAccount](/reference/services/SoftLayer_Hardware_Component_Partition_Template/getAccount) Retrieve a partition template's associated [SoftLayer_Account]({{}}). +
              #### [getData](/reference/services/SoftLayer_Hardware_Component_Partition_Template/getData) Retrieve an individual partition for a partition template. This is identical to 'partitionTemplatePartition' except this will sort unix partitions. +
              #### [getExpireDate](/reference/services/SoftLayer_Hardware_Component_Partition_Template/getExpireDate) +
              #### [getObject](/reference/services/SoftLayer_Hardware_Component_Partition_Template/getObject) Retrieve a SoftLayer_Hardware_Component_Partition_Template record. +
              #### [getPartitionOperatingSystem](/reference/services/SoftLayer_Hardware_Component_Partition_Template/getPartitionOperatingSystem) Retrieve a partition template's associated [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}). +
              #### [getPartitionTemplatePartition](/reference/services/SoftLayer_Hardware_Component_Partition_Template/getPartitionTemplatePartition) Retrieve an individual partition for a partition template. +
              diff --git a/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getAccount.md b/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getAccount.md index c4196d107c..ecbef59060 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getAccount.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Partition_Template](/reference/services/SoftLayer_Hardware_Component_Partition_Template)::getAccount + Retrieve a partition template's associated [SoftLayer_Account]({{}}). diff --git a/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getData.md b/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getData.md index 951b78ee10..355b2c2723 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getData.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Partition_Template](/reference/services/SoftLayer_Hardware_Component_Partition_Template)::getData + Retrieve an individual partition for a partition template. This is identical to 'partitionTemplatePartition' except this will sort unix partitions. diff --git a/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getExpireDate.md b/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getExpireDate.md index f1f55af1e6..fb48cff4b3 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getExpireDate.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getExpireDate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getObject.md b/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getObject.md index 3db6cab7a0..a803e86662 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getObject.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Partition_Template](/reference/services/SoftLayer_Hardware_Component_Partition_Template)::getObject + Retrieve a SoftLayer_Hardware_Component_Partition_Template record. diff --git a/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getPartitionOperatingSystem.md b/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getPartitionOperatingSystem.md index 7b909eb627..9005d8f648 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getPartitionOperatingSystem.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getPartitionOperatingSystem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Partition_Template](/reference/services/SoftLayer_Hardware_Component_Partition_Template)::getPartitionOperatingSystem + Retrieve a partition template's associated [SoftLayer_Hardware_Component_Partition_OperatingSystem]({{}}). diff --git a/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getPartitionTemplatePartition.md b/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getPartitionTemplatePartition.md index a825b7dc6c..5f53effed5 100644 --- a/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getPartitionTemplatePartition.md +++ b/content/reference/services/SoftLayer_Hardware_Component_Partition_Template/getPartitionTemplatePartition.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Component_Partition_Template](/reference/services/SoftLayer_Hardware_Component_Partition_Template)::getPartitionTemplatePartition + Retrieve an individual partition for a partition template. diff --git a/content/reference/services/SoftLayer_Hardware_Router/_index.md b/content/reference/services/SoftLayer_Hardware_Router/_index.md index 28d41f1827..3e75b3c34b 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/_index.md +++ b/content/reference/services/SoftLayer_Hardware_Router/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This service provides access to the device responsible for routing a particular SoftLayer Router. @@ -47,1092 +49,1274 @@ This service provides access to the device responsible for routing a particular #### [allowAccessToNetworkStorage](/reference/services/SoftLayer_Hardware_Router/allowAccessToNetworkStorage) Allow access to a SoftLayer_Network_Storage volume from this device. +
              #### [allowAccessToNetworkStorageList](/reference/services/SoftLayer_Hardware_Router/allowAccessToNetworkStorageList) Allow access to multiple SoftLayer_Network_Storage volumes from this device. +
              #### [captureImage](/reference/services/SoftLayer_Hardware_Router/captureImage) Captures an Image of the hard disk on the physical machine. +
              #### [createObject](/reference/services/SoftLayer_Hardware_Router/createObject) Create a new server +
              #### [deleteObject](/reference/services/SoftLayer_Hardware_Router/deleteObject) Delete a server +
              #### [deleteSoftwareComponentPasswords](/reference/services/SoftLayer_Hardware_Router/deleteSoftwareComponentPasswords) Delete software component passwords. +
              #### [deleteTag](/reference/services/SoftLayer_Hardware_Router/deleteTag) Delete a tag +
              #### [editSoftwareComponentPasswords](/reference/services/SoftLayer_Hardware_Router/editSoftwareComponentPasswords) Edit the properties of software component passwords. +
              #### [executeRemoteScript](/reference/services/SoftLayer_Hardware_Router/executeRemoteScript) Download and run remote script from uri on the hardware. Requires https for script to be executed after download. +
              #### [findByIpAddress](/reference/services/SoftLayer_Hardware_Router/findByIpAddress) Find hardware by its primary public or private IP (ipv4) address. +
              #### [generateOrderTemplate](/reference/services/SoftLayer_Hardware_Router/generateOrderTemplate) Obtain an order container for a given template object +
              #### [getAccount](/reference/services/SoftLayer_Hardware_Router/getAccount) Retrieve the account associated with a piece of hardware. +
              #### [getActiveComponents](/reference/services/SoftLayer_Hardware_Router/getActiveComponents) Retrieve a piece of hardware's active physical components. +
              #### [getActiveNetworkMonitorIncident](/reference/services/SoftLayer_Hardware_Router/getActiveNetworkMonitorIncident) Retrieve a piece of hardware's active network monitoring incidents. +
              #### [getAllPowerComponents](/reference/services/SoftLayer_Hardware_Router/getAllPowerComponents) +
              #### [getAllowedHost](/reference/services/SoftLayer_Hardware_Router/getAllowedHost) Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. +
              #### [getAllowedNetworkStorage](/reference/services/SoftLayer_Hardware_Router/getAllowedNetworkStorage) Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. +
              #### [getAllowedNetworkStorageReplicas](/reference/services/SoftLayer_Hardware_Router/getAllowedNetworkStorageReplicas) Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. +
              #### [getAntivirusSpywareSoftwareComponent](/reference/services/SoftLayer_Hardware_Router/getAntivirusSpywareSoftwareComponent) Retrieve information regarding an antivirus/spyware software component object. +
              #### [getAttachedNetworkStorages](/reference/services/SoftLayer_Hardware_Router/getAttachedNetworkStorages) Return a list of SoftLayer_Network_Storage volumes authorized to this device. +
              #### [getAttributes](/reference/services/SoftLayer_Hardware_Router/getAttributes) Retrieve information regarding a piece of hardware's specific attributes. +
              #### [getAvailableBillingTermChangePrices](/reference/services/SoftLayer_Hardware_Router/getAvailableBillingTermChangePrices) Retrieves a list of available term prices available to this of hardware. +
              #### [getAvailableNetworkStorages](/reference/services/SoftLayer_Hardware_Router/getAvailableNetworkStorages) Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. +
              #### [getAverageDailyPublicBandwidthUsage](/reference/services/SoftLayer_Hardware_Router/getAverageDailyPublicBandwidthUsage) Retrieve the average daily public bandwidth usage for the current billing cycle. +
              #### [getBackendIncomingBandwidth](/reference/services/SoftLayer_Hardware_Router/getBackendIncomingBandwidth) Retrieve the amount of incoming private network bandwidth used by a server over a period of time. +
              #### [getBackendNetworkComponents](/reference/services/SoftLayer_Hardware_Router/getBackendNetworkComponents) Retrieve a piece of hardware's back-end or private network components. +
              #### [getBackendOutgoingBandwidth](/reference/services/SoftLayer_Hardware_Router/getBackendOutgoingBandwidth) Retrieve the amount of outgoing private network bandwidth used by a server over a period of time. +
              #### [getBackendRouters](/reference/services/SoftLayer_Hardware_Router/getBackendRouters) Retrieve a hardware's backend or private router. +
              #### [getBandwidthAllocation](/reference/services/SoftLayer_Hardware_Router/getBandwidthAllocation) Retrieve a hardware's allotted bandwidth (measured in GB). +
              #### [getBandwidthAllotmentDetail](/reference/services/SoftLayer_Hardware_Router/getBandwidthAllotmentDetail) Retrieve a hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. +
              #### [getBenchmarkCertifications](/reference/services/SoftLayer_Hardware_Router/getBenchmarkCertifications) Retrieve information regarding a piece of hardware's benchmark certifications. +
              #### [getBillingItem](/reference/services/SoftLayer_Hardware_Router/getBillingItem) Retrieve information regarding the billing item for a server. +
              #### [getBillingItemFlag](/reference/services/SoftLayer_Hardware_Router/getBillingItemFlag) Retrieve a flag indicating that a billing item exists. +
              #### [getBlockCancelBecauseDisconnectedFlag](/reference/services/SoftLayer_Hardware_Router/getBlockCancelBecauseDisconnectedFlag) Retrieve determines whether the hardware is ineligible for cancellation because it is disconnected. +
              #### [getBoundSubnets](/reference/services/SoftLayer_Hardware_Router/getBoundSubnets) Retrieve associated subnets for a router object. +
              #### [getBusinessContinuanceInsuranceFlag](/reference/services/SoftLayer_Hardware_Router/getBusinessContinuanceInsuranceFlag) Retrieve status indicating whether or not a piece of hardware has business continuance insurance. +
              #### [getChildrenHardware](/reference/services/SoftLayer_Hardware_Router/getChildrenHardware) Retrieve child hardware. +
              #### [getComponentDetailsXML](/reference/services/SoftLayer_Hardware_Router/getComponentDetailsXML) +
              #### [getComponents](/reference/services/SoftLayer_Hardware_Router/getComponents) Retrieve a piece of hardware's components. +
              #### [getContinuousDataProtectionSoftwareComponent](/reference/services/SoftLayer_Hardware_Router/getContinuousDataProtectionSoftwareComponent) Retrieve a continuous data protection/server backup software component object. +
              #### [getCreateObjectOptions](/reference/services/SoftLayer_Hardware_Router/getCreateObjectOptions) Determine options available when creating a server +
              #### [getCurrentBillableBandwidthUsage](/reference/services/SoftLayer_Hardware_Router/getCurrentBillableBandwidthUsage) Retrieve the current billable public outbound bandwidth for this hardware for the current billing cycle. +
              #### [getCurrentBillingDetail](/reference/services/SoftLayer_Hardware_Router/getCurrentBillingDetail) << EOT +
              #### [getCurrentBillingTotal](/reference/services/SoftLayer_Hardware_Router/getCurrentBillingTotal) Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges. +
              #### [getDailyAverage](/reference/services/SoftLayer_Hardware_Router/getDailyAverage) calculate the average daily network traffic used by a server in gigabytes. +
              #### [getDatacenter](/reference/services/SoftLayer_Hardware_Router/getDatacenter) Retrieve information regarding the datacenter in which a piece of hardware resides. +
              #### [getDatacenterName](/reference/services/SoftLayer_Hardware_Router/getDatacenterName) Retrieve the name of the datacenter in which a piece of hardware resides. +
              #### [getDaysInSparePool](/reference/services/SoftLayer_Hardware_Router/getDaysInSparePool) Retrieve number of day(s) a server have been in spare pool. +
              #### [getDownlinkHardware](/reference/services/SoftLayer_Hardware_Router/getDownlinkHardware) Retrieve all hardware that has uplink network connections to a piece of hardware. +
              #### [getDownlinkNetworkHardware](/reference/services/SoftLayer_Hardware_Router/getDownlinkNetworkHardware) Retrieve all hardware that has uplink network connections to a piece of hardware. +
              #### [getDownlinkServers](/reference/services/SoftLayer_Hardware_Router/getDownlinkServers) Retrieve information regarding all servers attached to a piece of network hardware. +
              #### [getDownlinkVirtualGuests](/reference/services/SoftLayer_Hardware_Router/getDownlinkVirtualGuests) Retrieve information regarding all virtual guests attached to a piece of network hardware. +
              #### [getDownstreamHardwareBindings](/reference/services/SoftLayer_Hardware_Router/getDownstreamHardwareBindings) Retrieve all hardware downstream from a network device. +
              #### [getDownstreamNetworkHardware](/reference/services/SoftLayer_Hardware_Router/getDownstreamNetworkHardware) Retrieve all network hardware downstream from the selected piece of hardware. +
              #### [getDownstreamNetworkHardwareWithIncidents](/reference/services/SoftLayer_Hardware_Router/getDownstreamNetworkHardwareWithIncidents) Retrieve all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. +
              #### [getDownstreamServers](/reference/services/SoftLayer_Hardware_Router/getDownstreamServers) Retrieve information regarding all servers attached downstream to a piece of network hardware. +
              #### [getDownstreamVirtualGuests](/reference/services/SoftLayer_Hardware_Router/getDownstreamVirtualGuests) Retrieve information regarding all virtual guests attached to a piece of network hardware. +
              #### [getDriveControllers](/reference/services/SoftLayer_Hardware_Router/getDriveControllers) Retrieve the drive controllers contained within a piece of hardware. +
              #### [getEvaultNetworkStorage](/reference/services/SoftLayer_Hardware_Router/getEvaultNetworkStorage) Retrieve information regarding a piece of hardware's associated EVault network storage service account. +
              #### [getFirewallServiceComponent](/reference/services/SoftLayer_Hardware_Router/getFirewallServiceComponent) Retrieve information regarding a piece of hardware's firewall services. +
              #### [getFixedConfigurationPreset](/reference/services/SoftLayer_Hardware_Router/getFixedConfigurationPreset) Retrieve defines the fixed components in a fixed configuration bare metal server. +
              #### [getFrontendIncomingBandwidth](/reference/services/SoftLayer_Hardware_Router/getFrontendIncomingBandwidth) Retrieve the amount of incoming public network bandwidth used by a server over a period of time. +
              #### [getFrontendNetworkComponents](/reference/services/SoftLayer_Hardware_Router/getFrontendNetworkComponents) Retrieve a piece of hardware's front-end or public network components. +
              #### [getFrontendOutgoingBandwidth](/reference/services/SoftLayer_Hardware_Router/getFrontendOutgoingBandwidth) Retrieve the amount of outgoing public network bandwidth used by a server over a period of time. +
              #### [getFrontendRouters](/reference/services/SoftLayer_Hardware_Router/getFrontendRouters) Retrieve a hardware's frontend or public router. +
              #### [getFutureBillingItem](/reference/services/SoftLayer_Hardware_Router/getFutureBillingItem) Retrieve information regarding the future billing item for a server. +
              #### [getGlobalIdentifier](/reference/services/SoftLayer_Hardware_Router/getGlobalIdentifier) Retrieve a hardware's universally unique identifier. +
              #### [getHardDrives](/reference/services/SoftLayer_Hardware_Router/getHardDrives) Retrieve the hard drives contained within a piece of hardware. +
              #### [getHardwareChassis](/reference/services/SoftLayer_Hardware_Router/getHardwareChassis) Retrieve the chassis that a piece of hardware is housed in. +
              #### [getHardwareFunction](/reference/services/SoftLayer_Hardware_Router/getHardwareFunction) Retrieve a hardware's function. +
              #### [getHardwareFunctionDescription](/reference/services/SoftLayer_Hardware_Router/getHardwareFunctionDescription) Retrieve a hardware's function. +
              #### [getHardwareStatus](/reference/services/SoftLayer_Hardware_Router/getHardwareStatus) Retrieve a hardware's status. +
              #### [getHasTrustedPlatformModuleBillingItemFlag](/reference/services/SoftLayer_Hardware_Router/getHasTrustedPlatformModuleBillingItemFlag) Retrieve determine in hardware object has TPM enabled. +
              #### [getHostIpsSoftwareComponent](/reference/services/SoftLayer_Hardware_Router/getHostIpsSoftwareComponent) Retrieve information regarding a host IPS software component object. +
              #### [getHourlyBandwidth](/reference/services/SoftLayer_Hardware_Router/getHourlyBandwidth) Retrieves bandwidth hourly over a 24-hour period for the specified hardware. +
              #### [getHourlyBillingFlag](/reference/services/SoftLayer_Hardware_Router/getHourlyBillingFlag) Retrieve a server's hourly billing status. +
              #### [getInboundBandwidthUsage](/reference/services/SoftLayer_Hardware_Router/getInboundBandwidthUsage) Retrieve the sum of all the inbound network traffic data for the last 30 days. +
              #### [getInboundPublicBandwidthUsage](/reference/services/SoftLayer_Hardware_Router/getInboundPublicBandwidthUsage) Retrieve the total public inbound bandwidth for this hardware for the current billing cycle. +
              #### [getIsBillingTermChangeAvailableFlag](/reference/services/SoftLayer_Hardware_Router/getIsBillingTermChangeAvailableFlag) Retrieve whether or not this hardware object is eligible to change to term billing. +
              #### [getLastTransaction](/reference/services/SoftLayer_Hardware_Router/getLastTransaction) Retrieve information regarding the last transaction a server performed. +
              #### [getLatestNetworkMonitorIncident](/reference/services/SoftLayer_Hardware_Router/getLatestNetworkMonitorIncident) Retrieve a piece of hardware's latest network monitoring incident. +
              #### [getLocalDiskStorageCapabilityFlag](/reference/services/SoftLayer_Hardware_Router/getLocalDiskStorageCapabilityFlag) Retrieve a flag indicating that a VLAN on the router can be assigned to a host that has local disk functionality. +
              #### [getLocation](/reference/services/SoftLayer_Hardware_Router/getLocation) Retrieve where a piece of hardware is located within SoftLayer's location hierarchy. +
              #### [getLocationPathString](/reference/services/SoftLayer_Hardware_Router/getLocationPathString) +
              #### [getLockboxNetworkStorage](/reference/services/SoftLayer_Hardware_Router/getLockboxNetworkStorage) Retrieve information regarding a lockbox account associated with a server. +
              #### [getManagedResourceFlag](/reference/services/SoftLayer_Hardware_Router/getManagedResourceFlag) Retrieve a flag indicating that the hardware is a managed resource. +
              #### [getMemory](/reference/services/SoftLayer_Hardware_Router/getMemory) Retrieve information regarding a piece of hardware's memory. +
              #### [getMemoryCapacity](/reference/services/SoftLayer_Hardware_Router/getMemoryCapacity) Retrieve the amount of memory a piece of hardware has, measured in gigabytes. +
              #### [getMetricTrackingObject](/reference/services/SoftLayer_Hardware_Router/getMetricTrackingObject) Retrieve a piece of hardware's metric tracking object. +
              #### [getModules](/reference/services/SoftLayer_Hardware_Router/getModules) +
              #### [getMonitoringRobot](/reference/services/SoftLayer_Hardware_Router/getMonitoringRobot) +
              #### [getMonitoringServiceComponent](/reference/services/SoftLayer_Hardware_Router/getMonitoringServiceComponent) Retrieve information regarding a piece of hardware's network monitoring services. +
              #### [getMonitoringServiceEligibilityFlag](/reference/services/SoftLayer_Hardware_Router/getMonitoringServiceEligibilityFlag) +
              #### [getMotherboard](/reference/services/SoftLayer_Hardware_Router/getMotherboard) Retrieve information regarding a piece of hardware's motherboard. +
              #### [getNetworkCards](/reference/services/SoftLayer_Hardware_Router/getNetworkCards) Retrieve information regarding a piece of hardware's network cards. +
              #### [getNetworkComponents](/reference/services/SoftLayer_Hardware_Router/getNetworkComponents) Retrieve returns a hardware's network components. +
              #### [getNetworkGatewayMember](/reference/services/SoftLayer_Hardware_Router/getNetworkGatewayMember) Retrieve the gateway member if this device is part of a network gateway. +
              #### [getNetworkGatewayMemberFlag](/reference/services/SoftLayer_Hardware_Router/getNetworkGatewayMemberFlag) Retrieve whether or not this device is part of a network gateway. +
              #### [getNetworkMonitorAttachedDownHardware](/reference/services/SoftLayer_Hardware_Router/getNetworkMonitorAttachedDownHardware) Retrieve all servers with failed monitoring that are attached downstream to a piece of hardware. +
              #### [getNetworkMonitorAttachedDownVirtualGuests](/reference/services/SoftLayer_Hardware_Router/getNetworkMonitorAttachedDownVirtualGuests) Retrieve virtual guests that are attached downstream to a hardware that have failed monitoring +
              #### [getNetworkMonitorIncidents](/reference/services/SoftLayer_Hardware_Router/getNetworkMonitorIncidents) Retrieve the status of all of a piece of hardware's network monitoring incidents. +
              #### [getNetworkMonitors](/reference/services/SoftLayer_Hardware_Router/getNetworkMonitors) Retrieve information regarding a piece of hardware's network monitors. +
              #### [getNetworkStatus](/reference/services/SoftLayer_Hardware_Router/getNetworkStatus) Retrieve the value of a hardware's network status attribute. +
              #### [getNetworkStatusAttribute](/reference/services/SoftLayer_Hardware_Router/getNetworkStatusAttribute) Retrieve the hardware's related network status attribute. +
              #### [getNetworkStorage](/reference/services/SoftLayer_Hardware_Router/getNetworkStorage) Retrieve information regarding a piece of hardware's associated network storage service account. +
              #### [getNextBillingCycleBandwidthAllocation](/reference/services/SoftLayer_Hardware_Router/getNextBillingCycleBandwidthAllocation) Retrieve a hardware's allotted bandwidth for the next billing cycle (measured in GB). +
              #### [getNotesHistory](/reference/services/SoftLayer_Hardware_Router/getNotesHistory) +
              #### [getNvRamCapacity](/reference/services/SoftLayer_Hardware_Router/getNvRamCapacity) Retrieve the amount of non-volatile memory a piece of hardware has, measured in gigabytes. +
              #### [getNvRamComponentModels](/reference/services/SoftLayer_Hardware_Router/getNvRamComponentModels) +
              #### [getObject](/reference/services/SoftLayer_Hardware_Router/getObject) Retrieve a SoftLayer_Hardware_Router record. +
              #### [getOperatingSystem](/reference/services/SoftLayer_Hardware_Router/getOperatingSystem) Retrieve information regarding a piece of hardware's operating system. +
              #### [getOperatingSystemReferenceCode](/reference/services/SoftLayer_Hardware_Router/getOperatingSystemReferenceCode) Retrieve a hardware's operating system software description. +
              #### [getOutboundBandwidthUsage](/reference/services/SoftLayer_Hardware_Router/getOutboundBandwidthUsage) Retrieve the sum of all the outbound network traffic data for the last 30 days. +
              #### [getOutboundPublicBandwidthUsage](/reference/services/SoftLayer_Hardware_Router/getOutboundPublicBandwidthUsage) Retrieve the total public outbound bandwidth for this hardware for the current billing cycle. +
              #### [getParentBay](/reference/services/SoftLayer_Hardware_Router/getParentBay) Retrieve blade Bay +
              #### [getParentHardware](/reference/services/SoftLayer_Hardware_Router/getParentHardware) Retrieve parent Hardware. +
              #### [getPointOfPresenceLocation](/reference/services/SoftLayer_Hardware_Router/getPointOfPresenceLocation) Retrieve information regarding the Point of Presence (PoP) location in which a piece of hardware resides. +
              #### [getPowerComponents](/reference/services/SoftLayer_Hardware_Router/getPowerComponents) Retrieve the power components for a hardware object. +
              #### [getPowerSupply](/reference/services/SoftLayer_Hardware_Router/getPowerSupply) Retrieve information regarding a piece of hardware's power supply. +
              #### [getPrimaryBackendNetworkComponent](/reference/services/SoftLayer_Hardware_Router/getPrimaryBackendNetworkComponent) Retrieve information regarding the hardware's primary back-end network component. +
              #### [getPrimaryNetworkComponent](/reference/services/SoftLayer_Hardware_Router/getPrimaryNetworkComponent) Retrieve information regarding the hardware's primary public network component. +
              #### [getPrivateBandwidthData](/reference/services/SoftLayer_Hardware_Router/getPrivateBandwidthData) Retrieve a graph of a server's private network usage. +
              #### [getPrivateNetworkOnlyFlag](/reference/services/SoftLayer_Hardware_Router/getPrivateNetworkOnlyFlag) Retrieve whether the hardware only has access to the private network. +
              #### [getProcessorCoreAmount](/reference/services/SoftLayer_Hardware_Router/getProcessorCoreAmount) Retrieve the total number of processor cores, summed from all processors that are attached to a piece of hardware +
              #### [getProcessorPhysicalCoreAmount](/reference/services/SoftLayer_Hardware_Router/getProcessorPhysicalCoreAmount) Retrieve the total number of physical processor cores, summed from all processors that are attached to a piece of hardware +
              #### [getProcessors](/reference/services/SoftLayer_Hardware_Router/getProcessors) Retrieve information regarding a piece of hardware's processors. +
              #### [getPublicBandwidthData](/reference/services/SoftLayer_Hardware_Router/getPublicBandwidthData) Retrieve a graph of a server's public network usage. +
              #### [getRack](/reference/services/SoftLayer_Hardware_Router/getRack) +
              #### [getRaidControllers](/reference/services/SoftLayer_Hardware_Router/getRaidControllers) Retrieve the RAID controllers contained within a piece of hardware. +
              #### [getRecentEvents](/reference/services/SoftLayer_Hardware_Router/getRecentEvents) Retrieve recent events that impact this hardware. +
              #### [getRemoteManagementAccounts](/reference/services/SoftLayer_Hardware_Router/getRemoteManagementAccounts) Retrieve user credentials to issue commands and/or interact with the server's remote management card. +
              #### [getRemoteManagementComponent](/reference/services/SoftLayer_Hardware_Router/getRemoteManagementComponent) Retrieve a hardware's associated remote management component. This is normally IPMI. +
              #### [getResourceConfigurations](/reference/services/SoftLayer_Hardware_Router/getResourceConfigurations) +
              #### [getResourceGroupMemberReferences](/reference/services/SoftLayer_Hardware_Router/getResourceGroupMemberReferences) +
              #### [getResourceGroupRoles](/reference/services/SoftLayer_Hardware_Router/getResourceGroupRoles) +
              #### [getResourceGroups](/reference/services/SoftLayer_Hardware_Router/getResourceGroups) Retrieve the resource groups in which this hardware is a member. +
              #### [getRouters](/reference/services/SoftLayer_Hardware_Router/getRouters) Retrieve a hardware's routers. +
              #### [getSanStorageCapabilityFlag](/reference/services/SoftLayer_Hardware_Router/getSanStorageCapabilityFlag) Retrieve a flag indicating that a VLAN on the router can be assigned to a host that has SAN disk functionality. +
              #### [getScaleAssets](/reference/services/SoftLayer_Hardware_Router/getScaleAssets) Retrieve collection of scale assets this hardware corresponds to. +
              #### [getSecurityScanRequests](/reference/services/SoftLayer_Hardware_Router/getSecurityScanRequests) Retrieve information regarding a piece of hardware's vulnerability scan requests. +
              #### [getSensorData](/reference/services/SoftLayer_Hardware_Router/getSensorData) Retrieve a server's hardware state via its internal sensors +
              #### [getSensorDataWithGraphs](/reference/services/SoftLayer_Hardware_Router/getSensorDataWithGraphs) Retrieve server's temperature and fan speed graphs as well the sensor raw data. +
              #### [getServerFanSpeedGraphs](/reference/services/SoftLayer_Hardware_Router/getServerFanSpeedGraphs) Retrieve a server's fan speed graphs. +
              #### [getServerPowerState](/reference/services/SoftLayer_Hardware_Router/getServerPowerState) Retrieves a server's power state. +
              #### [getServerRoom](/reference/services/SoftLayer_Hardware_Router/getServerRoom) Retrieve information regarding the server room in which the hardware is located. +
              #### [getServerTemperatureGraphs](/reference/services/SoftLayer_Hardware_Router/getServerTemperatureGraphs) Retrieve server's temperature graphs +
              #### [getServiceProvider](/reference/services/SoftLayer_Hardware_Router/getServiceProvider) Retrieve information regarding the piece of hardware's service provider. +
              #### [getSoftwareComponents](/reference/services/SoftLayer_Hardware_Router/getSoftwareComponents) Retrieve information regarding a piece of hardware's installed software. +
              #### [getSparePoolBillingItem](/reference/services/SoftLayer_Hardware_Router/getSparePoolBillingItem) Retrieve information regarding the billing item for a spare pool server. +
              #### [getSshKeys](/reference/services/SoftLayer_Hardware_Router/getSshKeys) Retrieve sSH keys to be installed on the server during provisioning or an OS reload. +
              #### [getStorageGroups](/reference/services/SoftLayer_Hardware_Router/getStorageGroups) +
              #### [getStorageNetworkComponents](/reference/services/SoftLayer_Hardware_Router/getStorageNetworkComponents) Retrieve a piece of hardware's private storage network components. [Deprecated] +
              #### [getTagReferences](/reference/services/SoftLayer_Hardware_Router/getTagReferences) +
              #### [getTopLevelLocation](/reference/services/SoftLayer_Hardware_Router/getTopLevelLocation) +
              #### [getTransactionHistory](/reference/services/SoftLayer_Hardware_Router/getTransactionHistory) Get transaction history for a piece of hardware. +
              #### [getUpgradeItemPrices](/reference/services/SoftLayer_Hardware_Router/getUpgradeItemPrices) Retrieve a list of upgradable items available to a piece of hardware. +
              #### [getUpgradeRequest](/reference/services/SoftLayer_Hardware_Router/getUpgradeRequest) Retrieve an account's associated upgrade request object, if any. +
              #### [getUplinkHardware](/reference/services/SoftLayer_Hardware_Router/getUplinkHardware) Retrieve the network device connected to a piece of hardware. +
              #### [getUplinkNetworkComponents](/reference/services/SoftLayer_Hardware_Router/getUplinkNetworkComponents) Retrieve information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. +
              #### [getUserData](/reference/services/SoftLayer_Hardware_Router/getUserData) Retrieve an array containing a single string of custom user data for a hardware order. Max size is 16 kb. +
              #### [getVirtualChassis](/reference/services/SoftLayer_Hardware_Router/getVirtualChassis) Retrieve information regarding the virtual chassis for a piece of hardware. +
              #### [getVirtualChassisSiblings](/reference/services/SoftLayer_Hardware_Router/getVirtualChassisSiblings) Retrieve information regarding the virtual chassis siblings for a piece of hardware. +
              #### [getVirtualHost](/reference/services/SoftLayer_Hardware_Router/getVirtualHost) Retrieve a piece of hardware's virtual host record. +
              #### [getVirtualLicenses](/reference/services/SoftLayer_Hardware_Router/getVirtualLicenses) Retrieve information regarding a piece of hardware's virtual software licenses. +
              #### [getVirtualRack](/reference/services/SoftLayer_Hardware_Router/getVirtualRack) Retrieve information regarding the bandwidth allotment to which a piece of hardware belongs. +
              #### [getVirtualRackId](/reference/services/SoftLayer_Hardware_Router/getVirtualRackId) Retrieve the name of the bandwidth allotment belonging to a piece of hardware. +
              #### [getVirtualRackName](/reference/services/SoftLayer_Hardware_Router/getVirtualRackName) Retrieve the name of the bandwidth allotment belonging to a piece of hardware. +
              #### [getVirtualizationPlatform](/reference/services/SoftLayer_Hardware_Router/getVirtualizationPlatform) Retrieve a piece of hardware's virtualization platform software. +
              #### [importVirtualHost](/reference/services/SoftLayer_Hardware_Router/importVirtualHost) attempt to import the host record for the virtualization platform running on a server +
              #### [isPingable](/reference/services/SoftLayer_Hardware_Router/isPingable) Verifies whether or not a server is pingable. +
              #### [ping](/reference/services/SoftLayer_Hardware_Router/ping) Issues ping command. +
              #### [powerCycle](/reference/services/SoftLayer_Hardware_Router/powerCycle) Issues power cycle to server. +
              #### [powerOff](/reference/services/SoftLayer_Hardware_Router/powerOff) Power off server. +
              #### [powerOn](/reference/services/SoftLayer_Hardware_Router/powerOn) Power on server. +
              #### [rebootDefault](/reference/services/SoftLayer_Hardware_Router/rebootDefault) Reboot the server via the default method. +
              #### [rebootHard](/reference/services/SoftLayer_Hardware_Router/rebootHard) Reboot the server via "hard" reboot. +
              #### [rebootSoft](/reference/services/SoftLayer_Hardware_Router/rebootSoft) Execute a soft reboot to the server. +
              #### [removeAccessToNetworkStorage](/reference/services/SoftLayer_Hardware_Router/removeAccessToNetworkStorage) Remove access to a SoftLayer_Network_Storage volume from this device. +
              #### [removeAccessToNetworkStorageList](/reference/services/SoftLayer_Hardware_Router/removeAccessToNetworkStorageList) Remove access to multiple SoftLayer_Network_Storage volumes from this device. +
              #### [removeTags](/reference/services/SoftLayer_Hardware_Router/removeTags) Remove a tag reference +
              #### [setTags](/reference/services/SoftLayer_Hardware_Router/setTags) +
              #### [updateIpmiPassword](/reference/services/SoftLayer_Hardware_Router/updateIpmiPassword) Update the root IPMI user password +
              diff --git a/content/reference/services/SoftLayer_Hardware_Router/allowAccessToNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_Router/allowAccessToNetworkStorage.md index 2f023e424a..b71f9bb43e 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/allowAccessToNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_Router/allowAccessToNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::allowAccessToNetworkStorage + Allow access to a SoftLayer_Network_Storage volume from this device. diff --git a/content/reference/services/SoftLayer_Hardware_Router/allowAccessToNetworkStorageList.md b/content/reference/services/SoftLayer_Hardware_Router/allowAccessToNetworkStorageList.md index 617f31641c..3de0be6b03 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/allowAccessToNetworkStorageList.md +++ b/content/reference/services/SoftLayer_Hardware_Router/allowAccessToNetworkStorageList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::allowAccessToNetworkStorageList + Allow access to multiple SoftLayer_Network_Storage volumes from this device. diff --git a/content/reference/services/SoftLayer_Hardware_Router/captureImage.md b/content/reference/services/SoftLayer_Hardware_Router/captureImage.md index 6ddc171d65..29c47b1655 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/captureImage.md +++ b/content/reference/services/SoftLayer_Hardware_Router/captureImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::captureImage + Captures an Image of the hard disk on the physical machine. diff --git a/content/reference/services/SoftLayer_Hardware_Router/createObject.md b/content/reference/services/SoftLayer_Hardware_Router/createObject.md index 43f8e7d302..1e455fb1c3 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/createObject.md +++ b/content/reference/services/SoftLayer_Hardware_Router/createObject.md @@ -14,6 +14,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::createObject + Create a new server diff --git a/content/reference/services/SoftLayer_Hardware_Router/deleteObject.md b/content/reference/services/SoftLayer_Hardware_Router/deleteObject.md index 18ce6db09d..e620527e70 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/deleteObject.md +++ b/content/reference/services/SoftLayer_Hardware_Router/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::deleteObject + Delete a server diff --git a/content/reference/services/SoftLayer_Hardware_Router/deleteSoftwareComponentPasswords.md b/content/reference/services/SoftLayer_Hardware_Router/deleteSoftwareComponentPasswords.md index a0ebb43ce5..6f15c102a2 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/deleteSoftwareComponentPasswords.md +++ b/content/reference/services/SoftLayer_Hardware_Router/deleteSoftwareComponentPasswords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::deleteSoftwareComponentPasswords + Delete software component passwords. diff --git a/content/reference/services/SoftLayer_Hardware_Router/deleteTag.md b/content/reference/services/SoftLayer_Hardware_Router/deleteTag.md index 2a0ac1fe72..cea6a970aa 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/deleteTag.md +++ b/content/reference/services/SoftLayer_Hardware_Router/deleteTag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::deleteTag + Delete a tag diff --git a/content/reference/services/SoftLayer_Hardware_Router/editSoftwareComponentPasswords.md b/content/reference/services/SoftLayer_Hardware_Router/editSoftwareComponentPasswords.md index 1a6f392f09..65504cb3c5 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/editSoftwareComponentPasswords.md +++ b/content/reference/services/SoftLayer_Hardware_Router/editSoftwareComponentPasswords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::editSoftwareComponentPasswords + Edit the properties of software component passwords. diff --git a/content/reference/services/SoftLayer_Hardware_Router/executeRemoteScript.md b/content/reference/services/SoftLayer_Hardware_Router/executeRemoteScript.md index e15431d01d..d683905fa9 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/executeRemoteScript.md +++ b/content/reference/services/SoftLayer_Hardware_Router/executeRemoteScript.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::executeRemoteScript + Download and run remote script from uri on the hardware. Requires https for script to be executed after download. diff --git a/content/reference/services/SoftLayer_Hardware_Router/findByIpAddress.md b/content/reference/services/SoftLayer_Hardware_Router/findByIpAddress.md index 576fe9fdec..031ca7925a 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/findByIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_Router/findByIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::findByIpAddress + Find hardware by its primary public or private IP (ipv4) address. diff --git a/content/reference/services/SoftLayer_Hardware_Router/generateOrderTemplate.md b/content/reference/services/SoftLayer_Hardware_Router/generateOrderTemplate.md index 74e6a08838..fb2896f208 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/generateOrderTemplate.md +++ b/content/reference/services/SoftLayer_Hardware_Router/generateOrderTemplate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::generateOrderTemplate + Obtain an order container for a given template object diff --git a/content/reference/services/SoftLayer_Hardware_Router/getAccount.md b/content/reference/services/SoftLayer_Hardware_Router/getAccount.md index 740598e33f..674e718982 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getAccount.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getAccount + Retrieve the account associated with a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getActiveComponents.md b/content/reference/services/SoftLayer_Hardware_Router/getActiveComponents.md index 6439dc9520..c558d84121 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getActiveComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getActiveComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getActiveComponents + Retrieve a piece of hardware's active physical components. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getActiveNetworkMonitorIncident.md b/content/reference/services/SoftLayer_Hardware_Router/getActiveNetworkMonitorIncident.md index 40ae3a918e..45d57f027b 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getActiveNetworkMonitorIncident.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getActiveNetworkMonitorIncident.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getActiveNetworkMonitorIncident + Retrieve a piece of hardware's active network monitoring incidents. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getAllPowerComponents.md b/content/reference/services/SoftLayer_Hardware_Router/getAllPowerComponents.md index 41c738d920..c5f5d917a5 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getAllPowerComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getAllPowerComponents.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Router/getAllowedHost.md b/content/reference/services/SoftLayer_Hardware_Router/getAllowedHost.md index 4b3f49b422..0a17f6685c 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getAllowedHost.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getAllowedHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getAllowedHost + Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getAllowedNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_Router/getAllowedNetworkStorage.md index 6419341c92..81c2c64600 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getAllowedNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getAllowedNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getAllowedNetworkStorage + Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getAllowedNetworkStorageReplicas.md b/content/reference/services/SoftLayer_Hardware_Router/getAllowedNetworkStorageReplicas.md index 0211995713..c06f7a4479 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getAllowedNetworkStorageReplicas.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getAllowedNetworkStorageReplicas.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getAllowedNetworkStorageReplicas + Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getAntivirusSpywareSoftwareComponent.md b/content/reference/services/SoftLayer_Hardware_Router/getAntivirusSpywareSoftwareComponent.md index fe557e7de1..be724a7b46 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getAntivirusSpywareSoftwareComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getAntivirusSpywareSoftwareComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getAntivirusSpywareSoftwareComponent + Retrieve information regarding an antivirus/spyware software component object. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getAttachedNetworkStorages.md b/content/reference/services/SoftLayer_Hardware_Router/getAttachedNetworkStorages.md index 0408ad110a..092f72ad4c 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getAttachedNetworkStorages.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getAttachedNetworkStorages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getAttachedNetworkStorages + Return a list of SoftLayer_Network_Storage volumes authorized to this device. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getAttributes.md b/content/reference/services/SoftLayer_Hardware_Router/getAttributes.md index bb57262c65..0e13a3988e 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getAttributes.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getAttributes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getAttributes + Retrieve information regarding a piece of hardware's specific attributes. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getAvailableBillingTermChangePrices.md b/content/reference/services/SoftLayer_Hardware_Router/getAvailableBillingTermChangePrices.md index a191618e18..eb532163dc 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getAvailableBillingTermChangePrices.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getAvailableBillingTermChangePrices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getAvailableBillingTermChangePrices + Retrieves a list of available term prices available to this of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getAvailableNetworkStorages.md b/content/reference/services/SoftLayer_Hardware_Router/getAvailableNetworkStorages.md index f486d32c72..c35aa40b8d 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getAvailableNetworkStorages.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getAvailableNetworkStorages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getAvailableNetworkStorages + Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getAverageDailyPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Router/getAverageDailyPublicBandwidthUsage.md index daccaa5f9e..f02d5dcec0 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getAverageDailyPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getAverageDailyPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getAverageDailyPublicBandwidthUsage + Retrieve the average daily public bandwidth usage for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getBackendIncomingBandwidth.md b/content/reference/services/SoftLayer_Hardware_Router/getBackendIncomingBandwidth.md index 375af098f7..dc71732762 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getBackendIncomingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getBackendIncomingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getBackendIncomingBandwidth + Retrieve the amount of incoming private network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getBackendNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_Router/getBackendNetworkComponents.md index ab67eeb1cd..14cab4e2d8 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getBackendNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getBackendNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getBackendNetworkComponents + Retrieve a piece of hardware's back-end or private network components. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getBackendOutgoingBandwidth.md b/content/reference/services/SoftLayer_Hardware_Router/getBackendOutgoingBandwidth.md index 8699005731..5e703df795 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getBackendOutgoingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getBackendOutgoingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getBackendOutgoingBandwidth + Retrieve the amount of outgoing private network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getBackendRouters.md b/content/reference/services/SoftLayer_Hardware_Router/getBackendRouters.md index 31a7801515..cd64aceab4 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getBackendRouters.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getBackendRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getBackendRouters + Retrieve a hardware's backend or private router. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getBandwidthAllocation.md b/content/reference/services/SoftLayer_Hardware_Router/getBandwidthAllocation.md index c2d1f6d630..5ad6c4112b 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getBandwidthAllocation.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getBandwidthAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getBandwidthAllocation + Retrieve a hardware's allotted bandwidth (measured in GB). diff --git a/content/reference/services/SoftLayer_Hardware_Router/getBandwidthAllotmentDetail.md b/content/reference/services/SoftLayer_Hardware_Router/getBandwidthAllotmentDetail.md index 3b689a14e0..a337058e63 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getBandwidthAllotmentDetail.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getBandwidthAllotmentDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getBandwidthAllotmentDetail + Retrieve a hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getBenchmarkCertifications.md b/content/reference/services/SoftLayer_Hardware_Router/getBenchmarkCertifications.md index 8f90884c0e..119b4e8e2a 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getBenchmarkCertifications.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getBenchmarkCertifications.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getBenchmarkCertifications + Retrieve information regarding a piece of hardware's benchmark certifications. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getBillingItem.md b/content/reference/services/SoftLayer_Hardware_Router/getBillingItem.md index d309ee9cf2..3d0a529dfd 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getBillingItem.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getBillingItem + Retrieve information regarding the billing item for a server. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getBillingItemFlag.md b/content/reference/services/SoftLayer_Hardware_Router/getBillingItemFlag.md index 94585e5c49..bf120b142c 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getBillingItemFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getBillingItemFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getBillingItemFlag + Retrieve a flag indicating that a billing item exists. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getBlockCancelBecauseDisconnectedFlag.md b/content/reference/services/SoftLayer_Hardware_Router/getBlockCancelBecauseDisconnectedFlag.md index df03f522e1..6519724d5b 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getBlockCancelBecauseDisconnectedFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getBlockCancelBecauseDisconnectedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getBlockCancelBecauseDisconnectedFlag + Retrieve determines whether the hardware is ineligible for cancellation because it is disconnected. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getBoundSubnets.md b/content/reference/services/SoftLayer_Hardware_Router/getBoundSubnets.md index 716890c742..1cf2242213 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getBoundSubnets.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getBoundSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getBoundSubnets + Retrieve associated subnets for a router object. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getBusinessContinuanceInsuranceFlag.md b/content/reference/services/SoftLayer_Hardware_Router/getBusinessContinuanceInsuranceFlag.md index 317b42f598..56e095b9c4 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getBusinessContinuanceInsuranceFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getBusinessContinuanceInsuranceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getBusinessContinuanceInsuranceFlag + Retrieve status indicating whether or not a piece of hardware has business continuance insurance. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getChildrenHardware.md b/content/reference/services/SoftLayer_Hardware_Router/getChildrenHardware.md index 19f69241b7..70c0b833b3 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getChildrenHardware.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getChildrenHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getChildrenHardware + Retrieve child hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getComponentDetailsXML.md b/content/reference/services/SoftLayer_Hardware_Router/getComponentDetailsXML.md index 27d94335b0..f67e030e46 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getComponentDetailsXML.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getComponentDetailsXML.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Router/getComponents.md b/content/reference/services/SoftLayer_Hardware_Router/getComponents.md index 7c470273e9..ceaa07cb5b 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getComponents + Retrieve a piece of hardware's components. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getContinuousDataProtectionSoftwareComponent.md b/content/reference/services/SoftLayer_Hardware_Router/getContinuousDataProtectionSoftwareComponent.md index 8f819e97a3..a626e568bc 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getContinuousDataProtectionSoftwareComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getContinuousDataProtectionSoftwareComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getContinuousDataProtectionSoftwareComponent + Retrieve a continuous data protection/server backup software component object. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getCreateObjectOptions.md b/content/reference/services/SoftLayer_Hardware_Router/getCreateObjectOptions.md index f481a7d7de..a2f7fb5182 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getCreateObjectOptions.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getCreateObjectOptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getCreateObjectOptions + Determine options available when creating a server diff --git a/content/reference/services/SoftLayer_Hardware_Router/getCurrentBillableBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Router/getCurrentBillableBandwidthUsage.md index e3f0c6fdf4..9a321589d5 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getCurrentBillableBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getCurrentBillableBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getCurrentBillableBandwidthUsage + Retrieve the current billable public outbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getCurrentBillingDetail.md b/content/reference/services/SoftLayer_Hardware_Router/getCurrentBillingDetail.md index dcc067a415..cf60d38e27 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getCurrentBillingDetail.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getCurrentBillingDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getCurrentBillingDetail + << EOT diff --git a/content/reference/services/SoftLayer_Hardware_Router/getCurrentBillingTotal.md b/content/reference/services/SoftLayer_Hardware_Router/getCurrentBillingTotal.md index 7c6002511b..67315cc2af 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getCurrentBillingTotal.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getCurrentBillingTotal.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getCurrentBillingTotal + Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getDailyAverage.md b/content/reference/services/SoftLayer_Hardware_Router/getDailyAverage.md index ede585b4cc..9b7602d37c 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getDailyAverage.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getDailyAverage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getDailyAverage + calculate the average daily network traffic used by a server in gigabytes. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getDatacenter.md b/content/reference/services/SoftLayer_Hardware_Router/getDatacenter.md index a0778d4975..9048dcee81 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getDatacenter.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getDatacenter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getDatacenter + Retrieve information regarding the datacenter in which a piece of hardware resides. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getDatacenterName.md b/content/reference/services/SoftLayer_Hardware_Router/getDatacenterName.md index 704631c851..4f8e7e1f46 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getDatacenterName.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getDatacenterName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getDatacenterName + Retrieve the name of the datacenter in which a piece of hardware resides. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getDaysInSparePool.md b/content/reference/services/SoftLayer_Hardware_Router/getDaysInSparePool.md index b3403e5da3..aad9db4c26 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getDaysInSparePool.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getDaysInSparePool.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getDaysInSparePool + Retrieve number of day(s) a server have been in spare pool. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getDownlinkHardware.md b/content/reference/services/SoftLayer_Hardware_Router/getDownlinkHardware.md index 08523a44b2..faba676e57 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getDownlinkHardware.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getDownlinkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getDownlinkHardware + Retrieve all hardware that has uplink network connections to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getDownlinkNetworkHardware.md b/content/reference/services/SoftLayer_Hardware_Router/getDownlinkNetworkHardware.md index b477fc494b..2caf0eba85 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getDownlinkNetworkHardware.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getDownlinkNetworkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getDownlinkNetworkHardware + Retrieve all hardware that has uplink network connections to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getDownlinkServers.md b/content/reference/services/SoftLayer_Hardware_Router/getDownlinkServers.md index 4568b3091d..d8946ebcd3 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getDownlinkServers.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getDownlinkServers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getDownlinkServers + Retrieve information regarding all servers attached to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getDownlinkVirtualGuests.md b/content/reference/services/SoftLayer_Hardware_Router/getDownlinkVirtualGuests.md index c0336b6bf6..50fb3ccfc9 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getDownlinkVirtualGuests.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getDownlinkVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getDownlinkVirtualGuests + Retrieve information regarding all virtual guests attached to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getDownstreamHardwareBindings.md b/content/reference/services/SoftLayer_Hardware_Router/getDownstreamHardwareBindings.md index 7b26f357ba..7cfe4571d6 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getDownstreamHardwareBindings.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getDownstreamHardwareBindings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getDownstreamHardwareBindings + Retrieve all hardware downstream from a network device. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getDownstreamNetworkHardware.md b/content/reference/services/SoftLayer_Hardware_Router/getDownstreamNetworkHardware.md index fccdf03590..329a9b7a36 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getDownstreamNetworkHardware.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getDownstreamNetworkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getDownstreamNetworkHardware + Retrieve all network hardware downstream from the selected piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getDownstreamNetworkHardwareWithIncidents.md b/content/reference/services/SoftLayer_Hardware_Router/getDownstreamNetworkHardwareWithIncidents.md index 301b594736..7b3bf1374f 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getDownstreamNetworkHardwareWithIncidents.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getDownstreamNetworkHardwareWithIncidents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getDownstreamNetworkHardwareWithIncidents + Retrieve all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getDownstreamServers.md b/content/reference/services/SoftLayer_Hardware_Router/getDownstreamServers.md index f0cc658798..f10ccc84ac 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getDownstreamServers.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getDownstreamServers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getDownstreamServers + Retrieve information regarding all servers attached downstream to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getDownstreamVirtualGuests.md b/content/reference/services/SoftLayer_Hardware_Router/getDownstreamVirtualGuests.md index df49d5cb4f..2400cc1e02 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getDownstreamVirtualGuests.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getDownstreamVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getDownstreamVirtualGuests + Retrieve information regarding all virtual guests attached to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getDriveControllers.md b/content/reference/services/SoftLayer_Hardware_Router/getDriveControllers.md index 636ba7b3e2..fbb3ce5eb7 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getDriveControllers.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getDriveControllers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getDriveControllers + Retrieve the drive controllers contained within a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getEvaultNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_Router/getEvaultNetworkStorage.md index 1505a4fb2e..ddc1637d81 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getEvaultNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getEvaultNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getEvaultNetworkStorage + Retrieve information regarding a piece of hardware's associated EVault network storage service account. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getFirewallServiceComponent.md b/content/reference/services/SoftLayer_Hardware_Router/getFirewallServiceComponent.md index e1873993e5..db47711a26 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getFirewallServiceComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getFirewallServiceComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getFirewallServiceComponent + Retrieve information regarding a piece of hardware's firewall services. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getFixedConfigurationPreset.md b/content/reference/services/SoftLayer_Hardware_Router/getFixedConfigurationPreset.md index bed78bde82..87d3d48a7f 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getFixedConfigurationPreset.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getFixedConfigurationPreset.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getFixedConfigurationPreset + Retrieve defines the fixed components in a fixed configuration bare metal server. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getFrontendIncomingBandwidth.md b/content/reference/services/SoftLayer_Hardware_Router/getFrontendIncomingBandwidth.md index 1431015553..9641d179d1 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getFrontendIncomingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getFrontendIncomingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getFrontendIncomingBandwidth + Retrieve the amount of incoming public network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getFrontendNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_Router/getFrontendNetworkComponents.md index f395a6d213..116460fe6b 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getFrontendNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getFrontendNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getFrontendNetworkComponents + Retrieve a piece of hardware's front-end or public network components. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getFrontendOutgoingBandwidth.md b/content/reference/services/SoftLayer_Hardware_Router/getFrontendOutgoingBandwidth.md index 994c2a8748..a4109a6a0e 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getFrontendOutgoingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getFrontendOutgoingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getFrontendOutgoingBandwidth + Retrieve the amount of outgoing public network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getFrontendRouters.md b/content/reference/services/SoftLayer_Hardware_Router/getFrontendRouters.md index d442ecd911..22153fcd8d 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getFrontendRouters.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getFrontendRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getFrontendRouters + Retrieve a hardware's frontend or public router. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getFutureBillingItem.md b/content/reference/services/SoftLayer_Hardware_Router/getFutureBillingItem.md index 97ba71c178..7a5ec8913a 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getFutureBillingItem.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getFutureBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getFutureBillingItem + Retrieve information regarding the future billing item for a server. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getGlobalIdentifier.md b/content/reference/services/SoftLayer_Hardware_Router/getGlobalIdentifier.md index 01a3a7e640..353d6cefd7 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getGlobalIdentifier.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getGlobalIdentifier.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getGlobalIdentifier + Retrieve a hardware's universally unique identifier. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getHardDrives.md b/content/reference/services/SoftLayer_Hardware_Router/getHardDrives.md index 7f4e872215..9394a716df 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getHardDrives.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getHardDrives.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getHardDrives + Retrieve the hard drives contained within a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getHardwareChassis.md b/content/reference/services/SoftLayer_Hardware_Router/getHardwareChassis.md index 805c330545..aa25044924 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getHardwareChassis.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getHardwareChassis.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getHardwareChassis + Retrieve the chassis that a piece of hardware is housed in. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getHardwareFunction.md b/content/reference/services/SoftLayer_Hardware_Router/getHardwareFunction.md index 5bb99cd5f9..9c8a154c88 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getHardwareFunction.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getHardwareFunction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getHardwareFunction + Retrieve a hardware's function. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getHardwareFunctionDescription.md b/content/reference/services/SoftLayer_Hardware_Router/getHardwareFunctionDescription.md index 80f46afff3..3a2c0b6942 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getHardwareFunctionDescription.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getHardwareFunctionDescription.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getHardwareFunctionDescription + Retrieve a hardware's function. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getHardwareStatus.md b/content/reference/services/SoftLayer_Hardware_Router/getHardwareStatus.md index 795220cc31..09b1d3fa70 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getHardwareStatus.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getHardwareStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getHardwareStatus + Retrieve a hardware's status. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getHasTrustedPlatformModuleBillingItemFlag.md b/content/reference/services/SoftLayer_Hardware_Router/getHasTrustedPlatformModuleBillingItemFlag.md index 8380a3ef0b..34a0325450 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getHasTrustedPlatformModuleBillingItemFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getHasTrustedPlatformModuleBillingItemFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getHasTrustedPlatformModuleBillingItemFlag + Retrieve determine in hardware object has TPM enabled. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getHostIpsSoftwareComponent.md b/content/reference/services/SoftLayer_Hardware_Router/getHostIpsSoftwareComponent.md index 941c671ca5..979ac6bd0c 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getHostIpsSoftwareComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getHostIpsSoftwareComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getHostIpsSoftwareComponent + Retrieve information regarding a host IPS software component object. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getHourlyBandwidth.md b/content/reference/services/SoftLayer_Hardware_Router/getHourlyBandwidth.md index 0635311c51..8d71c5c829 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getHourlyBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getHourlyBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getHourlyBandwidth + Retrieves bandwidth hourly over a 24-hour period for the specified hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getHourlyBillingFlag.md b/content/reference/services/SoftLayer_Hardware_Router/getHourlyBillingFlag.md index 3360f5684c..d747c7e73d 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getHourlyBillingFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getHourlyBillingFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getHourlyBillingFlag + Retrieve a server's hourly billing status. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getInboundBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Router/getInboundBandwidthUsage.md index dcc1543619..dcff9508f4 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getInboundBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getInboundBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getInboundBandwidthUsage + Retrieve the sum of all the inbound network traffic data for the last 30 days. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getInboundPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Router/getInboundPublicBandwidthUsage.md index f5eb0ce10d..3b14919e02 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getInboundPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getInboundPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getInboundPublicBandwidthUsage + Retrieve the total public inbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getIsBillingTermChangeAvailableFlag.md b/content/reference/services/SoftLayer_Hardware_Router/getIsBillingTermChangeAvailableFlag.md index c6fe747445..5691689b2e 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getIsBillingTermChangeAvailableFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getIsBillingTermChangeAvailableFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getIsBillingTermChangeAvailableFlag + Retrieve whether or not this hardware object is eligible to change to term billing. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getLastTransaction.md b/content/reference/services/SoftLayer_Hardware_Router/getLastTransaction.md index bddc7a2a88..1fe97e1790 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getLastTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getLastTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getLastTransaction + Retrieve information regarding the last transaction a server performed. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getLatestNetworkMonitorIncident.md b/content/reference/services/SoftLayer_Hardware_Router/getLatestNetworkMonitorIncident.md index 049800dc21..e0b266a740 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getLatestNetworkMonitorIncident.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getLatestNetworkMonitorIncident.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getLatestNetworkMonitorIncident + Retrieve a piece of hardware's latest network monitoring incident. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getLocalDiskStorageCapabilityFlag.md b/content/reference/services/SoftLayer_Hardware_Router/getLocalDiskStorageCapabilityFlag.md index ffd0d5f826..64e845adf9 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getLocalDiskStorageCapabilityFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getLocalDiskStorageCapabilityFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getLocalDiskStorageCapabilityFlag + Retrieve a flag indicating that a VLAN on the router can be assigned to a host that has local disk functionality. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getLocation.md b/content/reference/services/SoftLayer_Hardware_Router/getLocation.md index 798dd747c7..8e7a81cd51 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getLocation.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getLocation + Retrieve where a piece of hardware is located within SoftLayer's location hierarchy. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getLocationPathString.md b/content/reference/services/SoftLayer_Hardware_Router/getLocationPathString.md index c40c0da702..575e2d9479 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getLocationPathString.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getLocationPathString.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Router/getLockboxNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_Router/getLockboxNetworkStorage.md index 4d2fa56608..5cb0a76038 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getLockboxNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getLockboxNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getLockboxNetworkStorage + Retrieve information regarding a lockbox account associated with a server. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getManagedResourceFlag.md b/content/reference/services/SoftLayer_Hardware_Router/getManagedResourceFlag.md index 320ac7be30..8bebf93260 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getManagedResourceFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getManagedResourceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getManagedResourceFlag + Retrieve a flag indicating that the hardware is a managed resource. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getMemory.md b/content/reference/services/SoftLayer_Hardware_Router/getMemory.md index 0d945699f9..463406229a 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getMemory.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getMemory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getMemory + Retrieve information regarding a piece of hardware's memory. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getMemoryCapacity.md b/content/reference/services/SoftLayer_Hardware_Router/getMemoryCapacity.md index 519d0a436a..19a50de8b1 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getMemoryCapacity.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getMemoryCapacity.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getMemoryCapacity + Retrieve the amount of memory a piece of hardware has, measured in gigabytes. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getMetricTrackingObject.md b/content/reference/services/SoftLayer_Hardware_Router/getMetricTrackingObject.md index c5614b652e..07e3be4d8a 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getMetricTrackingObject.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getMetricTrackingObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getMetricTrackingObject + Retrieve a piece of hardware's metric tracking object. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getModules.md b/content/reference/services/SoftLayer_Hardware_Router/getModules.md index 827e5357bd..2d15354484 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getModules.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getModules.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Router/getMonitoringRobot.md b/content/reference/services/SoftLayer_Hardware_Router/getMonitoringRobot.md index 6d1102f441..e042c1a8f2 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getMonitoringRobot.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getMonitoringRobot.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Router/getMonitoringServiceComponent.md b/content/reference/services/SoftLayer_Hardware_Router/getMonitoringServiceComponent.md index beb2940850..95cbed2bab 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getMonitoringServiceComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getMonitoringServiceComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getMonitoringServiceComponent + Retrieve information regarding a piece of hardware's network monitoring services. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getMonitoringServiceEligibilityFlag.md b/content/reference/services/SoftLayer_Hardware_Router/getMonitoringServiceEligibilityFlag.md index 4b27916e94..be3492b1aa 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getMonitoringServiceEligibilityFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getMonitoringServiceEligibilityFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Router/getMotherboard.md b/content/reference/services/SoftLayer_Hardware_Router/getMotherboard.md index 9a49570e45..5b2df11c56 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getMotherboard.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getMotherboard.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getMotherboard + Retrieve information regarding a piece of hardware's motherboard. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getNetworkCards.md b/content/reference/services/SoftLayer_Hardware_Router/getNetworkCards.md index 9dfe89bddc..de4a24f615 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getNetworkCards.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getNetworkCards.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getNetworkCards + Retrieve information regarding a piece of hardware's network cards. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_Router/getNetworkComponents.md index 53314805a0..e0de00f2bc 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getNetworkComponents + Retrieve returns a hardware's network components. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getNetworkGatewayMember.md b/content/reference/services/SoftLayer_Hardware_Router/getNetworkGatewayMember.md index 859978a2c0..70744d8cd7 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getNetworkGatewayMember.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getNetworkGatewayMember.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getNetworkGatewayMember + Retrieve the gateway member if this device is part of a network gateway. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getNetworkGatewayMemberFlag.md b/content/reference/services/SoftLayer_Hardware_Router/getNetworkGatewayMemberFlag.md index 0e1aa9afd5..359bf1d0fe 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getNetworkGatewayMemberFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getNetworkGatewayMemberFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getNetworkGatewayMemberFlag + Retrieve whether or not this device is part of a network gateway. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getNetworkMonitorAttachedDownHardware.md b/content/reference/services/SoftLayer_Hardware_Router/getNetworkMonitorAttachedDownHardware.md index de1155561d..1c93afafb4 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getNetworkMonitorAttachedDownHardware.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getNetworkMonitorAttachedDownHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getNetworkMonitorAttachedDownHardware + Retrieve all servers with failed monitoring that are attached downstream to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getNetworkMonitorAttachedDownVirtualGuests.md b/content/reference/services/SoftLayer_Hardware_Router/getNetworkMonitorAttachedDownVirtualGuests.md index db5ba79e34..2a3efd34ac 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getNetworkMonitorAttachedDownVirtualGuests.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getNetworkMonitorAttachedDownVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getNetworkMonitorAttachedDownVirtualGuests + Retrieve virtual guests that are attached downstream to a hardware that have failed monitoring diff --git a/content/reference/services/SoftLayer_Hardware_Router/getNetworkMonitorIncidents.md b/content/reference/services/SoftLayer_Hardware_Router/getNetworkMonitorIncidents.md index 02a420722d..111b5363af 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getNetworkMonitorIncidents.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getNetworkMonitorIncidents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getNetworkMonitorIncidents + Retrieve the status of all of a piece of hardware's network monitoring incidents. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getNetworkMonitors.md b/content/reference/services/SoftLayer_Hardware_Router/getNetworkMonitors.md index 0cc2cad4b8..815fafab9c 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getNetworkMonitors.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getNetworkMonitors.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getNetworkMonitors + Retrieve information regarding a piece of hardware's network monitors. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getNetworkStatus.md b/content/reference/services/SoftLayer_Hardware_Router/getNetworkStatus.md index bb64d8919a..676249b590 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getNetworkStatus.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getNetworkStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getNetworkStatus + Retrieve the value of a hardware's network status attribute. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getNetworkStatusAttribute.md b/content/reference/services/SoftLayer_Hardware_Router/getNetworkStatusAttribute.md index ab419eb1e1..19c633dee5 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getNetworkStatusAttribute.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getNetworkStatusAttribute.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getNetworkStatusAttribute + Retrieve the hardware's related network status attribute. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_Router/getNetworkStorage.md index 605bfe23b9..d2efb6f0db 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getNetworkStorage + Retrieve information regarding a piece of hardware's associated network storage service account. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getNextBillingCycleBandwidthAllocation.md b/content/reference/services/SoftLayer_Hardware_Router/getNextBillingCycleBandwidthAllocation.md index ffe48409fb..d065616051 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getNextBillingCycleBandwidthAllocation.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getNextBillingCycleBandwidthAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getNextBillingCycleBandwidthAllocation + Retrieve a hardware's allotted bandwidth for the next billing cycle (measured in GB). diff --git a/content/reference/services/SoftLayer_Hardware_Router/getNotesHistory.md b/content/reference/services/SoftLayer_Hardware_Router/getNotesHistory.md index c2a528d1e8..aa469564b0 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getNotesHistory.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getNotesHistory.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Router/getNvRamCapacity.md b/content/reference/services/SoftLayer_Hardware_Router/getNvRamCapacity.md index c1c12d4ca1..0a8af418c0 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getNvRamCapacity.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getNvRamCapacity.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getNvRamCapacity + Retrieve the amount of non-volatile memory a piece of hardware has, measured in gigabytes. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getNvRamComponentModels.md b/content/reference/services/SoftLayer_Hardware_Router/getNvRamComponentModels.md index b24d8fc3ed..806bab2f25 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getNvRamComponentModels.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getNvRamComponentModels.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Router/getObject.md b/content/reference/services/SoftLayer_Hardware_Router/getObject.md index 329e42f3ad..d83026c66f 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getObject.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getObject + Retrieve a SoftLayer_Hardware_Router record. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getOperatingSystem.md b/content/reference/services/SoftLayer_Hardware_Router/getOperatingSystem.md index 4a108f941a..63fa7c7376 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getOperatingSystem.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getOperatingSystem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getOperatingSystem + Retrieve information regarding a piece of hardware's operating system. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getOperatingSystemReferenceCode.md b/content/reference/services/SoftLayer_Hardware_Router/getOperatingSystemReferenceCode.md index d9efc56007..d4a72ffa22 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getOperatingSystemReferenceCode.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getOperatingSystemReferenceCode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getOperatingSystemReferenceCode + Retrieve a hardware's operating system software description. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getOutboundBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Router/getOutboundBandwidthUsage.md index 666bf15432..afe8b193e5 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getOutboundBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getOutboundBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getOutboundBandwidthUsage + Retrieve the sum of all the outbound network traffic data for the last 30 days. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getOutboundPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Router/getOutboundPublicBandwidthUsage.md index 8a85b4510e..a2a7e8a806 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getOutboundPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getOutboundPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getOutboundPublicBandwidthUsage + Retrieve the total public outbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getParentBay.md b/content/reference/services/SoftLayer_Hardware_Router/getParentBay.md index 1b1670728b..a43dee7465 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getParentBay.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getParentBay.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getParentBay + Retrieve blade Bay diff --git a/content/reference/services/SoftLayer_Hardware_Router/getParentHardware.md b/content/reference/services/SoftLayer_Hardware_Router/getParentHardware.md index e756e084f7..55417b15f2 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getParentHardware.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getParentHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getParentHardware + Retrieve parent Hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getPointOfPresenceLocation.md b/content/reference/services/SoftLayer_Hardware_Router/getPointOfPresenceLocation.md index f643d0a732..d54fccbd41 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getPointOfPresenceLocation.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getPointOfPresenceLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getPointOfPresenceLocation + Retrieve information regarding the Point of Presence (PoP) location in which a piece of hardware resides. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getPowerComponents.md b/content/reference/services/SoftLayer_Hardware_Router/getPowerComponents.md index 7c54f82d9c..c983965c44 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getPowerComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getPowerComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getPowerComponents + Retrieve the power components for a hardware object. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getPowerSupply.md b/content/reference/services/SoftLayer_Hardware_Router/getPowerSupply.md index 2ed2f793d7..dd0e63b932 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getPowerSupply.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getPowerSupply.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getPowerSupply + Retrieve information regarding a piece of hardware's power supply. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getPrimaryBackendNetworkComponent.md b/content/reference/services/SoftLayer_Hardware_Router/getPrimaryBackendNetworkComponent.md index f3aabe3a96..2c8ef66832 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getPrimaryBackendNetworkComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getPrimaryBackendNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getPrimaryBackendNetworkComponent + Retrieve information regarding the hardware's primary back-end network component. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getPrimaryNetworkComponent.md b/content/reference/services/SoftLayer_Hardware_Router/getPrimaryNetworkComponent.md index cec1f9ae87..378f01db8c 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getPrimaryNetworkComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getPrimaryNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getPrimaryNetworkComponent + Retrieve information regarding the hardware's primary public network component. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getPrivateBandwidthData.md b/content/reference/services/SoftLayer_Hardware_Router/getPrivateBandwidthData.md index 9f34acee58..08083d6bb8 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getPrivateBandwidthData.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getPrivateBandwidthData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getPrivateBandwidthData + Retrieve a graph of a server's private network usage. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getPrivateNetworkOnlyFlag.md b/content/reference/services/SoftLayer_Hardware_Router/getPrivateNetworkOnlyFlag.md index e835dff5f0..0393a50f97 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getPrivateNetworkOnlyFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getPrivateNetworkOnlyFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getPrivateNetworkOnlyFlag + Retrieve whether the hardware only has access to the private network. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getProcessorCoreAmount.md b/content/reference/services/SoftLayer_Hardware_Router/getProcessorCoreAmount.md index 10e07b1250..8eccf4f324 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getProcessorCoreAmount.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getProcessorCoreAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getProcessorCoreAmount + Retrieve the total number of processor cores, summed from all processors that are attached to a piece of hardware diff --git a/content/reference/services/SoftLayer_Hardware_Router/getProcessorPhysicalCoreAmount.md b/content/reference/services/SoftLayer_Hardware_Router/getProcessorPhysicalCoreAmount.md index 85318aeafc..bedd2d842e 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getProcessorPhysicalCoreAmount.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getProcessorPhysicalCoreAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getProcessorPhysicalCoreAmount + Retrieve the total number of physical processor cores, summed from all processors that are attached to a piece of hardware diff --git a/content/reference/services/SoftLayer_Hardware_Router/getProcessors.md b/content/reference/services/SoftLayer_Hardware_Router/getProcessors.md index 8ba8a6435c..c238a29d08 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getProcessors.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getProcessors.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getProcessors + Retrieve information regarding a piece of hardware's processors. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getPublicBandwidthData.md b/content/reference/services/SoftLayer_Hardware_Router/getPublicBandwidthData.md index 40fa143251..f04999c8e9 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getPublicBandwidthData.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getPublicBandwidthData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getPublicBandwidthData + Retrieve a graph of a server's public network usage. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getRack.md b/content/reference/services/SoftLayer_Hardware_Router/getRack.md index cf571fe11e..9a53951d33 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getRack.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getRack.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Router/getRaidControllers.md b/content/reference/services/SoftLayer_Hardware_Router/getRaidControllers.md index 034f596a6b..7cc826a48b 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getRaidControllers.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getRaidControllers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getRaidControllers + Retrieve the RAID controllers contained within a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getRecentEvents.md b/content/reference/services/SoftLayer_Hardware_Router/getRecentEvents.md index 1945936fa1..a5adaca14f 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getRecentEvents.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getRecentEvents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getRecentEvents + Retrieve recent events that impact this hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getRemoteManagementAccounts.md b/content/reference/services/SoftLayer_Hardware_Router/getRemoteManagementAccounts.md index 2146410080..fd4b075e73 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getRemoteManagementAccounts.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getRemoteManagementAccounts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getRemoteManagementAccounts + Retrieve user credentials to issue commands and/or interact with the server's remote management card. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getRemoteManagementComponent.md b/content/reference/services/SoftLayer_Hardware_Router/getRemoteManagementComponent.md index 5b578c8297..0cbefdcd16 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getRemoteManagementComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getRemoteManagementComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getRemoteManagementComponent + Retrieve a hardware's associated remote management component. This is normally IPMI. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getResourceConfigurations.md b/content/reference/services/SoftLayer_Hardware_Router/getResourceConfigurations.md index 3d2fd54ff7..78061bf393 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getResourceConfigurations.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getResourceConfigurations.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Router/getResourceGroupMemberReferences.md b/content/reference/services/SoftLayer_Hardware_Router/getResourceGroupMemberReferences.md index 127d1867da..6d97b3eb79 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getResourceGroupMemberReferences.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getResourceGroupMemberReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Router/getResourceGroupRoles.md b/content/reference/services/SoftLayer_Hardware_Router/getResourceGroupRoles.md index 697ed86209..e2e550ad99 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getResourceGroupRoles.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getResourceGroupRoles.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Router/getResourceGroups.md b/content/reference/services/SoftLayer_Hardware_Router/getResourceGroups.md index ccfc7e236f..89fe9cea48 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getResourceGroups.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getResourceGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getResourceGroups + Retrieve the resource groups in which this hardware is a member. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getRouters.md b/content/reference/services/SoftLayer_Hardware_Router/getRouters.md index 034d3622f5..618e422f4d 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getRouters.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getRouters + Retrieve a hardware's routers. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getSanStorageCapabilityFlag.md b/content/reference/services/SoftLayer_Hardware_Router/getSanStorageCapabilityFlag.md index 260bf1aef4..b2d6f5f673 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getSanStorageCapabilityFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getSanStorageCapabilityFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getSanStorageCapabilityFlag + Retrieve a flag indicating that a VLAN on the router can be assigned to a host that has SAN disk functionality. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getScaleAssets.md b/content/reference/services/SoftLayer_Hardware_Router/getScaleAssets.md index 4d46a319f1..d0301bc3f7 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getScaleAssets.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getScaleAssets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getScaleAssets + Retrieve collection of scale assets this hardware corresponds to. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getSecurityScanRequests.md b/content/reference/services/SoftLayer_Hardware_Router/getSecurityScanRequests.md index 3243025603..f110d46b51 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getSecurityScanRequests.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getSecurityScanRequests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getSecurityScanRequests + Retrieve information regarding a piece of hardware's vulnerability scan requests. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getSensorData.md b/content/reference/services/SoftLayer_Hardware_Router/getSensorData.md index 02b1278d34..4643d09c90 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getSensorData.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getSensorData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getSensorData + Retrieve a server's hardware state via its internal sensors diff --git a/content/reference/services/SoftLayer_Hardware_Router/getSensorDataWithGraphs.md b/content/reference/services/SoftLayer_Hardware_Router/getSensorDataWithGraphs.md index 51837ffb34..9b2d4f2c11 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getSensorDataWithGraphs.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getSensorDataWithGraphs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getSensorDataWithGraphs + Retrieve server's temperature and fan speed graphs as well the sensor raw data. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getServerFanSpeedGraphs.md b/content/reference/services/SoftLayer_Hardware_Router/getServerFanSpeedGraphs.md index 9ec7d471d2..0f440566ad 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getServerFanSpeedGraphs.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getServerFanSpeedGraphs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getServerFanSpeedGraphs + Retrieve a server's fan speed graphs. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getServerPowerState.md b/content/reference/services/SoftLayer_Hardware_Router/getServerPowerState.md index ad02bafb0b..3ed5bc8424 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getServerPowerState.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getServerPowerState.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getServerPowerState + Retrieves a server's power state. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getServerRoom.md b/content/reference/services/SoftLayer_Hardware_Router/getServerRoom.md index eb0c0e7264..32c660c1b3 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getServerRoom.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getServerRoom.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getServerRoom + Retrieve information regarding the server room in which the hardware is located. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getServerTemperatureGraphs.md b/content/reference/services/SoftLayer_Hardware_Router/getServerTemperatureGraphs.md index 7006ed65ab..c1d7fef00f 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getServerTemperatureGraphs.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getServerTemperatureGraphs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getServerTemperatureGraphs + Retrieve server's temperature graphs diff --git a/content/reference/services/SoftLayer_Hardware_Router/getServiceProvider.md b/content/reference/services/SoftLayer_Hardware_Router/getServiceProvider.md index ac3e6481ae..b346166c4d 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getServiceProvider.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getServiceProvider.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getServiceProvider + Retrieve information regarding the piece of hardware's service provider. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getSoftwareComponents.md b/content/reference/services/SoftLayer_Hardware_Router/getSoftwareComponents.md index ebafe5fa94..03c3e12320 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getSoftwareComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getSoftwareComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getSoftwareComponents + Retrieve information regarding a piece of hardware's installed software. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getSparePoolBillingItem.md b/content/reference/services/SoftLayer_Hardware_Router/getSparePoolBillingItem.md index 15eb5c6db7..d117051b24 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getSparePoolBillingItem.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getSparePoolBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getSparePoolBillingItem + Retrieve information regarding the billing item for a spare pool server. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getSshKeys.md b/content/reference/services/SoftLayer_Hardware_Router/getSshKeys.md index dae53a2039..c11d3a9b7d 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getSshKeys.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getSshKeys.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getSshKeys + Retrieve sSH keys to be installed on the server during provisioning or an OS reload. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getStorageGroups.md b/content/reference/services/SoftLayer_Hardware_Router/getStorageGroups.md index 9ae5164c96..e4a9200da9 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getStorageGroups.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getStorageGroups.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Router/getStorageNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_Router/getStorageNetworkComponents.md index d2419a55f9..46c65c42a3 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getStorageNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getStorageNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getStorageNetworkComponents + Retrieve a piece of hardware's private storage network components. [Deprecated] diff --git a/content/reference/services/SoftLayer_Hardware_Router/getTagReferences.md b/content/reference/services/SoftLayer_Hardware_Router/getTagReferences.md index 37326d6cdb..b9f31c23b6 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getTagReferences.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getTagReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Router/getTopLevelLocation.md b/content/reference/services/SoftLayer_Hardware_Router/getTopLevelLocation.md index a03573ab1f..5cb53c9c14 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getTopLevelLocation.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getTopLevelLocation.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Router/getTransactionHistory.md b/content/reference/services/SoftLayer_Hardware_Router/getTransactionHistory.md index cc6c0c96de..7901086d23 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getTransactionHistory.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getTransactionHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getTransactionHistory + Get transaction history for a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getUpgradeItemPrices.md b/content/reference/services/SoftLayer_Hardware_Router/getUpgradeItemPrices.md index 29cad8a1b7..13ed4d0f99 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getUpgradeItemPrices.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getUpgradeItemPrices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getUpgradeItemPrices + Retrieve a list of upgradable items available to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getUpgradeRequest.md b/content/reference/services/SoftLayer_Hardware_Router/getUpgradeRequest.md index e2014bd436..682cb13f0f 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getUpgradeRequest.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getUpgradeRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getUpgradeRequest + Retrieve an account's associated upgrade request object, if any. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getUplinkHardware.md b/content/reference/services/SoftLayer_Hardware_Router/getUplinkHardware.md index bc805b83e8..841694d076 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getUplinkHardware.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getUplinkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getUplinkHardware + Retrieve the network device connected to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getUplinkNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_Router/getUplinkNetworkComponents.md index 2e62fc95f3..d4ed5d1432 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getUplinkNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getUplinkNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getUplinkNetworkComponents + Retrieve information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getUserData.md b/content/reference/services/SoftLayer_Hardware_Router/getUserData.md index b6cd86eea3..6af2fbba87 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getUserData.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getUserData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getUserData + Retrieve an array containing a single string of custom user data for a hardware order. Max size is 16 kb. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getVirtualChassis.md b/content/reference/services/SoftLayer_Hardware_Router/getVirtualChassis.md index a1c720ce97..3715742e21 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getVirtualChassis.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getVirtualChassis.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getVirtualChassis + Retrieve information regarding the virtual chassis for a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getVirtualChassisSiblings.md b/content/reference/services/SoftLayer_Hardware_Router/getVirtualChassisSiblings.md index 4b421f90cb..4ab8f836a5 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getVirtualChassisSiblings.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getVirtualChassisSiblings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getVirtualChassisSiblings + Retrieve information regarding the virtual chassis siblings for a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getVirtualHost.md b/content/reference/services/SoftLayer_Hardware_Router/getVirtualHost.md index 205c9da653..536583a577 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getVirtualHost.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getVirtualHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getVirtualHost + Retrieve a piece of hardware's virtual host record. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getVirtualLicenses.md b/content/reference/services/SoftLayer_Hardware_Router/getVirtualLicenses.md index 69dc7c20c5..9c91f61edc 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getVirtualLicenses.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getVirtualLicenses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getVirtualLicenses + Retrieve information regarding a piece of hardware's virtual software licenses. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getVirtualRack.md b/content/reference/services/SoftLayer_Hardware_Router/getVirtualRack.md index 99a633ebf2..11ddc671d2 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getVirtualRack.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getVirtualRack.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getVirtualRack + Retrieve information regarding the bandwidth allotment to which a piece of hardware belongs. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getVirtualRackId.md b/content/reference/services/SoftLayer_Hardware_Router/getVirtualRackId.md index 18b74d433c..9c97252741 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getVirtualRackId.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getVirtualRackId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getVirtualRackId + Retrieve the name of the bandwidth allotment belonging to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getVirtualRackName.md b/content/reference/services/SoftLayer_Hardware_Router/getVirtualRackName.md index d0746a35a7..a7ea75104a 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getVirtualRackName.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getVirtualRackName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getVirtualRackName + Retrieve the name of the bandwidth allotment belonging to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Router/getVirtualizationPlatform.md b/content/reference/services/SoftLayer_Hardware_Router/getVirtualizationPlatform.md index 15416cf6e7..e91e6ddc80 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/getVirtualizationPlatform.md +++ b/content/reference/services/SoftLayer_Hardware_Router/getVirtualizationPlatform.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::getVirtualizationPlatform + Retrieve a piece of hardware's virtualization platform software. diff --git a/content/reference/services/SoftLayer_Hardware_Router/importVirtualHost.md b/content/reference/services/SoftLayer_Hardware_Router/importVirtualHost.md index 2b431f4b6a..f32a21cac8 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/importVirtualHost.md +++ b/content/reference/services/SoftLayer_Hardware_Router/importVirtualHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::importVirtualHost + attempt to import the host record for the virtualization platform running on a server diff --git a/content/reference/services/SoftLayer_Hardware_Router/isPingable.md b/content/reference/services/SoftLayer_Hardware_Router/isPingable.md index ede615997d..3bbdb2df25 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/isPingable.md +++ b/content/reference/services/SoftLayer_Hardware_Router/isPingable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::isPingable + Verifies whether or not a server is pingable. diff --git a/content/reference/services/SoftLayer_Hardware_Router/ping.md b/content/reference/services/SoftLayer_Hardware_Router/ping.md index 5d9c47de90..467542e614 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/ping.md +++ b/content/reference/services/SoftLayer_Hardware_Router/ping.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::ping + Issues ping command. diff --git a/content/reference/services/SoftLayer_Hardware_Router/powerCycle.md b/content/reference/services/SoftLayer_Hardware_Router/powerCycle.md index c8edcfc550..f247e5358d 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/powerCycle.md +++ b/content/reference/services/SoftLayer_Hardware_Router/powerCycle.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::powerCycle + Issues power cycle to server. diff --git a/content/reference/services/SoftLayer_Hardware_Router/powerOff.md b/content/reference/services/SoftLayer_Hardware_Router/powerOff.md index da71320591..43cb776795 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/powerOff.md +++ b/content/reference/services/SoftLayer_Hardware_Router/powerOff.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::powerOff + Power off server. diff --git a/content/reference/services/SoftLayer_Hardware_Router/powerOn.md b/content/reference/services/SoftLayer_Hardware_Router/powerOn.md index c70826cafc..aff2c9497a 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/powerOn.md +++ b/content/reference/services/SoftLayer_Hardware_Router/powerOn.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::powerOn + Power on server. diff --git a/content/reference/services/SoftLayer_Hardware_Router/rebootDefault.md b/content/reference/services/SoftLayer_Hardware_Router/rebootDefault.md index 70b11d3bd2..2e42e2dd69 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/rebootDefault.md +++ b/content/reference/services/SoftLayer_Hardware_Router/rebootDefault.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::rebootDefault + Reboot the server via the default method. diff --git a/content/reference/services/SoftLayer_Hardware_Router/rebootHard.md b/content/reference/services/SoftLayer_Hardware_Router/rebootHard.md index b36d12315c..acdebb4177 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/rebootHard.md +++ b/content/reference/services/SoftLayer_Hardware_Router/rebootHard.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::rebootHard + Reboot the server via "hard" reboot. diff --git a/content/reference/services/SoftLayer_Hardware_Router/rebootSoft.md b/content/reference/services/SoftLayer_Hardware_Router/rebootSoft.md index 1dfc42d65f..0d69204c7f 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/rebootSoft.md +++ b/content/reference/services/SoftLayer_Hardware_Router/rebootSoft.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::rebootSoft + Execute a soft reboot to the server. diff --git a/content/reference/services/SoftLayer_Hardware_Router/removeAccessToNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_Router/removeAccessToNetworkStorage.md index a77566328c..55319a6c04 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/removeAccessToNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_Router/removeAccessToNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::removeAccessToNetworkStorage + Remove access to a SoftLayer_Network_Storage volume from this device. diff --git a/content/reference/services/SoftLayer_Hardware_Router/removeAccessToNetworkStorageList.md b/content/reference/services/SoftLayer_Hardware_Router/removeAccessToNetworkStorageList.md index 4d5f7b895b..ff915ed23d 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/removeAccessToNetworkStorageList.md +++ b/content/reference/services/SoftLayer_Hardware_Router/removeAccessToNetworkStorageList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::removeAccessToNetworkStorageList + Remove access to multiple SoftLayer_Network_Storage volumes from this device. diff --git a/content/reference/services/SoftLayer_Hardware_Router/removeTags.md b/content/reference/services/SoftLayer_Hardware_Router/removeTags.md index 58856ed1a9..bc4d370894 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/removeTags.md +++ b/content/reference/services/SoftLayer_Hardware_Router/removeTags.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::removeTags + Remove a tag reference diff --git a/content/reference/services/SoftLayer_Hardware_Router/setTags.md b/content/reference/services/SoftLayer_Hardware_Router/setTags.md index 5278b06b99..a6b58307d4 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/setTags.md +++ b/content/reference/services/SoftLayer_Hardware_Router/setTags.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Router/updateIpmiPassword.md b/content/reference/services/SoftLayer_Hardware_Router/updateIpmiPassword.md index 10cd39a0ca..b6696190ed 100644 --- a/content/reference/services/SoftLayer_Hardware_Router/updateIpmiPassword.md +++ b/content/reference/services/SoftLayer_Hardware_Router/updateIpmiPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Router](/reference/services/SoftLayer_Hardware_Router)::updateIpmiPassword + Update the root IPMI user password diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/_index.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/_index.md index 229fa464f2..657dde2b64 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/_index.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/_index.md @@ -22,6 +22,8 @@ classes: + + ### seeAlso * [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware ) @@ -47,1734 +49,2032 @@ classes: #### [activatePrivatePort](/reference/services/SoftLayer_Hardware_SecurityModule/activatePrivatePort) Activate a server's private network interface. +
              #### [activatePublicPort](/reference/services/SoftLayer_Hardware_SecurityModule/activatePublicPort) Activate a server's public network interface. +
              #### [allowAccessToNetworkStorage](/reference/services/SoftLayer_Hardware_SecurityModule/allowAccessToNetworkStorage) Allow access to a SoftLayer_Network_Storage volume from this device. +
              #### [allowAccessToNetworkStorageList](/reference/services/SoftLayer_Hardware_SecurityModule/allowAccessToNetworkStorageList) Allow access to multiple SoftLayer_Network_Storage volumes from this device. +
              #### [bootToRescueLayer](/reference/services/SoftLayer_Hardware_SecurityModule/bootToRescueLayer) Initiates the Rescue Kernel to bring a server online to troubleshoot system problems. +
              #### [captureImage](/reference/services/SoftLayer_Hardware_SecurityModule/captureImage) Captures an Image of the hard disk on the physical machine. +
              #### [createFirmwareReflashTransaction](/reference/services/SoftLayer_Hardware_SecurityModule/createFirmwareReflashTransaction) Runs firmware reflash on the servers components. +
              #### [createFirmwareUpdateTransaction](/reference/services/SoftLayer_Hardware_SecurityModule/createFirmwareUpdateTransaction) Runs firmware updates on the servers components. +
              #### [createHyperThreadingUpdateTransaction](/reference/services/SoftLayer_Hardware_SecurityModule/createHyperThreadingUpdateTransaction) Runs BIOS update on the server to change the hyper-threading configuration. +
              #### [createObject](/reference/services/SoftLayer_Hardware_SecurityModule/createObject) Create a new server +
              #### [createPostSoftwareInstallTransaction](/reference/services/SoftLayer_Hardware_SecurityModule/createPostSoftwareInstallTransaction) +
              #### [deleteObject](/reference/services/SoftLayer_Hardware_SecurityModule/deleteObject) Delete a server +
              #### [deleteSoftwareComponentPasswords](/reference/services/SoftLayer_Hardware_SecurityModule/deleteSoftwareComponentPasswords) Delete software component passwords. +
              #### [deleteTag](/reference/services/SoftLayer_Hardware_SecurityModule/deleteTag) Delete a tag +
              #### [editObject](/reference/services/SoftLayer_Hardware_SecurityModule/editObject) Edit a server's properties +
              #### [editSoftwareComponentPasswords](/reference/services/SoftLayer_Hardware_SecurityModule/editSoftwareComponentPasswords) Edit the properties of software component passwords. +
              #### [executeRemoteScript](/reference/services/SoftLayer_Hardware_SecurityModule/executeRemoteScript) Download and run remote script from uri on the hardware. Requires https for script to be executed after download. +
              #### [findByIpAddress](/reference/services/SoftLayer_Hardware_SecurityModule/findByIpAddress) Find hardware by its primary public or private IP (ipv4) address. +
              #### [generateOrderTemplate](/reference/services/SoftLayer_Hardware_SecurityModule/generateOrderTemplate) Obtain an order container for a given template object +
              #### [getAccount](/reference/services/SoftLayer_Hardware_SecurityModule/getAccount) Retrieve the account associated with a piece of hardware. +
              #### [getActiveComponents](/reference/services/SoftLayer_Hardware_SecurityModule/getActiveComponents) Retrieve a piece of hardware's active physical components. +
              #### [getActiveNetworkFirewallBillingItem](/reference/services/SoftLayer_Hardware_SecurityModule/getActiveNetworkFirewallBillingItem) Retrieve the billing item for a server's attached network firewall. +
              #### [getActiveNetworkMonitorIncident](/reference/services/SoftLayer_Hardware_SecurityModule/getActiveNetworkMonitorIncident) Retrieve a piece of hardware's active network monitoring incidents. +
              #### [getActiveTickets](/reference/services/SoftLayer_Hardware_SecurityModule/getActiveTickets) +
              #### [getActiveTransaction](/reference/services/SoftLayer_Hardware_SecurityModule/getActiveTransaction) Retrieve transaction currently running for server. +
              #### [getActiveTransactions](/reference/services/SoftLayer_Hardware_SecurityModule/getActiveTransactions) Retrieve any active transaction(s) that are currently running for the server (example: os reload). +
              #### [getAllPowerComponents](/reference/services/SoftLayer_Hardware_SecurityModule/getAllPowerComponents) +
              #### [getAllowedHost](/reference/services/SoftLayer_Hardware_SecurityModule/getAllowedHost) Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. +
              #### [getAllowedNetworkStorage](/reference/services/SoftLayer_Hardware_SecurityModule/getAllowedNetworkStorage) Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. +
              #### [getAllowedNetworkStorageReplicas](/reference/services/SoftLayer_Hardware_SecurityModule/getAllowedNetworkStorageReplicas) Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. +
              #### [getAntivirusSpywareSoftwareComponent](/reference/services/SoftLayer_Hardware_SecurityModule/getAntivirusSpywareSoftwareComponent) Retrieve information regarding an antivirus/spyware software component object. +
              #### [getAttachedNetworkStorages](/reference/services/SoftLayer_Hardware_SecurityModule/getAttachedNetworkStorages) Return a list of SoftLayer_Network_Storage volumes authorized to this device. +
              #### [getAttributes](/reference/services/SoftLayer_Hardware_SecurityModule/getAttributes) Retrieve information regarding a piece of hardware's specific attributes. +
              #### [getAvailableBillingTermChangePrices](/reference/services/SoftLayer_Hardware_SecurityModule/getAvailableBillingTermChangePrices) Retrieves a list of available term prices available to this of hardware. +
              #### [getAvailableMonitoring](/reference/services/SoftLayer_Hardware_SecurityModule/getAvailableMonitoring) Retrieve an object that stores the maximum level for the monitoring query types and response types. +
              #### [getAvailableNetworkStorages](/reference/services/SoftLayer_Hardware_SecurityModule/getAvailableNetworkStorages) Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. +
              #### [getAverageDailyBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule/getAverageDailyBandwidthUsage) Retrieve the average daily total bandwidth usage for the current billing cycle. +
              #### [getAverageDailyPrivateBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule/getAverageDailyPrivateBandwidthUsage) Retrieve the average daily private bandwidth usage for the current billing cycle. +
              #### [getAverageDailyPublicBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule/getAverageDailyPublicBandwidthUsage) Retrieve the average daily public bandwidth usage for the current billing cycle. +
              #### [getBackendBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule/getBackendBandwidthUsage) Retrieves public bandwidth usage records. +
              -
              +
              #### [getBackendBandwidthUse](/reference/services/SoftLayer_Hardware_SecurityModule/getBackendBandwidthUse) Retrieves private bandwidth usage records. + +Deprecated + +
              #### [getBackendIncomingBandwidth](/reference/services/SoftLayer_Hardware_SecurityModule/getBackendIncomingBandwidth) Retrieve the amount of incoming private network bandwidth used by a server over a period of time. +
              #### [getBackendNetworkComponents](/reference/services/SoftLayer_Hardware_SecurityModule/getBackendNetworkComponents) Retrieve a piece of hardware's back-end or private network components. +
              #### [getBackendOutgoingBandwidth](/reference/services/SoftLayer_Hardware_SecurityModule/getBackendOutgoingBandwidth) Retrieve the amount of outgoing private network bandwidth used by a server over a period of time. +
              #### [getBackendRouters](/reference/services/SoftLayer_Hardware_SecurityModule/getBackendRouters) Retrieve a hardware's backend or private router. +
              #### [getBandwidthAllocation](/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthAllocation) Retrieve a hardware's allotted bandwidth (measured in GB). +
              #### [getBandwidthAllotmentDetail](/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthAllotmentDetail) Retrieve a hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. +
              #### [getBandwidthForDateRange](/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthForDateRange) Retrieve bandwidth data from a tracking object. +
              #### [getBandwidthImage](/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthImage) Retrieve a bandwidth image and textual description of that image for this server. +
              #### [getBenchmarkCertifications](/reference/services/SoftLayer_Hardware_SecurityModule/getBenchmarkCertifications) Retrieve information regarding a piece of hardware's benchmark certifications. +
              #### [getBillingCycleBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule/getBillingCycleBandwidthUsage) Retrieve the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. +
              #### [getBillingCyclePrivateBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule/getBillingCyclePrivateBandwidthUsage) Retrieve the raw private bandwidth usage data for the current billing cycle. +
              #### [getBillingCyclePublicBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule/getBillingCyclePublicBandwidthUsage) Retrieve the raw public bandwidth usage data for the current billing cycle. +
              #### [getBillingItem](/reference/services/SoftLayer_Hardware_SecurityModule/getBillingItem) Retrieve information regarding the billing item for a server. +
              #### [getBillingItemFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getBillingItemFlag) Retrieve a flag indicating that a billing item exists. +
              #### [getBiosPasswordNullFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getBiosPasswordNullFlag) Retrieve determine if BIOS password should be left as null. +
              #### [getBlockCancelBecauseDisconnectedFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getBlockCancelBecauseDisconnectedFlag) Retrieve determines whether the hardware is ineligible for cancellation because it is disconnected. +
              #### [getBootModeOptions](/reference/services/SoftLayer_Hardware_SecurityModule/getBootModeOptions) Retrieve the valid boot modes for this server. +
              #### [getBusinessContinuanceInsuranceFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getBusinessContinuanceInsuranceFlag) Retrieve status indicating whether or not a piece of hardware has business continuance insurance. +
              #### [getCaptureEnabledFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getCaptureEnabledFlag) Retrieve determine if the server is able to be image captured. If unable to image capture a reason will be provided. +
              #### [getChildrenHardware](/reference/services/SoftLayer_Hardware_SecurityModule/getChildrenHardware) Retrieve child hardware. +
              #### [getComponentDetailsXML](/reference/services/SoftLayer_Hardware_SecurityModule/getComponentDetailsXML) +
              #### [getComponents](/reference/services/SoftLayer_Hardware_SecurityModule/getComponents) Retrieve a piece of hardware's components. +
              #### [getContainsSolidStateDrivesFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getContainsSolidStateDrivesFlag) +
              #### [getContinuousDataProtectionSoftwareComponent](/reference/services/SoftLayer_Hardware_SecurityModule/getContinuousDataProtectionSoftwareComponent) Retrieve a continuous data protection/server backup software component object. +
              #### [getControlPanel](/reference/services/SoftLayer_Hardware_SecurityModule/getControlPanel) Retrieve a server's control panel. +
              #### [getCost](/reference/services/SoftLayer_Hardware_SecurityModule/getCost) Retrieve the total cost of a server, measured in US Dollars ($USD). +
              #### [getCreateObjectOptions](/reference/services/SoftLayer_Hardware_SecurityModule/getCreateObjectOptions) Determine options available when creating a server +
              #### [getCurrentBandwidthSummary](/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBandwidthSummary) Retrieve an object that provides commonly used bandwidth summary components for the current billing cycle. +
              #### [getCurrentBenchmarkCertificationResultFile](/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBenchmarkCertificationResultFile) Get the file for the current benchmark certification result, if it exists. +
              #### [getCurrentBillableBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBillableBandwidthUsage) Retrieve the current billable public outbound bandwidth for this hardware for the current billing cycle. +
              #### [getCurrentBillingDetail](/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBillingDetail) << EOT +
              #### [getCurrentBillingTotal](/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBillingTotal) Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges. +
              #### [getCustomBandwidthDataByDate](/reference/services/SoftLayer_Hardware_SecurityModule/getCustomBandwidthDataByDate) Retrieve bandwidth graph by date. +
              #### [getCustomerInstalledOperatingSystemFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getCustomerInstalledOperatingSystemFlag) Retrieve indicates if a server has a Customer Installed OS +
              #### [getCustomerOwnedFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getCustomerOwnedFlag) Retrieve indicates if a server is a customer owned device. +
              #### [getDailyAverage](/reference/services/SoftLayer_Hardware_SecurityModule/getDailyAverage) calculate the average daily network traffic used by a server in gigabytes. +
              #### [getDatacenter](/reference/services/SoftLayer_Hardware_SecurityModule/getDatacenter) Retrieve information regarding the datacenter in which a piece of hardware resides. +
              #### [getDatacenterName](/reference/services/SoftLayer_Hardware_SecurityModule/getDatacenterName) Retrieve the name of the datacenter in which a piece of hardware resides. +
              #### [getDaysInSparePool](/reference/services/SoftLayer_Hardware_SecurityModule/getDaysInSparePool) Retrieve number of day(s) a server have been in spare pool. +
              #### [getDownlinkHardware](/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkHardware) Retrieve all hardware that has uplink network connections to a piece of hardware. +
              #### [getDownlinkNetworkHardware](/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkNetworkHardware) Retrieve all hardware that has uplink network connections to a piece of hardware. +
              #### [getDownlinkServers](/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkServers) Retrieve information regarding all servers attached to a piece of network hardware. +
              #### [getDownlinkVirtualGuests](/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkVirtualGuests) Retrieve information regarding all virtual guests attached to a piece of network hardware. +
              #### [getDownstreamHardwareBindings](/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamHardwareBindings) Retrieve all hardware downstream from a network device. +
              #### [getDownstreamNetworkHardware](/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamNetworkHardware) Retrieve all network hardware downstream from the selected piece of hardware. +
              #### [getDownstreamNetworkHardwareWithIncidents](/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamNetworkHardwareWithIncidents) Retrieve all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. +
              #### [getDownstreamServers](/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamServers) Retrieve information regarding all servers attached downstream to a piece of network hardware. +
              #### [getDownstreamVirtualGuests](/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamVirtualGuests) Retrieve information regarding all virtual guests attached to a piece of network hardware. +
              #### [getDriveControllers](/reference/services/SoftLayer_Hardware_SecurityModule/getDriveControllers) Retrieve the drive controllers contained within a piece of hardware. +
              #### [getEvaultNetworkStorage](/reference/services/SoftLayer_Hardware_SecurityModule/getEvaultNetworkStorage) Retrieve information regarding a piece of hardware's associated EVault network storage service account. +
              #### [getFirewallProtectableSubnets](/reference/services/SoftLayer_Hardware_SecurityModule/getFirewallProtectableSubnets) Get the subnets associated with this server that are protectable by a network component firewall. +
              #### [getFirewallServiceComponent](/reference/services/SoftLayer_Hardware_SecurityModule/getFirewallServiceComponent) Retrieve information regarding a piece of hardware's firewall services. +
              #### [getFixedConfigurationPreset](/reference/services/SoftLayer_Hardware_SecurityModule/getFixedConfigurationPreset) Retrieve defines the fixed components in a fixed configuration bare metal server. +
              #### [getFrontendBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendBandwidthUsage) Retrieves public bandwidth usage records. +
              -
              +
              #### [getFrontendBandwidthUse](/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendBandwidthUse) Retrieves public bandwidth usage records. + +Deprecated + +
              #### [getFrontendIncomingBandwidth](/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendIncomingBandwidth) Retrieve the amount of incoming public network bandwidth used by a server over a period of time. +
              #### [getFrontendNetworkComponents](/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendNetworkComponents) Retrieve a piece of hardware's front-end or public network components. +
              #### [getFrontendOutgoingBandwidth](/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendOutgoingBandwidth) Retrieve the amount of outgoing public network bandwidth used by a server over a period of time. +
              #### [getFrontendRouters](/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendRouters) Retrieve a hardware's frontend or public router. +
              #### [getFutureBillingItem](/reference/services/SoftLayer_Hardware_SecurityModule/getFutureBillingItem) Retrieve information regarding the future billing item for a server. +
              #### [getGlobalIdentifier](/reference/services/SoftLayer_Hardware_SecurityModule/getGlobalIdentifier) Retrieve a hardware's universally unique identifier. +
              #### [getHardDrives](/reference/services/SoftLayer_Hardware_SecurityModule/getHardDrives) Retrieve the hard drives contained within a piece of hardware. +
              #### [getHardwareByIpAddress](/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareByIpAddress) Retrieve a SoftLayer_Hardware_Server object by IP address. +
              #### [getHardwareChassis](/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareChassis) Retrieve the chassis that a piece of hardware is housed in. +
              #### [getHardwareFunction](/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareFunction) Retrieve a hardware's function. +
              #### [getHardwareFunctionDescription](/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareFunctionDescription) Retrieve a hardware's function. +
              #### [getHardwareStatus](/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareStatus) Retrieve a hardware's status. +
              #### [getHasSingleRootVirtualizationBillingItemFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getHasSingleRootVirtualizationBillingItemFlag) Retrieve determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item. +
              #### [getHasTrustedPlatformModuleBillingItemFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getHasTrustedPlatformModuleBillingItemFlag) Retrieve determine in hardware object has TPM enabled. +
              #### [getHostIpsSoftwareComponent](/reference/services/SoftLayer_Hardware_SecurityModule/getHostIpsSoftwareComponent) Retrieve information regarding a host IPS software component object. +
              #### [getHourlyBandwidth](/reference/services/SoftLayer_Hardware_SecurityModule/getHourlyBandwidth) Retrieves bandwidth hourly over a 24-hour period for the specified hardware. +
              #### [getHourlyBillingFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getHourlyBillingFlag) Retrieve a server's hourly billing status. +
              #### [getInboundBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule/getInboundBandwidthUsage) Retrieve the sum of all the inbound network traffic data for the last 30 days. +
              #### [getInboundPrivateBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule/getInboundPrivateBandwidthUsage) Retrieve the total private inbound bandwidth for this hardware for the current billing cycle. +
              #### [getInboundPublicBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule/getInboundPublicBandwidthUsage) Retrieve the total public inbound bandwidth for this hardware for the current billing cycle. +
              #### [getIsBillingTermChangeAvailableFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getIsBillingTermChangeAvailableFlag) Retrieve whether or not this hardware object is eligible to change to term billing. +
              #### [getIsCloudReadyNodeCertified](/reference/services/SoftLayer_Hardware_SecurityModule/getIsCloudReadyNodeCertified) Retrieve determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute. +
              #### [getIsIpmiDisabled](/reference/services/SoftLayer_Hardware_SecurityModule/getIsIpmiDisabled) Retrieve determine if remote management has been disabled due to port speed. +
              #### [getIsVirtualPrivateCloudNode](/reference/services/SoftLayer_Hardware_SecurityModule/getIsVirtualPrivateCloudNode) Retrieve determine if hardware object is a Virtual Private Cloud node. +
              #### [getItemPricesFromSoftwareDescriptions](/reference/services/SoftLayer_Hardware_SecurityModule/getItemPricesFromSoftwareDescriptions) Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description +
              #### [getLastOperatingSystemReload](/reference/services/SoftLayer_Hardware_SecurityModule/getLastOperatingSystemReload) Retrieve the last transaction that a server's operating system was loaded. +
              #### [getLastTransaction](/reference/services/SoftLayer_Hardware_SecurityModule/getLastTransaction) Retrieve information regarding the last transaction a server performed. +
              #### [getLatestNetworkMonitorIncident](/reference/services/SoftLayer_Hardware_SecurityModule/getLatestNetworkMonitorIncident) Retrieve a piece of hardware's latest network monitoring incident. +
              #### [getLocation](/reference/services/SoftLayer_Hardware_SecurityModule/getLocation) Retrieve where a piece of hardware is located within SoftLayer's location hierarchy. +
              #### [getLocationPathString](/reference/services/SoftLayer_Hardware_SecurityModule/getLocationPathString) +
              #### [getLockboxNetworkStorage](/reference/services/SoftLayer_Hardware_SecurityModule/getLockboxNetworkStorage) Retrieve information regarding a lockbox account associated with a server. +
              #### [getLogicalVolumeStorageGroups](/reference/services/SoftLayer_Hardware_SecurityModule/getLogicalVolumeStorageGroups) Retrieve returns a list of logical volumes on the physical machine. +
              #### [getManagedResourceFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getManagedResourceFlag) Retrieve a flag indicating that the hardware is a managed resource. +
              #### [getManagementNetworkComponent](/reference/services/SoftLayer_Hardware_SecurityModule/getManagementNetworkComponent) Retrieve a server's management network component. +
              #### [getMemory](/reference/services/SoftLayer_Hardware_SecurityModule/getMemory) Retrieve information regarding a piece of hardware's memory. +
              #### [getMemoryCapacity](/reference/services/SoftLayer_Hardware_SecurityModule/getMemoryCapacity) Retrieve the amount of memory a piece of hardware has, measured in gigabytes. +
              #### [getMetricTrackingObject](/reference/services/SoftLayer_Hardware_SecurityModule/getMetricTrackingObject) Retrieve a piece of hardware's metric tracking object. +
              #### [getMetricTrackingObjectId](/reference/services/SoftLayer_Hardware_SecurityModule/getMetricTrackingObjectId) Retrieve the metric tracking object id for this server. +
              #### [getModules](/reference/services/SoftLayer_Hardware_SecurityModule/getModules) +
              #### [getMonitoringRobot](/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringRobot) +
              #### [getMonitoringServiceComponent](/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringServiceComponent) Retrieve information regarding a piece of hardware's network monitoring services. +
              #### [getMonitoringServiceEligibilityFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringServiceEligibilityFlag) +
              #### [getMonitoringUserNotification](/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringUserNotification) Retrieve the monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails +
              #### [getMotherboard](/reference/services/SoftLayer_Hardware_SecurityModule/getMotherboard) Retrieve a server's motherboard. +
              #### [getNetworkCards](/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkCards) Retrieve information regarding a piece of hardware's network cards. +
              #### [getNetworkComponentFirewallProtectableIpAddresses](/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkComponentFirewallProtectableIpAddresses) Get the IP addresses associated with this server that are protectable by a network component firewall. +
              #### [getNetworkComponents](/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkComponents) Retrieve returns a hardware's network components. +
              #### [getNetworkGatewayMember](/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkGatewayMember) Retrieve the gateway member if this device is part of a network gateway. +
              #### [getNetworkGatewayMemberFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkGatewayMemberFlag) Retrieve whether or not this device is part of a network gateway. +
              #### [getNetworkManagementIpAddress](/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkManagementIpAddress) Retrieve a piece of hardware's network management IP address. +
              #### [getNetworkMonitorAttachedDownHardware](/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitorAttachedDownHardware) Retrieve all servers with failed monitoring that are attached downstream to a piece of hardware. +
              #### [getNetworkMonitorAttachedDownVirtualGuests](/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitorAttachedDownVirtualGuests) Retrieve virtual guests that are attached downstream to a hardware that have failed monitoring +
              #### [getNetworkMonitorIncidents](/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitorIncidents) Retrieve the status of all of a piece of hardware's network monitoring incidents. +
              #### [getNetworkMonitors](/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitors) Retrieve information regarding a piece of hardware's network monitors. +
              #### [getNetworkStatus](/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStatus) Retrieve the value of a hardware's network status attribute. +
              #### [getNetworkStatusAttribute](/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStatusAttribute) Retrieve the hardware's related network status attribute. +
              #### [getNetworkStorage](/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStorage) Retrieve information regarding a piece of hardware's associated network storage service account. +
              #### [getNetworkVlans](/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkVlans) Retrieve the network virtual LANs (VLANs) associated with a piece of hardware's network components. +
              #### [getNextBillingCycleBandwidthAllocation](/reference/services/SoftLayer_Hardware_SecurityModule/getNextBillingCycleBandwidthAllocation) Retrieve a hardware's allotted bandwidth for the next billing cycle (measured in GB). +
              #### [getNotesHistory](/reference/services/SoftLayer_Hardware_SecurityModule/getNotesHistory) +
              #### [getNvRamCapacity](/reference/services/SoftLayer_Hardware_SecurityModule/getNvRamCapacity) Retrieve the amount of non-volatile memory a piece of hardware has, measured in gigabytes. +
              #### [getNvRamComponentModels](/reference/services/SoftLayer_Hardware_SecurityModule/getNvRamComponentModels) +
              #### [getObject](/reference/services/SoftLayer_Hardware_SecurityModule/getObject) Retrieve a SoftLayer_Hardware_SecurityModule record. +
              #### [getOpenCancellationTicket](/reference/services/SoftLayer_Hardware_SecurityModule/getOpenCancellationTicket) Retrieve an open ticket requesting cancellation of this server, if one exists. +
              #### [getOperatingSystem](/reference/services/SoftLayer_Hardware_SecurityModule/getOperatingSystem) Retrieve information regarding a piece of hardware's operating system. +
              #### [getOperatingSystemReferenceCode](/reference/services/SoftLayer_Hardware_SecurityModule/getOperatingSystemReferenceCode) Retrieve a hardware's operating system software description. +
              #### [getOutboundBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule/getOutboundBandwidthUsage) Retrieve the sum of all the outbound network traffic data for the last 30 days. +
              #### [getOutboundPrivateBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule/getOutboundPrivateBandwidthUsage) Retrieve the total private outbound bandwidth for this hardware for the current billing cycle. +
              #### [getOutboundPublicBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule/getOutboundPublicBandwidthUsage) Retrieve the total public outbound bandwidth for this hardware for the current billing cycle. +
              #### [getOverBandwidthAllocationFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getOverBandwidthAllocationFlag) Retrieve whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation. +
              #### [getPMInfo](/reference/services/SoftLayer_Hardware_SecurityModule/getPMInfo) Retrieve a server's hardware state via its internal sensors. +
              #### [getParentBay](/reference/services/SoftLayer_Hardware_SecurityModule/getParentBay) Retrieve blade Bay +
              #### [getParentHardware](/reference/services/SoftLayer_Hardware_SecurityModule/getParentHardware) Retrieve parent Hardware. +
              #### [getPartitions](/reference/services/SoftLayer_Hardware_SecurityModule/getPartitions) +
              #### [getPointOfPresenceLocation](/reference/services/SoftLayer_Hardware_SecurityModule/getPointOfPresenceLocation) Retrieve information regarding the Point of Presence (PoP) location in which a piece of hardware resides. +
              #### [getPowerComponents](/reference/services/SoftLayer_Hardware_SecurityModule/getPowerComponents) Retrieve the power components for a hardware object. +
              #### [getPowerSupply](/reference/services/SoftLayer_Hardware_SecurityModule/getPowerSupply) Retrieve a server's power supply. +
              #### [getPrimaryBackendIpAddress](/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryBackendIpAddress) Retrieve the hardware's primary private IP address. +
              #### [getPrimaryDriveSize](/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryDriveSize) +
              #### [getPrimaryIpAddress](/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryIpAddress) Retrieve the hardware's primary public IP address. +
              #### [getPrivateBandwidthData](/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthData) Retrieve a graph of a server's private network usage. +
              #### [getPrivateBandwidthDataSummary](/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthDataSummary) Retrieve a server's private bandwidth usage summary +
              #### [getPrivateBandwidthGraphImage](/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthGraphImage) Retrieve a graph of a server's private network usage. +
              #### [getPrivateIpAddress](/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateIpAddress) Retrieve a server's primary private IP address. +
              #### [getPrivateNetworkComponent](/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateNetworkComponent) Retrieve a server's private network component. +
              #### [getPrivateNetworkOnlyFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateNetworkOnlyFlag) Retrieve whether the hardware only has access to the private network. +
              #### [getPrivateVlan](/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateVlan) Retrieve the backend VLAN for the primary IP address of the server. +
              -
              +
              #### [getPrivateVlanByIpAddress](/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateVlanByIpAddress) Retrieve a backend network VLAN by searching for an IP address. + +Deprecated + +
              #### [getProcessorCoreAmount](/reference/services/SoftLayer_Hardware_SecurityModule/getProcessorCoreAmount) Retrieve the total number of processor cores, summed from all processors that are attached to a piece of hardware +
              #### [getProcessorPhysicalCoreAmount](/reference/services/SoftLayer_Hardware_SecurityModule/getProcessorPhysicalCoreAmount) Retrieve the total number of physical processor cores, summed from all processors that are attached to a piece of hardware +
              #### [getProcessors](/reference/services/SoftLayer_Hardware_SecurityModule/getProcessors) Retrieve information regarding a piece of hardware's processors. +
              #### [getProjectedOverBandwidthAllocationFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getProjectedOverBandwidthAllocationFlag) Retrieve whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation. +
              #### [getProjectedPublicBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule/getProjectedPublicBandwidthUsage) Retrieve the projected public outbound bandwidth for this hardware for the current billing cycle. +
              #### [getProvisionDate](/reference/services/SoftLayer_Hardware_SecurityModule/getProvisionDate) +
              #### [getPublicBandwidthData](/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthData) Retrieve a graph of a server's public network usage. +
              #### [getPublicBandwidthDataSummary](/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthDataSummary) Retrieve a server's public bandwidth usage summary +
              #### [getPublicBandwidthGraphImage](/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthGraphImage) Retrieve a graph of a server's public network usage. +
              #### [getPublicBandwidthTotal](/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthTotal) Retrieve total number of public bytes used by a server over time period specified. +
              #### [getPublicNetworkComponent](/reference/services/SoftLayer_Hardware_SecurityModule/getPublicNetworkComponent) Retrieve a server's public network component. +
              #### [getPublicVlan](/reference/services/SoftLayer_Hardware_SecurityModule/getPublicVlan) Retrieve the frontend VLAN for the primary IP address of the server +
              #### [getPublicVlanByHostname](/reference/services/SoftLayer_Hardware_SecurityModule/getPublicVlanByHostname) Retrieve the frontend VLAN by a server's hostname. +
              #### [getRack](/reference/services/SoftLayer_Hardware_SecurityModule/getRack) +
              #### [getRaidControllers](/reference/services/SoftLayer_Hardware_SecurityModule/getRaidControllers) Retrieve the RAID controllers contained within a piece of hardware. +
              #### [getReadyNodeFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getReadyNodeFlag) Retrieve determine if hardware object is vSan Ready Node. +
              #### [getRecentEvents](/reference/services/SoftLayer_Hardware_SecurityModule/getRecentEvents) Retrieve recent events that impact this hardware. +
              #### [getRecentRemoteManagementCommands](/reference/services/SoftLayer_Hardware_SecurityModule/getRecentRemoteManagementCommands) Retrieve the last five commands issued to the server's remote management card. +
              #### [getRegionalInternetRegistry](/reference/services/SoftLayer_Hardware_SecurityModule/getRegionalInternetRegistry) +
              #### [getRemoteManagement](/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagement) Retrieve a server's remote management card. +
              #### [getRemoteManagementAccounts](/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagementAccounts) Retrieve user credentials to issue commands and/or interact with the server's remote management card. +
              #### [getRemoteManagementComponent](/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagementComponent) Retrieve a hardware's associated remote management component. This is normally IPMI. +
              #### [getRemoteManagementUsers](/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagementUsers) Retrieve user(s) who have access to issue commands and/or interact with the server's remote management card. +
              #### [getResourceConfigurations](/reference/services/SoftLayer_Hardware_SecurityModule/getResourceConfigurations) +
              #### [getResourceGroupMemberReferences](/reference/services/SoftLayer_Hardware_SecurityModule/getResourceGroupMemberReferences) +
              #### [getResourceGroupRoles](/reference/services/SoftLayer_Hardware_SecurityModule/getResourceGroupRoles) +
              #### [getResourceGroups](/reference/services/SoftLayer_Hardware_SecurityModule/getResourceGroups) Retrieve the resource groups in which this hardware is a member. +
              #### [getReverseDomainRecords](/reference/services/SoftLayer_Hardware_SecurityModule/getReverseDomainRecords) Retrieve the reverse domain records associated with a server. +
              #### [getRouters](/reference/services/SoftLayer_Hardware_SecurityModule/getRouters) Retrieve a hardware's routers. +
              #### [getScaleAssets](/reference/services/SoftLayer_Hardware_SecurityModule/getScaleAssets) Retrieve collection of scale assets this hardware corresponds to. +
              #### [getSecurityScanRequests](/reference/services/SoftLayer_Hardware_SecurityModule/getSecurityScanRequests) Retrieve information regarding a piece of hardware's vulnerability scan requests. +
              #### [getSensorData](/reference/services/SoftLayer_Hardware_SecurityModule/getSensorData) Retrieve a server's hardware state via its internal sensors. +
              #### [getSensorDataWithGraphs](/reference/services/SoftLayer_Hardware_SecurityModule/getSensorDataWithGraphs) Retrieve server's temperature and fan speed graphs as well the sensor raw data. +
              #### [getServerDetails](/reference/services/SoftLayer_Hardware_SecurityModule/getServerDetails) Retrieve a server's hardware components, software, and network components. +
              #### [getServerFanSpeedGraphs](/reference/services/SoftLayer_Hardware_SecurityModule/getServerFanSpeedGraphs) Retrieve server's fan speed graphs. +
              #### [getServerPowerState](/reference/services/SoftLayer_Hardware_SecurityModule/getServerPowerState) Retrieves server's power state +
              #### [getServerRoom](/reference/services/SoftLayer_Hardware_SecurityModule/getServerRoom) Retrieve information regarding the server room in which the hardware is located. +
              #### [getServerTemperatureGraphs](/reference/services/SoftLayer_Hardware_SecurityModule/getServerTemperatureGraphs) Retrieve server's temperature graphs +
              #### [getServiceProvider](/reference/services/SoftLayer_Hardware_SecurityModule/getServiceProvider) Retrieve information regarding the piece of hardware's service provider. +
              #### [getSoftwareComponents](/reference/services/SoftLayer_Hardware_SecurityModule/getSoftwareComponents) Retrieve information regarding a piece of hardware's installed software. +
              #### [getSoftwareGuardExtensionEnabled](/reference/services/SoftLayer_Hardware_SecurityModule/getSoftwareGuardExtensionEnabled) Retrieve determine if hardware object has Software Guard Extension (SGX) enabled. +
              #### [getSshKeys](/reference/services/SoftLayer_Hardware_SecurityModule/getSshKeys) Retrieve sSH keys to be installed on the server during provisioning or an OS reload. +
              #### [getStatisticsRemoteManagement](/reference/services/SoftLayer_Hardware_SecurityModule/getStatisticsRemoteManagement) Retrieve a server's remote management card used for statistics. +
              #### [getStorageGroups](/reference/services/SoftLayer_Hardware_SecurityModule/getStorageGroups) +
              #### [getStorageNetworkComponents](/reference/services/SoftLayer_Hardware_SecurityModule/getStorageNetworkComponents) Retrieve a piece of hardware's private storage network components. [Deprecated] +
              #### [getTagReferences](/reference/services/SoftLayer_Hardware_SecurityModule/getTagReferences) +
              #### [getTopLevelLocation](/reference/services/SoftLayer_Hardware_SecurityModule/getTopLevelLocation) +
              #### [getTransactionHistory](/reference/services/SoftLayer_Hardware_SecurityModule/getTransactionHistory) Get transaction history for a piece of hardware. +
              #### [getUefiBootFlag](/reference/services/SoftLayer_Hardware_SecurityModule/getUefiBootFlag) Retrieve whether to use UEFI boot instead of BIOS. +
              #### [getUpgradeItemPrices](/reference/services/SoftLayer_Hardware_SecurityModule/getUpgradeItemPrices) Retrieve a list of upgradable items available to a piece of hardware. +
              #### [getUpgradeRequest](/reference/services/SoftLayer_Hardware_SecurityModule/getUpgradeRequest) Retrieve an account's associated upgrade request object, if any. +
              #### [getUplinkHardware](/reference/services/SoftLayer_Hardware_SecurityModule/getUplinkHardware) Retrieve the network device connected to a piece of hardware. +
              #### [getUplinkNetworkComponents](/reference/services/SoftLayer_Hardware_SecurityModule/getUplinkNetworkComponents) Retrieve information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. +
              #### [getUserData](/reference/services/SoftLayer_Hardware_SecurityModule/getUserData) Retrieve an array containing a single string of custom user data for a hardware order. Max size is 16 kb. +
              #### [getUsers](/reference/services/SoftLayer_Hardware_SecurityModule/getUsers) Retrieve a list of users that have access to this computing instance. +
              #### [getValidBlockDeviceTemplateGroups](/reference/services/SoftLayer_Hardware_SecurityModule/getValidBlockDeviceTemplateGroups) Return a list of valid block device template groups based on this host +
              #### [getVirtualChassis](/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualChassis) Retrieve information regarding the virtual chassis for a piece of hardware. +
              #### [getVirtualChassisSiblings](/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualChassisSiblings) Retrieve information regarding the virtual chassis siblings for a piece of hardware. +
              #### [getVirtualGuests](/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualGuests) Retrieve a hardware server's virtual servers. +
              #### [getVirtualHost](/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualHost) Retrieve a piece of hardware's virtual host record. +
              #### [getVirtualLicenses](/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualLicenses) Retrieve information regarding a piece of hardware's virtual software licenses. +
              #### [getVirtualRack](/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualRack) Retrieve information regarding the bandwidth allotment to which a piece of hardware belongs. +
              #### [getVirtualRackId](/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualRackId) Retrieve the name of the bandwidth allotment belonging to a piece of hardware. +
              #### [getVirtualRackName](/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualRackName) Retrieve the name of the bandwidth allotment belonging to a piece of hardware. +
              #### [getVirtualizationPlatform](/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualizationPlatform) Retrieve a piece of hardware's virtualization platform software. +
              #### [getWindowsUpdateAvailableUpdates](/reference/services/SoftLayer_Hardware_SecurityModule/getWindowsUpdateAvailableUpdates) Retrieve a list of Windows updates available to a server. +
              #### [getWindowsUpdateInstalledUpdates](/reference/services/SoftLayer_Hardware_SecurityModule/getWindowsUpdateInstalledUpdates) Retrieve a list of Windows updates installed on a server. +
              #### [getWindowsUpdateStatus](/reference/services/SoftLayer_Hardware_SecurityModule/getWindowsUpdateStatus) Retrieve a server's Windows update synchronization status +
              #### [importVirtualHost](/reference/services/SoftLayer_Hardware_SecurityModule/importVirtualHost) attempt to import the host record for the virtualization platform running on a server +
              #### [initiateIderaBareMetalRestore](/reference/services/SoftLayer_Hardware_SecurityModule/initiateIderaBareMetalRestore) Initiate an Idera bare metal restore for the server tied to an Idera Server Backup +
              #### [initiateR1SoftBareMetalRestore](/reference/services/SoftLayer_Hardware_SecurityModule/initiateR1SoftBareMetalRestore) Initiate an R1Soft bare metal restore for the server tied to an R1Soft CDP Server +
              #### [isBackendPingable](/reference/services/SoftLayer_Hardware_SecurityModule/isBackendPingable) Verifies if a server's backend ip address is pingable. +
              #### [isPingable](/reference/services/SoftLayer_Hardware_SecurityModule/isPingable) Verifies if server is pingable. +
              #### [isWindowsServer](/reference/services/SoftLayer_Hardware_SecurityModule/isWindowsServer) Determine if a server runs the Microsoft Windows operating system. +
              #### [massFirmwareReflash](/reference/services/SoftLayer_Hardware_SecurityModule/massFirmwareReflash) Runs firmware reflashes on the servers components. +
              #### [massFirmwareUpdate](/reference/services/SoftLayer_Hardware_SecurityModule/massFirmwareUpdate) Runs firmware updates on the servers components. +
              #### [massHyperThreadingUpdate](/reference/services/SoftLayer_Hardware_SecurityModule/massHyperThreadingUpdate) Runs firmware reflashes on the servers components. +
              #### [massReloadOperatingSystem](/reference/services/SoftLayer_Hardware_SecurityModule/massReloadOperatingSystem) Reloads operating system configuration on a set of hardware Ids. +
              #### [massSparePool](/reference/services/SoftLayer_Hardware_SecurityModule/massSparePool) Allows multiple servers to be added to or removed from the spare pool. +
              #### [ping](/reference/services/SoftLayer_Hardware_SecurityModule/ping) Issues ping command. +
              #### [populateServerRam](/reference/services/SoftLayer_Hardware_SecurityModule/populateServerRam) +
              #### [powerCycle](/reference/services/SoftLayer_Hardware_SecurityModule/powerCycle) Issues power cycle to server. +
              #### [powerOff](/reference/services/SoftLayer_Hardware_SecurityModule/powerOff) Power off server. +
              #### [powerOn](/reference/services/SoftLayer_Hardware_SecurityModule/powerOn) Power on server. +
              #### [rebootDefault](/reference/services/SoftLayer_Hardware_SecurityModule/rebootDefault) Reboot the server via the default method. +
              #### [rebootHard](/reference/services/SoftLayer_Hardware_SecurityModule/rebootHard) Reboot the server via "hard" reboot. +
              #### [rebootSoft](/reference/services/SoftLayer_Hardware_SecurityModule/rebootSoft) Reboot the server via gracefully (soft reboot). +
              #### [reloadCurrentOperatingSystemConfiguration](/reference/services/SoftLayer_Hardware_SecurityModule/reloadCurrentOperatingSystemConfiguration) Reloads current operating system configuration. +
              #### [reloadOperatingSystem](/reference/services/SoftLayer_Hardware_SecurityModule/reloadOperatingSystem) Reloads operating system configuration. +
              #### [removeAccessToNetworkStorage](/reference/services/SoftLayer_Hardware_SecurityModule/removeAccessToNetworkStorage) Remove access to a SoftLayer_Network_Storage volume from this device. +
              #### [removeAccessToNetworkStorageList](/reference/services/SoftLayer_Hardware_SecurityModule/removeAccessToNetworkStorageList) Remove access to multiple SoftLayer_Network_Storage volumes from this device. +
              #### [removeTags](/reference/services/SoftLayer_Hardware_SecurityModule/removeTags) Remove a tag reference +
              #### [runPassmarkCertificationBenchmark](/reference/services/SoftLayer_Hardware_SecurityModule/runPassmarkCertificationBenchmark) Runs a hardware stress test on the server to obtain a Passmark Certification. +
              #### [setOperatingSystemPassword](/reference/services/SoftLayer_Hardware_SecurityModule/setOperatingSystemPassword) Changes the password stored in our system for a servers' Operating System +
              #### [setPrivateNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_SecurityModule/setPrivateNetworkInterfaceSpeed) Set the speed and redundancy configuration of a server's private network interface. +
              #### [setPublicNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_SecurityModule/setPublicNetworkInterfaceSpeed) Set the speed and redundancy configuration of a server's public network interface. +
              #### [setTags](/reference/services/SoftLayer_Hardware_SecurityModule/setTags) +
              #### [setUserMetadata](/reference/services/SoftLayer_Hardware_SecurityModule/setUserMetadata) Sets the server's user metadata value. +
              #### [shutdownPrivatePort](/reference/services/SoftLayer_Hardware_SecurityModule/shutdownPrivatePort) Disconnect a server's private network interface. +
              #### [shutdownPublicPort](/reference/services/SoftLayer_Hardware_SecurityModule/shutdownPublicPort) Disconnect a server's public network interface. +
              #### [sparePool](/reference/services/SoftLayer_Hardware_SecurityModule/sparePool) Allows servers to be added to or removed from the spare pool. +
              #### [testRaidAlertService](/reference/services/SoftLayer_Hardware_SecurityModule/testRaidAlertService) Tests the RAID Alert service. +
              #### [toggleManagementInterface](/reference/services/SoftLayer_Hardware_SecurityModule/toggleManagementInterface) Toggle the IPMI interface on and off. +
              #### [updateIpmiPassword](/reference/services/SoftLayer_Hardware_SecurityModule/updateIpmiPassword) Update the root IPMI user password +
              #### [validatePartitionsForOperatingSystem](/reference/services/SoftLayer_Hardware_SecurityModule/validatePartitionsForOperatingSystem) Validates a collection of partitions for an operating system +
              diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/activatePrivatePort.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/activatePrivatePort.md index fc59f621e9..ce999afabd 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/activatePrivatePort.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/activatePrivatePort.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::activatePrivatePort + Activate a server's private network interface. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/activatePublicPort.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/activatePublicPort.md index 446fdbcb09..5d004ffec4 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/activatePublicPort.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/activatePublicPort.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::activatePublicPort + Activate a server's public network interface. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/allowAccessToNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/allowAccessToNetworkStorage.md index 30300dd533..667d86d304 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/allowAccessToNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/allowAccessToNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::allowAccessToNetworkStorage + Allow access to a SoftLayer_Network_Storage volume from this device. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/allowAccessToNetworkStorageList.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/allowAccessToNetworkStorageList.md index 34429bfe60..93f7fcd3d7 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/allowAccessToNetworkStorageList.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/allowAccessToNetworkStorageList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::allowAccessToNetworkStorageList + Allow access to multiple SoftLayer_Network_Storage volumes from this device. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/bootToRescueLayer.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/bootToRescueLayer.md index adb86fb742..a4a6e99194 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/bootToRescueLayer.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/bootToRescueLayer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::bootToRescueLayer + Initiates the Rescue Kernel to bring a server online to troubleshoot system problems. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/captureImage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/captureImage.md index 687502746b..41d4c0a19e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/captureImage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/captureImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::captureImage + Captures an Image of the hard disk on the physical machine. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/createFirmwareReflashTransaction.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/createFirmwareReflashTransaction.md index 01a9949fde..12c33806aa 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/createFirmwareReflashTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/createFirmwareReflashTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::createFirmwareReflashTransaction + Runs firmware reflash on the servers components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/createFirmwareUpdateTransaction.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/createFirmwareUpdateTransaction.md index b62984188c..f6a0a8844f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/createFirmwareUpdateTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/createFirmwareUpdateTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::createFirmwareUpdateTransaction + Runs firmware updates on the servers components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/createHyperThreadingUpdateTransaction.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/createHyperThreadingUpdateTransaction.md index 56f1d5d5c5..00a366f3ff 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/createHyperThreadingUpdateTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/createHyperThreadingUpdateTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::createHyperThreadingUpdateTransaction + Runs BIOS update on the server to change the hyper-threading configuration. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/createObject.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/createObject.md index 1915bf7694..3b0758d19d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/createObject.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/createObject.md @@ -14,6 +14,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::createObject + Create a new server diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/createPostSoftwareInstallTransaction.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/createPostSoftwareInstallTransaction.md index e1e3bad99a..c501b1a871 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/createPostSoftwareInstallTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/createPostSoftwareInstallTransaction.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/deleteObject.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/deleteObject.md index 7783f1bc9f..a0ece3b0ff 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/deleteObject.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::deleteObject + Delete a server diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/deleteSoftwareComponentPasswords.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/deleteSoftwareComponentPasswords.md index 3f25a71124..6feab58f07 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/deleteSoftwareComponentPasswords.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/deleteSoftwareComponentPasswords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::deleteSoftwareComponentPasswords + Delete software component passwords. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/deleteTag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/deleteTag.md index 4b8ba923a6..8735a3fbef 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/deleteTag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/deleteTag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::deleteTag + Delete a tag diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/editObject.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/editObject.md index e6f9fb2ba3..f443def7b9 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/editObject.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::editObject + Edit a server's properties diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/editSoftwareComponentPasswords.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/editSoftwareComponentPasswords.md index 6583da8ce3..a9ae955b88 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/editSoftwareComponentPasswords.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/editSoftwareComponentPasswords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::editSoftwareComponentPasswords + Edit the properties of software component passwords. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/executeRemoteScript.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/executeRemoteScript.md index eb87b6dd81..6fadf304d5 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/executeRemoteScript.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/executeRemoteScript.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::executeRemoteScript + Download and run remote script from uri on the hardware. Requires https for script to be executed after download. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/findByIpAddress.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/findByIpAddress.md index 82736fd818..b75f45ed17 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/findByIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/findByIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::findByIpAddress + Find hardware by its primary public or private IP (ipv4) address. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/generateOrderTemplate.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/generateOrderTemplate.md index 0c8949ee1c..40b34a48b9 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/generateOrderTemplate.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/generateOrderTemplate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::generateOrderTemplate + Obtain an order container for a given template object diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAccount.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAccount.md index ba2b2d1dcb..c233260564 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAccount.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getAccount + Retrieve the account associated with a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveComponents.md index 950b662e5d..68b13ad591 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getActiveComponents + Retrieve a piece of hardware's active physical components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveNetworkFirewallBillingItem.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveNetworkFirewallBillingItem.md index a75d4b6790..cfa559b619 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveNetworkFirewallBillingItem.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveNetworkFirewallBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getActiveNetworkFirewallBillingItem + Retrieve the billing item for a server's attached network firewall. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveNetworkMonitorIncident.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveNetworkMonitorIncident.md index bc1873f0b2..bada9d5486 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveNetworkMonitorIncident.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveNetworkMonitorIncident.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getActiveNetworkMonitorIncident + Retrieve a piece of hardware's active network monitoring incidents. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveTickets.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveTickets.md index 74ab908650..63bf697f08 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveTickets.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveTickets.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveTransaction.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveTransaction.md index 2fad140f0c..1238d21e3d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getActiveTransaction + Retrieve transaction currently running for server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveTransactions.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveTransactions.md index d5d2c626a2..cea9594e91 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveTransactions.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getActiveTransactions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getActiveTransactions + Retrieve any active transaction(s) that are currently running for the server (example: os reload). diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAllPowerComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAllPowerComponents.md index 4b61314e77..50befd2b5a 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAllPowerComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAllPowerComponents.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAllowedHost.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAllowedHost.md index 923bd2677d..7b78c3f6cd 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAllowedHost.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAllowedHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getAllowedHost + Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAllowedNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAllowedNetworkStorage.md index 3e1f6ef8dd..307acc6c5f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAllowedNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAllowedNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getAllowedNetworkStorage + Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAllowedNetworkStorageReplicas.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAllowedNetworkStorageReplicas.md index eaad86382e..7b89437424 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAllowedNetworkStorageReplicas.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAllowedNetworkStorageReplicas.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getAllowedNetworkStorageReplicas + Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAntivirusSpywareSoftwareComponent.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAntivirusSpywareSoftwareComponent.md index 3b2d38315c..9da24c01c0 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAntivirusSpywareSoftwareComponent.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAntivirusSpywareSoftwareComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getAntivirusSpywareSoftwareComponent + Retrieve information regarding an antivirus/spyware software component object. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAttachedNetworkStorages.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAttachedNetworkStorages.md index 5e549c4957..99c42b6517 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAttachedNetworkStorages.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAttachedNetworkStorages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getAttachedNetworkStorages + Return a list of SoftLayer_Network_Storage volumes authorized to this device. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAttributes.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAttributes.md index 8338d816c4..3824950078 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAttributes.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAttributes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getAttributes + Retrieve information regarding a piece of hardware's specific attributes. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAvailableBillingTermChangePrices.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAvailableBillingTermChangePrices.md index ab296e22dc..d33e145be2 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAvailableBillingTermChangePrices.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAvailableBillingTermChangePrices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getAvailableBillingTermChangePrices + Retrieves a list of available term prices available to this of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAvailableMonitoring.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAvailableMonitoring.md index e7f66c6055..5ff1e584a7 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAvailableMonitoring.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAvailableMonitoring.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getAvailableMonitoring + Retrieve an object that stores the maximum level for the monitoring query types and response types. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAvailableNetworkStorages.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAvailableNetworkStorages.md index ab244c7720..ca1d506564 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAvailableNetworkStorages.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAvailableNetworkStorages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getAvailableNetworkStorages + Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAverageDailyBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAverageDailyBandwidthUsage.md index 2770cd3dee..bf1d160b34 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAverageDailyBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAverageDailyBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getAverageDailyBandwidthUsage + Retrieve the average daily total bandwidth usage for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAverageDailyPrivateBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAverageDailyPrivateBandwidthUsage.md index 9e60d68fc2..f6af3144e2 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAverageDailyPrivateBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAverageDailyPrivateBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getAverageDailyPrivateBandwidthUsage + Retrieve the average daily private bandwidth usage for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAverageDailyPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAverageDailyPublicBandwidthUsage.md index 73f0feb7de..96e04e0eb7 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getAverageDailyPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getAverageDailyPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getAverageDailyPublicBandwidthUsage + Retrieve the average daily public bandwidth usage for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendBandwidthUsage.md index 33d91fd3d8..d759add6a1 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendBandwidthUsage.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBackendBandwidthUsage + Retrieves public bandwidth usage records. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendBandwidthUse.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendBandwidthUse.md index e1e4ab46a1..ea8f82b7cc 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendBandwidthUse.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendBandwidthUse.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBackendBandwidthUse +
              Deprecated
              + Retrieves private bandwidth usage records. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendIncomingBandwidth.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendIncomingBandwidth.md index b727141a7a..7d22c0a6f1 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendIncomingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendIncomingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBackendIncomingBandwidth + Retrieve the amount of incoming private network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendNetworkComponents.md index 5b14de9276..0290327e8e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBackendNetworkComponents + Retrieve a piece of hardware's back-end or private network components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendOutgoingBandwidth.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendOutgoingBandwidth.md index 3f4bff1f88..10288cb4f2 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendOutgoingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendOutgoingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBackendOutgoingBandwidth + Retrieve the amount of outgoing private network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendRouters.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendRouters.md index 8b9813e9ee..93bf7ccab0 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendRouters.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBackendRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBackendRouters + Retrieve a hardware's backend or private router. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthAllocation.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthAllocation.md index 909087442a..f8c26d2c3a 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthAllocation.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBandwidthAllocation + Retrieve a hardware's allotted bandwidth (measured in GB). diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthAllotmentDetail.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthAllotmentDetail.md index 646a656007..b758cfb76b 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthAllotmentDetail.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthAllotmentDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBandwidthAllotmentDetail + Retrieve a hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthForDateRange.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthForDateRange.md index c24340cfd3..fceff408ab 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthForDateRange.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthForDateRange.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBandwidthForDateRange + Retrieve bandwidth data from a tracking object. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthImage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthImage.md index cac5a6ff6a..8ee20dfa9d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthImage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBandwidthImage + Retrieve a bandwidth image and textual description of that image for this server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBenchmarkCertifications.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBenchmarkCertifications.md index a634e243d4..7a36c562c7 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBenchmarkCertifications.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBenchmarkCertifications.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBenchmarkCertifications + Retrieve information regarding a piece of hardware's benchmark certifications. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingCycleBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingCycleBandwidthUsage.md index 4dc122e8b1..79a0906425 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingCycleBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingCycleBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBillingCycleBandwidthUsage + Retrieve the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingCyclePrivateBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingCyclePrivateBandwidthUsage.md index 74defebf43..f839e19d82 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingCyclePrivateBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingCyclePrivateBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBillingCyclePrivateBandwidthUsage + Retrieve the raw private bandwidth usage data for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingCyclePublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingCyclePublicBandwidthUsage.md index 86e9b56725..db8d3a2d4a 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingCyclePublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingCyclePublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBillingCyclePublicBandwidthUsage + Retrieve the raw public bandwidth usage data for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingItem.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingItem.md index 5a5a05e489..0663a7072a 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingItem.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBillingItem + Retrieve information regarding the billing item for a server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingItemFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingItemFlag.md index b65b059b91..b81211ce9d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingItemFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBillingItemFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBillingItemFlag + Retrieve a flag indicating that a billing item exists. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBiosPasswordNullFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBiosPasswordNullFlag.md index d918489c34..83ffa336e5 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBiosPasswordNullFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBiosPasswordNullFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBiosPasswordNullFlag + Retrieve determine if BIOS password should be left as null. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBlockCancelBecauseDisconnectedFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBlockCancelBecauseDisconnectedFlag.md index d297eef703..e753887210 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBlockCancelBecauseDisconnectedFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBlockCancelBecauseDisconnectedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBlockCancelBecauseDisconnectedFlag + Retrieve determines whether the hardware is ineligible for cancellation because it is disconnected. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBootModeOptions.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBootModeOptions.md index f064c597ee..2b6fbc1d1d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBootModeOptions.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBootModeOptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBootModeOptions + Retrieve the valid boot modes for this server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBusinessContinuanceInsuranceFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBusinessContinuanceInsuranceFlag.md index 0c19dc3f1c..184baa7d3d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getBusinessContinuanceInsuranceFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getBusinessContinuanceInsuranceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getBusinessContinuanceInsuranceFlag + Retrieve status indicating whether or not a piece of hardware has business continuance insurance. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCaptureEnabledFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCaptureEnabledFlag.md index b25a571c05..308915d098 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCaptureEnabledFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCaptureEnabledFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getCaptureEnabledFlag + Retrieve determine if the server is able to be image captured. If unable to image capture a reason will be provided. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getChildrenHardware.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getChildrenHardware.md index e662e603ca..b953db4f39 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getChildrenHardware.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getChildrenHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getChildrenHardware + Retrieve child hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getComponentDetailsXML.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getComponentDetailsXML.md index 0fd563022e..60a708a1b0 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getComponentDetailsXML.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getComponentDetailsXML.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getComponents.md index d74729a83d..9521dba8b2 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getComponents + Retrieve a piece of hardware's components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getContainsSolidStateDrivesFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getContainsSolidStateDrivesFlag.md index 9edaf557b6..f29bcd71c7 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getContainsSolidStateDrivesFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getContainsSolidStateDrivesFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getContinuousDataProtectionSoftwareComponent.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getContinuousDataProtectionSoftwareComponent.md index 622f3e93e4..79fde65556 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getContinuousDataProtectionSoftwareComponent.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getContinuousDataProtectionSoftwareComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getContinuousDataProtectionSoftwareComponent + Retrieve a continuous data protection/server backup software component object. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getControlPanel.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getControlPanel.md index 3f3a23e1eb..9c97e20be9 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getControlPanel.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getControlPanel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getControlPanel + Retrieve a server's control panel. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCost.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCost.md index ce5da2b06d..bc33e79a2c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCost.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getCost + Retrieve the total cost of a server, measured in US Dollars ($USD). diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCreateObjectOptions.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCreateObjectOptions.md index 0805caee3a..32e1d4b524 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCreateObjectOptions.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCreateObjectOptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getCreateObjectOptions + Determine options available when creating a server diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBandwidthSummary.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBandwidthSummary.md index 2cea103243..7ac49c0834 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBandwidthSummary.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBandwidthSummary.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getCurrentBandwidthSummary + Retrieve an object that provides commonly used bandwidth summary components for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBenchmarkCertificationResultFile.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBenchmarkCertificationResultFile.md index 2e8f156ed6..067aee1426 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBenchmarkCertificationResultFile.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBenchmarkCertificationResultFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getCurrentBenchmarkCertificationResultFile + Get the file for the current benchmark certification result, if it exists. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBillableBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBillableBandwidthUsage.md index ed2a041672..b0207f015f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBillableBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBillableBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getCurrentBillableBandwidthUsage + Retrieve the current billable public outbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBillingDetail.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBillingDetail.md index fcced5942f..a4e94a6612 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBillingDetail.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBillingDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getCurrentBillingDetail + << EOT diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBillingTotal.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBillingTotal.md index defe2e1bbf..193927adbf 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBillingTotal.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCurrentBillingTotal.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getCurrentBillingTotal + Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCustomBandwidthDataByDate.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCustomBandwidthDataByDate.md index 53093f1065..060b701334 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCustomBandwidthDataByDate.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCustomBandwidthDataByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getCustomBandwidthDataByDate + Retrieve bandwidth graph by date. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCustomerInstalledOperatingSystemFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCustomerInstalledOperatingSystemFlag.md index c3cf99163c..d50e53a813 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCustomerInstalledOperatingSystemFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCustomerInstalledOperatingSystemFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getCustomerInstalledOperatingSystemFlag + Retrieve indicates if a server has a Customer Installed OS diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCustomerOwnedFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCustomerOwnedFlag.md index ddc7158dd3..20a97782af 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getCustomerOwnedFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getCustomerOwnedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getCustomerOwnedFlag + Retrieve indicates if a server is a customer owned device. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDailyAverage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDailyAverage.md index 5c7ddfcc80..60db5a6620 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDailyAverage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDailyAverage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getDailyAverage + calculate the average daily network traffic used by a server in gigabytes. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDatacenter.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDatacenter.md index b7b7e8f161..0579507f8f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDatacenter.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDatacenter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getDatacenter + Retrieve information regarding the datacenter in which a piece of hardware resides. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDatacenterName.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDatacenterName.md index 6bdb9cc9e0..ebfa9af730 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDatacenterName.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDatacenterName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getDatacenterName + Retrieve the name of the datacenter in which a piece of hardware resides. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDaysInSparePool.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDaysInSparePool.md index ca455a713f..47c743ab7c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDaysInSparePool.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDaysInSparePool.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getDaysInSparePool + Retrieve number of day(s) a server have been in spare pool. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkHardware.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkHardware.md index 3ceea55788..51176ae75a 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkHardware.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getDownlinkHardware + Retrieve all hardware that has uplink network connections to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkNetworkHardware.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkNetworkHardware.md index 05d285143b..65df7499ab 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkNetworkHardware.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkNetworkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getDownlinkNetworkHardware + Retrieve all hardware that has uplink network connections to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkServers.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkServers.md index 8e786ab08a..b20022409b 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkServers.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkServers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getDownlinkServers + Retrieve information regarding all servers attached to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkVirtualGuests.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkVirtualGuests.md index 13ebebb052..480155a5c6 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkVirtualGuests.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownlinkVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getDownlinkVirtualGuests + Retrieve information regarding all virtual guests attached to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamHardwareBindings.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamHardwareBindings.md index c708fa5206..10ffa31e50 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamHardwareBindings.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamHardwareBindings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getDownstreamHardwareBindings + Retrieve all hardware downstream from a network device. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamNetworkHardware.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamNetworkHardware.md index 5a5bf4a90e..b2229a00bb 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamNetworkHardware.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamNetworkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getDownstreamNetworkHardware + Retrieve all network hardware downstream from the selected piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamNetworkHardwareWithIncidents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamNetworkHardwareWithIncidents.md index 3d81098ab6..c5d23f2ff0 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamNetworkHardwareWithIncidents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamNetworkHardwareWithIncidents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getDownstreamNetworkHardwareWithIncidents + Retrieve all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamServers.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamServers.md index 118226b03c..347372d1b2 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamServers.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamServers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getDownstreamServers + Retrieve information regarding all servers attached downstream to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamVirtualGuests.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamVirtualGuests.md index 88da00957a..6a8281778f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamVirtualGuests.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getDownstreamVirtualGuests + Retrieve information regarding all virtual guests attached to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDriveControllers.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDriveControllers.md index 4b72474482..a98aa722e8 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getDriveControllers.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getDriveControllers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getDriveControllers + Retrieve the drive controllers contained within a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getEvaultNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getEvaultNetworkStorage.md index 995e1726dd..5dc175c469 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getEvaultNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getEvaultNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getEvaultNetworkStorage + Retrieve information regarding a piece of hardware's associated EVault network storage service account. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFirewallProtectableSubnets.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFirewallProtectableSubnets.md index c6a799088b..d68bfee172 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFirewallProtectableSubnets.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFirewallProtectableSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getFirewallProtectableSubnets + Get the subnets associated with this server that are protectable by a network component firewall. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFirewallServiceComponent.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFirewallServiceComponent.md index c38178e853..0de38b8a75 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFirewallServiceComponent.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFirewallServiceComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getFirewallServiceComponent + Retrieve information regarding a piece of hardware's firewall services. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFixedConfigurationPreset.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFixedConfigurationPreset.md index a48fd245e7..451fc25387 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFixedConfigurationPreset.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFixedConfigurationPreset.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getFixedConfigurationPreset + Retrieve defines the fixed components in a fixed configuration bare metal server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendBandwidthUsage.md index 14a632bacd..c6eee0c8d7 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendBandwidthUsage.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getFrontendBandwidthUsage + Retrieves public bandwidth usage records. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendBandwidthUse.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendBandwidthUse.md index 51f420545a..a44de06479 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendBandwidthUse.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendBandwidthUse.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getFrontendBandwidthUse +
              Deprecated
              + Retrieves public bandwidth usage records. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendIncomingBandwidth.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendIncomingBandwidth.md index d3e22403a6..f3e312f60b 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendIncomingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendIncomingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getFrontendIncomingBandwidth + Retrieve the amount of incoming public network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendNetworkComponents.md index b849016e3d..b63ff30d00 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getFrontendNetworkComponents + Retrieve a piece of hardware's front-end or public network components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendOutgoingBandwidth.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendOutgoingBandwidth.md index 123ab3bb6b..182d742a3f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendOutgoingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendOutgoingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getFrontendOutgoingBandwidth + Retrieve the amount of outgoing public network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendRouters.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendRouters.md index 9a61b1b8c0..999c20ff77 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendRouters.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFrontendRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getFrontendRouters + Retrieve a hardware's frontend or public router. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFutureBillingItem.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFutureBillingItem.md index 515b84b7b4..bfefe6cc38 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getFutureBillingItem.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getFutureBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getFutureBillingItem + Retrieve information regarding the future billing item for a server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getGlobalIdentifier.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getGlobalIdentifier.md index edcd56b99f..1707deeb1d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getGlobalIdentifier.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getGlobalIdentifier.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getGlobalIdentifier + Retrieve a hardware's universally unique identifier. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardDrives.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardDrives.md index 8bcb317386..b2ff935585 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardDrives.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardDrives.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getHardDrives + Retrieve the hard drives contained within a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareByIpAddress.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareByIpAddress.md index 8a87d06753..451618e02c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareByIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareByIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getHardwareByIpAddress + Retrieve a SoftLayer_Hardware_Server object by IP address. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareChassis.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareChassis.md index 1a36212e35..8072bb764e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareChassis.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareChassis.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getHardwareChassis + Retrieve the chassis that a piece of hardware is housed in. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareFunction.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareFunction.md index 73f7f63c4c..298c052be7 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareFunction.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareFunction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getHardwareFunction + Retrieve a hardware's function. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareFunctionDescription.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareFunctionDescription.md index 627dacda9c..8215037db7 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareFunctionDescription.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareFunctionDescription.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getHardwareFunctionDescription + Retrieve a hardware's function. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareStatus.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareStatus.md index c242a12071..01ac4d7fd5 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareStatus.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHardwareStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getHardwareStatus + Retrieve a hardware's status. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHasSingleRootVirtualizationBillingItemFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHasSingleRootVirtualizationBillingItemFlag.md index 07cdd2803f..2aa4339630 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHasSingleRootVirtualizationBillingItemFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHasSingleRootVirtualizationBillingItemFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getHasSingleRootVirtualizationBillingItemFlag + Retrieve determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHasTrustedPlatformModuleBillingItemFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHasTrustedPlatformModuleBillingItemFlag.md index c48e744c18..06cea54f1f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHasTrustedPlatformModuleBillingItemFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHasTrustedPlatformModuleBillingItemFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getHasTrustedPlatformModuleBillingItemFlag + Retrieve determine in hardware object has TPM enabled. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHostIpsSoftwareComponent.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHostIpsSoftwareComponent.md index 1346187488..7405b0b3cf 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHostIpsSoftwareComponent.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHostIpsSoftwareComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getHostIpsSoftwareComponent + Retrieve information regarding a host IPS software component object. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHourlyBandwidth.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHourlyBandwidth.md index cedf91ad05..a4890d4574 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHourlyBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHourlyBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getHourlyBandwidth + Retrieves bandwidth hourly over a 24-hour period for the specified hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHourlyBillingFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHourlyBillingFlag.md index e60184edd1..5689d8008a 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getHourlyBillingFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getHourlyBillingFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getHourlyBillingFlag + Retrieve a server's hourly billing status. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getInboundBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getInboundBandwidthUsage.md index 038fe627ec..afa066c49d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getInboundBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getInboundBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getInboundBandwidthUsage + Retrieve the sum of all the inbound network traffic data for the last 30 days. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getInboundPrivateBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getInboundPrivateBandwidthUsage.md index 29be9629c6..44ea976fbc 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getInboundPrivateBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getInboundPrivateBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getInboundPrivateBandwidthUsage + Retrieve the total private inbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getInboundPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getInboundPublicBandwidthUsage.md index bf039befa9..a5076127c4 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getInboundPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getInboundPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getInboundPublicBandwidthUsage + Retrieve the total public inbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getIsBillingTermChangeAvailableFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getIsBillingTermChangeAvailableFlag.md index 015830edaf..2e2212729a 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getIsBillingTermChangeAvailableFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getIsBillingTermChangeAvailableFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getIsBillingTermChangeAvailableFlag + Retrieve whether or not this hardware object is eligible to change to term billing. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getIsCloudReadyNodeCertified.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getIsCloudReadyNodeCertified.md index 7ff1e358d0..2cf3d41c32 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getIsCloudReadyNodeCertified.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getIsCloudReadyNodeCertified.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getIsCloudReadyNodeCertified + Retrieve determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getIsIpmiDisabled.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getIsIpmiDisabled.md index 61974244fe..f1c9eaf166 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getIsIpmiDisabled.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getIsIpmiDisabled.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getIsIpmiDisabled + Retrieve determine if remote management has been disabled due to port speed. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getIsVirtualPrivateCloudNode.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getIsVirtualPrivateCloudNode.md index 42584192be..d744b1851a 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getIsVirtualPrivateCloudNode.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getIsVirtualPrivateCloudNode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getIsVirtualPrivateCloudNode + Retrieve determine if hardware object is a Virtual Private Cloud node. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getItemPricesFromSoftwareDescriptions.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getItemPricesFromSoftwareDescriptions.md index 9b85db11ce..969bf803ba 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getItemPricesFromSoftwareDescriptions.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getItemPricesFromSoftwareDescriptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getItemPricesFromSoftwareDescriptions + Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getLastOperatingSystemReload.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getLastOperatingSystemReload.md index b828d26318..5cca13aa8e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getLastOperatingSystemReload.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getLastOperatingSystemReload.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getLastOperatingSystemReload + Retrieve the last transaction that a server's operating system was loaded. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getLastTransaction.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getLastTransaction.md index 5cd0925471..1cd0a42a58 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getLastTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getLastTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getLastTransaction + Retrieve information regarding the last transaction a server performed. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getLatestNetworkMonitorIncident.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getLatestNetworkMonitorIncident.md index d0cac4df10..c6660e32a5 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getLatestNetworkMonitorIncident.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getLatestNetworkMonitorIncident.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getLatestNetworkMonitorIncident + Retrieve a piece of hardware's latest network monitoring incident. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getLocation.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getLocation.md index b65f0f75f4..da54cff730 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getLocation.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getLocation + Retrieve where a piece of hardware is located within SoftLayer's location hierarchy. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getLocationPathString.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getLocationPathString.md index 8884e83689..d4a68caf81 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getLocationPathString.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getLocationPathString.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getLockboxNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getLockboxNetworkStorage.md index 0a7d83902e..28d73de32d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getLockboxNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getLockboxNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getLockboxNetworkStorage + Retrieve information regarding a lockbox account associated with a server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getLogicalVolumeStorageGroups.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getLogicalVolumeStorageGroups.md index 96ada6b92d..d1fd9768ed 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getLogicalVolumeStorageGroups.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getLogicalVolumeStorageGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getLogicalVolumeStorageGroups + Retrieve returns a list of logical volumes on the physical machine. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getManagedResourceFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getManagedResourceFlag.md index 9e1b408aa4..debcaacb56 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getManagedResourceFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getManagedResourceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getManagedResourceFlag + Retrieve a flag indicating that the hardware is a managed resource. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getManagementNetworkComponent.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getManagementNetworkComponent.md index 9b46ea8269..85e6e3d16a 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getManagementNetworkComponent.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getManagementNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getManagementNetworkComponent + Retrieve a server's management network component. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getMemory.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getMemory.md index 2f33aa7991..8b8f83396d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getMemory.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getMemory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getMemory + Retrieve information regarding a piece of hardware's memory. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getMemoryCapacity.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getMemoryCapacity.md index 6bc6d4cfd3..34b173a278 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getMemoryCapacity.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getMemoryCapacity.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getMemoryCapacity + Retrieve the amount of memory a piece of hardware has, measured in gigabytes. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getMetricTrackingObject.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getMetricTrackingObject.md index a6a3ba9cea..d02c4a07ce 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getMetricTrackingObject.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getMetricTrackingObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getMetricTrackingObject + Retrieve a piece of hardware's metric tracking object. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getMetricTrackingObjectId.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getMetricTrackingObjectId.md index 1aa1e40d82..eddadd5aee 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getMetricTrackingObjectId.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getMetricTrackingObjectId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getMetricTrackingObjectId + Retrieve the metric tracking object id for this server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getModules.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getModules.md index 3b99b6d106..fce59b7f2c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getModules.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getModules.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringRobot.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringRobot.md index b0831bd686..391da9c857 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringRobot.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringRobot.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringServiceComponent.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringServiceComponent.md index 094eb0381f..ae934b4266 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringServiceComponent.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringServiceComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getMonitoringServiceComponent + Retrieve information regarding a piece of hardware's network monitoring services. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringServiceEligibilityFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringServiceEligibilityFlag.md index 40aa2700eb..ad9e14a7c2 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringServiceEligibilityFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringServiceEligibilityFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringUserNotification.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringUserNotification.md index ee3c3ecf7c..3d7e685f14 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringUserNotification.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getMonitoringUserNotification.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getMonitoringUserNotification + Retrieve the monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getMotherboard.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getMotherboard.md index 96b00699be..2d6b772efb 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getMotherboard.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getMotherboard.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getMotherboard + Retrieve a server's motherboard. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkCards.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkCards.md index 74e87907ca..f45dea394d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkCards.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkCards.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getNetworkCards + Retrieve information regarding a piece of hardware's network cards. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkComponentFirewallProtectableIpAddresses.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkComponentFirewallProtectableIpAddresses.md index 72137c3ff2..db8d803d28 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkComponentFirewallProtectableIpAddresses.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkComponentFirewallProtectableIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getNetworkComponentFirewallProtectableIpAddresses + Get the IP addresses associated with this server that are protectable by a network component firewall. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkComponents.md index 2dbc958a58..de9986af2c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getNetworkComponents + Retrieve returns a hardware's network components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkGatewayMember.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkGatewayMember.md index ecb0e85574..c38a52a2fb 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkGatewayMember.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkGatewayMember.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getNetworkGatewayMember + Retrieve the gateway member if this device is part of a network gateway. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkGatewayMemberFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkGatewayMemberFlag.md index d40ba3b24b..5bbefb1a59 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkGatewayMemberFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkGatewayMemberFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getNetworkGatewayMemberFlag + Retrieve whether or not this device is part of a network gateway. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkManagementIpAddress.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkManagementIpAddress.md index 7d2cbbd9b9..3fc25db750 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkManagementIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkManagementIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getNetworkManagementIpAddress + Retrieve a piece of hardware's network management IP address. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitorAttachedDownHardware.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitorAttachedDownHardware.md index 166f5e47c3..97a08a5a02 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitorAttachedDownHardware.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitorAttachedDownHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getNetworkMonitorAttachedDownHardware + Retrieve all servers with failed monitoring that are attached downstream to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitorAttachedDownVirtualGuests.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitorAttachedDownVirtualGuests.md index aa4414d671..dce9031a6a 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitorAttachedDownVirtualGuests.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitorAttachedDownVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getNetworkMonitorAttachedDownVirtualGuests + Retrieve virtual guests that are attached downstream to a hardware that have failed monitoring diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitorIncidents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitorIncidents.md index 00b08a4e27..b47ecc95ca 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitorIncidents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitorIncidents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getNetworkMonitorIncidents + Retrieve the status of all of a piece of hardware's network monitoring incidents. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitors.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitors.md index ad1f48d82a..8dd4cf47f3 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitors.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkMonitors.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getNetworkMonitors + Retrieve information regarding a piece of hardware's network monitors. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStatus.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStatus.md index bf6e247b5e..0f155ab9d2 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStatus.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getNetworkStatus + Retrieve the value of a hardware's network status attribute. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStatusAttribute.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStatusAttribute.md index 8a036d2446..cf8476c7d7 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStatusAttribute.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStatusAttribute.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getNetworkStatusAttribute + Retrieve the hardware's related network status attribute. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStorage.md index 69f28af8f8..8a553f735a 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getNetworkStorage + Retrieve information regarding a piece of hardware's associated network storage service account. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkVlans.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkVlans.md index 18ad4e7885..f41ed011e1 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkVlans.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getNetworkVlans + Retrieve the network virtual LANs (VLANs) associated with a piece of hardware's network components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNextBillingCycleBandwidthAllocation.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNextBillingCycleBandwidthAllocation.md index 8a5e3a2478..77f9a1abf0 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNextBillingCycleBandwidthAllocation.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNextBillingCycleBandwidthAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getNextBillingCycleBandwidthAllocation + Retrieve a hardware's allotted bandwidth for the next billing cycle (measured in GB). diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNotesHistory.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNotesHistory.md index e5dca85996..78e30d62a0 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNotesHistory.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNotesHistory.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNvRamCapacity.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNvRamCapacity.md index db22f57bd7..3d8bd7660b 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNvRamCapacity.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNvRamCapacity.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getNvRamCapacity + Retrieve the amount of non-volatile memory a piece of hardware has, measured in gigabytes. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNvRamComponentModels.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNvRamComponentModels.md index bc50572b88..f3a5309e4f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getNvRamComponentModels.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getNvRamComponentModels.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getObject.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getObject.md index 5f7ed90c1b..3cc1507659 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getObject.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getObject + Retrieve a SoftLayer_Hardware_SecurityModule record. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getOpenCancellationTicket.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getOpenCancellationTicket.md index 51ddba7aed..c1e7f48cad 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getOpenCancellationTicket.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getOpenCancellationTicket.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getOpenCancellationTicket + Retrieve an open ticket requesting cancellation of this server, if one exists. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getOperatingSystem.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getOperatingSystem.md index 6807a55b07..c55415bf05 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getOperatingSystem.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getOperatingSystem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getOperatingSystem + Retrieve information regarding a piece of hardware's operating system. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getOperatingSystemReferenceCode.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getOperatingSystemReferenceCode.md index af995ec6c6..f426e27cc6 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getOperatingSystemReferenceCode.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getOperatingSystemReferenceCode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getOperatingSystemReferenceCode + Retrieve a hardware's operating system software description. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getOutboundBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getOutboundBandwidthUsage.md index 6fc73f0cda..a040d491d2 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getOutboundBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getOutboundBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getOutboundBandwidthUsage + Retrieve the sum of all the outbound network traffic data for the last 30 days. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getOutboundPrivateBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getOutboundPrivateBandwidthUsage.md index 4fbae2947b..82add7cc78 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getOutboundPrivateBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getOutboundPrivateBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getOutboundPrivateBandwidthUsage + Retrieve the total private outbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getOutboundPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getOutboundPublicBandwidthUsage.md index 977e737d70..3553006639 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getOutboundPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getOutboundPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getOutboundPublicBandwidthUsage + Retrieve the total public outbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getOverBandwidthAllocationFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getOverBandwidthAllocationFlag.md index 8359b37ead..ab15b1c106 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getOverBandwidthAllocationFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getOverBandwidthAllocationFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getOverBandwidthAllocationFlag + Retrieve whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPMInfo.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPMInfo.md index 18c9d7ffb6..9e105091dc 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPMInfo.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPMInfo.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPMInfo + Retrieve a server's hardware state via its internal sensors. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getParentBay.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getParentBay.md index 87597f9c6e..fd54002339 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getParentBay.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getParentBay.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getParentBay + Retrieve blade Bay diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getParentHardware.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getParentHardware.md index 5ab8709ba0..8fe3bdeb7c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getParentHardware.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getParentHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getParentHardware + Retrieve parent Hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPartitions.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPartitions.md index 9e66ceda10..c1a7b27e47 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPartitions.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPartitions.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPointOfPresenceLocation.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPointOfPresenceLocation.md index 59af4dbc69..40cf229c36 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPointOfPresenceLocation.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPointOfPresenceLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPointOfPresenceLocation + Retrieve information regarding the Point of Presence (PoP) location in which a piece of hardware resides. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPowerComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPowerComponents.md index fdee45985a..1dda29df01 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPowerComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPowerComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPowerComponents + Retrieve the power components for a hardware object. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPowerSupply.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPowerSupply.md index 694290a273..779103dc09 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPowerSupply.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPowerSupply.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPowerSupply + Retrieve a server's power supply. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryBackendIpAddress.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryBackendIpAddress.md index 08ee491e3b..618fa0a38b 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryBackendIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryBackendIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPrimaryBackendIpAddress + Retrieve the hardware's primary private IP address. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryDriveSize.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryDriveSize.md index b67b434c95..07b80c8b94 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryDriveSize.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryDriveSize.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryIpAddress.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryIpAddress.md index 8642971c3e..c6d5a3f590 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrimaryIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPrimaryIpAddress + Retrieve the hardware's primary public IP address. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthData.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthData.md index 8a1005c1eb..2abe49dca1 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthData.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPrivateBandwidthData + Retrieve a graph of a server's private network usage. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthDataSummary.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthDataSummary.md index d6258663fd..2cd558314c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthDataSummary.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthDataSummary.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPrivateBandwidthDataSummary + Retrieve a server's private bandwidth usage summary diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthGraphImage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthGraphImage.md index 427c7d4ed6..a8ab227435 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthGraphImage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthGraphImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPrivateBandwidthGraphImage + Retrieve a graph of a server's private network usage. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateIpAddress.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateIpAddress.md index b154293307..05a6786569 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPrivateIpAddress + Retrieve a server's primary private IP address. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateNetworkComponent.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateNetworkComponent.md index 898a33799e..0be4d47cb3 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateNetworkComponent.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPrivateNetworkComponent + Retrieve a server's private network component. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateNetworkOnlyFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateNetworkOnlyFlag.md index fa82847281..b969728a37 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateNetworkOnlyFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateNetworkOnlyFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPrivateNetworkOnlyFlag + Retrieve whether the hardware only has access to the private network. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateVlan.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateVlan.md index 04620f1205..1e7ef37be6 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateVlan.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateVlan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPrivateVlan + Retrieve the backend VLAN for the primary IP address of the server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateVlanByIpAddress.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateVlanByIpAddress.md index 9e0c2e9c77..f119bffba1 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateVlanByIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateVlanByIpAddress.md @@ -14,6 +14,8 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPrivateVlanByIpAddress +
              Deprecated
              + Retrieve a backend network VLAN by searching for an IP address. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getProcessorCoreAmount.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getProcessorCoreAmount.md index 8274ea4974..d2393d9b0a 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getProcessorCoreAmount.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getProcessorCoreAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getProcessorCoreAmount + Retrieve the total number of processor cores, summed from all processors that are attached to a piece of hardware diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getProcessorPhysicalCoreAmount.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getProcessorPhysicalCoreAmount.md index 81ac251158..2b6c379690 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getProcessorPhysicalCoreAmount.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getProcessorPhysicalCoreAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getProcessorPhysicalCoreAmount + Retrieve the total number of physical processor cores, summed from all processors that are attached to a piece of hardware diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getProcessors.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getProcessors.md index 6db80a2fce..745af19645 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getProcessors.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getProcessors.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getProcessors + Retrieve information regarding a piece of hardware's processors. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getProjectedOverBandwidthAllocationFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getProjectedOverBandwidthAllocationFlag.md index 149f31878b..cf21766fb1 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getProjectedOverBandwidthAllocationFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getProjectedOverBandwidthAllocationFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getProjectedOverBandwidthAllocationFlag + Retrieve whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getProjectedPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getProjectedPublicBandwidthUsage.md index 24364a8444..cd9ce80987 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getProjectedPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getProjectedPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getProjectedPublicBandwidthUsage + Retrieve the projected public outbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getProvisionDate.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getProvisionDate.md index c535d9bed0..58e6b14f4c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getProvisionDate.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getProvisionDate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthData.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthData.md index 6402c4bdd0..de27e2b384 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthData.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPublicBandwidthData + Retrieve a graph of a server's public network usage. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthDataSummary.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthDataSummary.md index 4583032ff4..d0d364f8fb 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthDataSummary.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthDataSummary.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPublicBandwidthDataSummary + Retrieve a server's public bandwidth usage summary diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthGraphImage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthGraphImage.md index e8404b2c80..c18ae494a6 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthGraphImage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthGraphImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPublicBandwidthGraphImage + Retrieve a graph of a server's public network usage. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthTotal.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthTotal.md index db82d88597..0d073b4f7e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthTotal.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthTotal.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPublicBandwidthTotal + Retrieve total number of public bytes used by a server over time period specified. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicNetworkComponent.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicNetworkComponent.md index 9d5361c9a6..57756fc9ab 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicNetworkComponent.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPublicNetworkComponent + Retrieve a server's public network component. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicVlan.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicVlan.md index cb1324f921..65353c49da 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicVlan.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicVlan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPublicVlan + Retrieve the frontend VLAN for the primary IP address of the server diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicVlanByHostname.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicVlanByHostname.md index 945d829e15..2862285190 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicVlanByHostname.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getPublicVlanByHostname.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getPublicVlanByHostname + Retrieve the frontend VLAN by a server's hostname. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRack.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRack.md index 4753794749..35bbfe1be9 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRack.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRack.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRaidControllers.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRaidControllers.md index e278784602..83b35244d6 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRaidControllers.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRaidControllers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getRaidControllers + Retrieve the RAID controllers contained within a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getReadyNodeFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getReadyNodeFlag.md index d585a0b41a..95862d4422 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getReadyNodeFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getReadyNodeFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getReadyNodeFlag + Retrieve determine if hardware object is vSan Ready Node. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRecentEvents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRecentEvents.md index 9268c20782..3850d43f00 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRecentEvents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRecentEvents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getRecentEvents + Retrieve recent events that impact this hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRecentRemoteManagementCommands.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRecentRemoteManagementCommands.md index 99aeca85f7..6fe5e7c930 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRecentRemoteManagementCommands.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRecentRemoteManagementCommands.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getRecentRemoteManagementCommands + Retrieve the last five commands issued to the server's remote management card. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRegionalInternetRegistry.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRegionalInternetRegistry.md index b99b212fb8..1b1d5a2e51 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRegionalInternetRegistry.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRegionalInternetRegistry.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagement.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagement.md index 8b376dacfc..359bd9da07 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagement.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagement.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getRemoteManagement + Retrieve a server's remote management card. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagementAccounts.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagementAccounts.md index 7990379f3f..f12fc527fa 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagementAccounts.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagementAccounts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getRemoteManagementAccounts + Retrieve user credentials to issue commands and/or interact with the server's remote management card. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagementComponent.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagementComponent.md index d7454a2fe0..897bbdda8d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagementComponent.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagementComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getRemoteManagementComponent + Retrieve a hardware's associated remote management component. This is normally IPMI. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagementUsers.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagementUsers.md index b85776f879..1e1bb9e012 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagementUsers.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRemoteManagementUsers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getRemoteManagementUsers + Retrieve user(s) who have access to issue commands and/or interact with the server's remote management card. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getResourceConfigurations.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getResourceConfigurations.md index 5a2798a2a5..323d579165 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getResourceConfigurations.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getResourceConfigurations.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getResourceGroupMemberReferences.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getResourceGroupMemberReferences.md index 75716b8cc1..86391d0fcb 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getResourceGroupMemberReferences.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getResourceGroupMemberReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getResourceGroupRoles.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getResourceGroupRoles.md index cf17a5dd5d..15efbb1fd6 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getResourceGroupRoles.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getResourceGroupRoles.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getResourceGroups.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getResourceGroups.md index b059ae5894..32bcf1f81c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getResourceGroups.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getResourceGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getResourceGroups + Retrieve the resource groups in which this hardware is a member. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getReverseDomainRecords.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getReverseDomainRecords.md index 8e00f5fafc..35e96cb497 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getReverseDomainRecords.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getReverseDomainRecords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getReverseDomainRecords + Retrieve the reverse domain records associated with a server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRouters.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRouters.md index 282e7f27a8..5aec5d90c8 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getRouters.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getRouters + Retrieve a hardware's routers. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getScaleAssets.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getScaleAssets.md index d70fd333df..4c36918e0e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getScaleAssets.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getScaleAssets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getScaleAssets + Retrieve collection of scale assets this hardware corresponds to. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getSecurityScanRequests.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getSecurityScanRequests.md index e933c3e7a8..839700a531 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getSecurityScanRequests.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getSecurityScanRequests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getSecurityScanRequests + Retrieve information regarding a piece of hardware's vulnerability scan requests. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getSensorData.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getSensorData.md index 645b95604a..5a918da7b2 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getSensorData.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getSensorData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getSensorData + Retrieve a server's hardware state via its internal sensors. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getSensorDataWithGraphs.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getSensorDataWithGraphs.md index c909f7abb3..9a2472b7fa 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getSensorDataWithGraphs.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getSensorDataWithGraphs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getSensorDataWithGraphs + Retrieve server's temperature and fan speed graphs as well the sensor raw data. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerDetails.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerDetails.md index 86fad9704b..450a4c8790 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerDetails.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getServerDetails + Retrieve a server's hardware components, software, and network components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerFanSpeedGraphs.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerFanSpeedGraphs.md index d861c94019..a256a4265d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerFanSpeedGraphs.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerFanSpeedGraphs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getServerFanSpeedGraphs + Retrieve server's fan speed graphs. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerPowerState.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerPowerState.md index cab1aa9d09..0b3182edf5 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerPowerState.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerPowerState.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getServerPowerState + Retrieves server's power state diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerRoom.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerRoom.md index d5e185364f..c17cfb5ac4 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerRoom.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerRoom.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getServerRoom + Retrieve information regarding the server room in which the hardware is located. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerTemperatureGraphs.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerTemperatureGraphs.md index 09ca0a7e96..01a47d2e42 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerTemperatureGraphs.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getServerTemperatureGraphs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getServerTemperatureGraphs + Retrieve server's temperature graphs diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getServiceProvider.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getServiceProvider.md index 194a1f0a00..bdd2e9f646 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getServiceProvider.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getServiceProvider.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getServiceProvider + Retrieve information regarding the piece of hardware's service provider. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getSoftwareComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getSoftwareComponents.md index 0243dc9160..242d15140f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getSoftwareComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getSoftwareComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getSoftwareComponents + Retrieve information regarding a piece of hardware's installed software. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getSoftwareGuardExtensionEnabled.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getSoftwareGuardExtensionEnabled.md index 53255ea715..1b4f0f93c9 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getSoftwareGuardExtensionEnabled.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getSoftwareGuardExtensionEnabled.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getSoftwareGuardExtensionEnabled + Retrieve determine if hardware object has Software Guard Extension (SGX) enabled. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getSshKeys.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getSshKeys.md index e8dd210021..213a57ce23 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getSshKeys.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getSshKeys.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getSshKeys + Retrieve sSH keys to be installed on the server during provisioning or an OS reload. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getStatisticsRemoteManagement.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getStatisticsRemoteManagement.md index c95ab615ae..849d5293ef 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getStatisticsRemoteManagement.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getStatisticsRemoteManagement.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getStatisticsRemoteManagement + Retrieve a server's remote management card used for statistics. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getStorageGroups.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getStorageGroups.md index df742f5f61..d73980538d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getStorageGroups.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getStorageGroups.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getStorageNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getStorageNetworkComponents.md index 225d6ba636..d8680c354f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getStorageNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getStorageNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getStorageNetworkComponents + Retrieve a piece of hardware's private storage network components. [Deprecated] diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getTagReferences.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getTagReferences.md index 87941f5e14..bfbf1a00a7 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getTagReferences.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getTagReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getTopLevelLocation.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getTopLevelLocation.md index 8106c1d80d..d7f80be53e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getTopLevelLocation.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getTopLevelLocation.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getTransactionHistory.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getTransactionHistory.md index 480c720622..fef733a8ac 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getTransactionHistory.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getTransactionHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getTransactionHistory + Get transaction history for a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getUefiBootFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getUefiBootFlag.md index 5b0e733dd6..5f13bcd7bf 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getUefiBootFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getUefiBootFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getUefiBootFlag + Retrieve whether to use UEFI boot instead of BIOS. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getUpgradeItemPrices.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getUpgradeItemPrices.md index fe3511c831..ae40e73b12 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getUpgradeItemPrices.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getUpgradeItemPrices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getUpgradeItemPrices + Retrieve a list of upgradable items available to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getUpgradeRequest.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getUpgradeRequest.md index 44c5690f7a..73b0d0ed6c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getUpgradeRequest.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getUpgradeRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getUpgradeRequest + Retrieve an account's associated upgrade request object, if any. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getUplinkHardware.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getUplinkHardware.md index 1e4ec0f46c..6556bec26c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getUplinkHardware.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getUplinkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getUplinkHardware + Retrieve the network device connected to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getUplinkNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getUplinkNetworkComponents.md index 7df5285526..1105a0ec29 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getUplinkNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getUplinkNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getUplinkNetworkComponents + Retrieve information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getUserData.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getUserData.md index 5eca3cb9f7..fc1d144c59 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getUserData.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getUserData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getUserData + Retrieve an array containing a single string of custom user data for a hardware order. Max size is 16 kb. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getUsers.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getUsers.md index 9a07a294a2..391afe82cd 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getUsers.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getUsers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getUsers + Retrieve a list of users that have access to this computing instance. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getValidBlockDeviceTemplateGroups.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getValidBlockDeviceTemplateGroups.md index c616f2caa4..5927f39ab6 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getValidBlockDeviceTemplateGroups.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getValidBlockDeviceTemplateGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getValidBlockDeviceTemplateGroups + Return a list of valid block device template groups based on this host diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualChassis.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualChassis.md index 0219ed38dc..ed34180309 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualChassis.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualChassis.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getVirtualChassis + Retrieve information regarding the virtual chassis for a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualChassisSiblings.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualChassisSiblings.md index cbff006da5..2bcc39016b 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualChassisSiblings.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualChassisSiblings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getVirtualChassisSiblings + Retrieve information regarding the virtual chassis siblings for a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualGuests.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualGuests.md index 7636d87929..c05db4553d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualGuests.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getVirtualGuests + Retrieve a hardware server's virtual servers. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualHost.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualHost.md index c26be81d7a..1775d9dc9c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualHost.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getVirtualHost + Retrieve a piece of hardware's virtual host record. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualLicenses.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualLicenses.md index 7aca93f800..0974221af3 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualLicenses.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualLicenses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getVirtualLicenses + Retrieve information regarding a piece of hardware's virtual software licenses. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualRack.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualRack.md index 728a4aa05e..ee791cd926 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualRack.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualRack.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getVirtualRack + Retrieve information regarding the bandwidth allotment to which a piece of hardware belongs. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualRackId.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualRackId.md index a28e41523b..959967f82f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualRackId.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualRackId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getVirtualRackId + Retrieve the name of the bandwidth allotment belonging to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualRackName.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualRackName.md index 4cfd102919..80aa03365e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualRackName.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualRackName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getVirtualRackName + Retrieve the name of the bandwidth allotment belonging to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualizationPlatform.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualizationPlatform.md index 3ff4d23c1a..4437d13ff5 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualizationPlatform.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getVirtualizationPlatform.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getVirtualizationPlatform + Retrieve a piece of hardware's virtualization platform software. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getWindowsUpdateAvailableUpdates.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getWindowsUpdateAvailableUpdates.md index 387e1989d5..c7e2eb76a7 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getWindowsUpdateAvailableUpdates.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getWindowsUpdateAvailableUpdates.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getWindowsUpdateAvailableUpdates + Retrieve a list of Windows updates available to a server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getWindowsUpdateInstalledUpdates.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getWindowsUpdateInstalledUpdates.md index adb768d734..2c980c2144 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getWindowsUpdateInstalledUpdates.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getWindowsUpdateInstalledUpdates.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getWindowsUpdateInstalledUpdates + Retrieve a list of Windows updates installed on a server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/getWindowsUpdateStatus.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/getWindowsUpdateStatus.md index 79f847a48f..e966500d2a 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/getWindowsUpdateStatus.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/getWindowsUpdateStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::getWindowsUpdateStatus + Retrieve a server's Windows update synchronization status diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/importVirtualHost.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/importVirtualHost.md index b00eb4464e..684212334d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/importVirtualHost.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/importVirtualHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::importVirtualHost + attempt to import the host record for the virtualization platform running on a server diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/initiateIderaBareMetalRestore.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/initiateIderaBareMetalRestore.md index 1c4de2837b..b3b0b8f06b 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/initiateIderaBareMetalRestore.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/initiateIderaBareMetalRestore.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::initiateIderaBareMetalRestore + Initiate an Idera bare metal restore for the server tied to an Idera Server Backup diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/initiateR1SoftBareMetalRestore.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/initiateR1SoftBareMetalRestore.md index ae7b337ac2..417f981b68 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/initiateR1SoftBareMetalRestore.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/initiateR1SoftBareMetalRestore.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::initiateR1SoftBareMetalRestore + Initiate an R1Soft bare metal restore for the server tied to an R1Soft CDP Server diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/isBackendPingable.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/isBackendPingable.md index 6ed5cd9461..9898b7c651 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/isBackendPingable.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/isBackendPingable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::isBackendPingable + Verifies if a server's backend ip address is pingable. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/isPingable.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/isPingable.md index 1b8db254fb..0eec591da5 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/isPingable.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/isPingable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::isPingable + Verifies if server is pingable. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/isWindowsServer.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/isWindowsServer.md index ff717154e1..b840b132da 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/isWindowsServer.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/isWindowsServer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::isWindowsServer + Determine if a server runs the Microsoft Windows operating system. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/massFirmwareReflash.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/massFirmwareReflash.md index d57d49d085..5a9e19e947 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/massFirmwareReflash.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/massFirmwareReflash.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::massFirmwareReflash + Runs firmware reflashes on the servers components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/massFirmwareUpdate.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/massFirmwareUpdate.md index d4829dc04f..2e9f3a5ecd 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/massFirmwareUpdate.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/massFirmwareUpdate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::massFirmwareUpdate + Runs firmware updates on the servers components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/massHyperThreadingUpdate.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/massHyperThreadingUpdate.md index 2274d52de9..324475c16a 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/massHyperThreadingUpdate.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/massHyperThreadingUpdate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::massHyperThreadingUpdate + Runs firmware reflashes on the servers components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/massReloadOperatingSystem.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/massReloadOperatingSystem.md index aac9428765..0010da5612 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/massReloadOperatingSystem.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/massReloadOperatingSystem.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::massReloadOperatingSystem + Reloads operating system configuration on a set of hardware Ids. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/massSparePool.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/massSparePool.md index 0bcee540f1..e3d9135e55 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/massSparePool.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/massSparePool.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::massSparePool + Allows multiple servers to be added to or removed from the spare pool. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/ping.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/ping.md index f4e724c133..5496b619fa 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/ping.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/ping.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::ping + Issues ping command. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/populateServerRam.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/populateServerRam.md index e94b483cc4..e88a7efb6c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/populateServerRam.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/populateServerRam.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/powerCycle.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/powerCycle.md index 328c1d2668..3cd6e9d28c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/powerCycle.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/powerCycle.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::powerCycle + Issues power cycle to server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/powerOff.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/powerOff.md index 8ddb1ad0e0..6282bf14f9 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/powerOff.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/powerOff.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::powerOff + Power off server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/powerOn.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/powerOn.md index 2e1b94610c..779b64b358 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/powerOn.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/powerOn.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::powerOn + Power on server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/rebootDefault.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/rebootDefault.md index b4b3e80acf..378f3014ef 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/rebootDefault.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/rebootDefault.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::rebootDefault + Reboot the server via the default method. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/rebootHard.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/rebootHard.md index bcadba9b89..3567455c49 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/rebootHard.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/rebootHard.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::rebootHard + Reboot the server via "hard" reboot. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/rebootSoft.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/rebootSoft.md index e8d07f878a..85546efb96 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/rebootSoft.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/rebootSoft.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::rebootSoft + Reboot the server via gracefully (soft reboot). diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/reloadCurrentOperatingSystemConfiguration.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/reloadCurrentOperatingSystemConfiguration.md index e6d7af431d..078466cac6 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/reloadCurrentOperatingSystemConfiguration.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/reloadCurrentOperatingSystemConfiguration.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::reloadCurrentOperatingSystemConfiguration + Reloads current operating system configuration. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/reloadOperatingSystem.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/reloadOperatingSystem.md index 8128e5b70e..797aa8ad2a 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/reloadOperatingSystem.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/reloadOperatingSystem.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::reloadOperatingSystem + Reloads operating system configuration. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/removeAccessToNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/removeAccessToNetworkStorage.md index 9099f13784..1261ded406 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/removeAccessToNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/removeAccessToNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::removeAccessToNetworkStorage + Remove access to a SoftLayer_Network_Storage volume from this device. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/removeAccessToNetworkStorageList.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/removeAccessToNetworkStorageList.md index 88ca3cab26..72dc14b4df 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/removeAccessToNetworkStorageList.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/removeAccessToNetworkStorageList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::removeAccessToNetworkStorageList + Remove access to multiple SoftLayer_Network_Storage volumes from this device. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/removeTags.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/removeTags.md index 38822d2c0a..44fa6d19a8 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/removeTags.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/removeTags.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::removeTags + Remove a tag reference diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/runPassmarkCertificationBenchmark.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/runPassmarkCertificationBenchmark.md index 3e27939038..b23746a643 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/runPassmarkCertificationBenchmark.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/runPassmarkCertificationBenchmark.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::runPassmarkCertificationBenchmark + Runs a hardware stress test on the server to obtain a Passmark Certification. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/setOperatingSystemPassword.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/setOperatingSystemPassword.md index 347ad3644a..a0b72e4a90 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/setOperatingSystemPassword.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/setOperatingSystemPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::setOperatingSystemPassword + Changes the password stored in our system for a servers' Operating System diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/setPrivateNetworkInterfaceSpeed.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/setPrivateNetworkInterfaceSpeed.md index ea520c07a4..b0ee9ec005 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/setPrivateNetworkInterfaceSpeed.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/setPrivateNetworkInterfaceSpeed.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::setPrivateNetworkInterfaceSpeed + Set the speed and redundancy configuration of a server's private network interface. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/setPublicNetworkInterfaceSpeed.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/setPublicNetworkInterfaceSpeed.md index 26625195ca..f603d798a1 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/setPublicNetworkInterfaceSpeed.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/setPublicNetworkInterfaceSpeed.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::setPublicNetworkInterfaceSpeed + Set the speed and redundancy configuration of a server's public network interface. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/setTags.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/setTags.md index 2fc732c435..2c8f02ee6e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/setTags.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/setTags.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/setUserMetadata.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/setUserMetadata.md index 01ef481c23..da1ef75130 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/setUserMetadata.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/setUserMetadata.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::setUserMetadata + Sets the server's user metadata value. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/shutdownPrivatePort.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/shutdownPrivatePort.md index bc85c8163f..288a68f1a3 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/shutdownPrivatePort.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/shutdownPrivatePort.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::shutdownPrivatePort + Disconnect a server's private network interface. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/shutdownPublicPort.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/shutdownPublicPort.md index 70c3bacc15..ec3a83d5c9 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/shutdownPublicPort.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/shutdownPublicPort.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::shutdownPublicPort + Disconnect a server's public network interface. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/sparePool.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/sparePool.md index d3428a86d5..6b9916c062 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/sparePool.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/sparePool.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::sparePool + Allows servers to be added to or removed from the spare pool. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/testRaidAlertService.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/testRaidAlertService.md index fe7acea6b1..170a30dbc3 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/testRaidAlertService.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/testRaidAlertService.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::testRaidAlertService + Tests the RAID Alert service. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/toggleManagementInterface.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/toggleManagementInterface.md index cdbd6f40ab..adb9016a64 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/toggleManagementInterface.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/toggleManagementInterface.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::toggleManagementInterface + Toggle the IPMI interface on and off. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/updateIpmiPassword.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/updateIpmiPassword.md index d5824dfa92..7980c56a4a 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/updateIpmiPassword.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/updateIpmiPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::updateIpmiPassword + Update the root IPMI user password diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule/validatePartitionsForOperatingSystem.md b/content/reference/services/SoftLayer_Hardware_SecurityModule/validatePartitionsForOperatingSystem.md index f6d971512d..a993360ea8 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule/validatePartitionsForOperatingSystem.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule/validatePartitionsForOperatingSystem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule](/reference/services/SoftLayer_Hardware_SecurityModule)::validatePartitionsForOperatingSystem + Validates a collection of partitions for an operating system diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/_index.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/_index.md index ca82ccfce9..422bd9f989 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/_index.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/_index.md @@ -22,6 +22,8 @@ classes: + + ### seeAlso * [SoftLayer_Hardware](/reference/services/SoftLayer_Hardware ) @@ -47,1734 +49,2032 @@ classes: #### [activatePrivatePort](/reference/services/SoftLayer_Hardware_SecurityModule750/activatePrivatePort) Activate a server's private network interface. +
              #### [activatePublicPort](/reference/services/SoftLayer_Hardware_SecurityModule750/activatePublicPort) Activate a server's public network interface. +
              #### [allowAccessToNetworkStorage](/reference/services/SoftLayer_Hardware_SecurityModule750/allowAccessToNetworkStorage) Allow access to a SoftLayer_Network_Storage volume from this device. +
              #### [allowAccessToNetworkStorageList](/reference/services/SoftLayer_Hardware_SecurityModule750/allowAccessToNetworkStorageList) Allow access to multiple SoftLayer_Network_Storage volumes from this device. +
              #### [bootToRescueLayer](/reference/services/SoftLayer_Hardware_SecurityModule750/bootToRescueLayer) Initiates the Rescue Kernel to bring a server online to troubleshoot system problems. +
              #### [captureImage](/reference/services/SoftLayer_Hardware_SecurityModule750/captureImage) Captures an Image of the hard disk on the physical machine. +
              #### [createFirmwareReflashTransaction](/reference/services/SoftLayer_Hardware_SecurityModule750/createFirmwareReflashTransaction) Runs firmware reflash on the servers components. +
              #### [createFirmwareUpdateTransaction](/reference/services/SoftLayer_Hardware_SecurityModule750/createFirmwareUpdateTransaction) Runs firmware updates on the servers components. +
              #### [createHyperThreadingUpdateTransaction](/reference/services/SoftLayer_Hardware_SecurityModule750/createHyperThreadingUpdateTransaction) Runs BIOS update on the server to change the hyper-threading configuration. +
              #### [createObject](/reference/services/SoftLayer_Hardware_SecurityModule750/createObject) Create a new server +
              #### [createPostSoftwareInstallTransaction](/reference/services/SoftLayer_Hardware_SecurityModule750/createPostSoftwareInstallTransaction) +
              #### [deleteObject](/reference/services/SoftLayer_Hardware_SecurityModule750/deleteObject) Delete a server +
              #### [deleteSoftwareComponentPasswords](/reference/services/SoftLayer_Hardware_SecurityModule750/deleteSoftwareComponentPasswords) Delete software component passwords. +
              #### [deleteTag](/reference/services/SoftLayer_Hardware_SecurityModule750/deleteTag) Delete a tag +
              #### [editObject](/reference/services/SoftLayer_Hardware_SecurityModule750/editObject) Edit a server's properties +
              #### [editSoftwareComponentPasswords](/reference/services/SoftLayer_Hardware_SecurityModule750/editSoftwareComponentPasswords) Edit the properties of software component passwords. +
              #### [executeRemoteScript](/reference/services/SoftLayer_Hardware_SecurityModule750/executeRemoteScript) Download and run remote script from uri on the hardware. Requires https for script to be executed after download. +
              #### [findByIpAddress](/reference/services/SoftLayer_Hardware_SecurityModule750/findByIpAddress) Find hardware by its primary public or private IP (ipv4) address. +
              #### [generateOrderTemplate](/reference/services/SoftLayer_Hardware_SecurityModule750/generateOrderTemplate) Obtain an order container for a given template object +
              #### [getAccount](/reference/services/SoftLayer_Hardware_SecurityModule750/getAccount) Retrieve the account associated with a piece of hardware. +
              #### [getActiveComponents](/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveComponents) Retrieve a piece of hardware's active physical components. +
              #### [getActiveNetworkFirewallBillingItem](/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveNetworkFirewallBillingItem) Retrieve the billing item for a server's attached network firewall. +
              #### [getActiveNetworkMonitorIncident](/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveNetworkMonitorIncident) Retrieve a piece of hardware's active network monitoring incidents. +
              #### [getActiveTickets](/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveTickets) +
              #### [getActiveTransaction](/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveTransaction) Retrieve transaction currently running for server. +
              #### [getActiveTransactions](/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveTransactions) Retrieve any active transaction(s) that are currently running for the server (example: os reload). +
              #### [getAllPowerComponents](/reference/services/SoftLayer_Hardware_SecurityModule750/getAllPowerComponents) +
              #### [getAllowedHost](/reference/services/SoftLayer_Hardware_SecurityModule750/getAllowedHost) Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. +
              #### [getAllowedNetworkStorage](/reference/services/SoftLayer_Hardware_SecurityModule750/getAllowedNetworkStorage) Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. +
              #### [getAllowedNetworkStorageReplicas](/reference/services/SoftLayer_Hardware_SecurityModule750/getAllowedNetworkStorageReplicas) Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. +
              #### [getAntivirusSpywareSoftwareComponent](/reference/services/SoftLayer_Hardware_SecurityModule750/getAntivirusSpywareSoftwareComponent) Retrieve information regarding an antivirus/spyware software component object. +
              #### [getAttachedNetworkStorages](/reference/services/SoftLayer_Hardware_SecurityModule750/getAttachedNetworkStorages) Return a list of SoftLayer_Network_Storage volumes authorized to this device. +
              #### [getAttributes](/reference/services/SoftLayer_Hardware_SecurityModule750/getAttributes) Retrieve information regarding a piece of hardware's specific attributes. +
              #### [getAvailableBillingTermChangePrices](/reference/services/SoftLayer_Hardware_SecurityModule750/getAvailableBillingTermChangePrices) Retrieves a list of available term prices available to this of hardware. +
              #### [getAvailableMonitoring](/reference/services/SoftLayer_Hardware_SecurityModule750/getAvailableMonitoring) Retrieve an object that stores the maximum level for the monitoring query types and response types. +
              #### [getAvailableNetworkStorages](/reference/services/SoftLayer_Hardware_SecurityModule750/getAvailableNetworkStorages) Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. +
              #### [getAverageDailyBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule750/getAverageDailyBandwidthUsage) Retrieve the average daily total bandwidth usage for the current billing cycle. +
              #### [getAverageDailyPrivateBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule750/getAverageDailyPrivateBandwidthUsage) Retrieve the average daily private bandwidth usage for the current billing cycle. +
              #### [getAverageDailyPublicBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule750/getAverageDailyPublicBandwidthUsage) Retrieve the average daily public bandwidth usage for the current billing cycle. +
              #### [getBackendBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendBandwidthUsage) Retrieves public bandwidth usage records. +
              -
              +
              #### [getBackendBandwidthUse](/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendBandwidthUse) Retrieves private bandwidth usage records. + +Deprecated + +
              #### [getBackendIncomingBandwidth](/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendIncomingBandwidth) Retrieve the amount of incoming private network bandwidth used by a server over a period of time. +
              #### [getBackendNetworkComponents](/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendNetworkComponents) Retrieve a piece of hardware's back-end or private network components. +
              #### [getBackendOutgoingBandwidth](/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendOutgoingBandwidth) Retrieve the amount of outgoing private network bandwidth used by a server over a period of time. +
              #### [getBackendRouters](/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendRouters) Retrieve a hardware's backend or private router. +
              #### [getBandwidthAllocation](/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthAllocation) Retrieve a hardware's allotted bandwidth (measured in GB). +
              #### [getBandwidthAllotmentDetail](/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthAllotmentDetail) Retrieve a hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. +
              #### [getBandwidthForDateRange](/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthForDateRange) Retrieve bandwidth data from a tracking object. +
              #### [getBandwidthImage](/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthImage) Retrieve a bandwidth image and textual description of that image for this server. +
              #### [getBenchmarkCertifications](/reference/services/SoftLayer_Hardware_SecurityModule750/getBenchmarkCertifications) Retrieve information regarding a piece of hardware's benchmark certifications. +
              #### [getBillingCycleBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingCycleBandwidthUsage) Retrieve the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. +
              #### [getBillingCyclePrivateBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingCyclePrivateBandwidthUsage) Retrieve the raw private bandwidth usage data for the current billing cycle. +
              #### [getBillingCyclePublicBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingCyclePublicBandwidthUsage) Retrieve the raw public bandwidth usage data for the current billing cycle. +
              #### [getBillingItem](/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingItem) Retrieve information regarding the billing item for a server. +
              #### [getBillingItemFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingItemFlag) Retrieve a flag indicating that a billing item exists. +
              #### [getBiosPasswordNullFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getBiosPasswordNullFlag) Retrieve determine if BIOS password should be left as null. +
              #### [getBlockCancelBecauseDisconnectedFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getBlockCancelBecauseDisconnectedFlag) Retrieve determines whether the hardware is ineligible for cancellation because it is disconnected. +
              #### [getBootModeOptions](/reference/services/SoftLayer_Hardware_SecurityModule750/getBootModeOptions) Retrieve the valid boot modes for this server. +
              #### [getBusinessContinuanceInsuranceFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getBusinessContinuanceInsuranceFlag) Retrieve status indicating whether or not a piece of hardware has business continuance insurance. +
              #### [getCaptureEnabledFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getCaptureEnabledFlag) Retrieve determine if the server is able to be image captured. If unable to image capture a reason will be provided. +
              #### [getChildrenHardware](/reference/services/SoftLayer_Hardware_SecurityModule750/getChildrenHardware) Retrieve child hardware. +
              #### [getComponentDetailsXML](/reference/services/SoftLayer_Hardware_SecurityModule750/getComponentDetailsXML) +
              #### [getComponents](/reference/services/SoftLayer_Hardware_SecurityModule750/getComponents) Retrieve a piece of hardware's components. +
              #### [getContainsSolidStateDrivesFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getContainsSolidStateDrivesFlag) +
              #### [getContinuousDataProtectionSoftwareComponent](/reference/services/SoftLayer_Hardware_SecurityModule750/getContinuousDataProtectionSoftwareComponent) Retrieve a continuous data protection/server backup software component object. +
              #### [getControlPanel](/reference/services/SoftLayer_Hardware_SecurityModule750/getControlPanel) Retrieve a server's control panel. +
              #### [getCost](/reference/services/SoftLayer_Hardware_SecurityModule750/getCost) Retrieve the total cost of a server, measured in US Dollars ($USD). +
              #### [getCreateObjectOptions](/reference/services/SoftLayer_Hardware_SecurityModule750/getCreateObjectOptions) Determine options available when creating a server +
              #### [getCurrentBandwidthSummary](/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBandwidthSummary) Retrieve an object that provides commonly used bandwidth summary components for the current billing cycle. +
              #### [getCurrentBenchmarkCertificationResultFile](/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBenchmarkCertificationResultFile) Get the file for the current benchmark certification result, if it exists. +
              #### [getCurrentBillableBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBillableBandwidthUsage) Retrieve the current billable public outbound bandwidth for this hardware for the current billing cycle. +
              #### [getCurrentBillingDetail](/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBillingDetail) << EOT +
              #### [getCurrentBillingTotal](/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBillingTotal) Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges. +
              #### [getCustomBandwidthDataByDate](/reference/services/SoftLayer_Hardware_SecurityModule750/getCustomBandwidthDataByDate) Retrieve bandwidth graph by date. +
              #### [getCustomerInstalledOperatingSystemFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getCustomerInstalledOperatingSystemFlag) Retrieve indicates if a server has a Customer Installed OS +
              #### [getCustomerOwnedFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getCustomerOwnedFlag) Retrieve indicates if a server is a customer owned device. +
              #### [getDailyAverage](/reference/services/SoftLayer_Hardware_SecurityModule750/getDailyAverage) calculate the average daily network traffic used by a server in gigabytes. +
              #### [getDatacenter](/reference/services/SoftLayer_Hardware_SecurityModule750/getDatacenter) Retrieve information regarding the datacenter in which a piece of hardware resides. +
              #### [getDatacenterName](/reference/services/SoftLayer_Hardware_SecurityModule750/getDatacenterName) Retrieve the name of the datacenter in which a piece of hardware resides. +
              #### [getDaysInSparePool](/reference/services/SoftLayer_Hardware_SecurityModule750/getDaysInSparePool) Retrieve number of day(s) a server have been in spare pool. +
              #### [getDownlinkHardware](/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkHardware) Retrieve all hardware that has uplink network connections to a piece of hardware. +
              #### [getDownlinkNetworkHardware](/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkNetworkHardware) Retrieve all hardware that has uplink network connections to a piece of hardware. +
              #### [getDownlinkServers](/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkServers) Retrieve information regarding all servers attached to a piece of network hardware. +
              #### [getDownlinkVirtualGuests](/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkVirtualGuests) Retrieve information regarding all virtual guests attached to a piece of network hardware. +
              #### [getDownstreamHardwareBindings](/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamHardwareBindings) Retrieve all hardware downstream from a network device. +
              #### [getDownstreamNetworkHardware](/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamNetworkHardware) Retrieve all network hardware downstream from the selected piece of hardware. +
              #### [getDownstreamNetworkHardwareWithIncidents](/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamNetworkHardwareWithIncidents) Retrieve all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. +
              #### [getDownstreamServers](/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamServers) Retrieve information regarding all servers attached downstream to a piece of network hardware. +
              #### [getDownstreamVirtualGuests](/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamVirtualGuests) Retrieve information regarding all virtual guests attached to a piece of network hardware. +
              #### [getDriveControllers](/reference/services/SoftLayer_Hardware_SecurityModule750/getDriveControllers) Retrieve the drive controllers contained within a piece of hardware. +
              #### [getEvaultNetworkStorage](/reference/services/SoftLayer_Hardware_SecurityModule750/getEvaultNetworkStorage) Retrieve information regarding a piece of hardware's associated EVault network storage service account. +
              #### [getFirewallProtectableSubnets](/reference/services/SoftLayer_Hardware_SecurityModule750/getFirewallProtectableSubnets) Get the subnets associated with this server that are protectable by a network component firewall. +
              #### [getFirewallServiceComponent](/reference/services/SoftLayer_Hardware_SecurityModule750/getFirewallServiceComponent) Retrieve information regarding a piece of hardware's firewall services. +
              #### [getFixedConfigurationPreset](/reference/services/SoftLayer_Hardware_SecurityModule750/getFixedConfigurationPreset) Retrieve defines the fixed components in a fixed configuration bare metal server. +
              #### [getFrontendBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendBandwidthUsage) Retrieves public bandwidth usage records. +
              -
              +
              #### [getFrontendBandwidthUse](/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendBandwidthUse) Retrieves public bandwidth usage records. + +Deprecated + +
              #### [getFrontendIncomingBandwidth](/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendIncomingBandwidth) Retrieve the amount of incoming public network bandwidth used by a server over a period of time. +
              #### [getFrontendNetworkComponents](/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendNetworkComponents) Retrieve a piece of hardware's front-end or public network components. +
              #### [getFrontendOutgoingBandwidth](/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendOutgoingBandwidth) Retrieve the amount of outgoing public network bandwidth used by a server over a period of time. +
              #### [getFrontendRouters](/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendRouters) Retrieve a hardware's frontend or public router. +
              #### [getFutureBillingItem](/reference/services/SoftLayer_Hardware_SecurityModule750/getFutureBillingItem) Retrieve information regarding the future billing item for a server. +
              #### [getGlobalIdentifier](/reference/services/SoftLayer_Hardware_SecurityModule750/getGlobalIdentifier) Retrieve a hardware's universally unique identifier. +
              #### [getHardDrives](/reference/services/SoftLayer_Hardware_SecurityModule750/getHardDrives) Retrieve the hard drives contained within a piece of hardware. +
              #### [getHardwareByIpAddress](/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareByIpAddress) Retrieve a SoftLayer_Hardware_Server object by IP address. +
              #### [getHardwareChassis](/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareChassis) Retrieve the chassis that a piece of hardware is housed in. +
              #### [getHardwareFunction](/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareFunction) Retrieve a hardware's function. +
              #### [getHardwareFunctionDescription](/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareFunctionDescription) Retrieve a hardware's function. +
              #### [getHardwareStatus](/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareStatus) Retrieve a hardware's status. +
              #### [getHasSingleRootVirtualizationBillingItemFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getHasSingleRootVirtualizationBillingItemFlag) Retrieve determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item. +
              #### [getHasTrustedPlatformModuleBillingItemFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getHasTrustedPlatformModuleBillingItemFlag) Retrieve determine in hardware object has TPM enabled. +
              #### [getHostIpsSoftwareComponent](/reference/services/SoftLayer_Hardware_SecurityModule750/getHostIpsSoftwareComponent) Retrieve information regarding a host IPS software component object. +
              #### [getHourlyBandwidth](/reference/services/SoftLayer_Hardware_SecurityModule750/getHourlyBandwidth) Retrieves bandwidth hourly over a 24-hour period for the specified hardware. +
              #### [getHourlyBillingFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getHourlyBillingFlag) Retrieve a server's hourly billing status. +
              #### [getInboundBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule750/getInboundBandwidthUsage) Retrieve the sum of all the inbound network traffic data for the last 30 days. +
              #### [getInboundPrivateBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule750/getInboundPrivateBandwidthUsage) Retrieve the total private inbound bandwidth for this hardware for the current billing cycle. +
              #### [getInboundPublicBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule750/getInboundPublicBandwidthUsage) Retrieve the total public inbound bandwidth for this hardware for the current billing cycle. +
              #### [getIsBillingTermChangeAvailableFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getIsBillingTermChangeAvailableFlag) Retrieve whether or not this hardware object is eligible to change to term billing. +
              #### [getIsCloudReadyNodeCertified](/reference/services/SoftLayer_Hardware_SecurityModule750/getIsCloudReadyNodeCertified) Retrieve determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute. +
              #### [getIsIpmiDisabled](/reference/services/SoftLayer_Hardware_SecurityModule750/getIsIpmiDisabled) Retrieve determine if remote management has been disabled due to port speed. +
              #### [getIsVirtualPrivateCloudNode](/reference/services/SoftLayer_Hardware_SecurityModule750/getIsVirtualPrivateCloudNode) Retrieve determine if hardware object is a Virtual Private Cloud node. +
              #### [getItemPricesFromSoftwareDescriptions](/reference/services/SoftLayer_Hardware_SecurityModule750/getItemPricesFromSoftwareDescriptions) Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description +
              #### [getLastOperatingSystemReload](/reference/services/SoftLayer_Hardware_SecurityModule750/getLastOperatingSystemReload) Retrieve the last transaction that a server's operating system was loaded. +
              #### [getLastTransaction](/reference/services/SoftLayer_Hardware_SecurityModule750/getLastTransaction) Retrieve information regarding the last transaction a server performed. +
              #### [getLatestNetworkMonitorIncident](/reference/services/SoftLayer_Hardware_SecurityModule750/getLatestNetworkMonitorIncident) Retrieve a piece of hardware's latest network monitoring incident. +
              #### [getLocation](/reference/services/SoftLayer_Hardware_SecurityModule750/getLocation) Retrieve where a piece of hardware is located within SoftLayer's location hierarchy. +
              #### [getLocationPathString](/reference/services/SoftLayer_Hardware_SecurityModule750/getLocationPathString) +
              #### [getLockboxNetworkStorage](/reference/services/SoftLayer_Hardware_SecurityModule750/getLockboxNetworkStorage) Retrieve information regarding a lockbox account associated with a server. +
              #### [getLogicalVolumeStorageGroups](/reference/services/SoftLayer_Hardware_SecurityModule750/getLogicalVolumeStorageGroups) Retrieve returns a list of logical volumes on the physical machine. +
              #### [getManagedResourceFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getManagedResourceFlag) Retrieve a flag indicating that the hardware is a managed resource. +
              #### [getManagementNetworkComponent](/reference/services/SoftLayer_Hardware_SecurityModule750/getManagementNetworkComponent) Retrieve a server's management network component. +
              #### [getMemory](/reference/services/SoftLayer_Hardware_SecurityModule750/getMemory) Retrieve information regarding a piece of hardware's memory. +
              #### [getMemoryCapacity](/reference/services/SoftLayer_Hardware_SecurityModule750/getMemoryCapacity) Retrieve the amount of memory a piece of hardware has, measured in gigabytes. +
              #### [getMetricTrackingObject](/reference/services/SoftLayer_Hardware_SecurityModule750/getMetricTrackingObject) Retrieve a piece of hardware's metric tracking object. +
              #### [getMetricTrackingObjectId](/reference/services/SoftLayer_Hardware_SecurityModule750/getMetricTrackingObjectId) Retrieve the metric tracking object id for this server. +
              #### [getModules](/reference/services/SoftLayer_Hardware_SecurityModule750/getModules) +
              #### [getMonitoringRobot](/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringRobot) +
              #### [getMonitoringServiceComponent](/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringServiceComponent) Retrieve information regarding a piece of hardware's network monitoring services. +
              #### [getMonitoringServiceEligibilityFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringServiceEligibilityFlag) +
              #### [getMonitoringUserNotification](/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringUserNotification) Retrieve the monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails +
              #### [getMotherboard](/reference/services/SoftLayer_Hardware_SecurityModule750/getMotherboard) Retrieve a server's motherboard. +
              #### [getNetworkCards](/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkCards) Retrieve information regarding a piece of hardware's network cards. +
              #### [getNetworkComponentFirewallProtectableIpAddresses](/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkComponentFirewallProtectableIpAddresses) Get the IP addresses associated with this server that are protectable by a network component firewall. +
              #### [getNetworkComponents](/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkComponents) Retrieve returns a hardware's network components. +
              #### [getNetworkGatewayMember](/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkGatewayMember) Retrieve the gateway member if this device is part of a network gateway. +
              #### [getNetworkGatewayMemberFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkGatewayMemberFlag) Retrieve whether or not this device is part of a network gateway. +
              #### [getNetworkManagementIpAddress](/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkManagementIpAddress) Retrieve a piece of hardware's network management IP address. +
              #### [getNetworkMonitorAttachedDownHardware](/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitorAttachedDownHardware) Retrieve all servers with failed monitoring that are attached downstream to a piece of hardware. +
              #### [getNetworkMonitorAttachedDownVirtualGuests](/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitorAttachedDownVirtualGuests) Retrieve virtual guests that are attached downstream to a hardware that have failed monitoring +
              #### [getNetworkMonitorIncidents](/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitorIncidents) Retrieve the status of all of a piece of hardware's network monitoring incidents. +
              #### [getNetworkMonitors](/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitors) Retrieve information regarding a piece of hardware's network monitors. +
              #### [getNetworkStatus](/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStatus) Retrieve the value of a hardware's network status attribute. +
              #### [getNetworkStatusAttribute](/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStatusAttribute) Retrieve the hardware's related network status attribute. +
              #### [getNetworkStorage](/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStorage) Retrieve information regarding a piece of hardware's associated network storage service account. +
              #### [getNetworkVlans](/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkVlans) Retrieve the network virtual LANs (VLANs) associated with a piece of hardware's network components. +
              #### [getNextBillingCycleBandwidthAllocation](/reference/services/SoftLayer_Hardware_SecurityModule750/getNextBillingCycleBandwidthAllocation) Retrieve a hardware's allotted bandwidth for the next billing cycle (measured in GB). +
              #### [getNotesHistory](/reference/services/SoftLayer_Hardware_SecurityModule750/getNotesHistory) +
              #### [getNvRamCapacity](/reference/services/SoftLayer_Hardware_SecurityModule750/getNvRamCapacity) Retrieve the amount of non-volatile memory a piece of hardware has, measured in gigabytes. +
              #### [getNvRamComponentModels](/reference/services/SoftLayer_Hardware_SecurityModule750/getNvRamComponentModels) +
              #### [getObject](/reference/services/SoftLayer_Hardware_SecurityModule750/getObject) Retrieve a SoftLayer_Hardware_SecurityModule750 record. +
              #### [getOpenCancellationTicket](/reference/services/SoftLayer_Hardware_SecurityModule750/getOpenCancellationTicket) Retrieve an open ticket requesting cancellation of this server, if one exists. +
              #### [getOperatingSystem](/reference/services/SoftLayer_Hardware_SecurityModule750/getOperatingSystem) Retrieve information regarding a piece of hardware's operating system. +
              #### [getOperatingSystemReferenceCode](/reference/services/SoftLayer_Hardware_SecurityModule750/getOperatingSystemReferenceCode) Retrieve a hardware's operating system software description. +
              #### [getOutboundBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule750/getOutboundBandwidthUsage) Retrieve the sum of all the outbound network traffic data for the last 30 days. +
              #### [getOutboundPrivateBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule750/getOutboundPrivateBandwidthUsage) Retrieve the total private outbound bandwidth for this hardware for the current billing cycle. +
              #### [getOutboundPublicBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule750/getOutboundPublicBandwidthUsage) Retrieve the total public outbound bandwidth for this hardware for the current billing cycle. +
              #### [getOverBandwidthAllocationFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getOverBandwidthAllocationFlag) Retrieve whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation. +
              #### [getPMInfo](/reference/services/SoftLayer_Hardware_SecurityModule750/getPMInfo) Retrieve a server's hardware state via its internal sensors. +
              #### [getParentBay](/reference/services/SoftLayer_Hardware_SecurityModule750/getParentBay) Retrieve blade Bay +
              #### [getParentHardware](/reference/services/SoftLayer_Hardware_SecurityModule750/getParentHardware) Retrieve parent Hardware. +
              #### [getPartitions](/reference/services/SoftLayer_Hardware_SecurityModule750/getPartitions) +
              #### [getPointOfPresenceLocation](/reference/services/SoftLayer_Hardware_SecurityModule750/getPointOfPresenceLocation) Retrieve information regarding the Point of Presence (PoP) location in which a piece of hardware resides. +
              #### [getPowerComponents](/reference/services/SoftLayer_Hardware_SecurityModule750/getPowerComponents) Retrieve the power components for a hardware object. +
              #### [getPowerSupply](/reference/services/SoftLayer_Hardware_SecurityModule750/getPowerSupply) Retrieve a server's power supply. +
              #### [getPrimaryBackendIpAddress](/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryBackendIpAddress) Retrieve the hardware's primary private IP address. +
              #### [getPrimaryDriveSize](/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryDriveSize) +
              #### [getPrimaryIpAddress](/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryIpAddress) Retrieve the hardware's primary public IP address. +
              #### [getPrivateBandwidthData](/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthData) Retrieve a graph of a server's private network usage. +
              #### [getPrivateBandwidthDataSummary](/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthDataSummary) Retrieve a server's private bandwidth usage summary +
              #### [getPrivateBandwidthGraphImage](/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthGraphImage) Retrieve a graph of a server's private network usage. +
              #### [getPrivateIpAddress](/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateIpAddress) Retrieve a server's primary private IP address. +
              #### [getPrivateNetworkComponent](/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateNetworkComponent) Retrieve a server's private network component. +
              #### [getPrivateNetworkOnlyFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateNetworkOnlyFlag) Retrieve whether the hardware only has access to the private network. +
              #### [getPrivateVlan](/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateVlan) Retrieve the backend VLAN for the primary IP address of the server. +
              -
              +
              #### [getPrivateVlanByIpAddress](/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateVlanByIpAddress) Retrieve a backend network VLAN by searching for an IP address. + +Deprecated + +
              #### [getProcessorCoreAmount](/reference/services/SoftLayer_Hardware_SecurityModule750/getProcessorCoreAmount) Retrieve the total number of processor cores, summed from all processors that are attached to a piece of hardware +
              #### [getProcessorPhysicalCoreAmount](/reference/services/SoftLayer_Hardware_SecurityModule750/getProcessorPhysicalCoreAmount) Retrieve the total number of physical processor cores, summed from all processors that are attached to a piece of hardware +
              #### [getProcessors](/reference/services/SoftLayer_Hardware_SecurityModule750/getProcessors) Retrieve information regarding a piece of hardware's processors. +
              #### [getProjectedOverBandwidthAllocationFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getProjectedOverBandwidthAllocationFlag) Retrieve whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation. +
              #### [getProjectedPublicBandwidthUsage](/reference/services/SoftLayer_Hardware_SecurityModule750/getProjectedPublicBandwidthUsage) Retrieve the projected public outbound bandwidth for this hardware for the current billing cycle. +
              #### [getProvisionDate](/reference/services/SoftLayer_Hardware_SecurityModule750/getProvisionDate) +
              #### [getPublicBandwidthData](/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthData) Retrieve a graph of a server's public network usage. +
              #### [getPublicBandwidthDataSummary](/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthDataSummary) Retrieve a server's public bandwidth usage summary +
              #### [getPublicBandwidthGraphImage](/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthGraphImage) Retrieve a graph of a server's public network usage. +
              #### [getPublicBandwidthTotal](/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthTotal) Retrieve total number of public bytes used by a server over time period specified. +
              #### [getPublicNetworkComponent](/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicNetworkComponent) Retrieve a server's public network component. +
              #### [getPublicVlan](/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicVlan) Retrieve the frontend VLAN for the primary IP address of the server +
              #### [getPublicVlanByHostname](/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicVlanByHostname) Retrieve the frontend VLAN by a server's hostname. +
              #### [getRack](/reference/services/SoftLayer_Hardware_SecurityModule750/getRack) +
              #### [getRaidControllers](/reference/services/SoftLayer_Hardware_SecurityModule750/getRaidControllers) Retrieve the RAID controllers contained within a piece of hardware. +
              #### [getReadyNodeFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getReadyNodeFlag) Retrieve determine if hardware object is vSan Ready Node. +
              #### [getRecentEvents](/reference/services/SoftLayer_Hardware_SecurityModule750/getRecentEvents) Retrieve recent events that impact this hardware. +
              #### [getRecentRemoteManagementCommands](/reference/services/SoftLayer_Hardware_SecurityModule750/getRecentRemoteManagementCommands) Retrieve the last five commands issued to the server's remote management card. +
              #### [getRegionalInternetRegistry](/reference/services/SoftLayer_Hardware_SecurityModule750/getRegionalInternetRegistry) +
              #### [getRemoteManagement](/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagement) Retrieve a server's remote management card. +
              #### [getRemoteManagementAccounts](/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagementAccounts) Retrieve user credentials to issue commands and/or interact with the server's remote management card. +
              #### [getRemoteManagementComponent](/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagementComponent) Retrieve a hardware's associated remote management component. This is normally IPMI. +
              #### [getRemoteManagementUsers](/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagementUsers) Retrieve user(s) who have access to issue commands and/or interact with the server's remote management card. +
              #### [getResourceConfigurations](/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceConfigurations) +
              #### [getResourceGroupMemberReferences](/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceGroupMemberReferences) +
              #### [getResourceGroupRoles](/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceGroupRoles) +
              #### [getResourceGroups](/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceGroups) Retrieve the resource groups in which this hardware is a member. +
              #### [getReverseDomainRecords](/reference/services/SoftLayer_Hardware_SecurityModule750/getReverseDomainRecords) Retrieve the reverse domain records associated with a server. +
              #### [getRouters](/reference/services/SoftLayer_Hardware_SecurityModule750/getRouters) Retrieve a hardware's routers. +
              #### [getScaleAssets](/reference/services/SoftLayer_Hardware_SecurityModule750/getScaleAssets) Retrieve collection of scale assets this hardware corresponds to. +
              #### [getSecurityScanRequests](/reference/services/SoftLayer_Hardware_SecurityModule750/getSecurityScanRequests) Retrieve information regarding a piece of hardware's vulnerability scan requests. +
              #### [getSensorData](/reference/services/SoftLayer_Hardware_SecurityModule750/getSensorData) Retrieve a server's hardware state via its internal sensors. +
              #### [getSensorDataWithGraphs](/reference/services/SoftLayer_Hardware_SecurityModule750/getSensorDataWithGraphs) Retrieve server's temperature and fan speed graphs as well the sensor raw data. +
              #### [getServerDetails](/reference/services/SoftLayer_Hardware_SecurityModule750/getServerDetails) Retrieve a server's hardware components, software, and network components. +
              #### [getServerFanSpeedGraphs](/reference/services/SoftLayer_Hardware_SecurityModule750/getServerFanSpeedGraphs) Retrieve server's fan speed graphs. +
              #### [getServerPowerState](/reference/services/SoftLayer_Hardware_SecurityModule750/getServerPowerState) Retrieves server's power state +
              #### [getServerRoom](/reference/services/SoftLayer_Hardware_SecurityModule750/getServerRoom) Retrieve information regarding the server room in which the hardware is located. +
              #### [getServerTemperatureGraphs](/reference/services/SoftLayer_Hardware_SecurityModule750/getServerTemperatureGraphs) Retrieve server's temperature graphs +
              #### [getServiceProvider](/reference/services/SoftLayer_Hardware_SecurityModule750/getServiceProvider) Retrieve information regarding the piece of hardware's service provider. +
              #### [getSoftwareComponents](/reference/services/SoftLayer_Hardware_SecurityModule750/getSoftwareComponents) Retrieve information regarding a piece of hardware's installed software. +
              #### [getSoftwareGuardExtensionEnabled](/reference/services/SoftLayer_Hardware_SecurityModule750/getSoftwareGuardExtensionEnabled) Retrieve determine if hardware object has Software Guard Extension (SGX) enabled. +
              #### [getSshKeys](/reference/services/SoftLayer_Hardware_SecurityModule750/getSshKeys) Retrieve sSH keys to be installed on the server during provisioning or an OS reload. +
              #### [getStatisticsRemoteManagement](/reference/services/SoftLayer_Hardware_SecurityModule750/getStatisticsRemoteManagement) Retrieve a server's remote management card used for statistics. +
              #### [getStorageGroups](/reference/services/SoftLayer_Hardware_SecurityModule750/getStorageGroups) +
              #### [getStorageNetworkComponents](/reference/services/SoftLayer_Hardware_SecurityModule750/getStorageNetworkComponents) Retrieve a piece of hardware's private storage network components. [Deprecated] +
              #### [getTagReferences](/reference/services/SoftLayer_Hardware_SecurityModule750/getTagReferences) +
              #### [getTopLevelLocation](/reference/services/SoftLayer_Hardware_SecurityModule750/getTopLevelLocation) +
              #### [getTransactionHistory](/reference/services/SoftLayer_Hardware_SecurityModule750/getTransactionHistory) Get transaction history for a piece of hardware. +
              #### [getUefiBootFlag](/reference/services/SoftLayer_Hardware_SecurityModule750/getUefiBootFlag) Retrieve whether to use UEFI boot instead of BIOS. +
              #### [getUpgradeItemPrices](/reference/services/SoftLayer_Hardware_SecurityModule750/getUpgradeItemPrices) Retrieve a list of upgradable items available to a piece of hardware. +
              #### [getUpgradeRequest](/reference/services/SoftLayer_Hardware_SecurityModule750/getUpgradeRequest) Retrieve an account's associated upgrade request object, if any. +
              #### [getUplinkHardware](/reference/services/SoftLayer_Hardware_SecurityModule750/getUplinkHardware) Retrieve the network device connected to a piece of hardware. +
              #### [getUplinkNetworkComponents](/reference/services/SoftLayer_Hardware_SecurityModule750/getUplinkNetworkComponents) Retrieve information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. +
              #### [getUserData](/reference/services/SoftLayer_Hardware_SecurityModule750/getUserData) Retrieve an array containing a single string of custom user data for a hardware order. Max size is 16 kb. +
              #### [getUsers](/reference/services/SoftLayer_Hardware_SecurityModule750/getUsers) Retrieve a list of users that have access to this computing instance. +
              #### [getValidBlockDeviceTemplateGroups](/reference/services/SoftLayer_Hardware_SecurityModule750/getValidBlockDeviceTemplateGroups) Return a list of valid block device template groups based on this host +
              #### [getVirtualChassis](/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualChassis) Retrieve information regarding the virtual chassis for a piece of hardware. +
              #### [getVirtualChassisSiblings](/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualChassisSiblings) Retrieve information regarding the virtual chassis siblings for a piece of hardware. +
              #### [getVirtualGuests](/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualGuests) Retrieve a hardware server's virtual servers. +
              #### [getVirtualHost](/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualHost) Retrieve a piece of hardware's virtual host record. +
              #### [getVirtualLicenses](/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualLicenses) Retrieve information regarding a piece of hardware's virtual software licenses. +
              #### [getVirtualRack](/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualRack) Retrieve information regarding the bandwidth allotment to which a piece of hardware belongs. +
              #### [getVirtualRackId](/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualRackId) Retrieve the name of the bandwidth allotment belonging to a piece of hardware. +
              #### [getVirtualRackName](/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualRackName) Retrieve the name of the bandwidth allotment belonging to a piece of hardware. +
              #### [getVirtualizationPlatform](/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualizationPlatform) Retrieve a piece of hardware's virtualization platform software. +
              #### [getWindowsUpdateAvailableUpdates](/reference/services/SoftLayer_Hardware_SecurityModule750/getWindowsUpdateAvailableUpdates) Retrieve a list of Windows updates available to a server. +
              #### [getWindowsUpdateInstalledUpdates](/reference/services/SoftLayer_Hardware_SecurityModule750/getWindowsUpdateInstalledUpdates) Retrieve a list of Windows updates installed on a server. +
              #### [getWindowsUpdateStatus](/reference/services/SoftLayer_Hardware_SecurityModule750/getWindowsUpdateStatus) Retrieve a server's Windows update synchronization status +
              #### [importVirtualHost](/reference/services/SoftLayer_Hardware_SecurityModule750/importVirtualHost) attempt to import the host record for the virtualization platform running on a server +
              #### [initiateIderaBareMetalRestore](/reference/services/SoftLayer_Hardware_SecurityModule750/initiateIderaBareMetalRestore) Initiate an Idera bare metal restore for the server tied to an Idera Server Backup +
              #### [initiateR1SoftBareMetalRestore](/reference/services/SoftLayer_Hardware_SecurityModule750/initiateR1SoftBareMetalRestore) Initiate an R1Soft bare metal restore for the server tied to an R1Soft CDP Server +
              #### [isBackendPingable](/reference/services/SoftLayer_Hardware_SecurityModule750/isBackendPingable) Verifies if a server's backend ip address is pingable. +
              #### [isPingable](/reference/services/SoftLayer_Hardware_SecurityModule750/isPingable) Verifies if server is pingable. +
              #### [isWindowsServer](/reference/services/SoftLayer_Hardware_SecurityModule750/isWindowsServer) Determine if a server runs the Microsoft Windows operating system. +
              #### [massFirmwareReflash](/reference/services/SoftLayer_Hardware_SecurityModule750/massFirmwareReflash) Runs firmware reflashes on the servers components. +
              #### [massFirmwareUpdate](/reference/services/SoftLayer_Hardware_SecurityModule750/massFirmwareUpdate) Runs firmware updates on the servers components. +
              #### [massHyperThreadingUpdate](/reference/services/SoftLayer_Hardware_SecurityModule750/massHyperThreadingUpdate) Runs firmware reflashes on the servers components. +
              #### [massReloadOperatingSystem](/reference/services/SoftLayer_Hardware_SecurityModule750/massReloadOperatingSystem) Reloads operating system configuration on a set of hardware Ids. +
              #### [massSparePool](/reference/services/SoftLayer_Hardware_SecurityModule750/massSparePool) Allows multiple servers to be added to or removed from the spare pool. +
              #### [ping](/reference/services/SoftLayer_Hardware_SecurityModule750/ping) Issues ping command. +
              #### [populateServerRam](/reference/services/SoftLayer_Hardware_SecurityModule750/populateServerRam) +
              #### [powerCycle](/reference/services/SoftLayer_Hardware_SecurityModule750/powerCycle) Issues power cycle to server. +
              #### [powerOff](/reference/services/SoftLayer_Hardware_SecurityModule750/powerOff) Power off server. +
              #### [powerOn](/reference/services/SoftLayer_Hardware_SecurityModule750/powerOn) Power on server. +
              #### [rebootDefault](/reference/services/SoftLayer_Hardware_SecurityModule750/rebootDefault) Reboot the server via the default method. +
              #### [rebootHard](/reference/services/SoftLayer_Hardware_SecurityModule750/rebootHard) Reboot the server via "hard" reboot. +
              #### [rebootSoft](/reference/services/SoftLayer_Hardware_SecurityModule750/rebootSoft) Reboot the server via gracefully (soft reboot). +
              #### [reloadCurrentOperatingSystemConfiguration](/reference/services/SoftLayer_Hardware_SecurityModule750/reloadCurrentOperatingSystemConfiguration) Reloads current operating system configuration. +
              #### [reloadOperatingSystem](/reference/services/SoftLayer_Hardware_SecurityModule750/reloadOperatingSystem) Reloads operating system configuration. +
              #### [removeAccessToNetworkStorage](/reference/services/SoftLayer_Hardware_SecurityModule750/removeAccessToNetworkStorage) Remove access to a SoftLayer_Network_Storage volume from this device. +
              #### [removeAccessToNetworkStorageList](/reference/services/SoftLayer_Hardware_SecurityModule750/removeAccessToNetworkStorageList) Remove access to multiple SoftLayer_Network_Storage volumes from this device. +
              #### [removeTags](/reference/services/SoftLayer_Hardware_SecurityModule750/removeTags) Remove a tag reference +
              #### [runPassmarkCertificationBenchmark](/reference/services/SoftLayer_Hardware_SecurityModule750/runPassmarkCertificationBenchmark) Runs a hardware stress test on the server to obtain a Passmark Certification. +
              #### [setOperatingSystemPassword](/reference/services/SoftLayer_Hardware_SecurityModule750/setOperatingSystemPassword) Changes the password stored in our system for a servers' Operating System +
              #### [setPrivateNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_SecurityModule750/setPrivateNetworkInterfaceSpeed) Set the speed and redundancy configuration of a server's private network interface. +
              #### [setPublicNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_SecurityModule750/setPublicNetworkInterfaceSpeed) Set the speed and redundancy configuration of a server's public network interface. +
              #### [setTags](/reference/services/SoftLayer_Hardware_SecurityModule750/setTags) +
              #### [setUserMetadata](/reference/services/SoftLayer_Hardware_SecurityModule750/setUserMetadata) Sets the server's user metadata value. +
              #### [shutdownPrivatePort](/reference/services/SoftLayer_Hardware_SecurityModule750/shutdownPrivatePort) Disconnect a server's private network interface. +
              #### [shutdownPublicPort](/reference/services/SoftLayer_Hardware_SecurityModule750/shutdownPublicPort) Disconnect a server's public network interface. +
              #### [sparePool](/reference/services/SoftLayer_Hardware_SecurityModule750/sparePool) Allows servers to be added to or removed from the spare pool. +
              #### [testRaidAlertService](/reference/services/SoftLayer_Hardware_SecurityModule750/testRaidAlertService) Tests the RAID Alert service. +
              #### [toggleManagementInterface](/reference/services/SoftLayer_Hardware_SecurityModule750/toggleManagementInterface) Toggle the IPMI interface on and off. +
              #### [updateIpmiPassword](/reference/services/SoftLayer_Hardware_SecurityModule750/updateIpmiPassword) Update the root IPMI user password +
              #### [validatePartitionsForOperatingSystem](/reference/services/SoftLayer_Hardware_SecurityModule750/validatePartitionsForOperatingSystem) Validates a collection of partitions for an operating system +
              diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/activatePrivatePort.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/activatePrivatePort.md index 42d08b3e3c..578195d5c0 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/activatePrivatePort.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/activatePrivatePort.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::activatePrivatePort + Activate a server's private network interface. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/activatePublicPort.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/activatePublicPort.md index e63e752fb2..431f81734f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/activatePublicPort.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/activatePublicPort.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::activatePublicPort + Activate a server's public network interface. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/allowAccessToNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/allowAccessToNetworkStorage.md index 423acf174c..e9f3da7163 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/allowAccessToNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/allowAccessToNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::allowAccessToNetworkStorage + Allow access to a SoftLayer_Network_Storage volume from this device. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/allowAccessToNetworkStorageList.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/allowAccessToNetworkStorageList.md index c858a88790..36ea5331c1 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/allowAccessToNetworkStorageList.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/allowAccessToNetworkStorageList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::allowAccessToNetworkStorageList + Allow access to multiple SoftLayer_Network_Storage volumes from this device. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/bootToRescueLayer.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/bootToRescueLayer.md index cba0a3cbad..fda65c9976 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/bootToRescueLayer.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/bootToRescueLayer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::bootToRescueLayer + Initiates the Rescue Kernel to bring a server online to troubleshoot system problems. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/captureImage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/captureImage.md index 51e4570ebc..5edc29169f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/captureImage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/captureImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::captureImage + Captures an Image of the hard disk on the physical machine. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/createFirmwareReflashTransaction.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/createFirmwareReflashTransaction.md index c01be1da59..b392bcc64c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/createFirmwareReflashTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/createFirmwareReflashTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::createFirmwareReflashTransaction + Runs firmware reflash on the servers components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/createFirmwareUpdateTransaction.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/createFirmwareUpdateTransaction.md index c226157322..90f487afd5 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/createFirmwareUpdateTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/createFirmwareUpdateTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::createFirmwareUpdateTransaction + Runs firmware updates on the servers components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/createHyperThreadingUpdateTransaction.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/createHyperThreadingUpdateTransaction.md index 857ecdf739..4c719c241d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/createHyperThreadingUpdateTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/createHyperThreadingUpdateTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::createHyperThreadingUpdateTransaction + Runs BIOS update on the server to change the hyper-threading configuration. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/createObject.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/createObject.md index 71d74c20ca..29d4f754a3 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/createObject.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/createObject.md @@ -14,6 +14,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::createObject + Create a new server diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/createPostSoftwareInstallTransaction.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/createPostSoftwareInstallTransaction.md index 3363779971..ba48e21296 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/createPostSoftwareInstallTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/createPostSoftwareInstallTransaction.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/deleteObject.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/deleteObject.md index b214e5c80f..500f06a507 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/deleteObject.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::deleteObject + Delete a server diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/deleteSoftwareComponentPasswords.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/deleteSoftwareComponentPasswords.md index 0a7491d0f5..f205fae3c1 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/deleteSoftwareComponentPasswords.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/deleteSoftwareComponentPasswords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::deleteSoftwareComponentPasswords + Delete software component passwords. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/deleteTag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/deleteTag.md index 8f246cb6d9..9899e1ada4 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/deleteTag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/deleteTag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::deleteTag + Delete a tag diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/editObject.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/editObject.md index eb0f98c086..4d4b3a240e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/editObject.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::editObject + Edit a server's properties diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/editSoftwareComponentPasswords.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/editSoftwareComponentPasswords.md index be2babc4eb..0b63977f19 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/editSoftwareComponentPasswords.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/editSoftwareComponentPasswords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::editSoftwareComponentPasswords + Edit the properties of software component passwords. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/executeRemoteScript.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/executeRemoteScript.md index 378cddb1ed..08c677f918 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/executeRemoteScript.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/executeRemoteScript.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::executeRemoteScript + Download and run remote script from uri on the hardware. Requires https for script to be executed after download. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/findByIpAddress.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/findByIpAddress.md index 55a6c2ff6c..0d34d2caaf 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/findByIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/findByIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::findByIpAddress + Find hardware by its primary public or private IP (ipv4) address. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/generateOrderTemplate.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/generateOrderTemplate.md index 0bac0a67e5..f694365d5a 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/generateOrderTemplate.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/generateOrderTemplate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::generateOrderTemplate + Obtain an order container for a given template object diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAccount.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAccount.md index 70428660b5..26fe949d51 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAccount.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getAccount + Retrieve the account associated with a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveComponents.md index f5d2af1bdc..1115ea841c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getActiveComponents + Retrieve a piece of hardware's active physical components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveNetworkFirewallBillingItem.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveNetworkFirewallBillingItem.md index 6e2e49ceab..0ba525808b 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveNetworkFirewallBillingItem.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveNetworkFirewallBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getActiveNetworkFirewallBillingItem + Retrieve the billing item for a server's attached network firewall. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveNetworkMonitorIncident.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveNetworkMonitorIncident.md index 6c6b85f66b..82bd8a92cb 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveNetworkMonitorIncident.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveNetworkMonitorIncident.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getActiveNetworkMonitorIncident + Retrieve a piece of hardware's active network monitoring incidents. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveTickets.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveTickets.md index 7db1db2c0b..7ac506b01f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveTickets.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveTickets.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveTransaction.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveTransaction.md index d482adc3ad..1521785f41 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getActiveTransaction + Retrieve transaction currently running for server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveTransactions.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveTransactions.md index 44dc17ac3f..d6b587d673 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveTransactions.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getActiveTransactions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getActiveTransactions + Retrieve any active transaction(s) that are currently running for the server (example: os reload). diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAllPowerComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAllPowerComponents.md index 56267f8263..58e427a419 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAllPowerComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAllPowerComponents.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAllowedHost.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAllowedHost.md index dd1b7ea112..ecfc51e453 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAllowedHost.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAllowedHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getAllowedHost + Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAllowedNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAllowedNetworkStorage.md index e6759e57fd..7bbdc12fcc 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAllowedNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAllowedNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getAllowedNetworkStorage + Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAllowedNetworkStorageReplicas.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAllowedNetworkStorageReplicas.md index 5383b3bfa1..3d7509f5c3 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAllowedNetworkStorageReplicas.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAllowedNetworkStorageReplicas.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getAllowedNetworkStorageReplicas + Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAntivirusSpywareSoftwareComponent.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAntivirusSpywareSoftwareComponent.md index 89e85e0667..de5747c558 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAntivirusSpywareSoftwareComponent.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAntivirusSpywareSoftwareComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getAntivirusSpywareSoftwareComponent + Retrieve information regarding an antivirus/spyware software component object. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAttachedNetworkStorages.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAttachedNetworkStorages.md index 426ecbec5a..ca5caed625 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAttachedNetworkStorages.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAttachedNetworkStorages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getAttachedNetworkStorages + Return a list of SoftLayer_Network_Storage volumes authorized to this device. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAttributes.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAttributes.md index 6b7792c7d5..5daebd4e84 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAttributes.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAttributes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getAttributes + Retrieve information regarding a piece of hardware's specific attributes. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAvailableBillingTermChangePrices.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAvailableBillingTermChangePrices.md index 3930eced22..27765974ff 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAvailableBillingTermChangePrices.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAvailableBillingTermChangePrices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getAvailableBillingTermChangePrices + Retrieves a list of available term prices available to this of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAvailableMonitoring.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAvailableMonitoring.md index e9ade0c2df..792b3ea045 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAvailableMonitoring.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAvailableMonitoring.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getAvailableMonitoring + Retrieve an object that stores the maximum level for the monitoring query types and response types. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAvailableNetworkStorages.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAvailableNetworkStorages.md index 0dee002dbb..c75b89b2c7 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAvailableNetworkStorages.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAvailableNetworkStorages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getAvailableNetworkStorages + Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAverageDailyBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAverageDailyBandwidthUsage.md index 58a19c9e6d..7a108cf600 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAverageDailyBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAverageDailyBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getAverageDailyBandwidthUsage + Retrieve the average daily total bandwidth usage for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAverageDailyPrivateBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAverageDailyPrivateBandwidthUsage.md index df61269818..7b0569efb5 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAverageDailyPrivateBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAverageDailyPrivateBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getAverageDailyPrivateBandwidthUsage + Retrieve the average daily private bandwidth usage for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAverageDailyPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAverageDailyPublicBandwidthUsage.md index 66bd24c39f..9aa1f361ee 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAverageDailyPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getAverageDailyPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getAverageDailyPublicBandwidthUsage + Retrieve the average daily public bandwidth usage for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendBandwidthUsage.md index 8942102903..57eeab6b11 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendBandwidthUsage.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBackendBandwidthUsage + Retrieves public bandwidth usage records. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendBandwidthUse.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendBandwidthUse.md index 58457e5f2e..aaa7dc4084 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendBandwidthUse.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendBandwidthUse.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBackendBandwidthUse +
              Deprecated
              + Retrieves private bandwidth usage records. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendIncomingBandwidth.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendIncomingBandwidth.md index 6716c6c32b..fe71971d23 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendIncomingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendIncomingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBackendIncomingBandwidth + Retrieve the amount of incoming private network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendNetworkComponents.md index 68370d835e..59d3d4bd46 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBackendNetworkComponents + Retrieve a piece of hardware's back-end or private network components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendOutgoingBandwidth.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendOutgoingBandwidth.md index 329850fcd2..5fad11a8e7 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendOutgoingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendOutgoingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBackendOutgoingBandwidth + Retrieve the amount of outgoing private network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendRouters.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendRouters.md index 3d21c2e130..032b177b99 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendRouters.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBackendRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBackendRouters + Retrieve a hardware's backend or private router. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthAllocation.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthAllocation.md index 26d411e081..dd78863515 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthAllocation.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBandwidthAllocation + Retrieve a hardware's allotted bandwidth (measured in GB). diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthAllotmentDetail.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthAllotmentDetail.md index fd7931a530..e415732296 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthAllotmentDetail.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthAllotmentDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBandwidthAllotmentDetail + Retrieve a hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthForDateRange.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthForDateRange.md index 6b2c302013..0bc8e61f0d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthForDateRange.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthForDateRange.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBandwidthForDateRange + Retrieve bandwidth data from a tracking object. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthImage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthImage.md index 97a7273d2f..50cc429cbb 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthImage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBandwidthImage + Retrieve a bandwidth image and textual description of that image for this server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBenchmarkCertifications.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBenchmarkCertifications.md index f4c4f55761..5dcdac17b8 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBenchmarkCertifications.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBenchmarkCertifications.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBenchmarkCertifications + Retrieve information regarding a piece of hardware's benchmark certifications. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingCycleBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingCycleBandwidthUsage.md index 058491f006..e355b729e7 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingCycleBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingCycleBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBillingCycleBandwidthUsage + Retrieve the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingCyclePrivateBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingCyclePrivateBandwidthUsage.md index f406b2e66c..a3ab633f43 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingCyclePrivateBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingCyclePrivateBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBillingCyclePrivateBandwidthUsage + Retrieve the raw private bandwidth usage data for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingCyclePublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingCyclePublicBandwidthUsage.md index 9f870461f4..bea48ac205 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingCyclePublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingCyclePublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBillingCyclePublicBandwidthUsage + Retrieve the raw public bandwidth usage data for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingItem.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingItem.md index 26690008a5..8bb0bf81d9 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingItem.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBillingItem + Retrieve information regarding the billing item for a server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingItemFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingItemFlag.md index 57b5a10633..a9fb9ff8f3 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingItemFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBillingItemFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBillingItemFlag + Retrieve a flag indicating that a billing item exists. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBiosPasswordNullFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBiosPasswordNullFlag.md index 58f143129a..0f879c2af8 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBiosPasswordNullFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBiosPasswordNullFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBiosPasswordNullFlag + Retrieve determine if BIOS password should be left as null. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBlockCancelBecauseDisconnectedFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBlockCancelBecauseDisconnectedFlag.md index 81773d6041..1075a1d959 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBlockCancelBecauseDisconnectedFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBlockCancelBecauseDisconnectedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBlockCancelBecauseDisconnectedFlag + Retrieve determines whether the hardware is ineligible for cancellation because it is disconnected. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBootModeOptions.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBootModeOptions.md index 28121bc0ef..948b351947 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBootModeOptions.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBootModeOptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBootModeOptions + Retrieve the valid boot modes for this server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBusinessContinuanceInsuranceFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBusinessContinuanceInsuranceFlag.md index 3c5a2f1d1c..171f88a72f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBusinessContinuanceInsuranceFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getBusinessContinuanceInsuranceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getBusinessContinuanceInsuranceFlag + Retrieve status indicating whether or not a piece of hardware has business continuance insurance. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCaptureEnabledFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCaptureEnabledFlag.md index 7f32352bfa..ec1e7d5fdc 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCaptureEnabledFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCaptureEnabledFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getCaptureEnabledFlag + Retrieve determine if the server is able to be image captured. If unable to image capture a reason will be provided. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getChildrenHardware.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getChildrenHardware.md index 14a2eb9ced..a096dab4ec 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getChildrenHardware.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getChildrenHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getChildrenHardware + Retrieve child hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getComponentDetailsXML.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getComponentDetailsXML.md index 7731e2e0e1..a743cd30fa 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getComponentDetailsXML.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getComponentDetailsXML.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getComponents.md index a6a5269aeb..4e0a7acdd0 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getComponents + Retrieve a piece of hardware's components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getContainsSolidStateDrivesFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getContainsSolidStateDrivesFlag.md index 3711dc6765..e8462645ea 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getContainsSolidStateDrivesFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getContainsSolidStateDrivesFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getContinuousDataProtectionSoftwareComponent.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getContinuousDataProtectionSoftwareComponent.md index 4c76aee2b4..3d33a1cabd 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getContinuousDataProtectionSoftwareComponent.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getContinuousDataProtectionSoftwareComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getContinuousDataProtectionSoftwareComponent + Retrieve a continuous data protection/server backup software component object. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getControlPanel.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getControlPanel.md index d123cd9d97..26ca369911 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getControlPanel.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getControlPanel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getControlPanel + Retrieve a server's control panel. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCost.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCost.md index a69b7b9d57..4c8a7dd352 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCost.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getCost + Retrieve the total cost of a server, measured in US Dollars ($USD). diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCreateObjectOptions.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCreateObjectOptions.md index 89f6118495..d790d492ed 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCreateObjectOptions.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCreateObjectOptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getCreateObjectOptions + Determine options available when creating a server diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBandwidthSummary.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBandwidthSummary.md index d8082be5af..07ede7694f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBandwidthSummary.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBandwidthSummary.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getCurrentBandwidthSummary + Retrieve an object that provides commonly used bandwidth summary components for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBenchmarkCertificationResultFile.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBenchmarkCertificationResultFile.md index fa932f3915..1f22fe10dd 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBenchmarkCertificationResultFile.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBenchmarkCertificationResultFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getCurrentBenchmarkCertificationResultFile + Get the file for the current benchmark certification result, if it exists. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBillableBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBillableBandwidthUsage.md index 8753c8ce22..991fdbbabd 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBillableBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBillableBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getCurrentBillableBandwidthUsage + Retrieve the current billable public outbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBillingDetail.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBillingDetail.md index 605d9a525d..2c35893998 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBillingDetail.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBillingDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getCurrentBillingDetail + << EOT diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBillingTotal.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBillingTotal.md index 7ecc743870..8e43e5ff91 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBillingTotal.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCurrentBillingTotal.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getCurrentBillingTotal + Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCustomBandwidthDataByDate.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCustomBandwidthDataByDate.md index 5ff5d1600e..0b7f7a50c2 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCustomBandwidthDataByDate.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCustomBandwidthDataByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getCustomBandwidthDataByDate + Retrieve bandwidth graph by date. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCustomerInstalledOperatingSystemFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCustomerInstalledOperatingSystemFlag.md index e29ddb3b09..bab4f66b2f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCustomerInstalledOperatingSystemFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCustomerInstalledOperatingSystemFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getCustomerInstalledOperatingSystemFlag + Retrieve indicates if a server has a Customer Installed OS diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCustomerOwnedFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCustomerOwnedFlag.md index 72e4230737..8d024df991 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCustomerOwnedFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getCustomerOwnedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getCustomerOwnedFlag + Retrieve indicates if a server is a customer owned device. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDailyAverage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDailyAverage.md index 5f0d897580..5a8ee08aaf 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDailyAverage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDailyAverage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getDailyAverage + calculate the average daily network traffic used by a server in gigabytes. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDatacenter.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDatacenter.md index a3887554f1..0c03a251de 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDatacenter.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDatacenter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getDatacenter + Retrieve information regarding the datacenter in which a piece of hardware resides. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDatacenterName.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDatacenterName.md index 17ef8bb069..25a4938a60 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDatacenterName.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDatacenterName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getDatacenterName + Retrieve the name of the datacenter in which a piece of hardware resides. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDaysInSparePool.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDaysInSparePool.md index 94dc03ddbb..59afccca7c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDaysInSparePool.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDaysInSparePool.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getDaysInSparePool + Retrieve number of day(s) a server have been in spare pool. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkHardware.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkHardware.md index 339c80f1da..40f7047b37 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkHardware.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getDownlinkHardware + Retrieve all hardware that has uplink network connections to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkNetworkHardware.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkNetworkHardware.md index d2a03062d3..dac7a16c3b 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkNetworkHardware.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkNetworkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getDownlinkNetworkHardware + Retrieve all hardware that has uplink network connections to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkServers.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkServers.md index fdb5faee7c..3501308968 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkServers.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkServers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getDownlinkServers + Retrieve information regarding all servers attached to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkVirtualGuests.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkVirtualGuests.md index ca602061e6..1db446283d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkVirtualGuests.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownlinkVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getDownlinkVirtualGuests + Retrieve information regarding all virtual guests attached to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamHardwareBindings.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamHardwareBindings.md index 04459d077d..668f851011 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamHardwareBindings.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamHardwareBindings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getDownstreamHardwareBindings + Retrieve all hardware downstream from a network device. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamNetworkHardware.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamNetworkHardware.md index 09689f5b69..10c126b386 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamNetworkHardware.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamNetworkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getDownstreamNetworkHardware + Retrieve all network hardware downstream from the selected piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamNetworkHardwareWithIncidents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamNetworkHardwareWithIncidents.md index 28e11602c6..d08f38c769 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamNetworkHardwareWithIncidents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamNetworkHardwareWithIncidents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getDownstreamNetworkHardwareWithIncidents + Retrieve all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamServers.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamServers.md index 349e39b8d5..583a7b5632 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamServers.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamServers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getDownstreamServers + Retrieve information regarding all servers attached downstream to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamVirtualGuests.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamVirtualGuests.md index 08d6f93b90..b7be7eec98 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamVirtualGuests.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getDownstreamVirtualGuests + Retrieve information regarding all virtual guests attached to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDriveControllers.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDriveControllers.md index dcd57fbb05..3cbe34a109 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDriveControllers.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getDriveControllers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getDriveControllers + Retrieve the drive controllers contained within a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getEvaultNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getEvaultNetworkStorage.md index 6a387cfab0..17f20fbdec 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getEvaultNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getEvaultNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getEvaultNetworkStorage + Retrieve information regarding a piece of hardware's associated EVault network storage service account. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFirewallProtectableSubnets.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFirewallProtectableSubnets.md index e67405a271..3a585913a1 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFirewallProtectableSubnets.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFirewallProtectableSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getFirewallProtectableSubnets + Get the subnets associated with this server that are protectable by a network component firewall. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFirewallServiceComponent.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFirewallServiceComponent.md index c71514e929..06084a6292 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFirewallServiceComponent.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFirewallServiceComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getFirewallServiceComponent + Retrieve information regarding a piece of hardware's firewall services. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFixedConfigurationPreset.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFixedConfigurationPreset.md index d837d8eef5..2eccaa80db 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFixedConfigurationPreset.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFixedConfigurationPreset.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getFixedConfigurationPreset + Retrieve defines the fixed components in a fixed configuration bare metal server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendBandwidthUsage.md index 4e71d73111..8d6187fd90 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendBandwidthUsage.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getFrontendBandwidthUsage + Retrieves public bandwidth usage records. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendBandwidthUse.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendBandwidthUse.md index a72d014879..6a425e2940 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendBandwidthUse.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendBandwidthUse.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getFrontendBandwidthUse +
              Deprecated
              + Retrieves public bandwidth usage records. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendIncomingBandwidth.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendIncomingBandwidth.md index f521b1867b..a2d15b03df 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendIncomingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendIncomingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getFrontendIncomingBandwidth + Retrieve the amount of incoming public network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendNetworkComponents.md index 4cacb99a3f..c1270aa7d0 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getFrontendNetworkComponents + Retrieve a piece of hardware's front-end or public network components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendOutgoingBandwidth.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendOutgoingBandwidth.md index 0c4523e94b..c4eca5d092 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendOutgoingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendOutgoingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getFrontendOutgoingBandwidth + Retrieve the amount of outgoing public network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendRouters.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendRouters.md index 2e3424f0c7..9f00c87b5e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendRouters.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFrontendRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getFrontendRouters + Retrieve a hardware's frontend or public router. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFutureBillingItem.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFutureBillingItem.md index 7974e916f8..610bc0e572 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFutureBillingItem.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getFutureBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getFutureBillingItem + Retrieve information regarding the future billing item for a server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getGlobalIdentifier.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getGlobalIdentifier.md index 39b9f04534..92cd295291 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getGlobalIdentifier.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getGlobalIdentifier.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getGlobalIdentifier + Retrieve a hardware's universally unique identifier. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardDrives.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardDrives.md index 45c16be0f3..8bc30494b7 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardDrives.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardDrives.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getHardDrives + Retrieve the hard drives contained within a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareByIpAddress.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareByIpAddress.md index 87e93630f6..26b229633d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareByIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareByIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getHardwareByIpAddress + Retrieve a SoftLayer_Hardware_Server object by IP address. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareChassis.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareChassis.md index 36d54c62f4..56cea5abae 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareChassis.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareChassis.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getHardwareChassis + Retrieve the chassis that a piece of hardware is housed in. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareFunction.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareFunction.md index 7dd544ee96..295a16a60b 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareFunction.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareFunction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getHardwareFunction + Retrieve a hardware's function. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareFunctionDescription.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareFunctionDescription.md index 8b10b701f1..2a56715947 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareFunctionDescription.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareFunctionDescription.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getHardwareFunctionDescription + Retrieve a hardware's function. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareStatus.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareStatus.md index a294af19d7..cbd198721c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareStatus.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHardwareStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getHardwareStatus + Retrieve a hardware's status. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHasSingleRootVirtualizationBillingItemFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHasSingleRootVirtualizationBillingItemFlag.md index 8d10febb7c..6cc9062451 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHasSingleRootVirtualizationBillingItemFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHasSingleRootVirtualizationBillingItemFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getHasSingleRootVirtualizationBillingItemFlag + Retrieve determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHasTrustedPlatformModuleBillingItemFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHasTrustedPlatformModuleBillingItemFlag.md index 96211b8c00..a1d20787b8 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHasTrustedPlatformModuleBillingItemFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHasTrustedPlatformModuleBillingItemFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getHasTrustedPlatformModuleBillingItemFlag + Retrieve determine in hardware object has TPM enabled. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHostIpsSoftwareComponent.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHostIpsSoftwareComponent.md index f87b7208c5..8ab7948601 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHostIpsSoftwareComponent.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHostIpsSoftwareComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getHostIpsSoftwareComponent + Retrieve information regarding a host IPS software component object. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHourlyBandwidth.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHourlyBandwidth.md index c32edf18ac..e04d6cb43e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHourlyBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHourlyBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getHourlyBandwidth + Retrieves bandwidth hourly over a 24-hour period for the specified hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHourlyBillingFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHourlyBillingFlag.md index 9535fc38fd..b3a1408e85 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHourlyBillingFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getHourlyBillingFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getHourlyBillingFlag + Retrieve a server's hourly billing status. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getInboundBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getInboundBandwidthUsage.md index df0b4bcc01..e1cc1a9af3 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getInboundBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getInboundBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getInboundBandwidthUsage + Retrieve the sum of all the inbound network traffic data for the last 30 days. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getInboundPrivateBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getInboundPrivateBandwidthUsage.md index ba3af0054f..6ff32d10b2 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getInboundPrivateBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getInboundPrivateBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getInboundPrivateBandwidthUsage + Retrieve the total private inbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getInboundPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getInboundPublicBandwidthUsage.md index c3d41339ff..84a9192c3c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getInboundPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getInboundPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getInboundPublicBandwidthUsage + Retrieve the total public inbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getIsBillingTermChangeAvailableFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getIsBillingTermChangeAvailableFlag.md index 3332291239..32c93aa597 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getIsBillingTermChangeAvailableFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getIsBillingTermChangeAvailableFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getIsBillingTermChangeAvailableFlag + Retrieve whether or not this hardware object is eligible to change to term billing. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getIsCloudReadyNodeCertified.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getIsCloudReadyNodeCertified.md index 0d024e72f7..392d3df095 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getIsCloudReadyNodeCertified.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getIsCloudReadyNodeCertified.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getIsCloudReadyNodeCertified + Retrieve determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getIsIpmiDisabled.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getIsIpmiDisabled.md index af9ba83be0..f85b1eeabd 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getIsIpmiDisabled.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getIsIpmiDisabled.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getIsIpmiDisabled + Retrieve determine if remote management has been disabled due to port speed. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getIsVirtualPrivateCloudNode.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getIsVirtualPrivateCloudNode.md index c76d4e7bcf..3904e90175 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getIsVirtualPrivateCloudNode.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getIsVirtualPrivateCloudNode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getIsVirtualPrivateCloudNode + Retrieve determine if hardware object is a Virtual Private Cloud node. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getItemPricesFromSoftwareDescriptions.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getItemPricesFromSoftwareDescriptions.md index 31f213481e..7454a07a48 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getItemPricesFromSoftwareDescriptions.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getItemPricesFromSoftwareDescriptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getItemPricesFromSoftwareDescriptions + Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLastOperatingSystemReload.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLastOperatingSystemReload.md index 53358a9b88..24d3815efe 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLastOperatingSystemReload.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLastOperatingSystemReload.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getLastOperatingSystemReload + Retrieve the last transaction that a server's operating system was loaded. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLastTransaction.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLastTransaction.md index b250ebbe1f..8ef8f3c9c9 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLastTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLastTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getLastTransaction + Retrieve information regarding the last transaction a server performed. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLatestNetworkMonitorIncident.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLatestNetworkMonitorIncident.md index 68f9065965..7efc018d5d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLatestNetworkMonitorIncident.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLatestNetworkMonitorIncident.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getLatestNetworkMonitorIncident + Retrieve a piece of hardware's latest network monitoring incident. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLocation.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLocation.md index f3cb268aed..b69d0a542e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLocation.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getLocation + Retrieve where a piece of hardware is located within SoftLayer's location hierarchy. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLocationPathString.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLocationPathString.md index 73e4c6106c..56feebcfc9 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLocationPathString.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLocationPathString.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLockboxNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLockboxNetworkStorage.md index 3748694d62..ef2ec649bd 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLockboxNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLockboxNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getLockboxNetworkStorage + Retrieve information regarding a lockbox account associated with a server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLogicalVolumeStorageGroups.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLogicalVolumeStorageGroups.md index 9bfb448034..0c3382f6fb 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLogicalVolumeStorageGroups.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getLogicalVolumeStorageGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getLogicalVolumeStorageGroups + Retrieve returns a list of logical volumes on the physical machine. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getManagedResourceFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getManagedResourceFlag.md index 9e62a25024..506276ee51 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getManagedResourceFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getManagedResourceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getManagedResourceFlag + Retrieve a flag indicating that the hardware is a managed resource. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getManagementNetworkComponent.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getManagementNetworkComponent.md index 907d984db7..cc6edccb4d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getManagementNetworkComponent.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getManagementNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getManagementNetworkComponent + Retrieve a server's management network component. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMemory.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMemory.md index 567d2c5e59..34d13fa2b8 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMemory.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMemory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getMemory + Retrieve information regarding a piece of hardware's memory. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMemoryCapacity.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMemoryCapacity.md index 1306b7a9c2..9fa4221853 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMemoryCapacity.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMemoryCapacity.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getMemoryCapacity + Retrieve the amount of memory a piece of hardware has, measured in gigabytes. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMetricTrackingObject.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMetricTrackingObject.md index c6816baa70..3d98f33d07 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMetricTrackingObject.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMetricTrackingObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getMetricTrackingObject + Retrieve a piece of hardware's metric tracking object. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMetricTrackingObjectId.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMetricTrackingObjectId.md index cffb6f48b0..dfc44bc869 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMetricTrackingObjectId.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMetricTrackingObjectId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getMetricTrackingObjectId + Retrieve the metric tracking object id for this server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getModules.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getModules.md index e9873fded2..49b5555845 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getModules.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getModules.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringRobot.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringRobot.md index 765fcb6d3f..03f323b416 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringRobot.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringRobot.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringServiceComponent.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringServiceComponent.md index 568f725ec9..9b7cc1e79f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringServiceComponent.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringServiceComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getMonitoringServiceComponent + Retrieve information regarding a piece of hardware's network monitoring services. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringServiceEligibilityFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringServiceEligibilityFlag.md index cf3c59eff0..ec150825f0 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringServiceEligibilityFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringServiceEligibilityFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringUserNotification.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringUserNotification.md index 346f34b436..0d0ddf3a6b 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringUserNotification.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMonitoringUserNotification.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getMonitoringUserNotification + Retrieve the monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMotherboard.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMotherboard.md index 9baa518d6c..6f1e6fe55e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMotherboard.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getMotherboard.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getMotherboard + Retrieve a server's motherboard. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkCards.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkCards.md index 96087d9faf..f6b4e1826d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkCards.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkCards.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getNetworkCards + Retrieve information regarding a piece of hardware's network cards. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkComponentFirewallProtectableIpAddresses.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkComponentFirewallProtectableIpAddresses.md index feeee875de..5be0dba18e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkComponentFirewallProtectableIpAddresses.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkComponentFirewallProtectableIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getNetworkComponentFirewallProtectableIpAddresses + Get the IP addresses associated with this server that are protectable by a network component firewall. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkComponents.md index 7a500ed5c2..dd6307abae 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getNetworkComponents + Retrieve returns a hardware's network components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkGatewayMember.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkGatewayMember.md index 1084212305..9e19bf7d54 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkGatewayMember.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkGatewayMember.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getNetworkGatewayMember + Retrieve the gateway member if this device is part of a network gateway. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkGatewayMemberFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkGatewayMemberFlag.md index 803cdbe64f..567b388158 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkGatewayMemberFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkGatewayMemberFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getNetworkGatewayMemberFlag + Retrieve whether or not this device is part of a network gateway. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkManagementIpAddress.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkManagementIpAddress.md index 0499498a7e..9176fcfbce 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkManagementIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkManagementIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getNetworkManagementIpAddress + Retrieve a piece of hardware's network management IP address. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitorAttachedDownHardware.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitorAttachedDownHardware.md index d790076dbb..1a6a979ad5 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitorAttachedDownHardware.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitorAttachedDownHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getNetworkMonitorAttachedDownHardware + Retrieve all servers with failed monitoring that are attached downstream to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitorAttachedDownVirtualGuests.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitorAttachedDownVirtualGuests.md index d12f9117a7..a0fa85630b 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitorAttachedDownVirtualGuests.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitorAttachedDownVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getNetworkMonitorAttachedDownVirtualGuests + Retrieve virtual guests that are attached downstream to a hardware that have failed monitoring diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitorIncidents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitorIncidents.md index 6e48e0b028..8629e2385b 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitorIncidents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitorIncidents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getNetworkMonitorIncidents + Retrieve the status of all of a piece of hardware's network monitoring incidents. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitors.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitors.md index 0cb63e750a..17fa5fddfc 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitors.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkMonitors.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getNetworkMonitors + Retrieve information regarding a piece of hardware's network monitors. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStatus.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStatus.md index fd9e701e82..f4bd178c56 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStatus.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getNetworkStatus + Retrieve the value of a hardware's network status attribute. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStatusAttribute.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStatusAttribute.md index 7ff7b52f8c..95415219c5 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStatusAttribute.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStatusAttribute.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getNetworkStatusAttribute + Retrieve the hardware's related network status attribute. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStorage.md index de830bd956..9f45ddb37d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getNetworkStorage + Retrieve information regarding a piece of hardware's associated network storage service account. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkVlans.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkVlans.md index 237195932d..07352e5b20 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkVlans.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getNetworkVlans + Retrieve the network virtual LANs (VLANs) associated with a piece of hardware's network components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNextBillingCycleBandwidthAllocation.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNextBillingCycleBandwidthAllocation.md index 731ea1038d..cde2ec78af 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNextBillingCycleBandwidthAllocation.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNextBillingCycleBandwidthAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getNextBillingCycleBandwidthAllocation + Retrieve a hardware's allotted bandwidth for the next billing cycle (measured in GB). diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNotesHistory.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNotesHistory.md index 874139317b..6fe97c1ca0 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNotesHistory.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNotesHistory.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNvRamCapacity.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNvRamCapacity.md index 82c3e4f7bd..823541477d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNvRamCapacity.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNvRamCapacity.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getNvRamCapacity + Retrieve the amount of non-volatile memory a piece of hardware has, measured in gigabytes. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNvRamComponentModels.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNvRamComponentModels.md index 845a746caa..3d80bb7f88 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNvRamComponentModels.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getNvRamComponentModels.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getObject.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getObject.md index 7bbdb619b6..54dc66a663 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getObject.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getObject + Retrieve a SoftLayer_Hardware_SecurityModule750 record. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOpenCancellationTicket.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOpenCancellationTicket.md index 32cda64543..de49ce3ed2 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOpenCancellationTicket.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOpenCancellationTicket.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getOpenCancellationTicket + Retrieve an open ticket requesting cancellation of this server, if one exists. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOperatingSystem.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOperatingSystem.md index 79b0435eb0..4dfb52b215 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOperatingSystem.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOperatingSystem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getOperatingSystem + Retrieve information regarding a piece of hardware's operating system. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOperatingSystemReferenceCode.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOperatingSystemReferenceCode.md index 2812d2c5e2..15c7120d72 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOperatingSystemReferenceCode.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOperatingSystemReferenceCode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getOperatingSystemReferenceCode + Retrieve a hardware's operating system software description. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOutboundBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOutboundBandwidthUsage.md index 0882e2116e..4e1a65baa9 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOutboundBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOutboundBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getOutboundBandwidthUsage + Retrieve the sum of all the outbound network traffic data for the last 30 days. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOutboundPrivateBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOutboundPrivateBandwidthUsage.md index 94982b8628..533ef6738f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOutboundPrivateBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOutboundPrivateBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getOutboundPrivateBandwidthUsage + Retrieve the total private outbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOutboundPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOutboundPublicBandwidthUsage.md index 8dc8c51313..d1340b11bd 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOutboundPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOutboundPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getOutboundPublicBandwidthUsage + Retrieve the total public outbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOverBandwidthAllocationFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOverBandwidthAllocationFlag.md index c090eb816e..d99d757a27 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOverBandwidthAllocationFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getOverBandwidthAllocationFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getOverBandwidthAllocationFlag + Retrieve whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPMInfo.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPMInfo.md index 8b93c8bf79..e66b1f7981 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPMInfo.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPMInfo.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPMInfo + Retrieve a server's hardware state via its internal sensors. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getParentBay.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getParentBay.md index 5aff357752..c0df0e87d8 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getParentBay.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getParentBay.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getParentBay + Retrieve blade Bay diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getParentHardware.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getParentHardware.md index e85168a3e3..854a0c42f9 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getParentHardware.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getParentHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getParentHardware + Retrieve parent Hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPartitions.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPartitions.md index 9991590e9d..7bffcaba88 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPartitions.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPartitions.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPointOfPresenceLocation.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPointOfPresenceLocation.md index 5c8c9fc566..d04aac666d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPointOfPresenceLocation.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPointOfPresenceLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPointOfPresenceLocation + Retrieve information regarding the Point of Presence (PoP) location in which a piece of hardware resides. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPowerComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPowerComponents.md index 35ddbe814d..71f49d2a47 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPowerComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPowerComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPowerComponents + Retrieve the power components for a hardware object. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPowerSupply.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPowerSupply.md index 3acfee9462..2ba52d1ad8 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPowerSupply.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPowerSupply.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPowerSupply + Retrieve a server's power supply. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryBackendIpAddress.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryBackendIpAddress.md index 3e80cad07d..d4c54b0df3 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryBackendIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryBackendIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPrimaryBackendIpAddress + Retrieve the hardware's primary private IP address. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryDriveSize.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryDriveSize.md index 6de13965fa..664d07f23f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryDriveSize.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryDriveSize.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryIpAddress.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryIpAddress.md index 7eaf4a2462..a26929f6e8 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrimaryIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPrimaryIpAddress + Retrieve the hardware's primary public IP address. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthData.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthData.md index 1b9ab3368e..46b8cccf3e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthData.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPrivateBandwidthData + Retrieve a graph of a server's private network usage. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthDataSummary.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthDataSummary.md index 0afadbd65a..6c3698f3e2 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthDataSummary.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthDataSummary.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPrivateBandwidthDataSummary + Retrieve a server's private bandwidth usage summary diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthGraphImage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthGraphImage.md index 6330e50a85..e835b18bb0 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthGraphImage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthGraphImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPrivateBandwidthGraphImage + Retrieve a graph of a server's private network usage. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateIpAddress.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateIpAddress.md index 7599916208..f29c884d22 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPrivateIpAddress + Retrieve a server's primary private IP address. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateNetworkComponent.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateNetworkComponent.md index b4a6213104..71deda9fbb 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateNetworkComponent.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPrivateNetworkComponent + Retrieve a server's private network component. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateNetworkOnlyFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateNetworkOnlyFlag.md index e1696faaf7..a99a7c96f2 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateNetworkOnlyFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateNetworkOnlyFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPrivateNetworkOnlyFlag + Retrieve whether the hardware only has access to the private network. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateVlan.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateVlan.md index d0235fb0ef..af9aada987 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateVlan.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateVlan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPrivateVlan + Retrieve the backend VLAN for the primary IP address of the server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateVlanByIpAddress.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateVlanByIpAddress.md index 0ea08cda3a..2e85020047 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateVlanByIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateVlanByIpAddress.md @@ -14,6 +14,8 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPrivateVlanByIpAddress +
              Deprecated
              + Retrieve a backend network VLAN by searching for an IP address. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProcessorCoreAmount.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProcessorCoreAmount.md index 0bc5c5af18..4278eac9b7 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProcessorCoreAmount.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProcessorCoreAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getProcessorCoreAmount + Retrieve the total number of processor cores, summed from all processors that are attached to a piece of hardware diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProcessorPhysicalCoreAmount.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProcessorPhysicalCoreAmount.md index 0b133c737d..0affa43f3f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProcessorPhysicalCoreAmount.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProcessorPhysicalCoreAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getProcessorPhysicalCoreAmount + Retrieve the total number of physical processor cores, summed from all processors that are attached to a piece of hardware diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProcessors.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProcessors.md index 179b985487..7d7d49a518 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProcessors.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProcessors.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getProcessors + Retrieve information regarding a piece of hardware's processors. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProjectedOverBandwidthAllocationFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProjectedOverBandwidthAllocationFlag.md index 8b361b91ea..c4d7bbd8ef 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProjectedOverBandwidthAllocationFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProjectedOverBandwidthAllocationFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getProjectedOverBandwidthAllocationFlag + Retrieve whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProjectedPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProjectedPublicBandwidthUsage.md index cd7fa06a57..325e77231e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProjectedPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProjectedPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getProjectedPublicBandwidthUsage + Retrieve the projected public outbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProvisionDate.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProvisionDate.md index 964aa9d62a..320a6ddcb2 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProvisionDate.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getProvisionDate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthData.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthData.md index fe652b9b8e..a7a489c984 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthData.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPublicBandwidthData + Retrieve a graph of a server's public network usage. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthDataSummary.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthDataSummary.md index 8d5fc01b47..513e418081 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthDataSummary.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthDataSummary.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPublicBandwidthDataSummary + Retrieve a server's public bandwidth usage summary diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthGraphImage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthGraphImage.md index 995c28f5e4..6c9278672e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthGraphImage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthGraphImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPublicBandwidthGraphImage + Retrieve a graph of a server's public network usage. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthTotal.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthTotal.md index 66105040b6..90d295213d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthTotal.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthTotal.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPublicBandwidthTotal + Retrieve total number of public bytes used by a server over time period specified. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicNetworkComponent.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicNetworkComponent.md index 26a7a393b5..1009834ad7 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicNetworkComponent.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPublicNetworkComponent + Retrieve a server's public network component. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicVlan.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicVlan.md index c8d2ea6f3f..54e18fb521 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicVlan.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicVlan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPublicVlan + Retrieve the frontend VLAN for the primary IP address of the server diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicVlanByHostname.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicVlanByHostname.md index 67baa86a08..8aa621d43b 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicVlanByHostname.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicVlanByHostname.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getPublicVlanByHostname + Retrieve the frontend VLAN by a server's hostname. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRack.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRack.md index 960b403742..53224bbf71 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRack.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRack.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRaidControllers.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRaidControllers.md index d02b821adf..e39aa1717c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRaidControllers.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRaidControllers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getRaidControllers + Retrieve the RAID controllers contained within a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getReadyNodeFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getReadyNodeFlag.md index cfd1d4a7c0..043c945bee 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getReadyNodeFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getReadyNodeFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getReadyNodeFlag + Retrieve determine if hardware object is vSan Ready Node. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRecentEvents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRecentEvents.md index 60edcd93df..e268d57775 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRecentEvents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRecentEvents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getRecentEvents + Retrieve recent events that impact this hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRecentRemoteManagementCommands.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRecentRemoteManagementCommands.md index 625bb994ac..dba7ec57e6 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRecentRemoteManagementCommands.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRecentRemoteManagementCommands.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getRecentRemoteManagementCommands + Retrieve the last five commands issued to the server's remote management card. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRegionalInternetRegistry.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRegionalInternetRegistry.md index cc4f5fe940..23611f354d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRegionalInternetRegistry.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRegionalInternetRegistry.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagement.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagement.md index 49096cabf1..1803fa30e3 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagement.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagement.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getRemoteManagement + Retrieve a server's remote management card. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagementAccounts.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagementAccounts.md index 7eef0bfd52..eb5a3eadfd 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagementAccounts.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagementAccounts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getRemoteManagementAccounts + Retrieve user credentials to issue commands and/or interact with the server's remote management card. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagementComponent.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagementComponent.md index 5466cc42af..b4ad42c9eb 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagementComponent.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagementComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getRemoteManagementComponent + Retrieve a hardware's associated remote management component. This is normally IPMI. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagementUsers.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagementUsers.md index 00b615cbab..18ec9503c0 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagementUsers.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRemoteManagementUsers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getRemoteManagementUsers + Retrieve user(s) who have access to issue commands and/or interact with the server's remote management card. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceConfigurations.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceConfigurations.md index 37f20c9111..61e92fd6d4 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceConfigurations.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceConfigurations.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceGroupMemberReferences.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceGroupMemberReferences.md index ec4782ab12..a6338e4145 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceGroupMemberReferences.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceGroupMemberReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceGroupRoles.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceGroupRoles.md index 6446f2ca07..3dfcd5e0a8 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceGroupRoles.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceGroupRoles.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceGroups.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceGroups.md index 4e4acd2e46..0a2663e930 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceGroups.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getResourceGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getResourceGroups + Retrieve the resource groups in which this hardware is a member. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getReverseDomainRecords.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getReverseDomainRecords.md index c363d0d681..74efab9105 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getReverseDomainRecords.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getReverseDomainRecords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getReverseDomainRecords + Retrieve the reverse domain records associated with a server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRouters.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRouters.md index 5ce5eb9717..fb8a4fc547 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRouters.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getRouters + Retrieve a hardware's routers. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getScaleAssets.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getScaleAssets.md index 746bdf2af2..2507e0fd30 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getScaleAssets.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getScaleAssets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getScaleAssets + Retrieve collection of scale assets this hardware corresponds to. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSecurityScanRequests.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSecurityScanRequests.md index 643a0f515e..5a4aea4708 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSecurityScanRequests.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSecurityScanRequests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getSecurityScanRequests + Retrieve information regarding a piece of hardware's vulnerability scan requests. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSensorData.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSensorData.md index 19fbf80fe3..9f35de2603 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSensorData.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSensorData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getSensorData + Retrieve a server's hardware state via its internal sensors. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSensorDataWithGraphs.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSensorDataWithGraphs.md index 47f528a9e1..6dfa55f109 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSensorDataWithGraphs.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSensorDataWithGraphs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getSensorDataWithGraphs + Retrieve server's temperature and fan speed graphs as well the sensor raw data. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerDetails.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerDetails.md index aa8f42f4ff..e959dbe9c3 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerDetails.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getServerDetails + Retrieve a server's hardware components, software, and network components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerFanSpeedGraphs.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerFanSpeedGraphs.md index fc576af64e..f14ea025a3 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerFanSpeedGraphs.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerFanSpeedGraphs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getServerFanSpeedGraphs + Retrieve server's fan speed graphs. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerPowerState.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerPowerState.md index 436c95eb48..495ab52c2e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerPowerState.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerPowerState.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getServerPowerState + Retrieves server's power state diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerRoom.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerRoom.md index ec157f2e94..7d0d55ec6c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerRoom.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerRoom.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getServerRoom + Retrieve information regarding the server room in which the hardware is located. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerTemperatureGraphs.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerTemperatureGraphs.md index 5d7c7329e4..dc4e58d384 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerTemperatureGraphs.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServerTemperatureGraphs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getServerTemperatureGraphs + Retrieve server's temperature graphs diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServiceProvider.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServiceProvider.md index 9de4e2ccbe..5090dfea09 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServiceProvider.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getServiceProvider.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getServiceProvider + Retrieve information regarding the piece of hardware's service provider. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSoftwareComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSoftwareComponents.md index 67aa801e28..66d7f92018 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSoftwareComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSoftwareComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getSoftwareComponents + Retrieve information regarding a piece of hardware's installed software. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSoftwareGuardExtensionEnabled.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSoftwareGuardExtensionEnabled.md index 3f10c7d533..5c6b04cfbd 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSoftwareGuardExtensionEnabled.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSoftwareGuardExtensionEnabled.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getSoftwareGuardExtensionEnabled + Retrieve determine if hardware object has Software Guard Extension (SGX) enabled. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSshKeys.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSshKeys.md index 7a7eddfa7b..59f77e0310 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSshKeys.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getSshKeys.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getSshKeys + Retrieve sSH keys to be installed on the server during provisioning or an OS reload. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getStatisticsRemoteManagement.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getStatisticsRemoteManagement.md index bd38020fd8..219ff4b0c3 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getStatisticsRemoteManagement.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getStatisticsRemoteManagement.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getStatisticsRemoteManagement + Retrieve a server's remote management card used for statistics. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getStorageGroups.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getStorageGroups.md index 165ebfcea3..f402faaa64 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getStorageGroups.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getStorageGroups.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getStorageNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getStorageNetworkComponents.md index 439968d7b9..c1734a9ef5 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getStorageNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getStorageNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getStorageNetworkComponents + Retrieve a piece of hardware's private storage network components. [Deprecated] diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getTagReferences.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getTagReferences.md index d8095f7925..67fadec285 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getTagReferences.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getTagReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getTopLevelLocation.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getTopLevelLocation.md index fa47c15744..44a747be7d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getTopLevelLocation.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getTopLevelLocation.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getTransactionHistory.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getTransactionHistory.md index 9b057699c7..43c3380cd8 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getTransactionHistory.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getTransactionHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getTransactionHistory + Get transaction history for a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUefiBootFlag.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUefiBootFlag.md index 8631af407e..1507b56a75 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUefiBootFlag.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUefiBootFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getUefiBootFlag + Retrieve whether to use UEFI boot instead of BIOS. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUpgradeItemPrices.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUpgradeItemPrices.md index 84cb6d5f85..d64d7ec60c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUpgradeItemPrices.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUpgradeItemPrices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getUpgradeItemPrices + Retrieve a list of upgradable items available to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUpgradeRequest.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUpgradeRequest.md index c6608d5896..384e7610f5 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUpgradeRequest.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUpgradeRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getUpgradeRequest + Retrieve an account's associated upgrade request object, if any. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUplinkHardware.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUplinkHardware.md index 8d91c46435..6431e8f228 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUplinkHardware.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUplinkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getUplinkHardware + Retrieve the network device connected to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUplinkNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUplinkNetworkComponents.md index 1d790b38f3..bf2bbf7315 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUplinkNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUplinkNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getUplinkNetworkComponents + Retrieve information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUserData.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUserData.md index 1b3a1bb3bc..5de3395d0c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUserData.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUserData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getUserData + Retrieve an array containing a single string of custom user data for a hardware order. Max size is 16 kb. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUsers.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUsers.md index e88cdc0990..1c64c5a2c8 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUsers.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getUsers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getUsers + Retrieve a list of users that have access to this computing instance. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getValidBlockDeviceTemplateGroups.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getValidBlockDeviceTemplateGroups.md index 066e7daf59..1370fd771f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getValidBlockDeviceTemplateGroups.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getValidBlockDeviceTemplateGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getValidBlockDeviceTemplateGroups + Return a list of valid block device template groups based on this host diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualChassis.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualChassis.md index 849b95f314..b638f6f5fa 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualChassis.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualChassis.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getVirtualChassis + Retrieve information regarding the virtual chassis for a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualChassisSiblings.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualChassisSiblings.md index 24ab93bb3e..7979f6f703 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualChassisSiblings.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualChassisSiblings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getVirtualChassisSiblings + Retrieve information regarding the virtual chassis siblings for a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualGuests.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualGuests.md index 68ee9a829d..bcaffb56da 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualGuests.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getVirtualGuests + Retrieve a hardware server's virtual servers. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualHost.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualHost.md index c0d1d9856f..cf30824b9c 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualHost.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getVirtualHost + Retrieve a piece of hardware's virtual host record. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualLicenses.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualLicenses.md index d02ebfdadf..f92846a327 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualLicenses.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualLicenses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getVirtualLicenses + Retrieve information regarding a piece of hardware's virtual software licenses. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualRack.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualRack.md index 66308ca5a6..56a047a829 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualRack.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualRack.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getVirtualRack + Retrieve information regarding the bandwidth allotment to which a piece of hardware belongs. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualRackId.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualRackId.md index bdcb31e1ec..d7d9eecfb1 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualRackId.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualRackId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getVirtualRackId + Retrieve the name of the bandwidth allotment belonging to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualRackName.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualRackName.md index 21c93e40e2..c9f0e4d207 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualRackName.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualRackName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getVirtualRackName + Retrieve the name of the bandwidth allotment belonging to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualizationPlatform.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualizationPlatform.md index 8e3123a1ba..a9d0ceedee 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualizationPlatform.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getVirtualizationPlatform.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getVirtualizationPlatform + Retrieve a piece of hardware's virtualization platform software. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getWindowsUpdateAvailableUpdates.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getWindowsUpdateAvailableUpdates.md index 242dcea5f5..52dd2468b7 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getWindowsUpdateAvailableUpdates.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getWindowsUpdateAvailableUpdates.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getWindowsUpdateAvailableUpdates + Retrieve a list of Windows updates available to a server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getWindowsUpdateInstalledUpdates.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getWindowsUpdateInstalledUpdates.md index fc1978565c..fe6ed4c748 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getWindowsUpdateInstalledUpdates.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getWindowsUpdateInstalledUpdates.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getWindowsUpdateInstalledUpdates + Retrieve a list of Windows updates installed on a server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getWindowsUpdateStatus.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getWindowsUpdateStatus.md index 0c3052d18d..14000d220f 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/getWindowsUpdateStatus.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/getWindowsUpdateStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::getWindowsUpdateStatus + Retrieve a server's Windows update synchronization status diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/importVirtualHost.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/importVirtualHost.md index ec982c10c7..91f12879ce 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/importVirtualHost.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/importVirtualHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::importVirtualHost + attempt to import the host record for the virtualization platform running on a server diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/initiateIderaBareMetalRestore.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/initiateIderaBareMetalRestore.md index c8e748a62f..2f15f0d6be 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/initiateIderaBareMetalRestore.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/initiateIderaBareMetalRestore.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::initiateIderaBareMetalRestore + Initiate an Idera bare metal restore for the server tied to an Idera Server Backup diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/initiateR1SoftBareMetalRestore.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/initiateR1SoftBareMetalRestore.md index eafdee0548..a07cfd759e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/initiateR1SoftBareMetalRestore.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/initiateR1SoftBareMetalRestore.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::initiateR1SoftBareMetalRestore + Initiate an R1Soft bare metal restore for the server tied to an R1Soft CDP Server diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/isBackendPingable.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/isBackendPingable.md index d078250bf7..1e115820ab 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/isBackendPingable.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/isBackendPingable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::isBackendPingable + Verifies if a server's backend ip address is pingable. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/isPingable.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/isPingable.md index 6f93f32f7d..c6af08ca0d 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/isPingable.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/isPingable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::isPingable + Verifies if server is pingable. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/isWindowsServer.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/isWindowsServer.md index bdc890c193..0b6b512c36 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/isWindowsServer.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/isWindowsServer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::isWindowsServer + Determine if a server runs the Microsoft Windows operating system. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/massFirmwareReflash.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/massFirmwareReflash.md index cf37fe0492..cf9757281e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/massFirmwareReflash.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/massFirmwareReflash.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::massFirmwareReflash + Runs firmware reflashes on the servers components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/massFirmwareUpdate.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/massFirmwareUpdate.md index 4b48603397..d40f042d54 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/massFirmwareUpdate.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/massFirmwareUpdate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::massFirmwareUpdate + Runs firmware updates on the servers components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/massHyperThreadingUpdate.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/massHyperThreadingUpdate.md index 89c17bf154..f1fae9b037 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/massHyperThreadingUpdate.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/massHyperThreadingUpdate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::massHyperThreadingUpdate + Runs firmware reflashes on the servers components. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/massReloadOperatingSystem.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/massReloadOperatingSystem.md index 599b989fd4..83acfdfb65 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/massReloadOperatingSystem.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/massReloadOperatingSystem.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::massReloadOperatingSystem + Reloads operating system configuration on a set of hardware Ids. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/massSparePool.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/massSparePool.md index 5e6de59042..4a46ca8a0b 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/massSparePool.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/massSparePool.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::massSparePool + Allows multiple servers to be added to or removed from the spare pool. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/ping.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/ping.md index e11632f234..e58736d068 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/ping.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/ping.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::ping + Issues ping command. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/populateServerRam.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/populateServerRam.md index 08b10a9a1a..cb7814e395 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/populateServerRam.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/populateServerRam.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/powerCycle.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/powerCycle.md index 992c7bc1b6..b4076fe4f0 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/powerCycle.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/powerCycle.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::powerCycle + Issues power cycle to server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/powerOff.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/powerOff.md index 33971c78b1..78e523c7de 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/powerOff.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/powerOff.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::powerOff + Power off server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/powerOn.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/powerOn.md index 38221ae9d7..e4da9fa8bc 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/powerOn.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/powerOn.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::powerOn + Power on server. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/rebootDefault.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/rebootDefault.md index 176e26a62c..4d42b56e18 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/rebootDefault.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/rebootDefault.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::rebootDefault + Reboot the server via the default method. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/rebootHard.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/rebootHard.md index ad39244d44..48a0916607 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/rebootHard.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/rebootHard.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::rebootHard + Reboot the server via "hard" reboot. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/rebootSoft.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/rebootSoft.md index 40d459dbf1..0d79a17ece 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/rebootSoft.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/rebootSoft.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::rebootSoft + Reboot the server via gracefully (soft reboot). diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/reloadCurrentOperatingSystemConfiguration.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/reloadCurrentOperatingSystemConfiguration.md index 7b5d759f79..d6eee55d81 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/reloadCurrentOperatingSystemConfiguration.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/reloadCurrentOperatingSystemConfiguration.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::reloadCurrentOperatingSystemConfiguration + Reloads current operating system configuration. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/reloadOperatingSystem.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/reloadOperatingSystem.md index bf593bdb9f..faff0ba658 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/reloadOperatingSystem.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/reloadOperatingSystem.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::reloadOperatingSystem + Reloads operating system configuration. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/removeAccessToNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/removeAccessToNetworkStorage.md index 4fe2de571b..0a9971b092 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/removeAccessToNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/removeAccessToNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::removeAccessToNetworkStorage + Remove access to a SoftLayer_Network_Storage volume from this device. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/removeAccessToNetworkStorageList.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/removeAccessToNetworkStorageList.md index 60ec8eec51..ade7100369 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/removeAccessToNetworkStorageList.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/removeAccessToNetworkStorageList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::removeAccessToNetworkStorageList + Remove access to multiple SoftLayer_Network_Storage volumes from this device. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/removeTags.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/removeTags.md index 0d65820ba1..d4ebd56f51 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/removeTags.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/removeTags.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::removeTags + Remove a tag reference diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/runPassmarkCertificationBenchmark.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/runPassmarkCertificationBenchmark.md index 3406584b60..2da3161ca2 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/runPassmarkCertificationBenchmark.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/runPassmarkCertificationBenchmark.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::runPassmarkCertificationBenchmark + Runs a hardware stress test on the server to obtain a Passmark Certification. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/setOperatingSystemPassword.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/setOperatingSystemPassword.md index f5482a170c..1c94f9ffce 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/setOperatingSystemPassword.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/setOperatingSystemPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::setOperatingSystemPassword + Changes the password stored in our system for a servers' Operating System diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/setPrivateNetworkInterfaceSpeed.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/setPrivateNetworkInterfaceSpeed.md index 7db07bf29c..994be0b54e 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/setPrivateNetworkInterfaceSpeed.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/setPrivateNetworkInterfaceSpeed.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::setPrivateNetworkInterfaceSpeed + Set the speed and redundancy configuration of a server's private network interface. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/setPublicNetworkInterfaceSpeed.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/setPublicNetworkInterfaceSpeed.md index 8d9eae9afe..97ab0bc890 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/setPublicNetworkInterfaceSpeed.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/setPublicNetworkInterfaceSpeed.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::setPublicNetworkInterfaceSpeed + Set the speed and redundancy configuration of a server's public network interface. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/setTags.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/setTags.md index 62b6d3bc1a..56a2bd5c67 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/setTags.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/setTags.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/setUserMetadata.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/setUserMetadata.md index 1156022d36..c473d2dab4 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/setUserMetadata.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/setUserMetadata.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::setUserMetadata + Sets the server's user metadata value. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/shutdownPrivatePort.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/shutdownPrivatePort.md index f1fe528a20..6143a7be22 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/shutdownPrivatePort.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/shutdownPrivatePort.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::shutdownPrivatePort + Disconnect a server's private network interface. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/shutdownPublicPort.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/shutdownPublicPort.md index c48571e1a2..ba463b8084 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/shutdownPublicPort.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/shutdownPublicPort.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::shutdownPublicPort + Disconnect a server's public network interface. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/sparePool.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/sparePool.md index 215abd0475..92ee010767 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/sparePool.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/sparePool.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::sparePool + Allows servers to be added to or removed from the spare pool. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/testRaidAlertService.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/testRaidAlertService.md index 762db486b0..7ba2ff4948 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/testRaidAlertService.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/testRaidAlertService.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::testRaidAlertService + Tests the RAID Alert service. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/toggleManagementInterface.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/toggleManagementInterface.md index 7fd41452ec..1827c26a33 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/toggleManagementInterface.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/toggleManagementInterface.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::toggleManagementInterface + Toggle the IPMI interface on and off. diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/updateIpmiPassword.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/updateIpmiPassword.md index a4dd2342f0..8fc3ae66dd 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/updateIpmiPassword.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/updateIpmiPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::updateIpmiPassword + Update the root IPMI user password diff --git a/content/reference/services/SoftLayer_Hardware_SecurityModule750/validatePartitionsForOperatingSystem.md b/content/reference/services/SoftLayer_Hardware_SecurityModule750/validatePartitionsForOperatingSystem.md index 10375f691a..43b5bac5eb 100644 --- a/content/reference/services/SoftLayer_Hardware_SecurityModule750/validatePartitionsForOperatingSystem.md +++ b/content/reference/services/SoftLayer_Hardware_SecurityModule750/validatePartitionsForOperatingSystem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_SecurityModule750](/reference/services/SoftLayer_Hardware_SecurityModule750)::validatePartitionsForOperatingSystem + Validates a collection of partitions for an operating system diff --git a/content/reference/services/SoftLayer_Hardware_Server/_index.md b/content/reference/services/SoftLayer_Hardware_Server/_index.md index 14c75e8083..e36ffbe990 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/_index.md +++ b/content/reference/services/SoftLayer_Hardware_Server/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + 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. @@ -47,1746 +49,2046 @@ Every SoftLayer server is defined in the SoftLayer_Hardware_Server service. Soft #### [activatePrivatePort](/reference/services/SoftLayer_Hardware_Server/activatePrivatePort) Activate a server's private network interface. +
              #### [activatePublicPort](/reference/services/SoftLayer_Hardware_Server/activatePublicPort) Activate a server's public network interface. +
              #### [allowAccessToNetworkStorage](/reference/services/SoftLayer_Hardware_Server/allowAccessToNetworkStorage) Allow access to a SoftLayer_Network_Storage volume from this device. +
              #### [allowAccessToNetworkStorageList](/reference/services/SoftLayer_Hardware_Server/allowAccessToNetworkStorageList) Allow access to multiple SoftLayer_Network_Storage volumes from this device. +
              #### [bootToRescueLayer](/reference/services/SoftLayer_Hardware_Server/bootToRescueLayer) Initiates the Rescue Kernel to bring a server online to troubleshoot system problems. +
              #### [captureImage](/reference/services/SoftLayer_Hardware_Server/captureImage) Captures an Image of the hard disk on the physical machine. +
              #### [createFirmwareReflashTransaction](/reference/services/SoftLayer_Hardware_Server/createFirmwareReflashTransaction) Runs firmware reflash on the servers components. +
              #### [createFirmwareUpdateTransaction](/reference/services/SoftLayer_Hardware_Server/createFirmwareUpdateTransaction) Runs firmware updates on the servers components. +
              #### [createHyperThreadingUpdateTransaction](/reference/services/SoftLayer_Hardware_Server/createHyperThreadingUpdateTransaction) Runs BIOS update on the server to change the hyper-threading configuration. +
              #### [createObject](/reference/services/SoftLayer_Hardware_Server/createObject) Create a new server +
              #### [createPostSoftwareInstallTransaction](/reference/services/SoftLayer_Hardware_Server/createPostSoftwareInstallTransaction) +
              #### [deleteObject](/reference/services/SoftLayer_Hardware_Server/deleteObject) Delete a server +
              #### [deleteSoftwareComponentPasswords](/reference/services/SoftLayer_Hardware_Server/deleteSoftwareComponentPasswords) Delete software component passwords. +
              #### [deleteTag](/reference/services/SoftLayer_Hardware_Server/deleteTag) Delete a tag +
              #### [editObject](/reference/services/SoftLayer_Hardware_Server/editObject) Edit a server's properties +
              #### [editSoftwareComponentPasswords](/reference/services/SoftLayer_Hardware_Server/editSoftwareComponentPasswords) Edit the properties of software component passwords. +
              #### [executeRemoteScript](/reference/services/SoftLayer_Hardware_Server/executeRemoteScript) Download and run remote script from uri on the hardware. Requires https for script to be executed after download. +
              #### [findByIpAddress](/reference/services/SoftLayer_Hardware_Server/findByIpAddress) Find hardware by its primary public or private IP (ipv4) address. +
              #### [generateOrderTemplate](/reference/services/SoftLayer_Hardware_Server/generateOrderTemplate) Obtain an order container for a given template object +
              #### [getAccount](/reference/services/SoftLayer_Hardware_Server/getAccount) Retrieve the account associated with a piece of hardware. +
              #### [getActiveComponents](/reference/services/SoftLayer_Hardware_Server/getActiveComponents) Retrieve a piece of hardware's active physical components. +
              #### [getActiveNetworkFirewallBillingItem](/reference/services/SoftLayer_Hardware_Server/getActiveNetworkFirewallBillingItem) Retrieve the billing item for a server's attached network firewall. +
              #### [getActiveNetworkMonitorIncident](/reference/services/SoftLayer_Hardware_Server/getActiveNetworkMonitorIncident) Retrieve a piece of hardware's active network monitoring incidents. +
              #### [getActiveTickets](/reference/services/SoftLayer_Hardware_Server/getActiveTickets) +
              #### [getActiveTransaction](/reference/services/SoftLayer_Hardware_Server/getActiveTransaction) Retrieve transaction currently running for server. +
              #### [getActiveTransactions](/reference/services/SoftLayer_Hardware_Server/getActiveTransactions) Retrieve any active transaction(s) that are currently running for the server (example: os reload). +
              #### [getAllPowerComponents](/reference/services/SoftLayer_Hardware_Server/getAllPowerComponents) +
              #### [getAllowedHost](/reference/services/SoftLayer_Hardware_Server/getAllowedHost) Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. +
              #### [getAllowedNetworkStorage](/reference/services/SoftLayer_Hardware_Server/getAllowedNetworkStorage) Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. +
              #### [getAllowedNetworkStorageReplicas](/reference/services/SoftLayer_Hardware_Server/getAllowedNetworkStorageReplicas) Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. +
              #### [getAntivirusSpywareSoftwareComponent](/reference/services/SoftLayer_Hardware_Server/getAntivirusSpywareSoftwareComponent) Retrieve information regarding an antivirus/spyware software component object. +
              #### [getAttachedNetworkStorages](/reference/services/SoftLayer_Hardware_Server/getAttachedNetworkStorages) Return a list of SoftLayer_Network_Storage volumes authorized to this device. +
              #### [getAttributes](/reference/services/SoftLayer_Hardware_Server/getAttributes) Retrieve information regarding a piece of hardware's specific attributes. +
              #### [getAvailableBillingTermChangePrices](/reference/services/SoftLayer_Hardware_Server/getAvailableBillingTermChangePrices) Retrieves a list of available term prices available to this of hardware. +
              #### [getAvailableMonitoring](/reference/services/SoftLayer_Hardware_Server/getAvailableMonitoring) Retrieve an object that stores the maximum level for the monitoring query types and response types. +
              #### [getAvailableNetworkStorages](/reference/services/SoftLayer_Hardware_Server/getAvailableNetworkStorages) Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. +
              #### [getAverageDailyBandwidthUsage](/reference/services/SoftLayer_Hardware_Server/getAverageDailyBandwidthUsage) Retrieve the average daily total bandwidth usage for the current billing cycle. +
              #### [getAverageDailyPrivateBandwidthUsage](/reference/services/SoftLayer_Hardware_Server/getAverageDailyPrivateBandwidthUsage) Retrieve the average daily private bandwidth usage for the current billing cycle. +
              #### [getAverageDailyPublicBandwidthUsage](/reference/services/SoftLayer_Hardware_Server/getAverageDailyPublicBandwidthUsage) Retrieve the average daily public bandwidth usage for the current billing cycle. +
              #### [getBackendBandwidthUsage](/reference/services/SoftLayer_Hardware_Server/getBackendBandwidthUsage) Retrieves public bandwidth usage records. +
              -
              +
              #### [getBackendBandwidthUse](/reference/services/SoftLayer_Hardware_Server/getBackendBandwidthUse) Retrieves private bandwidth usage records. + +Deprecated + +
              #### [getBackendIncomingBandwidth](/reference/services/SoftLayer_Hardware_Server/getBackendIncomingBandwidth) Retrieve the amount of incoming private network bandwidth used by a server over a period of time. +
              #### [getBackendNetworkComponents](/reference/services/SoftLayer_Hardware_Server/getBackendNetworkComponents) Retrieve a piece of hardware's back-end or private network components. +
              #### [getBackendOutgoingBandwidth](/reference/services/SoftLayer_Hardware_Server/getBackendOutgoingBandwidth) Retrieve the amount of outgoing private network bandwidth used by a server over a period of time. +
              #### [getBackendRouters](/reference/services/SoftLayer_Hardware_Server/getBackendRouters) Retrieve a hardware's backend or private router. +
              #### [getBandwidthAllocation](/reference/services/SoftLayer_Hardware_Server/getBandwidthAllocation) Retrieve a hardware's allotted bandwidth (measured in GB). +
              #### [getBandwidthAllotmentDetail](/reference/services/SoftLayer_Hardware_Server/getBandwidthAllotmentDetail) Retrieve a hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. +
              #### [getBandwidthForDateRange](/reference/services/SoftLayer_Hardware_Server/getBandwidthForDateRange) Retrieve bandwidth data from a tracking object. +
              #### [getBandwidthImage](/reference/services/SoftLayer_Hardware_Server/getBandwidthImage) Retrieve a bandwidth image and textual description of that image for this server. +
              #### [getBenchmarkCertifications](/reference/services/SoftLayer_Hardware_Server/getBenchmarkCertifications) Retrieve information regarding a piece of hardware's benchmark certifications. +
              #### [getBillingCycleBandwidthUsage](/reference/services/SoftLayer_Hardware_Server/getBillingCycleBandwidthUsage) Retrieve the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. +
              #### [getBillingCyclePrivateBandwidthUsage](/reference/services/SoftLayer_Hardware_Server/getBillingCyclePrivateBandwidthUsage) Retrieve the raw private bandwidth usage data for the current billing cycle. +
              #### [getBillingCyclePublicBandwidthUsage](/reference/services/SoftLayer_Hardware_Server/getBillingCyclePublicBandwidthUsage) Retrieve the raw public bandwidth usage data for the current billing cycle. +
              #### [getBillingItem](/reference/services/SoftLayer_Hardware_Server/getBillingItem) Retrieve the billing item for a server. +
              #### [getBillingItemFlag](/reference/services/SoftLayer_Hardware_Server/getBillingItemFlag) Retrieve a flag indicating that a billing item exists. +
              #### [getBiosPasswordNullFlag](/reference/services/SoftLayer_Hardware_Server/getBiosPasswordNullFlag) Retrieve determine if BIOS password should be left as null. +
              #### [getBlockCancelBecauseDisconnectedFlag](/reference/services/SoftLayer_Hardware_Server/getBlockCancelBecauseDisconnectedFlag) Retrieve determines whether the hardware is ineligible for cancellation because it is disconnected. +
              #### [getBootModeOptions](/reference/services/SoftLayer_Hardware_Server/getBootModeOptions) Retrieve the valid boot modes for this server. +
              #### [getBusinessContinuanceInsuranceFlag](/reference/services/SoftLayer_Hardware_Server/getBusinessContinuanceInsuranceFlag) Retrieve status indicating whether or not a piece of hardware has business continuance insurance. +
              #### [getCaptureEnabledFlag](/reference/services/SoftLayer_Hardware_Server/getCaptureEnabledFlag) Retrieve determine if the server is able to be image captured. If unable to image capture a reason will be provided. +
              #### [getChildrenHardware](/reference/services/SoftLayer_Hardware_Server/getChildrenHardware) Retrieve child hardware. +
              #### [getComponentDetailsXML](/reference/services/SoftLayer_Hardware_Server/getComponentDetailsXML) +
              #### [getComponents](/reference/services/SoftLayer_Hardware_Server/getComponents) Retrieve a piece of hardware's components. +
              #### [getContainsSolidStateDrivesFlag](/reference/services/SoftLayer_Hardware_Server/getContainsSolidStateDrivesFlag) +
              #### [getContinuousDataProtectionSoftwareComponent](/reference/services/SoftLayer_Hardware_Server/getContinuousDataProtectionSoftwareComponent) Retrieve a continuous data protection/server backup software component object. +
              #### [getControlPanel](/reference/services/SoftLayer_Hardware_Server/getControlPanel) Retrieve a server's control panel. +
              #### [getCost](/reference/services/SoftLayer_Hardware_Server/getCost) Retrieve the total cost of a server, measured in US Dollars ($USD). +
              #### [getCreateObjectOptions](/reference/services/SoftLayer_Hardware_Server/getCreateObjectOptions) Determine options available when creating a server +
              #### [getCurrentBandwidthSummary](/reference/services/SoftLayer_Hardware_Server/getCurrentBandwidthSummary) Retrieve an object that provides commonly used bandwidth summary components for the current billing cycle. +
              #### [getCurrentBenchmarkCertificationResultFile](/reference/services/SoftLayer_Hardware_Server/getCurrentBenchmarkCertificationResultFile) Get the file for the current benchmark certification result, if it exists. +
              #### [getCurrentBillableBandwidthUsage](/reference/services/SoftLayer_Hardware_Server/getCurrentBillableBandwidthUsage) Retrieve the current billable public outbound bandwidth for this hardware for the current billing cycle. +
              #### [getCurrentBillingDetail](/reference/services/SoftLayer_Hardware_Server/getCurrentBillingDetail) << EOT +
              #### [getCurrentBillingTotal](/reference/services/SoftLayer_Hardware_Server/getCurrentBillingTotal) Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges. +
              #### [getCustomBandwidthDataByDate](/reference/services/SoftLayer_Hardware_Server/getCustomBandwidthDataByDate) Retrieve bandwidth graph by date. +
              #### [getCustomerInstalledOperatingSystemFlag](/reference/services/SoftLayer_Hardware_Server/getCustomerInstalledOperatingSystemFlag) Retrieve indicates if a server has a Customer Installed OS +
              #### [getCustomerOwnedFlag](/reference/services/SoftLayer_Hardware_Server/getCustomerOwnedFlag) Retrieve indicates if a server is a customer owned device. +
              #### [getDailyAverage](/reference/services/SoftLayer_Hardware_Server/getDailyAverage) calculate the average daily network traffic used by a server in gigabytes. +
              #### [getDatacenter](/reference/services/SoftLayer_Hardware_Server/getDatacenter) Retrieve information regarding the datacenter in which a piece of hardware resides. +
              #### [getDatacenterName](/reference/services/SoftLayer_Hardware_Server/getDatacenterName) Retrieve the name of the datacenter in which a piece of hardware resides. +
              #### [getDaysInSparePool](/reference/services/SoftLayer_Hardware_Server/getDaysInSparePool) Retrieve number of day(s) a server have been in spare pool. +
              #### [getDownlinkHardware](/reference/services/SoftLayer_Hardware_Server/getDownlinkHardware) Retrieve all hardware that has uplink network connections to a piece of hardware. +
              #### [getDownlinkNetworkHardware](/reference/services/SoftLayer_Hardware_Server/getDownlinkNetworkHardware) Retrieve all hardware that has uplink network connections to a piece of hardware. +
              #### [getDownlinkServers](/reference/services/SoftLayer_Hardware_Server/getDownlinkServers) Retrieve information regarding all servers attached to a piece of network hardware. +
              #### [getDownlinkVirtualGuests](/reference/services/SoftLayer_Hardware_Server/getDownlinkVirtualGuests) Retrieve information regarding all virtual guests attached to a piece of network hardware. +
              #### [getDownstreamHardwareBindings](/reference/services/SoftLayer_Hardware_Server/getDownstreamHardwareBindings) Retrieve all hardware downstream from a network device. +
              #### [getDownstreamNetworkHardware](/reference/services/SoftLayer_Hardware_Server/getDownstreamNetworkHardware) Retrieve all network hardware downstream from the selected piece of hardware. +
              #### [getDownstreamNetworkHardwareWithIncidents](/reference/services/SoftLayer_Hardware_Server/getDownstreamNetworkHardwareWithIncidents) Retrieve all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. +
              #### [getDownstreamServers](/reference/services/SoftLayer_Hardware_Server/getDownstreamServers) Retrieve information regarding all servers attached downstream to a piece of network hardware. +
              #### [getDownstreamVirtualGuests](/reference/services/SoftLayer_Hardware_Server/getDownstreamVirtualGuests) Retrieve information regarding all virtual guests attached to a piece of network hardware. +
              #### [getDriveControllers](/reference/services/SoftLayer_Hardware_Server/getDriveControllers) Retrieve the drive controllers contained within a piece of hardware. +
              #### [getEvaultNetworkStorage](/reference/services/SoftLayer_Hardware_Server/getEvaultNetworkStorage) Retrieve information regarding a piece of hardware's associated EVault network storage service account. +
              #### [getFirewallProtectableSubnets](/reference/services/SoftLayer_Hardware_Server/getFirewallProtectableSubnets) Get the subnets associated with this server that are protectable by a network component firewall. +
              #### [getFirewallServiceComponent](/reference/services/SoftLayer_Hardware_Server/getFirewallServiceComponent) Retrieve information regarding a piece of hardware's firewall services. +
              #### [getFixedConfigurationPreset](/reference/services/SoftLayer_Hardware_Server/getFixedConfigurationPreset) Retrieve defines the fixed components in a fixed configuration bare metal server. +
              #### [getFrontendBandwidthUsage](/reference/services/SoftLayer_Hardware_Server/getFrontendBandwidthUsage) Retrieves public bandwidth usage records. +
              -
              +
              #### [getFrontendBandwidthUse](/reference/services/SoftLayer_Hardware_Server/getFrontendBandwidthUse) Retrieves public bandwidth usage records. + +Deprecated + +
              #### [getFrontendIncomingBandwidth](/reference/services/SoftLayer_Hardware_Server/getFrontendIncomingBandwidth) Retrieve the amount of incoming public network bandwidth used by a server over a period of time. +
              #### [getFrontendNetworkComponents](/reference/services/SoftLayer_Hardware_Server/getFrontendNetworkComponents) Retrieve a piece of hardware's front-end or public network components. +
              #### [getFrontendOutgoingBandwidth](/reference/services/SoftLayer_Hardware_Server/getFrontendOutgoingBandwidth) Retrieve the amount of outgoing public network bandwidth used by a server over a period of time. +
              #### [getFrontendRouters](/reference/services/SoftLayer_Hardware_Server/getFrontendRouters) Retrieve a hardware's frontend or public router. +
              #### [getFutureBillingItem](/reference/services/SoftLayer_Hardware_Server/getFutureBillingItem) Retrieve information regarding the future billing item for a server. +
              #### [getGlobalIdentifier](/reference/services/SoftLayer_Hardware_Server/getGlobalIdentifier) Retrieve a hardware's universally unique identifier. +
              #### [getHardDrives](/reference/services/SoftLayer_Hardware_Server/getHardDrives) Retrieve the hard drives contained within a piece of hardware. +
              #### [getHardwareByIpAddress](/reference/services/SoftLayer_Hardware_Server/getHardwareByIpAddress) Retrieve a SoftLayer_Hardware_Server object by IP address. +
              #### [getHardwareChassis](/reference/services/SoftLayer_Hardware_Server/getHardwareChassis) Retrieve the chassis that a piece of hardware is housed in. +
              #### [getHardwareFunction](/reference/services/SoftLayer_Hardware_Server/getHardwareFunction) Retrieve a hardware's function. +
              #### [getHardwareFunctionDescription](/reference/services/SoftLayer_Hardware_Server/getHardwareFunctionDescription) Retrieve a hardware's function. +
              #### [getHardwareStatus](/reference/services/SoftLayer_Hardware_Server/getHardwareStatus) Retrieve a hardware's status. +
              #### [getHasSingleRootVirtualizationBillingItemFlag](/reference/services/SoftLayer_Hardware_Server/getHasSingleRootVirtualizationBillingItemFlag) Retrieve determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item. +
              #### [getHasTrustedPlatformModuleBillingItemFlag](/reference/services/SoftLayer_Hardware_Server/getHasTrustedPlatformModuleBillingItemFlag) Retrieve determine in hardware object has TPM enabled. +
              #### [getHostIpsSoftwareComponent](/reference/services/SoftLayer_Hardware_Server/getHostIpsSoftwareComponent) Retrieve information regarding a host IPS software component object. +
              #### [getHourlyBandwidth](/reference/services/SoftLayer_Hardware_Server/getHourlyBandwidth) Retrieves bandwidth hourly over a 24-hour period for the specified hardware. +
              #### [getHourlyBillingFlag](/reference/services/SoftLayer_Hardware_Server/getHourlyBillingFlag) Retrieve a server's hourly billing status. +
              #### [getInboundBandwidthUsage](/reference/services/SoftLayer_Hardware_Server/getInboundBandwidthUsage) Retrieve the sum of all the inbound network traffic data for the last 30 days. +
              #### [getInboundPrivateBandwidthUsage](/reference/services/SoftLayer_Hardware_Server/getInboundPrivateBandwidthUsage) Retrieve the total private inbound bandwidth for this hardware for the current billing cycle. +
              #### [getInboundPublicBandwidthUsage](/reference/services/SoftLayer_Hardware_Server/getInboundPublicBandwidthUsage) Retrieve the total public inbound bandwidth for this hardware for the current billing cycle. +
              #### [getIsBillingTermChangeAvailableFlag](/reference/services/SoftLayer_Hardware_Server/getIsBillingTermChangeAvailableFlag) Retrieve whether or not this hardware object is eligible to change to term billing. +
              #### [getIsCloudReadyNodeCertified](/reference/services/SoftLayer_Hardware_Server/getIsCloudReadyNodeCertified) Retrieve determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute. +
              #### [getIsIpmiDisabled](/reference/services/SoftLayer_Hardware_Server/getIsIpmiDisabled) Retrieve determine if remote management has been disabled due to port speed. +
              #### [getIsVirtualPrivateCloudNode](/reference/services/SoftLayer_Hardware_Server/getIsVirtualPrivateCloudNode) Retrieve determine if hardware object is a Virtual Private Cloud node. +
              #### [getItemPricesFromSoftwareDescriptions](/reference/services/SoftLayer_Hardware_Server/getItemPricesFromSoftwareDescriptions) Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description +
              #### [getLastOperatingSystemReload](/reference/services/SoftLayer_Hardware_Server/getLastOperatingSystemReload) Retrieve the last transaction that a server's operating system was loaded. +
              #### [getLastTransaction](/reference/services/SoftLayer_Hardware_Server/getLastTransaction) Retrieve information regarding the last transaction a server performed. +
              #### [getLatestNetworkMonitorIncident](/reference/services/SoftLayer_Hardware_Server/getLatestNetworkMonitorIncident) Retrieve a piece of hardware's latest network monitoring incident. +
              #### [getLocation](/reference/services/SoftLayer_Hardware_Server/getLocation) Retrieve where a piece of hardware is located within SoftLayer's location hierarchy. +
              #### [getLocationPathString](/reference/services/SoftLayer_Hardware_Server/getLocationPathString) +
              #### [getLockboxNetworkStorage](/reference/services/SoftLayer_Hardware_Server/getLockboxNetworkStorage) Retrieve information regarding a lockbox account associated with a server. +
              #### [getLogicalVolumeStorageGroups](/reference/services/SoftLayer_Hardware_Server/getLogicalVolumeStorageGroups) Retrieve returns a list of logical volumes on the physical machine. +
              #### [getManagedResourceFlag](/reference/services/SoftLayer_Hardware_Server/getManagedResourceFlag) Retrieve a flag indicating that the hardware is a managed resource. +
              #### [getManagementNetworkComponent](/reference/services/SoftLayer_Hardware_Server/getManagementNetworkComponent) Retrieve a server's management network component. +
              #### [getMemory](/reference/services/SoftLayer_Hardware_Server/getMemory) Retrieve information regarding a piece of hardware's memory. +
              #### [getMemoryCapacity](/reference/services/SoftLayer_Hardware_Server/getMemoryCapacity) Retrieve the amount of memory a piece of hardware has, measured in gigabytes. +
              #### [getMetricTrackingObject](/reference/services/SoftLayer_Hardware_Server/getMetricTrackingObject) Retrieve a piece of hardware's metric tracking object. +
              #### [getMetricTrackingObjectId](/reference/services/SoftLayer_Hardware_Server/getMetricTrackingObjectId) Retrieve the metric tracking object id for this server. +
              #### [getModules](/reference/services/SoftLayer_Hardware_Server/getModules) +
              #### [getMonitoringRobot](/reference/services/SoftLayer_Hardware_Server/getMonitoringRobot) +
              #### [getMonitoringServiceComponent](/reference/services/SoftLayer_Hardware_Server/getMonitoringServiceComponent) Retrieve information regarding a piece of hardware's network monitoring services. +
              #### [getMonitoringServiceEligibilityFlag](/reference/services/SoftLayer_Hardware_Server/getMonitoringServiceEligibilityFlag) +
              #### [getMonitoringUserNotification](/reference/services/SoftLayer_Hardware_Server/getMonitoringUserNotification) Retrieve the monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails +
              #### [getMotherboard](/reference/services/SoftLayer_Hardware_Server/getMotherboard) Retrieve a server's motherboard. +
              #### [getNetworkCards](/reference/services/SoftLayer_Hardware_Server/getNetworkCards) Retrieve information regarding a piece of hardware's network cards. +
              #### [getNetworkComponentFirewallProtectableIpAddresses](/reference/services/SoftLayer_Hardware_Server/getNetworkComponentFirewallProtectableIpAddresses) Get the IP addresses associated with this server that are protectable by a network component firewall. +
              #### [getNetworkComponents](/reference/services/SoftLayer_Hardware_Server/getNetworkComponents) Retrieve returns a hardware's network components. +
              #### [getNetworkGatewayMember](/reference/services/SoftLayer_Hardware_Server/getNetworkGatewayMember) Retrieve the gateway member if this device is part of a network gateway. +
              #### [getNetworkGatewayMemberFlag](/reference/services/SoftLayer_Hardware_Server/getNetworkGatewayMemberFlag) Retrieve whether or not this device is part of a network gateway. +
              #### [getNetworkManagementIpAddress](/reference/services/SoftLayer_Hardware_Server/getNetworkManagementIpAddress) Retrieve a piece of hardware's network management IP address. +
              #### [getNetworkMonitorAttachedDownHardware](/reference/services/SoftLayer_Hardware_Server/getNetworkMonitorAttachedDownHardware) Retrieve all servers with failed monitoring that are attached downstream to a piece of hardware. +
              #### [getNetworkMonitorAttachedDownVirtualGuests](/reference/services/SoftLayer_Hardware_Server/getNetworkMonitorAttachedDownVirtualGuests) Retrieve virtual guests that are attached downstream to a hardware that have failed monitoring +
              #### [getNetworkMonitorIncidents](/reference/services/SoftLayer_Hardware_Server/getNetworkMonitorIncidents) Retrieve the status of all of a piece of hardware's network monitoring incidents. +
              #### [getNetworkMonitors](/reference/services/SoftLayer_Hardware_Server/getNetworkMonitors) Retrieve information regarding a piece of hardware's network monitors. +
              #### [getNetworkStatus](/reference/services/SoftLayer_Hardware_Server/getNetworkStatus) Retrieve the value of a hardware's network status attribute. +
              #### [getNetworkStatusAttribute](/reference/services/SoftLayer_Hardware_Server/getNetworkStatusAttribute) Retrieve the hardware's related network status attribute. +
              #### [getNetworkStorage](/reference/services/SoftLayer_Hardware_Server/getNetworkStorage) Retrieve information regarding a piece of hardware's associated network storage service account. +
              #### [getNetworkVlans](/reference/services/SoftLayer_Hardware_Server/getNetworkVlans) Retrieve the network virtual LANs (VLANs) associated with a piece of hardware's network components. +
              #### [getNextBillingCycleBandwidthAllocation](/reference/services/SoftLayer_Hardware_Server/getNextBillingCycleBandwidthAllocation) Retrieve a hardware's allotted bandwidth for the next billing cycle (measured in GB). +
              #### [getNotesHistory](/reference/services/SoftLayer_Hardware_Server/getNotesHistory) +
              #### [getNvRamCapacity](/reference/services/SoftLayer_Hardware_Server/getNvRamCapacity) Retrieve the amount of non-volatile memory a piece of hardware has, measured in gigabytes. +
              #### [getNvRamComponentModels](/reference/services/SoftLayer_Hardware_Server/getNvRamComponentModels) +
              #### [getObject](/reference/services/SoftLayer_Hardware_Server/getObject) Retrieve a SoftLayer_Hardware_Server record. +
              #### [getOpenCancellationTicket](/reference/services/SoftLayer_Hardware_Server/getOpenCancellationTicket) Retrieve an open ticket requesting cancellation of this server, if one exists. +
              #### [getOperatingSystem](/reference/services/SoftLayer_Hardware_Server/getOperatingSystem) Retrieve information regarding a piece of hardware's operating system. +
              #### [getOperatingSystemReferenceCode](/reference/services/SoftLayer_Hardware_Server/getOperatingSystemReferenceCode) Retrieve a hardware's operating system software description. +
              #### [getOutboundBandwidthUsage](/reference/services/SoftLayer_Hardware_Server/getOutboundBandwidthUsage) Retrieve the sum of all the outbound network traffic data for the last 30 days. +
              #### [getOutboundPrivateBandwidthUsage](/reference/services/SoftLayer_Hardware_Server/getOutboundPrivateBandwidthUsage) Retrieve the total private outbound bandwidth for this hardware for the current billing cycle. +
              #### [getOutboundPublicBandwidthUsage](/reference/services/SoftLayer_Hardware_Server/getOutboundPublicBandwidthUsage) Retrieve the total public outbound bandwidth for this hardware for the current billing cycle. +
              #### [getOverBandwidthAllocationFlag](/reference/services/SoftLayer_Hardware_Server/getOverBandwidthAllocationFlag) Retrieve whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation. +
              #### [getPMInfo](/reference/services/SoftLayer_Hardware_Server/getPMInfo) Retrieve a server's hardware state via its internal sensors. +
              #### [getParentBay](/reference/services/SoftLayer_Hardware_Server/getParentBay) Retrieve blade Bay +
              #### [getParentHardware](/reference/services/SoftLayer_Hardware_Server/getParentHardware) Retrieve parent Hardware. +
              #### [getPartitions](/reference/services/SoftLayer_Hardware_Server/getPartitions) +
              #### [getPointOfPresenceLocation](/reference/services/SoftLayer_Hardware_Server/getPointOfPresenceLocation) Retrieve information regarding the Point of Presence (PoP) location in which a piece of hardware resides. +
              #### [getPowerComponents](/reference/services/SoftLayer_Hardware_Server/getPowerComponents) Retrieve the power components for a hardware object. +
              #### [getPowerSupply](/reference/services/SoftLayer_Hardware_Server/getPowerSupply) Retrieve a server's power supply. +
              #### [getPrimaryBackendIpAddress](/reference/services/SoftLayer_Hardware_Server/getPrimaryBackendIpAddress) Retrieve the hardware's primary private IP address. +
              #### [getPrimaryBackendNetworkComponent](/reference/services/SoftLayer_Hardware_Server/getPrimaryBackendNetworkComponent) Retrieve information regarding the hardware's primary back-end network component. +
              #### [getPrimaryDriveSize](/reference/services/SoftLayer_Hardware_Server/getPrimaryDriveSize) +
              #### [getPrimaryIpAddress](/reference/services/SoftLayer_Hardware_Server/getPrimaryIpAddress) Retrieve the hardware's primary public IP address. +
              #### [getPrimaryNetworkComponent](/reference/services/SoftLayer_Hardware_Server/getPrimaryNetworkComponent) Retrieve information regarding the hardware's primary public network component. +
              #### [getPrivateBandwidthData](/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthData) Retrieve a graph of a server's private network usage. +
              #### [getPrivateBandwidthDataSummary](/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthDataSummary) Retrieve a server's private bandwidth usage summary +
              #### [getPrivateBandwidthGraphImage](/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthGraphImage) Retrieve a graph of a server's private network usage. +
              #### [getPrivateIpAddress](/reference/services/SoftLayer_Hardware_Server/getPrivateIpAddress) Retrieve a server's primary private IP address. +
              #### [getPrivateNetworkComponent](/reference/services/SoftLayer_Hardware_Server/getPrivateNetworkComponent) Retrieve a server's private network component. +
              #### [getPrivateNetworkOnlyFlag](/reference/services/SoftLayer_Hardware_Server/getPrivateNetworkOnlyFlag) Retrieve whether the hardware only has access to the private network. +
              #### [getPrivateVlan](/reference/services/SoftLayer_Hardware_Server/getPrivateVlan) Retrieve the backend VLAN for the primary IP address of the server. +
              -
              +
              #### [getPrivateVlanByIpAddress](/reference/services/SoftLayer_Hardware_Server/getPrivateVlanByIpAddress) Retrieve a backend network VLAN by searching for an IP address. + +Deprecated + +
              #### [getProcessorCoreAmount](/reference/services/SoftLayer_Hardware_Server/getProcessorCoreAmount) Retrieve the total number of processor cores, summed from all processors that are attached to a piece of hardware +
              #### [getProcessorPhysicalCoreAmount](/reference/services/SoftLayer_Hardware_Server/getProcessorPhysicalCoreAmount) Retrieve the total number of physical processor cores, summed from all processors that are attached to a piece of hardware +
              #### [getProcessors](/reference/services/SoftLayer_Hardware_Server/getProcessors) Retrieve information regarding a piece of hardware's processors. +
              #### [getProjectedOverBandwidthAllocationFlag](/reference/services/SoftLayer_Hardware_Server/getProjectedOverBandwidthAllocationFlag) Retrieve whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation. +
              #### [getProjectedPublicBandwidthUsage](/reference/services/SoftLayer_Hardware_Server/getProjectedPublicBandwidthUsage) Retrieve the projected public outbound bandwidth for this hardware for the current billing cycle. +
              #### [getProvisionDate](/reference/services/SoftLayer_Hardware_Server/getProvisionDate) +
              #### [getPublicBandwidthData](/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthData) Retrieve a graph of a server's public network usage. +
              #### [getPublicBandwidthDataSummary](/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthDataSummary) Retrieve a server's public bandwidth usage summary +
              #### [getPublicBandwidthGraphImage](/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthGraphImage) Retrieve a graph of a server's public network usage. +
              #### [getPublicBandwidthTotal](/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthTotal) Retrieve total number of public bytes used by a server over time period specified. +
              #### [getPublicNetworkComponent](/reference/services/SoftLayer_Hardware_Server/getPublicNetworkComponent) Retrieve a server's public network component. +
              #### [getPublicVlan](/reference/services/SoftLayer_Hardware_Server/getPublicVlan) Retrieve the frontend VLAN for the primary IP address of the server +
              #### [getPublicVlanByHostname](/reference/services/SoftLayer_Hardware_Server/getPublicVlanByHostname) Retrieve the frontend VLAN by a server's hostname. +
              #### [getRack](/reference/services/SoftLayer_Hardware_Server/getRack) +
              #### [getRaidControllers](/reference/services/SoftLayer_Hardware_Server/getRaidControllers) Retrieve the RAID controllers contained within a piece of hardware. +
              #### [getReadyNodeFlag](/reference/services/SoftLayer_Hardware_Server/getReadyNodeFlag) Retrieve determine if hardware object is vSan Ready Node. +
              #### [getRecentEvents](/reference/services/SoftLayer_Hardware_Server/getRecentEvents) Retrieve recent events that impact this hardware. +
              #### [getRecentRemoteManagementCommands](/reference/services/SoftLayer_Hardware_Server/getRecentRemoteManagementCommands) Retrieve the last five commands issued to the server's remote management card. +
              #### [getRegionalInternetRegistry](/reference/services/SoftLayer_Hardware_Server/getRegionalInternetRegistry) +
              #### [getRemoteManagement](/reference/services/SoftLayer_Hardware_Server/getRemoteManagement) Retrieve a server's remote management card. +
              #### [getRemoteManagementAccounts](/reference/services/SoftLayer_Hardware_Server/getRemoteManagementAccounts) Retrieve user credentials to issue commands and/or interact with the server's remote management card. +
              #### [getRemoteManagementComponent](/reference/services/SoftLayer_Hardware_Server/getRemoteManagementComponent) Retrieve a hardware's associated remote management component. This is normally IPMI. +
              #### [getRemoteManagementUsers](/reference/services/SoftLayer_Hardware_Server/getRemoteManagementUsers) Retrieve user(s) who have access to issue commands and/or interact with the server's remote management card. +
              #### [getResourceConfigurations](/reference/services/SoftLayer_Hardware_Server/getResourceConfigurations) +
              #### [getResourceGroupMemberReferences](/reference/services/SoftLayer_Hardware_Server/getResourceGroupMemberReferences) +
              #### [getResourceGroupRoles](/reference/services/SoftLayer_Hardware_Server/getResourceGroupRoles) +
              #### [getResourceGroups](/reference/services/SoftLayer_Hardware_Server/getResourceGroups) Retrieve the resource groups in which this hardware is a member. +
              #### [getReverseDomainRecords](/reference/services/SoftLayer_Hardware_Server/getReverseDomainRecords) Retrieve the reverse domain records associated with a server. +
              #### [getRouters](/reference/services/SoftLayer_Hardware_Server/getRouters) Retrieve a hardware's routers. +
              #### [getScaleAssets](/reference/services/SoftLayer_Hardware_Server/getScaleAssets) Retrieve collection of scale assets this hardware corresponds to. +
              #### [getSecurityScanRequests](/reference/services/SoftLayer_Hardware_Server/getSecurityScanRequests) Retrieve information regarding a piece of hardware's vulnerability scan requests. +
              #### [getSensorData](/reference/services/SoftLayer_Hardware_Server/getSensorData) Retrieve a server's hardware state via its internal sensors. +
              #### [getSensorDataWithGraphs](/reference/services/SoftLayer_Hardware_Server/getSensorDataWithGraphs) Retrieve server's temperature and fan speed graphs as well the sensor raw data. +
              #### [getServerDetails](/reference/services/SoftLayer_Hardware_Server/getServerDetails) Retrieve a server's hardware components, software, and network components. +
              #### [getServerFanSpeedGraphs](/reference/services/SoftLayer_Hardware_Server/getServerFanSpeedGraphs) Retrieve server's fan speed graphs. +
              #### [getServerPowerState](/reference/services/SoftLayer_Hardware_Server/getServerPowerState) Retrieves server's power state +
              #### [getServerRoom](/reference/services/SoftLayer_Hardware_Server/getServerRoom) Retrieve information regarding the server room in which the hardware is located. +
              #### [getServerTemperatureGraphs](/reference/services/SoftLayer_Hardware_Server/getServerTemperatureGraphs) Retrieve server's temperature graphs +
              #### [getServiceProvider](/reference/services/SoftLayer_Hardware_Server/getServiceProvider) Retrieve information regarding the piece of hardware's service provider. +
              #### [getSoftwareComponents](/reference/services/SoftLayer_Hardware_Server/getSoftwareComponents) Retrieve information regarding a piece of hardware's installed software. +
              #### [getSoftwareGuardExtensionEnabled](/reference/services/SoftLayer_Hardware_Server/getSoftwareGuardExtensionEnabled) Retrieve determine if hardware object has Software Guard Extension (SGX) enabled. +
              #### [getSshKeys](/reference/services/SoftLayer_Hardware_Server/getSshKeys) Retrieve sSH keys to be installed on the server during provisioning or an OS reload. +
              #### [getStatisticsRemoteManagement](/reference/services/SoftLayer_Hardware_Server/getStatisticsRemoteManagement) Retrieve a server's remote management card used for statistics. +
              #### [getStorageGroups](/reference/services/SoftLayer_Hardware_Server/getStorageGroups) +
              #### [getStorageNetworkComponents](/reference/services/SoftLayer_Hardware_Server/getStorageNetworkComponents) Retrieve a piece of hardware's private storage network components. [Deprecated] +
              #### [getTagReferences](/reference/services/SoftLayer_Hardware_Server/getTagReferences) +
              #### [getTopLevelLocation](/reference/services/SoftLayer_Hardware_Server/getTopLevelLocation) +
              #### [getTransactionHistory](/reference/services/SoftLayer_Hardware_Server/getTransactionHistory) Get transaction history for a piece of hardware. +
              #### [getUefiBootFlag](/reference/services/SoftLayer_Hardware_Server/getUefiBootFlag) Retrieve whether to use UEFI boot instead of BIOS. +
              #### [getUpgradeItemPrices](/reference/services/SoftLayer_Hardware_Server/getUpgradeItemPrices) Retrieve a list of upgradable items available to a piece of hardware. +
              #### [getUpgradeRequest](/reference/services/SoftLayer_Hardware_Server/getUpgradeRequest) Retrieve an account's associated upgrade request object, if any. +
              #### [getUplinkHardware](/reference/services/SoftLayer_Hardware_Server/getUplinkHardware) Retrieve the network device connected to a piece of hardware. +
              #### [getUplinkNetworkComponents](/reference/services/SoftLayer_Hardware_Server/getUplinkNetworkComponents) Retrieve information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. +
              #### [getUserData](/reference/services/SoftLayer_Hardware_Server/getUserData) Retrieve an array containing a single string of custom user data for a hardware order. Max size is 16 kb. +
              #### [getUsers](/reference/services/SoftLayer_Hardware_Server/getUsers) Retrieve a list of users that have access to this computing instance. +
              #### [getValidBlockDeviceTemplateGroups](/reference/services/SoftLayer_Hardware_Server/getValidBlockDeviceTemplateGroups) Return a list of valid block device template groups based on this host +
              #### [getVirtualChassis](/reference/services/SoftLayer_Hardware_Server/getVirtualChassis) Retrieve information regarding the virtual chassis for a piece of hardware. +
              #### [getVirtualChassisSiblings](/reference/services/SoftLayer_Hardware_Server/getVirtualChassisSiblings) Retrieve information regarding the virtual chassis siblings for a piece of hardware. +
              #### [getVirtualGuests](/reference/services/SoftLayer_Hardware_Server/getVirtualGuests) Retrieve a hardware server's virtual servers. +
              #### [getVirtualHost](/reference/services/SoftLayer_Hardware_Server/getVirtualHost) Retrieve a piece of hardware's virtual host record. +
              #### [getVirtualLicenses](/reference/services/SoftLayer_Hardware_Server/getVirtualLicenses) Retrieve information regarding a piece of hardware's virtual software licenses. +
              #### [getVirtualRack](/reference/services/SoftLayer_Hardware_Server/getVirtualRack) Retrieve information regarding the bandwidth allotment to which a piece of hardware belongs. +
              #### [getVirtualRackId](/reference/services/SoftLayer_Hardware_Server/getVirtualRackId) Retrieve the name of the bandwidth allotment belonging to a piece of hardware. +
              #### [getVirtualRackName](/reference/services/SoftLayer_Hardware_Server/getVirtualRackName) Retrieve the name of the bandwidth allotment belonging to a piece of hardware. +
              #### [getVirtualizationPlatform](/reference/services/SoftLayer_Hardware_Server/getVirtualizationPlatform) Retrieve a piece of hardware's virtualization platform software. +
              #### [getWindowsUpdateAvailableUpdates](/reference/services/SoftLayer_Hardware_Server/getWindowsUpdateAvailableUpdates) Retrieve a list of Windows updates available to a server. +
              #### [getWindowsUpdateInstalledUpdates](/reference/services/SoftLayer_Hardware_Server/getWindowsUpdateInstalledUpdates) Retrieve a list of Windows updates installed on a server. +
              #### [getWindowsUpdateStatus](/reference/services/SoftLayer_Hardware_Server/getWindowsUpdateStatus) Retrieve a server's Windows update synchronization status +
              #### [importVirtualHost](/reference/services/SoftLayer_Hardware_Server/importVirtualHost) attempt to import the host record for the virtualization platform running on a server +
              #### [initiateIderaBareMetalRestore](/reference/services/SoftLayer_Hardware_Server/initiateIderaBareMetalRestore) Initiate an Idera bare metal restore for the server tied to an Idera Server Backup +
              #### [initiateR1SoftBareMetalRestore](/reference/services/SoftLayer_Hardware_Server/initiateR1SoftBareMetalRestore) Initiate an R1Soft bare metal restore for the server tied to an R1Soft CDP Server +
              #### [isBackendPingable](/reference/services/SoftLayer_Hardware_Server/isBackendPingable) Verifies if a server's backend ip address is pingable. +
              #### [isPingable](/reference/services/SoftLayer_Hardware_Server/isPingable) Verifies if server is pingable. +
              #### [isWindowsServer](/reference/services/SoftLayer_Hardware_Server/isWindowsServer) Determine if a server runs the Microsoft Windows operating system. +
              #### [massFirmwareReflash](/reference/services/SoftLayer_Hardware_Server/massFirmwareReflash) Runs firmware reflashes on the servers components. +
              #### [massFirmwareUpdate](/reference/services/SoftLayer_Hardware_Server/massFirmwareUpdate) Runs firmware updates on the servers components. +
              #### [massHyperThreadingUpdate](/reference/services/SoftLayer_Hardware_Server/massHyperThreadingUpdate) Runs firmware reflashes on the servers components. +
              #### [massReloadOperatingSystem](/reference/services/SoftLayer_Hardware_Server/massReloadOperatingSystem) Reloads operating system configuration on a set of hardware Ids. +
              #### [massSparePool](/reference/services/SoftLayer_Hardware_Server/massSparePool) Allows multiple servers to be added to or removed from the spare pool. +
              #### [ping](/reference/services/SoftLayer_Hardware_Server/ping) Issues ping command. +
              #### [populateServerRam](/reference/services/SoftLayer_Hardware_Server/populateServerRam) +
              #### [powerCycle](/reference/services/SoftLayer_Hardware_Server/powerCycle) Issues power cycle to server. +
              #### [powerOff](/reference/services/SoftLayer_Hardware_Server/powerOff) Power off server. +
              #### [powerOn](/reference/services/SoftLayer_Hardware_Server/powerOn) Power on server. +
              #### [rebootDefault](/reference/services/SoftLayer_Hardware_Server/rebootDefault) Reboot the server via the default method. +
              #### [rebootHard](/reference/services/SoftLayer_Hardware_Server/rebootHard) Reboot the server via "hard" reboot. +
              #### [rebootSoft](/reference/services/SoftLayer_Hardware_Server/rebootSoft) Reboot the server via gracefully (soft reboot). +
              #### [reloadCurrentOperatingSystemConfiguration](/reference/services/SoftLayer_Hardware_Server/reloadCurrentOperatingSystemConfiguration) Reloads current operating system configuration. +
              #### [reloadOperatingSystem](/reference/services/SoftLayer_Hardware_Server/reloadOperatingSystem) Reloads operating system configuration. +
              #### [removeAccessToNetworkStorage](/reference/services/SoftLayer_Hardware_Server/removeAccessToNetworkStorage) Remove access to a SoftLayer_Network_Storage volume from this device. +
              #### [removeAccessToNetworkStorageList](/reference/services/SoftLayer_Hardware_Server/removeAccessToNetworkStorageList) Remove access to multiple SoftLayer_Network_Storage volumes from this device. +
              #### [removeTags](/reference/services/SoftLayer_Hardware_Server/removeTags) Remove a tag reference +
              #### [runPassmarkCertificationBenchmark](/reference/services/SoftLayer_Hardware_Server/runPassmarkCertificationBenchmark) Runs a hardware stress test on the server to obtain a Passmark Certification. +
              #### [setOperatingSystemPassword](/reference/services/SoftLayer_Hardware_Server/setOperatingSystemPassword) Changes the password stored in our system for a servers' Operating System +
              #### [setPrivateNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed) Set the speed and redundancy configuration of a server's private network interface. +
              #### [setPublicNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed) Set the speed and redundancy configuration of a server's public network interface. +
              #### [setTags](/reference/services/SoftLayer_Hardware_Server/setTags) +
              #### [setUserMetadata](/reference/services/SoftLayer_Hardware_Server/setUserMetadata) Sets the server's user metadata value. +
              #### [shutdownPrivatePort](/reference/services/SoftLayer_Hardware_Server/shutdownPrivatePort) Disconnect a server's private network interface. +
              #### [shutdownPublicPort](/reference/services/SoftLayer_Hardware_Server/shutdownPublicPort) Disconnect a server's public network interface. +
              #### [sparePool](/reference/services/SoftLayer_Hardware_Server/sparePool) Allows servers to be added to or removed from the spare pool. +
              #### [testRaidAlertService](/reference/services/SoftLayer_Hardware_Server/testRaidAlertService) Tests the RAID Alert service. +
              #### [toggleManagementInterface](/reference/services/SoftLayer_Hardware_Server/toggleManagementInterface) Toggle the IPMI interface on and off. +
              #### [updateIpmiPassword](/reference/services/SoftLayer_Hardware_Server/updateIpmiPassword) Update the root IPMI user password +
              #### [validatePartitionsForOperatingSystem](/reference/services/SoftLayer_Hardware_Server/validatePartitionsForOperatingSystem) Validates a collection of partitions for an operating system +
              diff --git a/content/reference/services/SoftLayer_Hardware_Server/activatePrivatePort.md b/content/reference/services/SoftLayer_Hardware_Server/activatePrivatePort.md index 188076e01b..e59d2297c0 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/activatePrivatePort.md +++ b/content/reference/services/SoftLayer_Hardware_Server/activatePrivatePort.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::activatePrivatePort + Activate a server's private network interface. diff --git a/content/reference/services/SoftLayer_Hardware_Server/activatePublicPort.md b/content/reference/services/SoftLayer_Hardware_Server/activatePublicPort.md index 77b9b59f9a..f9ed3f5c73 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/activatePublicPort.md +++ b/content/reference/services/SoftLayer_Hardware_Server/activatePublicPort.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::activatePublicPort + Activate a server's public network interface. diff --git a/content/reference/services/SoftLayer_Hardware_Server/allowAccessToNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_Server/allowAccessToNetworkStorage.md index f012546a53..5a1c118bb2 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/allowAccessToNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/allowAccessToNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::allowAccessToNetworkStorage + Allow access to a SoftLayer_Network_Storage volume from this device. diff --git a/content/reference/services/SoftLayer_Hardware_Server/allowAccessToNetworkStorageList.md b/content/reference/services/SoftLayer_Hardware_Server/allowAccessToNetworkStorageList.md index 2414755364..4ae8aef8a1 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/allowAccessToNetworkStorageList.md +++ b/content/reference/services/SoftLayer_Hardware_Server/allowAccessToNetworkStorageList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::allowAccessToNetworkStorageList + Allow access to multiple SoftLayer_Network_Storage volumes from this device. diff --git a/content/reference/services/SoftLayer_Hardware_Server/bootToRescueLayer.md b/content/reference/services/SoftLayer_Hardware_Server/bootToRescueLayer.md index 59f7c55985..5c97535054 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/bootToRescueLayer.md +++ b/content/reference/services/SoftLayer_Hardware_Server/bootToRescueLayer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::bootToRescueLayer + Initiates the Rescue Kernel to bring a server online to troubleshoot system problems. diff --git a/content/reference/services/SoftLayer_Hardware_Server/captureImage.md b/content/reference/services/SoftLayer_Hardware_Server/captureImage.md index fd1c1d0234..cd91b9bc17 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/captureImage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/captureImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::captureImage + Captures an Image of the hard disk on the physical machine. diff --git a/content/reference/services/SoftLayer_Hardware_Server/createFirmwareReflashTransaction.md b/content/reference/services/SoftLayer_Hardware_Server/createFirmwareReflashTransaction.md index e928311a30..12cd599a70 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/createFirmwareReflashTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_Server/createFirmwareReflashTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::createFirmwareReflashTransaction + Runs firmware reflash on the servers components. diff --git a/content/reference/services/SoftLayer_Hardware_Server/createFirmwareUpdateTransaction.md b/content/reference/services/SoftLayer_Hardware_Server/createFirmwareUpdateTransaction.md index eb15bad10e..087f796d43 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/createFirmwareUpdateTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_Server/createFirmwareUpdateTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::createFirmwareUpdateTransaction + Runs firmware updates on the servers components. diff --git a/content/reference/services/SoftLayer_Hardware_Server/createHyperThreadingUpdateTransaction.md b/content/reference/services/SoftLayer_Hardware_Server/createHyperThreadingUpdateTransaction.md index fe6b7143fe..f05cde4b54 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/createHyperThreadingUpdateTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_Server/createHyperThreadingUpdateTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::createHyperThreadingUpdateTransaction + Runs BIOS update on the server to change the hyper-threading configuration. diff --git a/content/reference/services/SoftLayer_Hardware_Server/createObject.md b/content/reference/services/SoftLayer_Hardware_Server/createObject.md index 8c924cfca4..14acf1d49a 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/createObject.md +++ b/content/reference/services/SoftLayer_Hardware_Server/createObject.md @@ -14,6 +14,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::createObject + Create a new server diff --git a/content/reference/services/SoftLayer_Hardware_Server/createPostSoftwareInstallTransaction.md b/content/reference/services/SoftLayer_Hardware_Server/createPostSoftwareInstallTransaction.md index 972a283129..19502474d1 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/createPostSoftwareInstallTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_Server/createPostSoftwareInstallTransaction.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/deleteObject.md b/content/reference/services/SoftLayer_Hardware_Server/deleteObject.md index 67a8c2b1f7..4f25d4b93e 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/deleteObject.md +++ b/content/reference/services/SoftLayer_Hardware_Server/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::deleteObject + Delete a server diff --git a/content/reference/services/SoftLayer_Hardware_Server/deleteSoftwareComponentPasswords.md b/content/reference/services/SoftLayer_Hardware_Server/deleteSoftwareComponentPasswords.md index b2bbbf84e0..efa2beeb2c 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/deleteSoftwareComponentPasswords.md +++ b/content/reference/services/SoftLayer_Hardware_Server/deleteSoftwareComponentPasswords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::deleteSoftwareComponentPasswords + Delete software component passwords. diff --git a/content/reference/services/SoftLayer_Hardware_Server/deleteTag.md b/content/reference/services/SoftLayer_Hardware_Server/deleteTag.md index 6b167ea61e..0ebd3da0ad 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/deleteTag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/deleteTag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::deleteTag + Delete a tag diff --git a/content/reference/services/SoftLayer_Hardware_Server/editObject.md b/content/reference/services/SoftLayer_Hardware_Server/editObject.md index 847cde8de5..72b5f986f9 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/editObject.md +++ b/content/reference/services/SoftLayer_Hardware_Server/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::editObject + Edit a server's properties diff --git a/content/reference/services/SoftLayer_Hardware_Server/editSoftwareComponentPasswords.md b/content/reference/services/SoftLayer_Hardware_Server/editSoftwareComponentPasswords.md index 4680ca8be1..7f01b7b002 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/editSoftwareComponentPasswords.md +++ b/content/reference/services/SoftLayer_Hardware_Server/editSoftwareComponentPasswords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::editSoftwareComponentPasswords + Edit the properties of software component passwords. diff --git a/content/reference/services/SoftLayer_Hardware_Server/executeRemoteScript.md b/content/reference/services/SoftLayer_Hardware_Server/executeRemoteScript.md index cd2ecd5e4b..d95fdeebf2 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/executeRemoteScript.md +++ b/content/reference/services/SoftLayer_Hardware_Server/executeRemoteScript.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::executeRemoteScript + Download and run remote script from uri on the hardware. Requires https for script to be executed after download. diff --git a/content/reference/services/SoftLayer_Hardware_Server/findByIpAddress.md b/content/reference/services/SoftLayer_Hardware_Server/findByIpAddress.md index da9b0b6ee3..5a3a59e042 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/findByIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_Server/findByIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::findByIpAddress + Find hardware by its primary public or private IP (ipv4) address. diff --git a/content/reference/services/SoftLayer_Hardware_Server/generateOrderTemplate.md b/content/reference/services/SoftLayer_Hardware_Server/generateOrderTemplate.md index 7937df5ba6..8305b269ef 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/generateOrderTemplate.md +++ b/content/reference/services/SoftLayer_Hardware_Server/generateOrderTemplate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::generateOrderTemplate + Obtain an order container for a given template object diff --git a/content/reference/services/SoftLayer_Hardware_Server/getAccount.md b/content/reference/services/SoftLayer_Hardware_Server/getAccount.md index 3966f10f22..185a7018f5 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getAccount.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getAccount + Retrieve the account associated with a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getActiveComponents.md b/content/reference/services/SoftLayer_Hardware_Server/getActiveComponents.md index 8d06045d3d..0633889dcb 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getActiveComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getActiveComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getActiveComponents + Retrieve a piece of hardware's active physical components. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getActiveNetworkFirewallBillingItem.md b/content/reference/services/SoftLayer_Hardware_Server/getActiveNetworkFirewallBillingItem.md index 68353668dd..f18f95ae6c 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getActiveNetworkFirewallBillingItem.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getActiveNetworkFirewallBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getActiveNetworkFirewallBillingItem + Retrieve the billing item for a server's attached network firewall. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getActiveNetworkMonitorIncident.md b/content/reference/services/SoftLayer_Hardware_Server/getActiveNetworkMonitorIncident.md index 822a2e79ed..cc7c14c611 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getActiveNetworkMonitorIncident.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getActiveNetworkMonitorIncident.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getActiveNetworkMonitorIncident + Retrieve a piece of hardware's active network monitoring incidents. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getActiveTickets.md b/content/reference/services/SoftLayer_Hardware_Server/getActiveTickets.md index c996388063..ddde36e1c2 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getActiveTickets.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getActiveTickets.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getActiveTransaction.md b/content/reference/services/SoftLayer_Hardware_Server/getActiveTransaction.md index cee51a3b61..002a4995bf 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getActiveTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getActiveTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getActiveTransaction + Retrieve transaction currently running for server. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getActiveTransactions.md b/content/reference/services/SoftLayer_Hardware_Server/getActiveTransactions.md index 55cb5c1f7a..691f69bb92 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getActiveTransactions.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getActiveTransactions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getActiveTransactions + Retrieve any active transaction(s) that are currently running for the server (example: os reload). diff --git a/content/reference/services/SoftLayer_Hardware_Server/getAllPowerComponents.md b/content/reference/services/SoftLayer_Hardware_Server/getAllPowerComponents.md index c5cc514b8a..a3f0e9d4b1 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getAllPowerComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getAllPowerComponents.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getAllowedHost.md b/content/reference/services/SoftLayer_Hardware_Server/getAllowedHost.md index ceb1fe53a9..f584929445 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getAllowedHost.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getAllowedHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getAllowedHost + Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getAllowedNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_Server/getAllowedNetworkStorage.md index 3ee40f258f..142ea13ce3 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getAllowedNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getAllowedNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getAllowedNetworkStorage + Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getAllowedNetworkStorageReplicas.md b/content/reference/services/SoftLayer_Hardware_Server/getAllowedNetworkStorageReplicas.md index 87ce2387b6..cc915b7853 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getAllowedNetworkStorageReplicas.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getAllowedNetworkStorageReplicas.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getAllowedNetworkStorageReplicas + Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getAntivirusSpywareSoftwareComponent.md b/content/reference/services/SoftLayer_Hardware_Server/getAntivirusSpywareSoftwareComponent.md index 93caf8d67a..9ecbd73a66 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getAntivirusSpywareSoftwareComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getAntivirusSpywareSoftwareComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getAntivirusSpywareSoftwareComponent + Retrieve information regarding an antivirus/spyware software component object. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getAttachedNetworkStorages.md b/content/reference/services/SoftLayer_Hardware_Server/getAttachedNetworkStorages.md index 1c14d147c2..cc59ffd48d 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getAttachedNetworkStorages.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getAttachedNetworkStorages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getAttachedNetworkStorages + Return a list of SoftLayer_Network_Storage volumes authorized to this device. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getAttributes.md b/content/reference/services/SoftLayer_Hardware_Server/getAttributes.md index 50e2fe280c..c4bb4a5743 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getAttributes.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getAttributes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getAttributes + Retrieve information regarding a piece of hardware's specific attributes. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getAvailableBillingTermChangePrices.md b/content/reference/services/SoftLayer_Hardware_Server/getAvailableBillingTermChangePrices.md index 1e0d74b2d3..e78dc5d706 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getAvailableBillingTermChangePrices.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getAvailableBillingTermChangePrices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getAvailableBillingTermChangePrices + Retrieves a list of available term prices available to this of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getAvailableMonitoring.md b/content/reference/services/SoftLayer_Hardware_Server/getAvailableMonitoring.md index 4d77b9399a..faacccadda 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getAvailableMonitoring.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getAvailableMonitoring.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getAvailableMonitoring + Retrieve an object that stores the maximum level for the monitoring query types and response types. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getAvailableNetworkStorages.md b/content/reference/services/SoftLayer_Hardware_Server/getAvailableNetworkStorages.md index 8c6220257e..a875747043 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getAvailableNetworkStorages.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getAvailableNetworkStorages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getAvailableNetworkStorages + Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getAverageDailyBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Server/getAverageDailyBandwidthUsage.md index 580e543ff5..dd4e4371b6 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getAverageDailyBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getAverageDailyBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getAverageDailyBandwidthUsage + Retrieve the average daily total bandwidth usage for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getAverageDailyPrivateBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Server/getAverageDailyPrivateBandwidthUsage.md index 9ef02cf649..3fa1bf2a93 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getAverageDailyPrivateBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getAverageDailyPrivateBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getAverageDailyPrivateBandwidthUsage + Retrieve the average daily private bandwidth usage for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getAverageDailyPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Server/getAverageDailyPublicBandwidthUsage.md index 710f4bd6b3..a0eb58924a 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getAverageDailyPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getAverageDailyPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getAverageDailyPublicBandwidthUsage + Retrieve the average daily public bandwidth usage for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBackendBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Server/getBackendBandwidthUsage.md index 1a3f86f352..f2d349c95e 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBackendBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBackendBandwidthUsage.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBackendBandwidthUsage + Retrieves public bandwidth usage records. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBackendBandwidthUse.md b/content/reference/services/SoftLayer_Hardware_Server/getBackendBandwidthUse.md index 2f10666ffe..6ed01412bd 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBackendBandwidthUse.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBackendBandwidthUse.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBackendBandwidthUse +
              Deprecated
              + Retrieves private bandwidth usage records. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBackendIncomingBandwidth.md b/content/reference/services/SoftLayer_Hardware_Server/getBackendIncomingBandwidth.md index 5d45ec83bd..03894dc955 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBackendIncomingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBackendIncomingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBackendIncomingBandwidth + Retrieve the amount of incoming private network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBackendNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_Server/getBackendNetworkComponents.md index 177123961d..cdaa9b0313 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBackendNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBackendNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBackendNetworkComponents + Retrieve a piece of hardware's back-end or private network components. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBackendOutgoingBandwidth.md b/content/reference/services/SoftLayer_Hardware_Server/getBackendOutgoingBandwidth.md index dc4186a476..1f22adb1db 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBackendOutgoingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBackendOutgoingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBackendOutgoingBandwidth + Retrieve the amount of outgoing private network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBackendRouters.md b/content/reference/services/SoftLayer_Hardware_Server/getBackendRouters.md index 808d443df9..97a8e85e2b 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBackendRouters.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBackendRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBackendRouters + Retrieve a hardware's backend or private router. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBandwidthAllocation.md b/content/reference/services/SoftLayer_Hardware_Server/getBandwidthAllocation.md index 46c398a5c9..288ed616fc 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBandwidthAllocation.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBandwidthAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBandwidthAllocation + Retrieve a hardware's allotted bandwidth (measured in GB). diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBandwidthAllotmentDetail.md b/content/reference/services/SoftLayer_Hardware_Server/getBandwidthAllotmentDetail.md index c4f1c93a15..f5d56ead80 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBandwidthAllotmentDetail.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBandwidthAllotmentDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBandwidthAllotmentDetail + Retrieve a hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBandwidthForDateRange.md b/content/reference/services/SoftLayer_Hardware_Server/getBandwidthForDateRange.md index 0137da1537..88bbb59adb 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBandwidthForDateRange.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBandwidthForDateRange.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBandwidthForDateRange + Retrieve bandwidth data from a tracking object. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBandwidthImage.md b/content/reference/services/SoftLayer_Hardware_Server/getBandwidthImage.md index 8212857972..e50f28451c 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBandwidthImage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBandwidthImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBandwidthImage + Retrieve a bandwidth image and textual description of that image for this server. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBenchmarkCertifications.md b/content/reference/services/SoftLayer_Hardware_Server/getBenchmarkCertifications.md index 78e78f2500..3764c5d9ea 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBenchmarkCertifications.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBenchmarkCertifications.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBenchmarkCertifications + Retrieve information regarding a piece of hardware's benchmark certifications. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBillingCycleBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Server/getBillingCycleBandwidthUsage.md index 70c8ebd9df..1f5aea53db 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBillingCycleBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBillingCycleBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBillingCycleBandwidthUsage + Retrieve the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBillingCyclePrivateBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Server/getBillingCyclePrivateBandwidthUsage.md index 0b5fbbebd3..a09641ecfa 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBillingCyclePrivateBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBillingCyclePrivateBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBillingCyclePrivateBandwidthUsage + Retrieve the raw private bandwidth usage data for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBillingCyclePublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Server/getBillingCyclePublicBandwidthUsage.md index f18d93dee2..2d35d07458 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBillingCyclePublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBillingCyclePublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBillingCyclePublicBandwidthUsage + Retrieve the raw public bandwidth usage data for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBillingItem.md b/content/reference/services/SoftLayer_Hardware_Server/getBillingItem.md index b8d22fd5c3..18723b8d53 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBillingItem.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBillingItem + Retrieve the billing item for a server. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBillingItemFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getBillingItemFlag.md index 30055509a9..8375c82fd2 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBillingItemFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBillingItemFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBillingItemFlag + Retrieve a flag indicating that a billing item exists. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBiosPasswordNullFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getBiosPasswordNullFlag.md index 02d19f0609..0328702915 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBiosPasswordNullFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBiosPasswordNullFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBiosPasswordNullFlag + Retrieve determine if BIOS password should be left as null. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBlockCancelBecauseDisconnectedFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getBlockCancelBecauseDisconnectedFlag.md index b5f410dfed..14e707642d 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBlockCancelBecauseDisconnectedFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBlockCancelBecauseDisconnectedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBlockCancelBecauseDisconnectedFlag + Retrieve determines whether the hardware is ineligible for cancellation because it is disconnected. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBootModeOptions.md b/content/reference/services/SoftLayer_Hardware_Server/getBootModeOptions.md index 34ff650d30..14e28b7987 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBootModeOptions.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBootModeOptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBootModeOptions + Retrieve the valid boot modes for this server. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getBusinessContinuanceInsuranceFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getBusinessContinuanceInsuranceFlag.md index b7d2ac3032..0060a73e15 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getBusinessContinuanceInsuranceFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getBusinessContinuanceInsuranceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getBusinessContinuanceInsuranceFlag + Retrieve status indicating whether or not a piece of hardware has business continuance insurance. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getCaptureEnabledFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getCaptureEnabledFlag.md index 75ce2c1fe7..98a6cd37b9 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getCaptureEnabledFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getCaptureEnabledFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getCaptureEnabledFlag + Retrieve determine if the server is able to be image captured. If unable to image capture a reason will be provided. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getChildrenHardware.md b/content/reference/services/SoftLayer_Hardware_Server/getChildrenHardware.md index e0cacd7b51..7e1d704245 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getChildrenHardware.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getChildrenHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getChildrenHardware + Retrieve child hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getComponentDetailsXML.md b/content/reference/services/SoftLayer_Hardware_Server/getComponentDetailsXML.md index b0ec4add77..4fac486056 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getComponentDetailsXML.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getComponentDetailsXML.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getComponents.md b/content/reference/services/SoftLayer_Hardware_Server/getComponents.md index e21bacb8bc..de2a2f4077 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getComponents + Retrieve a piece of hardware's components. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getContainsSolidStateDrivesFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getContainsSolidStateDrivesFlag.md index faf6915a8c..f5572b110b 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getContainsSolidStateDrivesFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getContainsSolidStateDrivesFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getContinuousDataProtectionSoftwareComponent.md b/content/reference/services/SoftLayer_Hardware_Server/getContinuousDataProtectionSoftwareComponent.md index 1a088624e6..ec0daec095 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getContinuousDataProtectionSoftwareComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getContinuousDataProtectionSoftwareComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getContinuousDataProtectionSoftwareComponent + Retrieve a continuous data protection/server backup software component object. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getControlPanel.md b/content/reference/services/SoftLayer_Hardware_Server/getControlPanel.md index 4baab07bf7..0c33f51cff 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getControlPanel.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getControlPanel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getControlPanel + Retrieve a server's control panel. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getCost.md b/content/reference/services/SoftLayer_Hardware_Server/getCost.md index 45cc3af59f..605269bb5a 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getCost.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getCost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getCost + Retrieve the total cost of a server, measured in US Dollars ($USD). diff --git a/content/reference/services/SoftLayer_Hardware_Server/getCreateObjectOptions.md b/content/reference/services/SoftLayer_Hardware_Server/getCreateObjectOptions.md index 0a7466cd68..7a391bfd97 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getCreateObjectOptions.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getCreateObjectOptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getCreateObjectOptions + Determine options available when creating a server diff --git a/content/reference/services/SoftLayer_Hardware_Server/getCurrentBandwidthSummary.md b/content/reference/services/SoftLayer_Hardware_Server/getCurrentBandwidthSummary.md index 20d490615f..ca5fa8da88 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getCurrentBandwidthSummary.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getCurrentBandwidthSummary.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getCurrentBandwidthSummary + Retrieve an object that provides commonly used bandwidth summary components for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getCurrentBenchmarkCertificationResultFile.md b/content/reference/services/SoftLayer_Hardware_Server/getCurrentBenchmarkCertificationResultFile.md index bf5f4c333a..ddb1bf6e39 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getCurrentBenchmarkCertificationResultFile.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getCurrentBenchmarkCertificationResultFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getCurrentBenchmarkCertificationResultFile + Get the file for the current benchmark certification result, if it exists. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getCurrentBillableBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Server/getCurrentBillableBandwidthUsage.md index 0866313448..2880c990d7 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getCurrentBillableBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getCurrentBillableBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getCurrentBillableBandwidthUsage + Retrieve the current billable public outbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getCurrentBillingDetail.md b/content/reference/services/SoftLayer_Hardware_Server/getCurrentBillingDetail.md index 0005d47ba5..333a52e844 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getCurrentBillingDetail.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getCurrentBillingDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getCurrentBillingDetail + << EOT diff --git a/content/reference/services/SoftLayer_Hardware_Server/getCurrentBillingTotal.md b/content/reference/services/SoftLayer_Hardware_Server/getCurrentBillingTotal.md index daa0dcb20b..bab0cf7ab3 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getCurrentBillingTotal.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getCurrentBillingTotal.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getCurrentBillingTotal + Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getCustomBandwidthDataByDate.md b/content/reference/services/SoftLayer_Hardware_Server/getCustomBandwidthDataByDate.md index 2c89dfb3c9..c5207216ad 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getCustomBandwidthDataByDate.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getCustomBandwidthDataByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getCustomBandwidthDataByDate + Retrieve bandwidth graph by date. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getCustomerInstalledOperatingSystemFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getCustomerInstalledOperatingSystemFlag.md index 162092f21f..ecb359cd29 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getCustomerInstalledOperatingSystemFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getCustomerInstalledOperatingSystemFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getCustomerInstalledOperatingSystemFlag + Retrieve indicates if a server has a Customer Installed OS diff --git a/content/reference/services/SoftLayer_Hardware_Server/getCustomerOwnedFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getCustomerOwnedFlag.md index e91ee46c88..e1656b230d 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getCustomerOwnedFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getCustomerOwnedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getCustomerOwnedFlag + Retrieve indicates if a server is a customer owned device. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getDailyAverage.md b/content/reference/services/SoftLayer_Hardware_Server/getDailyAverage.md index 9257129f0f..b76694fd26 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getDailyAverage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getDailyAverage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getDailyAverage + calculate the average daily network traffic used by a server in gigabytes. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getDatacenter.md b/content/reference/services/SoftLayer_Hardware_Server/getDatacenter.md index 64865a4068..5a7e5c97da 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getDatacenter.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getDatacenter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getDatacenter + Retrieve information regarding the datacenter in which a piece of hardware resides. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getDatacenterName.md b/content/reference/services/SoftLayer_Hardware_Server/getDatacenterName.md index 0399b1561a..6df5f18bd3 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getDatacenterName.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getDatacenterName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getDatacenterName + Retrieve the name of the datacenter in which a piece of hardware resides. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getDaysInSparePool.md b/content/reference/services/SoftLayer_Hardware_Server/getDaysInSparePool.md index 93886e5efc..15743ec0ae 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getDaysInSparePool.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getDaysInSparePool.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getDaysInSparePool + Retrieve number of day(s) a server have been in spare pool. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getDownlinkHardware.md b/content/reference/services/SoftLayer_Hardware_Server/getDownlinkHardware.md index 556b1b7254..874299ac6e 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getDownlinkHardware.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getDownlinkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getDownlinkHardware + Retrieve all hardware that has uplink network connections to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getDownlinkNetworkHardware.md b/content/reference/services/SoftLayer_Hardware_Server/getDownlinkNetworkHardware.md index bcbb1e5719..9ae86ea937 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getDownlinkNetworkHardware.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getDownlinkNetworkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getDownlinkNetworkHardware + Retrieve all hardware that has uplink network connections to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getDownlinkServers.md b/content/reference/services/SoftLayer_Hardware_Server/getDownlinkServers.md index 23e7b37404..cc0b3334f4 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getDownlinkServers.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getDownlinkServers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getDownlinkServers + Retrieve information regarding all servers attached to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getDownlinkVirtualGuests.md b/content/reference/services/SoftLayer_Hardware_Server/getDownlinkVirtualGuests.md index b12a4e9a7b..a8c72ce6a6 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getDownlinkVirtualGuests.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getDownlinkVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getDownlinkVirtualGuests + Retrieve information regarding all virtual guests attached to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getDownstreamHardwareBindings.md b/content/reference/services/SoftLayer_Hardware_Server/getDownstreamHardwareBindings.md index d92d6487cb..7d7aa95d59 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getDownstreamHardwareBindings.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getDownstreamHardwareBindings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getDownstreamHardwareBindings + Retrieve all hardware downstream from a network device. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getDownstreamNetworkHardware.md b/content/reference/services/SoftLayer_Hardware_Server/getDownstreamNetworkHardware.md index f9206e2f07..bd3a4f88ac 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getDownstreamNetworkHardware.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getDownstreamNetworkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getDownstreamNetworkHardware + Retrieve all network hardware downstream from the selected piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getDownstreamNetworkHardwareWithIncidents.md b/content/reference/services/SoftLayer_Hardware_Server/getDownstreamNetworkHardwareWithIncidents.md index b310697bed..ac641ad1ee 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getDownstreamNetworkHardwareWithIncidents.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getDownstreamNetworkHardwareWithIncidents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getDownstreamNetworkHardwareWithIncidents + Retrieve all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getDownstreamServers.md b/content/reference/services/SoftLayer_Hardware_Server/getDownstreamServers.md index a0ede3a013..f3245c8a23 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getDownstreamServers.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getDownstreamServers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getDownstreamServers + Retrieve information regarding all servers attached downstream to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getDownstreamVirtualGuests.md b/content/reference/services/SoftLayer_Hardware_Server/getDownstreamVirtualGuests.md index 34f7991ff7..548205304e 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getDownstreamVirtualGuests.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getDownstreamVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getDownstreamVirtualGuests + Retrieve information regarding all virtual guests attached to a piece of network hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getDriveControllers.md b/content/reference/services/SoftLayer_Hardware_Server/getDriveControllers.md index a87a806c6b..862a45c61f 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getDriveControllers.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getDriveControllers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getDriveControllers + Retrieve the drive controllers contained within a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getEvaultNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_Server/getEvaultNetworkStorage.md index 35120349d5..d1724aeb47 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getEvaultNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getEvaultNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getEvaultNetworkStorage + Retrieve information regarding a piece of hardware's associated EVault network storage service account. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getFirewallProtectableSubnets.md b/content/reference/services/SoftLayer_Hardware_Server/getFirewallProtectableSubnets.md index 8b3a5de134..b9178a3ab5 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getFirewallProtectableSubnets.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getFirewallProtectableSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getFirewallProtectableSubnets + Get the subnets associated with this server that are protectable by a network component firewall. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getFirewallServiceComponent.md b/content/reference/services/SoftLayer_Hardware_Server/getFirewallServiceComponent.md index b05950c918..5e9ccbb2b8 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getFirewallServiceComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getFirewallServiceComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getFirewallServiceComponent + Retrieve information regarding a piece of hardware's firewall services. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getFixedConfigurationPreset.md b/content/reference/services/SoftLayer_Hardware_Server/getFixedConfigurationPreset.md index 92a1054cda..adf3cb9772 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getFixedConfigurationPreset.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getFixedConfigurationPreset.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getFixedConfigurationPreset + Retrieve defines the fixed components in a fixed configuration bare metal server. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getFrontendBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Server/getFrontendBandwidthUsage.md index 060d5c4d60..dfda21e131 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getFrontendBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getFrontendBandwidthUsage.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getFrontendBandwidthUsage + Retrieves public bandwidth usage records. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getFrontendBandwidthUse.md b/content/reference/services/SoftLayer_Hardware_Server/getFrontendBandwidthUse.md index 2046537217..7bf0911d3f 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getFrontendBandwidthUse.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getFrontendBandwidthUse.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getFrontendBandwidthUse +
              Deprecated
              + Retrieves public bandwidth usage records. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getFrontendIncomingBandwidth.md b/content/reference/services/SoftLayer_Hardware_Server/getFrontendIncomingBandwidth.md index facb549105..eaef83b315 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getFrontendIncomingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getFrontendIncomingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getFrontendIncomingBandwidth + Retrieve the amount of incoming public network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getFrontendNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_Server/getFrontendNetworkComponents.md index c971041ce4..76872c946b 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getFrontendNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getFrontendNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getFrontendNetworkComponents + Retrieve a piece of hardware's front-end or public network components. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getFrontendOutgoingBandwidth.md b/content/reference/services/SoftLayer_Hardware_Server/getFrontendOutgoingBandwidth.md index e1ce71e3d2..9cc9e2057b 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getFrontendOutgoingBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getFrontendOutgoingBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getFrontendOutgoingBandwidth + Retrieve the amount of outgoing public network bandwidth used by a server over a period of time. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getFrontendRouters.md b/content/reference/services/SoftLayer_Hardware_Server/getFrontendRouters.md index 377e0f5d8f..653689a7df 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getFrontendRouters.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getFrontendRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getFrontendRouters + Retrieve a hardware's frontend or public router. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getFutureBillingItem.md b/content/reference/services/SoftLayer_Hardware_Server/getFutureBillingItem.md index 8ce3148ac7..4fd062ddb1 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getFutureBillingItem.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getFutureBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getFutureBillingItem + Retrieve information regarding the future billing item for a server. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getGlobalIdentifier.md b/content/reference/services/SoftLayer_Hardware_Server/getGlobalIdentifier.md index bda5dbe48a..3c01d9dfbb 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getGlobalIdentifier.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getGlobalIdentifier.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getGlobalIdentifier + Retrieve a hardware's universally unique identifier. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getHardDrives.md b/content/reference/services/SoftLayer_Hardware_Server/getHardDrives.md index 8afcd35093..6c5c2b5b87 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getHardDrives.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getHardDrives.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getHardDrives + Retrieve the hard drives contained within a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getHardwareByIpAddress.md b/content/reference/services/SoftLayer_Hardware_Server/getHardwareByIpAddress.md index 7daef4bc2f..7121b2764e 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getHardwareByIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getHardwareByIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getHardwareByIpAddress + Retrieve a SoftLayer_Hardware_Server object by IP address. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getHardwareChassis.md b/content/reference/services/SoftLayer_Hardware_Server/getHardwareChassis.md index 7bb0cd138e..56553fefbc 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getHardwareChassis.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getHardwareChassis.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getHardwareChassis + Retrieve the chassis that a piece of hardware is housed in. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getHardwareFunction.md b/content/reference/services/SoftLayer_Hardware_Server/getHardwareFunction.md index 415c680b44..80a4c380fe 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getHardwareFunction.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getHardwareFunction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getHardwareFunction + Retrieve a hardware's function. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getHardwareFunctionDescription.md b/content/reference/services/SoftLayer_Hardware_Server/getHardwareFunctionDescription.md index c6e9e5388d..ddbff2c512 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getHardwareFunctionDescription.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getHardwareFunctionDescription.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getHardwareFunctionDescription + Retrieve a hardware's function. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getHardwareStatus.md b/content/reference/services/SoftLayer_Hardware_Server/getHardwareStatus.md index e67879ee3c..bed772e704 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getHardwareStatus.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getHardwareStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getHardwareStatus + Retrieve a hardware's status. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getHasSingleRootVirtualizationBillingItemFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getHasSingleRootVirtualizationBillingItemFlag.md index 2a1aecbae5..127b17722c 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getHasSingleRootVirtualizationBillingItemFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getHasSingleRootVirtualizationBillingItemFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getHasSingleRootVirtualizationBillingItemFlag + Retrieve determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getHasTrustedPlatformModuleBillingItemFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getHasTrustedPlatformModuleBillingItemFlag.md index 2692bd39a5..7ef164bf38 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getHasTrustedPlatformModuleBillingItemFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getHasTrustedPlatformModuleBillingItemFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getHasTrustedPlatformModuleBillingItemFlag + Retrieve determine in hardware object has TPM enabled. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getHostIpsSoftwareComponent.md b/content/reference/services/SoftLayer_Hardware_Server/getHostIpsSoftwareComponent.md index bd1e3e51b5..293569ca7f 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getHostIpsSoftwareComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getHostIpsSoftwareComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getHostIpsSoftwareComponent + Retrieve information regarding a host IPS software component object. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getHourlyBandwidth.md b/content/reference/services/SoftLayer_Hardware_Server/getHourlyBandwidth.md index c93dec9ae3..524b3159c6 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getHourlyBandwidth.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getHourlyBandwidth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getHourlyBandwidth + Retrieves bandwidth hourly over a 24-hour period for the specified hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getHourlyBillingFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getHourlyBillingFlag.md index 4847a1edf5..1b4c09289f 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getHourlyBillingFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getHourlyBillingFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getHourlyBillingFlag + Retrieve a server's hourly billing status. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getInboundBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Server/getInboundBandwidthUsage.md index b82cbdd2d9..d252969b1e 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getInboundBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getInboundBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getInboundBandwidthUsage + Retrieve the sum of all the inbound network traffic data for the last 30 days. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getInboundPrivateBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Server/getInboundPrivateBandwidthUsage.md index cc95a2d0ea..58a1e697b8 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getInboundPrivateBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getInboundPrivateBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getInboundPrivateBandwidthUsage + Retrieve the total private inbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getInboundPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Server/getInboundPublicBandwidthUsage.md index 820017bc29..5002742bba 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getInboundPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getInboundPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getInboundPublicBandwidthUsage + Retrieve the total public inbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getIsBillingTermChangeAvailableFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getIsBillingTermChangeAvailableFlag.md index 939fd4ce90..f424409a41 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getIsBillingTermChangeAvailableFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getIsBillingTermChangeAvailableFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getIsBillingTermChangeAvailableFlag + Retrieve whether or not this hardware object is eligible to change to term billing. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getIsCloudReadyNodeCertified.md b/content/reference/services/SoftLayer_Hardware_Server/getIsCloudReadyNodeCertified.md index 3fb2ebe11b..eded521735 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getIsCloudReadyNodeCertified.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getIsCloudReadyNodeCertified.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getIsCloudReadyNodeCertified + Retrieve determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getIsIpmiDisabled.md b/content/reference/services/SoftLayer_Hardware_Server/getIsIpmiDisabled.md index d53abc4bf0..5598f6b13a 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getIsIpmiDisabled.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getIsIpmiDisabled.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getIsIpmiDisabled + Retrieve determine if remote management has been disabled due to port speed. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getIsVirtualPrivateCloudNode.md b/content/reference/services/SoftLayer_Hardware_Server/getIsVirtualPrivateCloudNode.md index f99b58a305..3781f10004 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getIsVirtualPrivateCloudNode.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getIsVirtualPrivateCloudNode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getIsVirtualPrivateCloudNode + Retrieve determine if hardware object is a Virtual Private Cloud node. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getItemPricesFromSoftwareDescriptions.md b/content/reference/services/SoftLayer_Hardware_Server/getItemPricesFromSoftwareDescriptions.md index 9a0564d9dd..006b72a1cb 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getItemPricesFromSoftwareDescriptions.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getItemPricesFromSoftwareDescriptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getItemPricesFromSoftwareDescriptions + Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description diff --git a/content/reference/services/SoftLayer_Hardware_Server/getLastOperatingSystemReload.md b/content/reference/services/SoftLayer_Hardware_Server/getLastOperatingSystemReload.md index 46ea51be35..fefe0b5729 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getLastOperatingSystemReload.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getLastOperatingSystemReload.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getLastOperatingSystemReload + Retrieve the last transaction that a server's operating system was loaded. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getLastTransaction.md b/content/reference/services/SoftLayer_Hardware_Server/getLastTransaction.md index ec3d9a0084..fd2a379844 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getLastTransaction.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getLastTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getLastTransaction + Retrieve information regarding the last transaction a server performed. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getLatestNetworkMonitorIncident.md b/content/reference/services/SoftLayer_Hardware_Server/getLatestNetworkMonitorIncident.md index 966f4343d2..3e96c6f417 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getLatestNetworkMonitorIncident.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getLatestNetworkMonitorIncident.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getLatestNetworkMonitorIncident + Retrieve a piece of hardware's latest network monitoring incident. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getLocation.md b/content/reference/services/SoftLayer_Hardware_Server/getLocation.md index dcf9f98d03..c8a19d77b2 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getLocation.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getLocation + Retrieve where a piece of hardware is located within SoftLayer's location hierarchy. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getLocationPathString.md b/content/reference/services/SoftLayer_Hardware_Server/getLocationPathString.md index b316aa4744..5a7fb015c7 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getLocationPathString.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getLocationPathString.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getLockboxNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_Server/getLockboxNetworkStorage.md index 5e7cb82d18..c51984e9c4 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getLockboxNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getLockboxNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getLockboxNetworkStorage + Retrieve information regarding a lockbox account associated with a server. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getLogicalVolumeStorageGroups.md b/content/reference/services/SoftLayer_Hardware_Server/getLogicalVolumeStorageGroups.md index a3dfec6ab3..dbdf74d7b4 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getLogicalVolumeStorageGroups.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getLogicalVolumeStorageGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getLogicalVolumeStorageGroups + Retrieve returns a list of logical volumes on the physical machine. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getManagedResourceFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getManagedResourceFlag.md index 21f6999e19..3bd0bdbd6a 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getManagedResourceFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getManagedResourceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getManagedResourceFlag + Retrieve a flag indicating that the hardware is a managed resource. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getManagementNetworkComponent.md b/content/reference/services/SoftLayer_Hardware_Server/getManagementNetworkComponent.md index 108d292a12..8f6b986555 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getManagementNetworkComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getManagementNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getManagementNetworkComponent + Retrieve a server's management network component. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getMemory.md b/content/reference/services/SoftLayer_Hardware_Server/getMemory.md index 96276e3019..dba610cce1 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getMemory.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getMemory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getMemory + Retrieve information regarding a piece of hardware's memory. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getMemoryCapacity.md b/content/reference/services/SoftLayer_Hardware_Server/getMemoryCapacity.md index 0fbe4c1068..34fd417434 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getMemoryCapacity.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getMemoryCapacity.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getMemoryCapacity + Retrieve the amount of memory a piece of hardware has, measured in gigabytes. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getMetricTrackingObject.md b/content/reference/services/SoftLayer_Hardware_Server/getMetricTrackingObject.md index 3af866b631..9f7879b7a0 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getMetricTrackingObject.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getMetricTrackingObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getMetricTrackingObject + Retrieve a piece of hardware's metric tracking object. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getMetricTrackingObjectId.md b/content/reference/services/SoftLayer_Hardware_Server/getMetricTrackingObjectId.md index 4c3305fb1e..7152ca540c 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getMetricTrackingObjectId.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getMetricTrackingObjectId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getMetricTrackingObjectId + Retrieve the metric tracking object id for this server. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getModules.md b/content/reference/services/SoftLayer_Hardware_Server/getModules.md index c3195e27ec..8361f53fb7 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getModules.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getModules.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getMonitoringRobot.md b/content/reference/services/SoftLayer_Hardware_Server/getMonitoringRobot.md index 39b0d2a2f4..afe3bfbcb1 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getMonitoringRobot.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getMonitoringRobot.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getMonitoringServiceComponent.md b/content/reference/services/SoftLayer_Hardware_Server/getMonitoringServiceComponent.md index 1aed6b59d6..99d02cbc70 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getMonitoringServiceComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getMonitoringServiceComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getMonitoringServiceComponent + Retrieve information regarding a piece of hardware's network monitoring services. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getMonitoringServiceEligibilityFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getMonitoringServiceEligibilityFlag.md index d180cc23ce..5541274baf 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getMonitoringServiceEligibilityFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getMonitoringServiceEligibilityFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getMonitoringUserNotification.md b/content/reference/services/SoftLayer_Hardware_Server/getMonitoringUserNotification.md index afa2b34f20..ad3ad47880 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getMonitoringUserNotification.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getMonitoringUserNotification.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getMonitoringUserNotification + Retrieve the monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails diff --git a/content/reference/services/SoftLayer_Hardware_Server/getMotherboard.md b/content/reference/services/SoftLayer_Hardware_Server/getMotherboard.md index 4b30e128f4..e83e495b5e 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getMotherboard.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getMotherboard.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getMotherboard + Retrieve a server's motherboard. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getNetworkCards.md b/content/reference/services/SoftLayer_Hardware_Server/getNetworkCards.md index 1755352422..539cbcbc7e 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getNetworkCards.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getNetworkCards.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getNetworkCards + Retrieve information regarding a piece of hardware's network cards. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getNetworkComponentFirewallProtectableIpAddresses.md b/content/reference/services/SoftLayer_Hardware_Server/getNetworkComponentFirewallProtectableIpAddresses.md index 0871278a1f..cf7b848ff1 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getNetworkComponentFirewallProtectableIpAddresses.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getNetworkComponentFirewallProtectableIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getNetworkComponentFirewallProtectableIpAddresses + Get the IP addresses associated with this server that are protectable by a network component firewall. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_Server/getNetworkComponents.md index c584f474a2..a6262d3a2a 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getNetworkComponents + Retrieve returns a hardware's network components. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getNetworkGatewayMember.md b/content/reference/services/SoftLayer_Hardware_Server/getNetworkGatewayMember.md index 20e10c54ef..e63fd75639 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getNetworkGatewayMember.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getNetworkGatewayMember.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getNetworkGatewayMember + Retrieve the gateway member if this device is part of a network gateway. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getNetworkGatewayMemberFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getNetworkGatewayMemberFlag.md index a69f20683b..cb6a0021e1 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getNetworkGatewayMemberFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getNetworkGatewayMemberFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getNetworkGatewayMemberFlag + Retrieve whether or not this device is part of a network gateway. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getNetworkManagementIpAddress.md b/content/reference/services/SoftLayer_Hardware_Server/getNetworkManagementIpAddress.md index d02adca47c..deb193a4e8 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getNetworkManagementIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getNetworkManagementIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getNetworkManagementIpAddress + Retrieve a piece of hardware's network management IP address. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getNetworkMonitorAttachedDownHardware.md b/content/reference/services/SoftLayer_Hardware_Server/getNetworkMonitorAttachedDownHardware.md index 3dc51b1e04..df6556034f 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getNetworkMonitorAttachedDownHardware.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getNetworkMonitorAttachedDownHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getNetworkMonitorAttachedDownHardware + Retrieve all servers with failed monitoring that are attached downstream to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getNetworkMonitorAttachedDownVirtualGuests.md b/content/reference/services/SoftLayer_Hardware_Server/getNetworkMonitorAttachedDownVirtualGuests.md index 03fbc4cccd..35bc169fcf 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getNetworkMonitorAttachedDownVirtualGuests.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getNetworkMonitorAttachedDownVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getNetworkMonitorAttachedDownVirtualGuests + Retrieve virtual guests that are attached downstream to a hardware that have failed monitoring diff --git a/content/reference/services/SoftLayer_Hardware_Server/getNetworkMonitorIncidents.md b/content/reference/services/SoftLayer_Hardware_Server/getNetworkMonitorIncidents.md index 05d957e4c2..072e7fbc8f 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getNetworkMonitorIncidents.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getNetworkMonitorIncidents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getNetworkMonitorIncidents + Retrieve the status of all of a piece of hardware's network monitoring incidents. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getNetworkMonitors.md b/content/reference/services/SoftLayer_Hardware_Server/getNetworkMonitors.md index 7eb9f90dd9..ebee2a7573 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getNetworkMonitors.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getNetworkMonitors.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getNetworkMonitors + Retrieve information regarding a piece of hardware's network monitors. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getNetworkStatus.md b/content/reference/services/SoftLayer_Hardware_Server/getNetworkStatus.md index cd70099210..bafcb539e3 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getNetworkStatus.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getNetworkStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getNetworkStatus + Retrieve the value of a hardware's network status attribute. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getNetworkStatusAttribute.md b/content/reference/services/SoftLayer_Hardware_Server/getNetworkStatusAttribute.md index 4b2402ce23..30147317f8 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getNetworkStatusAttribute.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getNetworkStatusAttribute.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getNetworkStatusAttribute + Retrieve the hardware's related network status attribute. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_Server/getNetworkStorage.md index 8677f35988..098a7c0b40 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getNetworkStorage + Retrieve information regarding a piece of hardware's associated network storage service account. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getNetworkVlans.md b/content/reference/services/SoftLayer_Hardware_Server/getNetworkVlans.md index 92d8d97d4d..2d27a91bcd 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getNetworkVlans.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getNetworkVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getNetworkVlans + Retrieve the network virtual LANs (VLANs) associated with a piece of hardware's network components. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getNextBillingCycleBandwidthAllocation.md b/content/reference/services/SoftLayer_Hardware_Server/getNextBillingCycleBandwidthAllocation.md index 4c136c1b60..ca3df06315 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getNextBillingCycleBandwidthAllocation.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getNextBillingCycleBandwidthAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getNextBillingCycleBandwidthAllocation + Retrieve a hardware's allotted bandwidth for the next billing cycle (measured in GB). diff --git a/content/reference/services/SoftLayer_Hardware_Server/getNotesHistory.md b/content/reference/services/SoftLayer_Hardware_Server/getNotesHistory.md index 7e2a8a9183..fb95ac7433 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getNotesHistory.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getNotesHistory.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getNvRamCapacity.md b/content/reference/services/SoftLayer_Hardware_Server/getNvRamCapacity.md index ba41f56ad4..a1c1199ccf 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getNvRamCapacity.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getNvRamCapacity.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getNvRamCapacity + Retrieve the amount of non-volatile memory a piece of hardware has, measured in gigabytes. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getNvRamComponentModels.md b/content/reference/services/SoftLayer_Hardware_Server/getNvRamComponentModels.md index 3fe1404323..aa60c2431b 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getNvRamComponentModels.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getNvRamComponentModels.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getObject.md b/content/reference/services/SoftLayer_Hardware_Server/getObject.md index 3ee3b6dc0f..712c4abc49 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getObject.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getObject + Retrieve a SoftLayer_Hardware_Server record. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getOpenCancellationTicket.md b/content/reference/services/SoftLayer_Hardware_Server/getOpenCancellationTicket.md index 96320ca99c..2a1d5119c4 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getOpenCancellationTicket.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getOpenCancellationTicket.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getOpenCancellationTicket + Retrieve an open ticket requesting cancellation of this server, if one exists. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getOperatingSystem.md b/content/reference/services/SoftLayer_Hardware_Server/getOperatingSystem.md index ac7d542b38..f88e8b0a36 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getOperatingSystem.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getOperatingSystem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getOperatingSystem + Retrieve information regarding a piece of hardware's operating system. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getOperatingSystemReferenceCode.md b/content/reference/services/SoftLayer_Hardware_Server/getOperatingSystemReferenceCode.md index af107741f1..785cb09c4e 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getOperatingSystemReferenceCode.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getOperatingSystemReferenceCode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getOperatingSystemReferenceCode + Retrieve a hardware's operating system software description. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getOutboundBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Server/getOutboundBandwidthUsage.md index 5a378ba04e..6d7ffa3a60 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getOutboundBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getOutboundBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getOutboundBandwidthUsage + Retrieve the sum of all the outbound network traffic data for the last 30 days. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getOutboundPrivateBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Server/getOutboundPrivateBandwidthUsage.md index 98befdd338..cc27181810 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getOutboundPrivateBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getOutboundPrivateBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getOutboundPrivateBandwidthUsage + Retrieve the total private outbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getOutboundPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Server/getOutboundPublicBandwidthUsage.md index 5be8ceffcc..dcf1ed12f3 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getOutboundPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getOutboundPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getOutboundPublicBandwidthUsage + Retrieve the total public outbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getOverBandwidthAllocationFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getOverBandwidthAllocationFlag.md index fb4e30b7d2..4ef321d172 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getOverBandwidthAllocationFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getOverBandwidthAllocationFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getOverBandwidthAllocationFlag + Retrieve whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPMInfo.md b/content/reference/services/SoftLayer_Hardware_Server/getPMInfo.md index a8ec503af7..76dc6942a5 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPMInfo.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPMInfo.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPMInfo + Retrieve a server's hardware state via its internal sensors. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getParentBay.md b/content/reference/services/SoftLayer_Hardware_Server/getParentBay.md index 1287ce59c0..1cc00fe3e6 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getParentBay.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getParentBay.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getParentBay + Retrieve blade Bay diff --git a/content/reference/services/SoftLayer_Hardware_Server/getParentHardware.md b/content/reference/services/SoftLayer_Hardware_Server/getParentHardware.md index cf183f21d1..9701380f22 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getParentHardware.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getParentHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getParentHardware + Retrieve parent Hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPartitions.md b/content/reference/services/SoftLayer_Hardware_Server/getPartitions.md index df53e68f32..4968c186fd 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPartitions.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPartitions.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPointOfPresenceLocation.md b/content/reference/services/SoftLayer_Hardware_Server/getPointOfPresenceLocation.md index 9ff7b6edec..4109765838 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPointOfPresenceLocation.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPointOfPresenceLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPointOfPresenceLocation + Retrieve information regarding the Point of Presence (PoP) location in which a piece of hardware resides. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPowerComponents.md b/content/reference/services/SoftLayer_Hardware_Server/getPowerComponents.md index 4e0e908a50..2be16199fa 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPowerComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPowerComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPowerComponents + Retrieve the power components for a hardware object. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPowerSupply.md b/content/reference/services/SoftLayer_Hardware_Server/getPowerSupply.md index 416b94afbb..7ee2c838d9 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPowerSupply.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPowerSupply.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPowerSupply + Retrieve a server's power supply. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPrimaryBackendIpAddress.md b/content/reference/services/SoftLayer_Hardware_Server/getPrimaryBackendIpAddress.md index c6749298be..c8b51b8789 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPrimaryBackendIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPrimaryBackendIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPrimaryBackendIpAddress + Retrieve the hardware's primary private IP address. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPrimaryBackendNetworkComponent.md b/content/reference/services/SoftLayer_Hardware_Server/getPrimaryBackendNetworkComponent.md index 03624cab02..c416ee50f2 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPrimaryBackendNetworkComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPrimaryBackendNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPrimaryBackendNetworkComponent + Retrieve information regarding the hardware's primary back-end network component. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPrimaryDriveSize.md b/content/reference/services/SoftLayer_Hardware_Server/getPrimaryDriveSize.md index 8b3cf87902..b92d532213 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPrimaryDriveSize.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPrimaryDriveSize.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPrimaryIpAddress.md b/content/reference/services/SoftLayer_Hardware_Server/getPrimaryIpAddress.md index 987727d998..9c5719d023 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPrimaryIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPrimaryIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPrimaryIpAddress + Retrieve the hardware's primary public IP address. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPrimaryNetworkComponent.md b/content/reference/services/SoftLayer_Hardware_Server/getPrimaryNetworkComponent.md index 05d9a32f53..a1579b7361 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPrimaryNetworkComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPrimaryNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPrimaryNetworkComponent + Retrieve information regarding the hardware's primary public network component. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthData.md b/content/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthData.md index 5b241438ed..3392bf7a30 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthData.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPrivateBandwidthData + Retrieve a graph of a server's private network usage. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthDataSummary.md b/content/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthDataSummary.md index 4fb5a42008..00c0c3da08 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthDataSummary.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthDataSummary.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPrivateBandwidthDataSummary + Retrieve a server's private bandwidth usage summary diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthGraphImage.md b/content/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthGraphImage.md index 027dffc3e6..98b1668af8 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthGraphImage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthGraphImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPrivateBandwidthGraphImage + Retrieve a graph of a server's private network usage. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPrivateIpAddress.md b/content/reference/services/SoftLayer_Hardware_Server/getPrivateIpAddress.md index 5978104eae..480d4ea5b8 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPrivateIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPrivateIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPrivateIpAddress + Retrieve a server's primary private IP address. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPrivateNetworkComponent.md b/content/reference/services/SoftLayer_Hardware_Server/getPrivateNetworkComponent.md index 0d176f4079..9ec9b95568 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPrivateNetworkComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPrivateNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPrivateNetworkComponent + Retrieve a server's private network component. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPrivateNetworkOnlyFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getPrivateNetworkOnlyFlag.md index 3655b1adf2..96b6501e15 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPrivateNetworkOnlyFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPrivateNetworkOnlyFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPrivateNetworkOnlyFlag + Retrieve whether the hardware only has access to the private network. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPrivateVlan.md b/content/reference/services/SoftLayer_Hardware_Server/getPrivateVlan.md index 2d4dc76615..37316c414d 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPrivateVlan.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPrivateVlan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPrivateVlan + Retrieve the backend VLAN for the primary IP address of the server. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPrivateVlanByIpAddress.md b/content/reference/services/SoftLayer_Hardware_Server/getPrivateVlanByIpAddress.md index 0dbc7aa5c2..0b79cd6af5 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPrivateVlanByIpAddress.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPrivateVlanByIpAddress.md @@ -14,6 +14,8 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPrivateVlanByIpAddress +
              Deprecated
              + Retrieve a backend network VLAN by searching for an IP address. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getProcessorCoreAmount.md b/content/reference/services/SoftLayer_Hardware_Server/getProcessorCoreAmount.md index eaf1d02c15..3da2fe2a60 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getProcessorCoreAmount.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getProcessorCoreAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getProcessorCoreAmount + Retrieve the total number of processor cores, summed from all processors that are attached to a piece of hardware diff --git a/content/reference/services/SoftLayer_Hardware_Server/getProcessorPhysicalCoreAmount.md b/content/reference/services/SoftLayer_Hardware_Server/getProcessorPhysicalCoreAmount.md index 591611843d..17b1e3e635 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getProcessorPhysicalCoreAmount.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getProcessorPhysicalCoreAmount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getProcessorPhysicalCoreAmount + Retrieve the total number of physical processor cores, summed from all processors that are attached to a piece of hardware diff --git a/content/reference/services/SoftLayer_Hardware_Server/getProcessors.md b/content/reference/services/SoftLayer_Hardware_Server/getProcessors.md index 48b587856e..31b2c01142 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getProcessors.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getProcessors.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getProcessors + Retrieve information regarding a piece of hardware's processors. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getProjectedOverBandwidthAllocationFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getProjectedOverBandwidthAllocationFlag.md index 2618e00e2b..49605df72d 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getProjectedOverBandwidthAllocationFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getProjectedOverBandwidthAllocationFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getProjectedOverBandwidthAllocationFlag + Retrieve whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getProjectedPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Hardware_Server/getProjectedPublicBandwidthUsage.md index fd7c2b423b..e8c28fee81 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getProjectedPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getProjectedPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getProjectedPublicBandwidthUsage + Retrieve the projected public outbound bandwidth for this hardware for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getProvisionDate.md b/content/reference/services/SoftLayer_Hardware_Server/getProvisionDate.md index 801f8630e5..2de157855b 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getProvisionDate.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getProvisionDate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthData.md b/content/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthData.md index 69094d7220..a3feb2277a 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthData.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPublicBandwidthData + Retrieve a graph of a server's public network usage. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthDataSummary.md b/content/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthDataSummary.md index c4595a9cd0..0a338f5c4e 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthDataSummary.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthDataSummary.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPublicBandwidthDataSummary + Retrieve a server's public bandwidth usage summary diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthGraphImage.md b/content/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthGraphImage.md index 8a752f48ce..39c416f594 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthGraphImage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthGraphImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPublicBandwidthGraphImage + Retrieve a graph of a server's public network usage. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthTotal.md b/content/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthTotal.md index e8ee1242da..a2bd187fc4 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthTotal.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthTotal.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPublicBandwidthTotal + Retrieve total number of public bytes used by a server over time period specified. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPublicNetworkComponent.md b/content/reference/services/SoftLayer_Hardware_Server/getPublicNetworkComponent.md index 2b2f2345d6..7c0b309849 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPublicNetworkComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPublicNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPublicNetworkComponent + Retrieve a server's public network component. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPublicVlan.md b/content/reference/services/SoftLayer_Hardware_Server/getPublicVlan.md index 108d73bdb1..ecb4e5653a 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPublicVlan.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPublicVlan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPublicVlan + Retrieve the frontend VLAN for the primary IP address of the server diff --git a/content/reference/services/SoftLayer_Hardware_Server/getPublicVlanByHostname.md b/content/reference/services/SoftLayer_Hardware_Server/getPublicVlanByHostname.md index d9610d2b8d..d1998dc8c2 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getPublicVlanByHostname.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getPublicVlanByHostname.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getPublicVlanByHostname + Retrieve the frontend VLAN by a server's hostname. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getRack.md b/content/reference/services/SoftLayer_Hardware_Server/getRack.md index 814d02958d..154da5fda7 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getRack.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getRack.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getRaidControllers.md b/content/reference/services/SoftLayer_Hardware_Server/getRaidControllers.md index f45e5d4f23..39527457fc 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getRaidControllers.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getRaidControllers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getRaidControllers + Retrieve the RAID controllers contained within a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getReadyNodeFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getReadyNodeFlag.md index f444e490c6..bae1942470 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getReadyNodeFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getReadyNodeFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getReadyNodeFlag + Retrieve determine if hardware object is vSan Ready Node. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getRecentEvents.md b/content/reference/services/SoftLayer_Hardware_Server/getRecentEvents.md index 49c77abea1..8f09116adb 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getRecentEvents.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getRecentEvents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getRecentEvents + Retrieve recent events that impact this hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getRecentRemoteManagementCommands.md b/content/reference/services/SoftLayer_Hardware_Server/getRecentRemoteManagementCommands.md index 951e34c7a0..5d52a437c9 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getRecentRemoteManagementCommands.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getRecentRemoteManagementCommands.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getRecentRemoteManagementCommands + Retrieve the last five commands issued to the server's remote management card. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getRegionalInternetRegistry.md b/content/reference/services/SoftLayer_Hardware_Server/getRegionalInternetRegistry.md index 7efa59d780..aee596753d 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getRegionalInternetRegistry.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getRegionalInternetRegistry.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getRemoteManagement.md b/content/reference/services/SoftLayer_Hardware_Server/getRemoteManagement.md index 4e494e8887..f4b265a8d1 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getRemoteManagement.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getRemoteManagement.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getRemoteManagement + Retrieve a server's remote management card. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getRemoteManagementAccounts.md b/content/reference/services/SoftLayer_Hardware_Server/getRemoteManagementAccounts.md index 3f854a694e..a7d69f0bea 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getRemoteManagementAccounts.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getRemoteManagementAccounts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getRemoteManagementAccounts + Retrieve user credentials to issue commands and/or interact with the server's remote management card. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getRemoteManagementComponent.md b/content/reference/services/SoftLayer_Hardware_Server/getRemoteManagementComponent.md index 5b9c8cf028..859d232e96 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getRemoteManagementComponent.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getRemoteManagementComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getRemoteManagementComponent + Retrieve a hardware's associated remote management component. This is normally IPMI. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getRemoteManagementUsers.md b/content/reference/services/SoftLayer_Hardware_Server/getRemoteManagementUsers.md index 74e41446a1..e81058e91e 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getRemoteManagementUsers.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getRemoteManagementUsers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getRemoteManagementUsers + Retrieve user(s) who have access to issue commands and/or interact with the server's remote management card. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getResourceConfigurations.md b/content/reference/services/SoftLayer_Hardware_Server/getResourceConfigurations.md index 05c6289be8..1176b880db 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getResourceConfigurations.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getResourceConfigurations.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getResourceGroupMemberReferences.md b/content/reference/services/SoftLayer_Hardware_Server/getResourceGroupMemberReferences.md index 0acb0d02bf..982ff6d4f4 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getResourceGroupMemberReferences.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getResourceGroupMemberReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getResourceGroupRoles.md b/content/reference/services/SoftLayer_Hardware_Server/getResourceGroupRoles.md index 98a6a087d0..f3cd15dbf5 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getResourceGroupRoles.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getResourceGroupRoles.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getResourceGroups.md b/content/reference/services/SoftLayer_Hardware_Server/getResourceGroups.md index e1c421277a..0954848f73 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getResourceGroups.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getResourceGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getResourceGroups + Retrieve the resource groups in which this hardware is a member. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getReverseDomainRecords.md b/content/reference/services/SoftLayer_Hardware_Server/getReverseDomainRecords.md index 745ba2f335..9322267977 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getReverseDomainRecords.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getReverseDomainRecords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getReverseDomainRecords + Retrieve the reverse domain records associated with a server. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getRouters.md b/content/reference/services/SoftLayer_Hardware_Server/getRouters.md index e508b78eac..594ec425ef 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getRouters.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getRouters + Retrieve a hardware's routers. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getScaleAssets.md b/content/reference/services/SoftLayer_Hardware_Server/getScaleAssets.md index a016e91264..4ea477d8f5 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getScaleAssets.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getScaleAssets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getScaleAssets + Retrieve collection of scale assets this hardware corresponds to. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getSecurityScanRequests.md b/content/reference/services/SoftLayer_Hardware_Server/getSecurityScanRequests.md index b9b843732d..8d3bd6aad0 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getSecurityScanRequests.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getSecurityScanRequests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getSecurityScanRequests + Retrieve information regarding a piece of hardware's vulnerability scan requests. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getSensorData.md b/content/reference/services/SoftLayer_Hardware_Server/getSensorData.md index dff26c9b6f..285af0f1db 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getSensorData.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getSensorData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getSensorData + Retrieve a server's hardware state via its internal sensors. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getSensorDataWithGraphs.md b/content/reference/services/SoftLayer_Hardware_Server/getSensorDataWithGraphs.md index 12feb5478b..5dcb470c2f 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getSensorDataWithGraphs.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getSensorDataWithGraphs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getSensorDataWithGraphs + Retrieve server's temperature and fan speed graphs as well the sensor raw data. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getServerDetails.md b/content/reference/services/SoftLayer_Hardware_Server/getServerDetails.md index 8a69b5964d..d8d6bcfcb3 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getServerDetails.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getServerDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getServerDetails + Retrieve a server's hardware components, software, and network components. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getServerFanSpeedGraphs.md b/content/reference/services/SoftLayer_Hardware_Server/getServerFanSpeedGraphs.md index d0477e56f9..88ccbf2e26 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getServerFanSpeedGraphs.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getServerFanSpeedGraphs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getServerFanSpeedGraphs + Retrieve server's fan speed graphs. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getServerPowerState.md b/content/reference/services/SoftLayer_Hardware_Server/getServerPowerState.md index 0e221295fd..14c502275e 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getServerPowerState.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getServerPowerState.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getServerPowerState + Retrieves server's power state diff --git a/content/reference/services/SoftLayer_Hardware_Server/getServerRoom.md b/content/reference/services/SoftLayer_Hardware_Server/getServerRoom.md index 2640ffb625..57c8c72406 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getServerRoom.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getServerRoom.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getServerRoom + Retrieve information regarding the server room in which the hardware is located. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getServerTemperatureGraphs.md b/content/reference/services/SoftLayer_Hardware_Server/getServerTemperatureGraphs.md index 607c22ce0b..4dfff84ca0 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getServerTemperatureGraphs.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getServerTemperatureGraphs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getServerTemperatureGraphs + Retrieve server's temperature graphs diff --git a/content/reference/services/SoftLayer_Hardware_Server/getServiceProvider.md b/content/reference/services/SoftLayer_Hardware_Server/getServiceProvider.md index be0bc92cea..a63632b521 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getServiceProvider.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getServiceProvider.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getServiceProvider + Retrieve information regarding the piece of hardware's service provider. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getSoftwareComponents.md b/content/reference/services/SoftLayer_Hardware_Server/getSoftwareComponents.md index da9fe05876..16145bb30d 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getSoftwareComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getSoftwareComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getSoftwareComponents + Retrieve information regarding a piece of hardware's installed software. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getSoftwareGuardExtensionEnabled.md b/content/reference/services/SoftLayer_Hardware_Server/getSoftwareGuardExtensionEnabled.md index e7b2783aa0..13071e5f09 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getSoftwareGuardExtensionEnabled.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getSoftwareGuardExtensionEnabled.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getSoftwareGuardExtensionEnabled + Retrieve determine if hardware object has Software Guard Extension (SGX) enabled. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getSshKeys.md b/content/reference/services/SoftLayer_Hardware_Server/getSshKeys.md index f62287eda9..84d71c81bf 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getSshKeys.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getSshKeys.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getSshKeys + Retrieve sSH keys to be installed on the server during provisioning or an OS reload. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getStatisticsRemoteManagement.md b/content/reference/services/SoftLayer_Hardware_Server/getStatisticsRemoteManagement.md index 070063a526..10fa2bd0f2 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getStatisticsRemoteManagement.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getStatisticsRemoteManagement.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getStatisticsRemoteManagement + Retrieve a server's remote management card used for statistics. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getStorageGroups.md b/content/reference/services/SoftLayer_Hardware_Server/getStorageGroups.md index d565c3a2c6..cf443e9764 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getStorageGroups.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getStorageGroups.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getStorageNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_Server/getStorageNetworkComponents.md index a70fc06c1a..f7a2f026a1 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getStorageNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getStorageNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getStorageNetworkComponents + Retrieve a piece of hardware's private storage network components. [Deprecated] diff --git a/content/reference/services/SoftLayer_Hardware_Server/getTagReferences.md b/content/reference/services/SoftLayer_Hardware_Server/getTagReferences.md index 47c9defb14..1c2d6a3344 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getTagReferences.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getTagReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getTopLevelLocation.md b/content/reference/services/SoftLayer_Hardware_Server/getTopLevelLocation.md index 4e80926d48..a6d981c0bc 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getTopLevelLocation.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getTopLevelLocation.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/getTransactionHistory.md b/content/reference/services/SoftLayer_Hardware_Server/getTransactionHistory.md index 26cd9eb2b6..e8808ef9ea 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getTransactionHistory.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getTransactionHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getTransactionHistory + Get transaction history for a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getUefiBootFlag.md b/content/reference/services/SoftLayer_Hardware_Server/getUefiBootFlag.md index d500ec7ab1..9fdd25483c 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getUefiBootFlag.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getUefiBootFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getUefiBootFlag + Retrieve whether to use UEFI boot instead of BIOS. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getUpgradeItemPrices.md b/content/reference/services/SoftLayer_Hardware_Server/getUpgradeItemPrices.md index 140185c82c..53f777389e 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getUpgradeItemPrices.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getUpgradeItemPrices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getUpgradeItemPrices + Retrieve a list of upgradable items available to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getUpgradeRequest.md b/content/reference/services/SoftLayer_Hardware_Server/getUpgradeRequest.md index 9fd915d23a..12e2f3a47f 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getUpgradeRequest.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getUpgradeRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getUpgradeRequest + Retrieve an account's associated upgrade request object, if any. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getUplinkHardware.md b/content/reference/services/SoftLayer_Hardware_Server/getUplinkHardware.md index d6acfde869..b95d0a85e5 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getUplinkHardware.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getUplinkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getUplinkHardware + Retrieve the network device connected to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getUplinkNetworkComponents.md b/content/reference/services/SoftLayer_Hardware_Server/getUplinkNetworkComponents.md index 9bac241509..f9fceade47 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getUplinkNetworkComponents.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getUplinkNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getUplinkNetworkComponents + Retrieve information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getUserData.md b/content/reference/services/SoftLayer_Hardware_Server/getUserData.md index c22fc99ea6..08e7124e6a 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getUserData.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getUserData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getUserData + Retrieve an array containing a single string of custom user data for a hardware order. Max size is 16 kb. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getUsers.md b/content/reference/services/SoftLayer_Hardware_Server/getUsers.md index 797e37a0fd..0d253c3d8d 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getUsers.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getUsers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getUsers + Retrieve a list of users that have access to this computing instance. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getValidBlockDeviceTemplateGroups.md b/content/reference/services/SoftLayer_Hardware_Server/getValidBlockDeviceTemplateGroups.md index 9bc5fb2c65..867f144ab1 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getValidBlockDeviceTemplateGroups.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getValidBlockDeviceTemplateGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getValidBlockDeviceTemplateGroups + Return a list of valid block device template groups based on this host diff --git a/content/reference/services/SoftLayer_Hardware_Server/getVirtualChassis.md b/content/reference/services/SoftLayer_Hardware_Server/getVirtualChassis.md index 1489758343..64fbb9a44f 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getVirtualChassis.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getVirtualChassis.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getVirtualChassis + Retrieve information regarding the virtual chassis for a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getVirtualChassisSiblings.md b/content/reference/services/SoftLayer_Hardware_Server/getVirtualChassisSiblings.md index 82093125bc..7c939c3a0e 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getVirtualChassisSiblings.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getVirtualChassisSiblings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getVirtualChassisSiblings + Retrieve information regarding the virtual chassis siblings for a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getVirtualGuests.md b/content/reference/services/SoftLayer_Hardware_Server/getVirtualGuests.md index 0189984a03..6d67c1f408 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getVirtualGuests.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getVirtualGuests + Retrieve a hardware server's virtual servers. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getVirtualHost.md b/content/reference/services/SoftLayer_Hardware_Server/getVirtualHost.md index d026190608..fed5233812 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getVirtualHost.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getVirtualHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getVirtualHost + Retrieve a piece of hardware's virtual host record. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getVirtualLicenses.md b/content/reference/services/SoftLayer_Hardware_Server/getVirtualLicenses.md index 6002561ff8..178df88b53 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getVirtualLicenses.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getVirtualLicenses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getVirtualLicenses + Retrieve information regarding a piece of hardware's virtual software licenses. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getVirtualRack.md b/content/reference/services/SoftLayer_Hardware_Server/getVirtualRack.md index f5fb2ef8d8..4b4e3e4eb4 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getVirtualRack.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getVirtualRack.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getVirtualRack + Retrieve information regarding the bandwidth allotment to which a piece of hardware belongs. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getVirtualRackId.md b/content/reference/services/SoftLayer_Hardware_Server/getVirtualRackId.md index 7b28417b92..670ea7d812 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getVirtualRackId.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getVirtualRackId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getVirtualRackId + Retrieve the name of the bandwidth allotment belonging to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getVirtualRackName.md b/content/reference/services/SoftLayer_Hardware_Server/getVirtualRackName.md index 4c0c1f805a..cb5d32d64b 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getVirtualRackName.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getVirtualRackName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getVirtualRackName + Retrieve the name of the bandwidth allotment belonging to a piece of hardware. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getVirtualizationPlatform.md b/content/reference/services/SoftLayer_Hardware_Server/getVirtualizationPlatform.md index b0a25db3ff..c283d2e7a4 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getVirtualizationPlatform.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getVirtualizationPlatform.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getVirtualizationPlatform + Retrieve a piece of hardware's virtualization platform software. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getWindowsUpdateAvailableUpdates.md b/content/reference/services/SoftLayer_Hardware_Server/getWindowsUpdateAvailableUpdates.md index b63fe4ed36..398469aa37 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getWindowsUpdateAvailableUpdates.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getWindowsUpdateAvailableUpdates.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getWindowsUpdateAvailableUpdates + Retrieve a list of Windows updates available to a server. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getWindowsUpdateInstalledUpdates.md b/content/reference/services/SoftLayer_Hardware_Server/getWindowsUpdateInstalledUpdates.md index a05daa7792..0b7c32a338 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getWindowsUpdateInstalledUpdates.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getWindowsUpdateInstalledUpdates.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getWindowsUpdateInstalledUpdates + Retrieve a list of Windows updates installed on a server. diff --git a/content/reference/services/SoftLayer_Hardware_Server/getWindowsUpdateStatus.md b/content/reference/services/SoftLayer_Hardware_Server/getWindowsUpdateStatus.md index 5bc96a2466..3c75ca14d6 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/getWindowsUpdateStatus.md +++ b/content/reference/services/SoftLayer_Hardware_Server/getWindowsUpdateStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::getWindowsUpdateStatus + Retrieve a server's Windows update synchronization status diff --git a/content/reference/services/SoftLayer_Hardware_Server/importVirtualHost.md b/content/reference/services/SoftLayer_Hardware_Server/importVirtualHost.md index 4e26bfe692..d343dd0138 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/importVirtualHost.md +++ b/content/reference/services/SoftLayer_Hardware_Server/importVirtualHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::importVirtualHost + attempt to import the host record for the virtualization platform running on a server diff --git a/content/reference/services/SoftLayer_Hardware_Server/initiateIderaBareMetalRestore.md b/content/reference/services/SoftLayer_Hardware_Server/initiateIderaBareMetalRestore.md index 740a7f8574..bf191eb4e1 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/initiateIderaBareMetalRestore.md +++ b/content/reference/services/SoftLayer_Hardware_Server/initiateIderaBareMetalRestore.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::initiateIderaBareMetalRestore + Initiate an Idera bare metal restore for the server tied to an Idera Server Backup diff --git a/content/reference/services/SoftLayer_Hardware_Server/initiateR1SoftBareMetalRestore.md b/content/reference/services/SoftLayer_Hardware_Server/initiateR1SoftBareMetalRestore.md index 14df1407bf..1865fb55f4 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/initiateR1SoftBareMetalRestore.md +++ b/content/reference/services/SoftLayer_Hardware_Server/initiateR1SoftBareMetalRestore.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::initiateR1SoftBareMetalRestore + Initiate an R1Soft bare metal restore for the server tied to an R1Soft CDP Server diff --git a/content/reference/services/SoftLayer_Hardware_Server/isBackendPingable.md b/content/reference/services/SoftLayer_Hardware_Server/isBackendPingable.md index c17a3bf02f..3581254676 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/isBackendPingable.md +++ b/content/reference/services/SoftLayer_Hardware_Server/isBackendPingable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::isBackendPingable + Verifies if a server's backend ip address is pingable. diff --git a/content/reference/services/SoftLayer_Hardware_Server/isPingable.md b/content/reference/services/SoftLayer_Hardware_Server/isPingable.md index c393c43481..1ba00bc700 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/isPingable.md +++ b/content/reference/services/SoftLayer_Hardware_Server/isPingable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::isPingable + Verifies if server is pingable. diff --git a/content/reference/services/SoftLayer_Hardware_Server/isWindowsServer.md b/content/reference/services/SoftLayer_Hardware_Server/isWindowsServer.md index f7b4212952..403f135ad8 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/isWindowsServer.md +++ b/content/reference/services/SoftLayer_Hardware_Server/isWindowsServer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::isWindowsServer + Determine if a server runs the Microsoft Windows operating system. diff --git a/content/reference/services/SoftLayer_Hardware_Server/massFirmwareReflash.md b/content/reference/services/SoftLayer_Hardware_Server/massFirmwareReflash.md index 49d4b64c2e..2a8e111dcd 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/massFirmwareReflash.md +++ b/content/reference/services/SoftLayer_Hardware_Server/massFirmwareReflash.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::massFirmwareReflash + Runs firmware reflashes on the servers components. diff --git a/content/reference/services/SoftLayer_Hardware_Server/massFirmwareUpdate.md b/content/reference/services/SoftLayer_Hardware_Server/massFirmwareUpdate.md index 6a3e04e007..cea4727a57 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/massFirmwareUpdate.md +++ b/content/reference/services/SoftLayer_Hardware_Server/massFirmwareUpdate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::massFirmwareUpdate + Runs firmware updates on the servers components. diff --git a/content/reference/services/SoftLayer_Hardware_Server/massHyperThreadingUpdate.md b/content/reference/services/SoftLayer_Hardware_Server/massHyperThreadingUpdate.md index ee88f14edd..77dbf0cb28 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/massHyperThreadingUpdate.md +++ b/content/reference/services/SoftLayer_Hardware_Server/massHyperThreadingUpdate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::massHyperThreadingUpdate + Runs firmware reflashes on the servers components. diff --git a/content/reference/services/SoftLayer_Hardware_Server/massReloadOperatingSystem.md b/content/reference/services/SoftLayer_Hardware_Server/massReloadOperatingSystem.md index dfcff7e4ae..562e6c2d44 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/massReloadOperatingSystem.md +++ b/content/reference/services/SoftLayer_Hardware_Server/massReloadOperatingSystem.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::massReloadOperatingSystem + Reloads operating system configuration on a set of hardware Ids. diff --git a/content/reference/services/SoftLayer_Hardware_Server/massSparePool.md b/content/reference/services/SoftLayer_Hardware_Server/massSparePool.md index 02522e8682..b8e47bb1d7 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/massSparePool.md +++ b/content/reference/services/SoftLayer_Hardware_Server/massSparePool.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::massSparePool + Allows multiple servers to be added to or removed from the spare pool. diff --git a/content/reference/services/SoftLayer_Hardware_Server/ping.md b/content/reference/services/SoftLayer_Hardware_Server/ping.md index f4b29c8831..3a56894191 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/ping.md +++ b/content/reference/services/SoftLayer_Hardware_Server/ping.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::ping + Issues ping command. diff --git a/content/reference/services/SoftLayer_Hardware_Server/populateServerRam.md b/content/reference/services/SoftLayer_Hardware_Server/populateServerRam.md index 15f2e28a19..21b20faff6 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/populateServerRam.md +++ b/content/reference/services/SoftLayer_Hardware_Server/populateServerRam.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/powerCycle.md b/content/reference/services/SoftLayer_Hardware_Server/powerCycle.md index cf7ee7ef89..a5cccff97b 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/powerCycle.md +++ b/content/reference/services/SoftLayer_Hardware_Server/powerCycle.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::powerCycle + Issues power cycle to server. diff --git a/content/reference/services/SoftLayer_Hardware_Server/powerOff.md b/content/reference/services/SoftLayer_Hardware_Server/powerOff.md index 1e1d58c921..a66be116b1 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/powerOff.md +++ b/content/reference/services/SoftLayer_Hardware_Server/powerOff.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::powerOff + Power off server. diff --git a/content/reference/services/SoftLayer_Hardware_Server/powerOn.md b/content/reference/services/SoftLayer_Hardware_Server/powerOn.md index 68e28a0472..aad44c649c 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/powerOn.md +++ b/content/reference/services/SoftLayer_Hardware_Server/powerOn.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::powerOn + Power on server. diff --git a/content/reference/services/SoftLayer_Hardware_Server/rebootDefault.md b/content/reference/services/SoftLayer_Hardware_Server/rebootDefault.md index ab192df028..8c464550cf 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/rebootDefault.md +++ b/content/reference/services/SoftLayer_Hardware_Server/rebootDefault.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::rebootDefault + Reboot the server via the default method. diff --git a/content/reference/services/SoftLayer_Hardware_Server/rebootHard.md b/content/reference/services/SoftLayer_Hardware_Server/rebootHard.md index 6950fcd75b..09473de8c7 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/rebootHard.md +++ b/content/reference/services/SoftLayer_Hardware_Server/rebootHard.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::rebootHard + Reboot the server via "hard" reboot. diff --git a/content/reference/services/SoftLayer_Hardware_Server/rebootSoft.md b/content/reference/services/SoftLayer_Hardware_Server/rebootSoft.md index 89795ce0ba..7df6cca5ca 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/rebootSoft.md +++ b/content/reference/services/SoftLayer_Hardware_Server/rebootSoft.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::rebootSoft + Reboot the server via gracefully (soft reboot). diff --git a/content/reference/services/SoftLayer_Hardware_Server/reloadCurrentOperatingSystemConfiguration.md b/content/reference/services/SoftLayer_Hardware_Server/reloadCurrentOperatingSystemConfiguration.md index 0a688965ab..627dd607dc 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/reloadCurrentOperatingSystemConfiguration.md +++ b/content/reference/services/SoftLayer_Hardware_Server/reloadCurrentOperatingSystemConfiguration.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::reloadCurrentOperatingSystemConfiguration + Reloads current operating system configuration. diff --git a/content/reference/services/SoftLayer_Hardware_Server/reloadOperatingSystem.md b/content/reference/services/SoftLayer_Hardware_Server/reloadOperatingSystem.md index aa724813cb..02794faec8 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/reloadOperatingSystem.md +++ b/content/reference/services/SoftLayer_Hardware_Server/reloadOperatingSystem.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::reloadOperatingSystem + Reloads operating system configuration. diff --git a/content/reference/services/SoftLayer_Hardware_Server/removeAccessToNetworkStorage.md b/content/reference/services/SoftLayer_Hardware_Server/removeAccessToNetworkStorage.md index 5cf04c5342..d20e945fe4 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/removeAccessToNetworkStorage.md +++ b/content/reference/services/SoftLayer_Hardware_Server/removeAccessToNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::removeAccessToNetworkStorage + Remove access to a SoftLayer_Network_Storage volume from this device. diff --git a/content/reference/services/SoftLayer_Hardware_Server/removeAccessToNetworkStorageList.md b/content/reference/services/SoftLayer_Hardware_Server/removeAccessToNetworkStorageList.md index e9133be292..f8ca2e6e65 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/removeAccessToNetworkStorageList.md +++ b/content/reference/services/SoftLayer_Hardware_Server/removeAccessToNetworkStorageList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::removeAccessToNetworkStorageList + Remove access to multiple SoftLayer_Network_Storage volumes from this device. diff --git a/content/reference/services/SoftLayer_Hardware_Server/removeTags.md b/content/reference/services/SoftLayer_Hardware_Server/removeTags.md index 6f70711fc5..73d8048c01 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/removeTags.md +++ b/content/reference/services/SoftLayer_Hardware_Server/removeTags.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::removeTags + Remove a tag reference diff --git a/content/reference/services/SoftLayer_Hardware_Server/runPassmarkCertificationBenchmark.md b/content/reference/services/SoftLayer_Hardware_Server/runPassmarkCertificationBenchmark.md index 45b210ab73..5c588cfcb1 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/runPassmarkCertificationBenchmark.md +++ b/content/reference/services/SoftLayer_Hardware_Server/runPassmarkCertificationBenchmark.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::runPassmarkCertificationBenchmark + Runs a hardware stress test on the server to obtain a Passmark Certification. diff --git a/content/reference/services/SoftLayer_Hardware_Server/setOperatingSystemPassword.md b/content/reference/services/SoftLayer_Hardware_Server/setOperatingSystemPassword.md index 0e3d9604e9..8d70b9a37e 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/setOperatingSystemPassword.md +++ b/content/reference/services/SoftLayer_Hardware_Server/setOperatingSystemPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::setOperatingSystemPassword + Changes the password stored in our system for a servers' Operating System diff --git a/content/reference/services/SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed.md b/content/reference/services/SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed.md index f0fe8ca5fb..84a4b27923 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed.md +++ b/content/reference/services/SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::setPrivateNetworkInterfaceSpeed + Set the speed and redundancy configuration of a server's private network interface. diff --git a/content/reference/services/SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed.md b/content/reference/services/SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed.md index cb27268a3f..aedc27d291 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed.md +++ b/content/reference/services/SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::setPublicNetworkInterfaceSpeed + Set the speed and redundancy configuration of a server's public network interface. diff --git a/content/reference/services/SoftLayer_Hardware_Server/setTags.md b/content/reference/services/SoftLayer_Hardware_Server/setTags.md index 4184c5e19d..3806bb0e86 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/setTags.md +++ b/content/reference/services/SoftLayer_Hardware_Server/setTags.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Hardware_Server/setUserMetadata.md b/content/reference/services/SoftLayer_Hardware_Server/setUserMetadata.md index 583b7c5d41..8639411376 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/setUserMetadata.md +++ b/content/reference/services/SoftLayer_Hardware_Server/setUserMetadata.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::setUserMetadata + Sets the server's user metadata value. diff --git a/content/reference/services/SoftLayer_Hardware_Server/shutdownPrivatePort.md b/content/reference/services/SoftLayer_Hardware_Server/shutdownPrivatePort.md index d644faea84..48d5c39329 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/shutdownPrivatePort.md +++ b/content/reference/services/SoftLayer_Hardware_Server/shutdownPrivatePort.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::shutdownPrivatePort + Disconnect a server's private network interface. diff --git a/content/reference/services/SoftLayer_Hardware_Server/shutdownPublicPort.md b/content/reference/services/SoftLayer_Hardware_Server/shutdownPublicPort.md index 97b65674ff..5c7ae499f7 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/shutdownPublicPort.md +++ b/content/reference/services/SoftLayer_Hardware_Server/shutdownPublicPort.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::shutdownPublicPort + Disconnect a server's public network interface. diff --git a/content/reference/services/SoftLayer_Hardware_Server/sparePool.md b/content/reference/services/SoftLayer_Hardware_Server/sparePool.md index 7b633da06b..57dca32b10 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/sparePool.md +++ b/content/reference/services/SoftLayer_Hardware_Server/sparePool.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::sparePool + Allows servers to be added to or removed from the spare pool. diff --git a/content/reference/services/SoftLayer_Hardware_Server/testRaidAlertService.md b/content/reference/services/SoftLayer_Hardware_Server/testRaidAlertService.md index f46bb9b922..e219e2a128 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/testRaidAlertService.md +++ b/content/reference/services/SoftLayer_Hardware_Server/testRaidAlertService.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::testRaidAlertService + Tests the RAID Alert service. diff --git a/content/reference/services/SoftLayer_Hardware_Server/toggleManagementInterface.md b/content/reference/services/SoftLayer_Hardware_Server/toggleManagementInterface.md index 53783404e4..3301163e60 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/toggleManagementInterface.md +++ b/content/reference/services/SoftLayer_Hardware_Server/toggleManagementInterface.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::toggleManagementInterface + Toggle the IPMI interface on and off. diff --git a/content/reference/services/SoftLayer_Hardware_Server/updateIpmiPassword.md b/content/reference/services/SoftLayer_Hardware_Server/updateIpmiPassword.md index 7e3ed3897a..ce74dcea7c 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/updateIpmiPassword.md +++ b/content/reference/services/SoftLayer_Hardware_Server/updateIpmiPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::updateIpmiPassword + Update the root IPMI user password diff --git a/content/reference/services/SoftLayer_Hardware_Server/validatePartitionsForOperatingSystem.md b/content/reference/services/SoftLayer_Hardware_Server/validatePartitionsForOperatingSystem.md index 83dd9a9453..969fd71b78 100644 --- a/content/reference/services/SoftLayer_Hardware_Server/validatePartitionsForOperatingSystem.md +++ b/content/reference/services/SoftLayer_Hardware_Server/validatePartitionsForOperatingSystem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Hardware_Server](/reference/services/SoftLayer_Hardware_Server)::validatePartitionsForOperatingSystem + Validates a collection of partitions for an operating system diff --git a/content/reference/services/SoftLayer_Layout_Container/_index.md b/content/reference/services/SoftLayer_Layout_Container/_index.md index e5554a232c..e61b23ee9f 100644 --- a/content/reference/services/SoftLayer_Layout_Container/_index.md +++ b/content/reference/services/SoftLayer_Layout_Container/_index.md @@ -20,6 +20,8 @@ classes:
              ## Description + + 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]({{}}), allowing for full customization of the container's related items. @@ -54,24 +56,28 @@ A single page in the portal can be thought of as a layout container. The contain #### [getAllObjects](/reference/services/SoftLayer_Layout_Container/getAllObjects) Returns customizable layout containers +
              #### [getLayoutContainerType](/reference/services/SoftLayer_Layout_Container/getLayoutContainerType) Retrieve the type of the layout container object +
              #### [getLayoutItems](/reference/services/SoftLayer_Layout_Container/getLayoutItems) Retrieve the layout items assigned to this layout container +
              #### [getObject](/reference/services/SoftLayer_Layout_Container/getObject) Retrieve a SoftLayer_Layout_Container record. +
              diff --git a/content/reference/services/SoftLayer_Layout_Container/getAllObjects.md b/content/reference/services/SoftLayer_Layout_Container/getAllObjects.md index 51bc0efef8..dad97f89c2 100644 --- a/content/reference/services/SoftLayer_Layout_Container/getAllObjects.md +++ b/content/reference/services/SoftLayer_Layout_Container/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Container](/reference/services/SoftLayer_Layout_Container)::getAllObjects + Returns customizable layout containers diff --git a/content/reference/services/SoftLayer_Layout_Container/getLayoutContainerType.md b/content/reference/services/SoftLayer_Layout_Container/getLayoutContainerType.md index 46d8419621..70c56ce557 100644 --- a/content/reference/services/SoftLayer_Layout_Container/getLayoutContainerType.md +++ b/content/reference/services/SoftLayer_Layout_Container/getLayoutContainerType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Container](/reference/services/SoftLayer_Layout_Container)::getLayoutContainerType + Retrieve the type of the layout container object diff --git a/content/reference/services/SoftLayer_Layout_Container/getLayoutItems.md b/content/reference/services/SoftLayer_Layout_Container/getLayoutItems.md index aeafa0e7b0..154390443a 100644 --- a/content/reference/services/SoftLayer_Layout_Container/getLayoutItems.md +++ b/content/reference/services/SoftLayer_Layout_Container/getLayoutItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Container](/reference/services/SoftLayer_Layout_Container)::getLayoutItems + Retrieve the layout items assigned to this layout container diff --git a/content/reference/services/SoftLayer_Layout_Container/getObject.md b/content/reference/services/SoftLayer_Layout_Container/getObject.md index 5a4063cd92..3be2564ebf 100644 --- a/content/reference/services/SoftLayer_Layout_Container/getObject.md +++ b/content/reference/services/SoftLayer_Layout_Container/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Container](/reference/services/SoftLayer_Layout_Container)::getObject + Retrieve a SoftLayer_Layout_Container record. diff --git a/content/reference/services/SoftLayer_Layout_Item/_index.md b/content/reference/services/SoftLayer_Layout_Item/_index.md index 77eecf0d27..bf30bb155d 100644 --- a/content/reference/services/SoftLayer_Layout_Item/_index.md +++ b/content/reference/services/SoftLayer_Layout_Item/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + Layout items are used in the customization of the Portal 4 customer experience. Each [SoftLayer_Layout_Container]({{}}). @@ -57,18 +59,21 @@ Each [SoftLayer_Layout_Container]({{
              #### [getLayoutItemType](/reference/services/SoftLayer_Layout_Item/getLayoutItemType) Retrieve the type of the layout item object +
              #### [getObject](/reference/services/SoftLayer_Layout_Item/getObject) Retrieve a SoftLayer_Layout_Item record. +
              diff --git a/content/reference/services/SoftLayer_Layout_Item/getLayoutItemPreferences.md b/content/reference/services/SoftLayer_Layout_Item/getLayoutItemPreferences.md index 1b4343b751..836ee5ee97 100644 --- a/content/reference/services/SoftLayer_Layout_Item/getLayoutItemPreferences.md +++ b/content/reference/services/SoftLayer_Layout_Item/getLayoutItemPreferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Item](/reference/services/SoftLayer_Layout_Item)::getLayoutItemPreferences + Retrieve the layout preferences assigned to this layout item diff --git a/content/reference/services/SoftLayer_Layout_Item/getLayoutItemType.md b/content/reference/services/SoftLayer_Layout_Item/getLayoutItemType.md index d6e6377d54..0078611342 100644 --- a/content/reference/services/SoftLayer_Layout_Item/getLayoutItemType.md +++ b/content/reference/services/SoftLayer_Layout_Item/getLayoutItemType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Item](/reference/services/SoftLayer_Layout_Item)::getLayoutItemType + Retrieve the type of the layout item object diff --git a/content/reference/services/SoftLayer_Layout_Item/getObject.md b/content/reference/services/SoftLayer_Layout_Item/getObject.md index 8281dcca61..ded16f4c46 100644 --- a/content/reference/services/SoftLayer_Layout_Item/getObject.md +++ b/content/reference/services/SoftLayer_Layout_Item/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Item](/reference/services/SoftLayer_Layout_Item)::getObject + Retrieve a SoftLayer_Layout_Item record. diff --git a/content/reference/services/SoftLayer_Layout_Profile/_index.md b/content/reference/services/SoftLayer_Layout_Profile/_index.md index ec90fe9374..2761da097e 100644 --- a/content/reference/services/SoftLayer_Layout_Profile/_index.md +++ b/content/reference/services/SoftLayer_Layout_Profile/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Layout profiles are the primary object used to tie customized portal experiences to the [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]({{}}) method, giving the user their own customized configuration. @@ -58,48 +60,56 @@ In order to take full advantage of the flexible customization of the portal, eac #### [createObject](/reference/services/SoftLayer_Layout_Profile/createObject) Create a new layout profile +
              #### [deleteObject](/reference/services/SoftLayer_Layout_Profile/deleteObject) Delete a layout profile +
              #### [editObject](/reference/services/SoftLayer_Layout_Profile/editObject) Edit the layout profile object +
              #### [getLayoutContainers](/reference/services/SoftLayer_Layout_Profile/getLayoutContainers) +
              #### [getLayoutPreferences](/reference/services/SoftLayer_Layout_Profile/getLayoutPreferences) +
              #### [getObject](/reference/services/SoftLayer_Layout_Profile/getObject) Retrieve a SoftLayer_Layout_Profile record. +
              #### [modifyPreference](/reference/services/SoftLayer_Layout_Profile/modifyPreference) Modifies an associated layout preference +
              #### [modifyPreferences](/reference/services/SoftLayer_Layout_Profile/modifyPreferences) Modifies a collection of associated preferences +
              diff --git a/content/reference/services/SoftLayer_Layout_Profile/createObject.md b/content/reference/services/SoftLayer_Layout_Profile/createObject.md index 0a6c752405..53770bbcbe 100644 --- a/content/reference/services/SoftLayer_Layout_Profile/createObject.md +++ b/content/reference/services/SoftLayer_Layout_Profile/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Profile](/reference/services/SoftLayer_Layout_Profile)::createObject + Create a new layout profile diff --git a/content/reference/services/SoftLayer_Layout_Profile/deleteObject.md b/content/reference/services/SoftLayer_Layout_Profile/deleteObject.md index 31ec465282..3f200082e4 100644 --- a/content/reference/services/SoftLayer_Layout_Profile/deleteObject.md +++ b/content/reference/services/SoftLayer_Layout_Profile/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Profile](/reference/services/SoftLayer_Layout_Profile)::deleteObject + Delete a layout profile diff --git a/content/reference/services/SoftLayer_Layout_Profile/editObject.md b/content/reference/services/SoftLayer_Layout_Profile/editObject.md index da3edb9abe..d505e43696 100644 --- a/content/reference/services/SoftLayer_Layout_Profile/editObject.md +++ b/content/reference/services/SoftLayer_Layout_Profile/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Profile](/reference/services/SoftLayer_Layout_Profile)::editObject + Edit the layout profile object diff --git a/content/reference/services/SoftLayer_Layout_Profile/getLayoutContainers.md b/content/reference/services/SoftLayer_Layout_Profile/getLayoutContainers.md index 3ebaecc11c..2d9528333b 100644 --- a/content/reference/services/SoftLayer_Layout_Profile/getLayoutContainers.md +++ b/content/reference/services/SoftLayer_Layout_Profile/getLayoutContainers.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Layout_Profile/getLayoutPreferences.md b/content/reference/services/SoftLayer_Layout_Profile/getLayoutPreferences.md index 7247faf2ad..c80490e0dd 100644 --- a/content/reference/services/SoftLayer_Layout_Profile/getLayoutPreferences.md +++ b/content/reference/services/SoftLayer_Layout_Profile/getLayoutPreferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Layout_Profile/getObject.md b/content/reference/services/SoftLayer_Layout_Profile/getObject.md index 1ef5cbb7c9..72c07b406e 100644 --- a/content/reference/services/SoftLayer_Layout_Profile/getObject.md +++ b/content/reference/services/SoftLayer_Layout_Profile/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Profile](/reference/services/SoftLayer_Layout_Profile)::getObject + Retrieve a SoftLayer_Layout_Profile record. diff --git a/content/reference/services/SoftLayer_Layout_Profile/modifyPreference.md b/content/reference/services/SoftLayer_Layout_Profile/modifyPreference.md index f175a524a7..1df48cd834 100644 --- a/content/reference/services/SoftLayer_Layout_Profile/modifyPreference.md +++ b/content/reference/services/SoftLayer_Layout_Profile/modifyPreference.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Profile](/reference/services/SoftLayer_Layout_Profile)::modifyPreference + Modifies an associated layout preference diff --git a/content/reference/services/SoftLayer_Layout_Profile/modifyPreferences.md b/content/reference/services/SoftLayer_Layout_Profile/modifyPreferences.md index 6589f7c269..b3f56a1ff8 100644 --- a/content/reference/services/SoftLayer_Layout_Profile/modifyPreferences.md +++ b/content/reference/services/SoftLayer_Layout_Profile/modifyPreferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Profile](/reference/services/SoftLayer_Layout_Profile)::modifyPreferences + Modifies a collection of associated preferences diff --git a/content/reference/services/SoftLayer_Layout_Profile_Containers/_index.md b/content/reference/services/SoftLayer_Layout_Profile_Containers/_index.md index a6a1e0760b..78a56a5733 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Containers/_index.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Containers/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,30 +44,35 @@ classes: #### [createObject](/reference/services/SoftLayer_Layout_Profile_Containers/createObject) Associate a layout container with a profile +
              #### [editObject](/reference/services/SoftLayer_Layout_Profile_Containers/editObject) Edit the object by passing in a modified instance of the object +
              #### [getLayoutContainerType](/reference/services/SoftLayer_Layout_Profile_Containers/getLayoutContainerType) Retrieve the container to be contained +
              #### [getLayoutProfile](/reference/services/SoftLayer_Layout_Profile_Containers/getLayoutProfile) Retrieve the profile containing this container +
              #### [getObject](/reference/services/SoftLayer_Layout_Profile_Containers/getObject) Retrieve a SoftLayer_Layout_Profile_Containers record. +
              diff --git a/content/reference/services/SoftLayer_Layout_Profile_Containers/createObject.md b/content/reference/services/SoftLayer_Layout_Profile_Containers/createObject.md index 5ffbe22415..308cbc8940 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Containers/createObject.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Containers/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Profile_Containers](/reference/services/SoftLayer_Layout_Profile_Containers)::createObject + Associate a layout container with a profile diff --git a/content/reference/services/SoftLayer_Layout_Profile_Containers/editObject.md b/content/reference/services/SoftLayer_Layout_Profile_Containers/editObject.md index 2aa94458b4..58e9574fa6 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Containers/editObject.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Containers/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Profile_Containers](/reference/services/SoftLayer_Layout_Profile_Containers)::editObject + Edit the object by passing in a modified instance of the object diff --git a/content/reference/services/SoftLayer_Layout_Profile_Containers/getLayoutContainerType.md b/content/reference/services/SoftLayer_Layout_Profile_Containers/getLayoutContainerType.md index 5616b7b38c..3afe8e83f4 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Containers/getLayoutContainerType.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Containers/getLayoutContainerType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Profile_Containers](/reference/services/SoftLayer_Layout_Profile_Containers)::getLayoutContainerType + Retrieve the container to be contained diff --git a/content/reference/services/SoftLayer_Layout_Profile_Containers/getLayoutProfile.md b/content/reference/services/SoftLayer_Layout_Profile_Containers/getLayoutProfile.md index 0ce8dff3c3..a5eae6a6aa 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Containers/getLayoutProfile.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Containers/getLayoutProfile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Profile_Containers](/reference/services/SoftLayer_Layout_Profile_Containers)::getLayoutProfile + Retrieve the profile containing this container diff --git a/content/reference/services/SoftLayer_Layout_Profile_Containers/getObject.md b/content/reference/services/SoftLayer_Layout_Profile_Containers/getObject.md index 89abec3fc2..21a0395350 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Containers/getObject.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Containers/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Profile_Containers](/reference/services/SoftLayer_Layout_Profile_Containers)::getObject + Retrieve a SoftLayer_Layout_Profile_Containers record. diff --git a/content/reference/services/SoftLayer_Layout_Profile_Customer/_index.md b/content/reference/services/SoftLayer_Layout_Profile_Customer/_index.md index 3fb5cbb2bd..d93942e619 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Customer/_index.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Customer/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,54 +44,63 @@ classes: #### [createObject](/reference/services/SoftLayer_Layout_Profile_Customer/createObject) Create a new layout profile +
              #### [deleteObject](/reference/services/SoftLayer_Layout_Profile_Customer/deleteObject) Delete a layout profile +
              #### [editObject](/reference/services/SoftLayer_Layout_Profile_Customer/editObject) Edit the layout profile object +
              #### [getLayoutContainers](/reference/services/SoftLayer_Layout_Profile_Customer/getLayoutContainers) +
              #### [getLayoutPreferences](/reference/services/SoftLayer_Layout_Profile_Customer/getLayoutPreferences) +
              #### [getObject](/reference/services/SoftLayer_Layout_Profile_Customer/getObject) Retrieve a SoftLayer_Layout_Profile_Customer record. +
              #### [getUserRecord](/reference/services/SoftLayer_Layout_Profile_Customer/getUserRecord) +
              #### [modifyPreference](/reference/services/SoftLayer_Layout_Profile_Customer/modifyPreference) Modifies an associated layout preference +
              #### [modifyPreferences](/reference/services/SoftLayer_Layout_Profile_Customer/modifyPreferences) Modifies a collection of associated preferences +
              diff --git a/content/reference/services/SoftLayer_Layout_Profile_Customer/createObject.md b/content/reference/services/SoftLayer_Layout_Profile_Customer/createObject.md index 3719a78436..a43fe02390 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Customer/createObject.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Customer/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Profile_Customer](/reference/services/SoftLayer_Layout_Profile_Customer)::createObject + Create a new layout profile diff --git a/content/reference/services/SoftLayer_Layout_Profile_Customer/deleteObject.md b/content/reference/services/SoftLayer_Layout_Profile_Customer/deleteObject.md index 507a7a4128..9a3aae7547 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Customer/deleteObject.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Customer/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Profile_Customer](/reference/services/SoftLayer_Layout_Profile_Customer)::deleteObject + Delete a layout profile diff --git a/content/reference/services/SoftLayer_Layout_Profile_Customer/editObject.md b/content/reference/services/SoftLayer_Layout_Profile_Customer/editObject.md index ef3c90eac1..dab8844e89 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Customer/editObject.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Customer/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Profile_Customer](/reference/services/SoftLayer_Layout_Profile_Customer)::editObject + Edit the layout profile object diff --git a/content/reference/services/SoftLayer_Layout_Profile_Customer/getLayoutContainers.md b/content/reference/services/SoftLayer_Layout_Profile_Customer/getLayoutContainers.md index 72ce6685c7..e29cd488a9 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Customer/getLayoutContainers.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Customer/getLayoutContainers.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Layout_Profile_Customer/getLayoutPreferences.md b/content/reference/services/SoftLayer_Layout_Profile_Customer/getLayoutPreferences.md index 8770be136f..e447c19caf 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Customer/getLayoutPreferences.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Customer/getLayoutPreferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Layout_Profile_Customer/getObject.md b/content/reference/services/SoftLayer_Layout_Profile_Customer/getObject.md index 7b5b5817c5..65316a6a3d 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Customer/getObject.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Customer/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Profile_Customer](/reference/services/SoftLayer_Layout_Profile_Customer)::getObject + Retrieve a SoftLayer_Layout_Profile_Customer record. diff --git a/content/reference/services/SoftLayer_Layout_Profile_Customer/getUserRecord.md b/content/reference/services/SoftLayer_Layout_Profile_Customer/getUserRecord.md index cb04ef1a44..b8e1aedccb 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Customer/getUserRecord.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Customer/getUserRecord.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Layout_Profile_Customer/modifyPreference.md b/content/reference/services/SoftLayer_Layout_Profile_Customer/modifyPreference.md index bd28189666..77e2157388 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Customer/modifyPreference.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Customer/modifyPreference.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Profile_Customer](/reference/services/SoftLayer_Layout_Profile_Customer)::modifyPreference + Modifies an associated layout preference diff --git a/content/reference/services/SoftLayer_Layout_Profile_Customer/modifyPreferences.md b/content/reference/services/SoftLayer_Layout_Profile_Customer/modifyPreferences.md index c8c1db839c..ad8168cc48 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Customer/modifyPreferences.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Customer/modifyPreferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Profile_Customer](/reference/services/SoftLayer_Layout_Profile_Customer)::modifyPreferences + Modifies a collection of associated preferences diff --git a/content/reference/services/SoftLayer_Layout_Profile_Preference/_index.md b/content/reference/services/SoftLayer_Layout_Profile_Preference/_index.md index 6589e7b062..78a566c683 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Preference/_index.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Preference/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + The profile preferences are an aggregation of the default preferences and the customized preferences. For each [SoftLayer_Layout_Profile_Containers]({{}}) 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. @@ -57,30 +59,35 @@ For each [SoftLayer_Layout_Profile_Containers]({{
              #### [getLayoutItem](/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutItem) +
              #### [getLayoutPreference](/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutPreference) +
              #### [getLayoutProfile](/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutProfile) +
              #### [getObject](/reference/services/SoftLayer_Layout_Profile_Preference/getObject) Retrieve a SoftLayer_Layout_Profile_Preference record. +
              diff --git a/content/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutContainer.md b/content/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutContainer.md index d377db5868..a58e3fbba9 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutContainer.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutContainer.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutItem.md b/content/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutItem.md index a61317feeb..47524e9e42 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutItem.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutItem.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutPreference.md b/content/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutPreference.md index ae87da9296..2af15218b1 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutPreference.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutPreference.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutProfile.md b/content/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutProfile.md index ebf2be316f..4b7a4384fa 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutProfile.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Preference/getLayoutProfile.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Layout_Profile_Preference/getObject.md b/content/reference/services/SoftLayer_Layout_Profile_Preference/getObject.md index a1d5c6ac9d..d148954717 100644 --- a/content/reference/services/SoftLayer_Layout_Profile_Preference/getObject.md +++ b/content/reference/services/SoftLayer_Layout_Profile_Preference/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Layout_Profile_Preference](/reference/services/SoftLayer_Layout_Profile_Preference)::getObject + Retrieve a SoftLayer_Layout_Profile_Preference record. diff --git a/content/reference/services/SoftLayer_Locale/_index.md b/content/reference/services/SoftLayer_Locale/_index.md index fe55c50050..600741cef4 100644 --- a/content/reference/services/SoftLayer_Locale/_index.md +++ b/content/reference/services/SoftLayer_Locale/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getClosestToLanguageTag](/reference/services/SoftLayer_Locale/getClosestToLanguageTag) Get the closest locale for the language tag (ISO 639-1 & 3166-1) format. +
              #### [getObject](/reference/services/SoftLayer_Locale/getObject) Retrieve a SoftLayer_Locale record. +
              diff --git a/content/reference/services/SoftLayer_Locale/getClosestToLanguageTag.md b/content/reference/services/SoftLayer_Locale/getClosestToLanguageTag.md index 1c08fa1887..937cd40eab 100644 --- a/content/reference/services/SoftLayer_Locale/getClosestToLanguageTag.md +++ b/content/reference/services/SoftLayer_Locale/getClosestToLanguageTag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Locale](/reference/services/SoftLayer_Locale)::getClosestToLanguageTag + Get the closest locale for the language tag (ISO 639-1 & 3166-1) format. diff --git a/content/reference/services/SoftLayer_Locale/getObject.md b/content/reference/services/SoftLayer_Locale/getObject.md index db774daaf5..431e9b3e73 100644 --- a/content/reference/services/SoftLayer_Locale/getObject.md +++ b/content/reference/services/SoftLayer_Locale/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Locale](/reference/services/SoftLayer_Locale)::getObject + Retrieve a SoftLayer_Locale record. diff --git a/content/reference/services/SoftLayer_Locale_Country/_index.md b/content/reference/services/SoftLayer_Locale_Country/_index.md index e2c1305aff..d62f245ba5 100644 --- a/content/reference/services/SoftLayer_Locale_Country/_index.md +++ b/content/reference/services/SoftLayer_Locale_Country/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This service provides methods to retrieve country locale information. @@ -42,60 +44,70 @@ This service provides methods to retrieve country locale information. #### [getAllVatCountryCodesAndVatIdRegexes](/reference/services/SoftLayer_Locale_Country/getAllVatCountryCodesAndVatIdRegexes) +
              #### [getAvailableCountries](/reference/services/SoftLayer_Locale_Country/getAvailableCountries) +
              #### [getCountries](/reference/services/SoftLayer_Locale_Country/getCountries) +
              #### [getCountriesAndStates](/reference/services/SoftLayer_Locale_Country/getCountriesAndStates) +
              #### [getObject](/reference/services/SoftLayer_Locale_Country/getObject) Retrieve a SoftLayer_Locale_Country record. +
              #### [getPostalCodeRequiredCountryCodes](/reference/services/SoftLayer_Locale_Country/getPostalCodeRequiredCountryCodes) +
              #### [getStates](/reference/services/SoftLayer_Locale_Country/getStates) Retrieve states that belong to this country. +
              #### [getVatCountries](/reference/services/SoftLayer_Locale_Country/getVatCountries) +
              #### [getVatRequiredCountryCodes](/reference/services/SoftLayer_Locale_Country/getVatRequiredCountryCodes) +
              #### [isEuropeanUnionCountry](/reference/services/SoftLayer_Locale_Country/isEuropeanUnionCountry) +
              diff --git a/content/reference/services/SoftLayer_Locale_Country/getAllVatCountryCodesAndVatIdRegexes.md b/content/reference/services/SoftLayer_Locale_Country/getAllVatCountryCodesAndVatIdRegexes.md index c791efe470..6f5aef694f 100644 --- a/content/reference/services/SoftLayer_Locale_Country/getAllVatCountryCodesAndVatIdRegexes.md +++ b/content/reference/services/SoftLayer_Locale_Country/getAllVatCountryCodesAndVatIdRegexes.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method is to get the collection of VAT country codes and VAT ID Regexes. diff --git a/content/reference/services/SoftLayer_Locale_Country/getAvailableCountries.md b/content/reference/services/SoftLayer_Locale_Country/getAvailableCountries.md index c48f7044a3..d4514029c6 100644 --- a/content/reference/services/SoftLayer_Locale_Country/getAvailableCountries.md +++ b/content/reference/services/SoftLayer_Locale_Country/getAvailableCountries.md @@ -16,6 +16,7 @@ aliases: + ## Overview Use this method to retrieve a list of countries and locale information available to the current user. diff --git a/content/reference/services/SoftLayer_Locale_Country/getCountries.md b/content/reference/services/SoftLayer_Locale_Country/getCountries.md index a205944666..c52b1f2d70 100644 --- a/content/reference/services/SoftLayer_Locale_Country/getCountries.md +++ b/content/reference/services/SoftLayer_Locale_Country/getCountries.md @@ -16,6 +16,7 @@ aliases: + ## Overview Use this method to retrieve a list of countries and locale information such as country code and state/provinces. diff --git a/content/reference/services/SoftLayer_Locale_Country/getCountriesAndStates.md b/content/reference/services/SoftLayer_Locale_Country/getCountriesAndStates.md index e594fab865..a1858af57d 100644 --- a/content/reference/services/SoftLayer_Locale_Country/getCountriesAndStates.md +++ b/content/reference/services/SoftLayer_Locale_Country/getCountriesAndStates.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method will return a collection of [SoftLayer_Container_Collection_Locale_CountryCode]({{}}) objects. If the country has states, a [SoftLayer_Container_Collection_Locale_StateCode]({{}}) collection will be provided with the country. diff --git a/content/reference/services/SoftLayer_Locale_Country/getObject.md b/content/reference/services/SoftLayer_Locale_Country/getObject.md index a9b8565076..8c1436c161 100644 --- a/content/reference/services/SoftLayer_Locale_Country/getObject.md +++ b/content/reference/services/SoftLayer_Locale_Country/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Locale_Country](/reference/services/SoftLayer_Locale_Country)::getObject + Retrieve a SoftLayer_Locale_Country record. diff --git a/content/reference/services/SoftLayer_Locale_Country/getPostalCodeRequiredCountryCodes.md b/content/reference/services/SoftLayer_Locale_Country/getPostalCodeRequiredCountryCodes.md index 900b49a88c..c77d9b5e27 100644 --- a/content/reference/services/SoftLayer_Locale_Country/getPostalCodeRequiredCountryCodes.md +++ b/content/reference/services/SoftLayer_Locale_Country/getPostalCodeRequiredCountryCodes.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method will return an array of country codes that require postal code diff --git a/content/reference/services/SoftLayer_Locale_Country/getStates.md b/content/reference/services/SoftLayer_Locale_Country/getStates.md index 56d7d55b05..bb338856d5 100644 --- a/content/reference/services/SoftLayer_Locale_Country/getStates.md +++ b/content/reference/services/SoftLayer_Locale_Country/getStates.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Locale_Country](/reference/services/SoftLayer_Locale_Country)::getStates + Retrieve states that belong to this country. diff --git a/content/reference/services/SoftLayer_Locale_Country/getVatCountries.md b/content/reference/services/SoftLayer_Locale_Country/getVatCountries.md index 9118d878f9..815f3d08f5 100644 --- a/content/reference/services/SoftLayer_Locale_Country/getVatCountries.md +++ b/content/reference/services/SoftLayer_Locale_Country/getVatCountries.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method will return an array of ISO 3166 Alpha-2 country codes that use a Value-Added Tax (VAT) ID. Note the difference between [SoftLayer_Locale_Country::getVatRequiredCountryCodes]({{}}) - this method will provide all country codes that use VAT ID, including those which are required. diff --git a/content/reference/services/SoftLayer_Locale_Country/getVatRequiredCountryCodes.md b/content/reference/services/SoftLayer_Locale_Country/getVatRequiredCountryCodes.md index c473e3d48a..a310de1689 100644 --- a/content/reference/services/SoftLayer_Locale_Country/getVatRequiredCountryCodes.md +++ b/content/reference/services/SoftLayer_Locale_Country/getVatRequiredCountryCodes.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method will return an array of ISO 3166 Alpha-2 country codes that use a Value-Added Tax (VAT) ID. Note the difference between [SoftLayer_Locale_Country::getVatCountries]({{}}) - this method will provide country codes where a VAT ID is required for onboarding to IBM Cloud. diff --git a/content/reference/services/SoftLayer_Locale_Country/isEuropeanUnionCountry.md b/content/reference/services/SoftLayer_Locale_Country/isEuropeanUnionCountry.md index b06fdabc8e..25a92ab2bf 100644 --- a/content/reference/services/SoftLayer_Locale_Country/isEuropeanUnionCountry.md +++ b/content/reference/services/SoftLayer_Locale_Country/isEuropeanUnionCountry.md @@ -16,6 +16,7 @@ aliases: + ## Overview Returns true if the country code is in the European Union (EU), false otherwise. diff --git a/content/reference/services/SoftLayer_Locale_Timezone/_index.md b/content/reference/services/SoftLayer_Locale_Timezone/_index.md index 787ac1f264..0b492d2a9f 100644 --- a/content/reference/services/SoftLayer_Locale_Timezone/_index.md +++ b/content/reference/services/SoftLayer_Locale_Timezone/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Each User is assigned a timezone allowing for a precise local timestamp. @@ -42,12 +44,14 @@ Each User is assigned a timezone allowing for a precise local timestamp. #### [getAllObjects](/reference/services/SoftLayer_Locale_Timezone/getAllObjects) Retrieve all timezone objects. +
              #### [getObject](/reference/services/SoftLayer_Locale_Timezone/getObject) Retrieve a SoftLayer_Locale_Timezone record. +
              diff --git a/content/reference/services/SoftLayer_Locale_Timezone/getAllObjects.md b/content/reference/services/SoftLayer_Locale_Timezone/getAllObjects.md index d6127391a7..8df5525717 100644 --- a/content/reference/services/SoftLayer_Locale_Timezone/getAllObjects.md +++ b/content/reference/services/SoftLayer_Locale_Timezone/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Locale_Timezone](/reference/services/SoftLayer_Locale_Timezone)::getAllObjects + Retrieve all timezone objects. diff --git a/content/reference/services/SoftLayer_Locale_Timezone/getObject.md b/content/reference/services/SoftLayer_Locale_Timezone/getObject.md index 41505cae90..5f9529d613 100644 --- a/content/reference/services/SoftLayer_Locale_Timezone/getObject.md +++ b/content/reference/services/SoftLayer_Locale_Timezone/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Locale_Timezone](/reference/services/SoftLayer_Locale_Timezone)::getObject + Retrieve a SoftLayer_Locale_Timezone record. diff --git a/content/reference/services/SoftLayer_Location/_index.md b/content/reference/services/SoftLayer_Location/_index.md index 28b811b94c..4df73eb897 100644 --- a/content/reference/services/SoftLayer_Location/_index.md +++ b/content/reference/services/SoftLayer_Location/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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, network backbones, and many more. @@ -42,150 +44,175 @@ The SoftLayer_Location API service queries SoftLayer's location tree to find loc #### [getActivePresaleEvents](/reference/services/SoftLayer_Location/getActivePresaleEvents) +
              #### [getAvailableObjectStorageDatacenters](/reference/services/SoftLayer_Location/getAvailableObjectStorageDatacenters) Get the datacenters where object storage is available +
              #### [getBackboneDependents](/reference/services/SoftLayer_Location/getBackboneDependents) +
              #### [getBnppCompliantFlag](/reference/services/SoftLayer_Location/getBnppCompliantFlag) Retrieve a flag indicating whether or not the datacenter/location is BNPP compliant. +
              #### [getDatacenters](/reference/services/SoftLayer_Location/getDatacenters) Retrieve all datacenter locations +
              #### [getDatacentersWithVirtualImageStoreServiceResourceRecord](/reference/services/SoftLayer_Location/getDatacentersWithVirtualImageStoreServiceResourceRecord) +
              #### [getEuCompliantFlag](/reference/services/SoftLayer_Location/getEuCompliantFlag) Retrieve a flag indicating whether or not the datacenter/location is EU compliant. +
              #### [getGroups](/reference/services/SoftLayer_Location/getGroups) Retrieve a location can be a member of 1 or more groups. This will show which groups to which a location belongs. +
              #### [getHardwareFirewalls](/reference/services/SoftLayer_Location/getHardwareFirewalls) +
              #### [getLocationAddress](/reference/services/SoftLayer_Location/getLocationAddress) Retrieve a location's physical address. +
              #### [getLocationAddresses](/reference/services/SoftLayer_Location/getLocationAddresses) Retrieve a location's physical addresses. +
              #### [getLocationReservationMember](/reference/services/SoftLayer_Location/getLocationReservationMember) Retrieve a location's Dedicated Rack member +
              #### [getLocationStatus](/reference/services/SoftLayer_Location/getLocationStatus) Retrieve the current locations status. +
              #### [getNetworkConfigurationAttribute](/reference/services/SoftLayer_Location/getNetworkConfigurationAttribute) +
              #### [getObject](/reference/services/SoftLayer_Location/getObject) Retrieve a SoftLayer_Location record. +
              #### [getOnlineSslVpnUserCount](/reference/services/SoftLayer_Location/getOnlineSslVpnUserCount) Retrieve the total number of users online using SoftLayer's SSL VPN service for a location. +
              #### [getPathString](/reference/services/SoftLayer_Location/getPathString) +
              #### [getPriceGroups](/reference/services/SoftLayer_Location/getPriceGroups) Retrieve a location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. +
              #### [getRegions](/reference/services/SoftLayer_Location/getRegions) Retrieve a location can be a member of 1 or more regions. This will show which regions to which a location belongs. +
              #### [getTimezone](/reference/services/SoftLayer_Location/getTimezone) +
              #### [getVdrGroup](/reference/services/SoftLayer_Location/getVdrGroup) Retrieve a location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs. +
              #### [getViewableDatacenters](/reference/services/SoftLayer_Location/getViewableDatacenters) Retrieve all datacenter locations +
              #### [getViewablePopsAndDataCenters](/reference/services/SoftLayer_Location/getViewablePopsAndDataCenters) Retrieve viewable pops and datacenters in a combined list. +
              #### [getViewablepointOfPresence](/reference/services/SoftLayer_Location/getViewablepointOfPresence) Retrieve viewable network locations +
              #### [getpointOfPresence](/reference/services/SoftLayer_Location/getpointOfPresence) Retrieve all points of presence locations +
              diff --git a/content/reference/services/SoftLayer_Location/getActivePresaleEvents.md b/content/reference/services/SoftLayer_Location/getActivePresaleEvents.md index 96497d4341..5e065c23e6 100644 --- a/content/reference/services/SoftLayer_Location/getActivePresaleEvents.md +++ b/content/reference/services/SoftLayer_Location/getActivePresaleEvents.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location/getAvailableObjectStorageDatacenters.md b/content/reference/services/SoftLayer_Location/getAvailableObjectStorageDatacenters.md index 485dd2507e..50e625f8c7 100644 --- a/content/reference/services/SoftLayer_Location/getAvailableObjectStorageDatacenters.md +++ b/content/reference/services/SoftLayer_Location/getAvailableObjectStorageDatacenters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location](/reference/services/SoftLayer_Location)::getAvailableObjectStorageDatacenters + Get the datacenters where object storage is available diff --git a/content/reference/services/SoftLayer_Location/getBackboneDependents.md b/content/reference/services/SoftLayer_Location/getBackboneDependents.md index b0ca04d636..18a6dc0028 100644 --- a/content/reference/services/SoftLayer_Location/getBackboneDependents.md +++ b/content/reference/services/SoftLayer_Location/getBackboneDependents.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location/getBnppCompliantFlag.md b/content/reference/services/SoftLayer_Location/getBnppCompliantFlag.md index c452ba56a2..4d3c3815cc 100644 --- a/content/reference/services/SoftLayer_Location/getBnppCompliantFlag.md +++ b/content/reference/services/SoftLayer_Location/getBnppCompliantFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location](/reference/services/SoftLayer_Location)::getBnppCompliantFlag + Retrieve a flag indicating whether or not the datacenter/location is BNPP compliant. diff --git a/content/reference/services/SoftLayer_Location/getDatacenters.md b/content/reference/services/SoftLayer_Location/getDatacenters.md index 628e2a1718..7909debfee 100644 --- a/content/reference/services/SoftLayer_Location/getDatacenters.md +++ b/content/reference/services/SoftLayer_Location/getDatacenters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location](/reference/services/SoftLayer_Location)::getDatacenters + Retrieve all datacenter locations diff --git a/content/reference/services/SoftLayer_Location/getDatacentersWithVirtualImageStoreServiceResourceRecord.md b/content/reference/services/SoftLayer_Location/getDatacentersWithVirtualImageStoreServiceResourceRecord.md index c7f22c208b..620295869f 100644 --- a/content/reference/services/SoftLayer_Location/getDatacentersWithVirtualImageStoreServiceResourceRecord.md +++ b/content/reference/services/SoftLayer_Location/getDatacentersWithVirtualImageStoreServiceResourceRecord.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location/getEuCompliantFlag.md b/content/reference/services/SoftLayer_Location/getEuCompliantFlag.md index c75ac43cfc..57ab92702f 100644 --- a/content/reference/services/SoftLayer_Location/getEuCompliantFlag.md +++ b/content/reference/services/SoftLayer_Location/getEuCompliantFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location](/reference/services/SoftLayer_Location)::getEuCompliantFlag + Retrieve a flag indicating whether or not the datacenter/location is EU compliant. diff --git a/content/reference/services/SoftLayer_Location/getGroups.md b/content/reference/services/SoftLayer_Location/getGroups.md index 568e14ac9a..9b13afd2d4 100644 --- a/content/reference/services/SoftLayer_Location/getGroups.md +++ b/content/reference/services/SoftLayer_Location/getGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location](/reference/services/SoftLayer_Location)::getGroups + Retrieve a location can be a member of 1 or more groups. This will show which groups to which a location belongs. diff --git a/content/reference/services/SoftLayer_Location/getHardwareFirewalls.md b/content/reference/services/SoftLayer_Location/getHardwareFirewalls.md index f1c82a0c57..b33c0ba87a 100644 --- a/content/reference/services/SoftLayer_Location/getHardwareFirewalls.md +++ b/content/reference/services/SoftLayer_Location/getHardwareFirewalls.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location/getLocationAddress.md b/content/reference/services/SoftLayer_Location/getLocationAddress.md index dad0e135d5..4c7cef21a6 100644 --- a/content/reference/services/SoftLayer_Location/getLocationAddress.md +++ b/content/reference/services/SoftLayer_Location/getLocationAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location](/reference/services/SoftLayer_Location)::getLocationAddress + Retrieve a location's physical address. diff --git a/content/reference/services/SoftLayer_Location/getLocationAddresses.md b/content/reference/services/SoftLayer_Location/getLocationAddresses.md index a43e978e21..99ffac2c00 100644 --- a/content/reference/services/SoftLayer_Location/getLocationAddresses.md +++ b/content/reference/services/SoftLayer_Location/getLocationAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location](/reference/services/SoftLayer_Location)::getLocationAddresses + Retrieve a location's physical addresses. diff --git a/content/reference/services/SoftLayer_Location/getLocationReservationMember.md b/content/reference/services/SoftLayer_Location/getLocationReservationMember.md index b14f31e98a..641631eff8 100644 --- a/content/reference/services/SoftLayer_Location/getLocationReservationMember.md +++ b/content/reference/services/SoftLayer_Location/getLocationReservationMember.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location](/reference/services/SoftLayer_Location)::getLocationReservationMember + Retrieve a location's Dedicated Rack member diff --git a/content/reference/services/SoftLayer_Location/getLocationStatus.md b/content/reference/services/SoftLayer_Location/getLocationStatus.md index 65fcc84f7c..dbd9182801 100644 --- a/content/reference/services/SoftLayer_Location/getLocationStatus.md +++ b/content/reference/services/SoftLayer_Location/getLocationStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location](/reference/services/SoftLayer_Location)::getLocationStatus + Retrieve the current locations status. diff --git a/content/reference/services/SoftLayer_Location/getNetworkConfigurationAttribute.md b/content/reference/services/SoftLayer_Location/getNetworkConfigurationAttribute.md index 70bcca1337..9822406a6b 100644 --- a/content/reference/services/SoftLayer_Location/getNetworkConfigurationAttribute.md +++ b/content/reference/services/SoftLayer_Location/getNetworkConfigurationAttribute.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location/getObject.md b/content/reference/services/SoftLayer_Location/getObject.md index 0109c4173a..e160b15985 100644 --- a/content/reference/services/SoftLayer_Location/getObject.md +++ b/content/reference/services/SoftLayer_Location/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location](/reference/services/SoftLayer_Location)::getObject + Retrieve a SoftLayer_Location record. diff --git a/content/reference/services/SoftLayer_Location/getOnlineSslVpnUserCount.md b/content/reference/services/SoftLayer_Location/getOnlineSslVpnUserCount.md index cfdaab9ce4..d63a857751 100644 --- a/content/reference/services/SoftLayer_Location/getOnlineSslVpnUserCount.md +++ b/content/reference/services/SoftLayer_Location/getOnlineSslVpnUserCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location](/reference/services/SoftLayer_Location)::getOnlineSslVpnUserCount + Retrieve the total number of users online using SoftLayer's SSL VPN service for a location. diff --git a/content/reference/services/SoftLayer_Location/getPathString.md b/content/reference/services/SoftLayer_Location/getPathString.md index 1a863c9c99..f7fc1858ce 100644 --- a/content/reference/services/SoftLayer_Location/getPathString.md +++ b/content/reference/services/SoftLayer_Location/getPathString.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location/getPriceGroups.md b/content/reference/services/SoftLayer_Location/getPriceGroups.md index c6ec9917e3..4068e32243 100644 --- a/content/reference/services/SoftLayer_Location/getPriceGroups.md +++ b/content/reference/services/SoftLayer_Location/getPriceGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location](/reference/services/SoftLayer_Location)::getPriceGroups + Retrieve a location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. diff --git a/content/reference/services/SoftLayer_Location/getRegions.md b/content/reference/services/SoftLayer_Location/getRegions.md index d3481358b2..278ee9bea8 100644 --- a/content/reference/services/SoftLayer_Location/getRegions.md +++ b/content/reference/services/SoftLayer_Location/getRegions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location](/reference/services/SoftLayer_Location)::getRegions + Retrieve a location can be a member of 1 or more regions. This will show which regions to which a location belongs. diff --git a/content/reference/services/SoftLayer_Location/getTimezone.md b/content/reference/services/SoftLayer_Location/getTimezone.md index e0a0ba662c..695cd6363e 100644 --- a/content/reference/services/SoftLayer_Location/getTimezone.md +++ b/content/reference/services/SoftLayer_Location/getTimezone.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location/getVdrGroup.md b/content/reference/services/SoftLayer_Location/getVdrGroup.md index d9fcee5ad4..27bbab47c0 100644 --- a/content/reference/services/SoftLayer_Location/getVdrGroup.md +++ b/content/reference/services/SoftLayer_Location/getVdrGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location](/reference/services/SoftLayer_Location)::getVdrGroup + Retrieve a location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs. diff --git a/content/reference/services/SoftLayer_Location/getViewableDatacenters.md b/content/reference/services/SoftLayer_Location/getViewableDatacenters.md index 5e2df99469..c6726b3955 100644 --- a/content/reference/services/SoftLayer_Location/getViewableDatacenters.md +++ b/content/reference/services/SoftLayer_Location/getViewableDatacenters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location](/reference/services/SoftLayer_Location)::getViewableDatacenters + Retrieve all datacenter locations diff --git a/content/reference/services/SoftLayer_Location/getViewablePopsAndDataCenters.md b/content/reference/services/SoftLayer_Location/getViewablePopsAndDataCenters.md index f8c01094c7..49f54bb4d1 100644 --- a/content/reference/services/SoftLayer_Location/getViewablePopsAndDataCenters.md +++ b/content/reference/services/SoftLayer_Location/getViewablePopsAndDataCenters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location](/reference/services/SoftLayer_Location)::getViewablePopsAndDataCenters + Retrieve viewable pops and datacenters in a combined list. diff --git a/content/reference/services/SoftLayer_Location/getViewablepointOfPresence.md b/content/reference/services/SoftLayer_Location/getViewablepointOfPresence.md index 6fe4454ccb..28a91af0e9 100644 --- a/content/reference/services/SoftLayer_Location/getViewablepointOfPresence.md +++ b/content/reference/services/SoftLayer_Location/getViewablepointOfPresence.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location](/reference/services/SoftLayer_Location)::getViewablepointOfPresence + Retrieve viewable network locations diff --git a/content/reference/services/SoftLayer_Location/getpointOfPresence.md b/content/reference/services/SoftLayer_Location/getpointOfPresence.md index e10c17baab..0d09dd375b 100644 --- a/content/reference/services/SoftLayer_Location/getpointOfPresence.md +++ b/content/reference/services/SoftLayer_Location/getpointOfPresence.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location](/reference/services/SoftLayer_Location)::getpointOfPresence + Retrieve all points of presence locations diff --git a/content/reference/services/SoftLayer_Location_Datacenter/_index.md b/content/reference/services/SoftLayer_Location_Datacenter/_index.md index e3dd8fe0ac..6c5b2234d3 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/_index.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -47,216 +49,252 @@ SoftLayer_Location_Datacenter exposes functionality to access datacenter-specifi #### [getActiveItemPresaleEvents](/reference/services/SoftLayer_Location_Datacenter/getActiveItemPresaleEvents) +
              #### [getActivePresaleEvents](/reference/services/SoftLayer_Location_Datacenter/getActivePresaleEvents) +
              #### [getAvailableObjectStorageDatacenters](/reference/services/SoftLayer_Location_Datacenter/getAvailableObjectStorageDatacenters) Get the datacenters where object storage is available +
              #### [getBackboneDependents](/reference/services/SoftLayer_Location_Datacenter/getBackboneDependents) +
              #### [getBackendHardwareRouters](/reference/services/SoftLayer_Location_Datacenter/getBackendHardwareRouters) +
              #### [getBnppCompliantFlag](/reference/services/SoftLayer_Location_Datacenter/getBnppCompliantFlag) Retrieve a flag indicating whether or not the datacenter/location is BNPP compliant. +
              #### [getBoundSubnets](/reference/services/SoftLayer_Location_Datacenter/getBoundSubnets) Retrieve subnets which are directly bound to one or more routers in a given datacenter, and currently allow routing. +
              #### [getBrandCountryRestrictions](/reference/services/SoftLayer_Location_Datacenter/getBrandCountryRestrictions) Retrieve this references 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 this brand for customers that live in Great Britain. +
              #### [getDatacenters](/reference/services/SoftLayer_Location_Datacenter/getDatacenters) Retrieve all datacenter locations +
              #### [getDatacentersWithVirtualImageStoreServiceResourceRecord](/reference/services/SoftLayer_Location_Datacenter/getDatacentersWithVirtualImageStoreServiceResourceRecord) +
              #### [getEuCompliantFlag](/reference/services/SoftLayer_Location_Datacenter/getEuCompliantFlag) Retrieve a flag indicating whether or not the datacenter/location is EU compliant. +
              #### [getFrontendHardwareRouters](/reference/services/SoftLayer_Location_Datacenter/getFrontendHardwareRouters) +
              #### [getGroups](/reference/services/SoftLayer_Location_Datacenter/getGroups) Retrieve a location can be a member of 1 or more groups. This will show which groups to which a location belongs. +
              #### [getHardwareFirewalls](/reference/services/SoftLayer_Location_Datacenter/getHardwareFirewalls) +
              #### [getHardwareRouters](/reference/services/SoftLayer_Location_Datacenter/getHardwareRouters) +
              #### [getLocationAddress](/reference/services/SoftLayer_Location_Datacenter/getLocationAddress) Retrieve a location's physical address. +
              #### [getLocationAddresses](/reference/services/SoftLayer_Location_Datacenter/getLocationAddresses) Retrieve a location's physical addresses. +
              #### [getLocationReservationMember](/reference/services/SoftLayer_Location_Datacenter/getLocationReservationMember) Retrieve a location's Dedicated Rack member +
              #### [getLocationStatus](/reference/services/SoftLayer_Location_Datacenter/getLocationStatus) Retrieve the current locations status. +
              #### [getNetworkConfigurationAttribute](/reference/services/SoftLayer_Location_Datacenter/getNetworkConfigurationAttribute) +
              #### [getObject](/reference/services/SoftLayer_Location_Datacenter/getObject) Retrieve a SoftLayer_Location_Datacenter record. +
              #### [getOnlineSslVpnUserCount](/reference/services/SoftLayer_Location_Datacenter/getOnlineSslVpnUserCount) Retrieve the total number of users online using SoftLayer's SSL VPN service for a location. +
              #### [getPathString](/reference/services/SoftLayer_Location_Datacenter/getPathString) +
              #### [getPresaleEvents](/reference/services/SoftLayer_Location_Datacenter/getPresaleEvents) +
              #### [getPriceGroups](/reference/services/SoftLayer_Location_Datacenter/getPriceGroups) Retrieve a location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. +
              #### [getRegionalGroup](/reference/services/SoftLayer_Location_Datacenter/getRegionalGroup) Retrieve the regional group this datacenter belongs to. +
              #### [getRegionalInternetRegistry](/reference/services/SoftLayer_Location_Datacenter/getRegionalInternetRegistry) +
              #### [getRegions](/reference/services/SoftLayer_Location_Datacenter/getRegions) Retrieve a location can be a member of 1 or more regions. This will show which regions to which a location belongs. +
              #### [getRoutableBoundSubnets](/reference/services/SoftLayer_Location_Datacenter/getRoutableBoundSubnets) Retrieve retrieve all subnets that are eligible to be routed; those which the account has permission to associate with a vlan. +
              #### [getStatisticsGraphImage](/reference/services/SoftLayer_Location_Datacenter/getStatisticsGraphImage) Retrieve a graph of a SoftLayer datacenter's last 48 hours of network activity. +
              #### [getTimezone](/reference/services/SoftLayer_Location_Datacenter/getTimezone) +
              #### [getVdrGroup](/reference/services/SoftLayer_Location_Datacenter/getVdrGroup) Retrieve a location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs. +
              #### [getViewableDatacenters](/reference/services/SoftLayer_Location_Datacenter/getViewableDatacenters) Retrieve all datacenter locations +
              #### [getViewablePopsAndDataCenters](/reference/services/SoftLayer_Location_Datacenter/getViewablePopsAndDataCenters) Retrieve viewable pops and datacenters in a combined list. +
              #### [getViewablepointOfPresence](/reference/services/SoftLayer_Location_Datacenter/getViewablepointOfPresence) Retrieve viewable network locations +
              #### [getpointOfPresence](/reference/services/SoftLayer_Location_Datacenter/getpointOfPresence) Retrieve all points of presence locations +
              diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getActiveItemPresaleEvents.md b/content/reference/services/SoftLayer_Location_Datacenter/getActiveItemPresaleEvents.md index e8c8353ca0..b6a01341e0 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getActiveItemPresaleEvents.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getActiveItemPresaleEvents.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getActivePresaleEvents.md b/content/reference/services/SoftLayer_Location_Datacenter/getActivePresaleEvents.md index e88c285efb..b5d3dc9bd7 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getActivePresaleEvents.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getActivePresaleEvents.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getAvailableObjectStorageDatacenters.md b/content/reference/services/SoftLayer_Location_Datacenter/getAvailableObjectStorageDatacenters.md index 4e795c214a..3dcb034984 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getAvailableObjectStorageDatacenters.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getAvailableObjectStorageDatacenters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getAvailableObjectStorageDatacenters + Get the datacenters where object storage is available diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getBackboneDependents.md b/content/reference/services/SoftLayer_Location_Datacenter/getBackboneDependents.md index 2ebfba85e3..7ef5b9003b 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getBackboneDependents.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getBackboneDependents.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getBackendHardwareRouters.md b/content/reference/services/SoftLayer_Location_Datacenter/getBackendHardwareRouters.md index 635f12a707..609d80b441 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getBackendHardwareRouters.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getBackendHardwareRouters.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getBnppCompliantFlag.md b/content/reference/services/SoftLayer_Location_Datacenter/getBnppCompliantFlag.md index 5fcbe8c957..79a7aa2b5d 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getBnppCompliantFlag.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getBnppCompliantFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getBnppCompliantFlag + Retrieve a flag indicating whether or not the datacenter/location is BNPP compliant. diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getBoundSubnets.md b/content/reference/services/SoftLayer_Location_Datacenter/getBoundSubnets.md index bbd504c8b0..f755889301 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getBoundSubnets.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getBoundSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getBoundSubnets + Retrieve subnets which are directly bound to one or more routers in a given datacenter, and currently allow routing. diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getBrandCountryRestrictions.md b/content/reference/services/SoftLayer_Location_Datacenter/getBrandCountryRestrictions.md index 3409964ff2..70159f2613 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getBrandCountryRestrictions.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getBrandCountryRestrictions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getBrandCountryRestrictions + Retrieve this references 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 this brand for customers that live in Great Britain. diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getDatacenters.md b/content/reference/services/SoftLayer_Location_Datacenter/getDatacenters.md index 1300d2e92a..7758cf307f 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getDatacenters.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getDatacenters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getDatacenters + Retrieve all datacenter locations diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getDatacentersWithVirtualImageStoreServiceResourceRecord.md b/content/reference/services/SoftLayer_Location_Datacenter/getDatacentersWithVirtualImageStoreServiceResourceRecord.md index ea5152a70a..54528e0d2c 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getDatacentersWithVirtualImageStoreServiceResourceRecord.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getDatacentersWithVirtualImageStoreServiceResourceRecord.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getEuCompliantFlag.md b/content/reference/services/SoftLayer_Location_Datacenter/getEuCompliantFlag.md index 7343af9e2c..cda643557e 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getEuCompliantFlag.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getEuCompliantFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getEuCompliantFlag + Retrieve a flag indicating whether or not the datacenter/location is EU compliant. diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getFrontendHardwareRouters.md b/content/reference/services/SoftLayer_Location_Datacenter/getFrontendHardwareRouters.md index c85235831c..f1baff0262 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getFrontendHardwareRouters.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getFrontendHardwareRouters.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getGroups.md b/content/reference/services/SoftLayer_Location_Datacenter/getGroups.md index 9375562b0e..1587b50604 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getGroups.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getGroups + Retrieve a location can be a member of 1 or more groups. This will show which groups to which a location belongs. diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getHardwareFirewalls.md b/content/reference/services/SoftLayer_Location_Datacenter/getHardwareFirewalls.md index 724dad32a6..0ed4eaf31a 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getHardwareFirewalls.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getHardwareFirewalls.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getHardwareRouters.md b/content/reference/services/SoftLayer_Location_Datacenter/getHardwareRouters.md index 564701c80a..94b699b9c7 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getHardwareRouters.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getHardwareRouters.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getLocationAddress.md b/content/reference/services/SoftLayer_Location_Datacenter/getLocationAddress.md index 2242159ac4..c27e680a2b 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getLocationAddress.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getLocationAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getLocationAddress + Retrieve a location's physical address. diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getLocationAddresses.md b/content/reference/services/SoftLayer_Location_Datacenter/getLocationAddresses.md index 82358f84df..b84f18ab87 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getLocationAddresses.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getLocationAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getLocationAddresses + Retrieve a location's physical addresses. diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getLocationReservationMember.md b/content/reference/services/SoftLayer_Location_Datacenter/getLocationReservationMember.md index 38e0ca3e6d..f9fd4d80c5 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getLocationReservationMember.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getLocationReservationMember.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getLocationReservationMember + Retrieve a location's Dedicated Rack member diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getLocationStatus.md b/content/reference/services/SoftLayer_Location_Datacenter/getLocationStatus.md index c6c1e90c77..36f63f7197 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getLocationStatus.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getLocationStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getLocationStatus + Retrieve the current locations status. diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getNetworkConfigurationAttribute.md b/content/reference/services/SoftLayer_Location_Datacenter/getNetworkConfigurationAttribute.md index 37e13bbed0..c1c33ddf45 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getNetworkConfigurationAttribute.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getNetworkConfigurationAttribute.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getObject.md b/content/reference/services/SoftLayer_Location_Datacenter/getObject.md index 08cf35eae0..c7fa82fbda 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getObject.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getObject + Retrieve a SoftLayer_Location_Datacenter record. diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getOnlineSslVpnUserCount.md b/content/reference/services/SoftLayer_Location_Datacenter/getOnlineSslVpnUserCount.md index 759ac6f7a4..e096ce35c7 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getOnlineSslVpnUserCount.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getOnlineSslVpnUserCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getOnlineSslVpnUserCount + Retrieve the total number of users online using SoftLayer's SSL VPN service for a location. diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getPathString.md b/content/reference/services/SoftLayer_Location_Datacenter/getPathString.md index b419b3848a..2113b7d5fa 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getPathString.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getPathString.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getPresaleEvents.md b/content/reference/services/SoftLayer_Location_Datacenter/getPresaleEvents.md index 05d12509e2..e965cbfea2 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getPresaleEvents.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getPresaleEvents.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getPriceGroups.md b/content/reference/services/SoftLayer_Location_Datacenter/getPriceGroups.md index f12f6f3d90..efc77875fb 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getPriceGroups.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getPriceGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getPriceGroups + Retrieve a location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getRegionalGroup.md b/content/reference/services/SoftLayer_Location_Datacenter/getRegionalGroup.md index da2259f6db..370554fa29 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getRegionalGroup.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getRegionalGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getRegionalGroup + Retrieve the regional group this datacenter belongs to. diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getRegionalInternetRegistry.md b/content/reference/services/SoftLayer_Location_Datacenter/getRegionalInternetRegistry.md index cb4d0206d0..53d0b1ef81 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getRegionalInternetRegistry.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getRegionalInternetRegistry.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getRegions.md b/content/reference/services/SoftLayer_Location_Datacenter/getRegions.md index e8fdf669b1..be9907f88a 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getRegions.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getRegions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getRegions + Retrieve a location can be a member of 1 or more regions. This will show which regions to which a location belongs. diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getRoutableBoundSubnets.md b/content/reference/services/SoftLayer_Location_Datacenter/getRoutableBoundSubnets.md index d67418f1f0..4dfa8045bf 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getRoutableBoundSubnets.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getRoutableBoundSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getRoutableBoundSubnets + Retrieve retrieve all subnets that are eligible to be routed; those which the account has permission to associate with a vlan. diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getStatisticsGraphImage.md b/content/reference/services/SoftLayer_Location_Datacenter/getStatisticsGraphImage.md index d02cda4c49..836a52f14f 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getStatisticsGraphImage.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getStatisticsGraphImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getStatisticsGraphImage + Retrieve a graph of a SoftLayer datacenter's last 48 hours of network activity. diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getTimezone.md b/content/reference/services/SoftLayer_Location_Datacenter/getTimezone.md index a82f1b7d7d..4356c829ec 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getTimezone.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getTimezone.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getVdrGroup.md b/content/reference/services/SoftLayer_Location_Datacenter/getVdrGroup.md index 787b250020..c4adaccbe4 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getVdrGroup.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getVdrGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getVdrGroup + Retrieve a location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs. diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getViewableDatacenters.md b/content/reference/services/SoftLayer_Location_Datacenter/getViewableDatacenters.md index b88f3b8985..180bf09c76 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getViewableDatacenters.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getViewableDatacenters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getViewableDatacenters + Retrieve all datacenter locations diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getViewablePopsAndDataCenters.md b/content/reference/services/SoftLayer_Location_Datacenter/getViewablePopsAndDataCenters.md index 841a7e5920..1b711879ac 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getViewablePopsAndDataCenters.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getViewablePopsAndDataCenters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getViewablePopsAndDataCenters + Retrieve viewable pops and datacenters in a combined list. diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getViewablepointOfPresence.md b/content/reference/services/SoftLayer_Location_Datacenter/getViewablepointOfPresence.md index 056f044331..f29b588a46 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getViewablepointOfPresence.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getViewablepointOfPresence.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getViewablepointOfPresence + Retrieve viewable network locations diff --git a/content/reference/services/SoftLayer_Location_Datacenter/getpointOfPresence.md b/content/reference/services/SoftLayer_Location_Datacenter/getpointOfPresence.md index a48351751c..2ba2dc7948 100644 --- a/content/reference/services/SoftLayer_Location_Datacenter/getpointOfPresence.md +++ b/content/reference/services/SoftLayer_Location_Datacenter/getpointOfPresence.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Datacenter](/reference/services/SoftLayer_Location_Datacenter)::getpointOfPresence + Retrieve all points of presence locations diff --git a/content/reference/services/SoftLayer_Location_Group/_index.md b/content/reference/services/SoftLayer_Location_Group/_index.md index 071227bf77..3342e03768 100644 --- a/content/reference/services/SoftLayer_Location_Group/_index.md +++ b/content/reference/services/SoftLayer_Location_Group/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,24 +44,28 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Location_Group/getAllObjects) +
              #### [getLocationGroupType](/reference/services/SoftLayer_Location_Group/getLocationGroupType) Retrieve the type for this location group. +
              #### [getLocations](/reference/services/SoftLayer_Location_Group/getLocations) Retrieve the locations in a group. +
              #### [getObject](/reference/services/SoftLayer_Location_Group/getObject) Retrieve a SoftLayer_Location_Group record. +
              diff --git a/content/reference/services/SoftLayer_Location_Group/getAllObjects.md b/content/reference/services/SoftLayer_Location_Group/getAllObjects.md index 2ff6aed35d..78a997a74b 100644 --- a/content/reference/services/SoftLayer_Location_Group/getAllObjects.md +++ b/content/reference/services/SoftLayer_Location_Group/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location_Group/getLocationGroupType.md b/content/reference/services/SoftLayer_Location_Group/getLocationGroupType.md index 817d2fd2b6..6bcecda2ba 100644 --- a/content/reference/services/SoftLayer_Location_Group/getLocationGroupType.md +++ b/content/reference/services/SoftLayer_Location_Group/getLocationGroupType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Group](/reference/services/SoftLayer_Location_Group)::getLocationGroupType + Retrieve the type for this location group. diff --git a/content/reference/services/SoftLayer_Location_Group/getLocations.md b/content/reference/services/SoftLayer_Location_Group/getLocations.md index efee76b946..914a069537 100644 --- a/content/reference/services/SoftLayer_Location_Group/getLocations.md +++ b/content/reference/services/SoftLayer_Location_Group/getLocations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Group](/reference/services/SoftLayer_Location_Group)::getLocations + Retrieve the locations in a group. diff --git a/content/reference/services/SoftLayer_Location_Group/getObject.md b/content/reference/services/SoftLayer_Location_Group/getObject.md index 7aabf44f79..18e0533703 100644 --- a/content/reference/services/SoftLayer_Location_Group/getObject.md +++ b/content/reference/services/SoftLayer_Location_Group/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Group](/reference/services/SoftLayer_Location_Group)::getObject + Retrieve a SoftLayer_Location_Group record. diff --git a/content/reference/services/SoftLayer_Location_Group_Pricing/_index.md b/content/reference/services/SoftLayer_Location_Group_Pricing/_index.md index 592b8ea172..1473ae8e28 100644 --- a/content/reference/services/SoftLayer_Location_Group_Pricing/_index.md +++ b/content/reference/services/SoftLayer_Location_Group_Pricing/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A pricing location group relates a set of [SoftLayer_Product_Item_Price]({{}}). @@ -42,30 +44,35 @@ A pricing location group relates a set of [SoftLayer_Product_Item_Price]({{
              #### [getLocationGroupType](/reference/services/SoftLayer_Location_Group_Pricing/getLocationGroupType) Retrieve the type for this location group. +
              #### [getLocations](/reference/services/SoftLayer_Location_Group_Pricing/getLocations) Retrieve the locations that this pricing location group is applicable for. This limits the locations that the prices referenced by this pricing location group can be used with. +
              #### [getObject](/reference/services/SoftLayer_Location_Group_Pricing/getObject) Retrieve a SoftLayer_Location_Group_Pricing record. +
              #### [getPrices](/reference/services/SoftLayer_Location_Group_Pricing/getPrices) Retrieve the prices that this pricing location group limits. All of these prices will only be available in the locations defined by this pricing location group. +
              diff --git a/content/reference/services/SoftLayer_Location_Group_Pricing/getAllObjects.md b/content/reference/services/SoftLayer_Location_Group_Pricing/getAllObjects.md index 0726702e5a..6116d47a0b 100644 --- a/content/reference/services/SoftLayer_Location_Group_Pricing/getAllObjects.md +++ b/content/reference/services/SoftLayer_Location_Group_Pricing/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Group_Pricing](/reference/services/SoftLayer_Location_Group_Pricing)::getAllObjects + Get all pricing location groups. diff --git a/content/reference/services/SoftLayer_Location_Group_Pricing/getLocationGroupType.md b/content/reference/services/SoftLayer_Location_Group_Pricing/getLocationGroupType.md index c209658e93..05814d1f14 100644 --- a/content/reference/services/SoftLayer_Location_Group_Pricing/getLocationGroupType.md +++ b/content/reference/services/SoftLayer_Location_Group_Pricing/getLocationGroupType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Group_Pricing](/reference/services/SoftLayer_Location_Group_Pricing)::getLocationGroupType + Retrieve the type for this location group. diff --git a/content/reference/services/SoftLayer_Location_Group_Pricing/getLocations.md b/content/reference/services/SoftLayer_Location_Group_Pricing/getLocations.md index 400f6f9ab8..25c4f10748 100644 --- a/content/reference/services/SoftLayer_Location_Group_Pricing/getLocations.md +++ b/content/reference/services/SoftLayer_Location_Group_Pricing/getLocations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Group_Pricing](/reference/services/SoftLayer_Location_Group_Pricing)::getLocations + Retrieve the locations that this pricing location group is applicable for. This limits the locations that the prices referenced by this pricing location group can be used with. diff --git a/content/reference/services/SoftLayer_Location_Group_Pricing/getObject.md b/content/reference/services/SoftLayer_Location_Group_Pricing/getObject.md index eafc6834d9..faebbd85b9 100644 --- a/content/reference/services/SoftLayer_Location_Group_Pricing/getObject.md +++ b/content/reference/services/SoftLayer_Location_Group_Pricing/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Group_Pricing](/reference/services/SoftLayer_Location_Group_Pricing)::getObject + Retrieve a SoftLayer_Location_Group_Pricing record. diff --git a/content/reference/services/SoftLayer_Location_Group_Pricing/getPrices.md b/content/reference/services/SoftLayer_Location_Group_Pricing/getPrices.md index a44a21587d..5dfe3991bd 100644 --- a/content/reference/services/SoftLayer_Location_Group_Pricing/getPrices.md +++ b/content/reference/services/SoftLayer_Location_Group_Pricing/getPrices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Group_Pricing](/reference/services/SoftLayer_Location_Group_Pricing)::getPrices + Retrieve the prices that this pricing location group limits. All of these prices will only be available in the locations defined by this pricing location group. diff --git a/content/reference/services/SoftLayer_Location_Group_Regional/_index.md b/content/reference/services/SoftLayer_Location_Group_Regional/_index.md index 80bc7ce95a..78ffaa857e 100644 --- a/content/reference/services/SoftLayer_Location_Group_Regional/_index.md +++ b/content/reference/services/SoftLayer_Location_Group_Regional/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A regional location group is a collection of datacenters for a region. @@ -42,36 +44,42 @@ A regional location group is a collection of datacenters for a region. #### [getAllObjects](/reference/services/SoftLayer_Location_Group_Regional/getAllObjects) Get all regional groups. +
              #### [getDatacenters](/reference/services/SoftLayer_Location_Group_Regional/getDatacenters) Retrieve the datacenters in a group. +
              #### [getLocationGroupType](/reference/services/SoftLayer_Location_Group_Regional/getLocationGroupType) Retrieve the type for this location group. +
              #### [getLocations](/reference/services/SoftLayer_Location_Group_Regional/getLocations) Retrieve the locations in a group. +
              #### [getObject](/reference/services/SoftLayer_Location_Group_Regional/getObject) Retrieve a SoftLayer_Location_Group_Regional record. +
              #### [getPreferredDatacenter](/reference/services/SoftLayer_Location_Group_Regional/getPreferredDatacenter) Retrieve the preferred datacenters of a group. +
              diff --git a/content/reference/services/SoftLayer_Location_Group_Regional/getAllObjects.md b/content/reference/services/SoftLayer_Location_Group_Regional/getAllObjects.md index 6dda6866ea..07abd81fa7 100644 --- a/content/reference/services/SoftLayer_Location_Group_Regional/getAllObjects.md +++ b/content/reference/services/SoftLayer_Location_Group_Regional/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Group_Regional](/reference/services/SoftLayer_Location_Group_Regional)::getAllObjects + Get all regional groups. diff --git a/content/reference/services/SoftLayer_Location_Group_Regional/getDatacenters.md b/content/reference/services/SoftLayer_Location_Group_Regional/getDatacenters.md index 2e7c03df82..efe45b9fa2 100644 --- a/content/reference/services/SoftLayer_Location_Group_Regional/getDatacenters.md +++ b/content/reference/services/SoftLayer_Location_Group_Regional/getDatacenters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Group_Regional](/reference/services/SoftLayer_Location_Group_Regional)::getDatacenters + Retrieve the datacenters in a group. diff --git a/content/reference/services/SoftLayer_Location_Group_Regional/getLocationGroupType.md b/content/reference/services/SoftLayer_Location_Group_Regional/getLocationGroupType.md index efd445b211..162500f6a3 100644 --- a/content/reference/services/SoftLayer_Location_Group_Regional/getLocationGroupType.md +++ b/content/reference/services/SoftLayer_Location_Group_Regional/getLocationGroupType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Group_Regional](/reference/services/SoftLayer_Location_Group_Regional)::getLocationGroupType + Retrieve the type for this location group. diff --git a/content/reference/services/SoftLayer_Location_Group_Regional/getLocations.md b/content/reference/services/SoftLayer_Location_Group_Regional/getLocations.md index a96a0d63bf..4a0c95a244 100644 --- a/content/reference/services/SoftLayer_Location_Group_Regional/getLocations.md +++ b/content/reference/services/SoftLayer_Location_Group_Regional/getLocations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Group_Regional](/reference/services/SoftLayer_Location_Group_Regional)::getLocations + Retrieve the locations in a group. diff --git a/content/reference/services/SoftLayer_Location_Group_Regional/getObject.md b/content/reference/services/SoftLayer_Location_Group_Regional/getObject.md index aa1a0e3d4f..8926e28d00 100644 --- a/content/reference/services/SoftLayer_Location_Group_Regional/getObject.md +++ b/content/reference/services/SoftLayer_Location_Group_Regional/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Group_Regional](/reference/services/SoftLayer_Location_Group_Regional)::getObject + Retrieve a SoftLayer_Location_Group_Regional record. diff --git a/content/reference/services/SoftLayer_Location_Group_Regional/getPreferredDatacenter.md b/content/reference/services/SoftLayer_Location_Group_Regional/getPreferredDatacenter.md index 6929dac127..4e4d18d719 100644 --- a/content/reference/services/SoftLayer_Location_Group_Regional/getPreferredDatacenter.md +++ b/content/reference/services/SoftLayer_Location_Group_Regional/getPreferredDatacenter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Group_Regional](/reference/services/SoftLayer_Location_Group_Regional)::getPreferredDatacenter + Retrieve the preferred datacenters of a group. diff --git a/content/reference/services/SoftLayer_Location_Reservation/_index.md b/content/reference/services/SoftLayer_Location_Reservation/_index.md index 72f5fcad51..d96e034fe9 100644 --- a/content/reference/services/SoftLayer_Location_Reservation/_index.md +++ b/content/reference/services/SoftLayer_Location_Reservation/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,42 +44,49 @@ classes: #### [getAccount](/reference/services/SoftLayer_Location_Reservation/getAccount) Retrieve the account that a billing item belongs to. +
              #### [getAccountReservations](/reference/services/SoftLayer_Location_Reservation/getAccountReservations) +
              #### [getAllotment](/reference/services/SoftLayer_Location_Reservation/getAllotment) Retrieve the bandwidth allotment that the reservation belongs to. +
              #### [getBillingItem](/reference/services/SoftLayer_Location_Reservation/getBillingItem) Retrieve the bandwidth allotment that the reservation belongs to. +
              #### [getLocation](/reference/services/SoftLayer_Location_Reservation/getLocation) Retrieve the datacenter location that the reservation belongs to. +
              #### [getLocationReservationRack](/reference/services/SoftLayer_Location_Reservation/getLocationReservationRack) Retrieve rack information for the reservation +
              #### [getObject](/reference/services/SoftLayer_Location_Reservation/getObject) Retrieve a SoftLayer_Location_Reservation record. +
              diff --git a/content/reference/services/SoftLayer_Location_Reservation/getAccount.md b/content/reference/services/SoftLayer_Location_Reservation/getAccount.md index 0fe14b8396..baedae440e 100644 --- a/content/reference/services/SoftLayer_Location_Reservation/getAccount.md +++ b/content/reference/services/SoftLayer_Location_Reservation/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Reservation](/reference/services/SoftLayer_Location_Reservation)::getAccount + Retrieve the account that a billing item belongs to. diff --git a/content/reference/services/SoftLayer_Location_Reservation/getAccountReservations.md b/content/reference/services/SoftLayer_Location_Reservation/getAccountReservations.md index e8a2ba370b..0fa71bb94e 100644 --- a/content/reference/services/SoftLayer_Location_Reservation/getAccountReservations.md +++ b/content/reference/services/SoftLayer_Location_Reservation/getAccountReservations.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location_Reservation/getAllotment.md b/content/reference/services/SoftLayer_Location_Reservation/getAllotment.md index 23b533f119..67197b287a 100644 --- a/content/reference/services/SoftLayer_Location_Reservation/getAllotment.md +++ b/content/reference/services/SoftLayer_Location_Reservation/getAllotment.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Reservation](/reference/services/SoftLayer_Location_Reservation)::getAllotment + Retrieve the bandwidth allotment that the reservation belongs to. diff --git a/content/reference/services/SoftLayer_Location_Reservation/getBillingItem.md b/content/reference/services/SoftLayer_Location_Reservation/getBillingItem.md index 462bd8967d..cfc25d1ae5 100644 --- a/content/reference/services/SoftLayer_Location_Reservation/getBillingItem.md +++ b/content/reference/services/SoftLayer_Location_Reservation/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Reservation](/reference/services/SoftLayer_Location_Reservation)::getBillingItem + Retrieve the bandwidth allotment that the reservation belongs to. diff --git a/content/reference/services/SoftLayer_Location_Reservation/getLocation.md b/content/reference/services/SoftLayer_Location_Reservation/getLocation.md index a7d2ac5b9f..d12977bad6 100644 --- a/content/reference/services/SoftLayer_Location_Reservation/getLocation.md +++ b/content/reference/services/SoftLayer_Location_Reservation/getLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Reservation](/reference/services/SoftLayer_Location_Reservation)::getLocation + Retrieve the datacenter location that the reservation belongs to. diff --git a/content/reference/services/SoftLayer_Location_Reservation/getLocationReservationRack.md b/content/reference/services/SoftLayer_Location_Reservation/getLocationReservationRack.md index 023304471b..3812d70adb 100644 --- a/content/reference/services/SoftLayer_Location_Reservation/getLocationReservationRack.md +++ b/content/reference/services/SoftLayer_Location_Reservation/getLocationReservationRack.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Reservation](/reference/services/SoftLayer_Location_Reservation)::getLocationReservationRack + Retrieve rack information for the reservation diff --git a/content/reference/services/SoftLayer_Location_Reservation/getObject.md b/content/reference/services/SoftLayer_Location_Reservation/getObject.md index f3f10dfcfc..c77fb16a53 100644 --- a/content/reference/services/SoftLayer_Location_Reservation/getObject.md +++ b/content/reference/services/SoftLayer_Location_Reservation/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Reservation](/reference/services/SoftLayer_Location_Reservation)::getObject + Retrieve a SoftLayer_Location_Reservation record. diff --git a/content/reference/services/SoftLayer_Location_Reservation_Rack/_index.md b/content/reference/services/SoftLayer_Location_Reservation_Rack/_index.md index 295fdf760c..e682cc54d2 100644 --- a/content/reference/services/SoftLayer_Location_Reservation_Rack/_index.md +++ b/content/reference/services/SoftLayer_Location_Reservation_Rack/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,30 +44,35 @@ classes: #### [getAllotment](/reference/services/SoftLayer_Location_Reservation_Rack/getAllotment) Retrieve the bandwidth allotment that the reservation belongs to. +
              #### [getChildren](/reference/services/SoftLayer_Location_Reservation_Rack/getChildren) Retrieve members of the rack. +
              #### [getLocation](/reference/services/SoftLayer_Location_Reservation_Rack/getLocation) +
              #### [getLocationReservation](/reference/services/SoftLayer_Location_Reservation_Rack/getLocationReservation) +
              #### [getObject](/reference/services/SoftLayer_Location_Reservation_Rack/getObject) Retrieve a SoftLayer_Location_Reservation_Rack record. +
              diff --git a/content/reference/services/SoftLayer_Location_Reservation_Rack/getAllotment.md b/content/reference/services/SoftLayer_Location_Reservation_Rack/getAllotment.md index e449d0b8a7..c2a27ac284 100644 --- a/content/reference/services/SoftLayer_Location_Reservation_Rack/getAllotment.md +++ b/content/reference/services/SoftLayer_Location_Reservation_Rack/getAllotment.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Reservation_Rack](/reference/services/SoftLayer_Location_Reservation_Rack)::getAllotment + Retrieve the bandwidth allotment that the reservation belongs to. diff --git a/content/reference/services/SoftLayer_Location_Reservation_Rack/getChildren.md b/content/reference/services/SoftLayer_Location_Reservation_Rack/getChildren.md index 5e6b82b253..e45818e9fa 100644 --- a/content/reference/services/SoftLayer_Location_Reservation_Rack/getChildren.md +++ b/content/reference/services/SoftLayer_Location_Reservation_Rack/getChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Reservation_Rack](/reference/services/SoftLayer_Location_Reservation_Rack)::getChildren + Retrieve members of the rack. diff --git a/content/reference/services/SoftLayer_Location_Reservation_Rack/getLocation.md b/content/reference/services/SoftLayer_Location_Reservation_Rack/getLocation.md index ac2629246c..fa3e37d0e6 100644 --- a/content/reference/services/SoftLayer_Location_Reservation_Rack/getLocation.md +++ b/content/reference/services/SoftLayer_Location_Reservation_Rack/getLocation.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location_Reservation_Rack/getLocationReservation.md b/content/reference/services/SoftLayer_Location_Reservation_Rack/getLocationReservation.md index 0f13dd4781..b3c3fdc9b6 100644 --- a/content/reference/services/SoftLayer_Location_Reservation_Rack/getLocationReservation.md +++ b/content/reference/services/SoftLayer_Location_Reservation_Rack/getLocationReservation.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location_Reservation_Rack/getObject.md b/content/reference/services/SoftLayer_Location_Reservation_Rack/getObject.md index ede98f25f8..8cd569aaae 100644 --- a/content/reference/services/SoftLayer_Location_Reservation_Rack/getObject.md +++ b/content/reference/services/SoftLayer_Location_Reservation_Rack/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Reservation_Rack](/reference/services/SoftLayer_Location_Reservation_Rack)::getObject + Retrieve a SoftLayer_Location_Reservation_Rack record. diff --git a/content/reference/services/SoftLayer_Location_Reservation_Rack_Member/_index.md b/content/reference/services/SoftLayer_Location_Reservation_Rack_Member/_index.md index 15acb94aaf..45a335e61a 100644 --- a/content/reference/services/SoftLayer_Location_Reservation_Rack_Member/_index.md +++ b/content/reference/services/SoftLayer_Location_Reservation_Rack_Member/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,18 +44,21 @@ classes: #### [getLocation](/reference/services/SoftLayer_Location_Reservation_Rack_Member/getLocation) Retrieve location relation for the rack member +
              #### [getLocationReservationRack](/reference/services/SoftLayer_Location_Reservation_Rack_Member/getLocationReservationRack) +
              #### [getObject](/reference/services/SoftLayer_Location_Reservation_Rack_Member/getObject) Retrieve a SoftLayer_Location_Reservation_Rack_Member record. +
              diff --git a/content/reference/services/SoftLayer_Location_Reservation_Rack_Member/getLocation.md b/content/reference/services/SoftLayer_Location_Reservation_Rack_Member/getLocation.md index 32e2ed378b..5d03fa48ef 100644 --- a/content/reference/services/SoftLayer_Location_Reservation_Rack_Member/getLocation.md +++ b/content/reference/services/SoftLayer_Location_Reservation_Rack_Member/getLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Reservation_Rack_Member](/reference/services/SoftLayer_Location_Reservation_Rack_Member)::getLocation + Retrieve location relation for the rack member diff --git a/content/reference/services/SoftLayer_Location_Reservation_Rack_Member/getLocationReservationRack.md b/content/reference/services/SoftLayer_Location_Reservation_Rack_Member/getLocationReservationRack.md index ce236e9223..a725b3d3d4 100644 --- a/content/reference/services/SoftLayer_Location_Reservation_Rack_Member/getLocationReservationRack.md +++ b/content/reference/services/SoftLayer_Location_Reservation_Rack_Member/getLocationReservationRack.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Location_Reservation_Rack_Member/getObject.md b/content/reference/services/SoftLayer_Location_Reservation_Rack_Member/getObject.md index d6bd4c01cf..0449743a85 100644 --- a/content/reference/services/SoftLayer_Location_Reservation_Rack_Member/getObject.md +++ b/content/reference/services/SoftLayer_Location_Reservation_Rack_Member/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Location_Reservation_Rack_Member](/reference/services/SoftLayer_Location_Reservation_Rack_Member)::getObject + Retrieve a SoftLayer_Location_Reservation_Rack_Member record. diff --git a/content/reference/services/SoftLayer_Marketplace_Partner/_index.md b/content/reference/services/SoftLayer_Marketplace_Partner/_index.md index d267275a96..2022ab71a7 100644 --- a/content/reference/services/SoftLayer_Marketplace_Partner/_index.md +++ b/content/reference/services/SoftLayer_Marketplace_Partner/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,66 +44,77 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Marketplace_Partner/getAllObjects) +
              #### [getAllPublishedPartners](/reference/services/SoftLayer_Marketplace_Partner/getAllPublishedPartners) +
              #### [getAttachments](/reference/services/SoftLayer_Marketplace_Partner/getAttachments) +
              #### [getFeaturedPartners](/reference/services/SoftLayer_Marketplace_Partner/getFeaturedPartners) +
              #### [getFile](/reference/services/SoftLayer_Marketplace_Partner/getFile) +
              #### [getLogoMedium](/reference/services/SoftLayer_Marketplace_Partner/getLogoMedium) +
              #### [getLogoMediumTemp](/reference/services/SoftLayer_Marketplace_Partner/getLogoMediumTemp) +
              #### [getLogoSmall](/reference/services/SoftLayer_Marketplace_Partner/getLogoSmall) +
              #### [getLogoSmallTemp](/reference/services/SoftLayer_Marketplace_Partner/getLogoSmallTemp) +
              #### [getObject](/reference/services/SoftLayer_Marketplace_Partner/getObject) Retrieve a SoftLayer_Marketplace_Partner record. +
              #### [getPartnerByUrlIdentifier](/reference/services/SoftLayer_Marketplace_Partner/getPartnerByUrlIdentifier) +
              diff --git a/content/reference/services/SoftLayer_Marketplace_Partner/getAllObjects.md b/content/reference/services/SoftLayer_Marketplace_Partner/getAllObjects.md index e828eca4df..9e976e5945 100644 --- a/content/reference/services/SoftLayer_Marketplace_Partner/getAllObjects.md +++ b/content/reference/services/SoftLayer_Marketplace_Partner/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Marketplace_Partner/getAllPublishedPartners.md b/content/reference/services/SoftLayer_Marketplace_Partner/getAllPublishedPartners.md index 0acbf0720c..4b7edad2e5 100644 --- a/content/reference/services/SoftLayer_Marketplace_Partner/getAllPublishedPartners.md +++ b/content/reference/services/SoftLayer_Marketplace_Partner/getAllPublishedPartners.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Marketplace_Partner/getAttachments.md b/content/reference/services/SoftLayer_Marketplace_Partner/getAttachments.md index d0950ed43c..ea66bd57ce 100644 --- a/content/reference/services/SoftLayer_Marketplace_Partner/getAttachments.md +++ b/content/reference/services/SoftLayer_Marketplace_Partner/getAttachments.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Marketplace_Partner/getFeaturedPartners.md b/content/reference/services/SoftLayer_Marketplace_Partner/getFeaturedPartners.md index 340e2fd09c..237d0c52c6 100644 --- a/content/reference/services/SoftLayer_Marketplace_Partner/getFeaturedPartners.md +++ b/content/reference/services/SoftLayer_Marketplace_Partner/getFeaturedPartners.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Marketplace_Partner/getFile.md b/content/reference/services/SoftLayer_Marketplace_Partner/getFile.md index c5ae013658..2ed0c04ea6 100644 --- a/content/reference/services/SoftLayer_Marketplace_Partner/getFile.md +++ b/content/reference/services/SoftLayer_Marketplace_Partner/getFile.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Marketplace_Partner/getLogoMedium.md b/content/reference/services/SoftLayer_Marketplace_Partner/getLogoMedium.md index afc35c46f5..e9ab2a0fb3 100644 --- a/content/reference/services/SoftLayer_Marketplace_Partner/getLogoMedium.md +++ b/content/reference/services/SoftLayer_Marketplace_Partner/getLogoMedium.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Marketplace_Partner/getLogoMediumTemp.md b/content/reference/services/SoftLayer_Marketplace_Partner/getLogoMediumTemp.md index bcb535d0c2..a0e3888f45 100644 --- a/content/reference/services/SoftLayer_Marketplace_Partner/getLogoMediumTemp.md +++ b/content/reference/services/SoftLayer_Marketplace_Partner/getLogoMediumTemp.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Marketplace_Partner/getLogoSmall.md b/content/reference/services/SoftLayer_Marketplace_Partner/getLogoSmall.md index 0098fe44b5..1ba2ac96ef 100644 --- a/content/reference/services/SoftLayer_Marketplace_Partner/getLogoSmall.md +++ b/content/reference/services/SoftLayer_Marketplace_Partner/getLogoSmall.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Marketplace_Partner/getLogoSmallTemp.md b/content/reference/services/SoftLayer_Marketplace_Partner/getLogoSmallTemp.md index d56d6e2ceb..f1e69f7121 100644 --- a/content/reference/services/SoftLayer_Marketplace_Partner/getLogoSmallTemp.md +++ b/content/reference/services/SoftLayer_Marketplace_Partner/getLogoSmallTemp.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Marketplace_Partner/getObject.md b/content/reference/services/SoftLayer_Marketplace_Partner/getObject.md index ad6cab18b7..bf9d48092b 100644 --- a/content/reference/services/SoftLayer_Marketplace_Partner/getObject.md +++ b/content/reference/services/SoftLayer_Marketplace_Partner/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Marketplace_Partner](/reference/services/SoftLayer_Marketplace_Partner)::getObject + Retrieve a SoftLayer_Marketplace_Partner record. diff --git a/content/reference/services/SoftLayer_Marketplace_Partner/getPartnerByUrlIdentifier.md b/content/reference/services/SoftLayer_Marketplace_Partner/getPartnerByUrlIdentifier.md index 8bfa2bca11..b0b9d9c7db 100644 --- a/content/reference/services/SoftLayer_Marketplace_Partner/getPartnerByUrlIdentifier.md +++ b/content/reference/services/SoftLayer_Marketplace_Partner/getPartnerByUrlIdentifier.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object/_index.md b/content/reference/services/SoftLayer_Metric_Tracking_Object/_index.md index 4794ef3c7a..db06b29109 100644 --- a/content/reference/services/SoftLayer_Metric_Tracking_Object/_index.md +++ b/content/reference/services/SoftLayer_Metric_Tracking_Object/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -45,76 +47,91 @@ The SoftLayer_Metric_Tracking_Object service contains methods that allow users t
              -
              +
              #### [getBackboneBandwidthGraph](/reference/services/SoftLayer_Metric_Tracking_Object/getBackboneBandwidthGraph) [DEPRECATED] Retrieve a graph of a SoftLayer backbone's recent traffic activity. + +Deprecated + +
              #### [getBandwidthData](/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthData) Retrieve raw bandwidth data from a tracking object. +
              #### [getBandwidthGraph](/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthGraph) Retrieve a bandwidth graph. +
              #### [getBandwidthTotal](/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthTotal) Retrieve the total bandwidth used within a given time frame. +
              #### [getCustomGraphData](/reference/services/SoftLayer_Metric_Tracking_Object/getCustomGraphData) Fetch metric data using the graph container class. +
              #### [getDetailsForDateRange](/reference/services/SoftLayer_Metric_Tracking_Object/getDetailsForDateRange) Retrieve metric detail data over a date range. +
              #### [getGraph](/reference/services/SoftLayer_Metric_Tracking_Object/getGraph) Retrieve a graph of a virtual hosting platform's per instance use. +
              #### [getMetricDataTypes](/reference/services/SoftLayer_Metric_Tracking_Object/getMetricDataTypes) Returns valid metric data types for a tracking object +
              #### [getObject](/reference/services/SoftLayer_Metric_Tracking_Object/getObject) Retrieve a SoftLayer_Metric_Tracking_Object record. +
              #### [getSummary](/reference/services/SoftLayer_Metric_Tracking_Object/getSummary) Retrieve metric summary. +
              #### [getSummaryData](/reference/services/SoftLayer_Metric_Tracking_Object/getSummaryData) Returns the metric data for the date range provided +
              #### [getType](/reference/services/SoftLayer_Metric_Tracking_Object/getType) Retrieve the type of data that a tracking object polls. +
              diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object/getBackboneBandwidthGraph.md b/content/reference/services/SoftLayer_Metric_Tracking_Object/getBackboneBandwidthGraph.md index 02a843d98b..1d8ff43c1b 100644 --- a/content/reference/services/SoftLayer_Metric_Tracking_Object/getBackboneBandwidthGraph.md +++ b/content/reference/services/SoftLayer_Metric_Tracking_Object/getBackboneBandwidthGraph.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Metric_Tracking_Object](/reference/services/SoftLayer_Metric_Tracking_Object)::getBackboneBandwidthGraph +
              Deprecated
              + [DEPRECATED] Retrieve a graph of a SoftLayer backbone's recent traffic activity. diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthData.md b/content/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthData.md index a40ff5bd90..41e53e1d5f 100644 --- a/content/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthData.md +++ b/content/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Metric_Tracking_Object](/reference/services/SoftLayer_Metric_Tracking_Object)::getBandwidthData + Retrieve raw bandwidth data from a tracking object. diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthGraph.md b/content/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthGraph.md index ef17ffb7c7..0fd4480433 100644 --- a/content/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthGraph.md +++ b/content/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthGraph.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Metric_Tracking_Object](/reference/services/SoftLayer_Metric_Tracking_Object)::getBandwidthGraph + Retrieve a bandwidth graph. diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthTotal.md b/content/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthTotal.md index 0cdd900059..2a402080a7 100644 --- a/content/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthTotal.md +++ b/content/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthTotal.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Metric_Tracking_Object](/reference/services/SoftLayer_Metric_Tracking_Object)::getBandwidthTotal + Retrieve the total bandwidth used within a given time frame. diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object/getCustomGraphData.md b/content/reference/services/SoftLayer_Metric_Tracking_Object/getCustomGraphData.md index c7af14e9ce..b078d67cdb 100644 --- a/content/reference/services/SoftLayer_Metric_Tracking_Object/getCustomGraphData.md +++ b/content/reference/services/SoftLayer_Metric_Tracking_Object/getCustomGraphData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Metric_Tracking_Object](/reference/services/SoftLayer_Metric_Tracking_Object)::getCustomGraphData + Fetch metric data using the graph container class. diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object/getDetailsForDateRange.md b/content/reference/services/SoftLayer_Metric_Tracking_Object/getDetailsForDateRange.md index 0052f4c5bd..94b600ef0a 100644 --- a/content/reference/services/SoftLayer_Metric_Tracking_Object/getDetailsForDateRange.md +++ b/content/reference/services/SoftLayer_Metric_Tracking_Object/getDetailsForDateRange.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Metric_Tracking_Object](/reference/services/SoftLayer_Metric_Tracking_Object)::getDetailsForDateRange + Retrieve metric detail data over a date range. diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object/getGraph.md b/content/reference/services/SoftLayer_Metric_Tracking_Object/getGraph.md index e5df180619..82f2fe71fe 100644 --- a/content/reference/services/SoftLayer_Metric_Tracking_Object/getGraph.md +++ b/content/reference/services/SoftLayer_Metric_Tracking_Object/getGraph.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Metric_Tracking_Object](/reference/services/SoftLayer_Metric_Tracking_Object)::getGraph + Retrieve a graph of a virtual hosting platform's per instance use. diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object/getMetricDataTypes.md b/content/reference/services/SoftLayer_Metric_Tracking_Object/getMetricDataTypes.md index dc72e6ab8d..d0b3b02664 100644 --- a/content/reference/services/SoftLayer_Metric_Tracking_Object/getMetricDataTypes.md +++ b/content/reference/services/SoftLayer_Metric_Tracking_Object/getMetricDataTypes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Metric_Tracking_Object](/reference/services/SoftLayer_Metric_Tracking_Object)::getMetricDataTypes + Returns valid metric data types for a tracking object diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object/getObject.md b/content/reference/services/SoftLayer_Metric_Tracking_Object/getObject.md index 090253f5a6..a11c42ab72 100644 --- a/content/reference/services/SoftLayer_Metric_Tracking_Object/getObject.md +++ b/content/reference/services/SoftLayer_Metric_Tracking_Object/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Metric_Tracking_Object](/reference/services/SoftLayer_Metric_Tracking_Object)::getObject + Retrieve a SoftLayer_Metric_Tracking_Object record. diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object/getSummary.md b/content/reference/services/SoftLayer_Metric_Tracking_Object/getSummary.md index 41d4b6eed4..7cbcc79086 100644 --- a/content/reference/services/SoftLayer_Metric_Tracking_Object/getSummary.md +++ b/content/reference/services/SoftLayer_Metric_Tracking_Object/getSummary.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Metric_Tracking_Object](/reference/services/SoftLayer_Metric_Tracking_Object)::getSummary + Retrieve metric summary. diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object/getSummaryData.md b/content/reference/services/SoftLayer_Metric_Tracking_Object/getSummaryData.md index c397ed28c5..e139a34d1c 100644 --- a/content/reference/services/SoftLayer_Metric_Tracking_Object/getSummaryData.md +++ b/content/reference/services/SoftLayer_Metric_Tracking_Object/getSummaryData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Metric_Tracking_Object](/reference/services/SoftLayer_Metric_Tracking_Object)::getSummaryData + Returns the metric data for the date range provided diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object/getType.md b/content/reference/services/SoftLayer_Metric_Tracking_Object/getType.md index 9ab9111037..24d43facc5 100644 --- a/content/reference/services/SoftLayer_Metric_Tracking_Object/getType.md +++ b/content/reference/services/SoftLayer_Metric_Tracking_Object/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Metric_Tracking_Object](/reference/services/SoftLayer_Metric_Tracking_Object)::getType + Retrieve the type of data that a tracking object polls. diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary/_index.md b/content/reference/services/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary/_index.md index 125d728471..73d449f676 100644 --- a/content/reference/services/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary/_index.md +++ b/content/reference/services/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,6 +44,7 @@ classes: #### [getObject](/reference/services/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary/getObject) Retrieve a SoftLayer_Metric_Tracking_Object_Bandwidth_Summary record. +
              diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary/getObject.md b/content/reference/services/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary/getObject.md index ba72a6ec3f..79a98472e8 100644 --- a/content/reference/services/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary/getObject.md +++ b/content/reference/services/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Metric_Tracking_Object_Bandwidth_Summary](/reference/services/SoftLayer_Metric_Tracking_Object_Bandwidth_Summary)::getObject + Retrieve a SoftLayer_Metric_Tracking_Object_Bandwidth_Summary record. diff --git a/content/reference/services/SoftLayer_Monitoring_Robot/_index.md b/content/reference/services/SoftLayer_Monitoring_Robot/_index.md index c4b7cc1f4a..733bf6dad4 100644 --- a/content/reference/services/SoftLayer_Monitoring_Robot/_index.md +++ b/content/reference/services/SoftLayer_Monitoring_Robot/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + DEPRECATED. @@ -38,16 +40,21 @@ DEPRECATED.
              -
              +
              #### [checkConnection](/reference/services/SoftLayer_Monitoring_Robot/checkConnection) DEPRECATED. Checks if a monitoring robot can communicate with SoftLayer monitoring management system + +Deprecated + +
              #### [getObject](/reference/services/SoftLayer_Monitoring_Robot/getObject) Retrieve a SoftLayer_Monitoring_Robot record. +
              diff --git a/content/reference/services/SoftLayer_Monitoring_Robot/checkConnection.md b/content/reference/services/SoftLayer_Monitoring_Robot/checkConnection.md index 90f13b1731..dfea2ff0cd 100644 --- a/content/reference/services/SoftLayer_Monitoring_Robot/checkConnection.md +++ b/content/reference/services/SoftLayer_Monitoring_Robot/checkConnection.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Monitoring_Robot](/reference/services/SoftLayer_Monitoring_Robot)::checkConnection +
              Deprecated
              + DEPRECATED. Checks if a monitoring robot can communicate with SoftLayer monitoring management system diff --git a/content/reference/services/SoftLayer_Monitoring_Robot/getObject.md b/content/reference/services/SoftLayer_Monitoring_Robot/getObject.md index 29a5008880..b3d90dc184 100644 --- a/content/reference/services/SoftLayer_Monitoring_Robot/getObject.md +++ b/content/reference/services/SoftLayer_Monitoring_Robot/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Monitoring_Robot](/reference/services/SoftLayer_Monitoring_Robot)::getObject + Retrieve a SoftLayer_Monitoring_Robot record. diff --git a/content/reference/services/SoftLayer_Network/_index.md b/content/reference/services/SoftLayer_Network/_index.md index e501006058..a2c74493be 100644 --- a/content/reference/services/SoftLayer_Network/_index.md +++ b/content/reference/services/SoftLayer_Network/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + Provides services oriented to network-centric discovery and manipulation. @@ -42,24 +44,28 @@ Provides services oriented to network-centric discovery and manipulation. #### [connectPrivateEndpointService](/reference/services/SoftLayer_Network/connectPrivateEndpointService) Establishes a connection between the account and Service Endpoint networks. +
              #### [disconnectPrivateEndpointService](/reference/services/SoftLayer_Network/disconnectPrivateEndpointService) Terminates the connection between the account and Service Endpoint networks. +
              #### [getObject](/reference/services/SoftLayer_Network/getObject) Retrieve a SoftLayer_Network record. +
              #### [isConnectedToPrivateEndpointService](/reference/services/SoftLayer_Network/isConnectedToPrivateEndpointService) Checks the current Service Endpoint network connection status. +
              diff --git a/content/reference/services/SoftLayer_Network/connectPrivateEndpointService.md b/content/reference/services/SoftLayer_Network/connectPrivateEndpointService.md index 61c99a4437..824164cb02 100644 --- a/content/reference/services/SoftLayer_Network/connectPrivateEndpointService.md +++ b/content/reference/services/SoftLayer_Network/connectPrivateEndpointService.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network](/reference/services/SoftLayer_Network)::connectPrivateEndpointService + Establishes a connection between the account and Service Endpoint networks. diff --git a/content/reference/services/SoftLayer_Network/disconnectPrivateEndpointService.md b/content/reference/services/SoftLayer_Network/disconnectPrivateEndpointService.md index c68a56c3b6..cef7536e47 100644 --- a/content/reference/services/SoftLayer_Network/disconnectPrivateEndpointService.md +++ b/content/reference/services/SoftLayer_Network/disconnectPrivateEndpointService.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network](/reference/services/SoftLayer_Network)::disconnectPrivateEndpointService + Terminates the connection between the account and Service Endpoint networks. diff --git a/content/reference/services/SoftLayer_Network/getObject.md b/content/reference/services/SoftLayer_Network/getObject.md index 562541b5a5..0134007dab 100644 --- a/content/reference/services/SoftLayer_Network/getObject.md +++ b/content/reference/services/SoftLayer_Network/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network](/reference/services/SoftLayer_Network)::getObject + Retrieve a SoftLayer_Network record. diff --git a/content/reference/services/SoftLayer_Network/isConnectedToPrivateEndpointService.md b/content/reference/services/SoftLayer_Network/isConnectedToPrivateEndpointService.md index b76e718ea1..faba9e55d0 100644 --- a/content/reference/services/SoftLayer_Network/isConnectedToPrivateEndpointService.md +++ b/content/reference/services/SoftLayer_Network/isConnectedToPrivateEndpointService.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network](/reference/services/SoftLayer_Network)::isConnectedToPrivateEndpointService + Checks the current Service Endpoint network connection status. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/_index.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/_index.md index db3696e96d..82e20381c5 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/_index.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) 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. @@ -44,204 +46,238 @@ Application delivery controllers support an "advanced" configuration scheme, ena #### [createLiveLoadBalancer](/reference/services/SoftLayer_Network_Application_Delivery_Controller/createLiveLoadBalancer) Add to or create load balancer service from a virtual IP address +
              #### [deleteLiveLoadBalancer](/reference/services/SoftLayer_Network_Application_Delivery_Controller/deleteLiveLoadBalancer) Remove a virtual IP address from a load balancer +
              #### [deleteLiveLoadBalancerService](/reference/services/SoftLayer_Network_Application_Delivery_Controller/deleteLiveLoadBalancerService) Remove load balancer service +
              #### [editObject](/reference/services/SoftLayer_Network_Application_Delivery_Controller/editObject) Edit an application delivery controller record +
              #### [getAccount](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getAccount) Retrieve the SoftLayer customer account that owns an application delivery controller record. +
              #### [getAverageDailyPublicBandwidthUsage](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getAverageDailyPublicBandwidthUsage) Retrieve the average daily public bandwidth usage for the current billing cycle. +
              #### [getBandwidthDataByDate](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBandwidthDataByDate) +
              #### [getBandwidthImageByDate](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBandwidthImageByDate) Retrieve a visual representation of the amount of network traffic that occurred for the specified time frame for an application delivery controller. +
              #### [getBillingItem](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBillingItem) Retrieve the billing item for a Application Delivery Controller. +
              #### [getConfigurationHistory](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getConfigurationHistory) Retrieve previous configurations for an Application Delivery Controller. +
              #### [getCustomBandwidthDataByDate](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getCustomBandwidthDataByDate) Retrieve bandwidth graph by date. +
              #### [getDatacenter](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getDatacenter) Retrieve the datacenter that the application delivery controller resides in. +
              #### [getDescription](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getDescription) Retrieve a brief description of an application delivery controller record. +
              #### [getLicenseExpirationDate](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLicenseExpirationDate) Retrieve the date in which the license for this application delivery controller will expire. +
              #### [getLiveLoadBalancerServiceGraphImage](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLiveLoadBalancerServiceGraphImage) Get the connection or status graph image for an application delivery controller service. +
              #### [getLoadBalancers](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLoadBalancers) Retrieve the virtual IP address records that belong to an application delivery controller based load balancer. +
              #### [getManagedResourceFlag](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getManagedResourceFlag) Retrieve a flag indicating that this Application Delivery Controller is a managed resource. +
              #### [getManagementIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getManagementIpAddress) Retrieve an application delivery controller's management ip address. +
              #### [getNetworkVlan](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getNetworkVlan) Retrieve the network VLAN that an application delivery controller resides on. +
              #### [getNetworkVlans](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getNetworkVlans) Retrieve the network VLANs that an application delivery controller resides on. +
              #### [getObject](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getObject) Retrieve a SoftLayer_Network_Application_Delivery_Controller record. +
              #### [getOutboundPublicBandwidthUsage](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getOutboundPublicBandwidthUsage) Retrieve the total public outbound bandwidth for the current billing cycle. +
              #### [getPassword](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getPassword) Retrieve the password used to connect to an application delivery controller's management interface when it is operating in advanced view mode. +
              #### [getPrimaryIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getPrimaryIpAddress) Retrieve an application delivery controller's primary public IP address. +
              #### [getProjectedPublicBandwidthUsage](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getProjectedPublicBandwidthUsage) Retrieve the projected public outbound bandwidth for the current billing cycle. +
              #### [getSubnets](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getSubnets) Retrieve a network application controller's subnets. A subnet is a group of IP addresses +
              #### [getTagReferences](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getTagReferences) +
              #### [getType](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getType) +
              #### [getVirtualIpAddresses](/reference/services/SoftLayer_Network_Application_Delivery_Controller/getVirtualIpAddresses) +
              #### [restoreBaseConfiguration](/reference/services/SoftLayer_Network_Application_Delivery_Controller/restoreBaseConfiguration) Restore an application delivery controller's base configuration state. +
              #### [restoreConfiguration](/reference/services/SoftLayer_Network_Application_Delivery_Controller/restoreConfiguration) Restore an application delivery controller's configuration state. +
              #### [saveCurrentConfiguration](/reference/services/SoftLayer_Network_Application_Delivery_Controller/saveCurrentConfiguration) Save an application delivery controller's configuration state. +
              #### [updateLiveLoadBalancer](/reference/services/SoftLayer_Network_Application_Delivery_Controller/updateLiveLoadBalancer) Edit a virtual IP address within a load balancer +
              #### [updateNetScalerLicense](/reference/services/SoftLayer_Network_Application_Delivery_Controller/updateNetScalerLicense) Update the NetScaler VPX License. +
              diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/createLiveLoadBalancer.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/createLiveLoadBalancer.md index 68cdc450f3..669806d286 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/createLiveLoadBalancer.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/createLiveLoadBalancer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::createLiveLoadBalancer + Add to or create load balancer service from a virtual IP address diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/deleteLiveLoadBalancer.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/deleteLiveLoadBalancer.md index 89ffc92d10..55755dfaab 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/deleteLiveLoadBalancer.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/deleteLiveLoadBalancer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::deleteLiveLoadBalancer + Remove a virtual IP address from a load balancer diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/deleteLiveLoadBalancerService.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/deleteLiveLoadBalancerService.md index b4b7ca9232..293e1ab91a 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/deleteLiveLoadBalancerService.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/deleteLiveLoadBalancerService.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::deleteLiveLoadBalancerService + Remove load balancer service diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/editObject.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/editObject.md index ef21941a91..54e4212d8a 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/editObject.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::editObject + Edit an application delivery controller record diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getAccount.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getAccount.md index e32f6233ec..c03809875c 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getAccount + Retrieve the SoftLayer customer account that owns an application delivery controller record. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getAverageDailyPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getAverageDailyPublicBandwidthUsage.md index d77666cc51..2bc8caff4b 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getAverageDailyPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getAverageDailyPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getAverageDailyPublicBandwidthUsage + Retrieve the average daily public bandwidth usage for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBandwidthDataByDate.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBandwidthDataByDate.md index 7801f79fdf..7f10d887dc 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBandwidthDataByDate.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBandwidthDataByDate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBandwidthImageByDate.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBandwidthImageByDate.md index 5eb1226c5e..69f66a10f8 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBandwidthImageByDate.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBandwidthImageByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getBandwidthImageByDate + Retrieve a visual representation of the amount of network traffic that occurred for the specified time frame for an application delivery controller. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBillingItem.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBillingItem.md index 2f4b122ee2..d14d0935a0 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getBillingItem + Retrieve the billing item for a Application Delivery Controller. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getConfigurationHistory.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getConfigurationHistory.md index a9da31e1ad..51968db272 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getConfigurationHistory.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getConfigurationHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getConfigurationHistory + Retrieve previous configurations for an Application Delivery Controller. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getCustomBandwidthDataByDate.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getCustomBandwidthDataByDate.md index 8e20a21609..0c9ce5cb9f 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getCustomBandwidthDataByDate.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getCustomBandwidthDataByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getCustomBandwidthDataByDate + Retrieve bandwidth graph by date. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getDatacenter.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getDatacenter.md index 3b88e09c5f..6432a5d660 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getDatacenter.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getDatacenter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getDatacenter + Retrieve the datacenter that the application delivery controller resides in. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getDescription.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getDescription.md index 4635304718..9baaadd7c6 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getDescription.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getDescription.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getDescription + Retrieve a brief description of an application delivery controller record. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLicenseExpirationDate.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLicenseExpirationDate.md index 7cda878869..a571301048 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLicenseExpirationDate.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLicenseExpirationDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getLicenseExpirationDate + Retrieve the date in which the license for this application delivery controller will expire. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLiveLoadBalancerServiceGraphImage.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLiveLoadBalancerServiceGraphImage.md index 472d7969fb..36e768fc9a 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLiveLoadBalancerServiceGraphImage.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLiveLoadBalancerServiceGraphImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getLiveLoadBalancerServiceGraphImage + Get the connection or status graph image for an application delivery controller service. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLoadBalancers.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLoadBalancers.md index bb99ed7eda..4f69d23389 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLoadBalancers.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLoadBalancers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getLoadBalancers + Retrieve the virtual IP address records that belong to an application delivery controller based load balancer. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getManagedResourceFlag.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getManagedResourceFlag.md index 37540abd78..b1e3fa39bd 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getManagedResourceFlag.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getManagedResourceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getManagedResourceFlag + Retrieve a flag indicating that this Application Delivery Controller is a managed resource. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getManagementIpAddress.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getManagementIpAddress.md index 41e62819bf..a19a3db1c2 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getManagementIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getManagementIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getManagementIpAddress + Retrieve an application delivery controller's management ip address. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getNetworkVlan.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getNetworkVlan.md index 42ec5758f5..6bc53d991b 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getNetworkVlan.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getNetworkVlan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getNetworkVlan + Retrieve the network VLAN that an application delivery controller resides on. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getNetworkVlans.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getNetworkVlans.md index 8efe73ba9d..1793af5cd8 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getNetworkVlans.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getNetworkVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getNetworkVlans + Retrieve the network VLANs that an application delivery controller resides on. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getObject.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getObject.md index 285d888cec..e4d85e0649 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getObject.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getObject + Retrieve a SoftLayer_Network_Application_Delivery_Controller record. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getOutboundPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getOutboundPublicBandwidthUsage.md index 10e2c64846..ddac95e08f 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getOutboundPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getOutboundPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getOutboundPublicBandwidthUsage + Retrieve the total public outbound bandwidth for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getPassword.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getPassword.md index fe370b0983..cbcd5451ba 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getPassword.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getPassword + Retrieve the password used to connect to an application delivery controller's management interface when it is operating in advanced view mode. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getPrimaryIpAddress.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getPrimaryIpAddress.md index c886906c23..ef4b00962b 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getPrimaryIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getPrimaryIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getPrimaryIpAddress + Retrieve an application delivery controller's primary public IP address. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getProjectedPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getProjectedPublicBandwidthUsage.md index 3ead50c9b3..d8f1278ae8 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getProjectedPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getProjectedPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getProjectedPublicBandwidthUsage + Retrieve the projected public outbound bandwidth for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getSubnets.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getSubnets.md index 49683c0c7e..86f1f7d698 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getSubnets.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::getSubnets + Retrieve a network application controller's subnets. A subnet is a group of IP addresses diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getTagReferences.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getTagReferences.md index 91b71b5479..c2c630853a 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getTagReferences.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getTagReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getType.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getType.md index 9e7b77b348..455d0e5aa7 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getType.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getType.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getVirtualIpAddresses.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getVirtualIpAddresses.md index 3f1db07ccc..a6e13d9281 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getVirtualIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/getVirtualIpAddresses.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/restoreBaseConfiguration.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/restoreBaseConfiguration.md index 4bbf081fe9..78a6c08e09 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/restoreBaseConfiguration.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/restoreBaseConfiguration.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::restoreBaseConfiguration + Restore an application delivery controller's base configuration state. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/restoreConfiguration.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/restoreConfiguration.md index 03335b4a7d..cf142c3e5f 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/restoreConfiguration.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/restoreConfiguration.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::restoreConfiguration + Restore an application delivery controller's configuration state. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/saveCurrentConfiguration.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/saveCurrentConfiguration.md index 4472782bc8..20cffba0f7 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/saveCurrentConfiguration.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/saveCurrentConfiguration.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::saveCurrentConfiguration + Save an application delivery controller's configuration state. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/updateLiveLoadBalancer.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/updateLiveLoadBalancer.md index 528126975b..e796ee1536 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/updateLiveLoadBalancer.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/updateLiveLoadBalancer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::updateLiveLoadBalancer + Edit a virtual IP address within a load balancer diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/updateNetScalerLicense.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/updateNetScalerLicense.md index 4accdb9b5b..eadde20231 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/updateNetScalerLicense.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller/updateNetScalerLicense.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller](/reference/services/SoftLayer_Network_Application_Delivery_Controller)::updateNetScalerLicense + Update the NetScaler VPX License. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/_index.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/_index.md index 978f017100..fcbac90454 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/_index.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,18 +44,21 @@ SoftLayer_Network_Application_Delivery_Controller_Configuration_History provides #### [deleteObject](/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/deleteObject) Remove a configuration history record. +
              #### [getController](/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/getController) Retrieve the application delivery controller that a configuration history record belongs to. +
              #### [getObject](/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/getObject) Retrieve a SoftLayer_Network_Application_Delivery_Controller_Configuration_History record. +
              diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/deleteObject.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/deleteObject.md index 92c59aa964..14af8cc440 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_Configuration_History](/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History)::deleteObject + Remove a configuration history record. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/getController.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/getController.md index e57e51b9f5..44d982da18 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/getController.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/getController.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_Configuration_History](/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History)::getController + Retrieve the application delivery controller that a configuration history record belongs to. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/getObject.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/getObject.md index b3c96c480f..c5f5274243 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/getObject.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_Configuration_History](/reference/services/SoftLayer_Network_Application_Delivery_Controller_Configuration_History)::getObject + Retrieve a SoftLayer_Network_Application_Delivery_Controller_Configuration_History record. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/_index.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/_index.md index 3a5b694742..464726b95e 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/_index.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,18 +44,21 @@ classes: #### [getHealthCheck](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/getHealthCheck) +
              #### [getObject](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/getObject) Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute record. +
              #### [getType](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/getType) +
              diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/getHealthCheck.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/getHealthCheck.md index 2eb50d301b..a28bec578d 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/getHealthCheck.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/getHealthCheck.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/getObject.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/getObject.md index 12085d16ed..064e0227a7 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/getObject.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute)::getObject + Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute record. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/getType.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/getType.md index fa2f70f0a4..ff02e7f671 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/getType.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute/getType.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/_index.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/_index.md index 2fdc6c8ab1..ba3c98943d 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/_index.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/getObject) Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type record. +
              diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/getAllObjects.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/getAllObjects.md index d7ae859afb..3901784f45 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/getObject.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/getObject.md index d49999933b..59d56ff1f0 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/getObject.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type)::getObject + Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type record. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/_index.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/_index.md index 53f966fee4..53d6272823 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/_index.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,30 +44,35 @@ classes: #### [getAttributes](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getAttributes) +
              #### [getObject](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getObject) Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check record. +
              #### [getScaleLoadBalancers](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getScaleLoadBalancers) Retrieve collection of scale load balancers that use this health check. +
              #### [getServices](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getServices) +
              #### [getType](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getType) +
              diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getAttributes.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getAttributes.md index 8d7a44f185..7b26d29935 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getAttributes.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getAttributes.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getObject.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getObject.md index 2591226939..94b92783ab 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getObject.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check)::getObject + Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check record. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getScaleLoadBalancers.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getScaleLoadBalancers.md index c3cf2b858b..f51545c645 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getScaleLoadBalancers.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getScaleLoadBalancers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check)::getScaleLoadBalancers + Retrieve collection of scale load balancers that use this health check. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getServices.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getServices.md index ebe14e9b5c..2f4a291bde 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getServices.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getServices.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getType.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getType.md index 2c9467dbaa..3097d8fd3d 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getType.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check/getType.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/_index.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/_index.md index 3c9c5d532e..ae5570638e 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/_index.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/getObject) Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type record. +
              diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/getAllObjects.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/getAllObjects.md index 26670804da..f2cbb95070 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/getObject.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/getObject.md index dbe4d73940..15f9937985 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/getObject.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type)::getObject + Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type record. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/_index.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/_index.md index c12309f0e2..eb21fd0ca1 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/_index.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/getObject) Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method record. +
              diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/getAllObjects.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/getAllObjects.md index af2e231ffd..268b327df8 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/getObject.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/getObject.md index dc2949bc36..9b4dc3597c 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/getObject.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method)::getObject + Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method record. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/_index.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/_index.md index a7a4ce6e34..9fceeb0dd3 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/_index.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/getObject) Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type record. +
              diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/getAllObjects.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/getAllObjects.md index 5b30b4e5d3..660601c1dc 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/getObject.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/getObject.md index 06f8584300..c6c9cdcf4c 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/getObject.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type)::getObject + Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type record. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/_index.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/_index.md index 64718a5a4c..8d4516983f 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/_index.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,60 +44,70 @@ classes: #### [deleteObject](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/deleteObject) +
              #### [getGraphImage](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getGraphImage) Get the connection or status graph image for a load balancer service. +
              #### [getGroupReferences](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getGroupReferences) +
              #### [getGroups](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getGroups) +
              #### [getHealthCheck](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getHealthCheck) +
              #### [getHealthChecks](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getHealthChecks) +
              #### [getIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getIpAddress) +
              #### [getObject](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getObject) Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service record. +
              #### [getServiceGroup](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getServiceGroup) +
              #### [toggleStatus](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/toggleStatus) +
              diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/deleteObject.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/deleteObject.md index 810793aca7..39d1d39145 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/deleteObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getGraphImage.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getGraphImage.md index 935c202dc8..ce5fa4a6ea 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getGraphImage.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getGraphImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service)::getGraphImage + Get the connection or status graph image for a load balancer service. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getGroupReferences.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getGroupReferences.md index b1fbe57344..9f274acaae 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getGroupReferences.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getGroupReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getGroups.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getGroups.md index 8b89ffc6c1..3954c66e38 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getGroups.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getGroups.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getHealthCheck.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getHealthCheck.md index 666c312f5d..3d6b0e4317 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getHealthCheck.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getHealthCheck.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getHealthChecks.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getHealthChecks.md index 506c5fc80a..487d4ccae7 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getHealthChecks.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getHealthChecks.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getIpAddress.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getIpAddress.md index c2ee22dc30..bd145e6a2b 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getIpAddress.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getObject.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getObject.md index 005b5d691f..c17d640b89 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getObject.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service)::getObject + Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service record. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getServiceGroup.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getServiceGroup.md index 904067a23f..c31e8a8df0 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getServiceGroup.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/getServiceGroup.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/toggleStatus.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/toggleStatus.md index c4d00584dd..5ee292d3be 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/toggleStatus.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service/toggleStatus.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/_index.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/_index.md index 87cb0eeeda..cbd1407272 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/_index.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,54 +44,63 @@ classes: #### [getGraphImage](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getGraphImage) Get the connection or status graph image for a load balancer service group. +
              #### [getObject](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getObject) Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group record. +
              #### [getRoutingMethod](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getRoutingMethod) +
              #### [getRoutingType](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getRoutingType) +
              #### [getServiceReferences](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getServiceReferences) +
              #### [getServices](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getServices) +
              #### [getVirtualServer](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getVirtualServer) +
              #### [getVirtualServers](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getVirtualServers) +
              #### [kickAllConnections](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/kickAllConnections) +
              diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getGraphImage.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getGraphImage.md index ac3f2c6963..3359994958 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getGraphImage.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getGraphImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group)::getGraphImage + Get the connection or status graph image for a load balancer service group. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getObject.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getObject.md index 9bc4de8055..50f3436fbb 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getObject.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group)::getObject + Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group record. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getRoutingMethod.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getRoutingMethod.md index 4b7cf12011..541fa8afe2 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getRoutingMethod.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getRoutingMethod.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getRoutingType.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getRoutingType.md index 3a49062fab..5198323501 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getRoutingType.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getRoutingType.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getServiceReferences.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getServiceReferences.md index c89305c7d8..b8b661b0ec 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getServiceReferences.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getServiceReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getServices.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getServices.md index a3c8cf2638..ad0d179d82 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getServices.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getServices.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getVirtualServer.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getVirtualServer.md index d83158957d..e6635b1aaa 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getVirtualServer.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getVirtualServer.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getVirtualServers.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getVirtualServers.md index d57cfc81bb..77a89b7020 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getVirtualServers.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/getVirtualServers.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/kickAllConnections.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/kickAllConnections.md index 9907465f96..a3bfa257d6 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/kickAllConnections.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group/kickAllConnections.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/_index.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/_index.md index 92ef74836e..b8e662f401 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/_index.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,126 +44,147 @@ classes: #### [editObject](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/editObject) Edit the object by passing in a modified instance of the object +
              #### [getAccount](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getAccount) +
              #### [getApplicationDeliveryController](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getApplicationDeliveryController) Retrieve a virtual IP address's associated application delivery controller. +
              #### [getApplicationDeliveryControllers](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getApplicationDeliveryControllers) Retrieve a virtual IP address's associated application delivery controllers. +
              #### [getAvailableSecureTransportCiphers](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getAvailableSecureTransportCiphers) Lists the SSL encryption ciphers available to this virtual IP address +
              #### [getAvailableSecureTransportProtocols](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getAvailableSecureTransportProtocols) Lists the secure communication protocols available to this virtual IP address +
              #### [getBillingItem](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getBillingItem) Retrieve the current billing item for the load balancer virtual IP. This is only valid when dedicatedFlag is false. This is an independent virtual IP, and if canceled, will only affect the associated virtual IP. +
              #### [getDedicatedBillingItem](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getDedicatedBillingItem) Retrieve the current billing item for the load balancing device housing the virtual IP. This billing item represents a device which could contain other virtual IPs. Caution should be taken when canceling. This is only valid when dedicatedFlag is true. +
              #### [getHighAvailabilityFlag](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getHighAvailabilityFlag) Retrieve denotes whether the virtual IP is configured within a high availability cluster. +
              #### [getIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getIpAddress) +
              #### [getLoadBalancerHardware](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getLoadBalancerHardware) +
              #### [getManagedResourceFlag](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getManagedResourceFlag) Retrieve a flag indicating that the load balancer is a managed resource. +
              #### [getObject](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getObject) Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress record. +
              #### [getSecureTransportCiphers](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecureTransportCiphers) Retrieve the list of security ciphers enabled for this virtual IP address +
              #### [getSecureTransportProtocols](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecureTransportProtocols) Retrieve the list of secure transport protocols enabled for this virtual IP address +
              #### [getSecurityCertificate](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecurityCertificate) Retrieve the SSL certificate currently associated with the VIP. +
              #### [getSecurityCertificateEntry](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecurityCertificateEntry) Retrieve the SSL certificate currently associated with the VIP. Provides chosen certificate visibility to unprivileged users. +
              #### [getVirtualServers](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getVirtualServers) +
              #### [startSsl](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/startSsl) +
              #### [stopSsl](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/stopSsl) +
              #### [upgradeConnectionLimit](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/upgradeConnectionLimit) Upgrades the connection limit on the Virtual IP Address and changes the billing item on your account to reflect the change. +
              diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/editObject.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/editObject.md index 13f0abf833..4a2af48aa0 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/editObject.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress)::editObject + Edit the object by passing in a modified instance of the object diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getAccount.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getAccount.md index e7ac099330..737a197ddd 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getApplicationDeliveryController.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getApplicationDeliveryController.md index a84c23e000..5e786e834a 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getApplicationDeliveryController.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getApplicationDeliveryController.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress)::getApplicationDeliveryController + Retrieve a virtual IP address's associated application delivery controller. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getApplicationDeliveryControllers.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getApplicationDeliveryControllers.md index 8f55d8b082..ceb9f63c0b 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getApplicationDeliveryControllers.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getApplicationDeliveryControllers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress)::getApplicationDeliveryControllers + Retrieve a virtual IP address's associated application delivery controllers. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getAvailableSecureTransportCiphers.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getAvailableSecureTransportCiphers.md index f84fd8a6e5..6e0ca191ea 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getAvailableSecureTransportCiphers.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getAvailableSecureTransportCiphers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress)::getAvailableSecureTransportCiphers + Lists the SSL encryption ciphers available to this virtual IP address diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getAvailableSecureTransportProtocols.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getAvailableSecureTransportProtocols.md index 4834698805..b187c7db2c 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getAvailableSecureTransportProtocols.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getAvailableSecureTransportProtocols.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress)::getAvailableSecureTransportProtocols + Lists the secure communication protocols available to this virtual IP address diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getBillingItem.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getBillingItem.md index e8c8d61feb..6d65fbf7a6 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress)::getBillingItem + Retrieve the current billing item for the load balancer virtual IP. This is only valid when dedicatedFlag is false. This is an independent virtual IP, and if canceled, will only affect the associated virtual IP. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getDedicatedBillingItem.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getDedicatedBillingItem.md index 93a7cd6eb4..b45141a35a 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getDedicatedBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getDedicatedBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress)::getDedicatedBillingItem + Retrieve the current billing item for the load balancing device housing the virtual IP. This billing item represents a device which could contain other virtual IPs. Caution should be taken when canceling. This is only valid when dedicatedFlag is true. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getHighAvailabilityFlag.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getHighAvailabilityFlag.md index 6a45515de6..579128393f 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getHighAvailabilityFlag.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getHighAvailabilityFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress)::getHighAvailabilityFlag + Retrieve denotes whether the virtual IP is configured within a high availability cluster. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getIpAddress.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getIpAddress.md index 702a1c9d2b..3ff4c1ba45 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getIpAddress.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getLoadBalancerHardware.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getLoadBalancerHardware.md index f813caa9f2..76b0b5fb65 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getLoadBalancerHardware.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getLoadBalancerHardware.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getManagedResourceFlag.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getManagedResourceFlag.md index 275e9c0c9f..8fd9c4e765 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getManagedResourceFlag.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getManagedResourceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress)::getManagedResourceFlag + Retrieve a flag indicating that the load balancer is a managed resource. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getObject.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getObject.md index 092bb1d567..102119071b 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getObject.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress)::getObject + Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress record. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecureTransportCiphers.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecureTransportCiphers.md index 91d266b4e9..fc60d5e994 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecureTransportCiphers.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecureTransportCiphers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress)::getSecureTransportCiphers + Retrieve the list of security ciphers enabled for this virtual IP address diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecureTransportProtocols.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecureTransportProtocols.md index da57f31aea..a6a87b2753 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecureTransportProtocols.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecureTransportProtocols.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress)::getSecureTransportProtocols + Retrieve the list of secure transport protocols enabled for this virtual IP address diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecurityCertificate.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecurityCertificate.md index acaa24f666..67e9ce22d2 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecurityCertificate.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecurityCertificate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress)::getSecurityCertificate + Retrieve the SSL certificate currently associated with the VIP. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecurityCertificateEntry.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecurityCertificateEntry.md index 9ad0e17253..6012f366aa 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecurityCertificateEntry.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getSecurityCertificateEntry.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress)::getSecurityCertificateEntry + Retrieve the SSL certificate currently associated with the VIP. Provides chosen certificate visibility to unprivileged users. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getVirtualServers.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getVirtualServers.md index 34fea035f0..56949052b9 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getVirtualServers.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getVirtualServers.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/startSsl.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/startSsl.md index 76dd870274..88eff9a4f2 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/startSsl.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/startSsl.md @@ -16,6 +16,7 @@ aliases: + ## Overview Start SSL acceleration on all SSL virtual services (those with a type of HTTPS). This action should be taken only after configuring an SSL certificate for the virtual IP. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/stopSsl.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/stopSsl.md index 4c946bb607..fa614beb2b 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/stopSsl.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/stopSsl.md @@ -16,6 +16,7 @@ aliases: + ## Overview Stop SSL acceleration on all SSL virtual services (those with a type of HTTPS). diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/upgradeConnectionLimit.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/upgradeConnectionLimit.md index b244d1e8dd..80d2997918 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/upgradeConnectionLimit.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/upgradeConnectionLimit.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress)::upgradeConnectionLimit + Upgrades the connection limit on the Virtual IP Address and changes the billing item on your account to reflect the change. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/_index.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/_index.md index c9f284caf0..31f12583b0 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/_index.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,48 +44,62 @@ classes: #### [deleteObject](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/deleteObject) +
              #### [getObject](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getObject) Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer record. +
              #### [getRoutingMethod](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getRoutingMethod) +
              #### [getScaleLoadBalancers](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getScaleLoadBalancers) Retrieve collection of scale load balancers this virtual server applies to. +
              #### [getServiceGroups](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getServiceGroups) +
              #### [getVirtualIpAddress](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getVirtualIpAddress) +
              -
              +
              #### [startSsl](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/startSsl) + +Deprecated + +
              -
              +
              #### [stopSsl](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/stopSsl) + +Deprecated + +
              diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/deleteObject.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/deleteObject.md index 777c30c7dd..2bbe232bb0 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/deleteObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getObject.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getObject.md index ae7a430330..ba41503318 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getObject.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer)::getObject + Retrieve a SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer record. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getRoutingMethod.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getRoutingMethod.md index f1d003f2eb..86b8bb9de0 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getRoutingMethod.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getRoutingMethod.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getScaleLoadBalancers.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getScaleLoadBalancers.md index fbc219e8ef..ffc4363a91 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getScaleLoadBalancers.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getScaleLoadBalancers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer)::getScaleLoadBalancers + Retrieve collection of scale load balancers this virtual server applies to. diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getServiceGroups.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getServiceGroups.md index c235b1667b..8678453b29 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getServiceGroups.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getServiceGroups.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getVirtualIpAddress.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getVirtualIpAddress.md index b925885d72..092cab9d89 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getVirtualIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/getVirtualIpAddress.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/startSsl.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/startSsl.md index 023eceb8f5..50ba108db0 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/startSsl.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/startSsl.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer)::startSsl +
              Deprecated
              + diff --git a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/stopSsl.md b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/stopSsl.md index d26674cf6f..5912381d29 100644 --- a/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/stopSsl.md +++ b/content/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer/stopSsl.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer](/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer)::stopSsl +
              Deprecated
              + diff --git a/content/reference/services/SoftLayer_Network_Backbone/_index.md b/content/reference/services/SoftLayer_Network_Backbone/_index.md index d304d94f08..3a6f0bf32c 100644 --- a/content/reference/services/SoftLayer_Network_Backbone/_index.md +++ b/content/reference/services/SoftLayer_Network_Backbone/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + A SoftLayer_Network_Backbone represents a single backbone connection from SoftLayer to the public Internet, from the Internet to the SoftLayer private network, or a link that connects the private networks between SoftLayer's datacenters. The SoftLayer_Network_Backbone service is unique in that it is not referenced by any of the other SoftLayer API services. @@ -42,42 +44,52 @@ A SoftLayer_Network_Backbone represents a single backbone connection from SoftLa #### [getAllBackbones](/reference/services/SoftLayer_Network_Backbone/getAllBackbones) Retrieve a list of all SoftLayer Backbones +
              #### [getBackbonesForLocationName](/reference/services/SoftLayer_Network_Backbone/getBackbonesForLocationName) Retrieve a list of all SoftLayer Backbones for a location name +
              -
              +
              #### [getGraphImage](/reference/services/SoftLayer_Network_Backbone/getGraphImage) [DEPRECATED] Retrieve a graph of a SoftLayer backbone's last 24 hours of activity. + +Deprecated + +
              #### [getHealth](/reference/services/SoftLayer_Network_Backbone/getHealth) Retrieve a backbone's status. +
              #### [getLocation](/reference/services/SoftLayer_Network_Backbone/getLocation) Retrieve which of the SoftLayer datacenters a backbone is connected to. +
              #### [getNetworkComponent](/reference/services/SoftLayer_Network_Backbone/getNetworkComponent) Retrieve a backbone's primary network component. +
              #### [getObject](/reference/services/SoftLayer_Network_Backbone/getObject) Retrieve a SoftLayer_Network_Backbone record. +
              diff --git a/content/reference/services/SoftLayer_Network_Backbone/getAllBackbones.md b/content/reference/services/SoftLayer_Network_Backbone/getAllBackbones.md index 1785868872..9035c58fc6 100644 --- a/content/reference/services/SoftLayer_Network_Backbone/getAllBackbones.md +++ b/content/reference/services/SoftLayer_Network_Backbone/getAllBackbones.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Backbone](/reference/services/SoftLayer_Network_Backbone)::getAllBackbones + Retrieve a list of all SoftLayer Backbones diff --git a/content/reference/services/SoftLayer_Network_Backbone/getBackbonesForLocationName.md b/content/reference/services/SoftLayer_Network_Backbone/getBackbonesForLocationName.md index 5a922c853d..614d69b5d6 100644 --- a/content/reference/services/SoftLayer_Network_Backbone/getBackbonesForLocationName.md +++ b/content/reference/services/SoftLayer_Network_Backbone/getBackbonesForLocationName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Backbone](/reference/services/SoftLayer_Network_Backbone)::getBackbonesForLocationName + Retrieve a list of all SoftLayer Backbones for a location name diff --git a/content/reference/services/SoftLayer_Network_Backbone/getGraphImage.md b/content/reference/services/SoftLayer_Network_Backbone/getGraphImage.md index e66ee6f3f7..c8493fec33 100644 --- a/content/reference/services/SoftLayer_Network_Backbone/getGraphImage.md +++ b/content/reference/services/SoftLayer_Network_Backbone/getGraphImage.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Network_Backbone](/reference/services/SoftLayer_Network_Backbone)::getGraphImage +
              Deprecated
              + [DEPRECATED] Retrieve a graph of a SoftLayer backbone's last 24 hours of activity. diff --git a/content/reference/services/SoftLayer_Network_Backbone/getHealth.md b/content/reference/services/SoftLayer_Network_Backbone/getHealth.md index 6562a34001..9b621bab4f 100644 --- a/content/reference/services/SoftLayer_Network_Backbone/getHealth.md +++ b/content/reference/services/SoftLayer_Network_Backbone/getHealth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Backbone](/reference/services/SoftLayer_Network_Backbone)::getHealth + Retrieve a backbone's status. diff --git a/content/reference/services/SoftLayer_Network_Backbone/getLocation.md b/content/reference/services/SoftLayer_Network_Backbone/getLocation.md index 5acbe013f7..36899d61a9 100644 --- a/content/reference/services/SoftLayer_Network_Backbone/getLocation.md +++ b/content/reference/services/SoftLayer_Network_Backbone/getLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Backbone](/reference/services/SoftLayer_Network_Backbone)::getLocation + Retrieve which of the SoftLayer datacenters a backbone is connected to. diff --git a/content/reference/services/SoftLayer_Network_Backbone/getNetworkComponent.md b/content/reference/services/SoftLayer_Network_Backbone/getNetworkComponent.md index a3a74da02d..f8b7cafdda 100644 --- a/content/reference/services/SoftLayer_Network_Backbone/getNetworkComponent.md +++ b/content/reference/services/SoftLayer_Network_Backbone/getNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Backbone](/reference/services/SoftLayer_Network_Backbone)::getNetworkComponent + Retrieve a backbone's primary network component. diff --git a/content/reference/services/SoftLayer_Network_Backbone/getObject.md b/content/reference/services/SoftLayer_Network_Backbone/getObject.md index 3f1bbe6b3a..fd72c43e59 100644 --- a/content/reference/services/SoftLayer_Network_Backbone/getObject.md +++ b/content/reference/services/SoftLayer_Network_Backbone/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Backbone](/reference/services/SoftLayer_Network_Backbone)::getObject + Retrieve a SoftLayer_Network_Backbone record. diff --git a/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/_index.md b/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/_index.md index a71c3976d6..d45151bc02 100644 --- a/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/_index.md +++ b/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,30 +44,35 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getAllObjects) +
              #### [getDependentLocation](/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getDependentLocation) +
              #### [getObject](/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getObject) Retrieve a SoftLayer_Network_Backbone_Location_Dependent record. +
              #### [getSourceDependentsByName](/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getSourceDependentsByName) +
              #### [getSourceLocation](/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getSourceLocation) +
              diff --git a/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getAllObjects.md b/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getAllObjects.md index c6a4d26f19..18efe2f34f 100644 --- a/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getDependentLocation.md b/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getDependentLocation.md index 093827d3ad..109eb6b20c 100644 --- a/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getDependentLocation.md +++ b/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getDependentLocation.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getObject.md b/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getObject.md index 39bcdbaf79..b41fd6148e 100644 --- a/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getObject.md +++ b/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Backbone_Location_Dependent](/reference/services/SoftLayer_Network_Backbone_Location_Dependent)::getObject + Retrieve a SoftLayer_Network_Backbone_Location_Dependent record. diff --git a/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getSourceDependentsByName.md b/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getSourceDependentsByName.md index 5cf6e69550..4ba3069db8 100644 --- a/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getSourceDependentsByName.md +++ b/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getSourceDependentsByName.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getSourceLocation.md b/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getSourceLocation.md index 0d01fd5406..325bb1284e 100644 --- a/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getSourceLocation.md +++ b/content/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getSourceLocation.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/_index.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/_index.md index 8f88fe3b13..09ebdf49e2 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/_index.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -48,282 +50,335 @@ For example, if you had 5 servers, each with 2000 GB of bandwidth, and one serve #### [createObject](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/createObject) create a new allotment by passing in a allotment object. +
              #### [editObject](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/editObject) Edit a bandwidth allotment +
              #### [getAccount](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getAccount) Retrieve the account associated with this virtual rack. +
              #### [getActiveDetails](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getActiveDetails) Retrieve the bandwidth allotment detail records associated with this virtual rack. +
              #### [getApplicationDeliveryControllers](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getApplicationDeliveryControllers) Retrieve the Application Delivery Controller contained within a virtual rack. +
              #### [getAverageDailyPublicBandwidthUsage](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getAverageDailyPublicBandwidthUsage) Retrieve the average daily public bandwidth usage for the current billing cycle. +
              -
              +
              #### [getBackendBandwidthByHour](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBackendBandwidthByHour) [DEPRECATED] return a collection of private usage objects that contain hourly incoming and outgoing network traffic amounts for a 24 hour period. + +Deprecated + +
              #### [getBackendBandwidthUse](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBackendBandwidthUse) return a collection of private usage objects that contain hourly incoming and outgoing network traffic amounts for a customer date period. +
              #### [getBandwidthAllotmentType](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthAllotmentType) Retrieve the bandwidth allotment type of this virtual rack. +
              #### [getBandwidthForDateRange](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthForDateRange) Retrieve bandwidth data from a tracking object. +
              #### [getBandwidthImage](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthImage) generate a graph image of all the bandwidth usage for an entire allotment of servers. +
              #### [getBareMetalInstances](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBareMetalInstances) Retrieve the bare metal server instances contained within a virtual rack. +
              #### [getBillingCycleBandwidthUsage](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCycleBandwidthUsage) Retrieve a virtual rack's raw bandwidth usage data for an account's current billing cycle. One object is returned for each network this server is attached to. +
              #### [getBillingCyclePrivateBandwidthUsage](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCyclePrivateBandwidthUsage) Retrieve a virtual rack's raw private network bandwidth usage data for an account's current billing cycle. +
              #### [getBillingCyclePublicBandwidthUsage](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCyclePublicBandwidthUsage) Retrieve a virtual rack's raw public network bandwidth usage data for an account's current billing cycle. +
              #### [getBillingCyclePublicUsageTotal](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCyclePublicUsageTotal) Retrieve the total public bandwidth used in this virtual rack for an account's current billing cycle. +
              #### [getBillingItem](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingItem) Retrieve a virtual rack's billing item. +
              #### [getCurrentBandwidthSummary](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getCurrentBandwidthSummary) Retrieve an object that provides commonly used bandwidth summary components for the current billing cycle. +
              #### [getCustomBandwidthDataByDate](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getCustomBandwidthDataByDate) Retrieve bandwidth graph by date. +
              #### [getDetails](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getDetails) Retrieve the bandwidth allotment detail records associated with this virtual rack. +
              -
              +
              #### [getFrontendBandwidthByHour](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getFrontendBandwidthByHour) [DEPRECATED] return a collection of public usage objects that contain hourly incoming and outgoing network traffic amounts for a 24 hour period. + +Deprecated + +
              #### [getFrontendBandwidthUse](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getFrontendBandwidthUse) return a collection of public usage objects that contain hourly incoming and outgoing network traffic amounts for a 24 hour period. +
              #### [getHardware](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getHardware) Retrieve the hardware contained within a virtual rack. +
              #### [getInboundPublicBandwidthUsage](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getInboundPublicBandwidthUsage) Retrieve the total public inbound bandwidth used in this virtual rack for an account's current billing cycle. +
              #### [getLocationGroup](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getLocationGroup) Retrieve the location group associated with this virtual rack. +
              #### [getManagedBareMetalInstances](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedBareMetalInstances) Retrieve the managed bare metal server instances contained within a virtual rack. +
              #### [getManagedHardware](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedHardware) Retrieve the managed hardware contained within a virtual rack. +
              #### [getManagedVirtualGuests](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedVirtualGuests) Retrieve the managed Virtual Server contained within a virtual rack. +
              #### [getMetricTrackingObject](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getMetricTrackingObject) Retrieve a virtual rack's metric tracking object. This object records all periodic polled data available to this rack. +
              #### [getMetricTrackingObjectId](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getMetricTrackingObjectId) Retrieve the metric tracking object id for this allotment. +
              #### [getObject](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getObject) Retrieve a SoftLayer_Network_Bandwidth_Version1_Allotment record. +
              #### [getOutboundPublicBandwidthUsage](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getOutboundPublicBandwidthUsage) Retrieve the total public outbound bandwidth used in this virtual rack for an account's current billing cycle. +
              #### [getOverBandwidthAllocationFlag](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getOverBandwidthAllocationFlag) Retrieve whether the bandwidth usage for this bandwidth pool for the current billing cycle exceeds the allocation. +
              #### [getPrivateNetworkOnlyHardware](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getPrivateNetworkOnlyHardware) Retrieve the private network only hardware contained within a virtual rack. +
              #### [getProjectedOverBandwidthAllocationFlag](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getProjectedOverBandwidthAllocationFlag) Retrieve whether the bandwidth usage for this bandwidth pool for the current billing cycle is projected to exceed the allocation. +
              #### [getProjectedPublicBandwidthUsage](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getProjectedPublicBandwidthUsage) Retrieve the projected public outbound bandwidth for this virtual server for the current billing cycle. +
              #### [getServiceProvider](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getServiceProvider) +
              #### [getTotalBandwidthAllocated](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getTotalBandwidthAllocated) Retrieve the combined allocated bandwidth for all servers in a virtual rack. +
              #### [getVdrMemberRecurringFee](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getVdrMemberRecurringFee) Gets the monthly recurring fee of a pooled server. +
              #### [getVirtualGuests](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getVirtualGuests) Retrieve the Virtual Server contained within a virtual rack. +
              #### [reassignServers](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/reassignServers) reassign a collection of servers to a different allotment. +
              #### [requestVdrCancellation](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/requestVdrCancellation) cancel a bandwidth pooling and assign contents, if any, to bandwidth pool. +
              #### [requestVdrContentUpdates](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/requestVdrContentUpdates) Move servers into our out of a bandwidth pool. +
              #### [setVdrContent](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/setVdrContent) Update bandwidth pool. +
              #### [unassignServers](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/unassignServers) unassign a collection of servers from an allotment and insert them into the accounts VPR. +
              #### [voidPendingServerMove](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/voidPendingServerMove) Void a pending server removal from this bandwidth pooling. +
              #### [voidPendingVdrCancellation](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/voidPendingVdrCancellation) Void a pending cancellation on a bandwidth pool. +
              diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/createObject.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/createObject.md index 47814f0671..949ec037b7 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/createObject.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::createObject + create a new allotment by passing in a allotment object. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/editObject.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/editObject.md index d2b5d8c471..12db47e65a 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/editObject.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::editObject + Edit a bandwidth allotment diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getAccount.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getAccount.md index 7d8d609636..1c60ea3a5b 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getAccount + Retrieve the account associated with this virtual rack. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getActiveDetails.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getActiveDetails.md index e903aee525..314cd1f9ab 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getActiveDetails.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getActiveDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getActiveDetails + Retrieve the bandwidth allotment detail records associated with this virtual rack. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getApplicationDeliveryControllers.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getApplicationDeliveryControllers.md index 47e20ff1d4..ecaa3fbac8 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getApplicationDeliveryControllers.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getApplicationDeliveryControllers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getApplicationDeliveryControllers + Retrieve the Application Delivery Controller contained within a virtual rack. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getAverageDailyPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getAverageDailyPublicBandwidthUsage.md index 6474c364a8..28b545b970 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getAverageDailyPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getAverageDailyPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getAverageDailyPublicBandwidthUsage + Retrieve the average daily public bandwidth usage for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBackendBandwidthByHour.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBackendBandwidthByHour.md index 7c72cee33b..d8ca1331cb 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBackendBandwidthByHour.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBackendBandwidthByHour.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getBackendBandwidthByHour +
              Deprecated
              + [DEPRECATED] return a collection of private usage objects that contain hourly incoming and outgoing network traffic amounts for a 24 hour period. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBackendBandwidthUse.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBackendBandwidthUse.md index fbc6e3110e..4f204d9a8a 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBackendBandwidthUse.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBackendBandwidthUse.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getBackendBandwidthUse + return a collection of private usage objects that contain hourly incoming and outgoing network traffic amounts for a customer date period. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthAllotmentType.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthAllotmentType.md index 976b1b9778..f9b5dd4617 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthAllotmentType.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthAllotmentType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getBandwidthAllotmentType + Retrieve the bandwidth allotment type of this virtual rack. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthForDateRange.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthForDateRange.md index 3be41997b2..505145bdb2 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthForDateRange.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthForDateRange.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getBandwidthForDateRange + Retrieve bandwidth data from a tracking object. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthImage.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthImage.md index 844e095867..f43323384f 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthImage.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getBandwidthImage + generate a graph image of all the bandwidth usage for an entire allotment of servers. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBareMetalInstances.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBareMetalInstances.md index 4284b9ba16..485e994efd 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBareMetalInstances.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBareMetalInstances.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getBareMetalInstances + Retrieve the bare metal server instances contained within a virtual rack. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCycleBandwidthUsage.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCycleBandwidthUsage.md index 3c3e07ca96..4d0cdc4fb3 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCycleBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCycleBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getBillingCycleBandwidthUsage + Retrieve a virtual rack's raw bandwidth usage data for an account's current billing cycle. One object is returned for each network this server is attached to. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCyclePrivateBandwidthUsage.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCyclePrivateBandwidthUsage.md index 5db5b3c2e1..19d565f7dd 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCyclePrivateBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCyclePrivateBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getBillingCyclePrivateBandwidthUsage + Retrieve a virtual rack's raw private network bandwidth usage data for an account's current billing cycle. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCyclePublicBandwidthUsage.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCyclePublicBandwidthUsage.md index 880aac10ab..4d7f3f2a3e 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCyclePublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCyclePublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getBillingCyclePublicBandwidthUsage + Retrieve a virtual rack's raw public network bandwidth usage data for an account's current billing cycle. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCyclePublicUsageTotal.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCyclePublicUsageTotal.md index 0b1a8967a9..352350c39d 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCyclePublicUsageTotal.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingCyclePublicUsageTotal.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getBillingCyclePublicUsageTotal + Retrieve the total public bandwidth used in this virtual rack for an account's current billing cycle. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingItem.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingItem.md index b3cc79ac95..f6b58d3c91 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getBillingItem + Retrieve a virtual rack's billing item. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getCurrentBandwidthSummary.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getCurrentBandwidthSummary.md index f34465751b..cb6d063218 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getCurrentBandwidthSummary.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getCurrentBandwidthSummary.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getCurrentBandwidthSummary + Retrieve an object that provides commonly used bandwidth summary components for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getCustomBandwidthDataByDate.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getCustomBandwidthDataByDate.md index 79b715c390..ea6ce75e95 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getCustomBandwidthDataByDate.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getCustomBandwidthDataByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getCustomBandwidthDataByDate + Retrieve bandwidth graph by date. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getDetails.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getDetails.md index e43d1e581d..284bc4b5e9 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getDetails.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getDetails + Retrieve the bandwidth allotment detail records associated with this virtual rack. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getFrontendBandwidthByHour.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getFrontendBandwidthByHour.md index ce6eb04757..8d527157f8 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getFrontendBandwidthByHour.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getFrontendBandwidthByHour.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getFrontendBandwidthByHour +
              Deprecated
              + [DEPRECATED] return a collection of public usage objects that contain hourly incoming and outgoing network traffic amounts for a 24 hour period. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getFrontendBandwidthUse.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getFrontendBandwidthUse.md index 772139c6c5..1a7834dc13 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getFrontendBandwidthUse.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getFrontendBandwidthUse.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getFrontendBandwidthUse + return a collection of public usage objects that contain hourly incoming and outgoing network traffic amounts for a 24 hour period. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getHardware.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getHardware.md index 66ee998889..0e7d1bed45 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getHardware.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getHardware + Retrieve the hardware contained within a virtual rack. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getInboundPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getInboundPublicBandwidthUsage.md index 69d5f23bf2..340edaf5f3 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getInboundPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getInboundPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getInboundPublicBandwidthUsage + Retrieve the total public inbound bandwidth used in this virtual rack for an account's current billing cycle. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getLocationGroup.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getLocationGroup.md index 20f63d91d8..69f6f1f502 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getLocationGroup.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getLocationGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getLocationGroup + Retrieve the location group associated with this virtual rack. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedBareMetalInstances.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedBareMetalInstances.md index ce3c5ea157..52acf9c418 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedBareMetalInstances.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedBareMetalInstances.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getManagedBareMetalInstances + Retrieve the managed bare metal server instances contained within a virtual rack. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedHardware.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedHardware.md index 3240253dcb..abd5214c52 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedHardware.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getManagedHardware + Retrieve the managed hardware contained within a virtual rack. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedVirtualGuests.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedVirtualGuests.md index 55ddef855f..c17e3f1fea 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedVirtualGuests.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getManagedVirtualGuests + Retrieve the managed Virtual Server contained within a virtual rack. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getMetricTrackingObject.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getMetricTrackingObject.md index dfe5001752..02f682b995 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getMetricTrackingObject.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getMetricTrackingObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getMetricTrackingObject + Retrieve a virtual rack's metric tracking object. This object records all periodic polled data available to this rack. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getMetricTrackingObjectId.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getMetricTrackingObjectId.md index d4a9a42c78..7b8e600ba2 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getMetricTrackingObjectId.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getMetricTrackingObjectId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getMetricTrackingObjectId + Retrieve the metric tracking object id for this allotment. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getObject.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getObject.md index 1f4a9ba172..f9d67a9ebe 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getObject.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getObject + Retrieve a SoftLayer_Network_Bandwidth_Version1_Allotment record. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getOutboundPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getOutboundPublicBandwidthUsage.md index c5c36b966e..8c54d43a22 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getOutboundPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getOutboundPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getOutboundPublicBandwidthUsage + Retrieve the total public outbound bandwidth used in this virtual rack for an account's current billing cycle. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getOverBandwidthAllocationFlag.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getOverBandwidthAllocationFlag.md index 5bac5eadb2..146a947787 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getOverBandwidthAllocationFlag.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getOverBandwidthAllocationFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getOverBandwidthAllocationFlag + Retrieve whether the bandwidth usage for this bandwidth pool for the current billing cycle exceeds the allocation. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getPrivateNetworkOnlyHardware.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getPrivateNetworkOnlyHardware.md index 0667999a69..5b8e1cf70b 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getPrivateNetworkOnlyHardware.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getPrivateNetworkOnlyHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getPrivateNetworkOnlyHardware + Retrieve the private network only hardware contained within a virtual rack. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getProjectedOverBandwidthAllocationFlag.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getProjectedOverBandwidthAllocationFlag.md index 4f9d28a3df..22c7a4511f 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getProjectedOverBandwidthAllocationFlag.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getProjectedOverBandwidthAllocationFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getProjectedOverBandwidthAllocationFlag + Retrieve whether the bandwidth usage for this bandwidth pool for the current billing cycle is projected to exceed the allocation. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getProjectedPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getProjectedPublicBandwidthUsage.md index bdc41a3203..2bd3e8ea5d 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getProjectedPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getProjectedPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getProjectedPublicBandwidthUsage + Retrieve the projected public outbound bandwidth for this virtual server for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getServiceProvider.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getServiceProvider.md index 7b76996890..393d6c037a 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getServiceProvider.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getServiceProvider.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getTotalBandwidthAllocated.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getTotalBandwidthAllocated.md index 2ab3834dcb..fba728189a 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getTotalBandwidthAllocated.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getTotalBandwidthAllocated.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getTotalBandwidthAllocated + Retrieve the combined allocated bandwidth for all servers in a virtual rack. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getVdrMemberRecurringFee.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getVdrMemberRecurringFee.md index 0cf0c189b7..fd73f400e8 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getVdrMemberRecurringFee.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getVdrMemberRecurringFee.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getVdrMemberRecurringFee + Gets the monthly recurring fee of a pooled server. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getVirtualGuests.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getVirtualGuests.md index 5920daef04..afbab9ebd5 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getVirtualGuests.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::getVirtualGuests + Retrieve the Virtual Server contained within a virtual rack. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/reassignServers.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/reassignServers.md index 41a703ee9e..75b53582c6 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/reassignServers.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/reassignServers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::reassignServers + reassign a collection of servers to a different allotment. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/requestVdrCancellation.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/requestVdrCancellation.md index 6632f6e2a9..aea478fbbc 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/requestVdrCancellation.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/requestVdrCancellation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::requestVdrCancellation + cancel a bandwidth pooling and assign contents, if any, to bandwidth pool. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/requestVdrContentUpdates.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/requestVdrContentUpdates.md index 66e48663ef..0baf15b709 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/requestVdrContentUpdates.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/requestVdrContentUpdates.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::requestVdrContentUpdates + Move servers into our out of a bandwidth pool. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/setVdrContent.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/setVdrContent.md index 79ae51d6cb..45718e4bd1 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/setVdrContent.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/setVdrContent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::setVdrContent + Update bandwidth pool. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/unassignServers.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/unassignServers.md index 44d8912fa8..c10aa9302f 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/unassignServers.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/unassignServers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::unassignServers + unassign a collection of servers from an allotment and insert them into the accounts VPR. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/voidPendingServerMove.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/voidPendingServerMove.md index 1a4460f570..e0758acb35 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/voidPendingServerMove.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/voidPendingServerMove.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::voidPendingServerMove + Void a pending server removal from this bandwidth pooling. diff --git a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/voidPendingVdrCancellation.md b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/voidPendingVdrCancellation.md index 8422311790..251c1a51dc 100644 --- a/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/voidPendingVdrCancellation.md +++ b/content/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/voidPendingVdrCancellation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Bandwidth_Version1_Allotment](/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment)::voidPendingVdrCancellation + Void a pending cancellation on a bandwidth pool. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/_index.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/_index.md index 4494e3425e..0d5323fd62 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/_index.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + The SoftLayer_Network_CdnMarketplace_Account service allows customers to create, and delete CDN accounts. A SoftLayer_Network_CdnMarketplace_Account record is created when the customer configures a CDN account for the first time. A customer will be able to create multiple CDN accounts, but each account will be bound to a single vendor. @@ -42,24 +44,28 @@ The SoftLayer_Network_CdnMarketplace_Account service allows customers to create, #### [getAccount](/reference/services/SoftLayer_Network_CdnMarketplace_Account/getAccount) Retrieve softLayer account to which the CDN account belongs. +
              #### [getBillingItem](/reference/services/SoftLayer_Network_CdnMarketplace_Account/getBillingItem) Retrieve an associated parent billing item which is active. +
              #### [getObject](/reference/services/SoftLayer_Network_CdnMarketplace_Account/getObject) Retrieve a SoftLayer_Network_CdnMarketplace_Account record. +
              #### [verifyCdnAccountExists](/reference/services/SoftLayer_Network_CdnMarketplace_Account/verifyCdnAccountExists) Wrapper for UI to verify whether or not an account exists for user under specified vendor. Returns true if account exists, else false. +
              diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/getAccount.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/getAccount.md index f7b223bc96..5f98ff2219 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/getAccount.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Account](/reference/services/SoftLayer_Network_CdnMarketplace_Account)::getAccount + Retrieve softLayer account to which the CDN account belongs. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/getBillingItem.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/getBillingItem.md index 70e158f447..3452a921ea 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Account](/reference/services/SoftLayer_Network_CdnMarketplace_Account)::getBillingItem + Retrieve an associated parent billing item which is active. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/getObject.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/getObject.md index efbb0b56cb..c4d5555278 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/getObject.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Account](/reference/services/SoftLayer_Network_CdnMarketplace_Account)::getObject + Retrieve a SoftLayer_Network_CdnMarketplace_Account record. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/verifyCdnAccountExists.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/verifyCdnAccountExists.md index 2ff3a6621e..302051bf4b 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/verifyCdnAccountExists.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/verifyCdnAccountExists.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Account](/reference/services/SoftLayer_Network_CdnMarketplace_Account)::verifyCdnAccountExists + Wrapper for UI to verify whether or not an account exists for user under specified vendor. Returns true if account exists, else false. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/_index.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/_index.md index dd8e54c0f5..ba61bef94e 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/_index.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,36 +44,42 @@ classes: #### [createGeoblocking](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/createGeoblocking) +
              #### [deleteGeoblocking](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/deleteGeoblocking) +
              #### [getGeoblocking](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblocking) +
              #### [getGeoblockingAllowedTypesAndRegions](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblockingAllowedTypesAndRegions) +
              #### [getObject](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getObject) Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking record. +
              #### [updateGeoblocking](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/updateGeoblocking) +
              diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/createGeoblocking.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/createGeoblocking.md index 002fcb8947..f7cccd66ab 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/createGeoblocking.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/createGeoblocking.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/deleteGeoblocking.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/deleteGeoblocking.md index 27c45ac4b8..6b3b3d4db7 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/deleteGeoblocking.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/deleteGeoblocking.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblocking.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblocking.md index cc2dcf4890..69baa02c7e 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblocking.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblocking.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblockingAllowedTypesAndRegions.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblockingAllowedTypesAndRegions.md index fdda69ae3c..ba46667584 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblockingAllowedTypesAndRegions.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblockingAllowedTypesAndRegions.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getObject.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getObject.md index 896508c59e..4a54a3fcfc 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getObject.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking)::getObject + Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking record. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/updateGeoblocking.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/updateGeoblocking.md index 3f354a4981..0661533b0f 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/updateGeoblocking.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/updateGeoblocking.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/_index.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/_index.md index ac24f5d0be..48a5640d6f 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/_index.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,30 +44,35 @@ classes: #### [createHotlinkProtection](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/createHotlinkProtection) +
              #### [deleteHotlinkProtection](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/deleteHotlinkProtection) +
              #### [getHotlinkProtection](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getHotlinkProtection) +
              #### [getObject](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getObject) Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection record. +
              #### [updateHotlinkProtection](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/updateHotlinkProtection) +
              diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/createHotlinkProtection.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/createHotlinkProtection.md index cb25709f17..f2c03201a5 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/createHotlinkProtection.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/createHotlinkProtection.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/deleteHotlinkProtection.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/deleteHotlinkProtection.md index 8fab1af10f..84b7c2c7d8 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/deleteHotlinkProtection.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/deleteHotlinkProtection.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getHotlinkProtection.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getHotlinkProtection.md index e286919eac..abf67364ec 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getHotlinkProtection.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getHotlinkProtection.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getObject.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getObject.md index a0cc373717..c7eef38a6d 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getObject.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection)::getObject + Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection record. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/updateHotlinkProtection.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/updateHotlinkProtection.md index 24d898b3f0..eb44ab6183 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/updateHotlinkProtection.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/updateHotlinkProtection.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/_index.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/_index.md index 920c00a20e..c986455fed 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/_index.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This service manages the modify response headers for domain mapping configurations. @@ -42,30 +44,35 @@ This service manages the modify response headers for domain mapping configuratio #### [createModifyResponseHeader](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/createModifyResponseHeader) SOAP API will create modify response header for an existing CDN mapping and for a particular customer. +
              #### [deleteModifyResponseHeader](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/deleteModifyResponseHeader) SOAP API will delete modify response header for an existing mapping and for a particular customer. +
              #### [getObject](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/getObject) Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader record. +
              #### [listModifyResponseHeader](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/listModifyResponseHeader) SOAP API will list modify response headers for an existing mapping and for a particular customer. +
              #### [updateModifyResponseHeader](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/updateModifyResponseHeader) SOAP API will update modify response header for an existing mapping and for a particular customer. +
              diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/createModifyResponseHeader.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/createModifyResponseHeader.md index 9272d8e06b..5930a7b90b 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/createModifyResponseHeader.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/createModifyResponseHeader.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader)::createModifyResponseHeader + SOAP API will create modify response header for an existing CDN mapping and for a particular customer. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/deleteModifyResponseHeader.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/deleteModifyResponseHeader.md index 81aeb90f8d..c27c25a307 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/deleteModifyResponseHeader.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/deleteModifyResponseHeader.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader)::deleteModifyResponseHeader + SOAP API will delete modify response header for an existing mapping and for a particular customer. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/getObject.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/getObject.md index 40e27c90a6..8ec28a829e 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/getObject.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader)::getObject + Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader record. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/listModifyResponseHeader.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/listModifyResponseHeader.md index 82828e5f7f..ffdb1ebdef 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/listModifyResponseHeader.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/listModifyResponseHeader.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader)::listModifyResponseHeader + SOAP API will list modify response headers for an existing mapping and for a particular customer. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/updateModifyResponseHeader.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/updateModifyResponseHeader.md index d3c26a085d..c8c1c60b46 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/updateModifyResponseHeader.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/updateModifyResponseHeader.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader)::updateModifyResponseHeader + SOAP API will update modify response header for an existing mapping and for a particular customer. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/_index.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/_index.md index 065abe6177..881fe6fddc 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/_index.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This service manages the paths for domain mapping configurations. @@ -42,30 +44,35 @@ This service manages the paths for domain mapping configurations. #### [createTokenAuthPath](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/createTokenAuthPath) SOAP API will create Token authentication Path for an existing CDN mapping and for a particular customer. +
              #### [deleteTokenAuthPath](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/deleteTokenAuthPath) SOAP API will delete token authentication Path for an existing mapping and for a particular customer. +
              #### [getObject](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/getObject) Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth record. +
              #### [listTokenAuthPath](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/listTokenAuthPath) SOAP API will list token authentication paths for an existing mapping and for a particular customer. +
              #### [updateTokenAuthPath](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/updateTokenAuthPath) SOAP API will update Token authentication Path for an existing mapping and for a particular customer. +
              diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/createTokenAuthPath.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/createTokenAuthPath.md index b02f8ecb2c..7d9a4fb248 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/createTokenAuthPath.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/createTokenAuthPath.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth)::createTokenAuthPath + SOAP API will create Token authentication Path for an existing CDN mapping and for a particular customer. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/deleteTokenAuthPath.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/deleteTokenAuthPath.md index 605a03c72f..767a006d01 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/deleteTokenAuthPath.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/deleteTokenAuthPath.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth)::deleteTokenAuthPath + SOAP API will delete token authentication Path for an existing mapping and for a particular customer. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/getObject.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/getObject.md index b752c292cd..4e27e3341f 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/getObject.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth)::getObject + Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth record. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/listTokenAuthPath.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/listTokenAuthPath.md index 89692656df..154b5a1ae0 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/listTokenAuthPath.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/listTokenAuthPath.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth)::listTokenAuthPath + SOAP API will list token authentication paths for an existing mapping and for a particular customer. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/updateTokenAuthPath.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/updateTokenAuthPath.md index f4b9aaaf68..886129186b 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/updateTokenAuthPath.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/updateTokenAuthPath.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth)::updateTokenAuthPath + SOAP API will update Token authentication Path for an existing mapping and for a particular customer. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/_index.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/_index.md index 6bc9b55f42..ba7d3790be 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/_index.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This service manages purges associated with a CDN mapping Configuration. @@ -42,30 +44,35 @@ This service manages purges associated with a CDN mapping Configuration. #### [createPurge](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/createPurge) This method creates a purge record in the purge table, and also initiates the create purge call. +
              #### [getObject](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getObject) Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge record. +
              #### [getPurgeHistoryPerMapping](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeHistoryPerMapping) This method returns the purge history for a given domain and CDN account. +
              #### [getPurgeStatus](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeStatus) This method gets the status of a given purge path. +
              #### [saveOrUnsavePurgePath](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/saveOrUnsavePurgePath) Creates a new saved purge if a purge path is saved. Deletes a saved purge record if the path is unsaved. +
              diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/createPurge.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/createPurge.md index 3b64dd146c..b0ba384a5b 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/createPurge.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/createPurge.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge)::createPurge + This method creates a purge record in the purge table, and also initiates the create purge call. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getObject.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getObject.md index 1b98054a37..03bff67eb8 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getObject.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge)::getObject + Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge record. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeHistoryPerMapping.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeHistoryPerMapping.md index b224df98ad..a6be246f13 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeHistoryPerMapping.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeHistoryPerMapping.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge)::getPurgeHistoryPerMapping + This method returns the purge history for a given domain and CDN account. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeStatus.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeStatus.md index ff22f4c9c2..a78dd2130b 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeStatus.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge)::getPurgeStatus + This method gets the status of a given purge path. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/saveOrUnsavePurgePath.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/saveOrUnsavePurgePath.md index b9e0239ef5..d4fd8c966e 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/saveOrUnsavePurgePath.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/saveOrUnsavePurgePath.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge)::saveOrUnsavePurgePath + Creates a new saved purge if a purge path is saved. Deletes a saved purge record if the path is unsaved. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/_index.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/_index.md index 1ea260fc83..7e7074b074 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/_index.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This service manages purge group associated with a CDN mapping Configuration. @@ -42,54 +44,63 @@ This service manages purge group associated with a CDN mapping Configuration. #### [createPurgeGroup](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/createPurgeGroup) This method creates a purge group record in the table, and also initiates the purge action based on the input option value. The unsaved groups will be deleted after 15 days if no purge actions executed. The possible input option value can be: 1: (Default) Only purge the paths in the group, don't save the group as favorite. 2: Only save the group as favorite, don't purge the paths. 3: Save the group as favorite and also purge the paths in the group. +
              #### [getObject](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getObject) Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup record. +
              #### [getPurgeGroupByGroupId](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupByGroupId) This method returns the purge group for a given domain and group ID. +
              #### [getPurgeGroupQuota](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupQuota) This method gets a purge group quota. +
              #### [listFavoriteGroup](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listFavoriteGroup) This method returns the list of favorite purge groups. +
              #### [listUnfavoriteGroup](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listUnfavoriteGroup) This method returns the list of unsaved purge groups. +
              #### [purgeByGroupIds](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/purgeByGroupIds) This method purges the content from purge groups. +
              #### [removePurgeGroupFromFavorite](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/removePurgeGroupFromFavorite) This method removes a purge group from favorite. +
              #### [savePurgeGroupAsFavorite](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/savePurgeGroupAsFavorite) This method saves a purge group as favorite. +
              diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/createPurgeGroup.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/createPurgeGroup.md index ef319f5787..e0d13c0c30 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/createPurgeGroup.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/createPurgeGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup)::createPurgeGroup + This method creates a purge group record in the table, and also initiates the purge action based on the input option value. The unsaved groups will be deleted after 15 days if no purge actions executed. The possible input option value can be: 1: (Default) Only purge the paths in the group, don't save the group as favorite. 2: Only save the group as favorite, don't purge the paths. 3: Save the group as favorite and also purge the paths in the group. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getObject.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getObject.md index c36e104c9d..f21bd3a1a1 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getObject.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup)::getObject + Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup record. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupByGroupId.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupByGroupId.md index 9263e31c61..25c6dcf686 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupByGroupId.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupByGroupId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup)::getPurgeGroupByGroupId + This method returns the purge group for a given domain and group ID. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupQuota.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupQuota.md index 0b5294ba36..3743a1e7ce 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupQuota.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupQuota.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup)::getPurgeGroupQuota + This method gets a purge group quota. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listFavoriteGroup.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listFavoriteGroup.md index c1feff4ee5..c0b8aaf26a 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listFavoriteGroup.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listFavoriteGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup)::listFavoriteGroup + This method returns the list of favorite purge groups. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listUnfavoriteGroup.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listUnfavoriteGroup.md index 475778da34..896fab0080 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listUnfavoriteGroup.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listUnfavoriteGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup)::listUnfavoriteGroup + This method returns the list of unsaved purge groups. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/purgeByGroupIds.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/purgeByGroupIds.md index 445b24decc..40e5919e28 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/purgeByGroupIds.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/purgeByGroupIds.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup)::purgeByGroupIds + This method purges the content from purge groups. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/removePurgeGroupFromFavorite.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/removePurgeGroupFromFavorite.md index 7cf45ffcfd..ad167be599 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/removePurgeGroupFromFavorite.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/removePurgeGroupFromFavorite.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup)::removePurgeGroupFromFavorite + This method removes a purge group from favorite. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/savePurgeGroupAsFavorite.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/savePurgeGroupAsFavorite.md index fe6999bf80..5f8e4622e4 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/savePurgeGroupAsFavorite.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/savePurgeGroupAsFavorite.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup)::savePurgeGroupAsFavorite + This method saves a purge group as favorite. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/_index.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/_index.md index 89c6c94246..901587e75c 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/_index.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This service manages purge history associated with a CDN mapping Configuration. @@ -42,12 +44,14 @@ This service manages purge history associated with a CDN mapping Configuration. #### [getObject](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/getObject) Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory record. +
              #### [listPurgeGroupHistory](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/listPurgeGroupHistory) This method returns the list of purge group histories +
              diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/getObject.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/getObject.md index bc423fd3b6..e09dcb0be9 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/getObject.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory)::getObject + Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory record. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/listPurgeGroupHistory.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/listPurgeGroupHistory.md index 3891c70f0a..364aa37d1f 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/listPurgeGroupHistory.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/listPurgeGroupHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory)::listPurgeGroupHistory + This method returns the list of purge group histories diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/_index.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/_index.md index b67eb2f404..3d95596c8e 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/_index.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This service manages Times To Live (TTLs) associated with a CDN mapping Configuration. A time to live represents the time a purge will occur at a given path. @@ -42,30 +44,35 @@ This service manages Times To Live (TTLs) associated with a CDN mapping Configur #### [createTimeToLive](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/createTimeToLive) Creates a Time To Live object and inserts it into the database +
              #### [deleteTimeToLive](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/deleteTimeToLive) +
              #### [getObject](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/getObject) Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive record. +
              #### [listTimeToLive](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/listTimeToLive) +
              #### [updateTimeToLive](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/updateTimeToLive) Updates an existing Time To Live object. If the old and new inputs are equal, exits early. +
              diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/createTimeToLive.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/createTimeToLive.md index d23176e052..0543262b66 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/createTimeToLive.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/createTimeToLive.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive)::createTimeToLive + Creates a Time To Live object and inserts it into the database diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/deleteTimeToLive.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/deleteTimeToLive.md index 74c4c5b5aa..3d2dfc6885 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/deleteTimeToLive.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/deleteTimeToLive.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/getObject.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/getObject.md index 89bdadb268..2228b9b8d6 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/getObject.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive)::getObject + Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive record. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/listTimeToLive.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/listTimeToLive.md index d708b837ff..fde257aba2 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/listTimeToLive.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/listTimeToLive.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/updateTimeToLive.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/updateTimeToLive.md index c40f78566c..841f998d54 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/updateTimeToLive.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/updateTimeToLive.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive)::updateTimeToLive + Updates an existing Time To Live object. If the old and new inputs are equal, exits early. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/_index.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/_index.md index 1b653e6c0b..b062694de4 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/_index.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This service manages domain mapping configurations for enabling CDN services. @@ -42,48 +44,56 @@ This service manages domain mapping configurations for enabling CDN services. #### [createDomainMapping](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/createDomainMapping) SOAP API will create a new CDN domain mapping for a particular customer. +
              #### [deleteDomainMapping](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/deleteDomainMapping) SOAP API will delete CDN domain mapping for a particular customer. +
              #### [getObject](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/getObject) Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Mapping record. +
              #### [listDomainMappingByUniqueId](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappingByUniqueId) SOAP API will return the domain mapping based on the uniqueId. +
              #### [listDomainMappings](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappings) SOAP API will return all domains for a particular customer. +
              #### [retryHttpsActionRequest](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/retryHttpsActionRequest) For specific mappings in HTTPS-related error states, this SOAP API will determine whether it needs to re-attempt an enable or disable HTTPS. +
              #### [startDomainMapping](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/startDomainMapping) SOAP API will start CDN domain mapping for a particular customer. +
              #### [stopDomainMapping](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/stopDomainMapping) SOAP API will stop CDN mapping for a particular customer. +
              @@ -92,18 +102,21 @@ SOAP API will stop CDN mapping for a particular customer. SOAP API will update the Domain Mapping identified by the Unique Id. Following fields are allowed to be changed: originHost, HttpPort/HttpsPort, RespectHeaders, ServeStale Additionally, bucketName and fileExtension if OriginType is Object Store +
              #### [verifyCname](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyCname) This method will verify the CNAME given is unique. +
              #### [verifyDomainMapping](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyDomainMapping) This method will verify the status of a domain mapping +
              diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/createDomainMapping.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/createDomainMapping.md index 9264c5a571..f338cdb61b 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/createDomainMapping.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/createDomainMapping.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Mapping](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping)::createDomainMapping + SOAP API will create a new CDN domain mapping for a particular customer. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/deleteDomainMapping.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/deleteDomainMapping.md index c567586e82..1dbb969671 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/deleteDomainMapping.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/deleteDomainMapping.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Mapping](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping)::deleteDomainMapping + SOAP API will delete CDN domain mapping for a particular customer. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/getObject.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/getObject.md index c5db66751b..3026ce115c 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/getObject.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Mapping](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping)::getObject + Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Mapping record. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappingByUniqueId.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappingByUniqueId.md index c20004a4a2..19eff00a3d 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappingByUniqueId.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappingByUniqueId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Mapping](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping)::listDomainMappingByUniqueId + SOAP API will return the domain mapping based on the uniqueId. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappings.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappings.md index d7dbef388d..116347b8a5 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappings.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Mapping](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping)::listDomainMappings + SOAP API will return all domains for a particular customer. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/retryHttpsActionRequest.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/retryHttpsActionRequest.md index f976e936f3..527cb2189d 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/retryHttpsActionRequest.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/retryHttpsActionRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Mapping](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping)::retryHttpsActionRequest + For specific mappings in HTTPS-related error states, this SOAP API will determine whether it needs to re-attempt an enable or disable HTTPS. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/startDomainMapping.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/startDomainMapping.md index 564a03c591..426bd048e5 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/startDomainMapping.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/startDomainMapping.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Mapping](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping)::startDomainMapping + SOAP API will start CDN domain mapping for a particular customer. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/stopDomainMapping.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/stopDomainMapping.md index eda2ae0cb1..d2debb0081 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/stopDomainMapping.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/stopDomainMapping.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Mapping](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping)::stopDomainMapping + SOAP API will stop CDN mapping for a particular customer. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/updateDomainMapping.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/updateDomainMapping.md index b0234388c2..18421181d7 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/updateDomainMapping.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/updateDomainMapping.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Mapping](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping)::updateDomainMapping + SOAP API will update the Domain Mapping identified by the Unique Id. Following fields are allowed to be changed: originHost, HttpPort/HttpsPort, RespectHeaders, ServeStale Additionally, bucketName and fileExtension if OriginType is Object Store diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyCname.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyCname.md index 5832ea58ff..09a8fc7720 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyCname.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyCname.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Mapping](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping)::verifyCname + This method will verify the CNAME given is unique. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyDomainMapping.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyDomainMapping.md index 8642259f93..b41d472068 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyDomainMapping.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyDomainMapping.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Mapping](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping)::verifyDomainMapping + This method will verify the status of a domain mapping diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/_index.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/_index.md index c49ce5e183..d0012e7b47 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/_index.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This service manages the paths for domain mapping configurations. @@ -42,24 +44,28 @@ This service manages the paths for domain mapping configurations. #### [createOriginPath](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/createOriginPath) SOAP API will create Origin Path for an existing CDN mapping and for a particular customer. +
              #### [deleteOriginPath](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/deleteOriginPath) SOAP API will delete Origin Path for an existing mapping and for a particular customer. +
              #### [getObject](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/getObject) Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path record. +
              #### [listOriginPath](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/listOriginPath) SOAP API will list origin path for an existing mapping and for a particular customer. +
              @@ -70,6 +76,7 @@ SOAP API will update Origin Path for an existing mapping and for a particular cu When passing the $input object as a parameter, it will expect the following properties to be set: $oldPath $uniqueId $originType, $path, $origin, $httpPort, $httpsPort, and if the path's origin type is object storage, the $bucketName and the $fileExtension. Out of the properties listed above only the following path properties are allowed to be changed: $path, $origin, $httpPort, $httpsPort These properties may not be changed: $originType +
              diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/createOriginPath.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/createOriginPath.md index 62494acf9d..bba0608256 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/createOriginPath.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/createOriginPath.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path)::createOriginPath + SOAP API will create Origin Path for an existing CDN mapping and for a particular customer. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/deleteOriginPath.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/deleteOriginPath.md index a0044f456b..99e9426515 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/deleteOriginPath.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/deleteOriginPath.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path)::deleteOriginPath + SOAP API will delete Origin Path for an existing mapping and for a particular customer. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/getObject.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/getObject.md index ca0f59c0c4..e38952bb87 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/getObject.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path)::getObject + Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path record. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/listOriginPath.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/listOriginPath.md index 193c038bde..f9d83d4401 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/listOriginPath.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/listOriginPath.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path)::listOriginPath + SOAP API will list origin path for an existing mapping and for a particular customer. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/updateOriginPath.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/updateOriginPath.md index 9d3c2d79b1..e856b66b91 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/updateOriginPath.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/updateOriginPath.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path](/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path)::updateOriginPath + SOAP API will update Origin Path for an existing mapping and for a particular customer. When passing the $input object as a parameter, it will expect the following properties to be set: $oldPath $uniqueId $originType, $path, $origin, $httpPort, $httpsPort, and if the path's origin type is object storage, the $bucketName and the $fileExtension. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/_index.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/_index.md index 0475d81e1e..4cf576bc87 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/_index.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This Service class will describe in detail each Simple Object Access Protocol (SOAP) API call used in the Content Delivery Network (CDN) metrics. These APIs will allow callers to collect metrics for the CDN service. @@ -42,60 +44,70 @@ This Service class will describe in detail each Simple Object Access Protocol (S #### [getCustomerInvoicingMetrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerInvoicingMetrics) Get the static & dynamic bandwidth and mapping hits of predetermined statistics for direct display (no graph) for a customer's account over a given period of time. Frequency can be 'day', 'aggregate'. If the value 'day' is specified for Frequency, return data will be ordered based on startDate to endDate, and if the value 'aggregate' is specified for Frequency, aggregated data from startDate to endDate will be returned. There is a delay within 3 days(including today) for fetching the metrics data. +
              #### [getCustomerRealTimeMetrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerRealTimeMetrics) Get the realtime metrics data for the current account. Takes the startTime and endTime and returns the total metrics data and line graph metrics data divided by the timeInterval. +
              #### [getCustomerUsageMetrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerUsageMetrics) Get the total number of predetermined statistics for direct display (no graph) for a customer's account over a given period of time +
              #### [getMappingBandwidthByRegionMetrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthByRegionMetrics) Get the total number of predetermined statistics for direct display (no graph) for a customer's account over a given period of time +
              #### [getMappingBandwidthMetrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthMetrics) Get the amount of edge hits for an individual mapping. +
              #### [getMappingHitsByTypeMetrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsByTypeMetrics) Get the total number of hits at a certain frequency over a given range of time. Frequency can be day, week, and month where each interval is one plot point for a graph. Return Data must be ordered based on startDate, endDate and frequency +
              #### [getMappingHitsMetrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsMetrics) Get the total number of hits at a certain frequency over a given range of time per domain mapping. Frequency can be day, week, and month where each interval is one plot point for a graph. Return Data will be ordered based on startDate, endDate and frequency. +
              #### [getMappingIntegratedMetrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingIntegratedMetrics) Get the integrated metrics data for the given mapping. You can get the the hits, bandwidth, hits by type and bandwidth by region. It will return both the total data and the detail data. +
              #### [getMappingRealTimeMetrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingRealTimeMetrics) Get the real time metrics data for the given mapping +
              #### [getMappingUsageMetrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingUsageMetrics) Get the total number of predetermined statistics for direct display for the given mapping +
              diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerInvoicingMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerInvoicingMetrics.md index d702c52a55..a62379828e 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerInvoicingMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerInvoicingMetrics.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Metrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics)::getCustomerInvoicingMetrics + Get the static & dynamic bandwidth and mapping hits of predetermined statistics for direct display (no graph) for a customer's account over a given period of time. Frequency can be 'day', 'aggregate'. If the value 'day' is specified for Frequency, return data will be ordered based on startDate to endDate, and if the value 'aggregate' is specified for Frequency, aggregated data from startDate to endDate will be returned. There is a delay within 3 days(including today) for fetching the metrics data. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerRealTimeMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerRealTimeMetrics.md index cf6114dd68..0b9982f5e7 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerRealTimeMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerRealTimeMetrics.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Metrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics)::getCustomerRealTimeMetrics + Get the realtime metrics data for the current account. Takes the startTime and endTime and returns the total metrics data and line graph metrics data divided by the timeInterval. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerUsageMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerUsageMetrics.md index ff100b9016..fa761dee28 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerUsageMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerUsageMetrics.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Metrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics)::getCustomerUsageMetrics + Get the total number of predetermined statistics for direct display (no graph) for a customer's account over a given period of time diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthByRegionMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthByRegionMetrics.md index d90ff23d47..5b145f736b 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthByRegionMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthByRegionMetrics.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Metrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics)::getMappingBandwidthByRegionMetrics + Get the total number of predetermined statistics for direct display (no graph) for a customer's account over a given period of time diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthMetrics.md index 7ad02a4359..8f5f5e30c4 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthMetrics.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Metrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics)::getMappingBandwidthMetrics + Get the amount of edge hits for an individual mapping. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsByTypeMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsByTypeMetrics.md index 23e458a2a1..bacb8b9ac1 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsByTypeMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsByTypeMetrics.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Metrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics)::getMappingHitsByTypeMetrics + Get the total number of hits at a certain frequency over a given range of time. Frequency can be day, week, and month where each interval is one plot point for a graph. Return Data must be ordered based on startDate, endDate and frequency diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsMetrics.md index 0a4912ce28..fd36c1d428 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsMetrics.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Metrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics)::getMappingHitsMetrics + Get the total number of hits at a certain frequency over a given range of time per domain mapping. Frequency can be day, week, and month where each interval is one plot point for a graph. Return Data will be ordered based on startDate, endDate and frequency. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingIntegratedMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingIntegratedMetrics.md index 94ffd19909..b6e817a898 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingIntegratedMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingIntegratedMetrics.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Metrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics)::getMappingIntegratedMetrics + Get the integrated metrics data for the given mapping. You can get the the hits, bandwidth, hits by type and bandwidth by region. It will return both the total data and the detail data. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingRealTimeMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingRealTimeMetrics.md index 18b19a053d..05ca70850a 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingRealTimeMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingRealTimeMetrics.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Metrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics)::getMappingRealTimeMetrics + Get the real time metrics data for the given mapping diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingUsageMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingUsageMetrics.md index 80a7c93976..98e87602c7 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingUsageMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingUsageMetrics.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Metrics](/reference/services/SoftLayer_Network_CdnMarketplace_Metrics)::getMappingUsageMetrics + Get the total number of predetermined statistics for direct display for the given mapping diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/_index.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/_index.md index bdba2d68a0..154dc2c9d6 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/_index.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This service allows internal users to create, read, update, and delete
 vendor instances. @@ -42,12 +44,14 @@ This service allows internal users to create, read, update, and delete
 vendor #### [getObject](/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/getObject) Retrieve a SoftLayer_Network_CdnMarketplace_Vendor record. +
              #### [listVendors](/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/listVendors) SOAP API will return all CDN vendors available. +
              diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/getObject.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/getObject.md index b9a6260a66..ac690066a4 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/getObject.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Vendor](/reference/services/SoftLayer_Network_CdnMarketplace_Vendor)::getObject + Retrieve a SoftLayer_Network_CdnMarketplace_Vendor record. diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/listVendors.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/listVendors.md index ce1ee0a3de..8c2f45617e 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/listVendors.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/listVendors.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_CdnMarketplace_Vendor](/reference/services/SoftLayer_Network_CdnMarketplace_Vendor)::listVendors + SOAP API will return all CDN vendors available. diff --git a/content/reference/services/SoftLayer_Network_Component/_index.md b/content/reference/services/SoftLayer_Network_Component/_index.md index 9c71044f0d..66928b9b2e 100644 --- a/content/reference/services/SoftLayer_Network_Component/_index.md +++ b/content/reference/services/SoftLayer_Network_Component/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,198 +44,234 @@ classes: #### [addNetworkVlanTrunks](/reference/services/SoftLayer_Network_Component/addNetworkVlanTrunks) Add VLAN trunks to network component +
              #### [clearNetworkVlanTrunks](/reference/services/SoftLayer_Network_Component/clearNetworkVlanTrunks) Remove all VLANs trunked to this port. +
              #### [getActiveCommand](/reference/services/SoftLayer_Network_Component/getActiveCommand) Retrieve reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command currently executing by the server's remote management card. +
              #### [getCustomBandwidthDataByDate](/reference/services/SoftLayer_Network_Component/getCustomBandwidthDataByDate) Retrieve bandwidth graph by date. +
              #### [getDownlinkComponent](/reference/services/SoftLayer_Network_Component/getDownlinkComponent) Retrieve the network component linking this object to a child device +
              #### [getDuplexMode](/reference/services/SoftLayer_Network_Component/getDuplexMode) Retrieve the duplex mode of a network component. +
              #### [getHardware](/reference/services/SoftLayer_Network_Component/getHardware) Retrieve the hardware that a network component resides in. +
              #### [getHighAvailabilityFirewallFlag](/reference/services/SoftLayer_Network_Component/getHighAvailabilityFirewallFlag) +
              #### [getInterface](/reference/services/SoftLayer_Network_Component/getInterface) Retrieve [DEPRECATED] A hardware switch's interface to the bandwidth pod. +
              #### [getIpAddressBindings](/reference/services/SoftLayer_Network_Component/getIpAddressBindings) Retrieve the records of all IP addresses bound to a network component. +
              #### [getIpAddresses](/reference/services/SoftLayer_Network_Component/getIpAddresses) +
              #### [getLastCommand](/reference/services/SoftLayer_Network_Component/getLastCommand) Retrieve last reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command issued to the server's remote management card. +
              #### [getMetricTrackingObject](/reference/services/SoftLayer_Network_Component/getMetricTrackingObject) Retrieve the metric tracking object for this network component. +
              #### [getNetworkComponentFirewall](/reference/services/SoftLayer_Network_Component/getNetworkComponentFirewall) Retrieve the upstream network component firewall. +
              #### [getNetworkComponentGroup](/reference/services/SoftLayer_Network_Component/getNetworkComponentGroup) Retrieve a network component's associated group. +
              #### [getNetworkHardware](/reference/services/SoftLayer_Network_Component/getNetworkHardware) Retrieve all network devices in SoftLayer's network hierarchy that this device is connected to. +
              #### [getNetworkVlan](/reference/services/SoftLayer_Network_Component/getNetworkVlan) Retrieve the VLAN that a network component's subnet is associated with. +
              #### [getNetworkVlanTrunks](/reference/services/SoftLayer_Network_Component/getNetworkVlanTrunks) Retrieve the VLANs that are trunked to this network component. +
              #### [getObject](/reference/services/SoftLayer_Network_Component/getObject) Retrieve a SoftLayer_Network_Component record. +
              -
              +
              #### [getPortStatistics](/reference/services/SoftLayer_Network_Component/getPortStatistics) Retrieve various network statistics for the specific port. + +Deprecated + +
              #### [getPrimaryIpAddressRecord](/reference/services/SoftLayer_Network_Component/getPrimaryIpAddressRecord) Retrieve the primary IPv4 Address record for a network component. +
              #### [getPrimarySubnet](/reference/services/SoftLayer_Network_Component/getPrimarySubnet) Retrieve the subnet of the primary IP address assigned to this network component. +
              #### [getPrimaryVersion6IpAddressRecord](/reference/services/SoftLayer_Network_Component/getPrimaryVersion6IpAddressRecord) Retrieve the primary IPv6 Address record for a network component. +
              #### [getRecentCommands](/reference/services/SoftLayer_Network_Component/getRecentCommands) Retrieve the last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card. +
              #### [getRedundancyCapableFlag](/reference/services/SoftLayer_Network_Component/getRedundancyCapableFlag) Retrieve indicates whether the network component is participating in a group of two or more components capable of being operationally redundant, if enabled. +
              #### [getRedundancyEnabledFlag](/reference/services/SoftLayer_Network_Component/getRedundancyEnabledFlag) Retrieve indicates whether the network component is participating in a group of two or more components which is actively providing link redundancy. +
              #### [getRemoteManagementUsers](/reference/services/SoftLayer_Network_Component/getRemoteManagementUsers) Retrieve user(s) credentials to issue commands and/or interact with the server's remote management card. +
              #### [getRouter](/reference/services/SoftLayer_Network_Component/getRouter) Retrieve a network component's routers. +
              #### [getStorageNetworkFlag](/reference/services/SoftLayer_Network_Component/getStorageNetworkFlag) Retrieve whether a network component's primary ip address is from a storage network subnet or not. [Deprecated] +
              #### [getSubnets](/reference/services/SoftLayer_Network_Component/getSubnets) Retrieve a network component's subnets. A subnet is a group of IP addresses +
              #### [getUplinkComponent](/reference/services/SoftLayer_Network_Component/getUplinkComponent) Retrieve the network component linking this object to parent +
              #### [getUplinkDuplexMode](/reference/services/SoftLayer_Network_Component/getUplinkDuplexMode) Retrieve the duplex mode of the uplink network component linking to this object +
              #### [removeNetworkVlanTrunks](/reference/services/SoftLayer_Network_Component/removeNetworkVlanTrunks) Remove VLAN trunks from a network component +
              diff --git a/content/reference/services/SoftLayer_Network_Component/addNetworkVlanTrunks.md b/content/reference/services/SoftLayer_Network_Component/addNetworkVlanTrunks.md index 356a3983e4..c4f4ccdf35 100644 --- a/content/reference/services/SoftLayer_Network_Component/addNetworkVlanTrunks.md +++ b/content/reference/services/SoftLayer_Network_Component/addNetworkVlanTrunks.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::addNetworkVlanTrunks + Add VLAN trunks to network component diff --git a/content/reference/services/SoftLayer_Network_Component/clearNetworkVlanTrunks.md b/content/reference/services/SoftLayer_Network_Component/clearNetworkVlanTrunks.md index 5f634a0631..06c3d05f53 100644 --- a/content/reference/services/SoftLayer_Network_Component/clearNetworkVlanTrunks.md +++ b/content/reference/services/SoftLayer_Network_Component/clearNetworkVlanTrunks.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::clearNetworkVlanTrunks + Remove all VLANs trunked to this port. diff --git a/content/reference/services/SoftLayer_Network_Component/getActiveCommand.md b/content/reference/services/SoftLayer_Network_Component/getActiveCommand.md index 3cef3e9b62..d5fb0fbeb7 100644 --- a/content/reference/services/SoftLayer_Network_Component/getActiveCommand.md +++ b/content/reference/services/SoftLayer_Network_Component/getActiveCommand.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getActiveCommand + Retrieve reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command currently executing by the server's remote management card. diff --git a/content/reference/services/SoftLayer_Network_Component/getCustomBandwidthDataByDate.md b/content/reference/services/SoftLayer_Network_Component/getCustomBandwidthDataByDate.md index f6f26f861d..7749162245 100644 --- a/content/reference/services/SoftLayer_Network_Component/getCustomBandwidthDataByDate.md +++ b/content/reference/services/SoftLayer_Network_Component/getCustomBandwidthDataByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getCustomBandwidthDataByDate + Retrieve bandwidth graph by date. diff --git a/content/reference/services/SoftLayer_Network_Component/getDownlinkComponent.md b/content/reference/services/SoftLayer_Network_Component/getDownlinkComponent.md index 969fcb1710..21fbce1821 100644 --- a/content/reference/services/SoftLayer_Network_Component/getDownlinkComponent.md +++ b/content/reference/services/SoftLayer_Network_Component/getDownlinkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getDownlinkComponent + Retrieve the network component linking this object to a child device diff --git a/content/reference/services/SoftLayer_Network_Component/getDuplexMode.md b/content/reference/services/SoftLayer_Network_Component/getDuplexMode.md index 8deb11574a..ae1ca51f12 100644 --- a/content/reference/services/SoftLayer_Network_Component/getDuplexMode.md +++ b/content/reference/services/SoftLayer_Network_Component/getDuplexMode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getDuplexMode + Retrieve the duplex mode of a network component. diff --git a/content/reference/services/SoftLayer_Network_Component/getHardware.md b/content/reference/services/SoftLayer_Network_Component/getHardware.md index 1c4acc1dba..7dd4d2231a 100644 --- a/content/reference/services/SoftLayer_Network_Component/getHardware.md +++ b/content/reference/services/SoftLayer_Network_Component/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getHardware + Retrieve the hardware that a network component resides in. diff --git a/content/reference/services/SoftLayer_Network_Component/getHighAvailabilityFirewallFlag.md b/content/reference/services/SoftLayer_Network_Component/getHighAvailabilityFirewallFlag.md index 0ae37f7228..eb8cf719bf 100644 --- a/content/reference/services/SoftLayer_Network_Component/getHighAvailabilityFirewallFlag.md +++ b/content/reference/services/SoftLayer_Network_Component/getHighAvailabilityFirewallFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Component/getInterface.md b/content/reference/services/SoftLayer_Network_Component/getInterface.md index 65a0e58e6b..66fc5b13bf 100644 --- a/content/reference/services/SoftLayer_Network_Component/getInterface.md +++ b/content/reference/services/SoftLayer_Network_Component/getInterface.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getInterface + Retrieve [DEPRECATED] A hardware switch's interface to the bandwidth pod. diff --git a/content/reference/services/SoftLayer_Network_Component/getIpAddressBindings.md b/content/reference/services/SoftLayer_Network_Component/getIpAddressBindings.md index c38a3c6e9d..e8c20a0424 100644 --- a/content/reference/services/SoftLayer_Network_Component/getIpAddressBindings.md +++ b/content/reference/services/SoftLayer_Network_Component/getIpAddressBindings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getIpAddressBindings + Retrieve the records of all IP addresses bound to a network component. diff --git a/content/reference/services/SoftLayer_Network_Component/getIpAddresses.md b/content/reference/services/SoftLayer_Network_Component/getIpAddresses.md index 5ac7919f39..2987f2d22d 100644 --- a/content/reference/services/SoftLayer_Network_Component/getIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Component/getIpAddresses.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Component/getLastCommand.md b/content/reference/services/SoftLayer_Network_Component/getLastCommand.md index 2e047d7956..3c8dce9b65 100644 --- a/content/reference/services/SoftLayer_Network_Component/getLastCommand.md +++ b/content/reference/services/SoftLayer_Network_Component/getLastCommand.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getLastCommand + Retrieve last reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command issued to the server's remote management card. diff --git a/content/reference/services/SoftLayer_Network_Component/getMetricTrackingObject.md b/content/reference/services/SoftLayer_Network_Component/getMetricTrackingObject.md index 459ba6df9d..a0c842a233 100644 --- a/content/reference/services/SoftLayer_Network_Component/getMetricTrackingObject.md +++ b/content/reference/services/SoftLayer_Network_Component/getMetricTrackingObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getMetricTrackingObject + Retrieve the metric tracking object for this network component. diff --git a/content/reference/services/SoftLayer_Network_Component/getNetworkComponentFirewall.md b/content/reference/services/SoftLayer_Network_Component/getNetworkComponentFirewall.md index 369d84e904..673b8c72c3 100644 --- a/content/reference/services/SoftLayer_Network_Component/getNetworkComponentFirewall.md +++ b/content/reference/services/SoftLayer_Network_Component/getNetworkComponentFirewall.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getNetworkComponentFirewall + Retrieve the upstream network component firewall. diff --git a/content/reference/services/SoftLayer_Network_Component/getNetworkComponentGroup.md b/content/reference/services/SoftLayer_Network_Component/getNetworkComponentGroup.md index e4a3aa877d..3ea941922a 100644 --- a/content/reference/services/SoftLayer_Network_Component/getNetworkComponentGroup.md +++ b/content/reference/services/SoftLayer_Network_Component/getNetworkComponentGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getNetworkComponentGroup + Retrieve a network component's associated group. diff --git a/content/reference/services/SoftLayer_Network_Component/getNetworkHardware.md b/content/reference/services/SoftLayer_Network_Component/getNetworkHardware.md index 17692fc20f..4394e37c24 100644 --- a/content/reference/services/SoftLayer_Network_Component/getNetworkHardware.md +++ b/content/reference/services/SoftLayer_Network_Component/getNetworkHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getNetworkHardware + Retrieve all network devices in SoftLayer's network hierarchy that this device is connected to. diff --git a/content/reference/services/SoftLayer_Network_Component/getNetworkVlan.md b/content/reference/services/SoftLayer_Network_Component/getNetworkVlan.md index ab36ed09a8..e4cacd64b2 100644 --- a/content/reference/services/SoftLayer_Network_Component/getNetworkVlan.md +++ b/content/reference/services/SoftLayer_Network_Component/getNetworkVlan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getNetworkVlan + Retrieve the VLAN that a network component's subnet is associated with. diff --git a/content/reference/services/SoftLayer_Network_Component/getNetworkVlanTrunks.md b/content/reference/services/SoftLayer_Network_Component/getNetworkVlanTrunks.md index ab7a7d4352..27c1352ac2 100644 --- a/content/reference/services/SoftLayer_Network_Component/getNetworkVlanTrunks.md +++ b/content/reference/services/SoftLayer_Network_Component/getNetworkVlanTrunks.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getNetworkVlanTrunks + Retrieve the VLANs that are trunked to this network component. diff --git a/content/reference/services/SoftLayer_Network_Component/getObject.md b/content/reference/services/SoftLayer_Network_Component/getObject.md index 89fe23ca73..cb78251162 100644 --- a/content/reference/services/SoftLayer_Network_Component/getObject.md +++ b/content/reference/services/SoftLayer_Network_Component/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getObject + Retrieve a SoftLayer_Network_Component record. diff --git a/content/reference/services/SoftLayer_Network_Component/getPortStatistics.md b/content/reference/services/SoftLayer_Network_Component/getPortStatistics.md index 4a748be029..a335d7243d 100644 --- a/content/reference/services/SoftLayer_Network_Component/getPortStatistics.md +++ b/content/reference/services/SoftLayer_Network_Component/getPortStatistics.md @@ -14,6 +14,8 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getPortStatistics +
              Deprecated
              + Retrieve various network statistics for the specific port. diff --git a/content/reference/services/SoftLayer_Network_Component/getPrimaryIpAddressRecord.md b/content/reference/services/SoftLayer_Network_Component/getPrimaryIpAddressRecord.md index d9a754f0be..66e04b3b6e 100644 --- a/content/reference/services/SoftLayer_Network_Component/getPrimaryIpAddressRecord.md +++ b/content/reference/services/SoftLayer_Network_Component/getPrimaryIpAddressRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getPrimaryIpAddressRecord + Retrieve the primary IPv4 Address record for a network component. diff --git a/content/reference/services/SoftLayer_Network_Component/getPrimarySubnet.md b/content/reference/services/SoftLayer_Network_Component/getPrimarySubnet.md index bc6da7e693..bce2ca4f92 100644 --- a/content/reference/services/SoftLayer_Network_Component/getPrimarySubnet.md +++ b/content/reference/services/SoftLayer_Network_Component/getPrimarySubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getPrimarySubnet + Retrieve the subnet of the primary IP address assigned to this network component. diff --git a/content/reference/services/SoftLayer_Network_Component/getPrimaryVersion6IpAddressRecord.md b/content/reference/services/SoftLayer_Network_Component/getPrimaryVersion6IpAddressRecord.md index 1fee477a19..dc088138b9 100644 --- a/content/reference/services/SoftLayer_Network_Component/getPrimaryVersion6IpAddressRecord.md +++ b/content/reference/services/SoftLayer_Network_Component/getPrimaryVersion6IpAddressRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getPrimaryVersion6IpAddressRecord + Retrieve the primary IPv6 Address record for a network component. diff --git a/content/reference/services/SoftLayer_Network_Component/getRecentCommands.md b/content/reference/services/SoftLayer_Network_Component/getRecentCommands.md index 2375d0c981..2f541278d1 100644 --- a/content/reference/services/SoftLayer_Network_Component/getRecentCommands.md +++ b/content/reference/services/SoftLayer_Network_Component/getRecentCommands.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getRecentCommands + Retrieve the last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card. diff --git a/content/reference/services/SoftLayer_Network_Component/getRedundancyCapableFlag.md b/content/reference/services/SoftLayer_Network_Component/getRedundancyCapableFlag.md index 47f9f03a6a..67d7948ee9 100644 --- a/content/reference/services/SoftLayer_Network_Component/getRedundancyCapableFlag.md +++ b/content/reference/services/SoftLayer_Network_Component/getRedundancyCapableFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getRedundancyCapableFlag + Retrieve indicates whether the network component is participating in a group of two or more components capable of being operationally redundant, if enabled. diff --git a/content/reference/services/SoftLayer_Network_Component/getRedundancyEnabledFlag.md b/content/reference/services/SoftLayer_Network_Component/getRedundancyEnabledFlag.md index 5259e79706..8c3b8a6bbc 100644 --- a/content/reference/services/SoftLayer_Network_Component/getRedundancyEnabledFlag.md +++ b/content/reference/services/SoftLayer_Network_Component/getRedundancyEnabledFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getRedundancyEnabledFlag + Retrieve indicates whether the network component is participating in a group of two or more components which is actively providing link redundancy. diff --git a/content/reference/services/SoftLayer_Network_Component/getRemoteManagementUsers.md b/content/reference/services/SoftLayer_Network_Component/getRemoteManagementUsers.md index 6a466572b9..974e10825a 100644 --- a/content/reference/services/SoftLayer_Network_Component/getRemoteManagementUsers.md +++ b/content/reference/services/SoftLayer_Network_Component/getRemoteManagementUsers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getRemoteManagementUsers + Retrieve user(s) credentials to issue commands and/or interact with the server's remote management card. diff --git a/content/reference/services/SoftLayer_Network_Component/getRouter.md b/content/reference/services/SoftLayer_Network_Component/getRouter.md index 5fa5104224..57b114c58d 100644 --- a/content/reference/services/SoftLayer_Network_Component/getRouter.md +++ b/content/reference/services/SoftLayer_Network_Component/getRouter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getRouter + Retrieve a network component's routers. diff --git a/content/reference/services/SoftLayer_Network_Component/getStorageNetworkFlag.md b/content/reference/services/SoftLayer_Network_Component/getStorageNetworkFlag.md index 896c1e330c..13f23b0a03 100644 --- a/content/reference/services/SoftLayer_Network_Component/getStorageNetworkFlag.md +++ b/content/reference/services/SoftLayer_Network_Component/getStorageNetworkFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getStorageNetworkFlag + Retrieve whether a network component's primary ip address is from a storage network subnet or not. [Deprecated] diff --git a/content/reference/services/SoftLayer_Network_Component/getSubnets.md b/content/reference/services/SoftLayer_Network_Component/getSubnets.md index 409ff7da9f..63881e613e 100644 --- a/content/reference/services/SoftLayer_Network_Component/getSubnets.md +++ b/content/reference/services/SoftLayer_Network_Component/getSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getSubnets + Retrieve a network component's subnets. A subnet is a group of IP addresses diff --git a/content/reference/services/SoftLayer_Network_Component/getUplinkComponent.md b/content/reference/services/SoftLayer_Network_Component/getUplinkComponent.md index d50f995903..c45f103348 100644 --- a/content/reference/services/SoftLayer_Network_Component/getUplinkComponent.md +++ b/content/reference/services/SoftLayer_Network_Component/getUplinkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getUplinkComponent + Retrieve the network component linking this object to parent diff --git a/content/reference/services/SoftLayer_Network_Component/getUplinkDuplexMode.md b/content/reference/services/SoftLayer_Network_Component/getUplinkDuplexMode.md index b98c1aa3e2..3ebe5ba328 100644 --- a/content/reference/services/SoftLayer_Network_Component/getUplinkDuplexMode.md +++ b/content/reference/services/SoftLayer_Network_Component/getUplinkDuplexMode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::getUplinkDuplexMode + Retrieve the duplex mode of the uplink network component linking to this object diff --git a/content/reference/services/SoftLayer_Network_Component/removeNetworkVlanTrunks.md b/content/reference/services/SoftLayer_Network_Component/removeNetworkVlanTrunks.md index a18526506b..9ab1317b40 100644 --- a/content/reference/services/SoftLayer_Network_Component/removeNetworkVlanTrunks.md +++ b/content/reference/services/SoftLayer_Network_Component/removeNetworkVlanTrunks.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component](/reference/services/SoftLayer_Network_Component)::removeNetworkVlanTrunks + Remove VLAN trunks from a network component diff --git a/content/reference/services/SoftLayer_Network_Component_Firewall/_index.md b/content/reference/services/SoftLayer_Network_Component_Firewall/_index.md index 9f1f4b6560..db731eb8de 100644 --- a/content/reference/services/SoftLayer_Network_Component_Firewall/_index.md +++ b/content/reference/services/SoftLayer_Network_Component_Firewall/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -56,54 +58,63 @@ The SoftLayer_Network_Component_Firewall service accesses general information re #### [getApplyServerRuleSubnets](/reference/services/SoftLayer_Network_Component_Firewall/getApplyServerRuleSubnets) Retrieve the additional subnets linked to this network component firewall, that inherit rules from the host that the context slot is attached to. +
              #### [getBillingItem](/reference/services/SoftLayer_Network_Component_Firewall/getBillingItem) Retrieve the billing item for a Hardware Firewall (Dedicated). +
              #### [getGuestNetworkComponent](/reference/services/SoftLayer_Network_Component_Firewall/getGuestNetworkComponent) Retrieve the network component of the guest virtual server that this network component firewall belongs to. +
              #### [getNetworkComponent](/reference/services/SoftLayer_Network_Component_Firewall/getNetworkComponent) Retrieve the network component of the switch interface that this network component firewall belongs to. +
              #### [getNetworkFirewallUpdateRequest](/reference/services/SoftLayer_Network_Component_Firewall/getNetworkFirewallUpdateRequest) Retrieve the update requests made for this firewall. +
              #### [getObject](/reference/services/SoftLayer_Network_Component_Firewall/getObject) Retrieve a SoftLayer_Network_Component_Firewall record. +
              #### [getRules](/reference/services/SoftLayer_Network_Component_Firewall/getRules) Retrieve the currently running rule set of this network component firewall. +
              #### [getSubnets](/reference/services/SoftLayer_Network_Component_Firewall/getSubnets) Retrieve the additional subnets linked to this network component firewall. +
              #### [hasActiveTransactions](/reference/services/SoftLayer_Network_Component_Firewall/hasActiveTransactions) +
              diff --git a/content/reference/services/SoftLayer_Network_Component_Firewall/getApplyServerRuleSubnets.md b/content/reference/services/SoftLayer_Network_Component_Firewall/getApplyServerRuleSubnets.md index 063abef9c7..3743798c1d 100644 --- a/content/reference/services/SoftLayer_Network_Component_Firewall/getApplyServerRuleSubnets.md +++ b/content/reference/services/SoftLayer_Network_Component_Firewall/getApplyServerRuleSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component_Firewall](/reference/services/SoftLayer_Network_Component_Firewall)::getApplyServerRuleSubnets + Retrieve the additional subnets linked to this network component firewall, that inherit rules from the host that the context slot is attached to. diff --git a/content/reference/services/SoftLayer_Network_Component_Firewall/getBillingItem.md b/content/reference/services/SoftLayer_Network_Component_Firewall/getBillingItem.md index f02ec1e577..00dd6639fa 100644 --- a/content/reference/services/SoftLayer_Network_Component_Firewall/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Component_Firewall/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component_Firewall](/reference/services/SoftLayer_Network_Component_Firewall)::getBillingItem + Retrieve the billing item for a Hardware Firewall (Dedicated). diff --git a/content/reference/services/SoftLayer_Network_Component_Firewall/getGuestNetworkComponent.md b/content/reference/services/SoftLayer_Network_Component_Firewall/getGuestNetworkComponent.md index 2deda88109..4d1744d083 100644 --- a/content/reference/services/SoftLayer_Network_Component_Firewall/getGuestNetworkComponent.md +++ b/content/reference/services/SoftLayer_Network_Component_Firewall/getGuestNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component_Firewall](/reference/services/SoftLayer_Network_Component_Firewall)::getGuestNetworkComponent + Retrieve the network component of the guest virtual server that this network component firewall belongs to. diff --git a/content/reference/services/SoftLayer_Network_Component_Firewall/getNetworkComponent.md b/content/reference/services/SoftLayer_Network_Component_Firewall/getNetworkComponent.md index ec2d16344a..ba7c2fe988 100644 --- a/content/reference/services/SoftLayer_Network_Component_Firewall/getNetworkComponent.md +++ b/content/reference/services/SoftLayer_Network_Component_Firewall/getNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component_Firewall](/reference/services/SoftLayer_Network_Component_Firewall)::getNetworkComponent + Retrieve the network component of the switch interface that this network component firewall belongs to. diff --git a/content/reference/services/SoftLayer_Network_Component_Firewall/getNetworkFirewallUpdateRequest.md b/content/reference/services/SoftLayer_Network_Component_Firewall/getNetworkFirewallUpdateRequest.md index 3befe0e5e9..4c9ba89457 100644 --- a/content/reference/services/SoftLayer_Network_Component_Firewall/getNetworkFirewallUpdateRequest.md +++ b/content/reference/services/SoftLayer_Network_Component_Firewall/getNetworkFirewallUpdateRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component_Firewall](/reference/services/SoftLayer_Network_Component_Firewall)::getNetworkFirewallUpdateRequest + Retrieve the update requests made for this firewall. diff --git a/content/reference/services/SoftLayer_Network_Component_Firewall/getObject.md b/content/reference/services/SoftLayer_Network_Component_Firewall/getObject.md index c087bf02c8..36c5d87a4b 100644 --- a/content/reference/services/SoftLayer_Network_Component_Firewall/getObject.md +++ b/content/reference/services/SoftLayer_Network_Component_Firewall/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component_Firewall](/reference/services/SoftLayer_Network_Component_Firewall)::getObject + Retrieve a SoftLayer_Network_Component_Firewall record. diff --git a/content/reference/services/SoftLayer_Network_Component_Firewall/getRules.md b/content/reference/services/SoftLayer_Network_Component_Firewall/getRules.md index ffeee1b23a..d4b95c21ad 100644 --- a/content/reference/services/SoftLayer_Network_Component_Firewall/getRules.md +++ b/content/reference/services/SoftLayer_Network_Component_Firewall/getRules.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component_Firewall](/reference/services/SoftLayer_Network_Component_Firewall)::getRules + Retrieve the currently running rule set of this network component firewall. diff --git a/content/reference/services/SoftLayer_Network_Component_Firewall/getSubnets.md b/content/reference/services/SoftLayer_Network_Component_Firewall/getSubnets.md index 88c7c071c8..e050ead993 100644 --- a/content/reference/services/SoftLayer_Network_Component_Firewall/getSubnets.md +++ b/content/reference/services/SoftLayer_Network_Component_Firewall/getSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Component_Firewall](/reference/services/SoftLayer_Network_Component_Firewall)::getSubnets + Retrieve the additional subnets linked to this network component firewall. diff --git a/content/reference/services/SoftLayer_Network_Component_Firewall/hasActiveTransactions.md b/content/reference/services/SoftLayer_Network_Component_Firewall/hasActiveTransactions.md index 0a493b795e..fb4979b73f 100644 --- a/content/reference/services/SoftLayer_Network_Component_Firewall/hasActiveTransactions.md +++ b/content/reference/services/SoftLayer_Network_Component_Firewall/hasActiveTransactions.md @@ -16,6 +16,7 @@ aliases: + ## Overview Check for active transactions for the shared Firewall. diff --git a/content/reference/services/SoftLayer_Network_Customer_Subnet/_index.md b/content/reference/services/SoftLayer_Network_Customer_Subnet/_index.md index 32ef8b3557..1d19ed7f71 100644 --- a/content/reference/services/SoftLayer_Network_Customer_Subnet/_index.md +++ b/content/reference/services/SoftLayer_Network_Customer_Subnet/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Every Customer subnet is defined in the SoftLayer_Network_Customer_Subnet service. SoftLayer keeps track of subnets outside of the SoftLayer Network that are associated to SoftLayer subnets or systems. For example, customer subnets are tracked for proper management of network tunnels. This service allows for managing subnets on the remote end of the network tunnel. @@ -44,18 +46,21 @@ For example, customer subnets are tracked for proper management of network tunne #### [createObject](/reference/services/SoftLayer_Network_Customer_Subnet/createObject) * +
              #### [getIpAddresses](/reference/services/SoftLayer_Network_Customer_Subnet/getIpAddresses) Retrieve all ip addresses associated with a subnet. +
              #### [getObject](/reference/services/SoftLayer_Network_Customer_Subnet/getObject) Retrieve a SoftLayer_Network_Customer_Subnet record. +
              diff --git a/content/reference/services/SoftLayer_Network_Customer_Subnet/createObject.md b/content/reference/services/SoftLayer_Network_Customer_Subnet/createObject.md index f883c309b0..8fafc50def 100644 --- a/content/reference/services/SoftLayer_Network_Customer_Subnet/createObject.md +++ b/content/reference/services/SoftLayer_Network_Customer_Subnet/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Customer_Subnet](/reference/services/SoftLayer_Network_Customer_Subnet)::createObject + * diff --git a/content/reference/services/SoftLayer_Network_Customer_Subnet/getIpAddresses.md b/content/reference/services/SoftLayer_Network_Customer_Subnet/getIpAddresses.md index b9bcf4c372..5846cb444e 100644 --- a/content/reference/services/SoftLayer_Network_Customer_Subnet/getIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Customer_Subnet/getIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Customer_Subnet](/reference/services/SoftLayer_Network_Customer_Subnet)::getIpAddresses + Retrieve all ip addresses associated with a subnet. diff --git a/content/reference/services/SoftLayer_Network_Customer_Subnet/getObject.md b/content/reference/services/SoftLayer_Network_Customer_Subnet/getObject.md index 4fdb4e859d..b03131adb1 100644 --- a/content/reference/services/SoftLayer_Network_Customer_Subnet/getObject.md +++ b/content/reference/services/SoftLayer_Network_Customer_Subnet/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Customer_Subnet](/reference/services/SoftLayer_Network_Customer_Subnet)::getObject + Retrieve a SoftLayer_Network_Customer_Subnet record. diff --git a/content/reference/services/SoftLayer_Network_DirectLink_Location/_index.md b/content/reference/services/SoftLayer_Network_DirectLink_Location/_index.md index 3d935531c4..7b85364740 100644 --- a/content/reference/services/SoftLayer_Network_DirectLink_Location/_index.md +++ b/content/reference/services/SoftLayer_Network_DirectLink_Location/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Network_DirectLink_Location service allows users to create, update, delete, get details of a Direct Link location and retrieve all existing details. @@ -42,30 +44,35 @@ The SoftLayer_Network_DirectLink_Location service allows users to create, update #### [getAllObjects](/reference/services/SoftLayer_Network_DirectLink_Location/getAllObjects) Get all existing Direct Link location. +
              #### [getLocation](/reference/services/SoftLayer_Network_DirectLink_Location/getLocation) Retrieve the location of Direct Link facility. +
              #### [getObject](/reference/services/SoftLayer_Network_DirectLink_Location/getObject) Retrieve a SoftLayer_Network_DirectLink_Location record. +
              #### [getProvider](/reference/services/SoftLayer_Network_DirectLink_Location/getProvider) Retrieve the Id of Direct Link provider. +
              #### [getServiceType](/reference/services/SoftLayer_Network_DirectLink_Location/getServiceType) Retrieve the Id of Direct Link service type. +
              diff --git a/content/reference/services/SoftLayer_Network_DirectLink_Location/getAllObjects.md b/content/reference/services/SoftLayer_Network_DirectLink_Location/getAllObjects.md index 1bedce38e1..903298edef 100644 --- a/content/reference/services/SoftLayer_Network_DirectLink_Location/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_DirectLink_Location/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_DirectLink_Location](/reference/services/SoftLayer_Network_DirectLink_Location)::getAllObjects + Get all existing Direct Link location. diff --git a/content/reference/services/SoftLayer_Network_DirectLink_Location/getLocation.md b/content/reference/services/SoftLayer_Network_DirectLink_Location/getLocation.md index 186d08f067..58e737249e 100644 --- a/content/reference/services/SoftLayer_Network_DirectLink_Location/getLocation.md +++ b/content/reference/services/SoftLayer_Network_DirectLink_Location/getLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_DirectLink_Location](/reference/services/SoftLayer_Network_DirectLink_Location)::getLocation + Retrieve the location of Direct Link facility. diff --git a/content/reference/services/SoftLayer_Network_DirectLink_Location/getObject.md b/content/reference/services/SoftLayer_Network_DirectLink_Location/getObject.md index eef1962b01..23a5d1b78a 100644 --- a/content/reference/services/SoftLayer_Network_DirectLink_Location/getObject.md +++ b/content/reference/services/SoftLayer_Network_DirectLink_Location/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_DirectLink_Location](/reference/services/SoftLayer_Network_DirectLink_Location)::getObject + Retrieve a SoftLayer_Network_DirectLink_Location record. diff --git a/content/reference/services/SoftLayer_Network_DirectLink_Location/getProvider.md b/content/reference/services/SoftLayer_Network_DirectLink_Location/getProvider.md index 17096e1fd8..b6af4abeed 100644 --- a/content/reference/services/SoftLayer_Network_DirectLink_Location/getProvider.md +++ b/content/reference/services/SoftLayer_Network_DirectLink_Location/getProvider.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_DirectLink_Location](/reference/services/SoftLayer_Network_DirectLink_Location)::getProvider + Retrieve the Id of Direct Link provider. diff --git a/content/reference/services/SoftLayer_Network_DirectLink_Location/getServiceType.md b/content/reference/services/SoftLayer_Network_DirectLink_Location/getServiceType.md index aff9e2cfb4..813246ddd8 100644 --- a/content/reference/services/SoftLayer_Network_DirectLink_Location/getServiceType.md +++ b/content/reference/services/SoftLayer_Network_DirectLink_Location/getServiceType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_DirectLink_Location](/reference/services/SoftLayer_Network_DirectLink_Location)::getServiceType + Retrieve the Id of Direct Link service type. diff --git a/content/reference/services/SoftLayer_Network_DirectLink_Provider/_index.md b/content/reference/services/SoftLayer_Network_DirectLink_Provider/_index.md index 7297be1c99..8735628dcf 100644 --- a/content/reference/services/SoftLayer_Network_DirectLink_Provider/_index.md +++ b/content/reference/services/SoftLayer_Network_DirectLink_Provider/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,6 +44,7 @@ The SoftLayer_Network_DirectLink_Provider service allows users to create, update #### [getObject](/reference/services/SoftLayer_Network_DirectLink_Provider/getObject) Retrieve a SoftLayer_Network_DirectLink_Provider record. + diff --git a/content/reference/services/SoftLayer_Network_DirectLink_Provider/getObject.md b/content/reference/services/SoftLayer_Network_DirectLink_Provider/getObject.md index 34c68c80ba..0c921d9cc8 100644 --- a/content/reference/services/SoftLayer_Network_DirectLink_Provider/getObject.md +++ b/content/reference/services/SoftLayer_Network_DirectLink_Provider/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_DirectLink_Provider](/reference/services/SoftLayer_Network_DirectLink_Provider)::getObject + Retrieve a SoftLayer_Network_DirectLink_Provider record. diff --git a/content/reference/services/SoftLayer_Network_DirectLink_ServiceType/_index.md b/content/reference/services/SoftLayer_Network_DirectLink_ServiceType/_index.md index 6ec8264076..0467cdae5b 100644 --- a/content/reference/services/SoftLayer_Network_DirectLink_ServiceType/_index.md +++ b/content/reference/services/SoftLayer_Network_DirectLink_ServiceType/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -42,6 +44,7 @@ The SoftLayer_Network_DirectLink_ServiceType service allows users to create, upd #### [getObject](/reference/services/SoftLayer_Network_DirectLink_ServiceType/getObject) Retrieve a SoftLayer_Network_DirectLink_ServiceType record. + diff --git a/content/reference/services/SoftLayer_Network_DirectLink_ServiceType/getObject.md b/content/reference/services/SoftLayer_Network_DirectLink_ServiceType/getObject.md index 6d03bdacdf..2dc1f053d5 100644 --- a/content/reference/services/SoftLayer_Network_DirectLink_ServiceType/getObject.md +++ b/content/reference/services/SoftLayer_Network_DirectLink_ServiceType/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_DirectLink_ServiceType](/reference/services/SoftLayer_Network_DirectLink_ServiceType)::getObject + Retrieve a SoftLayer_Network_DirectLink_ServiceType record. diff --git a/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/_index.md b/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/_index.md index 7b4aa8f80a..0aece54483 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/_index.md +++ b/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -56,24 +58,28 @@ The SoftLayer_Network_Firewall_AccessControlList service accesses general inform #### [getNetworkFirewallUpdateRequests](/reference/services/SoftLayer_Network_Firewall_AccessControlList/getNetworkFirewallUpdateRequests) Retrieve the update requests made for this firewall. +
              #### [getNetworkVlan](/reference/services/SoftLayer_Network_Firewall_AccessControlList/getNetworkVlan) +
              #### [getObject](/reference/services/SoftLayer_Network_Firewall_AccessControlList/getObject) Retrieve a SoftLayer_Network_Firewall_AccessControlList record. +
              #### [getRules](/reference/services/SoftLayer_Network_Firewall_AccessControlList/getRules) Retrieve the currently running rule set of this context access control list firewall. +
              diff --git a/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/getNetworkFirewallUpdateRequests.md b/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/getNetworkFirewallUpdateRequests.md index cd61e9e7c3..ba8fed59e7 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/getNetworkFirewallUpdateRequests.md +++ b/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/getNetworkFirewallUpdateRequests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_AccessControlList](/reference/services/SoftLayer_Network_Firewall_AccessControlList)::getNetworkFirewallUpdateRequests + Retrieve the update requests made for this firewall. diff --git a/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/getNetworkVlan.md b/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/getNetworkVlan.md index 0cca945c0e..5c6cd2a61d 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/getNetworkVlan.md +++ b/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/getNetworkVlan.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/getObject.md b/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/getObject.md index 7cc7133fc3..19a43f10e7 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/getObject.md +++ b/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_AccessControlList](/reference/services/SoftLayer_Network_Firewall_AccessControlList)::getObject + Retrieve a SoftLayer_Network_Firewall_AccessControlList record. diff --git a/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/getRules.md b/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/getRules.md index 0c23b3d25d..8f8ab56bf3 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/getRules.md +++ b/content/reference/services/SoftLayer_Network_Firewall_AccessControlList/getRules.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_AccessControlList](/reference/services/SoftLayer_Network_Firewall_AccessControlList)::getRules + Retrieve the currently running rule set of this context access control list firewall. diff --git a/content/reference/services/SoftLayer_Network_Firewall_Interface/_index.md b/content/reference/services/SoftLayer_Network_Firewall_Interface/_index.md index b59fe357f9..42e1aa3822 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Interface/_index.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Interface/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -56,18 +58,21 @@ The SoftLayer_Network_Firewall_Interface service accesses general information re #### [getFirewallContextAccessControlLists](/reference/services/SoftLayer_Network_Firewall_Interface/getFirewallContextAccessControlLists) +
              #### [getNetworkVlan](/reference/services/SoftLayer_Network_Firewall_Interface/getNetworkVlan) +
              #### [getObject](/reference/services/SoftLayer_Network_Firewall_Interface/getObject) Retrieve a SoftLayer_Network_Firewall_Interface record. +
              diff --git a/content/reference/services/SoftLayer_Network_Firewall_Interface/getFirewallContextAccessControlLists.md b/content/reference/services/SoftLayer_Network_Firewall_Interface/getFirewallContextAccessControlLists.md index 146a4d572a..21b09ce209 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Interface/getFirewallContextAccessControlLists.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Interface/getFirewallContextAccessControlLists.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Firewall_Interface/getNetworkVlan.md b/content/reference/services/SoftLayer_Network_Firewall_Interface/getNetworkVlan.md index 41439034b9..d00946e750 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Interface/getNetworkVlan.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Interface/getNetworkVlan.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Firewall_Interface/getObject.md b/content/reference/services/SoftLayer_Network_Firewall_Interface/getObject.md index d00380388b..17a1a2d5ac 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Interface/getObject.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Interface/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_Interface](/reference/services/SoftLayer_Network_Firewall_Interface)::getObject + Retrieve a SoftLayer_Network_Firewall_Interface record. diff --git a/content/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/_index.md b/content/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/_index.md index 7eabb1b93c..648d252500 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/_index.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,18 +44,21 @@ classes: #### [getFirewallContextAccessControlLists](/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/getFirewallContextAccessControlLists) +
              #### [getNetworkVlan](/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/getNetworkVlan) +
              #### [getObject](/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/getObject) Retrieve a SoftLayer_Network_Firewall_Module_Context_Interface record. +
              diff --git a/content/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/getFirewallContextAccessControlLists.md b/content/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/getFirewallContextAccessControlLists.md index 78a3df395a..771e5100fa 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/getFirewallContextAccessControlLists.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/getFirewallContextAccessControlLists.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/getNetworkVlan.md b/content/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/getNetworkVlan.md index 704d5e58d2..fd3d801c95 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/getNetworkVlan.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/getNetworkVlan.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/getObject.md b/content/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/getObject.md index 240eef7182..228b440626 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/getObject.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_Module_Context_Interface](/reference/services/SoftLayer_Network_Firewall_Module_Context_Interface)::getObject + Retrieve a SoftLayer_Network_Firewall_Module_Context_Interface record. diff --git a/content/reference/services/SoftLayer_Network_Firewall_Template/_index.md b/content/reference/services/SoftLayer_Network_Firewall_Template/_index.md index f0e53282f8..0e94c88d2a 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Template/_index.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Template/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -67,18 +69,21 @@ The provided firewall templates are recommend rule sets for use with SoftLayer H #### [getAllObjects](/reference/services/SoftLayer_Network_Firewall_Template/getAllObjects) Get all available firewall template objects. +
              #### [getObject](/reference/services/SoftLayer_Network_Firewall_Template/getObject) Retrieve a SoftLayer_Network_Firewall_Template record. +
              #### [getRules](/reference/services/SoftLayer_Network_Firewall_Template/getRules) Retrieve the rule set that belongs to this firewall rules template. +
              diff --git a/content/reference/services/SoftLayer_Network_Firewall_Template/getAllObjects.md b/content/reference/services/SoftLayer_Network_Firewall_Template/getAllObjects.md index 4e37490d72..d2bda9e509 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Template/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Template/getAllObjects.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Firewall_Template](/reference/services/SoftLayer_Network_Firewall_Template)::getAllObjects + Get all available firewall template objects. diff --git a/content/reference/services/SoftLayer_Network_Firewall_Template/getObject.md b/content/reference/services/SoftLayer_Network_Firewall_Template/getObject.md index bb33e6099a..f09906282d 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Template/getObject.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Template/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_Template](/reference/services/SoftLayer_Network_Firewall_Template)::getObject + Retrieve a SoftLayer_Network_Firewall_Template record. diff --git a/content/reference/services/SoftLayer_Network_Firewall_Template/getRules.md b/content/reference/services/SoftLayer_Network_Firewall_Template/getRules.md index 11ac8a7608..6e935bc59f 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Template/getRules.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Template/getRules.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_Template](/reference/services/SoftLayer_Network_Firewall_Template)::getRules + Retrieve the rule set that belongs to this firewall rules template. diff --git a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/_index.md b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/_index.md index ac5744f9b4..dece8a3edc 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/_index.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -62,54 +64,63 @@ The SoftLayer_Network_Firewall_Update_Request service can be used to create Soft #### [createObject](/reference/services/SoftLayer_Network_Firewall_Update_Request/createObject) Create a new firewall update request. +
              #### [getAuthorizingUser](/reference/services/SoftLayer_Network_Firewall_Update_Request/getAuthorizingUser) Retrieve the user that authorized this firewall update request. +
              #### [getFirewallUpdateRequestRuleAttributes](/reference/services/SoftLayer_Network_Firewall_Update_Request/getFirewallUpdateRequestRuleAttributes) Get the possible attribute values for a firewall update request rule. +
              #### [getGuest](/reference/services/SoftLayer_Network_Firewall_Update_Request/getGuest) Retrieve the downstream virtual server that the rule set will be applied to. +
              #### [getHardware](/reference/services/SoftLayer_Network_Firewall_Update_Request/getHardware) Retrieve the downstream server that the rule set will be applied to. +
              #### [getNetworkComponentFirewall](/reference/services/SoftLayer_Network_Firewall_Update_Request/getNetworkComponentFirewall) Retrieve the network component firewall that the rule set will be applied to. +
              #### [getObject](/reference/services/SoftLayer_Network_Firewall_Update_Request/getObject) Retrieve a SoftLayer_Network_Firewall_Update_Request record. +
              #### [getRules](/reference/services/SoftLayer_Network_Firewall_Update_Request/getRules) Retrieve the group of rules contained within the update request. +
              #### [updateRuleNote](/reference/services/SoftLayer_Network_Firewall_Update_Request/updateRuleNote) +
              diff --git a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/createObject.md b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/createObject.md index ff6641cb0b..3c6a994a8b 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/createObject.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_Update_Request](/reference/services/SoftLayer_Network_Firewall_Update_Request)::createObject + Create a new firewall update request. diff --git a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getAuthorizingUser.md b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getAuthorizingUser.md index a5d71e263e..f24132156b 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getAuthorizingUser.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getAuthorizingUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_Update_Request](/reference/services/SoftLayer_Network_Firewall_Update_Request)::getAuthorizingUser + Retrieve the user that authorized this firewall update request. diff --git a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getFirewallUpdateRequestRuleAttributes.md b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getFirewallUpdateRequestRuleAttributes.md index 661cd9673c..20f747741a 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getFirewallUpdateRequestRuleAttributes.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getFirewallUpdateRequestRuleAttributes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_Update_Request](/reference/services/SoftLayer_Network_Firewall_Update_Request)::getFirewallUpdateRequestRuleAttributes + Get the possible attribute values for a firewall update request rule. diff --git a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getGuest.md b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getGuest.md index 3816eaaa6e..16a8d495b1 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getGuest.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_Update_Request](/reference/services/SoftLayer_Network_Firewall_Update_Request)::getGuest + Retrieve the downstream virtual server that the rule set will be applied to. diff --git a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getHardware.md b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getHardware.md index d82be1947b..0158af5b22 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getHardware.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_Update_Request](/reference/services/SoftLayer_Network_Firewall_Update_Request)::getHardware + Retrieve the downstream server that the rule set will be applied to. diff --git a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getNetworkComponentFirewall.md b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getNetworkComponentFirewall.md index c34a5cf059..279f359c84 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getNetworkComponentFirewall.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getNetworkComponentFirewall.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_Update_Request](/reference/services/SoftLayer_Network_Firewall_Update_Request)::getNetworkComponentFirewall + Retrieve the network component firewall that the rule set will be applied to. diff --git a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getObject.md b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getObject.md index 1056fb9cec..b448273a08 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getObject.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_Update_Request](/reference/services/SoftLayer_Network_Firewall_Update_Request)::getObject + Retrieve a SoftLayer_Network_Firewall_Update_Request record. diff --git a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getRules.md b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getRules.md index 53c478401e..0cff012afe 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getRules.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/getRules.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_Update_Request](/reference/services/SoftLayer_Network_Firewall_Update_Request)::getRules + Retrieve the group of rules contained within the update request. diff --git a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/updateRuleNote.md b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/updateRuleNote.md index 430ed4b268..24717d1818 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Update_Request/updateRuleNote.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Update_Request/updateRuleNote.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/_index.md b/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/_index.md index 825b6e2fc5..ae81d14aa7 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/_index.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -74,24 +76,28 @@ The SoftLayer_Network_Firewall_Update_Request_Rule service accesses information #### [createObject](/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/createObject) Create a new firewall update request rule. +
              #### [getFirewallUpdateRequest](/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/getFirewallUpdateRequest) Retrieve the update request that this rule belongs to. +
              #### [getObject](/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/getObject) Retrieve a SoftLayer_Network_Firewall_Update_Request_Rule record. +
              #### [validateRule](/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/validateRule) Validate a firewall update request rule. +
              diff --git a/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/createObject.md b/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/createObject.md index ffe55e2120..eac5c1bbf9 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/createObject.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_Update_Request_Rule](/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule)::createObject + Create a new firewall update request rule. diff --git a/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/getFirewallUpdateRequest.md b/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/getFirewallUpdateRequest.md index b3d45e138d..7159d50099 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/getFirewallUpdateRequest.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/getFirewallUpdateRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_Update_Request_Rule](/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule)::getFirewallUpdateRequest + Retrieve the update request that this rule belongs to. diff --git a/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/getObject.md b/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/getObject.md index 4c0c68a214..6b847fa047 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/getObject.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_Update_Request_Rule](/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule)::getObject + Retrieve a SoftLayer_Network_Firewall_Update_Request_Rule record. diff --git a/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/validateRule.md b/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/validateRule.md index d9aa388ac0..ed8798479a 100644 --- a/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/validateRule.md +++ b/content/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule/validateRule.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Firewall_Update_Request_Rule](/reference/services/SoftLayer_Network_Firewall_Update_Request_Rule)::validateRule + Validate a firewall update request rule. diff --git a/content/reference/services/SoftLayer_Network_Gateway/_index.md b/content/reference/services/SoftLayer_Network_Gateway/_index.md index 85bfd3801f..3cb551d60b 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/_index.md +++ b/content/reference/services/SoftLayer_Network_Gateway/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,204 +44,238 @@ A network gateway is a set of members which have a configurable set of VLANs tru #### [bypassAllVlans](/reference/services/SoftLayer_Network_Gateway/bypassAllVlans) Bypass All VLANs +
              #### [bypassVlans](/reference/services/SoftLayer_Network_Gateway/bypassVlans) Bypass VLANs +
              #### [changeGatewayVersion](/reference/services/SoftLayer_Network_Gateway/changeGatewayVersion) Change Juniper vSRX version on a Gateway +
              #### [checkAccountWhiteList](/reference/services/SoftLayer_Network_Gateway/checkAccountWhiteList) +
              #### [createObject](/reference/services/SoftLayer_Network_Gateway/createObject) Create a new server gateway +
              #### [editObject](/reference/services/SoftLayer_Network_Gateway/editObject) Edit Gateway +
              #### [forceRebuildvSRXCluster](/reference/services/SoftLayer_Network_Gateway/forceRebuildvSRXCluster) Rebuild HA GAteway +
              #### [getAccount](/reference/services/SoftLayer_Network_Gateway/getAccount) Retrieve the account for this gateway. +
              #### [getAllowedOsPriceIds](/reference/services/SoftLayer_Network_Gateway/getAllowedOsPriceIds) +
              #### [getCapacity](/reference/services/SoftLayer_Network_Gateway/getCapacity) +
              #### [getInsideVlans](/reference/services/SoftLayer_Network_Gateway/getInsideVlans) Retrieve all VLANs trunked to this gateway. +
              #### [getManufacturer](/reference/services/SoftLayer_Network_Gateway/getManufacturer) manufacturer name +
              #### [getMemberGatewayImagesMatch](/reference/services/SoftLayer_Network_Gateway/getMemberGatewayImagesMatch) +
              #### [getMembers](/reference/services/SoftLayer_Network_Gateway/getMembers) Retrieve the members for this gateway. +
              #### [getNetworkFirewall](/reference/services/SoftLayer_Network_Gateway/getNetworkFirewall) Retrieve the firewall associated with this gateway, if any. +
              #### [getNetworkFirewallFlag](/reference/services/SoftLayer_Network_Gateway/getNetworkFirewallFlag) Retrieve whether or not there is a firewall associated with this gateway. +
              #### [getObject](/reference/services/SoftLayer_Network_Gateway/getObject) Retrieve a SoftLayer_Network_Gateway record. +
              #### [getPossibleInsideVlans](/reference/services/SoftLayer_Network_Gateway/getPossibleInsideVlans) Get Possible Inside VLANs +
              #### [getPrivateIpAddress](/reference/services/SoftLayer_Network_Gateway/getPrivateIpAddress) Retrieve the private gateway IP address. +
              #### [getPrivateVlan](/reference/services/SoftLayer_Network_Gateway/getPrivateVlan) Retrieve the private VLAN for accessing this gateway. +
              #### [getPublicIpAddress](/reference/services/SoftLayer_Network_Gateway/getPublicIpAddress) Retrieve the public gateway IP address. +
              #### [getPublicIpv6Address](/reference/services/SoftLayer_Network_Gateway/getPublicIpv6Address) Retrieve the public gateway IPv6 address. +
              #### [getPublicVlan](/reference/services/SoftLayer_Network_Gateway/getPublicVlan) Retrieve the public VLAN for accessing this gateway. +
              #### [getRollbackSupport](/reference/services/SoftLayer_Network_Gateway/getRollbackSupport) +
              #### [getStatus](/reference/services/SoftLayer_Network_Gateway/getStatus) Retrieve the current status of the gateway. +
              #### [getUpgradeItemPrices](/reference/services/SoftLayer_Network_Gateway/getUpgradeItemPrices) Retrieve available upgrade prices +
              #### [isAccountWhiteListed](/reference/services/SoftLayer_Network_Gateway/isAccountWhiteListed) +
              #### [isLicenseServerAllowed](/reference/services/SoftLayer_Network_Gateway/isLicenseServerAllowed) +
              #### [isRollbackAllowed](/reference/services/SoftLayer_Network_Gateway/isRollbackAllowed) +
              #### [rebuildvSRXHACluster](/reference/services/SoftLayer_Network_Gateway/rebuildvSRXHACluster) Rebuild Juniper vSRX HA Gateway +
              #### [refreshGatewayLicense](/reference/services/SoftLayer_Network_Gateway/refreshGatewayLicense) +
              #### [setGatewayPassword](/reference/services/SoftLayer_Network_Gateway/setGatewayPassword) +
              #### [unbypassAllVlans](/reference/services/SoftLayer_Network_Gateway/unbypassAllVlans) Bypass All VLANs +
              #### [unbypassVlans](/reference/services/SoftLayer_Network_Gateway/unbypassVlans) Bypass VLANs +
              diff --git a/content/reference/services/SoftLayer_Network_Gateway/bypassAllVlans.md b/content/reference/services/SoftLayer_Network_Gateway/bypassAllVlans.md index d5f46e1b28..b2a00cf8f4 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/bypassAllVlans.md +++ b/content/reference/services/SoftLayer_Network_Gateway/bypassAllVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::bypassAllVlans + Bypass All VLANs diff --git a/content/reference/services/SoftLayer_Network_Gateway/bypassVlans.md b/content/reference/services/SoftLayer_Network_Gateway/bypassVlans.md index bf9119cfe3..ee7f717f2b 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/bypassVlans.md +++ b/content/reference/services/SoftLayer_Network_Gateway/bypassVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::bypassVlans + Bypass VLANs diff --git a/content/reference/services/SoftLayer_Network_Gateway/changeGatewayVersion.md b/content/reference/services/SoftLayer_Network_Gateway/changeGatewayVersion.md index 45208f9ec3..4386958ac6 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/changeGatewayVersion.md +++ b/content/reference/services/SoftLayer_Network_Gateway/changeGatewayVersion.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::changeGatewayVersion + Change Juniper vSRX version on a Gateway diff --git a/content/reference/services/SoftLayer_Network_Gateway/checkAccountWhiteList.md b/content/reference/services/SoftLayer_Network_Gateway/checkAccountWhiteList.md index 420c4b9e60..2e1f411f37 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/checkAccountWhiteList.md +++ b/content/reference/services/SoftLayer_Network_Gateway/checkAccountWhiteList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Gateway/createObject.md b/content/reference/services/SoftLayer_Network_Gateway/createObject.md index 29230eb541..3799a25f2b 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/createObject.md +++ b/content/reference/services/SoftLayer_Network_Gateway/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::createObject + Create a new server gateway diff --git a/content/reference/services/SoftLayer_Network_Gateway/editObject.md b/content/reference/services/SoftLayer_Network_Gateway/editObject.md index e884a7b31a..635bfabb93 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/editObject.md +++ b/content/reference/services/SoftLayer_Network_Gateway/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::editObject + Edit Gateway diff --git a/content/reference/services/SoftLayer_Network_Gateway/forceRebuildvSRXCluster.md b/content/reference/services/SoftLayer_Network_Gateway/forceRebuildvSRXCluster.md index a065cd3577..d701c1cf39 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/forceRebuildvSRXCluster.md +++ b/content/reference/services/SoftLayer_Network_Gateway/forceRebuildvSRXCluster.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::forceRebuildvSRXCluster + Rebuild HA GAteway diff --git a/content/reference/services/SoftLayer_Network_Gateway/getAccount.md b/content/reference/services/SoftLayer_Network_Gateway/getAccount.md index f5292720c3..62d03aa625 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::getAccount + Retrieve the account for this gateway. diff --git a/content/reference/services/SoftLayer_Network_Gateway/getAllowedOsPriceIds.md b/content/reference/services/SoftLayer_Network_Gateway/getAllowedOsPriceIds.md index f1fc260fc9..8024c0f03c 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getAllowedOsPriceIds.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getAllowedOsPriceIds.md @@ -16,6 +16,7 @@ aliases: + ## Overview Used to get a list of OS prices (ids) which are allowed for the Gateway. diff --git a/content/reference/services/SoftLayer_Network_Gateway/getCapacity.md b/content/reference/services/SoftLayer_Network_Gateway/getCapacity.md index b85e7d7b61..826868d278 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getCapacity.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getCapacity.md @@ -16,6 +16,7 @@ aliases: + ## Overview Returns the Gbps capacity of the gateway object diff --git a/content/reference/services/SoftLayer_Network_Gateway/getInsideVlans.md b/content/reference/services/SoftLayer_Network_Gateway/getInsideVlans.md index efc2284b7e..0de28614ec 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getInsideVlans.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getInsideVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::getInsideVlans + Retrieve all VLANs trunked to this gateway. diff --git a/content/reference/services/SoftLayer_Network_Gateway/getManufacturer.md b/content/reference/services/SoftLayer_Network_Gateway/getManufacturer.md index 11c7b1f8a8..d04b6746aa 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getManufacturer.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getManufacturer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::getManufacturer + manufacturer name diff --git a/content/reference/services/SoftLayer_Network_Gateway/getMemberGatewayImagesMatch.md b/content/reference/services/SoftLayer_Network_Gateway/getMemberGatewayImagesMatch.md index 52c0d61090..d5dcf29a1a 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getMemberGatewayImagesMatch.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getMemberGatewayImagesMatch.md @@ -16,6 +16,7 @@ aliases: + ## Overview Returns true if no mismatch is found, gateway is not Juniper vSRX or SA gateway diff --git a/content/reference/services/SoftLayer_Network_Gateway/getMembers.md b/content/reference/services/SoftLayer_Network_Gateway/getMembers.md index 6183bfc3c3..1e03eecd77 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getMembers.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getMembers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::getMembers + Retrieve the members for this gateway. diff --git a/content/reference/services/SoftLayer_Network_Gateway/getNetworkFirewall.md b/content/reference/services/SoftLayer_Network_Gateway/getNetworkFirewall.md index 4fd570d26c..7b85372244 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getNetworkFirewall.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getNetworkFirewall.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::getNetworkFirewall + Retrieve the firewall associated with this gateway, if any. diff --git a/content/reference/services/SoftLayer_Network_Gateway/getNetworkFirewallFlag.md b/content/reference/services/SoftLayer_Network_Gateway/getNetworkFirewallFlag.md index a70dbd5c4a..1118732a86 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getNetworkFirewallFlag.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getNetworkFirewallFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::getNetworkFirewallFlag + Retrieve whether or not there is a firewall associated with this gateway. diff --git a/content/reference/services/SoftLayer_Network_Gateway/getObject.md b/content/reference/services/SoftLayer_Network_Gateway/getObject.md index a9806d2aeb..4a706a7b99 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getObject.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::getObject + Retrieve a SoftLayer_Network_Gateway record. diff --git a/content/reference/services/SoftLayer_Network_Gateway/getPossibleInsideVlans.md b/content/reference/services/SoftLayer_Network_Gateway/getPossibleInsideVlans.md index cec3c5e890..f945e07000 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getPossibleInsideVlans.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getPossibleInsideVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::getPossibleInsideVlans + Get Possible Inside VLANs diff --git a/content/reference/services/SoftLayer_Network_Gateway/getPrivateIpAddress.md b/content/reference/services/SoftLayer_Network_Gateway/getPrivateIpAddress.md index fe4403032b..eef6d4d7dd 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getPrivateIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getPrivateIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::getPrivateIpAddress + Retrieve the private gateway IP address. diff --git a/content/reference/services/SoftLayer_Network_Gateway/getPrivateVlan.md b/content/reference/services/SoftLayer_Network_Gateway/getPrivateVlan.md index 59716c6a5b..9396050e7d 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getPrivateVlan.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getPrivateVlan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::getPrivateVlan + Retrieve the private VLAN for accessing this gateway. diff --git a/content/reference/services/SoftLayer_Network_Gateway/getPublicIpAddress.md b/content/reference/services/SoftLayer_Network_Gateway/getPublicIpAddress.md index 9b8ef8f014..d7d7057a9f 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getPublicIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getPublicIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::getPublicIpAddress + Retrieve the public gateway IP address. diff --git a/content/reference/services/SoftLayer_Network_Gateway/getPublicIpv6Address.md b/content/reference/services/SoftLayer_Network_Gateway/getPublicIpv6Address.md index db0cc80504..0b4fb4664b 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getPublicIpv6Address.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getPublicIpv6Address.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::getPublicIpv6Address + Retrieve the public gateway IPv6 address. diff --git a/content/reference/services/SoftLayer_Network_Gateway/getPublicVlan.md b/content/reference/services/SoftLayer_Network_Gateway/getPublicVlan.md index fe5615123e..5a531e6e77 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getPublicVlan.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getPublicVlan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::getPublicVlan + Retrieve the public VLAN for accessing this gateway. diff --git a/content/reference/services/SoftLayer_Network_Gateway/getRollbackSupport.md b/content/reference/services/SoftLayer_Network_Gateway/getRollbackSupport.md index b3d616495e..0f24d6c648 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getRollbackSupport.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getRollbackSupport.md @@ -16,6 +16,7 @@ aliases: + ## Overview Returns the following statuses SUPPORTED - rollback is supported and perform automatically UNSUPPORTED - rollback is not supported MANUAL - rollback can be performed but diff --git a/content/reference/services/SoftLayer_Network_Gateway/getStatus.md b/content/reference/services/SoftLayer_Network_Gateway/getStatus.md index 8e5b42597e..714cdafa5b 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getStatus.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::getStatus + Retrieve the current status of the gateway. diff --git a/content/reference/services/SoftLayer_Network_Gateway/getUpgradeItemPrices.md b/content/reference/services/SoftLayer_Network_Gateway/getUpgradeItemPrices.md index 007f605f3b..b20a1fcb00 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/getUpgradeItemPrices.md +++ b/content/reference/services/SoftLayer_Network_Gateway/getUpgradeItemPrices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::getUpgradeItemPrices + Retrieve available upgrade prices diff --git a/content/reference/services/SoftLayer_Network_Gateway/isAccountWhiteListed.md b/content/reference/services/SoftLayer_Network_Gateway/isAccountWhiteListed.md index 59dd15965d..78bf21f331 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/isAccountWhiteListed.md +++ b/content/reference/services/SoftLayer_Network_Gateway/isAccountWhiteListed.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Gateway/isLicenseServerAllowed.md b/content/reference/services/SoftLayer_Network_Gateway/isLicenseServerAllowed.md index 965cb29eef..0432053eb8 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/isLicenseServerAllowed.md +++ b/content/reference/services/SoftLayer_Network_Gateway/isLicenseServerAllowed.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Gateway/isRollbackAllowed.md b/content/reference/services/SoftLayer_Network_Gateway/isRollbackAllowed.md index 30aedc75c6..c24af46eb9 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/isRollbackAllowed.md +++ b/content/reference/services/SoftLayer_Network_Gateway/isRollbackAllowed.md @@ -16,6 +16,7 @@ aliases: + ## Overview Returns true if rollback is allowed. diff --git a/content/reference/services/SoftLayer_Network_Gateway/rebuildvSRXHACluster.md b/content/reference/services/SoftLayer_Network_Gateway/rebuildvSRXHACluster.md index 37f9e72f9c..c4ae9aaa52 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/rebuildvSRXHACluster.md +++ b/content/reference/services/SoftLayer_Network_Gateway/rebuildvSRXHACluster.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::rebuildvSRXHACluster + Rebuild Juniper vSRX HA Gateway diff --git a/content/reference/services/SoftLayer_Network_Gateway/refreshGatewayLicense.md b/content/reference/services/SoftLayer_Network_Gateway/refreshGatewayLicense.md index 0dd9421666..90f6802b19 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/refreshGatewayLicense.md +++ b/content/reference/services/SoftLayer_Network_Gateway/refreshGatewayLicense.md @@ -16,6 +16,7 @@ aliases: + ## Overview Used to refresh the license for the Juniper Gateway, requires License readiness check has passed. diff --git a/content/reference/services/SoftLayer_Network_Gateway/setGatewayPassword.md b/content/reference/services/SoftLayer_Network_Gateway/setGatewayPassword.md index 075c5f8a31..092c0ddbdf 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/setGatewayPassword.md +++ b/content/reference/services/SoftLayer_Network_Gateway/setGatewayPassword.md @@ -16,6 +16,7 @@ aliases: + ## Overview Returns true if password change is successful, false if not successful diff --git a/content/reference/services/SoftLayer_Network_Gateway/unbypassAllVlans.md b/content/reference/services/SoftLayer_Network_Gateway/unbypassAllVlans.md index 53925ddd0c..96d2a4636e 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/unbypassAllVlans.md +++ b/content/reference/services/SoftLayer_Network_Gateway/unbypassAllVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::unbypassAllVlans + Bypass All VLANs diff --git a/content/reference/services/SoftLayer_Network_Gateway/unbypassVlans.md b/content/reference/services/SoftLayer_Network_Gateway/unbypassVlans.md index ccbc56aac2..9ce98e4c7e 100644 --- a/content/reference/services/SoftLayer_Network_Gateway/unbypassVlans.md +++ b/content/reference/services/SoftLayer_Network_Gateway/unbypassVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway](/reference/services/SoftLayer_Network_Gateway)::unbypassVlans + Bypass VLANs diff --git a/content/reference/services/SoftLayer_Network_Gateway_Member/_index.md b/content/reference/services/SoftLayer_Network_Gateway_Member/_index.md index 8579d4e2f8..316996764d 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Member/_index.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Member/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,36 +44,42 @@ A network gateway member is a device that serves as a gateway. Once the hardware #### [createObject](/reference/services/SoftLayer_Network_Gateway_Member/createObject) Add a member to a gateway +
              #### [createObjects](/reference/services/SoftLayer_Network_Gateway_Member/createObjects) Add a member to a gateway +
              #### [getAttributes](/reference/services/SoftLayer_Network_Gateway_Member/getAttributes) Retrieve the attributes for this member. +
              #### [getHardware](/reference/services/SoftLayer_Network_Gateway_Member/getHardware) Retrieve the device for this member. +
              #### [getNetworkGateway](/reference/services/SoftLayer_Network_Gateway_Member/getNetworkGateway) Retrieve the gateway this member belongs to. +
              #### [getObject](/reference/services/SoftLayer_Network_Gateway_Member/getObject) Retrieve a SoftLayer_Network_Gateway_Member record. +
              diff --git a/content/reference/services/SoftLayer_Network_Gateway_Member/createObject.md b/content/reference/services/SoftLayer_Network_Gateway_Member/createObject.md index edce25076e..e7d5363165 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Member/createObject.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Member/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Member](/reference/services/SoftLayer_Network_Gateway_Member)::createObject + Add a member to a gateway diff --git a/content/reference/services/SoftLayer_Network_Gateway_Member/createObjects.md b/content/reference/services/SoftLayer_Network_Gateway_Member/createObjects.md index 3541cd71e0..1f726d683d 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Member/createObjects.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Member/createObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Member](/reference/services/SoftLayer_Network_Gateway_Member)::createObjects + Add a member to a gateway diff --git a/content/reference/services/SoftLayer_Network_Gateway_Member/getAttributes.md b/content/reference/services/SoftLayer_Network_Gateway_Member/getAttributes.md index 19d8ade04a..b5b65c1256 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Member/getAttributes.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Member/getAttributes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Member](/reference/services/SoftLayer_Network_Gateway_Member)::getAttributes + Retrieve the attributes for this member. diff --git a/content/reference/services/SoftLayer_Network_Gateway_Member/getHardware.md b/content/reference/services/SoftLayer_Network_Gateway_Member/getHardware.md index 42f81413d1..3ea287ac8a 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Member/getHardware.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Member/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Member](/reference/services/SoftLayer_Network_Gateway_Member)::getHardware + Retrieve the device for this member. diff --git a/content/reference/services/SoftLayer_Network_Gateway_Member/getNetworkGateway.md b/content/reference/services/SoftLayer_Network_Gateway_Member/getNetworkGateway.md index 52eba837f4..fa538f6751 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Member/getNetworkGateway.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Member/getNetworkGateway.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Member](/reference/services/SoftLayer_Network_Gateway_Member)::getNetworkGateway + Retrieve the gateway this member belongs to. diff --git a/content/reference/services/SoftLayer_Network_Gateway_Member/getObject.md b/content/reference/services/SoftLayer_Network_Gateway_Member/getObject.md index 8d086079da..83250b2c7b 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Member/getObject.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Member/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Member](/reference/services/SoftLayer_Network_Gateway_Member)::getObject + Retrieve a SoftLayer_Network_Gateway_Member record. diff --git a/content/reference/services/SoftLayer_Network_Gateway_Member_Attribute/_index.md b/content/reference/services/SoftLayer_Network_Gateway_Member_Attribute/_index.md index a5e190823b..71aed85208 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Member_Attribute/_index.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Member_Attribute/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A network gateway member attribute is the attributes associated with a network gateway member. @@ -42,18 +44,21 @@ A network gateway member attribute is the attributes associated with a network g #### [getGatewayMember](/reference/services/SoftLayer_Network_Gateway_Member_Attribute/getGatewayMember) Retrieve the gateway member has these attributes. +
              #### [getObject](/reference/services/SoftLayer_Network_Gateway_Member_Attribute/getObject) Retrieve a SoftLayer_Network_Gateway_Member_Attribute record. +
              #### [getSshKey](/reference/services/SoftLayer_Network_Gateway_Member_Attribute/getSshKey) +
              diff --git a/content/reference/services/SoftLayer_Network_Gateway_Member_Attribute/getGatewayMember.md b/content/reference/services/SoftLayer_Network_Gateway_Member_Attribute/getGatewayMember.md index 2197eb01d4..3dfc00da0d 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Member_Attribute/getGatewayMember.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Member_Attribute/getGatewayMember.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Member_Attribute](/reference/services/SoftLayer_Network_Gateway_Member_Attribute)::getGatewayMember + Retrieve the gateway member has these attributes. diff --git a/content/reference/services/SoftLayer_Network_Gateway_Member_Attribute/getObject.md b/content/reference/services/SoftLayer_Network_Gateway_Member_Attribute/getObject.md index 03895a91be..2b8bd084ab 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Member_Attribute/getObject.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Member_Attribute/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Member_Attribute](/reference/services/SoftLayer_Network_Gateway_Member_Attribute)::getObject + Retrieve a SoftLayer_Network_Gateway_Member_Attribute record. diff --git a/content/reference/services/SoftLayer_Network_Gateway_Member_Attribute/getSshKey.md b/content/reference/services/SoftLayer_Network_Gateway_Member_Attribute/getSshKey.md index efe24983c8..80e5ce9921 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Member_Attribute/getSshKey.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Member_Attribute/getSshKey.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Gateway_Precheck/_index.md b/content/reference/services/SoftLayer_Network_Gateway_Precheck/_index.md index a4d5e2e019..078c3c9e23 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Precheck/_index.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Precheck/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A network gateway precheck is the precheck codes for member(s) of a gateway @@ -42,30 +44,35 @@ A network gateway precheck is the precheck codes for member(s) of a gateway #### [getObject](/reference/services/SoftLayer_Network_Gateway_Precheck/getObject) Retrieve a SoftLayer_Network_Gateway_Precheck record. +
              #### [getPrecheckStatus](/reference/services/SoftLayer_Network_Gateway_Precheck/getPrecheckStatus) Get Precheck status for Gateway +
              #### [licenseManagementPrecheck](/reference/services/SoftLayer_Network_Gateway_Precheck/licenseManagementPrecheck) License Management Gateway Precheck +
              #### [osReloadPrecheck](/reference/services/SoftLayer_Network_Gateway_Precheck/osReloadPrecheck) OS Reload Gateway Precheck +
              #### [upgradePrecheck](/reference/services/SoftLayer_Network_Gateway_Precheck/upgradePrecheck) Upgrade Gateway Precheck +
              diff --git a/content/reference/services/SoftLayer_Network_Gateway_Precheck/getObject.md b/content/reference/services/SoftLayer_Network_Gateway_Precheck/getObject.md index e6b74090d1..a6b756a5b9 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Precheck/getObject.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Precheck/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Precheck](/reference/services/SoftLayer_Network_Gateway_Precheck)::getObject + Retrieve a SoftLayer_Network_Gateway_Precheck record. diff --git a/content/reference/services/SoftLayer_Network_Gateway_Precheck/getPrecheckStatus.md b/content/reference/services/SoftLayer_Network_Gateway_Precheck/getPrecheckStatus.md index 29a5dcdf9a..97057596ed 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Precheck/getPrecheckStatus.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Precheck/getPrecheckStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Precheck](/reference/services/SoftLayer_Network_Gateway_Precheck)::getPrecheckStatus + Get Precheck status for Gateway diff --git a/content/reference/services/SoftLayer_Network_Gateway_Precheck/licenseManagementPrecheck.md b/content/reference/services/SoftLayer_Network_Gateway_Precheck/licenseManagementPrecheck.md index 98ce734e21..2316364e7a 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Precheck/licenseManagementPrecheck.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Precheck/licenseManagementPrecheck.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Precheck](/reference/services/SoftLayer_Network_Gateway_Precheck)::licenseManagementPrecheck + License Management Gateway Precheck diff --git a/content/reference/services/SoftLayer_Network_Gateway_Precheck/osReloadPrecheck.md b/content/reference/services/SoftLayer_Network_Gateway_Precheck/osReloadPrecheck.md index f0f2c132d1..408a1c4a7d 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Precheck/osReloadPrecheck.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Precheck/osReloadPrecheck.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Precheck](/reference/services/SoftLayer_Network_Gateway_Precheck)::osReloadPrecheck + OS Reload Gateway Precheck diff --git a/content/reference/services/SoftLayer_Network_Gateway_Precheck/upgradePrecheck.md b/content/reference/services/SoftLayer_Network_Gateway_Precheck/upgradePrecheck.md index 1027e3763e..50c2fe71f0 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Precheck/upgradePrecheck.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Precheck/upgradePrecheck.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Precheck](/reference/services/SoftLayer_Network_Gateway_Precheck)::upgradePrecheck + Upgrade Gateway Precheck diff --git a/content/reference/services/SoftLayer_Network_Gateway_Status/_index.md b/content/reference/services/SoftLayer_Network_Gateway_Status/_index.md index f2c405ea23..71045c07e1 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Status/_index.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,6 +44,7 @@ A network gateway status is a value representing the state of a network gateway. #### [getObject](/reference/services/SoftLayer_Network_Gateway_Status/getObject) Retrieve a SoftLayer_Network_Gateway_Status record. + diff --git a/content/reference/services/SoftLayer_Network_Gateway_Status/getObject.md b/content/reference/services/SoftLayer_Network_Gateway_Status/getObject.md index a19cc412fa..5ec32bfa13 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Status/getObject.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Status/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Status](/reference/services/SoftLayer_Network_Gateway_Status)::getObject + Retrieve a SoftLayer_Network_Gateway_Status record. diff --git a/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/_index.md b/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/_index.md index 67e421520a..e82fd1fdac 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/_index.md +++ b/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A gateway software version upgrade reference provides pairing for possible upgrades from a given versin. @@ -42,30 +44,35 @@ A gateway software version upgrade reference provides pairing for possible upgra #### [getAllByUpgradePkgUrlId](/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getAllByUpgradePkgUrlId) +
              #### [getAllUpgradesByGatewayId](/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getAllUpgradesByGatewayId) +
              #### [getObject](/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getObject) Retrieve a SoftLayer_Network_Gateway_VersionUpgrade record. +
              #### [getVsrxOrdersAllowedOS](/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getVsrxOrdersAllowedOS) +
              #### [validateVersionChange](/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/validateVersionChange) +
              diff --git a/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getAllByUpgradePkgUrlId.md b/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getAllByUpgradePkgUrlId.md index 286d68322f..80d97e4df2 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getAllByUpgradePkgUrlId.md +++ b/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getAllByUpgradePkgUrlId.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getAllUpgradesByGatewayId.md b/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getAllUpgradesByGatewayId.md index 7dc3129720..52bf390dbe 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getAllUpgradesByGatewayId.md +++ b/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getAllUpgradesByGatewayId.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getObject.md b/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getObject.md index f9e982df7f..49c9fb1ad2 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getObject.md +++ b/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_VersionUpgrade](/reference/services/SoftLayer_Network_Gateway_VersionUpgrade)::getObject + Retrieve a SoftLayer_Network_Gateway_VersionUpgrade record. diff --git a/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getVsrxOrdersAllowedOS.md b/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getVsrxOrdersAllowedOS.md index af859cb626..410fc144ee 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getVsrxOrdersAllowedOS.md +++ b/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getVsrxOrdersAllowedOS.md @@ -16,6 +16,7 @@ aliases: + ## Overview Used to get a list per package of prices ids for allowed vSRX OS-es for new orders. diff --git a/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/validateVersionChange.md b/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/validateVersionChange.md index 47284ef5c0..41e2a8fe08 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/validateVersionChange.md +++ b/content/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/validateVersionChange.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Gateway_Vlan/_index.md b/content/reference/services/SoftLayer_Network_Gateway_Vlan/_index.md index de61ee7f16..df4bd7e79b 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Vlan/_index.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Vlan/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + An inside VLAN is a VLAN which is attached to a network gateway and can be routed or bypassed. @@ -42,54 +44,63 @@ An inside VLAN is a VLAN which is attached to a network gateway and can be route #### [bypass](/reference/services/SoftLayer_Network_Gateway_Vlan/bypass) Bypass VLAN +
              #### [createObject](/reference/services/SoftLayer_Network_Gateway_Vlan/createObject) Attach a VLAN to a gateway +
              #### [createObjects](/reference/services/SoftLayer_Network_Gateway_Vlan/createObjects) Attach a VLAN to a gateway +
              #### [deleteObject](/reference/services/SoftLayer_Network_Gateway_Vlan/deleteObject) Detach VLAN +
              #### [deleteObjects](/reference/services/SoftLayer_Network_Gateway_Vlan/deleteObjects) Attach a VLAN to a gateway +
              #### [getNetworkGateway](/reference/services/SoftLayer_Network_Gateway_Vlan/getNetworkGateway) Retrieve the gateway this VLAN is attached to. +
              #### [getNetworkVlan](/reference/services/SoftLayer_Network_Gateway_Vlan/getNetworkVlan) Retrieve the network VLAN record. +
              #### [getObject](/reference/services/SoftLayer_Network_Gateway_Vlan/getObject) Retrieve a SoftLayer_Network_Gateway_Vlan record. +
              #### [unbypass](/reference/services/SoftLayer_Network_Gateway_Vlan/unbypass) Unbypass VLAN +
              diff --git a/content/reference/services/SoftLayer_Network_Gateway_Vlan/bypass.md b/content/reference/services/SoftLayer_Network_Gateway_Vlan/bypass.md index 9629f76180..ec6f9f65f7 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Vlan/bypass.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Vlan/bypass.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Vlan](/reference/services/SoftLayer_Network_Gateway_Vlan)::bypass + Bypass VLAN diff --git a/content/reference/services/SoftLayer_Network_Gateway_Vlan/createObject.md b/content/reference/services/SoftLayer_Network_Gateway_Vlan/createObject.md index c26cff27b3..5db1e6db20 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Vlan/createObject.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Vlan/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Vlan](/reference/services/SoftLayer_Network_Gateway_Vlan)::createObject + Attach a VLAN to a gateway diff --git a/content/reference/services/SoftLayer_Network_Gateway_Vlan/createObjects.md b/content/reference/services/SoftLayer_Network_Gateway_Vlan/createObjects.md index cff3caffb5..5d926c2bf8 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Vlan/createObjects.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Vlan/createObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Vlan](/reference/services/SoftLayer_Network_Gateway_Vlan)::createObjects + Attach a VLAN to a gateway diff --git a/content/reference/services/SoftLayer_Network_Gateway_Vlan/deleteObject.md b/content/reference/services/SoftLayer_Network_Gateway_Vlan/deleteObject.md index 63189beedd..8ce8c644ba 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Vlan/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Vlan/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Vlan](/reference/services/SoftLayer_Network_Gateway_Vlan)::deleteObject + Detach VLAN diff --git a/content/reference/services/SoftLayer_Network_Gateway_Vlan/deleteObjects.md b/content/reference/services/SoftLayer_Network_Gateway_Vlan/deleteObjects.md index 19a281b8d8..ebdc711394 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Vlan/deleteObjects.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Vlan/deleteObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Vlan](/reference/services/SoftLayer_Network_Gateway_Vlan)::deleteObjects + Attach a VLAN to a gateway diff --git a/content/reference/services/SoftLayer_Network_Gateway_Vlan/getNetworkGateway.md b/content/reference/services/SoftLayer_Network_Gateway_Vlan/getNetworkGateway.md index 365227ff45..3c5366dc85 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Vlan/getNetworkGateway.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Vlan/getNetworkGateway.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Vlan](/reference/services/SoftLayer_Network_Gateway_Vlan)::getNetworkGateway + Retrieve the gateway this VLAN is attached to. diff --git a/content/reference/services/SoftLayer_Network_Gateway_Vlan/getNetworkVlan.md b/content/reference/services/SoftLayer_Network_Gateway_Vlan/getNetworkVlan.md index 325acb5e03..0b83f253c0 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Vlan/getNetworkVlan.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Vlan/getNetworkVlan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Vlan](/reference/services/SoftLayer_Network_Gateway_Vlan)::getNetworkVlan + Retrieve the network VLAN record. diff --git a/content/reference/services/SoftLayer_Network_Gateway_Vlan/getObject.md b/content/reference/services/SoftLayer_Network_Gateway_Vlan/getObject.md index 67e7731faf..e7ce2ea098 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Vlan/getObject.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Vlan/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Vlan](/reference/services/SoftLayer_Network_Gateway_Vlan)::getObject + Retrieve a SoftLayer_Network_Gateway_Vlan record. diff --git a/content/reference/services/SoftLayer_Network_Gateway_Vlan/unbypass.md b/content/reference/services/SoftLayer_Network_Gateway_Vlan/unbypass.md index bc8fcedf70..f111e9128f 100644 --- a/content/reference/services/SoftLayer_Network_Gateway_Vlan/unbypass.md +++ b/content/reference/services/SoftLayer_Network_Gateway_Vlan/unbypass.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Gateway_Vlan](/reference/services/SoftLayer_Network_Gateway_Vlan)::unbypass + Unbypass VLAN diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/_index.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/_index.md index cc4a603040..5250bfabc0 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/_index.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -42,132 +44,154 @@ A network interconnect tenant defines an IP routing path through a network inter #### [allowDeleteConnection](/reference/services/SoftLayer_Network_Interconnect_Tenant/allowDeleteConnection) +
              #### [createConnection](/reference/services/SoftLayer_Network_Interconnect_Tenant/createConnection) +
              #### [deleteConnection](/reference/services/SoftLayer_Network_Interconnect_Tenant/deleteConnection) +
              #### [editConnection](/reference/services/SoftLayer_Network_Interconnect_Tenant/editConnection) +
              #### [getAllConnections](/reference/services/SoftLayer_Network_Interconnect_Tenant/getAllConnections) +
              #### [getAllObjects](/reference/services/SoftLayer_Network_Interconnect_Tenant/getAllObjects) +
              #### [getAllPortLabelsWithCurrentUsage](/reference/services/SoftLayer_Network_Interconnect_Tenant/getAllPortLabelsWithCurrentUsage) +
              #### [getBgpIpRange](/reference/services/SoftLayer_Network_Interconnect_Tenant/getBgpIpRange) +
              #### [getBillingItem](/reference/services/SoftLayer_Network_Interconnect_Tenant/getBillingItem) Retrieve the active billing item for a network interconnect. +
              #### [getConnection](/reference/services/SoftLayer_Network_Interconnect_Tenant/getConnection) +
              #### [getDatacenterName](/reference/services/SoftLayer_Network_Interconnect_Tenant/getDatacenterName) +
              #### [getDirectLinkSpeeds](/reference/services/SoftLayer_Network_Interconnect_Tenant/getDirectLinkSpeeds) +
              #### [getNetworkZones](/reference/services/SoftLayer_Network_Interconnect_Tenant/getNetworkZones) +
              #### [getObject](/reference/services/SoftLayer_Network_Interconnect_Tenant/getObject) Retrieve a SoftLayer_Network_Interconnect_Tenant record. +
              #### [getPortLabel](/reference/services/SoftLayer_Network_Interconnect_Tenant/getPortLabel) +
              #### [getPorts](/reference/services/SoftLayer_Network_Interconnect_Tenant/getPorts) +
              #### [getServiceType](/reference/services/SoftLayer_Network_Interconnect_Tenant/getServiceType) +
              #### [getVendorName](/reference/services/SoftLayer_Network_Interconnect_Tenant/getVendorName) +
              #### [getZoneName](/reference/services/SoftLayer_Network_Interconnect_Tenant/getZoneName) +
              #### [isAdnAccount](/reference/services/SoftLayer_Network_Interconnect_Tenant/isAdnAccount) +
              #### [rejectApprovalRequests](/reference/services/SoftLayer_Network_Interconnect_Tenant/rejectApprovalRequests) +
              #### [updateConnectionStatus](/reference/services/SoftLayer_Network_Interconnect_Tenant/updateConnectionStatus) +
              diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/allowDeleteConnection.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/allowDeleteConnection.md index 89e8a37f01..35c41994ad 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/allowDeleteConnection.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/allowDeleteConnection.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/createConnection.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/createConnection.md index 10024dcc62..4b698a9314 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/createConnection.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/createConnection.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/deleteConnection.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/deleteConnection.md index 7a0021ce8b..9f88a4a267 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/deleteConnection.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/deleteConnection.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/editConnection.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/editConnection.md index 2552be2026..37f2ee7437 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/editConnection.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/editConnection.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getAllConnections.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getAllConnections.md index 4024090cc0..829ad21631 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getAllConnections.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getAllConnections.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getAllObjects.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getAllObjects.md index 55407826a3..8600650b10 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getAllPortLabelsWithCurrentUsage.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getAllPortLabelsWithCurrentUsage.md index ef0b80dfa3..7ecaf2eef1 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getAllPortLabelsWithCurrentUsage.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getAllPortLabelsWithCurrentUsage.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getBgpIpRange.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getBgpIpRange.md index 488b6536e7..71cecd92e5 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getBgpIpRange.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getBgpIpRange.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getBillingItem.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getBillingItem.md index 4adca9a6ef..96d5e20f0e 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Interconnect_Tenant](/reference/services/SoftLayer_Network_Interconnect_Tenant)::getBillingItem + Retrieve the active billing item for a network interconnect. diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getConnection.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getConnection.md index e0c13ece7c..14a8403285 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getConnection.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getConnection.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getDatacenterName.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getDatacenterName.md index 9ed15bfb5e..5cd21b46af 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getDatacenterName.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getDatacenterName.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getDirectLinkSpeeds.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getDirectLinkSpeeds.md index 3305e0c1fe..6be177fc80 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getDirectLinkSpeeds.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getDirectLinkSpeeds.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getNetworkZones.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getNetworkZones.md index cb7cd893cb..e72fcf96a8 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getNetworkZones.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getNetworkZones.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getObject.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getObject.md index 807282af02..ad0e789e19 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getObject.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Interconnect_Tenant](/reference/services/SoftLayer_Network_Interconnect_Tenant)::getObject + Retrieve a SoftLayer_Network_Interconnect_Tenant record. diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getPortLabel.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getPortLabel.md index 0cde5a8470..e9d5cce74b 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getPortLabel.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getPortLabel.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getPorts.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getPorts.md index 6bdc4c7378..92bd750b92 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getPorts.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getPorts.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getServiceType.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getServiceType.md index 689fdf6421..179faa3b17 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getServiceType.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getServiceType.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getVendorName.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getVendorName.md index 03f3d4070f..a848a4c700 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getVendorName.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getVendorName.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getZoneName.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getZoneName.md index 49d21c3127..2db0e161e4 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getZoneName.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/getZoneName.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/isAdnAccount.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/isAdnAccount.md index a3a834c648..09a8e98fb8 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/isAdnAccount.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/isAdnAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/rejectApprovalRequests.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/rejectApprovalRequests.md index d1c253dd50..acddf22232 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/rejectApprovalRequests.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/rejectApprovalRequests.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/updateConnectionStatus.md b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/updateConnectionStatus.md index c46632f25e..9838ec7718 100644 --- a/content/reference/services/SoftLayer_Network_Interconnect_Tenant/updateConnectionStatus.md +++ b/content/reference/services/SoftLayer_Network_Interconnect_Tenant/updateConnectionStatus.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_LBaaS_HealthMonitor/_index.md b/content/reference/services/SoftLayer_Network_LBaaS_HealthMonitor/_index.md index e849e63c86..a1b6b43d6f 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_HealthMonitor/_index.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_HealthMonitor/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getObject](/reference/services/SoftLayer_Network_LBaaS_HealthMonitor/getObject) Retrieve a SoftLayer_Network_LBaaS_HealthMonitor record. +
              #### [updateLoadBalancerHealthMonitors](/reference/services/SoftLayer_Network_LBaaS_HealthMonitor/updateLoadBalancerHealthMonitors) Update load balancer health monitors +
              diff --git a/content/reference/services/SoftLayer_Network_LBaaS_HealthMonitor/getObject.md b/content/reference/services/SoftLayer_Network_LBaaS_HealthMonitor/getObject.md index 6008828c45..94364f56c5 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_HealthMonitor/getObject.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_HealthMonitor/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_HealthMonitor](/reference/services/SoftLayer_Network_LBaaS_HealthMonitor)::getObject + Retrieve a SoftLayer_Network_LBaaS_HealthMonitor record. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_HealthMonitor/updateLoadBalancerHealthMonitors.md b/content/reference/services/SoftLayer_Network_LBaaS_HealthMonitor/updateLoadBalancerHealthMonitors.md index 517569ba02..665cb28dc7 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_HealthMonitor/updateLoadBalancerHealthMonitors.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_HealthMonitor/updateLoadBalancerHealthMonitors.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_HealthMonitor](/reference/services/SoftLayer_Network_LBaaS_HealthMonitor)::updateLoadBalancerHealthMonitors + Update load balancer health monitors diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Member/_index.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Member/_index.md index 8000f629d1..6cce81a5e4 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Member/_index.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Member/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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". @@ -42,24 +44,28 @@ The SoftLayer_Network_LBaaS_L7Member service allows consumers to manage (backend #### [addL7PoolMembers](/reference/services/SoftLayer_Network_LBaaS_L7Member/addL7PoolMembers) Add load balancer L7 members +
              #### [deleteL7PoolMembers](/reference/services/SoftLayer_Network_LBaaS_L7Member/deleteL7PoolMembers) Delete load balancer members +
              #### [getObject](/reference/services/SoftLayer_Network_LBaaS_L7Member/getObject) Retrieve a SoftLayer_Network_LBaaS_L7Member record. +
              #### [updateL7PoolMembers](/reference/services/SoftLayer_Network_LBaaS_L7Member/updateL7PoolMembers) Update l7 members weight and port +
              diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Member/addL7PoolMembers.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Member/addL7PoolMembers.md index cd38ebdb60..22ceab155b 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Member/addL7PoolMembers.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Member/addL7PoolMembers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_L7Member](/reference/services/SoftLayer_Network_LBaaS_L7Member)::addL7PoolMembers + Add load balancer L7 members diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Member/deleteL7PoolMembers.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Member/deleteL7PoolMembers.md index ae3c934840..2ab7cb9fd1 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Member/deleteL7PoolMembers.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Member/deleteL7PoolMembers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_L7Member](/reference/services/SoftLayer_Network_LBaaS_L7Member)::deleteL7PoolMembers + Delete load balancer members diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Member/getObject.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Member/getObject.md index b2faecd7f1..90eadd30fd 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Member/getObject.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Member/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_L7Member](/reference/services/SoftLayer_Network_LBaaS_L7Member)::getObject + Retrieve a SoftLayer_Network_LBaaS_L7Member record. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Member/updateL7PoolMembers.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Member/updateL7PoolMembers.md index 0832e11d4a..0203feb8a5 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Member/updateL7PoolMembers.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Member/updateL7PoolMembers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_L7Member](/reference/services/SoftLayer_Network_LBaaS_L7Member)::updateL7PoolMembers + Update l7 members weight and port diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/_index.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/_index.md index 0568441aa1..619e7f8bbb 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/_index.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,30 +44,35 @@ The SoftLayer_Network_LBaaS_L7Policy service allows consumers to manage the Poli #### [addL7Policies](/reference/services/SoftLayer_Network_LBaaS_L7Policy/addL7Policies) Create layer 7 policies with rules for the given listener. +
              #### [deleteObject](/reference/services/SoftLayer_Network_LBaaS_L7Policy/deleteObject) Deletes a l7 policy instance and the rules associated with the policy +
              #### [editObject](/reference/services/SoftLayer_Network_LBaaS_L7Policy/editObject) Edit a l7 policy instance's properties +
              #### [getL7Rules](/reference/services/SoftLayer_Network_LBaaS_L7Policy/getL7Rules) +
              #### [getObject](/reference/services/SoftLayer_Network_LBaaS_L7Policy/getObject) Retrieve a SoftLayer_Network_LBaaS_L7Policy record. +
              diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/addL7Policies.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/addL7Policies.md index d6c1c9574e..e6be7f7203 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/addL7Policies.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/addL7Policies.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_L7Policy](/reference/services/SoftLayer_Network_LBaaS_L7Policy)::addL7Policies + Create layer 7 policies with rules for the given listener. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/deleteObject.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/deleteObject.md index bdce3ea980..56a760dc03 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_L7Policy](/reference/services/SoftLayer_Network_LBaaS_L7Policy)::deleteObject + Deletes a l7 policy instance and the rules associated with the policy diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/editObject.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/editObject.md index c628ecd8c2..7b927972c8 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/editObject.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_L7Policy](/reference/services/SoftLayer_Network_LBaaS_L7Policy)::editObject + Edit a l7 policy instance's properties diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/getL7Rules.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/getL7Rules.md index ef0b6712a8..6584e45fdc 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/getL7Rules.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/getL7Rules.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/getObject.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/getObject.md index 09fd74a3a1..87481ac066 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/getObject.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Policy/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_L7Policy](/reference/services/SoftLayer_Network_LBaaS_L7Policy)::getObject + Retrieve a SoftLayer_Network_LBaaS_L7Policy record. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/_index.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/_index.md index 3f3e405879..0b8581f460 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/_index.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,54 +44,63 @@ classes: #### [createL7Pool](/reference/services/SoftLayer_Network_LBaaS_L7Pool/createL7Pool) create L7 pools +
              #### [deleteObject](/reference/services/SoftLayer_Network_LBaaS_L7Pool/deleteObject) deletes L7 pools +
              #### [getL7HealthMonitor](/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7HealthMonitor) +
              #### [getL7Members](/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7Members) +
              #### [getL7Policies](/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7Policies) +
              #### [getL7PoolMemberHealth](/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7PoolMemberHealth) Return load balancer's all L7 pools members health +
              #### [getL7SessionAffinity](/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7SessionAffinity) +
              #### [getObject](/reference/services/SoftLayer_Network_LBaaS_L7Pool/getObject) Retrieve a SoftLayer_Network_LBaaS_L7Pool record. +
              #### [updateL7Pool](/reference/services/SoftLayer_Network_LBaaS_L7Pool/updateL7Pool) updates L7 pools +
              diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/createL7Pool.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/createL7Pool.md index 00cb724768..f85f5b8ebb 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/createL7Pool.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/createL7Pool.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_L7Pool](/reference/services/SoftLayer_Network_LBaaS_L7Pool)::createL7Pool + create L7 pools diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/deleteObject.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/deleteObject.md index 96b44f2e79..cef7515674 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_L7Pool](/reference/services/SoftLayer_Network_LBaaS_L7Pool)::deleteObject + deletes L7 pools diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7HealthMonitor.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7HealthMonitor.md index e7bdf79ef1..5e7e3f30cd 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7HealthMonitor.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7HealthMonitor.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7Members.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7Members.md index f381c4e488..4f88945262 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7Members.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7Members.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7Policies.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7Policies.md index d85ac4c173..0f8e80e6c2 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7Policies.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7Policies.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7PoolMemberHealth.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7PoolMemberHealth.md index be7112c5a4..9c7dc31452 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7PoolMemberHealth.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7PoolMemberHealth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_L7Pool](/reference/services/SoftLayer_Network_LBaaS_L7Pool)::getL7PoolMemberHealth + Return load balancer's all L7 pools members health diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7SessionAffinity.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7SessionAffinity.md index bb59009315..2071646240 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7SessionAffinity.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getL7SessionAffinity.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getObject.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getObject.md index c0b1aade1b..bf8dd40133 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getObject.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_L7Pool](/reference/services/SoftLayer_Network_LBaaS_L7Pool)::getObject + Retrieve a SoftLayer_Network_LBaaS_L7Pool record. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/updateL7Pool.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/updateL7Pool.md index cc67c76bbc..86d38fd1bb 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/updateL7Pool.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Pool/updateL7Pool.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_L7Pool](/reference/services/SoftLayer_Network_LBaaS_L7Pool)::updateL7Pool + updates L7 pools diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/_index.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/_index.md index 8a0caabf34..768eff9657 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/_index.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,24 +44,28 @@ The SoftLayer_Network_LBaaS_L7Rule service allows consumers to manage the Rules #### [addL7Rules](/reference/services/SoftLayer_Network_LBaaS_L7Rule/addL7Rules) Create and add a L7 Rule to a given L7 policy with the provided rules details. +
              #### [deleteL7Rules](/reference/services/SoftLayer_Network_LBaaS_L7Rule/deleteL7Rules) Delete one or more rules associated with the same policy. +
              #### [getObject](/reference/services/SoftLayer_Network_LBaaS_L7Rule/getObject) Retrieve a SoftLayer_Network_LBaaS_L7Rule record. +
              #### [updateL7Rules](/reference/services/SoftLayer_Network_LBaaS_L7Rule/updateL7Rules) Update one or more rules associated with the same policy. +
              diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/addL7Rules.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/addL7Rules.md index 54e2dbb8d5..e5014c5c73 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/addL7Rules.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/addL7Rules.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_L7Rule](/reference/services/SoftLayer_Network_LBaaS_L7Rule)::addL7Rules + Create and add a L7 Rule to a given L7 policy with the provided rules details. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/deleteL7Rules.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/deleteL7Rules.md index 28c217ac0a..7904ae368b 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/deleteL7Rules.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/deleteL7Rules.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_L7Rule](/reference/services/SoftLayer_Network_LBaaS_L7Rule)::deleteL7Rules + Delete one or more rules associated with the same policy. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/getObject.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/getObject.md index df56ee50e2..5762551f25 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/getObject.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_L7Rule](/reference/services/SoftLayer_Network_LBaaS_L7Rule)::getObject + Retrieve a SoftLayer_Network_LBaaS_L7Rule record. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/updateL7Rules.md b/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/updateL7Rules.md index 5f23991e71..8df9670f59 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/updateL7Rules.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_L7Rule/updateL7Rules.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_L7Rule](/reference/services/SoftLayer_Network_LBaaS_L7Rule)::updateL7Rules + Update one or more rules associated with the same policy. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_Listener/_index.md b/content/reference/services/SoftLayer_Network_LBaaS_Listener/_index.md index ff639e5722..7151e725a4 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_Listener/_index.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_Listener/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) 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. @@ -42,30 +44,35 @@ The SoftLayer_Network_LBaaS_Listener API service allows consumers to add, edit a #### [deleteLoadBalancerProtocols](/reference/services/SoftLayer_Network_LBaaS_Listener/deleteLoadBalancerProtocols) Delete load balancers front- and backend protocols +
              #### [getDefaultPool](/reference/services/SoftLayer_Network_LBaaS_Listener/getDefaultPool) +
              #### [getL7Policies](/reference/services/SoftLayer_Network_LBaaS_Listener/getL7Policies) +
              #### [getObject](/reference/services/SoftLayer_Network_LBaaS_Listener/getObject) Retrieve a SoftLayer_Network_LBaaS_Listener record. +
              #### [updateLoadBalancerProtocols](/reference/services/SoftLayer_Network_LBaaS_Listener/updateLoadBalancerProtocols) Update/create load balancers protocols +
              diff --git a/content/reference/services/SoftLayer_Network_LBaaS_Listener/deleteLoadBalancerProtocols.md b/content/reference/services/SoftLayer_Network_LBaaS_Listener/deleteLoadBalancerProtocols.md index 39b30cef51..c8420387f5 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_Listener/deleteLoadBalancerProtocols.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_Listener/deleteLoadBalancerProtocols.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_Listener](/reference/services/SoftLayer_Network_LBaaS_Listener)::deleteLoadBalancerProtocols + Delete load balancers front- and backend protocols diff --git a/content/reference/services/SoftLayer_Network_LBaaS_Listener/getDefaultPool.md b/content/reference/services/SoftLayer_Network_LBaaS_Listener/getDefaultPool.md index 4b56454c7b..29461fe3f7 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_Listener/getDefaultPool.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_Listener/getDefaultPool.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_LBaaS_Listener/getL7Policies.md b/content/reference/services/SoftLayer_Network_LBaaS_Listener/getL7Policies.md index 2c11c32de8..8b7af22684 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_Listener/getL7Policies.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_Listener/getL7Policies.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_LBaaS_Listener/getObject.md b/content/reference/services/SoftLayer_Network_LBaaS_Listener/getObject.md index 0353511bc0..cfda4f5b07 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_Listener/getObject.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_Listener/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_Listener](/reference/services/SoftLayer_Network_LBaaS_Listener)::getObject + Retrieve a SoftLayer_Network_LBaaS_Listener record. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_Listener/updateLoadBalancerProtocols.md b/content/reference/services/SoftLayer_Network_LBaaS_Listener/updateLoadBalancerProtocols.md index 6578b4331a..75e4b5d049 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_Listener/updateLoadBalancerProtocols.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_Listener/updateLoadBalancerProtocols.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_Listener](/reference/services/SoftLayer_Network_LBaaS_Listener)::updateLoadBalancerProtocols + Update/create load balancers protocols diff --git a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/_index.md b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/_index.md index 726fac91f8..29addc3cb1 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/_index.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,102 +44,119 @@ The SoftLayer_Network_LBaaS_LoadBalancer service allows customers to create, edi #### [cancelLoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/cancelLoadBalancer) Cancel the specified load balancer. +
              #### [enableOrDisableDataLogs](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/enableOrDisableDataLogs) Enable or disable data logs forwarding. +
              #### [getAllObjects](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getAllObjects) Get all existing load balancers. +
              #### [getDatacenter](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getDatacenter) Retrieve datacenter, where load balancer is located. +
              #### [getHealthMonitors](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getHealthMonitors) Retrieve health monitors for the backend members. +
              #### [getL7Pools](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getL7Pools) Retrieve l7Pools for load balancer. +
              #### [getListenerTimeSeriesData](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getListenerTimeSeriesData) Return time series datapoints +
              #### [getListeners](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getListeners) Retrieve listeners assigned to load balancer. +
              #### [getLoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancer) Get a specific load balancer. +
              #### [getLoadBalancerMemberHealth](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancerMemberHealth) Return load balancer members health +
              #### [getLoadBalancerStatistics](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancerStatistics) Return load balancers statistics +
              #### [getMembers](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getMembers) Retrieve members assigned to load balancer. +
              #### [getObject](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getObject) Retrieve a SoftLayer_Network_LBaaS_LoadBalancer record. +
              #### [getSslCiphers](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getSslCiphers) Retrieve list of preferred custom ciphers configured for the load balancer. +
              #### [serviceLoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/serviceLoadBalancer) Service function for a load balancer. +
              #### [updateLoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/updateLoadBalancer) Update a load balancer's description. +
              #### [updateSslCiphers](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/updateSslCiphers) Updates the cipher list of the load balancer +
              diff --git a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/cancelLoadBalancer.md b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/cancelLoadBalancer.md index cd3fb2a857..1e340f6913 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/cancelLoadBalancer.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/cancelLoadBalancer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_LoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer)::cancelLoadBalancer + Cancel the specified load balancer. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/enableOrDisableDataLogs.md b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/enableOrDisableDataLogs.md index 3fb569847c..861025242f 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/enableOrDisableDataLogs.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/enableOrDisableDataLogs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_LoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer)::enableOrDisableDataLogs + Enable or disable data logs forwarding. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getAllObjects.md b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getAllObjects.md index 38d68c8d98..2a0511d23b 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_LoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer)::getAllObjects + Get all existing load balancers. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getDatacenter.md b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getDatacenter.md index 5e0d3877a9..c21c6be86e 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getDatacenter.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getDatacenter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_LoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer)::getDatacenter + Retrieve datacenter, where load balancer is located. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getHealthMonitors.md b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getHealthMonitors.md index 379487c31f..0fcebec4f9 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getHealthMonitors.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getHealthMonitors.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_LoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer)::getHealthMonitors + Retrieve health monitors for the backend members. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getL7Pools.md b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getL7Pools.md index 8b5a611a2f..37642fb3f1 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getL7Pools.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getL7Pools.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_LoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer)::getL7Pools + Retrieve l7Pools for load balancer. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getListenerTimeSeriesData.md b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getListenerTimeSeriesData.md index 9eb4f55f27..edca1b19fb 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getListenerTimeSeriesData.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getListenerTimeSeriesData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_LoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer)::getListenerTimeSeriesData + Return time series datapoints diff --git a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getListeners.md b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getListeners.md index e7e4ca3fa3..d824cf4630 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getListeners.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getListeners.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_LoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer)::getListeners + Retrieve listeners assigned to load balancer. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancer.md b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancer.md index 5901d33939..eb9a49a174 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancer.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_LoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer)::getLoadBalancer + Get a specific load balancer. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancerMemberHealth.md b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancerMemberHealth.md index 2784adfaba..25c8735b83 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancerMemberHealth.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancerMemberHealth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_LoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer)::getLoadBalancerMemberHealth + Return load balancer members health diff --git a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancerStatistics.md b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancerStatistics.md index 65ee938038..5540fd579c 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancerStatistics.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getLoadBalancerStatistics.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_LoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer)::getLoadBalancerStatistics + Return load balancers statistics diff --git a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getMembers.md b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getMembers.md index 7d9986b7de..a1f5346354 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getMembers.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getMembers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_LoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer)::getMembers + Retrieve members assigned to load balancer. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getObject.md b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getObject.md index 72b4baa90c..7ef2c8c2c4 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getObject.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_LoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer)::getObject + Retrieve a SoftLayer_Network_LBaaS_LoadBalancer record. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getSslCiphers.md b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getSslCiphers.md index 7db063210f..e70bbbb063 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getSslCiphers.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/getSslCiphers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_LoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer)::getSslCiphers + Retrieve list of preferred custom ciphers configured for the load balancer. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/serviceLoadBalancer.md b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/serviceLoadBalancer.md index 156b9a7b82..7a36bd36f0 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/serviceLoadBalancer.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/serviceLoadBalancer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_LoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer)::serviceLoadBalancer + Service function for a load balancer. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/updateLoadBalancer.md b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/updateLoadBalancer.md index 64e9c05fcc..d8030adbae 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/updateLoadBalancer.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/updateLoadBalancer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_LoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer)::updateLoadBalancer + Update a load balancer's description. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/updateSslCiphers.md b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/updateSslCiphers.md index dad2950a1f..0d21597bc4 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/updateSslCiphers.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_LoadBalancer/updateSslCiphers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_LoadBalancer](/reference/services/SoftLayer_Network_LBaaS_LoadBalancer)::updateSslCiphers + Updates the cipher list of the load balancer diff --git a/content/reference/services/SoftLayer_Network_LBaaS_Member/_index.md b/content/reference/services/SoftLayer_Network_LBaaS_Member/_index.md index 77234e4797..c67217fc20 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_Member/_index.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_Member/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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". @@ -42,24 +44,28 @@ The SoftLayer_Network_LBaaS_Member service allows consumers to manage (backend) #### [addLoadBalancerMembers](/reference/services/SoftLayer_Network_LBaaS_Member/addLoadBalancerMembers) Add load balancer members +
              #### [deleteLoadBalancerMembers](/reference/services/SoftLayer_Network_LBaaS_Member/deleteLoadBalancerMembers) Delete load balancer members +
              #### [getObject](/reference/services/SoftLayer_Network_LBaaS_Member/getObject) Retrieve a SoftLayer_Network_LBaaS_Member record. +
              #### [updateLoadBalancerMembers](/reference/services/SoftLayer_Network_LBaaS_Member/updateLoadBalancerMembers) Update members weight +
              diff --git a/content/reference/services/SoftLayer_Network_LBaaS_Member/addLoadBalancerMembers.md b/content/reference/services/SoftLayer_Network_LBaaS_Member/addLoadBalancerMembers.md index c981ed2df6..8891911000 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_Member/addLoadBalancerMembers.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_Member/addLoadBalancerMembers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_Member](/reference/services/SoftLayer_Network_LBaaS_Member)::addLoadBalancerMembers + Add load balancer members diff --git a/content/reference/services/SoftLayer_Network_LBaaS_Member/deleteLoadBalancerMembers.md b/content/reference/services/SoftLayer_Network_LBaaS_Member/deleteLoadBalancerMembers.md index 86fac167e0..7807930b79 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_Member/deleteLoadBalancerMembers.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_Member/deleteLoadBalancerMembers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_Member](/reference/services/SoftLayer_Network_LBaaS_Member)::deleteLoadBalancerMembers + Delete load balancer members diff --git a/content/reference/services/SoftLayer_Network_LBaaS_Member/getObject.md b/content/reference/services/SoftLayer_Network_LBaaS_Member/getObject.md index 8d970a116c..f37993c77e 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_Member/getObject.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_Member/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_Member](/reference/services/SoftLayer_Network_LBaaS_Member)::getObject + Retrieve a SoftLayer_Network_LBaaS_Member record. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_Member/updateLoadBalancerMembers.md b/content/reference/services/SoftLayer_Network_LBaaS_Member/updateLoadBalancerMembers.md index 37dba0ccdb..61dc42d949 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_Member/updateLoadBalancerMembers.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_Member/updateLoadBalancerMembers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_Member](/reference/services/SoftLayer_Network_LBaaS_Member)::updateLoadBalancerMembers + Update members weight diff --git a/content/reference/services/SoftLayer_Network_LBaaS_SSLCipher/_index.md b/content/reference/services/SoftLayer_Network_LBaaS_SSLCipher/_index.md index c90ae848c1..2cfc803466 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_SSLCipher/_index.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_SSLCipher/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Network_LBaaS_SSLCipher/getAllObjects) Get all supported ciphers. +
              #### [getObject](/reference/services/SoftLayer_Network_LBaaS_SSLCipher/getObject) Retrieve a SoftLayer_Network_LBaaS_SSLCipher record. +
              diff --git a/content/reference/services/SoftLayer_Network_LBaaS_SSLCipher/getAllObjects.md b/content/reference/services/SoftLayer_Network_LBaaS_SSLCipher/getAllObjects.md index e887367449..d799b75425 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_SSLCipher/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_SSLCipher/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_SSLCipher](/reference/services/SoftLayer_Network_LBaaS_SSLCipher)::getAllObjects + Get all supported ciphers. diff --git a/content/reference/services/SoftLayer_Network_LBaaS_SSLCipher/getObject.md b/content/reference/services/SoftLayer_Network_LBaaS_SSLCipher/getObject.md index bdd77b62ab..59f05006bf 100644 --- a/content/reference/services/SoftLayer_Network_LBaaS_SSLCipher/getObject.md +++ b/content/reference/services/SoftLayer_Network_LBaaS_SSLCipher/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LBaaS_SSLCipher](/reference/services/SoftLayer_Network_LBaaS_SSLCipher)::getObject + Retrieve a SoftLayer_Network_LBaaS_SSLCipher record. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/_index.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/_index.md index 4603b8d55a..cc9266fa3d 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/_index.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/_index.md @@ -20,6 +20,9 @@ classes: ## Description + +
              Deprecated
              + The global load balancer service has been deprecated and is no longer available. A global load balancer account enables you to load balance traffic between servers that are in geographically diverse locations. SoftLayer's global load balancers act as a highly modified DNS server. SoftLayer's global load balancers work by accepting DNS requests for a specific hostname, choosing a host from a load balancing pool using the load balance method specified, and returning a destination IP address through a DNS response. @@ -42,58 +45,76 @@ A global load balancer account enables you to load balance traffic between serve
              -
              +
              #### [addNsRecord](/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/addNsRecord) [Deprecated] Add the required nameserver resource record for a global load balancer account. + +Deprecated + +
              -
              +
              #### [editObject](/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/editObject) [Deprecated] Edit a global load balancer account and the hosts that make up the load balancing pool. + +Deprecated + +
              #### [getAccount](/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getAccount) Retrieve your SoftLayer customer account. +
              #### [getBillingItem](/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getBillingItem) Retrieve the current billing item for a Global Load Balancer account. +
              #### [getHosts](/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getHosts) Retrieve the hosts in the load balancing pool for a global load balancer account. +
              #### [getLoadBalanceType](/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getLoadBalanceType) Retrieve the load balance method of a global load balancer account +
              #### [getManagedResourceFlag](/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getManagedResourceFlag) Retrieve a flag indicating that the global load balancer is a managed resource. +
              #### [getObject](/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getObject) Retrieve a SoftLayer_Network_LoadBalancer_Global_Account record. +
              -
              +
              #### [removeNsRecord](/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/removeNsRecord) [Deprecated] Remove the required nameserver resource record for a global load balancer account. + +Deprecated + +
              diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/addNsRecord.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/addNsRecord.md index 89832508d0..ae3ae182fa 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/addNsRecord.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/addNsRecord.md @@ -15,6 +15,8 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_Global_Account](/reference/services/SoftLayer_Network_LoadBalancer_Global_Account)::addNsRecord +
              Deprecated
              + [Deprecated] Add the required nameserver resource record for a global load balancer account. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/editObject.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/editObject.md index 0652071e67..5eb0f1f7f2 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/editObject.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/editObject.md @@ -15,6 +15,8 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_Global_Account](/reference/services/SoftLayer_Network_LoadBalancer_Global_Account)::editObject +
              Deprecated
              + [Deprecated] Edit a global load balancer account and the hosts that make up the load balancing pool. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getAccount.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getAccount.md index 57b29b8ee7..ea582801f3 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getAccount.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_Global_Account](/reference/services/SoftLayer_Network_LoadBalancer_Global_Account)::getAccount + Retrieve your SoftLayer customer account. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getBillingItem.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getBillingItem.md index 275409187f..60c3030336 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_Global_Account](/reference/services/SoftLayer_Network_LoadBalancer_Global_Account)::getBillingItem + Retrieve the current billing item for a Global Load Balancer account. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getHosts.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getHosts.md index ca1aa95c0c..208cdf6ab5 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getHosts.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getHosts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_Global_Account](/reference/services/SoftLayer_Network_LoadBalancer_Global_Account)::getHosts + Retrieve the hosts in the load balancing pool for a global load balancer account. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getLoadBalanceType.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getLoadBalanceType.md index f237ff8fef..768c0e77fb 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getLoadBalanceType.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getLoadBalanceType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_Global_Account](/reference/services/SoftLayer_Network_LoadBalancer_Global_Account)::getLoadBalanceType + Retrieve the load balance method of a global load balancer account diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getManagedResourceFlag.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getManagedResourceFlag.md index 6cd19442d2..31a02dc76e 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getManagedResourceFlag.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getManagedResourceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_Global_Account](/reference/services/SoftLayer_Network_LoadBalancer_Global_Account)::getManagedResourceFlag + Retrieve a flag indicating that the global load balancer is a managed resource. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getObject.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getObject.md index ac67d3bf10..3d7739c80c 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getObject.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_Global_Account](/reference/services/SoftLayer_Network_LoadBalancer_Global_Account)::getObject + Retrieve a SoftLayer_Network_LoadBalancer_Global_Account record. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/removeNsRecord.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/removeNsRecord.md index 66c2a8065b..5c1d85a4d8 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/removeNsRecord.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/removeNsRecord.md @@ -15,6 +15,8 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_Global_Account](/reference/services/SoftLayer_Network_LoadBalancer_Global_Account)::removeNsRecord +
              Deprecated
              + [Deprecated] Remove the required nameserver resource record for a global load balancer account. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/_index.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/_index.md index e3156f1119..a047fb7163 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/_index.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/_index.md @@ -20,6 +20,9 @@ classes:
              ## Description + +
              Deprecated
              + The global load balancer service has been deprecated and is no longer available. Every global load balancer account contains hosts that make up the load balancing pool. The global load balancers select hosts from this pool and return the destination IP in the DNS response. The SoftLayer_Network_LoadBalancer_Global_Host service represent these hosts. @@ -42,22 +45,28 @@ Every global load balancer account contains hosts that make up the load balancin
              -
              +
              #### [deleteObject](/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/deleteObject) [Deprecated] Remove a host from the load balancing pool of a global load balancer account. + +Deprecated + +
              #### [getLoadBalancerAccount](/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getLoadBalancerAccount) Retrieve the global load balancer account a host belongs to. +
              #### [getObject](/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getObject) Retrieve a SoftLayer_Network_LoadBalancer_Global_Host record. +
              diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/deleteObject.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/deleteObject.md index 24e64ff70d..59bdea9944 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/deleteObject.md @@ -15,6 +15,8 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_Global_Host](/reference/services/SoftLayer_Network_LoadBalancer_Global_Host)::deleteObject +
              Deprecated
              + [Deprecated] Remove a host from the load balancing pool of a global load balancer account. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getLoadBalancerAccount.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getLoadBalancerAccount.md index 9b31389f68..b1fc81b203 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getLoadBalancerAccount.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getLoadBalancerAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_Global_Host](/reference/services/SoftLayer_Network_LoadBalancer_Global_Host)::getLoadBalancerAccount + Retrieve the global load balancer account a host belongs to. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getObject.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getObject.md index 506d06b363..2a2727beca 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getObject.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_Global_Host](/reference/services/SoftLayer_Network_LoadBalancer_Global_Host)::getObject + Retrieve a SoftLayer_Network_LoadBalancer_Global_Host record. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Service/_index.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Service/_index.md index af4daff5b3..c04f04e197 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Service/_index.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Service/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + Load balancer services represent the "routes" that the load balancer will have available to route requests. Each service has a source port (located on the load balancer itself), and a destination IP address and port. Any services that share a source port will be used as potential routes for traffic coming into the load balancer on that port. For instance, if there are two services that both have a source port of 80, both of those services will be used as balanced servers for traffic coming into your virtual IP on port 80. For a more complete example, consider the following scenario: @@ -79,36 +81,42 @@ The affect of other variables are listed in their individual documentation. #### [deleteObject](/reference/services/SoftLayer_Network_LoadBalancer_Service/deleteObject) Delete this service, removing it from the load balancer. +
              #### [getGraphImage](/reference/services/SoftLayer_Network_LoadBalancer_Service/getGraphImage) Get the connection or status graph image for a load balancer service. +
              #### [getObject](/reference/services/SoftLayer_Network_LoadBalancer_Service/getObject) Retrieve a SoftLayer_Network_LoadBalancer_Service record. +
              #### [getStatus](/reference/services/SoftLayer_Network_LoadBalancer_Service/getStatus) Returns various status entries for this service as an array of SoftLayer_Container_Network_LoadBalancer_StatusEntry objects +
              #### [getVip](/reference/services/SoftLayer_Network_LoadBalancer_Service/getVip) Retrieve the load balancer that this service belongs to. +
              #### [resetPeakConnections](/reference/services/SoftLayer_Network_LoadBalancer_Service/resetPeakConnections) Update the PeakConnections value on the service to zero. +
              diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Service/deleteObject.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Service/deleteObject.md index 697e845efe..bec65928e6 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Service/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Service/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_Service](/reference/services/SoftLayer_Network_LoadBalancer_Service)::deleteObject + Delete this service, removing it from the load balancer. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Service/getGraphImage.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Service/getGraphImage.md index d71972254a..3ca5524ccb 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Service/getGraphImage.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Service/getGraphImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_Service](/reference/services/SoftLayer_Network_LoadBalancer_Service)::getGraphImage + Get the connection or status graph image for a load balancer service. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Service/getObject.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Service/getObject.md index 190cdecab4..b0ed956933 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Service/getObject.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Service/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_Service](/reference/services/SoftLayer_Network_LoadBalancer_Service)::getObject + Retrieve a SoftLayer_Network_LoadBalancer_Service record. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Service/getStatus.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Service/getStatus.md index a57d9ed67a..d0900fa8a4 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Service/getStatus.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Service/getStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_Service](/reference/services/SoftLayer_Network_LoadBalancer_Service)::getStatus + Returns various status entries for this service as an array of SoftLayer_Container_Network_LoadBalancer_StatusEntry objects diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Service/getVip.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Service/getVip.md index aabdd55fd4..3642767ce7 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Service/getVip.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Service/getVip.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_Service](/reference/services/SoftLayer_Network_LoadBalancer_Service)::getVip + Retrieve the load balancer that this service belongs to. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_Service/resetPeakConnections.md b/content/reference/services/SoftLayer_Network_LoadBalancer_Service/resetPeakConnections.md index 0a038d1162..9c6ad21ba1 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_Service/resetPeakConnections.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_Service/resetPeakConnections.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_Service](/reference/services/SoftLayer_Network_LoadBalancer_Service)::resetPeakConnections + Update the PeakConnections value on the service to zero. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/_index.md b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/_index.md index 3afde82762..bee9efe483 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/_index.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Each SoftLayer customer that has purchased a load balancer will have one defined in the SoftLayer_Network_LoadBalancer_VirtualIpAddress service. Load balancers have a virtual IP address and a number of SoftLayer_Network_LoadBalancer_Service objects associated with them. The SoftLayer_Network_LoadBalancer_VirtualIpAddress object is the only way for a customer to make changes to their load balancer service. Load balancers can be upgraded by using the upgradeConnectionLimit function, but this will upgrade your billing accordingly. Downgrades are currently not supported, please open a ticket to accomplish a downgrade. @@ -44,66 +46,77 @@ Load balancers can be upgraded by using the upgradeConnectionLimit function, but #### [disable](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/disable) Disable a Virtual IP Address +
              #### [editObject](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/editObject) Edit the object by passing in a modified instance of the object +
              #### [enable](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/enable) Enable a Virtual IP Address +
              #### [getAccount](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getAccount) Retrieve the account that owns this load balancer. +
              #### [getBillingItem](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getBillingItem) Retrieve the current billing item for the Load Balancer. +
              #### [getCustomerManagedFlag](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getCustomerManagedFlag) Retrieve if false, this VIP and associated services may be edited via the portal or the API. If true, you must configure this VIP manually on the device. +
              #### [getManagedResourceFlag](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getManagedResourceFlag) Retrieve a flag indicating that the load balancer is a managed resource. +
              #### [getObject](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getObject) Retrieve a SoftLayer_Network_LoadBalancer_VirtualIpAddress record. +
              #### [getServices](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getServices) Retrieve the services on this load balancer. +
              #### [kickAllConnections](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/kickAllConnections) Kick all active connections off a Virtual IP Address. +
              #### [upgradeConnectionLimit](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/upgradeConnectionLimit) Upgrades the connection limit on the Virtual IP Address and changes the billing item on your account to reflect the change. +
              diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/disable.md b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/disable.md index 8707d8569c..6a2290dcc1 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/disable.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/disable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress)::disable + Disable a Virtual IP Address diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/editObject.md b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/editObject.md index 1660246cf7..039039e084 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/editObject.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress)::editObject + Edit the object by passing in a modified instance of the object diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/enable.md b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/enable.md index b4655acaea..0369f7d57b 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/enable.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/enable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress)::enable + Enable a Virtual IP Address diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getAccount.md b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getAccount.md index dc021cee58..37dad14896 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getAccount.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress)::getAccount + Retrieve the account that owns this load balancer. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getBillingItem.md b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getBillingItem.md index 9078e8719a..cc4c5eca14 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress)::getBillingItem + Retrieve the current billing item for the Load Balancer. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getCustomerManagedFlag.md b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getCustomerManagedFlag.md index c78e1fb8c0..10d371a2b1 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getCustomerManagedFlag.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getCustomerManagedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress)::getCustomerManagedFlag + Retrieve if false, this VIP and associated services may be edited via the portal or the API. If true, you must configure this VIP manually on the device. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getManagedResourceFlag.md b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getManagedResourceFlag.md index 664bfa537b..afd914d1af 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getManagedResourceFlag.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getManagedResourceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress)::getManagedResourceFlag + Retrieve a flag indicating that the load balancer is a managed resource. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getObject.md b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getObject.md index ad7d755e62..2f256337c9 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getObject.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress)::getObject + Retrieve a SoftLayer_Network_LoadBalancer_VirtualIpAddress record. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getServices.md b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getServices.md index e5dd9fd569..257dbffb20 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getServices.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/getServices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress)::getServices + Retrieve the services on this load balancer. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/kickAllConnections.md b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/kickAllConnections.md index c95034e92f..cefecdfe23 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/kickAllConnections.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/kickAllConnections.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress)::kickAllConnections + Kick all active connections off a Virtual IP Address. diff --git a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/upgradeConnectionLimit.md b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/upgradeConnectionLimit.md index 94d3322fbe..e7d56d8b01 100644 --- a/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/upgradeConnectionLimit.md +++ b/content/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress/upgradeConnectionLimit.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_LoadBalancer_VirtualIpAddress](/reference/services/SoftLayer_Network_LoadBalancer_VirtualIpAddress)::upgradeConnectionLimit + Upgrades the connection limit on the Virtual IP Address and changes the billing item on your account to reflect the change. diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/_index.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/_index.md index eed6488400..3c90ea9e4c 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/_index.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Transcoding is a service which allows you to transcode media files to different formats. For example, if you have a Windows Media Video file you wish to stream in Flash Video format, transcoding would be the process to make this change. Individual SoftLayer customer can have a single Transcode account and you need to create a Transcode account to use the service. To create a Transcode account, go to the "Private Network" -> "Transcoding" page in the SoftLayer [https://manage.softlayer.com customer portal] or invoke [SoftLayer_Network_Media_Transcode_Account::createTranscodeAccount]({{}}) method. SoftLayer Transcoding service supports a large number of video and audio codecs. This means you can transcode many different types of movies. Refer to [http://knowledgelayer.softlayer.com/questions/409/SoftLayer+Transcoding+FAQ Transcode FAQ] for supported codes and media containers. Transcode server also has hundreds of pre-defined output formats that you can choose from. @@ -62,60 +64,70 @@ When a Transcode account is created, it creates an FTP account on the Transcode #### [createTranscodeAccount](/reference/services/SoftLayer_Network_Media_Transcode_Account/createTranscodeAccount) Creates a new transcode account +
              #### [createTranscodeJob](/reference/services/SoftLayer_Network_Media_Transcode_Account/createTranscodeJob) Creates a transcode job +
              #### [getAccount](/reference/services/SoftLayer_Network_Media_Transcode_Account/getAccount) Retrieve the SoftLayer account information +
              #### [getDirectoryInformation](/reference/services/SoftLayer_Network_Media_Transcode_Account/getDirectoryInformation) Returns a directory listing +
              #### [getFileDetail](/reference/services/SoftLayer_Network_Media_Transcode_Account/getFileDetail) Returns detailed information on a video or audio file +
              #### [getFtpAttributes](/reference/services/SoftLayer_Network_Media_Transcode_Account/getFtpAttributes) Returns Transcode FTP login credentials +
              #### [getObject](/reference/services/SoftLayer_Network_Media_Transcode_Account/getObject) Retrieve a SoftLayer_Network_Media_Transcode_Account record. +
              #### [getPresetDetail](/reference/services/SoftLayer_Network_Media_Transcode_Account/getPresetDetail) Returns details on a transcode output preset +
              #### [getPresets](/reference/services/SoftLayer_Network_Media_Transcode_Account/getPresets) Returns an array of transcoding preset objects +
              #### [getTranscodeJobs](/reference/services/SoftLayer_Network_Media_Transcode_Account/getTranscodeJobs) Retrieve transcode jobs +
              diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/createTranscodeAccount.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/createTranscodeAccount.md index 053fcd451b..5d7558eca0 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/createTranscodeAccount.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/createTranscodeAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Media_Transcode_Account](/reference/services/SoftLayer_Network_Media_Transcode_Account)::createTranscodeAccount + Creates a new transcode account diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/createTranscodeJob.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/createTranscodeJob.md index 5f4444327f..6e3eb14e7a 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/createTranscodeJob.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/createTranscodeJob.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Media_Transcode_Account](/reference/services/SoftLayer_Network_Media_Transcode_Account)::createTranscodeJob + Creates a transcode job diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getAccount.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getAccount.md index f8e61dc323..9d15d390b8 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Media_Transcode_Account](/reference/services/SoftLayer_Network_Media_Transcode_Account)::getAccount + Retrieve the SoftLayer account information diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getDirectoryInformation.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getDirectoryInformation.md index 6b129e4ba1..82b76e7838 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getDirectoryInformation.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getDirectoryInformation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Media_Transcode_Account](/reference/services/SoftLayer_Network_Media_Transcode_Account)::getDirectoryInformation + Returns a directory listing diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getFileDetail.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getFileDetail.md index 92f56a489c..f3592b42c7 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getFileDetail.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getFileDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Media_Transcode_Account](/reference/services/SoftLayer_Network_Media_Transcode_Account)::getFileDetail + Returns detailed information on a video or audio file diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getFtpAttributes.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getFtpAttributes.md index 5581831497..f4eeb75807 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getFtpAttributes.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getFtpAttributes.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Media_Transcode_Account](/reference/services/SoftLayer_Network_Media_Transcode_Account)::getFtpAttributes + Returns Transcode FTP login credentials diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getObject.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getObject.md index a24c5cef63..b7fa95ffaf 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getObject.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Media_Transcode_Account](/reference/services/SoftLayer_Network_Media_Transcode_Account)::getObject + Retrieve a SoftLayer_Network_Media_Transcode_Account record. diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getPresetDetail.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getPresetDetail.md index df71931ef7..007b0de873 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getPresetDetail.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getPresetDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Media_Transcode_Account](/reference/services/SoftLayer_Network_Media_Transcode_Account)::getPresetDetail + Returns details on a transcode output preset diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getPresets.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getPresets.md index 80b11efb6c..db90c9f5ea 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getPresets.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getPresets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Media_Transcode_Account](/reference/services/SoftLayer_Network_Media_Transcode_Account)::getPresets + Returns an array of transcoding preset objects diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getTranscodeJobs.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getTranscodeJobs.md index a8289964ca..aac7a29a64 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getTranscodeJobs.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Account/getTranscodeJobs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Media_Transcode_Account](/reference/services/SoftLayer_Network_Media_Transcode_Account)::getTranscodeJobs + Retrieve transcode jobs diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Job/_index.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Job/_index.md index 0a361cb8bf..f2cdb647d1 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Job/_index.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Job/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Network_Media_Transcode_Job holds information on a transcode job. To create a transcode job, use a [SoftLayer_Network_Media_Transcode_Account]({{}}) object. @@ -42,42 +44,49 @@ SoftLayer_Network_Media_Transcode_Job holds information on a transcode job. To c #### [createObject](/reference/services/SoftLayer_Network_Media_Transcode_Job/createObject) Creates a transcode job +
              #### [getHistory](/reference/services/SoftLayer_Network_Media_Transcode_Job/getHistory) +
              #### [getObject](/reference/services/SoftLayer_Network_Media_Transcode_Job/getObject) Retrieve a SoftLayer_Network_Media_Transcode_Job record. +
              #### [getTranscodeAccount](/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeAccount) Retrieve the transcode service account +
              #### [getTranscodeStatus](/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeStatus) Retrieve the status information of a transcode job +
              #### [getTranscodeStatusName](/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeStatusName) Retrieve the status of a transcode job +
              #### [getUser](/reference/services/SoftLayer_Network_Media_Transcode_Job/getUser) Retrieve the SoftLayer user that created the transcode job +
              diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Job/createObject.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Job/createObject.md index 9882ad2584..f4d279b976 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Job/createObject.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Job/createObject.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Media_Transcode_Job](/reference/services/SoftLayer_Network_Media_Transcode_Job)::createObject + Creates a transcode job diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getHistory.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getHistory.md index 30f12e6b3a..1c5ab088c3 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getHistory.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getHistory.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getObject.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getObject.md index bd0f071bfe..ffca24df8c 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getObject.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Media_Transcode_Job](/reference/services/SoftLayer_Network_Media_Transcode_Job)::getObject + Retrieve a SoftLayer_Network_Media_Transcode_Job record. diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeAccount.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeAccount.md index 0d136bbc5c..11cd334258 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeAccount.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Media_Transcode_Job](/reference/services/SoftLayer_Network_Media_Transcode_Job)::getTranscodeAccount + Retrieve the transcode service account diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeStatus.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeStatus.md index ca668bc8cb..3db815017e 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeStatus.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Media_Transcode_Job](/reference/services/SoftLayer_Network_Media_Transcode_Job)::getTranscodeStatus + Retrieve the status information of a transcode job diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeStatusName.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeStatusName.md index 63dbe46e6a..6cb4a54092 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeStatusName.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeStatusName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Media_Transcode_Job](/reference/services/SoftLayer_Network_Media_Transcode_Job)::getTranscodeStatusName + Retrieve the status of a transcode job diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getUser.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getUser.md index 41128442fa..1c2ad7dad9 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getUser.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Job/getUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Media_Transcode_Job](/reference/services/SoftLayer_Network_Media_Transcode_Job)::getUser + Retrieve the SoftLayer user that created the transcode job diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/_index.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/_index.md index e976a8019d..2aaac3e360 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/_index.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A Transcode job's status. It can be Pending, Processing, Complete, Error or Deleted. @@ -42,12 +44,14 @@ A Transcode job's status. It can be Pending, Processing, Complete, Error or Dele #### [getAllStatuses](/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/getAllStatuses) Returns all transcode job statuses +
              #### [getObject](/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/getObject) Retrieve a SoftLayer_Network_Media_Transcode_Job_Status record. +
              diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/getAllStatuses.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/getAllStatuses.md index 41d7fd6c29..95105c9762 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/getAllStatuses.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/getAllStatuses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Media_Transcode_Job_Status](/reference/services/SoftLayer_Network_Media_Transcode_Job_Status)::getAllStatuses + Returns all transcode job statuses diff --git a/content/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/getObject.md b/content/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/getObject.md index 0f5062236a..ca5bda0d29 100644 --- a/content/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/getObject.md +++ b/content/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Media_Transcode_Job_Status](/reference/services/SoftLayer_Network_Media_Transcode_Job_Status)::getObject + Retrieve a SoftLayer_Network_Media_Transcode_Job_Status record. diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery/_index.md b/content/reference/services/SoftLayer_Network_Message_Delivery/_index.md index 4dd6964782..21090f25bc 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery/_index.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,36 +44,42 @@ classes: #### [editObject](/reference/services/SoftLayer_Network_Message_Delivery/editObject) +
              #### [getAccount](/reference/services/SoftLayer_Network_Message_Delivery/getAccount) Retrieve the SoftLayer customer account that a network message delivery account belongs to. +
              #### [getBillingItem](/reference/services/SoftLayer_Network_Message_Delivery/getBillingItem) Retrieve the billing item for a network message delivery account. +
              #### [getObject](/reference/services/SoftLayer_Network_Message_Delivery/getObject) Retrieve a SoftLayer_Network_Message_Delivery record. +
              #### [getType](/reference/services/SoftLayer_Network_Message_Delivery/getType) Retrieve the message delivery type of a network message delivery account. +
              #### [getVendor](/reference/services/SoftLayer_Network_Message_Delivery/getVendor) Retrieve the vendor for a network message delivery account. +
              diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery/editObject.md b/content/reference/services/SoftLayer_Network_Message_Delivery/editObject.md index aef2115117..1c3074f5ed 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery/editObject.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery/getAccount.md b/content/reference/services/SoftLayer_Network_Message_Delivery/getAccount.md index a89f38c8be..bfc4b3d969 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Message_Delivery](/reference/services/SoftLayer_Network_Message_Delivery)::getAccount + Retrieve the SoftLayer customer account that a network message delivery account belongs to. diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery/getBillingItem.md b/content/reference/services/SoftLayer_Network_Message_Delivery/getBillingItem.md index 6322c9c018..25801e3ac9 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Message_Delivery](/reference/services/SoftLayer_Network_Message_Delivery)::getBillingItem + Retrieve the billing item for a network message delivery account. diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery/getObject.md b/content/reference/services/SoftLayer_Network_Message_Delivery/getObject.md index 20a16f7eb1..910e8f44f7 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery/getObject.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Message_Delivery](/reference/services/SoftLayer_Network_Message_Delivery)::getObject + Retrieve a SoftLayer_Network_Message_Delivery record. diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery/getType.md b/content/reference/services/SoftLayer_Network_Message_Delivery/getType.md index 1842fd75c9..028ee0b620 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery/getType.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Message_Delivery](/reference/services/SoftLayer_Network_Message_Delivery)::getType + Retrieve the message delivery type of a network message delivery account. diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery/getVendor.md b/content/reference/services/SoftLayer_Network_Message_Delivery/getVendor.md index 3891137e3a..e3fd280c9a 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery/getVendor.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery/getVendor.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Message_Delivery](/reference/services/SoftLayer_Network_Message_Delivery)::getVendor + Retrieve the vendor for a network message delivery account. diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/_index.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/_index.md index dbf8c8566f..c2ff718e3b 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/_index.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,120 +44,140 @@ classes: #### [addUnsubscribeEmailAddress](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/addUnsubscribeEmailAddress) +
              #### [deleteEmailListEntries](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/deleteEmailListEntries) +
              #### [disableSmtpAccess](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/disableSmtpAccess) +
              #### [editObject](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/editObject) +
              #### [enableSmtpAccess](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/enableSmtpAccess) +
              #### [getAccount](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getAccount) Retrieve the SoftLayer customer account that a network message delivery account belongs to. +
              #### [getAccountOverview](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getAccountOverview) +
              #### [getBillingItem](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getBillingItem) Retrieve the billing item for a network message delivery account. +
              #### [getCategoryList](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getCategoryList) +
              #### [getEmailAddress](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getEmailAddress) Retrieve the contact e-mail address used by SendGrid. +
              #### [getEmailList](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getEmailList) +
              #### [getObject](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getObject) Retrieve a SoftLayer_Network_Message_Delivery_Email_Sendgrid record. +
              #### [getSmtpAccess](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getSmtpAccess) Retrieve a flag that determines if a SendGrid e-mail delivery account has access to send mail through the SendGrid SMTP server. +
              #### [getStatistics](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getStatistics) +
              #### [getStatisticsGraph](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getStatisticsGraph) +
              #### [getType](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getType) Retrieve the message delivery type of a network message delivery account. +
              #### [getVendor](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getVendor) Retrieve the vendor for a network message delivery account. +
              #### [getVendorPortalUrl](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getVendorPortalUrl) +
              #### [sendEmail](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/sendEmail) This method is deprecated and will be removed in API version 3.2. +
              #### [updateEmailAddress](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/updateEmailAddress) +
              diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/addUnsubscribeEmailAddress.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/addUnsubscribeEmailAddress.md index 096cc6cf58..600246ac9e 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/addUnsubscribeEmailAddress.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/addUnsubscribeEmailAddress.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/deleteEmailListEntries.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/deleteEmailListEntries.md index 5edd5ec8db..8897be1f07 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/deleteEmailListEntries.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/deleteEmailListEntries.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/disableSmtpAccess.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/disableSmtpAccess.md index ed7e74b675..2e7cba0232 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/disableSmtpAccess.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/disableSmtpAccess.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/editObject.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/editObject.md index a0cc155d03..af584b9107 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/editObject.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/enableSmtpAccess.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/enableSmtpAccess.md index 6d5b6a27e2..ae76652820 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/enableSmtpAccess.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/enableSmtpAccess.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getAccount.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getAccount.md index 223b52a3e3..65c50d1d1d 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Message_Delivery_Email_Sendgrid](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid)::getAccount + Retrieve the SoftLayer customer account that a network message delivery account belongs to. diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getAccountOverview.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getAccountOverview.md index 77f4463127..ea946ba2c8 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getAccountOverview.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getAccountOverview.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getBillingItem.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getBillingItem.md index 27cc4ec430..ffd54d34a0 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Message_Delivery_Email_Sendgrid](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid)::getBillingItem + Retrieve the billing item for a network message delivery account. diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getCategoryList.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getCategoryList.md index 75a3cf35cc..9426ede87b 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getCategoryList.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getCategoryList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getEmailAddress.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getEmailAddress.md index 87ab42ec2e..6266e3a0a0 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getEmailAddress.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getEmailAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Message_Delivery_Email_Sendgrid](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid)::getEmailAddress + Retrieve the contact e-mail address used by SendGrid. diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getEmailList.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getEmailList.md index 846b9a8771..66ccc22536 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getEmailList.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getEmailList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getObject.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getObject.md index cb565d017d..d53d48dd45 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getObject.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Message_Delivery_Email_Sendgrid](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid)::getObject + Retrieve a SoftLayer_Network_Message_Delivery_Email_Sendgrid record. diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getSmtpAccess.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getSmtpAccess.md index bcbd8de3fa..bc6723f371 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getSmtpAccess.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getSmtpAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Message_Delivery_Email_Sendgrid](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid)::getSmtpAccess + Retrieve a flag that determines if a SendGrid e-mail delivery account has access to send mail through the SendGrid SMTP server. diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getStatistics.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getStatistics.md index af3e90ff38..6d2eb31cc9 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getStatistics.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getStatistics.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getStatisticsGraph.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getStatisticsGraph.md index 85374d9a19..9ecd44d1d9 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getStatisticsGraph.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getStatisticsGraph.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getType.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getType.md index 6ea7aed2ab..7deb22619c 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getType.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Message_Delivery_Email_Sendgrid](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid)::getType + Retrieve the message delivery type of a network message delivery account. diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getVendor.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getVendor.md index d5d55d7d6f..a7df108790 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getVendor.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getVendor.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Message_Delivery_Email_Sendgrid](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid)::getVendor + Retrieve the vendor for a network message delivery account. diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getVendorPortalUrl.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getVendorPortalUrl.md index ec205c19b4..fcfe4b8828 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getVendorPortalUrl.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/getVendorPortalUrl.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/sendEmail.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/sendEmail.md index cbaeb02943..1c8f360632 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/sendEmail.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/sendEmail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Message_Delivery_Email_Sendgrid](/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid)::sendEmail + This method is deprecated and will be removed in API version 3.2. diff --git a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/updateEmailAddress.md b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/updateEmailAddress.md index 107b15c489..7c5dc508c4 100644 --- a/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/updateEmailAddress.md +++ b/content/reference/services/SoftLayer_Network_Message_Delivery_Email_Sendgrid/updateEmailAddress.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Monitor/_index.md b/content/reference/services/SoftLayer_Network_Monitor/_index.md index eb77264874..a3e510a5ff 100644 --- a/content/reference/services/SoftLayer_Network_Monitor/_index.md +++ b/content/reference/services/SoftLayer_Network_Monitor/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getIpAddressesByHardware](/reference/services/SoftLayer_Network_Monitor/getIpAddressesByHardware) Returns an ArrayObject of subnet ip address objects for a hardware +
              #### [getIpAddressesByVirtualGuest](/reference/services/SoftLayer_Network_Monitor/getIpAddressesByVirtualGuest) Returns an ArrayObject of subnet ip address objects for a guest resource. +
              diff --git a/content/reference/services/SoftLayer_Network_Monitor/getIpAddressesByHardware.md b/content/reference/services/SoftLayer_Network_Monitor/getIpAddressesByHardware.md index e502c8a14c..d78552c1e7 100644 --- a/content/reference/services/SoftLayer_Network_Monitor/getIpAddressesByHardware.md +++ b/content/reference/services/SoftLayer_Network_Monitor/getIpAddressesByHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Monitor](/reference/services/SoftLayer_Network_Monitor)::getIpAddressesByHardware + Returns an ArrayObject of subnet ip address objects for a hardware diff --git a/content/reference/services/SoftLayer_Network_Monitor/getIpAddressesByVirtualGuest.md b/content/reference/services/SoftLayer_Network_Monitor/getIpAddressesByVirtualGuest.md index 879fa4ea15..95fecac5cc 100644 --- a/content/reference/services/SoftLayer_Network_Monitor/getIpAddressesByVirtualGuest.md +++ b/content/reference/services/SoftLayer_Network_Monitor/getIpAddressesByVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Monitor](/reference/services/SoftLayer_Network_Monitor)::getIpAddressesByVirtualGuest + Returns an ArrayObject of subnet ip address objects for a guest resource. diff --git a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/_index.md b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/_index.md index 87fe005fea..cecf286126 100644 --- a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/_index.md +++ b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -46,72 +48,84 @@ If the user wishes to be notified, or have other users on the account notified w #### [createObject](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/createObject) Create a monitoring entry +
              #### [createObjects](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/createObjects) Create multiple monitoring entries at once +
              #### [deleteObject](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/deleteObject) Delete a Query_Host object by passing in a version of it +
              #### [deleteObjects](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/deleteObjects) Delete a group of Query_Host objects by passing in a collection of them +
              #### [editObject](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/editObject) Edit the object by passing in a modified instance of the object +
              #### [editObjects](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/editObjects) Edit a group of Query_Host objects by passing in a collection of them. +
              #### [findByHardwareId](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/findByHardwareId) Return all monitoring instances associated with the passed hardware ID +
              #### [getHardware](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getHardware) Retrieve the hardware that is being monitored by this monitoring instance +
              #### [getLastResult](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getLastResult) Retrieve the most recent result for this particular monitoring instance. +
              #### [getObject](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getObject) Retrieve a SoftLayer_Network_Monitor_Version1_Query_Host record. +
              #### [getQueryType](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getQueryType) Retrieve the type of monitoring query that is executed when this hardware is monitored. +
              #### [getResponseAction](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getResponseAction) Retrieve the action taken when a monitor fails. +
              diff --git a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/createObject.md b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/createObject.md index 85762a19cc..750c870190 100644 --- a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/createObject.md +++ b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Monitor_Version1_Query_Host](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host)::createObject + Create a monitoring entry diff --git a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/createObjects.md b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/createObjects.md index 46315669f0..8c50f7a24e 100644 --- a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/createObjects.md +++ b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/createObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Monitor_Version1_Query_Host](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host)::createObjects + Create multiple monitoring entries at once diff --git a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/deleteObject.md b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/deleteObject.md index 169080733d..d5dbc77fcc 100644 --- a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Monitor_Version1_Query_Host](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host)::deleteObject + Delete a Query_Host object by passing in a version of it diff --git a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/deleteObjects.md b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/deleteObjects.md index 1a5b0a39f8..8c88a51c92 100644 --- a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/deleteObjects.md +++ b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/deleteObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Monitor_Version1_Query_Host](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host)::deleteObjects + Delete a group of Query_Host objects by passing in a collection of them diff --git a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/editObject.md b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/editObject.md index 94b7b34af8..0e7299ec59 100644 --- a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/editObject.md +++ b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Monitor_Version1_Query_Host](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host)::editObject + Edit the object by passing in a modified instance of the object diff --git a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/editObjects.md b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/editObjects.md index e32a886d33..465216da1c 100644 --- a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/editObjects.md +++ b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/editObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Monitor_Version1_Query_Host](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host)::editObjects + Edit a group of Query_Host objects by passing in a collection of them. diff --git a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/findByHardwareId.md b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/findByHardwareId.md index b87b3c74f1..a9163da1a3 100644 --- a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/findByHardwareId.md +++ b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/findByHardwareId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Monitor_Version1_Query_Host](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host)::findByHardwareId + Return all monitoring instances associated with the passed hardware ID diff --git a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getHardware.md b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getHardware.md index 81ac6d1d9a..f84d87b7a5 100644 --- a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getHardware.md +++ b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Monitor_Version1_Query_Host](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host)::getHardware + Retrieve the hardware that is being monitored by this monitoring instance diff --git a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getLastResult.md b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getLastResult.md index 8236acef35..0825a3e026 100644 --- a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getLastResult.md +++ b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getLastResult.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Monitor_Version1_Query_Host](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host)::getLastResult + Retrieve the most recent result for this particular monitoring instance. diff --git a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getObject.md b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getObject.md index 587b7546a0..cd58e62d21 100644 --- a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getObject.md +++ b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Monitor_Version1_Query_Host](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host)::getObject + Retrieve a SoftLayer_Network_Monitor_Version1_Query_Host record. diff --git a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getQueryType.md b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getQueryType.md index 7de7bf63d5..abbd247d11 100644 --- a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getQueryType.md +++ b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getQueryType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Monitor_Version1_Query_Host](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host)::getQueryType + Retrieve the type of monitoring query that is executed when this hardware is monitored. diff --git a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getResponseAction.md b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getResponseAction.md index d70cde2c24..91952dac59 100644 --- a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getResponseAction.md +++ b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host/getResponseAction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Monitor_Version1_Query_Host](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host)::getResponseAction + Retrieve the action taken when a monitor fails. diff --git a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/_index.md b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/_index.md index 19c7932876..e6c77ad33e 100644 --- a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/_index.md +++ b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This service is for reference only. It can be changed by purchasing higher monitoring levels through the portal. @@ -42,24 +44,28 @@ This service is for reference only. It can be changed by purchasing higher moni #### [getAllQueryTypes](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getAllQueryTypes) Return all Query_Type objects. +
              #### [getAllResponseTypes](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getAllResponseTypes) Return all ResponseType objects. +
              #### [getHardware](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getHardware) Retrieve the hardware object that these monitoring permissions applies to. +
              #### [getObject](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getObject) Retrieve a SoftLayer_Network_Monitor_Version1_Query_Host_Stratum record. +
              diff --git a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getAllQueryTypes.md b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getAllQueryTypes.md index db330b8af0..2a6171004f 100644 --- a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getAllQueryTypes.md +++ b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getAllQueryTypes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Monitor_Version1_Query_Host_Stratum](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum)::getAllQueryTypes + Return all Query_Type objects. diff --git a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getAllResponseTypes.md b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getAllResponseTypes.md index 1ad4af4c71..a1ef178971 100644 --- a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getAllResponseTypes.md +++ b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getAllResponseTypes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Monitor_Version1_Query_Host_Stratum](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum)::getAllResponseTypes + Return all ResponseType objects. diff --git a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getHardware.md b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getHardware.md index 04bae0a6fa..54a24106f7 100644 --- a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getHardware.md +++ b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Monitor_Version1_Query_Host_Stratum](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum)::getHardware + Retrieve the hardware object that these monitoring permissions applies to. diff --git a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getObject.md b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getObject.md index 0cb507e834..b71815553e 100644 --- a/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getObject.md +++ b/content/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Monitor_Version1_Query_Host_Stratum](/reference/services/SoftLayer_Network_Monitor_Version1_Query_Host_Stratum)::getObject + Retrieve a SoftLayer_Network_Monitor_Version1_Query_Host_Stratum record. diff --git a/content/reference/services/SoftLayer_Network_Pod/_index.md b/content/reference/services/SoftLayer_Network_Pod/_index.md index 6ec163093b..96db09c8d0 100644 --- a/content/reference/services/SoftLayer_Network_Pod/_index.md +++ b/content/reference/services/SoftLayer_Network_Pod/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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:
              • dal09.pod01 = Dallas 9, Pod 1 (ie. bcr01)
              • sjc01.pod04 = San Jose 1, Pod 4 (ie. bcr04)
              • ams01.pod01 = Amsterdam 1, Pod 1 (ie. bcr01)
              @@ -44,24 +46,28 @@ A ``Pod`` is identified by a ``name``, which is unique. A Pod name follows the f #### [getAllObjects](/reference/services/SoftLayer_Network_Pod/getAllObjects) Retrieve a list of Pods; optionally filtered via datacenter and/or capabilities. +
              #### [getCapabilities](/reference/services/SoftLayer_Network_Pod/getCapabilities) Retrieve capabilities for the Pod. +
              #### [getObject](/reference/services/SoftLayer_Network_Pod/getObject) Retrieve a Pod by name. +
              #### [listCapabilities](/reference/services/SoftLayer_Network_Pod/listCapabilities) Retrieve a list of all possible capabilities Pods may fulfill. +
              diff --git a/content/reference/services/SoftLayer_Network_Pod/getAllObjects.md b/content/reference/services/SoftLayer_Network_Pod/getAllObjects.md index b0ceac4d0f..748f58c152 100644 --- a/content/reference/services/SoftLayer_Network_Pod/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Pod/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Pod](/reference/services/SoftLayer_Network_Pod)::getAllObjects + Retrieve a list of Pods; optionally filtered via datacenter and/or capabilities. diff --git a/content/reference/services/SoftLayer_Network_Pod/getCapabilities.md b/content/reference/services/SoftLayer_Network_Pod/getCapabilities.md index 2dd3bfb3ee..d07630b84c 100644 --- a/content/reference/services/SoftLayer_Network_Pod/getCapabilities.md +++ b/content/reference/services/SoftLayer_Network_Pod/getCapabilities.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Pod](/reference/services/SoftLayer_Network_Pod)::getCapabilities + Retrieve capabilities for the Pod. diff --git a/content/reference/services/SoftLayer_Network_Pod/getObject.md b/content/reference/services/SoftLayer_Network_Pod/getObject.md index a1ee8d9a92..0dc65c7052 100644 --- a/content/reference/services/SoftLayer_Network_Pod/getObject.md +++ b/content/reference/services/SoftLayer_Network_Pod/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Pod](/reference/services/SoftLayer_Network_Pod)::getObject + Retrieve a Pod by name. diff --git a/content/reference/services/SoftLayer_Network_Pod/listCapabilities.md b/content/reference/services/SoftLayer_Network_Pod/listCapabilities.md index c8c7337fec..8508455f56 100644 --- a/content/reference/services/SoftLayer_Network_Pod/listCapabilities.md +++ b/content/reference/services/SoftLayer_Network_Pod/listCapabilities.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Pod](/reference/services/SoftLayer_Network_Pod)::listCapabilities + Retrieve a list of all possible capabilities Pods may fulfill. diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/_index.md b/content/reference/services/SoftLayer_Network_SecurityGroup/_index.md index ba4461d2a4..fe69077a09 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/_index.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}). 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/ @@ -44,114 +46,133 @@ Additional information can be found in IBM Cloud Docs and SoftLayer API Examples #### [addRules](/reference/services/SoftLayer_Network_SecurityGroup/addRules) Add new rules to a security group. +
              #### [attachNetworkComponents](/reference/services/SoftLayer_Network_SecurityGroup/attachNetworkComponents) Attach network components to a security group by creating a network component binding. +
              #### [createObject](/reference/services/SoftLayer_Network_SecurityGroup/createObject) Create a new security group. +
              #### [createObjects](/reference/services/SoftLayer_Network_SecurityGroup/createObjects) Create new security groups. +
              #### [deleteObject](/reference/services/SoftLayer_Network_SecurityGroup/deleteObject) Delete a security group. +
              #### [deleteObjects](/reference/services/SoftLayer_Network_SecurityGroup/deleteObjects) Delete security groups. +
              #### [detachNetworkComponents](/reference/services/SoftLayer_Network_SecurityGroup/detachNetworkComponents) Detach network components from a security group by deleting its network component binding. +
              #### [editObject](/reference/services/SoftLayer_Network_SecurityGroup/editObject) Edit a security group. +
              #### [editObjects](/reference/services/SoftLayer_Network_SecurityGroup/editObjects) Edit security groups. +
              #### [editRules](/reference/services/SoftLayer_Network_SecurityGroup/editRules) Edit rules that belong to a security group. +
              #### [getAccount](/reference/services/SoftLayer_Network_SecurityGroup/getAccount) Retrieve the account this security group belongs to. +
              #### [getAllObjects](/reference/services/SoftLayer_Network_SecurityGroup/getAllObjects) Get all security groups. +
              #### [getLimits](/reference/services/SoftLayer_Network_SecurityGroup/getLimits) List the current security group limits +
              #### [getNetworkComponentBindings](/reference/services/SoftLayer_Network_SecurityGroup/getNetworkComponentBindings) Retrieve the network component bindings for this security group. +
              #### [getObject](/reference/services/SoftLayer_Network_SecurityGroup/getObject) Retrieve a SoftLayer_Network_SecurityGroup record. +
              #### [getOrderBindings](/reference/services/SoftLayer_Network_SecurityGroup/getOrderBindings) Retrieve the order bindings for this security group +
              #### [getRules](/reference/services/SoftLayer_Network_SecurityGroup/getRules) Retrieve the rules for this security group. +
              #### [getSupportedDataCenters](/reference/services/SoftLayer_Network_SecurityGroup/getSupportedDataCenters) List the data centers that currently support the use of security groups. +
              #### [removeRules](/reference/services/SoftLayer_Network_SecurityGroup/removeRules) Remove rules from a security group. +
              diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/addRules.md b/content/reference/services/SoftLayer_Network_SecurityGroup/addRules.md index 877035cbe5..70297d1ece 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/addRules.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/addRules.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::addRules + Add new rules to a security group. diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/attachNetworkComponents.md b/content/reference/services/SoftLayer_Network_SecurityGroup/attachNetworkComponents.md index 6d5dfbf229..5dc836f576 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/attachNetworkComponents.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/attachNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::attachNetworkComponents + Attach network components to a security group by creating a network component binding. diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/createObject.md b/content/reference/services/SoftLayer_Network_SecurityGroup/createObject.md index 70543d8066..04cf36f985 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/createObject.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::createObject + Create a new security group. diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/createObjects.md b/content/reference/services/SoftLayer_Network_SecurityGroup/createObjects.md index f1e2bd07e0..c4d0540770 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/createObjects.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/createObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::createObjects + Create new security groups. diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/deleteObject.md b/content/reference/services/SoftLayer_Network_SecurityGroup/deleteObject.md index c36d92d0b3..b434452f76 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::deleteObject + Delete a security group. diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/deleteObjects.md b/content/reference/services/SoftLayer_Network_SecurityGroup/deleteObjects.md index 8cc206f8de..5cc311df8d 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/deleteObjects.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/deleteObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::deleteObjects + Delete security groups. diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/detachNetworkComponents.md b/content/reference/services/SoftLayer_Network_SecurityGroup/detachNetworkComponents.md index f152bf8a6c..39b7f02d17 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/detachNetworkComponents.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/detachNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::detachNetworkComponents + Detach network components from a security group by deleting its network component binding. diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/editObject.md b/content/reference/services/SoftLayer_Network_SecurityGroup/editObject.md index 691b897cf1..d88a17a7e8 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/editObject.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::editObject + Edit a security group. diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/editObjects.md b/content/reference/services/SoftLayer_Network_SecurityGroup/editObjects.md index f1eb7dfef2..08bc365772 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/editObjects.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/editObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::editObjects + Edit security groups. diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/editRules.md b/content/reference/services/SoftLayer_Network_SecurityGroup/editRules.md index 4b8ca6bbdd..24f3faf2c4 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/editRules.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/editRules.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::editRules + Edit rules that belong to a security group. diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/getAccount.md b/content/reference/services/SoftLayer_Network_SecurityGroup/getAccount.md index 2f2ae7b645..3ad831453d 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/getAccount.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::getAccount + Retrieve the account this security group belongs to. diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/getAllObjects.md b/content/reference/services/SoftLayer_Network_SecurityGroup/getAllObjects.md index 78fa368443..14be8bc7e9 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::getAllObjects + Get all security groups. diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/getLimits.md b/content/reference/services/SoftLayer_Network_SecurityGroup/getLimits.md index 00bd869f19..1685ebb3de 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/getLimits.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/getLimits.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::getLimits + List the current security group limits diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/getNetworkComponentBindings.md b/content/reference/services/SoftLayer_Network_SecurityGroup/getNetworkComponentBindings.md index 6d0450c072..a934034649 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/getNetworkComponentBindings.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/getNetworkComponentBindings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::getNetworkComponentBindings + Retrieve the network component bindings for this security group. diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/getObject.md b/content/reference/services/SoftLayer_Network_SecurityGroup/getObject.md index bc4e75f341..6ca6001412 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/getObject.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::getObject + Retrieve a SoftLayer_Network_SecurityGroup record. diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/getOrderBindings.md b/content/reference/services/SoftLayer_Network_SecurityGroup/getOrderBindings.md index ed823e90b0..d791b12c77 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/getOrderBindings.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/getOrderBindings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::getOrderBindings + Retrieve the order bindings for this security group diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/getRules.md b/content/reference/services/SoftLayer_Network_SecurityGroup/getRules.md index eb52dd44b3..b42a96cada 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/getRules.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/getRules.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::getRules + Retrieve the rules for this security group. diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/getSupportedDataCenters.md b/content/reference/services/SoftLayer_Network_SecurityGroup/getSupportedDataCenters.md index 299493bf2a..219200771e 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/getSupportedDataCenters.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/getSupportedDataCenters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::getSupportedDataCenters + List the data centers that currently support the use of security groups. diff --git a/content/reference/services/SoftLayer_Network_SecurityGroup/removeRules.md b/content/reference/services/SoftLayer_Network_SecurityGroup/removeRules.md index cb3adbf4dc..bf26397d2b 100644 --- a/content/reference/services/SoftLayer_Network_SecurityGroup/removeRules.md +++ b/content/reference/services/SoftLayer_Network_SecurityGroup/removeRules.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_SecurityGroup](/reference/services/SoftLayer_Network_SecurityGroup)::removeRules + Remove rules from a security group. diff --git a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/_index.md b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/_index.md index 5e72a02fbd..374b7319d1 100644 --- a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/_index.md +++ b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer gives customers the ability to manage vulnerability scans for each of their servers. This service provides the ability to create a new scan request, view the status of a current request, and finally view the report of a finished scan. A vulnerability scan attempts to find potential security problems on a server by first searching for open ports and the services that run on them. If any services are found the scanner will then check for version and patch information of each service found. Lastly, the scanner will use the information gathered to search its database of known vulnerabilities and generate a report. Reports typically take five to ten minutes to run but allow for up to thirty minutes in rare cases. @@ -64,48 +66,56 @@ If you have a firewall, SoftLayer's administrative networks need to be allowed f #### [createObject](/reference/services/SoftLayer_Network_Security_Scanner_Request/createObject) Create a new vulnerability scan request. +
              #### [getAccount](/reference/services/SoftLayer_Network_Security_Scanner_Request/getAccount) Retrieve the account associated with a security scan request. +
              #### [getGuest](/reference/services/SoftLayer_Network_Security_Scanner_Request/getGuest) Retrieve the virtual guest a security scan is run against. +
              #### [getHardware](/reference/services/SoftLayer_Network_Security_Scanner_Request/getHardware) Retrieve the hardware a security scan is run against. +
              #### [getObject](/reference/services/SoftLayer_Network_Security_Scanner_Request/getObject) Retrieve a SoftLayer_Network_Security_Scanner_Request record. +
              #### [getReport](/reference/services/SoftLayer_Network_Security_Scanner_Request/getReport) Get the vulnerability report for a scan request. +
              #### [getRequestorOwnedFlag](/reference/services/SoftLayer_Network_Security_Scanner_Request/getRequestorOwnedFlag) Retrieve flag whether the requestor owns the hardware the scan was run on. This flag will return for hardware servers only, virtual servers will result in a null return even if you have a request out for them. +
              #### [getStatus](/reference/services/SoftLayer_Network_Security_Scanner_Request/getStatus) Retrieve a security scan request's status. +
              diff --git a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/createObject.md b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/createObject.md index 1f7531f9cb..38516b86f5 100644 --- a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/createObject.md +++ b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Security_Scanner_Request](/reference/services/SoftLayer_Network_Security_Scanner_Request)::createObject + Create a new vulnerability scan request. diff --git a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getAccount.md b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getAccount.md index f268dce4da..e2bd423e18 100644 --- a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Security_Scanner_Request](/reference/services/SoftLayer_Network_Security_Scanner_Request)::getAccount + Retrieve the account associated with a security scan request. diff --git a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getGuest.md b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getGuest.md index a7ee2b1753..4e52afd6bf 100644 --- a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getGuest.md +++ b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Security_Scanner_Request](/reference/services/SoftLayer_Network_Security_Scanner_Request)::getGuest + Retrieve the virtual guest a security scan is run against. diff --git a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getHardware.md b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getHardware.md index 12dbc65bd6..113ba1e717 100644 --- a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getHardware.md +++ b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Security_Scanner_Request](/reference/services/SoftLayer_Network_Security_Scanner_Request)::getHardware + Retrieve the hardware a security scan is run against. diff --git a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getObject.md b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getObject.md index 9d9aeca160..8ea0b91eb9 100644 --- a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getObject.md +++ b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Security_Scanner_Request](/reference/services/SoftLayer_Network_Security_Scanner_Request)::getObject + Retrieve a SoftLayer_Network_Security_Scanner_Request record. diff --git a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getReport.md b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getReport.md index c3b0d1d183..06b103cd8e 100644 --- a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getReport.md +++ b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getReport.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Security_Scanner_Request](/reference/services/SoftLayer_Network_Security_Scanner_Request)::getReport + Get the vulnerability report for a scan request. diff --git a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getRequestorOwnedFlag.md b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getRequestorOwnedFlag.md index 62fcfbc5d5..4cca147f15 100644 --- a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getRequestorOwnedFlag.md +++ b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getRequestorOwnedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Security_Scanner_Request](/reference/services/SoftLayer_Network_Security_Scanner_Request)::getRequestorOwnedFlag + Retrieve flag whether the requestor owns the hardware the scan was run on. This flag will return for hardware servers only, virtual servers will result in a null return even if you have a request out for them. diff --git a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getStatus.md b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getStatus.md index bf61af8a76..309bd9cd51 100644 --- a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getStatus.md +++ b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Security_Scanner_Request](/reference/services/SoftLayer_Network_Security_Scanner_Request)::getStatus + Retrieve a security scan request's status. diff --git a/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/_index.md b/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/_index.md index 22f347bcd7..078e5dd3ef 100644 --- a/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/_index.md +++ b/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -52,36 +54,42 @@ Use to manually decide which subnets within your virtual private address space a #### [createObjects](/reference/services/SoftLayer_Network_Service_Vpn_Overrides/createObjects) Create Softlayer portal user VPN overrides. +
              #### [deleteObject](/reference/services/SoftLayer_Network_Service_Vpn_Overrides/deleteObject) Delete single override. +
              #### [deleteObjects](/reference/services/SoftLayer_Network_Service_Vpn_Overrides/deleteObjects) Delete multiple entries in the overrides 'white list' for a SoftLayer portal VPN user. +
              #### [getObject](/reference/services/SoftLayer_Network_Service_Vpn_Overrides/getObject) Retrieve a SoftLayer_Network_Service_Vpn_Overrides record. +
              #### [getSubnet](/reference/services/SoftLayer_Network_Service_Vpn_Overrides/getSubnet) Retrieve subnet components accessible by a SoftLayer VPN portal user. +
              #### [getUser](/reference/services/SoftLayer_Network_Service_Vpn_Overrides/getUser) Retrieve softLayer VPN portal user. +
              diff --git a/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/createObjects.md b/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/createObjects.md index 837a57ce6e..fb1e13b960 100644 --- a/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/createObjects.md +++ b/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/createObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Service_Vpn_Overrides](/reference/services/SoftLayer_Network_Service_Vpn_Overrides)::createObjects + Create Softlayer portal user VPN overrides. diff --git a/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/deleteObject.md b/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/deleteObject.md index 21ea662573..b7276a78bd 100644 --- a/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Service_Vpn_Overrides](/reference/services/SoftLayer_Network_Service_Vpn_Overrides)::deleteObject + Delete single override. diff --git a/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/deleteObjects.md b/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/deleteObjects.md index a656f33720..c454ef042b 100644 --- a/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/deleteObjects.md +++ b/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/deleteObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Service_Vpn_Overrides](/reference/services/SoftLayer_Network_Service_Vpn_Overrides)::deleteObjects + Delete multiple entries in the overrides 'white list' for a SoftLayer portal VPN user. diff --git a/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/getObject.md b/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/getObject.md index cbeee0e6a0..e97fd57749 100644 --- a/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/getObject.md +++ b/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Service_Vpn_Overrides](/reference/services/SoftLayer_Network_Service_Vpn_Overrides)::getObject + Retrieve a SoftLayer_Network_Service_Vpn_Overrides record. diff --git a/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/getSubnet.md b/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/getSubnet.md index 806911467d..1c57b680cc 100644 --- a/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/getSubnet.md +++ b/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/getSubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Service_Vpn_Overrides](/reference/services/SoftLayer_Network_Service_Vpn_Overrides)::getSubnet + Retrieve subnet components accessible by a SoftLayer VPN portal user. diff --git a/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/getUser.md b/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/getUser.md index 5d0138b5e0..3b2150595a 100644 --- a/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/getUser.md +++ b/content/reference/services/SoftLayer_Network_Service_Vpn_Overrides/getUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Service_Vpn_Overrides](/reference/services/SoftLayer_Network_Service_Vpn_Overrides)::getUser + Retrieve softLayer VPN portal user. diff --git a/content/reference/services/SoftLayer_Network_Storage/_index.md b/content/reference/services/SoftLayer_Network_Storage/_index.md index 988ffab8c6..6c0d098e74 100644 --- a/content/reference/services/SoftLayer_Network_Storage/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) service to edit the passwords and notes for the EVault Webcc tool. @@ -58,1146 +60,1351 @@ For the EVault Storage services, the username and passwords in the SoftLayer_Net #### [allowAccessFromHardware](/reference/services/SoftLayer_Network_Storage/allowAccessFromHardware) Allow access to this volume from a specified SoftLayer_Hardware object. +
              #### [allowAccessFromHardwareList](/reference/services/SoftLayer_Network_Storage/allowAccessFromHardwareList) +
              #### [allowAccessFromHost](/reference/services/SoftLayer_Network_Storage/allowAccessFromHost) Allow access to this volume from a specified [SoftLayer_Hardware]({{}}) object. +
              #### [allowAccessFromHostList](/reference/services/SoftLayer_Network_Storage/allowAccessFromHostList) Allow access to this volume from multiple [SoftLayer_Hardware]({{}}) objects. +
              #### [allowAccessFromIpAddress](/reference/services/SoftLayer_Network_Storage/allowAccessFromIpAddress) Allow access to this volume from a specified SoftLayer_Network_Subnet_IpAddress object. +
              #### [allowAccessFromIpAddressList](/reference/services/SoftLayer_Network_Storage/allowAccessFromIpAddressList) +
              #### [allowAccessFromSubnet](/reference/services/SoftLayer_Network_Storage/allowAccessFromSubnet) Allow access to this volume from multiple SoftLayer_Network_Subnet objects. +
              #### [allowAccessFromSubnetList](/reference/services/SoftLayer_Network_Storage/allowAccessFromSubnetList) +
              #### [allowAccessFromVirtualGuest](/reference/services/SoftLayer_Network_Storage/allowAccessFromVirtualGuest) Allow access to this volume from a specified SoftLayer_Virtual_Guest object. +
              #### [allowAccessFromVirtualGuestList](/reference/services/SoftLayer_Network_Storage/allowAccessFromVirtualGuestList) Allow access to this volume from multiple SoftLayer_Virtual_Guest objects. +
              #### [allowAccessToReplicantFromHardware](/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromHardware) Allow access to this replicant volume from a specified SoftLayer_Hardware object. +
              #### [allowAccessToReplicantFromHardwareList](/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromHardwareList) allow access to this volume's replica from multiple SoftLayer_Hardware objects. +
              #### [allowAccessToReplicantFromIpAddress](/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromIpAddress) +
              #### [allowAccessToReplicantFromIpAddressList](/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromIpAddressList) allow access to this volume's replica from multiple SoftLayer_Network_Subnet_IpAddress objects. +
              #### [allowAccessToReplicantFromSubnet](/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromSubnet) Allow access to this replicant volume from multiple SoftLayer_Network_Subnet objects. +
              #### [allowAccessToReplicantFromSubnetList](/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromSubnetList) allow access to this volume's replica from multiple SoftLayer_Network_Subnet objects. +
              #### [allowAccessToReplicantFromVirtualGuest](/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromVirtualGuest) Allow access to this replicant volume from a specified SoftLayer_Virtual_Guest object. +
              #### [allowAccessToReplicantFromVirtualGuestList](/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromVirtualGuestList) allow access to this volume's replica from multiple SoftLayer_Virtual_Guest objects. +
              #### [assignCredential](/reference/services/SoftLayer_Network_Storage/assignCredential) This method will assign an existing credential to the current volume. +
              #### [assignNewCredential](/reference/services/SoftLayer_Network_Storage/assignNewCredential) This method will set up a new credential for the remote storage volume. +
              #### [changePassword](/reference/services/SoftLayer_Network_Storage/changePassword) Change the password for a Storage/Virtual Server Storage account +
              #### [collectBandwidth](/reference/services/SoftLayer_Network_Storage/collectBandwidth) Retrieve the bandwidth usage for the current billing cycle. +
              #### [collectBytesUsed](/reference/services/SoftLayer_Network_Storage/collectBytesUsed) Retrieve the number of bytes capacity currently in use on a Storage account. +
              #### [convertCloneDependentToIndependent](/reference/services/SoftLayer_Network_Storage/convertCloneDependentToIndependent) Splits a clone from its parent allowing it to be an independent volume. +
              #### [createFolder](/reference/services/SoftLayer_Network_Storage/createFolder) Create a new folder in the root directory. +
              #### [createOrUpdateLunId](/reference/services/SoftLayer_Network_Storage/createOrUpdateLunId) Creates or updates the LUN ID property on a volume. +
              #### [createSnapshot](/reference/services/SoftLayer_Network_Storage/createSnapshot) Manually create a new snapshot of a storage volume. +
              #### [deleteAllFiles](/reference/services/SoftLayer_Network_Storage/deleteAllFiles) Delete all files within a Storage account. +
              #### [deleteFile](/reference/services/SoftLayer_Network_Storage/deleteFile) Delete an individual file within a Storage account. +
              #### [deleteFiles](/reference/services/SoftLayer_Network_Storage/deleteFiles) Delete multiple files within a Storage account. +
              #### [deleteFolder](/reference/services/SoftLayer_Network_Storage/deleteFolder) Delete a folder in the root directory. +
              #### [deleteObject](/reference/services/SoftLayer_Network_Storage/deleteObject) Delete a network storage volume +
              #### [disableSnapshots](/reference/services/SoftLayer_Network_Storage/disableSnapshots) Disable snapshots of this Storage Volume on a schedule. +
              #### [disasterRecoveryFailoverToReplicant](/reference/services/SoftLayer_Network_Storage/disasterRecoveryFailoverToReplicant) Failover an inaccessible block/file volume to its available replicant volume. +
              #### [downloadFile](/reference/services/SoftLayer_Network_Storage/downloadFile) Download a file from a Storage account. +
              #### [editCredential](/reference/services/SoftLayer_Network_Storage/editCredential) This method will change the password of a credential created using the 'addNewCredential' method. +
              #### [editObject](/reference/services/SoftLayer_Network_Storage/editObject) Edit the password and/or notes for the Storage service +
              #### [enableSnapshots](/reference/services/SoftLayer_Network_Storage/enableSnapshots) Enable snapshots of this Storage Volume on a schedule. +
              #### [failbackFromReplicant](/reference/services/SoftLayer_Network_Storage/failbackFromReplicant) Failback from a volume replicant. +
              #### [failoverToReplicant](/reference/services/SoftLayer_Network_Storage/failoverToReplicant) Failover to a volume replicant. +
              #### [getAccount](/reference/services/SoftLayer_Network_Storage/getAccount) Retrieve the account that a Storage services belongs to. +
              #### [getAccountPassword](/reference/services/SoftLayer_Network_Storage/getAccountPassword) Retrieve other usernames and passwords associated with a Storage volume. +
              #### [getActiveTransactions](/reference/services/SoftLayer_Network_Storage/getActiveTransactions) Retrieve the currently active transactions on a network storage volume. +
              #### [getAllFiles](/reference/services/SoftLayer_Network_Storage/getAllFiles) Retrieve a listing of all files in a Storage account's root directory. +
              #### [getAllFilesByFilter](/reference/services/SoftLayer_Network_Storage/getAllFilesByFilter) Retrieve a listing of all files matching the filter's criteria in a Storage account's root directory. + +
              + +
              + +#### [getAllowDisasterRecoveryFailback](/reference/services/SoftLayer_Network_Storage/getAllowDisasterRecoveryFailback) + +
              #### [getAllowDisasterRecoveryFailover](/reference/services/SoftLayer_Network_Storage/getAllowDisasterRecoveryFailover) +
              #### [getAllowableHardware](/reference/services/SoftLayer_Network_Storage/getAllowableHardware) Return a list of SoftLayer_Hardware that can be authorized to this volume. +
              #### [getAllowableIpAddresses](/reference/services/SoftLayer_Network_Storage/getAllowableIpAddresses) Return a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this volume. +
              #### [getAllowableSubnets](/reference/services/SoftLayer_Network_Storage/getAllowableSubnets) Return a list of SoftLayer_Network_Subnet that can be authorized to this volume. +
              #### [getAllowableVirtualGuests](/reference/services/SoftLayer_Network_Storage/getAllowableVirtualGuests) Return a list of SoftLayer_Virtual_Guest that can be authorized to this volume. +
              #### [getAllowedHardware](/reference/services/SoftLayer_Network_Storage/getAllowedHardware) Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume. +
              #### [getAllowedHostsLimit](/reference/services/SoftLayer_Network_Storage/getAllowedHostsLimit) Retrieves the total number of allowed hosts limit per volume. +
              #### [getAllowedIpAddresses](/reference/services/SoftLayer_Network_Storage/getAllowedIpAddresses) Retrieve the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. +
              #### [getAllowedReplicationHardware](/reference/services/SoftLayer_Network_Storage/getAllowedReplicationHardware) Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. +
              #### [getAllowedReplicationIpAddresses](/reference/services/SoftLayer_Network_Storage/getAllowedReplicationIpAddresses) Retrieve the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. +
              #### [getAllowedReplicationSubnets](/reference/services/SoftLayer_Network_Storage/getAllowedReplicationSubnets) Retrieve the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. +
              #### [getAllowedReplicationVirtualGuests](/reference/services/SoftLayer_Network_Storage/getAllowedReplicationVirtualGuests) Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. +
              #### [getAllowedSubnets](/reference/services/SoftLayer_Network_Storage/getAllowedSubnets) Retrieve the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. +
              #### [getAllowedVirtualGuests](/reference/services/SoftLayer_Network_Storage/getAllowedVirtualGuests) Retrieve the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. +
              #### [getBillingItem](/reference/services/SoftLayer_Network_Storage/getBillingItem) Retrieve the current billing item for a Storage volume. +
              #### [getBillingItemCategory](/reference/services/SoftLayer_Network_Storage/getBillingItemCategory) +
              #### [getByUsername](/reference/services/SoftLayer_Network_Storage/getByUsername) Retrieve network storage accounts by username. +
              #### [getBytesUsed](/reference/services/SoftLayer_Network_Storage/getBytesUsed) Retrieve the amount of space used by the volume, in bytes. +
              #### [getCdnUrls](/reference/services/SoftLayer_Network_Storage/getCdnUrls) +
              #### [getClusterResource](/reference/services/SoftLayer_Network_Storage/getClusterResource) +
              #### [getCreationScheduleId](/reference/services/SoftLayer_Network_Storage/getCreationScheduleId) Retrieve the schedule id which was executed to create a snapshot. +
              #### [getCredentials](/reference/services/SoftLayer_Network_Storage/getCredentials) +
              #### [getDailySchedule](/reference/services/SoftLayer_Network_Storage/getDailySchedule) Retrieve the Daily Schedule which is associated with this network storage volume. +
              #### [getDependentDuplicate](/reference/services/SoftLayer_Network_Storage/getDependentDuplicate) Retrieve whether or not a network storage volume is a dependent duplicate. +
              #### [getDependentDuplicates](/reference/services/SoftLayer_Network_Storage/getDependentDuplicates) Retrieve the network storage volumes configured to be dependent duplicates of a volume. +
              #### [getEvents](/reference/services/SoftLayer_Network_Storage/getEvents) Retrieve the events which have taken place on a network storage volume. +
              #### [getFailbackNotAllowed](/reference/services/SoftLayer_Network_Storage/getFailbackNotAllowed) Retrieve determines whether the volume is allowed to failback + +
              + +
              + +#### [getFailoverNotAllowed](/reference/services/SoftLayer_Network_Storage/getFailoverNotAllowed) +Retrieve determines whether the volume is allowed to failover +
              #### [getFileBlockEncryptedLocations](/reference/services/SoftLayer_Network_Storage/getFileBlockEncryptedLocations) Returns a list of SoftLayer_Location_Datacenter objects corresponding to Datacenters in which File and Block Storage Volumes with Encryption at Rest may be ordered. +
              #### [getFileByIdentifier](/reference/services/SoftLayer_Network_Storage/getFileByIdentifier) Retrieve an individual file's details. +
              #### [getFileCount](/reference/services/SoftLayer_Network_Storage/getFileCount) Retrieve the file number of files in a Virtual Server Storage account's root directory. +
              #### [getFileList](/reference/services/SoftLayer_Network_Storage/getFileList) Retrieve list of files in a given folder for this account. +
              #### [getFileNetworkMountAddress](/reference/services/SoftLayer_Network_Storage/getFileNetworkMountAddress) Retrieve retrieves the NFS Network Mount Address Name for a given File Storage Volume. +
              #### [getFilePendingDeleteCount](/reference/services/SoftLayer_Network_Storage/getFilePendingDeleteCount) Retrieve the number of files pending deletion in a Storage account's recycle bin. +
              #### [getFilesPendingDelete](/reference/services/SoftLayer_Network_Storage/getFilesPendingDelete) Retrieve a list of files in a Storage account's recycle bin. +
              #### [getFolderList](/reference/services/SoftLayer_Network_Storage/getFolderList) Retrieve a list of level 1 folders for this account. +
              #### [getGraph](/reference/services/SoftLayer_Network_Storage/getGraph) Retrieve a graph representing the bandwidth used by a Storage account. +
              #### [getHardware](/reference/services/SoftLayer_Network_Storage/getHardware) Retrieve when applicable, the hardware associated with a Storage service. +
              #### [getHasEncryptionAtRest](/reference/services/SoftLayer_Network_Storage/getHasEncryptionAtRest) +
              #### [getHourlySchedule](/reference/services/SoftLayer_Network_Storage/getHourlySchedule) Retrieve the Hourly Schedule which is associated with this network storage volume. +
              #### [getIntervalSchedule](/reference/services/SoftLayer_Network_Storage/getIntervalSchedule) Retrieve the Interval Schedule which is associated with this network storage volume. +
              #### [getIops](/reference/services/SoftLayer_Network_Storage/getIops) Retrieve the maximum number of IOPs selected for this volume. +
              #### [getIsDependentDuplicateProvisionCompleted](/reference/services/SoftLayer_Network_Storage/getIsDependentDuplicateProvisionCompleted) Retrieve determines whether dependent volume provision is completed on background. +
              #### [getIsInDedicatedServiceResource](/reference/services/SoftLayer_Network_Storage/getIsInDedicatedServiceResource) +
              #### [getIsMagneticStorage](/reference/services/SoftLayer_Network_Storage/getIsMagneticStorage) +
              #### [getIsReadyForSnapshot](/reference/services/SoftLayer_Network_Storage/getIsReadyForSnapshot) Retrieve determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. +
              #### [getIsReadyToMount](/reference/services/SoftLayer_Network_Storage/getIsReadyToMount) Retrieve determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. +
              #### [getIscsiLuns](/reference/services/SoftLayer_Network_Storage/getIscsiLuns) Retrieve relationship between a container volume and iSCSI LUNs. +
              #### [getIscsiTargetIpAddresses](/reference/services/SoftLayer_Network_Storage/getIscsiTargetIpAddresses) Retrieve returns the target IP addresses of an iSCSI volume. +
              #### [getLunId](/reference/services/SoftLayer_Network_Storage/getLunId) Retrieve the ID of the LUN volume. +
              #### [getManualSnapshots](/reference/services/SoftLayer_Network_Storage/getManualSnapshots) Retrieve the manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. +
              #### [getMaximumExpansionSize](/reference/services/SoftLayer_Network_Storage/getMaximumExpansionSize) Returns the maximum volume expansion size in GB. +
              #### [getMetricTrackingObject](/reference/services/SoftLayer_Network_Storage/getMetricTrackingObject) Retrieve a network storage volume's metric tracking object. This object records all periodic polled data available to this volume. +
              #### [getMountPath](/reference/services/SoftLayer_Network_Storage/getMountPath) Retrieve retrieves the NFS Network Mount Path for a given File Storage Volume. +
              #### [getMountableFlag](/reference/services/SoftLayer_Network_Storage/getMountableFlag) Retrieve whether or not a network storage volume may be mounted. +
              #### [getMoveAndSplitStatus](/reference/services/SoftLayer_Network_Storage/getMoveAndSplitStatus) Retrieve the current status of split or move operation as a part of volume duplication. +
              #### [getNetworkConnectionDetails](/reference/services/SoftLayer_Network_Storage/getNetworkConnectionDetails) Retrieve network connection details for complex network storage volumes. +
              #### [getNetworkMountAddress](/reference/services/SoftLayer_Network_Storage/getNetworkMountAddress) Displays the mount path of a storage volume. +
              #### [getNetworkMountPath](/reference/services/SoftLayer_Network_Storage/getNetworkMountPath) Displays the mount path of a storage volume. +
              #### [getNotificationSubscribers](/reference/services/SoftLayer_Network_Storage/getNotificationSubscribers) Retrieve the subscribers that will be notified for usage amount warnings and overages. +
              #### [getObject](/reference/services/SoftLayer_Network_Storage/getObject) Retrieve a SoftLayer_Network_Storage record. +
              #### [getObjectStorageConnectionInformation](/reference/services/SoftLayer_Network_Storage/getObjectStorageConnectionInformation) Retrieve all object storage details for connection +
              #### [getObjectsByCredential](/reference/services/SoftLayer_Network_Storage/getObjectsByCredential) Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object. +
              #### [getOriginalSnapshotName](/reference/services/SoftLayer_Network_Storage/getOriginalSnapshotName) Retrieve the name of the snapshot that this volume was duplicated from. +
              #### [getOriginalVolumeName](/reference/services/SoftLayer_Network_Storage/getOriginalVolumeName) Retrieve the name of the volume that this volume was duplicated from. +
              #### [getOriginalVolumeSize](/reference/services/SoftLayer_Network_Storage/getOriginalVolumeSize) Retrieve the size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. +
              #### [getOsType](/reference/services/SoftLayer_Network_Storage/getOsType) Retrieve a volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. +
              #### [getOsTypeId](/reference/services/SoftLayer_Network_Storage/getOsTypeId) Retrieve a volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. +
              #### [getParentPartnerships](/reference/services/SoftLayer_Network_Storage/getParentPartnerships) Retrieve the volumes or snapshots partnered with a network storage volume in a parental role. +
              #### [getParentVolume](/reference/services/SoftLayer_Network_Storage/getParentVolume) Retrieve the parent volume of a volume in a complex storage relationship. +
              #### [getPartnerships](/reference/services/SoftLayer_Network_Storage/getPartnerships) Retrieve the volumes or snapshots partnered with a network storage volume. +
              #### [getPermissionsGroups](/reference/services/SoftLayer_Network_Storage/getPermissionsGroups) Retrieve all permissions group(s) this volume is in. +
              #### [getProperties](/reference/services/SoftLayer_Network_Storage/getProperties) Retrieve the properties used to provide additional details about a network storage volume. +
              #### [getProvisionedIops](/reference/services/SoftLayer_Network_Storage/getProvisionedIops) Retrieve the number of IOPs provisioned for this volume. +
              #### [getRecycleBinFileByIdentifier](/reference/services/SoftLayer_Network_Storage/getRecycleBinFileByIdentifier) Retrieve all files that are in the recycle bin (pending delete). This method is only used for Virtual Server Storage accounts at moment but may expanded to other Storage types in the future. +
              #### [getRemainingAllowedHosts](/reference/services/SoftLayer_Network_Storage/getRemainingAllowedHosts) Retrieves the remaining number of allowed hosts per volume. +
              #### [getRemainingAllowedHostsForReplicant](/reference/services/SoftLayer_Network_Storage/getRemainingAllowedHostsForReplicant) Retrieves the remaining number of allowed hosts for a volume's replicant. +
              #### [getReplicatingLuns](/reference/services/SoftLayer_Network_Storage/getReplicatingLuns) Retrieve the iSCSI LUN volumes being replicated by this network storage volume. +
              #### [getReplicatingVolume](/reference/services/SoftLayer_Network_Storage/getReplicatingVolume) Retrieve the network storage volume being replicated by a volume. +
              #### [getReplicationEvents](/reference/services/SoftLayer_Network_Storage/getReplicationEvents) Retrieve the volume replication events. +
              #### [getReplicationPartners](/reference/services/SoftLayer_Network_Storage/getReplicationPartners) Retrieve the network storage volumes configured to be replicants of a volume. +
              #### [getReplicationSchedule](/reference/services/SoftLayer_Network_Storage/getReplicationSchedule) Retrieve the Replication Schedule associated with a network storage volume. +
              #### [getReplicationStatus](/reference/services/SoftLayer_Network_Storage/getReplicationStatus) Retrieve the current replication status of a network storage volume. Indicates Failover or Failback status. +
              #### [getReplicationTimestamp](/reference/services/SoftLayer_Network_Storage/getReplicationTimestamp) An API call to fetch the last timestamp of the replication process +
              #### [getSchedules](/reference/services/SoftLayer_Network_Storage/getSchedules) Retrieve the schedules which are associated with a network storage volume. +
              #### [getServiceResource](/reference/services/SoftLayer_Network_Storage/getServiceResource) Retrieve the network resource a Storage service is connected to. +
              #### [getServiceResourceBackendIpAddress](/reference/services/SoftLayer_Network_Storage/getServiceResourceBackendIpAddress) Retrieve the IP address of a Storage resource. +
              #### [getServiceResourceName](/reference/services/SoftLayer_Network_Storage/getServiceResourceName) Retrieve the name of a Storage's network resource. +
              #### [getSnapshotCapacityGb](/reference/services/SoftLayer_Network_Storage/getSnapshotCapacityGb) Retrieve a volume's configured snapshot space size. +
              #### [getSnapshotCreationTimestamp](/reference/services/SoftLayer_Network_Storage/getSnapshotCreationTimestamp) Retrieve the creation timestamp of the snapshot on the storage platform. +
              #### [getSnapshotDeletionThresholdPercentage](/reference/services/SoftLayer_Network_Storage/getSnapshotDeletionThresholdPercentage) Retrieve the percentage of used snapshot space after which to delete automated snapshots. +
              #### [getSnapshotNotificationStatus](/reference/services/SoftLayer_Network_Storage/getSnapshotNotificationStatus) Retrieve whether or not a network storage volume may be mounted. +
              #### [getSnapshotSizeBytes](/reference/services/SoftLayer_Network_Storage/getSnapshotSizeBytes) Retrieve the snapshot size in bytes. +
              #### [getSnapshotSpaceAvailable](/reference/services/SoftLayer_Network_Storage/getSnapshotSpaceAvailable) Retrieve a volume's available snapshot reservation space. +
              #### [getSnapshots](/reference/services/SoftLayer_Network_Storage/getSnapshots) Retrieve the snapshots associated with this SoftLayer_Network_Storage volume. +
              #### [getSnapshotsForVolume](/reference/services/SoftLayer_Network_Storage/getSnapshotsForVolume) Retrieves a list oƒf snapshots for a given volume. +
              #### [getStaasVersion](/reference/services/SoftLayer_Network_Storage/getStaasVersion) +
              #### [getStorageGroups](/reference/services/SoftLayer_Network_Storage/getStorageGroups) Retrieve the network storage groups this volume is attached to. +
              #### [getStorageGroupsNetworkConnectionDetails](/reference/services/SoftLayer_Network_Storage/getStorageGroupsNetworkConnectionDetails) +
              #### [getStorageTierLevel](/reference/services/SoftLayer_Network_Storage/getStorageTierLevel) +
              #### [getStorageType](/reference/services/SoftLayer_Network_Storage/getStorageType) Retrieve a description of the Storage object. +
              #### [getTargetIpAddresses](/reference/services/SoftLayer_Network_Storage/getTargetIpAddresses) +
              #### [getTotalBytesUsed](/reference/services/SoftLayer_Network_Storage/getTotalBytesUsed) Retrieve the amount of space used by the volume. +
              #### [getTotalScheduleSnapshotRetentionCount](/reference/services/SoftLayer_Network_Storage/getTotalScheduleSnapshotRetentionCount) Retrieve the total snapshot retention count of all schedules on this network storage volume. +
              #### [getUsageNotification](/reference/services/SoftLayer_Network_Storage/getUsageNotification) Retrieve the usage notification for SL Storage services. +
              #### [getValidReplicationTargetDatacenterLocations](/reference/services/SoftLayer_Network_Storage/getValidReplicationTargetDatacenterLocations) +
              #### [getVendorName](/reference/services/SoftLayer_Network_Storage/getVendorName) Retrieve the type of network storage service. +
              #### [getVirtualGuest](/reference/services/SoftLayer_Network_Storage/getVirtualGuest) Retrieve when applicable, the virtual guest associated with a Storage service. +
              #### [getVolumeCountLimits](/reference/services/SoftLayer_Network_Storage/getVolumeCountLimits) Retrieves an array of volume count limits per location and globally. +
              #### [getVolumeDuplicateParameters](/reference/services/SoftLayer_Network_Storage/getVolumeDuplicateParameters) +
              #### [getVolumeHistory](/reference/services/SoftLayer_Network_Storage/getVolumeHistory) Retrieve the username and password history for a Storage service. +
              #### [getVolumeStatus](/reference/services/SoftLayer_Network_Storage/getVolumeStatus) Retrieve the current status of a network storage volume. +
              #### [getWebccAccount](/reference/services/SoftLayer_Network_Storage/getWebccAccount) Retrieve the account username and password for the EVault webCC interface. +
              #### [getWeeklySchedule](/reference/services/SoftLayer_Network_Storage/getWeeklySchedule) Retrieve the Weekly Schedule which is associated with this network storage volume. +
              #### [immediateFailoverToReplicant](/reference/services/SoftLayer_Network_Storage/immediateFailoverToReplicant) Immediate Failover to a volume replicant. +
              #### [initiateOriginVolumeReclaim](/reference/services/SoftLayer_Network_Storage/initiateOriginVolumeReclaim) Initiates Origin Volume Reclaim to delete volume from NetApp. +
              #### [initiateVolumeCutover](/reference/services/SoftLayer_Network_Storage/initiateVolumeCutover) Initiates Volume Cutover to remove access from the old volume. +
              #### [isBlockingOperationInProgress](/reference/services/SoftLayer_Network_Storage/isBlockingOperationInProgress) +
              #### [isDuplicateReadyForSnapshot](/reference/services/SoftLayer_Network_Storage/isDuplicateReadyForSnapshot) Displays the if clone snapshots can be ordered. +
              #### [isDuplicateReadyToMount](/reference/services/SoftLayer_Network_Storage/isDuplicateReadyToMount) Displays the status of a clone mount. +
              #### [isVolumeActive](/reference/services/SoftLayer_Network_Storage/isVolumeActive) +
              #### [refreshDependentDuplicate](/reference/services/SoftLayer_Network_Storage/refreshDependentDuplicate) Refreshes a duplicate volume with a snapshot taken from its parent. This is deprecated now. +
              #### [refreshDuplicate](/reference/services/SoftLayer_Network_Storage/refreshDuplicate) Refreshes any duplicate volume with a snapshot taken from its parent. +
              #### [removeAccessFromHardware](/reference/services/SoftLayer_Network_Storage/removeAccessFromHardware) Remove access to this volume from a specified SoftLayer_Hardware object. +
              #### [removeAccessFromHardwareList](/reference/services/SoftLayer_Network_Storage/removeAccessFromHardwareList) Remove access to this volume from multiple SoftLayer_Hardware objects. +
              #### [removeAccessFromHost](/reference/services/SoftLayer_Network_Storage/removeAccessFromHost) Remove access to this volume from a specified [SoftLayer_Hardware]({{}}) object. +
              #### [removeAccessFromHostList](/reference/services/SoftLayer_Network_Storage/removeAccessFromHostList) Remove access to this volume from multiple [SoftLayer_Hardware]({{}}) objects. +
              #### [removeAccessFromIpAddress](/reference/services/SoftLayer_Network_Storage/removeAccessFromIpAddress) Remove access to this volume from a specified SoftLayer_Network_Subnet_IpAddress object. +
              #### [removeAccessFromIpAddressList](/reference/services/SoftLayer_Network_Storage/removeAccessFromIpAddressList) +
              #### [removeAccessFromSubnet](/reference/services/SoftLayer_Network_Storage/removeAccessFromSubnet) +
              #### [removeAccessFromSubnetList](/reference/services/SoftLayer_Network_Storage/removeAccessFromSubnetList) +
              #### [removeAccessFromVirtualGuest](/reference/services/SoftLayer_Network_Storage/removeAccessFromVirtualGuest) Remove access to this volume from a specified SoftLayer_Virtual_Guest object. +
              #### [removeAccessFromVirtualGuestList](/reference/services/SoftLayer_Network_Storage/removeAccessFromVirtualGuestList) Remove access to this volume from multiple SoftLayer_Virtual_Guest objects. +
              #### [removeAccessToReplicantFromHardwareList](/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromHardwareList) Remove access to this volume's replica from multiple SoftLayer_Hardware objects. +
              #### [removeAccessToReplicantFromIpAddressList](/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromIpAddressList) Remove access to this replica volume's replica from multiple SoftLayer_Network_Subnet_IpAddress objects. +
              #### [removeAccessToReplicantFromSubnet](/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromSubnet) +
              #### [removeAccessToReplicantFromSubnetList](/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromSubnetList) Remove access to this volume's replica from multiple SoftLayer_Network_Subnet objects. +
              #### [removeAccessToReplicantFromVirtualGuestList](/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromVirtualGuestList) Remove access to this volume's replica from multiple SoftLayer_Virtual_Guest objects. +
              #### [removeCredential](/reference/services/SoftLayer_Network_Storage/removeCredential) This method will remove a credential from the current volume. +
              #### [restoreFile](/reference/services/SoftLayer_Network_Storage/restoreFile) Restore access to an individual file in a Storage account. +
              #### [restoreFromSnapshot](/reference/services/SoftLayer_Network_Storage/restoreFromSnapshot) Restore from a volume snapshot. +
              #### [sendPasswordReminderEmail](/reference/services/SoftLayer_Network_Storage/sendPasswordReminderEmail) Email the password for the Storage account to the master user. +
              #### [setMountable](/reference/services/SoftLayer_Network_Storage/setMountable) Enable or disable mounting of a Storage volume. +
              #### [setSnapshotAllocation](/reference/services/SoftLayer_Network_Storage/setSnapshotAllocation) +
              #### [setSnapshotNotification](/reference/services/SoftLayer_Network_Storage/setSnapshotNotification) Function to enable/disable snapshot warning notification. +
              #### [upgradeVolumeCapacity](/reference/services/SoftLayer_Network_Storage/upgradeVolumeCapacity) Edit the Storage volume to a different package +
              #### [uploadFile](/reference/services/SoftLayer_Network_Storage/uploadFile) Upload a file to a Storage account's root directory. +
              diff --git a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromHardware.md b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromHardware.md index 6268fbda78..d7cf280a47 100644 --- a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::allowAccessFromHardware + Allow access to this volume from a specified SoftLayer_Hardware object. diff --git a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromHardwareList.md b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromHardwareList.md index acbdcb81cb..d2acdc5ab1 100644 --- a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromHardwareList.md +++ b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromHardwareList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromHost.md b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromHost.md index 269d9e5206..91063f8a49 100644 --- a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromHost.md +++ b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::allowAccessFromHost + Allow access to this volume from a specified [SoftLayer_Hardware]({{}}) object. diff --git a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromHostList.md b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromHostList.md index 5c6aa8c7a8..c9ab394311 100644 --- a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromHostList.md +++ b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromHostList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::allowAccessFromHostList + Allow access to this volume from multiple [SoftLayer_Hardware]({{}}) objects. diff --git a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromIpAddress.md b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromIpAddress.md index 20c0274b02..93182f64a3 100644 --- a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::allowAccessFromIpAddress + Allow access to this volume from a specified SoftLayer_Network_Subnet_IpAddress object. diff --git a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromIpAddressList.md b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromIpAddressList.md index 5e2480470d..cf568594b3 100644 --- a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromIpAddressList.md +++ b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromIpAddressList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromSubnet.md b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromSubnet.md index 1d841af6af..07a7169ad3 100644 --- a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromSubnet.md +++ b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromSubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::allowAccessFromSubnet + Allow access to this volume from multiple SoftLayer_Network_Subnet objects. diff --git a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromSubnetList.md b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromSubnetList.md index 6f39a43337..011ab2c415 100644 --- a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromSubnetList.md +++ b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromSubnetList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromVirtualGuest.md b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromVirtualGuest.md index 743cdd7fd0..a865566a91 100644 --- a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromVirtualGuest.md +++ b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::allowAccessFromVirtualGuest + Allow access to this volume from a specified SoftLayer_Virtual_Guest object. diff --git a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromVirtualGuestList.md b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromVirtualGuestList.md index ac91508bc3..a968bd0852 100644 --- a/content/reference/services/SoftLayer_Network_Storage/allowAccessFromVirtualGuestList.md +++ b/content/reference/services/SoftLayer_Network_Storage/allowAccessFromVirtualGuestList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::allowAccessFromVirtualGuestList + Allow access to this volume from multiple SoftLayer_Virtual_Guest objects. diff --git a/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromHardware.md b/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromHardware.md index c4403f6c16..eaac742e24 100644 --- a/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::allowAccessToReplicantFromHardware + Allow access to this replicant volume from a specified SoftLayer_Hardware object. diff --git a/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromHardwareList.md b/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromHardwareList.md index a2dcdd3b07..c810abe691 100644 --- a/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromHardwareList.md +++ b/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromHardwareList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::allowAccessToReplicantFromHardwareList + allow access to this volume's replica from multiple SoftLayer_Hardware objects. diff --git a/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromIpAddress.md b/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromIpAddress.md index 4eefed6c68..c8278c0f6c 100644 --- a/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromIpAddress.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromIpAddressList.md b/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromIpAddressList.md index 97ab206a11..ee633d527a 100644 --- a/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromIpAddressList.md +++ b/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromIpAddressList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::allowAccessToReplicantFromIpAddressList + allow access to this volume's replica from multiple SoftLayer_Network_Subnet_IpAddress objects. diff --git a/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromSubnet.md b/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromSubnet.md index 24295ec2a8..ab8b1d8230 100644 --- a/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromSubnet.md +++ b/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromSubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::allowAccessToReplicantFromSubnet + Allow access to this replicant volume from multiple SoftLayer_Network_Subnet objects. diff --git a/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromSubnetList.md b/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromSubnetList.md index a144d9e9a6..3b9a08e2c4 100644 --- a/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromSubnetList.md +++ b/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromSubnetList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::allowAccessToReplicantFromSubnetList + allow access to this volume's replica from multiple SoftLayer_Network_Subnet objects. diff --git a/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromVirtualGuest.md b/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromVirtualGuest.md index 7d27134c2d..9fd2622263 100644 --- a/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromVirtualGuest.md +++ b/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::allowAccessToReplicantFromVirtualGuest + Allow access to this replicant volume from a specified SoftLayer_Virtual_Guest object. diff --git a/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromVirtualGuestList.md b/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromVirtualGuestList.md index 933d0e7d4a..0f4faf4727 100644 --- a/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromVirtualGuestList.md +++ b/content/reference/services/SoftLayer_Network_Storage/allowAccessToReplicantFromVirtualGuestList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::allowAccessToReplicantFromVirtualGuestList + allow access to this volume's replica from multiple SoftLayer_Virtual_Guest objects. diff --git a/content/reference/services/SoftLayer_Network_Storage/assignCredential.md b/content/reference/services/SoftLayer_Network_Storage/assignCredential.md index 8fdbb6fb99..0d9e270501 100644 --- a/content/reference/services/SoftLayer_Network_Storage/assignCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage/assignCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::assignCredential + This method will assign an existing credential to the current volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/assignNewCredential.md b/content/reference/services/SoftLayer_Network_Storage/assignNewCredential.md index debb7526d4..0b5e8eb468 100644 --- a/content/reference/services/SoftLayer_Network_Storage/assignNewCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage/assignNewCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::assignNewCredential + This method will set up a new credential for the remote storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/changePassword.md b/content/reference/services/SoftLayer_Network_Storage/changePassword.md index 548404ef7e..163527e431 100644 --- a/content/reference/services/SoftLayer_Network_Storage/changePassword.md +++ b/content/reference/services/SoftLayer_Network_Storage/changePassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::changePassword + Change the password for a Storage/Virtual Server Storage account diff --git a/content/reference/services/SoftLayer_Network_Storage/collectBandwidth.md b/content/reference/services/SoftLayer_Network_Storage/collectBandwidth.md index 1a04750d0f..3c020a3499 100644 --- a/content/reference/services/SoftLayer_Network_Storage/collectBandwidth.md +++ b/content/reference/services/SoftLayer_Network_Storage/collectBandwidth.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::collectBandwidth + Retrieve the bandwidth usage for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Network_Storage/collectBytesUsed.md b/content/reference/services/SoftLayer_Network_Storage/collectBytesUsed.md index 8d2f7d59c2..b160f2d9ce 100644 --- a/content/reference/services/SoftLayer_Network_Storage/collectBytesUsed.md +++ b/content/reference/services/SoftLayer_Network_Storage/collectBytesUsed.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::collectBytesUsed + Retrieve the number of bytes capacity currently in use on a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage/convertCloneDependentToIndependent.md b/content/reference/services/SoftLayer_Network_Storage/convertCloneDependentToIndependent.md index bf01c21f5a..1a5559f664 100644 --- a/content/reference/services/SoftLayer_Network_Storage/convertCloneDependentToIndependent.md +++ b/content/reference/services/SoftLayer_Network_Storage/convertCloneDependentToIndependent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::convertCloneDependentToIndependent + Splits a clone from its parent allowing it to be an independent volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/createFolder.md b/content/reference/services/SoftLayer_Network_Storage/createFolder.md index c1aaca89b5..8de205f689 100644 --- a/content/reference/services/SoftLayer_Network_Storage/createFolder.md +++ b/content/reference/services/SoftLayer_Network_Storage/createFolder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::createFolder + Create a new folder in the root directory. diff --git a/content/reference/services/SoftLayer_Network_Storage/createOrUpdateLunId.md b/content/reference/services/SoftLayer_Network_Storage/createOrUpdateLunId.md index f11130e0a1..68f1b792c2 100644 --- a/content/reference/services/SoftLayer_Network_Storage/createOrUpdateLunId.md +++ b/content/reference/services/SoftLayer_Network_Storage/createOrUpdateLunId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::createOrUpdateLunId + Creates or updates the LUN ID property on a volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/createSnapshot.md b/content/reference/services/SoftLayer_Network_Storage/createSnapshot.md index b32af77a43..495fcc50bf 100644 --- a/content/reference/services/SoftLayer_Network_Storage/createSnapshot.md +++ b/content/reference/services/SoftLayer_Network_Storage/createSnapshot.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::createSnapshot + Manually create a new snapshot of a storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/deleteAllFiles.md b/content/reference/services/SoftLayer_Network_Storage/deleteAllFiles.md index e6369024ac..fc9d3223a7 100644 --- a/content/reference/services/SoftLayer_Network_Storage/deleteAllFiles.md +++ b/content/reference/services/SoftLayer_Network_Storage/deleteAllFiles.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::deleteAllFiles + Delete all files within a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage/deleteFile.md b/content/reference/services/SoftLayer_Network_Storage/deleteFile.md index 3fb1c292c1..0e20ac2848 100644 --- a/content/reference/services/SoftLayer_Network_Storage/deleteFile.md +++ b/content/reference/services/SoftLayer_Network_Storage/deleteFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::deleteFile + Delete an individual file within a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage/deleteFiles.md b/content/reference/services/SoftLayer_Network_Storage/deleteFiles.md index 8927439b70..1bc6d0bd35 100644 --- a/content/reference/services/SoftLayer_Network_Storage/deleteFiles.md +++ b/content/reference/services/SoftLayer_Network_Storage/deleteFiles.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::deleteFiles + Delete multiple files within a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage/deleteFolder.md b/content/reference/services/SoftLayer_Network_Storage/deleteFolder.md index 676bfddb11..4ad08c0dec 100644 --- a/content/reference/services/SoftLayer_Network_Storage/deleteFolder.md +++ b/content/reference/services/SoftLayer_Network_Storage/deleteFolder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::deleteFolder + Delete a folder in the root directory. diff --git a/content/reference/services/SoftLayer_Network_Storage/deleteObject.md b/content/reference/services/SoftLayer_Network_Storage/deleteObject.md index 63c359875d..2bfcdea04a 100644 --- a/content/reference/services/SoftLayer_Network_Storage/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_Storage/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::deleteObject + Delete a network storage volume diff --git a/content/reference/services/SoftLayer_Network_Storage/disableSnapshots.md b/content/reference/services/SoftLayer_Network_Storage/disableSnapshots.md index 1f8b017ce0..e344d41be0 100644 --- a/content/reference/services/SoftLayer_Network_Storage/disableSnapshots.md +++ b/content/reference/services/SoftLayer_Network_Storage/disableSnapshots.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::disableSnapshots + Disable snapshots of this Storage Volume on a schedule. diff --git a/content/reference/services/SoftLayer_Network_Storage/disasterRecoveryFailoverToReplicant.md b/content/reference/services/SoftLayer_Network_Storage/disasterRecoveryFailoverToReplicant.md index 4da31e0819..48633c45ae 100644 --- a/content/reference/services/SoftLayer_Network_Storage/disasterRecoveryFailoverToReplicant.md +++ b/content/reference/services/SoftLayer_Network_Storage/disasterRecoveryFailoverToReplicant.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::disasterRecoveryFailoverToReplicant + Failover an inaccessible block/file volume to its available replicant volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/downloadFile.md b/content/reference/services/SoftLayer_Network_Storage/downloadFile.md index 0b57c0ba53..a220361df8 100644 --- a/content/reference/services/SoftLayer_Network_Storage/downloadFile.md +++ b/content/reference/services/SoftLayer_Network_Storage/downloadFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::downloadFile + Download a file from a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage/editCredential.md b/content/reference/services/SoftLayer_Network_Storage/editCredential.md index e68bfe0cdb..5420b6ca73 100644 --- a/content/reference/services/SoftLayer_Network_Storage/editCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage/editCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::editCredential + This method will change the password of a credential created using the 'addNewCredential' method. diff --git a/content/reference/services/SoftLayer_Network_Storage/editObject.md b/content/reference/services/SoftLayer_Network_Storage/editObject.md index ebf685d0a9..2fd7c6e54e 100644 --- a/content/reference/services/SoftLayer_Network_Storage/editObject.md +++ b/content/reference/services/SoftLayer_Network_Storage/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::editObject + Edit the password and/or notes for the Storage service diff --git a/content/reference/services/SoftLayer_Network_Storage/enableSnapshots.md b/content/reference/services/SoftLayer_Network_Storage/enableSnapshots.md index 0b79d760e6..cbf62ce429 100644 --- a/content/reference/services/SoftLayer_Network_Storage/enableSnapshots.md +++ b/content/reference/services/SoftLayer_Network_Storage/enableSnapshots.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::enableSnapshots + Enable snapshots of this Storage Volume on a schedule. diff --git a/content/reference/services/SoftLayer_Network_Storage/failbackFromReplicant.md b/content/reference/services/SoftLayer_Network_Storage/failbackFromReplicant.md index 94cab96ca6..4e74190597 100644 --- a/content/reference/services/SoftLayer_Network_Storage/failbackFromReplicant.md +++ b/content/reference/services/SoftLayer_Network_Storage/failbackFromReplicant.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::failbackFromReplicant + Failback from a volume replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage/failoverToReplicant.md b/content/reference/services/SoftLayer_Network_Storage/failoverToReplicant.md index 775b1cc618..537dffd840 100644 --- a/content/reference/services/SoftLayer_Network_Storage/failoverToReplicant.md +++ b/content/reference/services/SoftLayer_Network_Storage/failoverToReplicant.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::failoverToReplicant + Failover to a volume replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage/getAccount.md b/content/reference/services/SoftLayer_Network_Storage/getAccount.md index f15f4fcfde..9e6b677f05 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Storage/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getAccount + Retrieve the account that a Storage services belongs to. diff --git a/content/reference/services/SoftLayer_Network_Storage/getAccountPassword.md b/content/reference/services/SoftLayer_Network_Storage/getAccountPassword.md index fc08a900e5..49582d0f05 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getAccountPassword.md +++ b/content/reference/services/SoftLayer_Network_Storage/getAccountPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getAccountPassword + Retrieve other usernames and passwords associated with a Storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getActiveTransactions.md b/content/reference/services/SoftLayer_Network_Storage/getActiveTransactions.md index 346d50f3fb..474eed6d9a 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getActiveTransactions.md +++ b/content/reference/services/SoftLayer_Network_Storage/getActiveTransactions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getActiveTransactions + Retrieve the currently active transactions on a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getAllFiles.md b/content/reference/services/SoftLayer_Network_Storage/getAllFiles.md index f8e23eaea2..bbb5ef947f 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getAllFiles.md +++ b/content/reference/services/SoftLayer_Network_Storage/getAllFiles.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getAllFiles + Retrieve a listing of all files in a Storage account's root directory. diff --git a/content/reference/services/SoftLayer_Network_Storage/getAllFilesByFilter.md b/content/reference/services/SoftLayer_Network_Storage/getAllFilesByFilter.md index 1705fc924b..30e5011a0a 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getAllFilesByFilter.md +++ b/content/reference/services/SoftLayer_Network_Storage/getAllFilesByFilter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getAllFilesByFilter + Retrieve a listing of all files matching the filter's criteria in a Storage account's root directory. diff --git a/content/reference/services/SoftLayer_Network_Storage/getAllowDisasterRecoveryFailback.md b/content/reference/services/SoftLayer_Network_Storage/getAllowDisasterRecoveryFailback.md new file mode 100644 index 0000000000..f377570e54 --- /dev/null +++ b/content/reference/services/SoftLayer_Network_Storage/getAllowDisasterRecoveryFailback.md @@ -0,0 +1,45 @@ +--- +title: "getAllowDisasterRecoveryFailback" +description: "" +layout: "method" +tags: + - "method" + - "sldn" + - "Network" +classes: + - "SoftLayer_Network_Storage" +aliases: + - "/reference/services/softlayer_network_storage/getAllowDisasterRecoveryFailback" +--- +# [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getAllowDisasterRecoveryFailback + + + + + +## Overview + + +----- + +### Parameters +|Name | Type | Description | +| --- | --- | --- | + + +### Required Headers +* SoftLayer_Network_StorageInitParameters +* authenticate + + +### Optional Headers +* SoftLayer_Network_StorageObjectMask +* SoftLayer_Network_StorageObjectFilter +* SoftLayer_ObjectMask + +### Return Values +* string + + + + diff --git a/content/reference/services/SoftLayer_Network_Storage/getAllowDisasterRecoveryFailover.md b/content/reference/services/SoftLayer_Network_Storage/getAllowDisasterRecoveryFailover.md index 74f354efdb..dce9e23fa3 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getAllowDisasterRecoveryFailover.md +++ b/content/reference/services/SoftLayer_Network_Storage/getAllowDisasterRecoveryFailover.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/getAllowableHardware.md b/content/reference/services/SoftLayer_Network_Storage/getAllowableHardware.md index 41d082b070..1aab33a83e 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getAllowableHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage/getAllowableHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getAllowableHardware + Return a list of SoftLayer_Hardware that can be authorized to this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getAllowableIpAddresses.md b/content/reference/services/SoftLayer_Network_Storage/getAllowableIpAddresses.md index 0ebbbe1e39..cc6f78bb2f 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getAllowableIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Storage/getAllowableIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getAllowableIpAddresses + Return a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getAllowableSubnets.md b/content/reference/services/SoftLayer_Network_Storage/getAllowableSubnets.md index dbb0990b2c..a4ed2ca834 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getAllowableSubnets.md +++ b/content/reference/services/SoftLayer_Network_Storage/getAllowableSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getAllowableSubnets + Return a list of SoftLayer_Network_Subnet that can be authorized to this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getAllowableVirtualGuests.md b/content/reference/services/SoftLayer_Network_Storage/getAllowableVirtualGuests.md index 6f79c18575..fa831ed032 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getAllowableVirtualGuests.md +++ b/content/reference/services/SoftLayer_Network_Storage/getAllowableVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getAllowableVirtualGuests + Return a list of SoftLayer_Virtual_Guest that can be authorized to this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getAllowedHardware.md b/content/reference/services/SoftLayer_Network_Storage/getAllowedHardware.md index 0c9aca4c52..2295aac4c3 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getAllowedHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage/getAllowedHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getAllowedHardware + Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getAllowedHostsLimit.md b/content/reference/services/SoftLayer_Network_Storage/getAllowedHostsLimit.md index c5d9c5f6ce..835e659b64 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getAllowedHostsLimit.md +++ b/content/reference/services/SoftLayer_Network_Storage/getAllowedHostsLimit.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getAllowedHostsLimit + Retrieves the total number of allowed hosts limit per volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getAllowedIpAddresses.md b/content/reference/services/SoftLayer_Network_Storage/getAllowedIpAddresses.md index 23082cbe91..940323d7f6 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getAllowedIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Storage/getAllowedIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getAllowedIpAddresses + Retrieve the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getAllowedReplicationHardware.md b/content/reference/services/SoftLayer_Network_Storage/getAllowedReplicationHardware.md index f0969e1fad..5a25e86071 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getAllowedReplicationHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage/getAllowedReplicationHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getAllowedReplicationHardware + Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage/getAllowedReplicationIpAddresses.md b/content/reference/services/SoftLayer_Network_Storage/getAllowedReplicationIpAddresses.md index 521c371077..db1a39b410 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getAllowedReplicationIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Storage/getAllowedReplicationIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getAllowedReplicationIpAddresses + Retrieve the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage/getAllowedReplicationSubnets.md b/content/reference/services/SoftLayer_Network_Storage/getAllowedReplicationSubnets.md index eb0e7009e0..db0f8f1f18 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getAllowedReplicationSubnets.md +++ b/content/reference/services/SoftLayer_Network_Storage/getAllowedReplicationSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getAllowedReplicationSubnets + Retrieve the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage/getAllowedReplicationVirtualGuests.md b/content/reference/services/SoftLayer_Network_Storage/getAllowedReplicationVirtualGuests.md index 9ab315141e..1a288475e6 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getAllowedReplicationVirtualGuests.md +++ b/content/reference/services/SoftLayer_Network_Storage/getAllowedReplicationVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getAllowedReplicationVirtualGuests + Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage/getAllowedSubnets.md b/content/reference/services/SoftLayer_Network_Storage/getAllowedSubnets.md index 0a5cd27268..c5357704ed 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getAllowedSubnets.md +++ b/content/reference/services/SoftLayer_Network_Storage/getAllowedSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getAllowedSubnets + Retrieve the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getAllowedVirtualGuests.md b/content/reference/services/SoftLayer_Network_Storage/getAllowedVirtualGuests.md index dab9526eeb..646612282f 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getAllowedVirtualGuests.md +++ b/content/reference/services/SoftLayer_Network_Storage/getAllowedVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getAllowedVirtualGuests + Retrieve the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getBillingItem.md b/content/reference/services/SoftLayer_Network_Storage/getBillingItem.md index c58a8ab4f9..ee973eb37e 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Storage/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getBillingItem + Retrieve the current billing item for a Storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getBillingItemCategory.md b/content/reference/services/SoftLayer_Network_Storage/getBillingItemCategory.md index 61950fd00d..6f413a4303 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getBillingItemCategory.md +++ b/content/reference/services/SoftLayer_Network_Storage/getBillingItemCategory.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/getByUsername.md b/content/reference/services/SoftLayer_Network_Storage/getByUsername.md index 0e6a3c5b8f..7542555ad8 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getByUsername.md +++ b/content/reference/services/SoftLayer_Network_Storage/getByUsername.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getByUsername + Retrieve network storage accounts by username. diff --git a/content/reference/services/SoftLayer_Network_Storage/getBytesUsed.md b/content/reference/services/SoftLayer_Network_Storage/getBytesUsed.md index 37ba6bd3fd..bce5e38fa8 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getBytesUsed.md +++ b/content/reference/services/SoftLayer_Network_Storage/getBytesUsed.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getBytesUsed + Retrieve the amount of space used by the volume, in bytes. diff --git a/content/reference/services/SoftLayer_Network_Storage/getCdnUrls.md b/content/reference/services/SoftLayer_Network_Storage/getCdnUrls.md index 65adfffc64..c1b3eb3ea2 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getCdnUrls.md +++ b/content/reference/services/SoftLayer_Network_Storage/getCdnUrls.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/getClusterResource.md b/content/reference/services/SoftLayer_Network_Storage/getClusterResource.md index 9a74b118cf..c64ced100e 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getClusterResource.md +++ b/content/reference/services/SoftLayer_Network_Storage/getClusterResource.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/getCreationScheduleId.md b/content/reference/services/SoftLayer_Network_Storage/getCreationScheduleId.md index 073430ad40..a781af3767 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getCreationScheduleId.md +++ b/content/reference/services/SoftLayer_Network_Storage/getCreationScheduleId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getCreationScheduleId + Retrieve the schedule id which was executed to create a snapshot. diff --git a/content/reference/services/SoftLayer_Network_Storage/getCredentials.md b/content/reference/services/SoftLayer_Network_Storage/getCredentials.md index 8d4400787a..222574d713 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getCredentials.md +++ b/content/reference/services/SoftLayer_Network_Storage/getCredentials.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/getDailySchedule.md b/content/reference/services/SoftLayer_Network_Storage/getDailySchedule.md index a654171cd6..87984e747e 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getDailySchedule.md +++ b/content/reference/services/SoftLayer_Network_Storage/getDailySchedule.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getDailySchedule + Retrieve the Daily Schedule which is associated with this network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getDependentDuplicate.md b/content/reference/services/SoftLayer_Network_Storage/getDependentDuplicate.md index b2e8497971..4a61f06d53 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getDependentDuplicate.md +++ b/content/reference/services/SoftLayer_Network_Storage/getDependentDuplicate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getDependentDuplicate + Retrieve whether or not a network storage volume is a dependent duplicate. diff --git a/content/reference/services/SoftLayer_Network_Storage/getDependentDuplicates.md b/content/reference/services/SoftLayer_Network_Storage/getDependentDuplicates.md index 6af6893083..cdae70400a 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getDependentDuplicates.md +++ b/content/reference/services/SoftLayer_Network_Storage/getDependentDuplicates.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getDependentDuplicates + Retrieve the network storage volumes configured to be dependent duplicates of a volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getEvents.md b/content/reference/services/SoftLayer_Network_Storage/getEvents.md index fe2066d87f..ea3afc3f6b 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getEvents.md +++ b/content/reference/services/SoftLayer_Network_Storage/getEvents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getEvents + Retrieve the events which have taken place on a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getFailbackNotAllowed.md b/content/reference/services/SoftLayer_Network_Storage/getFailbackNotAllowed.md index cd911e9e2d..110e2e0c11 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getFailbackNotAllowed.md +++ b/content/reference/services/SoftLayer_Network_Storage/getFailbackNotAllowed.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getFailbackNotAllowed + Retrieve determines whether the volume is allowed to failback diff --git a/content/reference/services/SoftLayer_Network_Storage/getFailoverNotAllowed.md b/content/reference/services/SoftLayer_Network_Storage/getFailoverNotAllowed.md new file mode 100644 index 0000000000..df0aaa9054 --- /dev/null +++ b/content/reference/services/SoftLayer_Network_Storage/getFailoverNotAllowed.md @@ -0,0 +1,45 @@ +--- +title: "getFailoverNotAllowed" +description: "Retrieve determines whether the volume is allowed to failover" +layout: "method" +tags: + - "method" + - "sldn" + - "Network" +classes: + - "SoftLayer_Network_Storage" +aliases: + - "/reference/services/softlayer_network_storage/getFailoverNotAllowed" +--- +# [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getFailoverNotAllowed + + +Retrieve determines whether the volume is allowed to failover + + +## Overview +Retrieve determines whether the volume is allowed to failover + +----- + +### Parameters +|Name | Type | Description | +| --- | --- | --- | + + +### Required Headers +* SoftLayer_Network_StorageInitParameters +* authenticate + + +### Optional Headers +* SoftLayer_Network_StorageObjectMask +* SoftLayer_Network_StorageObjectFilter +* SoftLayer_ObjectMask + +### Return Values +* string + + + + diff --git a/content/reference/services/SoftLayer_Network_Storage/getFileBlockEncryptedLocations.md b/content/reference/services/SoftLayer_Network_Storage/getFileBlockEncryptedLocations.md index e7edf225a7..e729eeb2fb 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getFileBlockEncryptedLocations.md +++ b/content/reference/services/SoftLayer_Network_Storage/getFileBlockEncryptedLocations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getFileBlockEncryptedLocations + Returns a list of SoftLayer_Location_Datacenter objects corresponding to Datacenters in which File and Block Storage Volumes with Encryption at Rest may be ordered. diff --git a/content/reference/services/SoftLayer_Network_Storage/getFileByIdentifier.md b/content/reference/services/SoftLayer_Network_Storage/getFileByIdentifier.md index 658e49367c..facc59cac2 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getFileByIdentifier.md +++ b/content/reference/services/SoftLayer_Network_Storage/getFileByIdentifier.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getFileByIdentifier + Retrieve an individual file's details. diff --git a/content/reference/services/SoftLayer_Network_Storage/getFileCount.md b/content/reference/services/SoftLayer_Network_Storage/getFileCount.md index 4f32985a80..fce4e59243 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getFileCount.md +++ b/content/reference/services/SoftLayer_Network_Storage/getFileCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getFileCount + Retrieve the file number of files in a Virtual Server Storage account's root directory. diff --git a/content/reference/services/SoftLayer_Network_Storage/getFileList.md b/content/reference/services/SoftLayer_Network_Storage/getFileList.md index 41c123e24f..e7588239cb 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getFileList.md +++ b/content/reference/services/SoftLayer_Network_Storage/getFileList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getFileList + Retrieve list of files in a given folder for this account. diff --git a/content/reference/services/SoftLayer_Network_Storage/getFileNetworkMountAddress.md b/content/reference/services/SoftLayer_Network_Storage/getFileNetworkMountAddress.md index 13a1978b70..03045c123f 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getFileNetworkMountAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage/getFileNetworkMountAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getFileNetworkMountAddress + Retrieve retrieves the NFS Network Mount Address Name for a given File Storage Volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getFilePendingDeleteCount.md b/content/reference/services/SoftLayer_Network_Storage/getFilePendingDeleteCount.md index b38f87151f..2715761144 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getFilePendingDeleteCount.md +++ b/content/reference/services/SoftLayer_Network_Storage/getFilePendingDeleteCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getFilePendingDeleteCount + Retrieve the number of files pending deletion in a Storage account's recycle bin. diff --git a/content/reference/services/SoftLayer_Network_Storage/getFilesPendingDelete.md b/content/reference/services/SoftLayer_Network_Storage/getFilesPendingDelete.md index a876465069..1dfc750977 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getFilesPendingDelete.md +++ b/content/reference/services/SoftLayer_Network_Storage/getFilesPendingDelete.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getFilesPendingDelete + Retrieve a list of files in a Storage account's recycle bin. diff --git a/content/reference/services/SoftLayer_Network_Storage/getFolderList.md b/content/reference/services/SoftLayer_Network_Storage/getFolderList.md index 597166e5d5..2f04b529a8 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getFolderList.md +++ b/content/reference/services/SoftLayer_Network_Storage/getFolderList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getFolderList + Retrieve a list of level 1 folders for this account. diff --git a/content/reference/services/SoftLayer_Network_Storage/getGraph.md b/content/reference/services/SoftLayer_Network_Storage/getGraph.md index 38cd2a92a0..a0bf0fe57f 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getGraph.md +++ b/content/reference/services/SoftLayer_Network_Storage/getGraph.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getGraph + Retrieve a graph representing the bandwidth used by a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage/getHardware.md b/content/reference/services/SoftLayer_Network_Storage/getHardware.md index 28eb7cfa0e..35817b8ea1 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getHardware + Retrieve when applicable, the hardware associated with a Storage service. diff --git a/content/reference/services/SoftLayer_Network_Storage/getHasEncryptionAtRest.md b/content/reference/services/SoftLayer_Network_Storage/getHasEncryptionAtRest.md index 53a98e62d5..4586cdb768 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getHasEncryptionAtRest.md +++ b/content/reference/services/SoftLayer_Network_Storage/getHasEncryptionAtRest.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/getHourlySchedule.md b/content/reference/services/SoftLayer_Network_Storage/getHourlySchedule.md index 2dc4f5337c..35d31edd6e 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getHourlySchedule.md +++ b/content/reference/services/SoftLayer_Network_Storage/getHourlySchedule.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getHourlySchedule + Retrieve the Hourly Schedule which is associated with this network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getIntervalSchedule.md b/content/reference/services/SoftLayer_Network_Storage/getIntervalSchedule.md index 078d335b56..814ff1f5cf 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getIntervalSchedule.md +++ b/content/reference/services/SoftLayer_Network_Storage/getIntervalSchedule.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getIntervalSchedule + Retrieve the Interval Schedule which is associated with this network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getIops.md b/content/reference/services/SoftLayer_Network_Storage/getIops.md index 157406990f..db13f78bb7 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getIops.md +++ b/content/reference/services/SoftLayer_Network_Storage/getIops.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getIops + Retrieve the maximum number of IOPs selected for this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getIsDependentDuplicateProvisionCompleted.md b/content/reference/services/SoftLayer_Network_Storage/getIsDependentDuplicateProvisionCompleted.md index 6a56f088b1..8225d755b6 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getIsDependentDuplicateProvisionCompleted.md +++ b/content/reference/services/SoftLayer_Network_Storage/getIsDependentDuplicateProvisionCompleted.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getIsDependentDuplicateProvisionCompleted + Retrieve determines whether dependent volume provision is completed on background. diff --git a/content/reference/services/SoftLayer_Network_Storage/getIsInDedicatedServiceResource.md b/content/reference/services/SoftLayer_Network_Storage/getIsInDedicatedServiceResource.md index 87f77d0f3f..e97b411510 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getIsInDedicatedServiceResource.md +++ b/content/reference/services/SoftLayer_Network_Storage/getIsInDedicatedServiceResource.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/getIsMagneticStorage.md b/content/reference/services/SoftLayer_Network_Storage/getIsMagneticStorage.md index ce2efc6f8e..3b39e3df27 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getIsMagneticStorage.md +++ b/content/reference/services/SoftLayer_Network_Storage/getIsMagneticStorage.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/getIsReadyForSnapshot.md b/content/reference/services/SoftLayer_Network_Storage/getIsReadyForSnapshot.md index b5a794d4e6..a6450661ed 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getIsReadyForSnapshot.md +++ b/content/reference/services/SoftLayer_Network_Storage/getIsReadyForSnapshot.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getIsReadyForSnapshot + Retrieve determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. diff --git a/content/reference/services/SoftLayer_Network_Storage/getIsReadyToMount.md b/content/reference/services/SoftLayer_Network_Storage/getIsReadyToMount.md index da60cc8669..be57d60dfe 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getIsReadyToMount.md +++ b/content/reference/services/SoftLayer_Network_Storage/getIsReadyToMount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getIsReadyToMount + Retrieve determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. diff --git a/content/reference/services/SoftLayer_Network_Storage/getIscsiLuns.md b/content/reference/services/SoftLayer_Network_Storage/getIscsiLuns.md index 438d7a53a2..b1321aac13 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getIscsiLuns.md +++ b/content/reference/services/SoftLayer_Network_Storage/getIscsiLuns.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getIscsiLuns + Retrieve relationship between a container volume and iSCSI LUNs. diff --git a/content/reference/services/SoftLayer_Network_Storage/getIscsiTargetIpAddresses.md b/content/reference/services/SoftLayer_Network_Storage/getIscsiTargetIpAddresses.md index 1601cdd5a1..7677de9c74 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getIscsiTargetIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Storage/getIscsiTargetIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getIscsiTargetIpAddresses + Retrieve returns the target IP addresses of an iSCSI volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getLunId.md b/content/reference/services/SoftLayer_Network_Storage/getLunId.md index 42a5f1154e..23f09490b9 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getLunId.md +++ b/content/reference/services/SoftLayer_Network_Storage/getLunId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getLunId + Retrieve the ID of the LUN volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getManualSnapshots.md b/content/reference/services/SoftLayer_Network_Storage/getManualSnapshots.md index 210572b89b..ad147c903d 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getManualSnapshots.md +++ b/content/reference/services/SoftLayer_Network_Storage/getManualSnapshots.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getManualSnapshots + Retrieve the manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. diff --git a/content/reference/services/SoftLayer_Network_Storage/getMaximumExpansionSize.md b/content/reference/services/SoftLayer_Network_Storage/getMaximumExpansionSize.md index 56e32077f9..e03dce754f 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getMaximumExpansionSize.md +++ b/content/reference/services/SoftLayer_Network_Storage/getMaximumExpansionSize.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getMaximumExpansionSize + Returns the maximum volume expansion size in GB. diff --git a/content/reference/services/SoftLayer_Network_Storage/getMetricTrackingObject.md b/content/reference/services/SoftLayer_Network_Storage/getMetricTrackingObject.md index a055058e83..cb7642c9a2 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getMetricTrackingObject.md +++ b/content/reference/services/SoftLayer_Network_Storage/getMetricTrackingObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getMetricTrackingObject + Retrieve a network storage volume's metric tracking object. This object records all periodic polled data available to this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getMountPath.md b/content/reference/services/SoftLayer_Network_Storage/getMountPath.md index 9ce88b54e6..40c8538ef5 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getMountPath.md +++ b/content/reference/services/SoftLayer_Network_Storage/getMountPath.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getMountPath + Retrieve retrieves the NFS Network Mount Path for a given File Storage Volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getMountableFlag.md b/content/reference/services/SoftLayer_Network_Storage/getMountableFlag.md index fecea97859..9a38af0926 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getMountableFlag.md +++ b/content/reference/services/SoftLayer_Network_Storage/getMountableFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getMountableFlag + Retrieve whether or not a network storage volume may be mounted. diff --git a/content/reference/services/SoftLayer_Network_Storage/getMoveAndSplitStatus.md b/content/reference/services/SoftLayer_Network_Storage/getMoveAndSplitStatus.md index 2c09ca521c..64986274a7 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getMoveAndSplitStatus.md +++ b/content/reference/services/SoftLayer_Network_Storage/getMoveAndSplitStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getMoveAndSplitStatus + Retrieve the current status of split or move operation as a part of volume duplication. diff --git a/content/reference/services/SoftLayer_Network_Storage/getNetworkConnectionDetails.md b/content/reference/services/SoftLayer_Network_Storage/getNetworkConnectionDetails.md index 8076764cb7..4acb88fa22 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getNetworkConnectionDetails.md +++ b/content/reference/services/SoftLayer_Network_Storage/getNetworkConnectionDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getNetworkConnectionDetails + Retrieve network connection details for complex network storage volumes. diff --git a/content/reference/services/SoftLayer_Network_Storage/getNetworkMountAddress.md b/content/reference/services/SoftLayer_Network_Storage/getNetworkMountAddress.md index 8dca42b711..9c1cc273b8 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getNetworkMountAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage/getNetworkMountAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getNetworkMountAddress + Displays the mount path of a storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getNetworkMountPath.md b/content/reference/services/SoftLayer_Network_Storage/getNetworkMountPath.md index 14fe2cb7c0..b14a08fff3 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getNetworkMountPath.md +++ b/content/reference/services/SoftLayer_Network_Storage/getNetworkMountPath.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getNetworkMountPath + Displays the mount path of a storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getNotificationSubscribers.md b/content/reference/services/SoftLayer_Network_Storage/getNotificationSubscribers.md index 9d0a8e6698..4780e12775 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getNotificationSubscribers.md +++ b/content/reference/services/SoftLayer_Network_Storage/getNotificationSubscribers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getNotificationSubscribers + Retrieve the subscribers that will be notified for usage amount warnings and overages. diff --git a/content/reference/services/SoftLayer_Network_Storage/getObject.md b/content/reference/services/SoftLayer_Network_Storage/getObject.md index 9b979c4982..957a0913f1 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getObject + Retrieve a SoftLayer_Network_Storage record. diff --git a/content/reference/services/SoftLayer_Network_Storage/getObjectStorageConnectionInformation.md b/content/reference/services/SoftLayer_Network_Storage/getObjectStorageConnectionInformation.md index 6cf024e4e5..eec746445d 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getObjectStorageConnectionInformation.md +++ b/content/reference/services/SoftLayer_Network_Storage/getObjectStorageConnectionInformation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getObjectStorageConnectionInformation + Retrieve all object storage details for connection diff --git a/content/reference/services/SoftLayer_Network_Storage/getObjectsByCredential.md b/content/reference/services/SoftLayer_Network_Storage/getObjectsByCredential.md index 0da49d405c..80ababe94e 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getObjectsByCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage/getObjectsByCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getObjectsByCredential + Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object. diff --git a/content/reference/services/SoftLayer_Network_Storage/getOriginalSnapshotName.md b/content/reference/services/SoftLayer_Network_Storage/getOriginalSnapshotName.md index c61ef21519..9db00da18a 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getOriginalSnapshotName.md +++ b/content/reference/services/SoftLayer_Network_Storage/getOriginalSnapshotName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getOriginalSnapshotName + Retrieve the name of the snapshot that this volume was duplicated from. diff --git a/content/reference/services/SoftLayer_Network_Storage/getOriginalVolumeName.md b/content/reference/services/SoftLayer_Network_Storage/getOriginalVolumeName.md index cfc6d7a056..f5b3062f6d 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getOriginalVolumeName.md +++ b/content/reference/services/SoftLayer_Network_Storage/getOriginalVolumeName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getOriginalVolumeName + Retrieve the name of the volume that this volume was duplicated from. diff --git a/content/reference/services/SoftLayer_Network_Storage/getOriginalVolumeSize.md b/content/reference/services/SoftLayer_Network_Storage/getOriginalVolumeSize.md index ddfaee4df6..3fbd5eda54 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getOriginalVolumeSize.md +++ b/content/reference/services/SoftLayer_Network_Storage/getOriginalVolumeSize.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getOriginalVolumeSize + Retrieve the size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. diff --git a/content/reference/services/SoftLayer_Network_Storage/getOsType.md b/content/reference/services/SoftLayer_Network_Storage/getOsType.md index e500e41263..1b7c04eee1 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getOsType.md +++ b/content/reference/services/SoftLayer_Network_Storage/getOsType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getOsType + Retrieve a volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. diff --git a/content/reference/services/SoftLayer_Network_Storage/getOsTypeId.md b/content/reference/services/SoftLayer_Network_Storage/getOsTypeId.md index d9553e95ff..5fa88233c6 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getOsTypeId.md +++ b/content/reference/services/SoftLayer_Network_Storage/getOsTypeId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getOsTypeId + Retrieve a volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. diff --git a/content/reference/services/SoftLayer_Network_Storage/getParentPartnerships.md b/content/reference/services/SoftLayer_Network_Storage/getParentPartnerships.md index bde111aada..cd63709f34 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getParentPartnerships.md +++ b/content/reference/services/SoftLayer_Network_Storage/getParentPartnerships.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getParentPartnerships + Retrieve the volumes or snapshots partnered with a network storage volume in a parental role. diff --git a/content/reference/services/SoftLayer_Network_Storage/getParentVolume.md b/content/reference/services/SoftLayer_Network_Storage/getParentVolume.md index 2a0b9fd209..279417ab16 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getParentVolume.md +++ b/content/reference/services/SoftLayer_Network_Storage/getParentVolume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getParentVolume + Retrieve the parent volume of a volume in a complex storage relationship. diff --git a/content/reference/services/SoftLayer_Network_Storage/getPartnerships.md b/content/reference/services/SoftLayer_Network_Storage/getPartnerships.md index 25cf6a6e89..86c4888de5 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getPartnerships.md +++ b/content/reference/services/SoftLayer_Network_Storage/getPartnerships.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getPartnerships + Retrieve the volumes or snapshots partnered with a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getPermissionsGroups.md b/content/reference/services/SoftLayer_Network_Storage/getPermissionsGroups.md index 4906cb1ef4..97c4f36fbf 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getPermissionsGroups.md +++ b/content/reference/services/SoftLayer_Network_Storage/getPermissionsGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getPermissionsGroups + Retrieve all permissions group(s) this volume is in. diff --git a/content/reference/services/SoftLayer_Network_Storage/getProperties.md b/content/reference/services/SoftLayer_Network_Storage/getProperties.md index 4f33fe512b..1db5ac0d4a 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getProperties.md +++ b/content/reference/services/SoftLayer_Network_Storage/getProperties.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getProperties + Retrieve the properties used to provide additional details about a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getProvisionedIops.md b/content/reference/services/SoftLayer_Network_Storage/getProvisionedIops.md index 3019d05023..90091d69d7 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getProvisionedIops.md +++ b/content/reference/services/SoftLayer_Network_Storage/getProvisionedIops.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getProvisionedIops + Retrieve the number of IOPs provisioned for this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getRecycleBinFileByIdentifier.md b/content/reference/services/SoftLayer_Network_Storage/getRecycleBinFileByIdentifier.md index 8f295d6d8a..290615b7e6 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getRecycleBinFileByIdentifier.md +++ b/content/reference/services/SoftLayer_Network_Storage/getRecycleBinFileByIdentifier.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getRecycleBinFileByIdentifier + Retrieve all files that are in the recycle bin (pending delete). This method is only used for Virtual Server Storage accounts at moment but may expanded to other Storage types in the future. diff --git a/content/reference/services/SoftLayer_Network_Storage/getRemainingAllowedHosts.md b/content/reference/services/SoftLayer_Network_Storage/getRemainingAllowedHosts.md index 405cdc7c4d..30c292cba6 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getRemainingAllowedHosts.md +++ b/content/reference/services/SoftLayer_Network_Storage/getRemainingAllowedHosts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getRemainingAllowedHosts + Retrieves the remaining number of allowed hosts per volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getRemainingAllowedHostsForReplicant.md b/content/reference/services/SoftLayer_Network_Storage/getRemainingAllowedHostsForReplicant.md index c851fb0956..7ca9f154d7 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getRemainingAllowedHostsForReplicant.md +++ b/content/reference/services/SoftLayer_Network_Storage/getRemainingAllowedHostsForReplicant.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getRemainingAllowedHostsForReplicant + Retrieves the remaining number of allowed hosts for a volume's replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage/getReplicatingLuns.md b/content/reference/services/SoftLayer_Network_Storage/getReplicatingLuns.md index ba1f28078d..8d357a414b 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getReplicatingLuns.md +++ b/content/reference/services/SoftLayer_Network_Storage/getReplicatingLuns.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getReplicatingLuns + Retrieve the iSCSI LUN volumes being replicated by this network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getReplicatingVolume.md b/content/reference/services/SoftLayer_Network_Storage/getReplicatingVolume.md index 017a2909af..794f18cbe4 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getReplicatingVolume.md +++ b/content/reference/services/SoftLayer_Network_Storage/getReplicatingVolume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getReplicatingVolume + Retrieve the network storage volume being replicated by a volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getReplicationEvents.md b/content/reference/services/SoftLayer_Network_Storage/getReplicationEvents.md index 987ca20c4a..c848a5cb38 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getReplicationEvents.md +++ b/content/reference/services/SoftLayer_Network_Storage/getReplicationEvents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getReplicationEvents + Retrieve the volume replication events. diff --git a/content/reference/services/SoftLayer_Network_Storage/getReplicationPartners.md b/content/reference/services/SoftLayer_Network_Storage/getReplicationPartners.md index b898f671db..274f32a090 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getReplicationPartners.md +++ b/content/reference/services/SoftLayer_Network_Storage/getReplicationPartners.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getReplicationPartners + Retrieve the network storage volumes configured to be replicants of a volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getReplicationSchedule.md b/content/reference/services/SoftLayer_Network_Storage/getReplicationSchedule.md index 9d1fc3ca31..ee2d20542a 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getReplicationSchedule.md +++ b/content/reference/services/SoftLayer_Network_Storage/getReplicationSchedule.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getReplicationSchedule + Retrieve the Replication Schedule associated with a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getReplicationStatus.md b/content/reference/services/SoftLayer_Network_Storage/getReplicationStatus.md index 7f077d00f2..822b302d43 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getReplicationStatus.md +++ b/content/reference/services/SoftLayer_Network_Storage/getReplicationStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getReplicationStatus + Retrieve the current replication status of a network storage volume. Indicates Failover or Failback status. diff --git a/content/reference/services/SoftLayer_Network_Storage/getReplicationTimestamp.md b/content/reference/services/SoftLayer_Network_Storage/getReplicationTimestamp.md index dadae68761..7f3b544cb6 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getReplicationTimestamp.md +++ b/content/reference/services/SoftLayer_Network_Storage/getReplicationTimestamp.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getReplicationTimestamp + An API call to fetch the last timestamp of the replication process diff --git a/content/reference/services/SoftLayer_Network_Storage/getSchedules.md b/content/reference/services/SoftLayer_Network_Storage/getSchedules.md index aa5e3c006c..f3385fb0e0 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getSchedules.md +++ b/content/reference/services/SoftLayer_Network_Storage/getSchedules.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getSchedules + Retrieve the schedules which are associated with a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getServiceResource.md b/content/reference/services/SoftLayer_Network_Storage/getServiceResource.md index 3b7c64fbfb..ac815e5e84 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getServiceResource.md +++ b/content/reference/services/SoftLayer_Network_Storage/getServiceResource.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getServiceResource + Retrieve the network resource a Storage service is connected to. diff --git a/content/reference/services/SoftLayer_Network_Storage/getServiceResourceBackendIpAddress.md b/content/reference/services/SoftLayer_Network_Storage/getServiceResourceBackendIpAddress.md index af36814545..5f8ad0b06b 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getServiceResourceBackendIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage/getServiceResourceBackendIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getServiceResourceBackendIpAddress + Retrieve the IP address of a Storage resource. diff --git a/content/reference/services/SoftLayer_Network_Storage/getServiceResourceName.md b/content/reference/services/SoftLayer_Network_Storage/getServiceResourceName.md index 4ef776b230..929e75ef4a 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getServiceResourceName.md +++ b/content/reference/services/SoftLayer_Network_Storage/getServiceResourceName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getServiceResourceName + Retrieve the name of a Storage's network resource. diff --git a/content/reference/services/SoftLayer_Network_Storage/getSnapshotCapacityGb.md b/content/reference/services/SoftLayer_Network_Storage/getSnapshotCapacityGb.md index fbb5e953fd..0777dcaffd 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getSnapshotCapacityGb.md +++ b/content/reference/services/SoftLayer_Network_Storage/getSnapshotCapacityGb.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getSnapshotCapacityGb + Retrieve a volume's configured snapshot space size. diff --git a/content/reference/services/SoftLayer_Network_Storage/getSnapshotCreationTimestamp.md b/content/reference/services/SoftLayer_Network_Storage/getSnapshotCreationTimestamp.md index ae0ae8d102..a36be7e6c3 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getSnapshotCreationTimestamp.md +++ b/content/reference/services/SoftLayer_Network_Storage/getSnapshotCreationTimestamp.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getSnapshotCreationTimestamp + Retrieve the creation timestamp of the snapshot on the storage platform. diff --git a/content/reference/services/SoftLayer_Network_Storage/getSnapshotDeletionThresholdPercentage.md b/content/reference/services/SoftLayer_Network_Storage/getSnapshotDeletionThresholdPercentage.md index a5a9596725..4d20f42a23 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getSnapshotDeletionThresholdPercentage.md +++ b/content/reference/services/SoftLayer_Network_Storage/getSnapshotDeletionThresholdPercentage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getSnapshotDeletionThresholdPercentage + Retrieve the percentage of used snapshot space after which to delete automated snapshots. diff --git a/content/reference/services/SoftLayer_Network_Storage/getSnapshotNotificationStatus.md b/content/reference/services/SoftLayer_Network_Storage/getSnapshotNotificationStatus.md index 7651058e20..bc9b6e188f 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getSnapshotNotificationStatus.md +++ b/content/reference/services/SoftLayer_Network_Storage/getSnapshotNotificationStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getSnapshotNotificationStatus + Retrieve whether or not a network storage volume may be mounted. diff --git a/content/reference/services/SoftLayer_Network_Storage/getSnapshotSizeBytes.md b/content/reference/services/SoftLayer_Network_Storage/getSnapshotSizeBytes.md index 5d21350334..bcf7216bb9 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getSnapshotSizeBytes.md +++ b/content/reference/services/SoftLayer_Network_Storage/getSnapshotSizeBytes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getSnapshotSizeBytes + Retrieve the snapshot size in bytes. diff --git a/content/reference/services/SoftLayer_Network_Storage/getSnapshotSpaceAvailable.md b/content/reference/services/SoftLayer_Network_Storage/getSnapshotSpaceAvailable.md index 30bc7386c3..eb80ca4c5c 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getSnapshotSpaceAvailable.md +++ b/content/reference/services/SoftLayer_Network_Storage/getSnapshotSpaceAvailable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getSnapshotSpaceAvailable + Retrieve a volume's available snapshot reservation space. diff --git a/content/reference/services/SoftLayer_Network_Storage/getSnapshots.md b/content/reference/services/SoftLayer_Network_Storage/getSnapshots.md index 1e185f51f6..9aecd0947a 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getSnapshots.md +++ b/content/reference/services/SoftLayer_Network_Storage/getSnapshots.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getSnapshots + Retrieve the snapshots associated with this SoftLayer_Network_Storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getSnapshotsForVolume.md b/content/reference/services/SoftLayer_Network_Storage/getSnapshotsForVolume.md index 97803e0b67..8920a8997e 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getSnapshotsForVolume.md +++ b/content/reference/services/SoftLayer_Network_Storage/getSnapshotsForVolume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getSnapshotsForVolume + Retrieves a list oƒf snapshots for a given volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getStaasVersion.md b/content/reference/services/SoftLayer_Network_Storage/getStaasVersion.md index e38a364594..528b1b560d 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getStaasVersion.md +++ b/content/reference/services/SoftLayer_Network_Storage/getStaasVersion.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/getStorageGroups.md b/content/reference/services/SoftLayer_Network_Storage/getStorageGroups.md index 084ee8a0cc..0597be783b 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getStorageGroups.md +++ b/content/reference/services/SoftLayer_Network_Storage/getStorageGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getStorageGroups + Retrieve the network storage groups this volume is attached to. diff --git a/content/reference/services/SoftLayer_Network_Storage/getStorageGroupsNetworkConnectionDetails.md b/content/reference/services/SoftLayer_Network_Storage/getStorageGroupsNetworkConnectionDetails.md index 7dead5ef04..5f95fda8d1 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getStorageGroupsNetworkConnectionDetails.md +++ b/content/reference/services/SoftLayer_Network_Storage/getStorageGroupsNetworkConnectionDetails.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/getStorageTierLevel.md b/content/reference/services/SoftLayer_Network_Storage/getStorageTierLevel.md index c0054ba269..5fa95dbe85 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getStorageTierLevel.md +++ b/content/reference/services/SoftLayer_Network_Storage/getStorageTierLevel.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/getStorageType.md b/content/reference/services/SoftLayer_Network_Storage/getStorageType.md index c4219b2fc7..6b8ee9dd5f 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getStorageType.md +++ b/content/reference/services/SoftLayer_Network_Storage/getStorageType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getStorageType + Retrieve a description of the Storage object. diff --git a/content/reference/services/SoftLayer_Network_Storage/getTargetIpAddresses.md b/content/reference/services/SoftLayer_Network_Storage/getTargetIpAddresses.md index 75f4ad1bb5..7a0b2f19f9 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getTargetIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Storage/getTargetIpAddresses.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/getTotalBytesUsed.md b/content/reference/services/SoftLayer_Network_Storage/getTotalBytesUsed.md index aeb86205c9..319fa79c6a 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getTotalBytesUsed.md +++ b/content/reference/services/SoftLayer_Network_Storage/getTotalBytesUsed.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getTotalBytesUsed + Retrieve the amount of space used by the volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getTotalScheduleSnapshotRetentionCount.md b/content/reference/services/SoftLayer_Network_Storage/getTotalScheduleSnapshotRetentionCount.md index 191e180815..18975101ba 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getTotalScheduleSnapshotRetentionCount.md +++ b/content/reference/services/SoftLayer_Network_Storage/getTotalScheduleSnapshotRetentionCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getTotalScheduleSnapshotRetentionCount + Retrieve the total snapshot retention count of all schedules on this network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getUsageNotification.md b/content/reference/services/SoftLayer_Network_Storage/getUsageNotification.md index dc41665100..99beeff8ed 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getUsageNotification.md +++ b/content/reference/services/SoftLayer_Network_Storage/getUsageNotification.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getUsageNotification + Retrieve the usage notification for SL Storage services. diff --git a/content/reference/services/SoftLayer_Network_Storage/getValidReplicationTargetDatacenterLocations.md b/content/reference/services/SoftLayer_Network_Storage/getValidReplicationTargetDatacenterLocations.md index b127e75966..dd18a4890b 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getValidReplicationTargetDatacenterLocations.md +++ b/content/reference/services/SoftLayer_Network_Storage/getValidReplicationTargetDatacenterLocations.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/getVendorName.md b/content/reference/services/SoftLayer_Network_Storage/getVendorName.md index a1c81d33a3..00d8d51c2d 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getVendorName.md +++ b/content/reference/services/SoftLayer_Network_Storage/getVendorName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getVendorName + Retrieve the type of network storage service. diff --git a/content/reference/services/SoftLayer_Network_Storage/getVirtualGuest.md b/content/reference/services/SoftLayer_Network_Storage/getVirtualGuest.md index 82b2c98493..5ba2acd644 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getVirtualGuest.md +++ b/content/reference/services/SoftLayer_Network_Storage/getVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getVirtualGuest + Retrieve when applicable, the virtual guest associated with a Storage service. diff --git a/content/reference/services/SoftLayer_Network_Storage/getVolumeCountLimits.md b/content/reference/services/SoftLayer_Network_Storage/getVolumeCountLimits.md index a0291501b6..8c5cb57256 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getVolumeCountLimits.md +++ b/content/reference/services/SoftLayer_Network_Storage/getVolumeCountLimits.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getVolumeCountLimits + Retrieves an array of volume count limits per location and globally. diff --git a/content/reference/services/SoftLayer_Network_Storage/getVolumeDuplicateParameters.md b/content/reference/services/SoftLayer_Network_Storage/getVolumeDuplicateParameters.md index 33b357194e..165bacd03f 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getVolumeDuplicateParameters.md +++ b/content/reference/services/SoftLayer_Network_Storage/getVolumeDuplicateParameters.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method returns the parameters for cloning a volume diff --git a/content/reference/services/SoftLayer_Network_Storage/getVolumeHistory.md b/content/reference/services/SoftLayer_Network_Storage/getVolumeHistory.md index 0d569e8150..3d6be575cc 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getVolumeHistory.md +++ b/content/reference/services/SoftLayer_Network_Storage/getVolumeHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getVolumeHistory + Retrieve the username and password history for a Storage service. diff --git a/content/reference/services/SoftLayer_Network_Storage/getVolumeStatus.md b/content/reference/services/SoftLayer_Network_Storage/getVolumeStatus.md index d9b421bf1c..55cf86f392 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getVolumeStatus.md +++ b/content/reference/services/SoftLayer_Network_Storage/getVolumeStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getVolumeStatus + Retrieve the current status of a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/getWebccAccount.md b/content/reference/services/SoftLayer_Network_Storage/getWebccAccount.md index 00c8a272c1..2717a57b03 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getWebccAccount.md +++ b/content/reference/services/SoftLayer_Network_Storage/getWebccAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getWebccAccount + Retrieve the account username and password for the EVault webCC interface. diff --git a/content/reference/services/SoftLayer_Network_Storage/getWeeklySchedule.md b/content/reference/services/SoftLayer_Network_Storage/getWeeklySchedule.md index e1de98888d..fda60f5a3a 100644 --- a/content/reference/services/SoftLayer_Network_Storage/getWeeklySchedule.md +++ b/content/reference/services/SoftLayer_Network_Storage/getWeeklySchedule.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::getWeeklySchedule + Retrieve the Weekly Schedule which is associated with this network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/immediateFailoverToReplicant.md b/content/reference/services/SoftLayer_Network_Storage/immediateFailoverToReplicant.md index daf9c177e4..66f515eff2 100644 --- a/content/reference/services/SoftLayer_Network_Storage/immediateFailoverToReplicant.md +++ b/content/reference/services/SoftLayer_Network_Storage/immediateFailoverToReplicant.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::immediateFailoverToReplicant + Immediate Failover to a volume replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage/initiateOriginVolumeReclaim.md b/content/reference/services/SoftLayer_Network_Storage/initiateOriginVolumeReclaim.md index 6fc3ed0190..4a806733cd 100644 --- a/content/reference/services/SoftLayer_Network_Storage/initiateOriginVolumeReclaim.md +++ b/content/reference/services/SoftLayer_Network_Storage/initiateOriginVolumeReclaim.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::initiateOriginVolumeReclaim + Initiates Origin Volume Reclaim to delete volume from NetApp. diff --git a/content/reference/services/SoftLayer_Network_Storage/initiateVolumeCutover.md b/content/reference/services/SoftLayer_Network_Storage/initiateVolumeCutover.md index e0492ff515..41f55fa1dc 100644 --- a/content/reference/services/SoftLayer_Network_Storage/initiateVolumeCutover.md +++ b/content/reference/services/SoftLayer_Network_Storage/initiateVolumeCutover.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::initiateVolumeCutover + Initiates Volume Cutover to remove access from the old volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/isBlockingOperationInProgress.md b/content/reference/services/SoftLayer_Network_Storage/isBlockingOperationInProgress.md index c8926150c0..abf94b55ea 100644 --- a/content/reference/services/SoftLayer_Network_Storage/isBlockingOperationInProgress.md +++ b/content/reference/services/SoftLayer_Network_Storage/isBlockingOperationInProgress.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/isDuplicateReadyForSnapshot.md b/content/reference/services/SoftLayer_Network_Storage/isDuplicateReadyForSnapshot.md index 8adcb130a9..1654e3bf26 100644 --- a/content/reference/services/SoftLayer_Network_Storage/isDuplicateReadyForSnapshot.md +++ b/content/reference/services/SoftLayer_Network_Storage/isDuplicateReadyForSnapshot.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::isDuplicateReadyForSnapshot + Displays the if clone snapshots can be ordered. diff --git a/content/reference/services/SoftLayer_Network_Storage/isDuplicateReadyToMount.md b/content/reference/services/SoftLayer_Network_Storage/isDuplicateReadyToMount.md index c262694bd2..9c99537704 100644 --- a/content/reference/services/SoftLayer_Network_Storage/isDuplicateReadyToMount.md +++ b/content/reference/services/SoftLayer_Network_Storage/isDuplicateReadyToMount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::isDuplicateReadyToMount + Displays the status of a clone mount. diff --git a/content/reference/services/SoftLayer_Network_Storage/isVolumeActive.md b/content/reference/services/SoftLayer_Network_Storage/isVolumeActive.md index 077cb62785..e550507f7e 100644 --- a/content/reference/services/SoftLayer_Network_Storage/isVolumeActive.md +++ b/content/reference/services/SoftLayer_Network_Storage/isVolumeActive.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/refreshDependentDuplicate.md b/content/reference/services/SoftLayer_Network_Storage/refreshDependentDuplicate.md index 8729988778..88a89213c8 100644 --- a/content/reference/services/SoftLayer_Network_Storage/refreshDependentDuplicate.md +++ b/content/reference/services/SoftLayer_Network_Storage/refreshDependentDuplicate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::refreshDependentDuplicate + Refreshes a duplicate volume with a snapshot taken from its parent. This is deprecated now. diff --git a/content/reference/services/SoftLayer_Network_Storage/refreshDuplicate.md b/content/reference/services/SoftLayer_Network_Storage/refreshDuplicate.md index f4626512a2..6e3e5ea438 100644 --- a/content/reference/services/SoftLayer_Network_Storage/refreshDuplicate.md +++ b/content/reference/services/SoftLayer_Network_Storage/refreshDuplicate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::refreshDuplicate + Refreshes any duplicate volume with a snapshot taken from its parent. diff --git a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromHardware.md b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromHardware.md index b038a7e9a8..5488491bbc 100644 --- a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::removeAccessFromHardware + Remove access to this volume from a specified SoftLayer_Hardware object. diff --git a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromHardwareList.md b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromHardwareList.md index ef7a516edd..06ce6633e5 100644 --- a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromHardwareList.md +++ b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromHardwareList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::removeAccessFromHardwareList + Remove access to this volume from multiple SoftLayer_Hardware objects. diff --git a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromHost.md b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromHost.md index 961ae50939..47108e3c92 100644 --- a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromHost.md +++ b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::removeAccessFromHost + Remove access to this volume from a specified [SoftLayer_Hardware]({{}}) object. diff --git a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromHostList.md b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromHostList.md index 52506369ef..141ed46727 100644 --- a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromHostList.md +++ b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromHostList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::removeAccessFromHostList + Remove access to this volume from multiple [SoftLayer_Hardware]({{}}) objects. diff --git a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromIpAddress.md b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromIpAddress.md index fb6564a1f4..2b806e3e3f 100644 --- a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::removeAccessFromIpAddress + Remove access to this volume from a specified SoftLayer_Network_Subnet_IpAddress object. diff --git a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromIpAddressList.md b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromIpAddressList.md index bbb47d4041..7e939341b3 100644 --- a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromIpAddressList.md +++ b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromIpAddressList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromSubnet.md b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromSubnet.md index 1b34de38f8..2d2e15c9d2 100644 --- a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromSubnet.md +++ b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromSubnet.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromSubnetList.md b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromSubnetList.md index 3492d0ac47..a1c3a69696 100644 --- a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromSubnetList.md +++ b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromSubnetList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromVirtualGuest.md b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromVirtualGuest.md index 0839fbf0d2..a1357871ce 100644 --- a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromVirtualGuest.md +++ b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::removeAccessFromVirtualGuest + Remove access to this volume from a specified SoftLayer_Virtual_Guest object. diff --git a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromVirtualGuestList.md b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromVirtualGuestList.md index 8be49607ae..7c931c21e1 100644 --- a/content/reference/services/SoftLayer_Network_Storage/removeAccessFromVirtualGuestList.md +++ b/content/reference/services/SoftLayer_Network_Storage/removeAccessFromVirtualGuestList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::removeAccessFromVirtualGuestList + Remove access to this volume from multiple SoftLayer_Virtual_Guest objects. diff --git a/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromHardwareList.md b/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromHardwareList.md index d10d6ee7a1..645b77df86 100644 --- a/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromHardwareList.md +++ b/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromHardwareList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::removeAccessToReplicantFromHardwareList + Remove access to this volume's replica from multiple SoftLayer_Hardware objects. diff --git a/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromIpAddressList.md b/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromIpAddressList.md index 5cbe4f74d8..282813cff9 100644 --- a/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromIpAddressList.md +++ b/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromIpAddressList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::removeAccessToReplicantFromIpAddressList + Remove access to this replica volume's replica from multiple SoftLayer_Network_Subnet_IpAddress objects. diff --git a/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromSubnet.md b/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromSubnet.md index 8fe6ab3acd..c924198fd7 100644 --- a/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromSubnet.md +++ b/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromSubnet.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromSubnetList.md b/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromSubnetList.md index c0cc2605db..a86ffa785c 100644 --- a/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromSubnetList.md +++ b/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromSubnetList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::removeAccessToReplicantFromSubnetList + Remove access to this volume's replica from multiple SoftLayer_Network_Subnet objects. diff --git a/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromVirtualGuestList.md b/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromVirtualGuestList.md index d23b3f1dbc..291fa2a43e 100644 --- a/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromVirtualGuestList.md +++ b/content/reference/services/SoftLayer_Network_Storage/removeAccessToReplicantFromVirtualGuestList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::removeAccessToReplicantFromVirtualGuestList + Remove access to this volume's replica from multiple SoftLayer_Virtual_Guest objects. diff --git a/content/reference/services/SoftLayer_Network_Storage/removeCredential.md b/content/reference/services/SoftLayer_Network_Storage/removeCredential.md index 15c8aedb01..3440cfb9ec 100644 --- a/content/reference/services/SoftLayer_Network_Storage/removeCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage/removeCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::removeCredential + This method will remove a credential from the current volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/restoreFile.md b/content/reference/services/SoftLayer_Network_Storage/restoreFile.md index 8ebbed6d07..24f05c0d36 100644 --- a/content/reference/services/SoftLayer_Network_Storage/restoreFile.md +++ b/content/reference/services/SoftLayer_Network_Storage/restoreFile.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::restoreFile + Restore access to an individual file in a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage/restoreFromSnapshot.md b/content/reference/services/SoftLayer_Network_Storage/restoreFromSnapshot.md index c9e544f8e3..7ed1a8a87e 100644 --- a/content/reference/services/SoftLayer_Network_Storage/restoreFromSnapshot.md +++ b/content/reference/services/SoftLayer_Network_Storage/restoreFromSnapshot.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::restoreFromSnapshot + Restore from a volume snapshot. diff --git a/content/reference/services/SoftLayer_Network_Storage/sendPasswordReminderEmail.md b/content/reference/services/SoftLayer_Network_Storage/sendPasswordReminderEmail.md index f48f3ab699..a41ad0bd39 100644 --- a/content/reference/services/SoftLayer_Network_Storage/sendPasswordReminderEmail.md +++ b/content/reference/services/SoftLayer_Network_Storage/sendPasswordReminderEmail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::sendPasswordReminderEmail + Email the password for the Storage account to the master user. diff --git a/content/reference/services/SoftLayer_Network_Storage/setMountable.md b/content/reference/services/SoftLayer_Network_Storage/setMountable.md index 95930106c5..40efc51c9b 100644 --- a/content/reference/services/SoftLayer_Network_Storage/setMountable.md +++ b/content/reference/services/SoftLayer_Network_Storage/setMountable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::setMountable + Enable or disable mounting of a Storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage/setSnapshotAllocation.md b/content/reference/services/SoftLayer_Network_Storage/setSnapshotAllocation.md index 0092056f81..8816119d6e 100644 --- a/content/reference/services/SoftLayer_Network_Storage/setSnapshotAllocation.md +++ b/content/reference/services/SoftLayer_Network_Storage/setSnapshotAllocation.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage/setSnapshotNotification.md b/content/reference/services/SoftLayer_Network_Storage/setSnapshotNotification.md index 82a31f2137..bf5eede9f9 100644 --- a/content/reference/services/SoftLayer_Network_Storage/setSnapshotNotification.md +++ b/content/reference/services/SoftLayer_Network_Storage/setSnapshotNotification.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::setSnapshotNotification + Function to enable/disable snapshot warning notification. diff --git a/content/reference/services/SoftLayer_Network_Storage/upgradeVolumeCapacity.md b/content/reference/services/SoftLayer_Network_Storage/upgradeVolumeCapacity.md index bcb4ff605e..156e91b973 100644 --- a/content/reference/services/SoftLayer_Network_Storage/upgradeVolumeCapacity.md +++ b/content/reference/services/SoftLayer_Network_Storage/upgradeVolumeCapacity.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::upgradeVolumeCapacity + Edit the Storage volume to a different package diff --git a/content/reference/services/SoftLayer_Network_Storage/uploadFile.md b/content/reference/services/SoftLayer_Network_Storage/uploadFile.md index 2cc94132da..c356acadd1 100644 --- a/content/reference/services/SoftLayer_Network_Storage/uploadFile.md +++ b/content/reference/services/SoftLayer_Network_Storage/uploadFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage](/reference/services/SoftLayer_Network_Storage)::uploadFile + Upload a file to a Storage account's root directory. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/_index.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/_index.md index d6d334c5ff..3eee673e5e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,84 +44,98 @@ classes: #### [assignSubnetsToAcl](/reference/services/SoftLayer_Network_Storage_Allowed_Host/assignSubnetsToAcl) +
              #### [editObject](/reference/services/SoftLayer_Network_Storage_Allowed_Host/editObject) +
              #### [getAllObjects](/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAllObjects) +
              #### [getAssignedGroups](/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedGroups) Retrieve the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. +
              #### [getAssignedIscsiVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedIscsiVolumes) Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. +
              #### [getAssignedNfsVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedNfsVolumes) Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. +
              #### [getAssignedReplicationVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedReplicationVolumes) Retrieve the SoftLayer_Network_Storage primary volumes whose replicas are allowed access. +
              #### [getAssignedVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedVolumes) Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. +
              #### [getCredential](/reference/services/SoftLayer_Network_Storage_Allowed_Host/getCredential) Retrieve the SoftLayer_Network_Storage_Credential this allowed host uses. +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_Allowed_Host/getObject) Retrieve a SoftLayer_Network_Storage_Allowed_Host record. +
              #### [getSourceSubnet](/reference/services/SoftLayer_Network_Storage_Allowed_Host/getSourceSubnet) Retrieve connections to a target with a source IP in this subnet prefix are allowed. +
              #### [getSubnetsInAcl](/reference/services/SoftLayer_Network_Storage_Allowed_Host/getSubnetsInAcl) Retrieve the SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. +
              #### [removeSubnetsFromAcl](/reference/services/SoftLayer_Network_Storage_Allowed_Host/removeSubnetsFromAcl) +
              #### [setCredentialPassword](/reference/services/SoftLayer_Network_Storage_Allowed_Host/setCredentialPassword) Modify the credential password for this SoftLayer_Network_Storage_Allowed_Host +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/assignSubnetsToAcl.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/assignSubnetsToAcl.md index b86723c336..fb62148df2 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/assignSubnetsToAcl.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/assignSubnetsToAcl.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/editObject.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/editObject.md index 8fbe16532d..0413401a8f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/editObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAllObjects.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAllObjects.md index 0cee93b4fa..d1053852db 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedGroups.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedGroups.md index 36c8dca70c..a6d6b1ef8c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedGroups.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host](/reference/services/SoftLayer_Network_Storage_Allowed_Host)::getAssignedGroups + Retrieve the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedIscsiVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedIscsiVolumes.md index 2be542306e..39295610f1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedIscsiVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedIscsiVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host](/reference/services/SoftLayer_Network_Storage_Allowed_Host)::getAssignedIscsiVolumes + Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedNfsVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedNfsVolumes.md index 39e8c96b52..00d196cd33 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedNfsVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedNfsVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host](/reference/services/SoftLayer_Network_Storage_Allowed_Host)::getAssignedNfsVolumes + Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedReplicationVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedReplicationVolumes.md index 43e2cec5fd..5592d1bea6 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedReplicationVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedReplicationVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host](/reference/services/SoftLayer_Network_Storage_Allowed_Host)::getAssignedReplicationVolumes + Retrieve the SoftLayer_Network_Storage primary volumes whose replicas are allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedVolumes.md index ad779ce07c..38a0997670 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getAssignedVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host](/reference/services/SoftLayer_Network_Storage_Allowed_Host)::getAssignedVolumes + Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getCredential.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getCredential.md index 9b8ff26096..29c384e44d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host](/reference/services/SoftLayer_Network_Storage_Allowed_Host)::getCredential + Retrieve the SoftLayer_Network_Storage_Credential this allowed host uses. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getObject.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getObject.md index 9c47808ae3..ea34dd6045 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host](/reference/services/SoftLayer_Network_Storage_Allowed_Host)::getObject + Retrieve a SoftLayer_Network_Storage_Allowed_Host record. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getSourceSubnet.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getSourceSubnet.md index 52fa0c466a..bf268df0e0 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getSourceSubnet.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getSourceSubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host](/reference/services/SoftLayer_Network_Storage_Allowed_Host)::getSourceSubnet + Retrieve connections to a target with a source IP in this subnet prefix are allowed. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getSubnetsInAcl.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getSubnetsInAcl.md index 4b05956b09..f0c9bec607 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getSubnetsInAcl.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/getSubnetsInAcl.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host](/reference/services/SoftLayer_Network_Storage_Allowed_Host)::getSubnetsInAcl + Retrieve the SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/removeSubnetsFromAcl.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/removeSubnetsFromAcl.md index f5cfd4e0f0..19ba9ac7e7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/removeSubnetsFromAcl.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/removeSubnetsFromAcl.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/setCredentialPassword.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/setCredentialPassword.md index b90908169d..0aee154a3e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/setCredentialPassword.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host/setCredentialPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host](/reference/services/SoftLayer_Network_Storage_Allowed_Host)::setCredentialPassword + Modify the credential password for this SoftLayer_Network_Storage_Allowed_Host diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/_index.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/_index.md index 85883381d8..546de7f140 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,96 +44,112 @@ classes: #### [assignSubnetsToAcl](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/assignSubnetsToAcl) +
              #### [editObject](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/editObject) +
              #### [getAccount](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAccount) Retrieve the SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to. +
              #### [getAllObjects](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAllObjects) +
              #### [getAssignedGroups](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedGroups) Retrieve the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. +
              #### [getAssignedIscsiVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedIscsiVolumes) Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. +
              #### [getAssignedNfsVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedNfsVolumes) Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. +
              #### [getAssignedReplicationVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedReplicationVolumes) Retrieve the SoftLayer_Network_Storage primary volumes whose replicas are allowed access. +
              #### [getAssignedVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedVolumes) Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. +
              #### [getCredential](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getCredential) Retrieve the SoftLayer_Network_Storage_Credential this allowed host uses. +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getObject) Retrieve a SoftLayer_Network_Storage_Allowed_Host_Hardware record. +
              #### [getResource](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getResource) Retrieve the SoftLayer_Hardware object which this SoftLayer_Network_Storage_Allowed_Host is referencing. +
              #### [getSourceSubnet](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getSourceSubnet) Retrieve connections to a target with a source IP in this subnet prefix are allowed. +
              #### [getSubnetsInAcl](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getSubnetsInAcl) Retrieve the SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. +
              #### [removeSubnetsFromAcl](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/removeSubnetsFromAcl) +
              #### [setCredentialPassword](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/setCredentialPassword) Modify the credential password for this SoftLayer_Network_Storage_Allowed_Host +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/assignSubnetsToAcl.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/assignSubnetsToAcl.md index 007ed521c9..43b90e7744 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/assignSubnetsToAcl.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/assignSubnetsToAcl.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/editObject.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/editObject.md index 659bbc5a50..f5fa92701d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/editObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAccount.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAccount.md index 5b2de3f5b6..b0c41e35fe 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Hardware](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware)::getAccount + Retrieve the SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAllObjects.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAllObjects.md index e6113e1196..e9466fc807 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedGroups.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedGroups.md index ca5f972120..101006ae7c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedGroups.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Hardware](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware)::getAssignedGroups + Retrieve the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedIscsiVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedIscsiVolumes.md index e777e50f1a..9d33732d29 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedIscsiVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedIscsiVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Hardware](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware)::getAssignedIscsiVolumes + Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedNfsVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedNfsVolumes.md index f6122bc0c3..e93f253136 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedNfsVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedNfsVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Hardware](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware)::getAssignedNfsVolumes + Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedReplicationVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedReplicationVolumes.md index 2aedb5fd00..6f4cae0e3a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedReplicationVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedReplicationVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Hardware](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware)::getAssignedReplicationVolumes + Retrieve the SoftLayer_Network_Storage primary volumes whose replicas are allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedVolumes.md index 5e85923d8b..7f98522299 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getAssignedVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Hardware](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware)::getAssignedVolumes + Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getCredential.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getCredential.md index 03939bf286..7323122d55 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Hardware](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware)::getCredential + Retrieve the SoftLayer_Network_Storage_Credential this allowed host uses. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getObject.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getObject.md index adee8c6b86..04246b21f4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Hardware](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware)::getObject + Retrieve a SoftLayer_Network_Storage_Allowed_Host_Hardware record. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getResource.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getResource.md index cf0e4c7fb5..ad88a70ff1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getResource.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getResource.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Hardware](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware)::getResource + Retrieve the SoftLayer_Hardware object which this SoftLayer_Network_Storage_Allowed_Host is referencing. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getSourceSubnet.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getSourceSubnet.md index 6d53e80eb8..d0741bbc54 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getSourceSubnet.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getSourceSubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Hardware](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware)::getSourceSubnet + Retrieve connections to a target with a source IP in this subnet prefix are allowed. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getSubnetsInAcl.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getSubnetsInAcl.md index bdce9f3e24..6938e1e61c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getSubnetsInAcl.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/getSubnetsInAcl.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Hardware](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware)::getSubnetsInAcl + Retrieve the SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/removeSubnetsFromAcl.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/removeSubnetsFromAcl.md index 5095f4c934..f3cc065c30 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/removeSubnetsFromAcl.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/removeSubnetsFromAcl.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/setCredentialPassword.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/setCredentialPassword.md index 7d72257db2..2f0d175505 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/setCredentialPassword.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware/setCredentialPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Hardware](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Hardware)::setCredentialPassword + Modify the credential password for this SoftLayer_Network_Storage_Allowed_Host diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/_index.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/_index.md index b920af068e..b4d9d58f33 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,96 +44,112 @@ classes: #### [assignSubnetsToAcl](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/assignSubnetsToAcl) +
              #### [editObject](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/editObject) +
              #### [getAccount](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAccount) Retrieve the SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to. +
              #### [getAllObjects](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAllObjects) +
              #### [getAssignedGroups](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedGroups) Retrieve the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. +
              #### [getAssignedIscsiVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedIscsiVolumes) Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. +
              #### [getAssignedNfsVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedNfsVolumes) Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. +
              #### [getAssignedReplicationVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedReplicationVolumes) Retrieve the SoftLayer_Network_Storage primary volumes whose replicas are allowed access. +
              #### [getAssignedVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedVolumes) Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. +
              #### [getCredential](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getCredential) Retrieve the SoftLayer_Network_Storage_Credential this allowed host uses. +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getObject) Retrieve a SoftLayer_Network_Storage_Allowed_Host_IpAddress record. +
              #### [getResource](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getResource) Retrieve the SoftLayer_Network_Subnet_IpAddress object which this SoftLayer_Network_Storage_Allowed_Host is referencing. +
              #### [getSourceSubnet](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getSourceSubnet) Retrieve connections to a target with a source IP in this subnet prefix are allowed. +
              #### [getSubnetsInAcl](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getSubnetsInAcl) Retrieve the SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. +
              #### [removeSubnetsFromAcl](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/removeSubnetsFromAcl) +
              #### [setCredentialPassword](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/setCredentialPassword) Modify the credential password for this SoftLayer_Network_Storage_Allowed_Host +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/assignSubnetsToAcl.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/assignSubnetsToAcl.md index 8a0beb5b9e..2fdbdc488d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/assignSubnetsToAcl.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/assignSubnetsToAcl.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/editObject.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/editObject.md index b3322defce..87e21878a2 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/editObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAccount.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAccount.md index 9f4e89f5d2..59a5dfb940 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_IpAddress](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress)::getAccount + Retrieve the SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAllObjects.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAllObjects.md index 3e49cfc1ff..0a104085df 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedGroups.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedGroups.md index 3898d56323..a9a42cb4ba 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedGroups.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_IpAddress](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress)::getAssignedGroups + Retrieve the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedIscsiVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedIscsiVolumes.md index ec13931a2b..633962e2ad 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedIscsiVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedIscsiVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_IpAddress](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress)::getAssignedIscsiVolumes + Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedNfsVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedNfsVolumes.md index 8f0d6b099d..ad845f411b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedNfsVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedNfsVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_IpAddress](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress)::getAssignedNfsVolumes + Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedReplicationVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedReplicationVolumes.md index 0be8f1a016..c515d99a77 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedReplicationVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedReplicationVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_IpAddress](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress)::getAssignedReplicationVolumes + Retrieve the SoftLayer_Network_Storage primary volumes whose replicas are allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedVolumes.md index b5448bead9..bf4c200805 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getAssignedVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_IpAddress](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress)::getAssignedVolumes + Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getCredential.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getCredential.md index 95c51a3796..580bca5b46 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_IpAddress](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress)::getCredential + Retrieve the SoftLayer_Network_Storage_Credential this allowed host uses. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getObject.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getObject.md index 9bf15a9ab8..930b39486f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_IpAddress](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress)::getObject + Retrieve a SoftLayer_Network_Storage_Allowed_Host_IpAddress record. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getResource.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getResource.md index e2b84ee7ab..dfa3fc0d72 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getResource.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getResource.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_IpAddress](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress)::getResource + Retrieve the SoftLayer_Network_Subnet_IpAddress object which this SoftLayer_Network_Storage_Allowed_Host is referencing. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getSourceSubnet.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getSourceSubnet.md index b246090348..882608b9f9 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getSourceSubnet.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getSourceSubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_IpAddress](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress)::getSourceSubnet + Retrieve connections to a target with a source IP in this subnet prefix are allowed. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getSubnetsInAcl.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getSubnetsInAcl.md index 0a071ae861..d3e9b765b8 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getSubnetsInAcl.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/getSubnetsInAcl.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_IpAddress](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress)::getSubnetsInAcl + Retrieve the SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/removeSubnetsFromAcl.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/removeSubnetsFromAcl.md index e75c1b6cfb..294a67af51 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/removeSubnetsFromAcl.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/removeSubnetsFromAcl.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/setCredentialPassword.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/setCredentialPassword.md index 86826a1c46..16bd20c9de 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/setCredentialPassword.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress/setCredentialPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_IpAddress](/reference/services/SoftLayer_Network_Storage_Allowed_Host_IpAddress)::setCredentialPassword + Modify the credential password for this SoftLayer_Network_Storage_Allowed_Host diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/_index.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/_index.md index 38e27f4913..f0cf45bbf3 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,96 +44,112 @@ classes: #### [assignSubnetsToAcl](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/assignSubnetsToAcl) +
              #### [editObject](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/editObject) +
              #### [getAccount](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAccount) Retrieve the SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to. +
              #### [getAllObjects](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAllObjects) +
              #### [getAssignedGroups](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedGroups) Retrieve the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. +
              #### [getAssignedIscsiVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedIscsiVolumes) Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. +
              #### [getAssignedNfsVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedNfsVolumes) Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. +
              #### [getAssignedReplicationVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedReplicationVolumes) Retrieve the SoftLayer_Network_Storage primary volumes whose replicas are allowed access. +
              #### [getAssignedVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedVolumes) Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. +
              #### [getCredential](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getCredential) Retrieve the SoftLayer_Network_Storage_Credential this allowed host uses. +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getObject) Retrieve a SoftLayer_Network_Storage_Allowed_Host_Subnet record. +
              #### [getResource](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getResource) Retrieve the SoftLayer_Network_Subnet object which this SoftLayer_Network_Storage_Allowed_Host is referencing. +
              #### [getSourceSubnet](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getSourceSubnet) Retrieve connections to a target with a source IP in this subnet prefix are allowed. +
              #### [getSubnetsInAcl](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getSubnetsInAcl) Retrieve the SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. +
              #### [removeSubnetsFromAcl](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/removeSubnetsFromAcl) +
              #### [setCredentialPassword](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/setCredentialPassword) Modify the credential password for this SoftLayer_Network_Storage_Allowed_Host +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/assignSubnetsToAcl.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/assignSubnetsToAcl.md index 6e5ad0bb4b..9cb664de44 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/assignSubnetsToAcl.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/assignSubnetsToAcl.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/editObject.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/editObject.md index d6e31d5f46..54367ed2f9 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/editObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAccount.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAccount.md index 24ac3bb010..472c4ba870 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Subnet](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet)::getAccount + Retrieve the SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAllObjects.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAllObjects.md index 143242174e..b5065ab451 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedGroups.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedGroups.md index 1ebf7dcde4..af661abfef 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedGroups.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Subnet](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet)::getAssignedGroups + Retrieve the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedIscsiVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedIscsiVolumes.md index f9ef108818..d695cbd130 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedIscsiVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedIscsiVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Subnet](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet)::getAssignedIscsiVolumes + Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedNfsVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedNfsVolumes.md index 1dfce9530f..48856fb0fe 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedNfsVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedNfsVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Subnet](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet)::getAssignedNfsVolumes + Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedReplicationVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedReplicationVolumes.md index a461a0d20c..c3002d3278 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedReplicationVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedReplicationVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Subnet](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet)::getAssignedReplicationVolumes + Retrieve the SoftLayer_Network_Storage primary volumes whose replicas are allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedVolumes.md index 97fdfb66e7..b5f752cd6e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getAssignedVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Subnet](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet)::getAssignedVolumes + Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getCredential.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getCredential.md index 15add8af71..ab2cd732cc 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Subnet](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet)::getCredential + Retrieve the SoftLayer_Network_Storage_Credential this allowed host uses. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getObject.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getObject.md index e95384d3e2..9b63796b54 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Subnet](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet)::getObject + Retrieve a SoftLayer_Network_Storage_Allowed_Host_Subnet record. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getResource.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getResource.md index 3d203ef4eb..e8ec28a1a1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getResource.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getResource.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Subnet](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet)::getResource + Retrieve the SoftLayer_Network_Subnet object which this SoftLayer_Network_Storage_Allowed_Host is referencing. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getSourceSubnet.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getSourceSubnet.md index d8d8f2e356..070c04defd 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getSourceSubnet.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getSourceSubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Subnet](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet)::getSourceSubnet + Retrieve connections to a target with a source IP in this subnet prefix are allowed. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getSubnetsInAcl.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getSubnetsInAcl.md index 4ac32d2f07..23fadcc9d8 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getSubnetsInAcl.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/getSubnetsInAcl.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Subnet](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet)::getSubnetsInAcl + Retrieve the SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/removeSubnetsFromAcl.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/removeSubnetsFromAcl.md index 86a74886bf..d7f8c81d62 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/removeSubnetsFromAcl.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/removeSubnetsFromAcl.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/setCredentialPassword.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/setCredentialPassword.md index 96b57150b8..7c73f08941 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/setCredentialPassword.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet/setCredentialPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_Subnet](/reference/services/SoftLayer_Network_Storage_Allowed_Host_Subnet)::setCredentialPassword + Modify the credential password for this SoftLayer_Network_Storage_Allowed_Host diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/_index.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/_index.md index 2a010f8694..65b34dc4dc 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,96 +44,112 @@ classes: #### [assignSubnetsToAcl](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/assignSubnetsToAcl) +
              #### [editObject](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/editObject) +
              #### [getAccount](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAccount) Retrieve the SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to. +
              #### [getAllObjects](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAllObjects) +
              #### [getAssignedGroups](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedGroups) Retrieve the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. +
              #### [getAssignedIscsiVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedIscsiVolumes) Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. +
              #### [getAssignedNfsVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedNfsVolumes) Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. +
              #### [getAssignedReplicationVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedReplicationVolumes) Retrieve the SoftLayer_Network_Storage primary volumes whose replicas are allowed access. +
              #### [getAssignedVolumes](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedVolumes) Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. +
              #### [getCredential](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getCredential) Retrieve the SoftLayer_Network_Storage_Credential this allowed host uses. +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getObject) Retrieve a SoftLayer_Network_Storage_Allowed_Host_VirtualGuest record. +
              #### [getResource](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getResource) Retrieve the SoftLayer_Virtual_Guest object which this SoftLayer_Network_Storage_Allowed_Host is referencing. +
              #### [getSourceSubnet](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getSourceSubnet) Retrieve connections to a target with a source IP in this subnet prefix are allowed. +
              #### [getSubnetsInAcl](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getSubnetsInAcl) Retrieve the SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. +
              #### [removeSubnetsFromAcl](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/removeSubnetsFromAcl) +
              #### [setCredentialPassword](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/setCredentialPassword) Modify the credential password for this SoftLayer_Network_Storage_Allowed_Host +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/assignSubnetsToAcl.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/assignSubnetsToAcl.md index 7b2594e3e4..9509b42fb4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/assignSubnetsToAcl.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/assignSubnetsToAcl.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/editObject.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/editObject.md index b0eb24a510..d754122a30 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/editObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAccount.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAccount.md index c61c8b0516..421c45cb3d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_VirtualGuest](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest)::getAccount + Retrieve the SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAllObjects.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAllObjects.md index f0bc04d549..db979be2e8 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedGroups.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedGroups.md index 023d1c4e05..377acdcc12 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedGroups.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_VirtualGuest](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest)::getAssignedGroups + Retrieve the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedIscsiVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedIscsiVolumes.md index 3cf5da2206..32bbc7d8d3 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedIscsiVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedIscsiVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_VirtualGuest](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest)::getAssignedIscsiVolumes + Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedNfsVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedNfsVolumes.md index 8448d21fc8..d29207d9b9 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedNfsVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedNfsVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_VirtualGuest](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest)::getAssignedNfsVolumes + Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedReplicationVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedReplicationVolumes.md index 1a0878775f..c660dd440d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedReplicationVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedReplicationVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_VirtualGuest](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest)::getAssignedReplicationVolumes + Retrieve the SoftLayer_Network_Storage primary volumes whose replicas are allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedVolumes.md index c4035bec2d..3dd1c628bd 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getAssignedVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_VirtualGuest](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest)::getAssignedVolumes + Retrieve the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getCredential.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getCredential.md index 7cb0648b0f..ac6b2a7070 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_VirtualGuest](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest)::getCredential + Retrieve the SoftLayer_Network_Storage_Credential this allowed host uses. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getObject.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getObject.md index b9153d481c..ff820a504a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_VirtualGuest](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest)::getObject + Retrieve a SoftLayer_Network_Storage_Allowed_Host_VirtualGuest record. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getResource.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getResource.md index 8bf41e0f20..a6b361d34a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getResource.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getResource.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_VirtualGuest](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest)::getResource + Retrieve the SoftLayer_Virtual_Guest object which this SoftLayer_Network_Storage_Allowed_Host is referencing. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getSourceSubnet.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getSourceSubnet.md index 2664b087ac..5b2a369628 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getSourceSubnet.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getSourceSubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_VirtualGuest](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest)::getSourceSubnet + Retrieve connections to a target with a source IP in this subnet prefix are allowed. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getSubnetsInAcl.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getSubnetsInAcl.md index f81bc0aa20..3fa58034f4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getSubnetsInAcl.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/getSubnetsInAcl.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_VirtualGuest](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest)::getSubnetsInAcl + Retrieve the SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/removeSubnetsFromAcl.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/removeSubnetsFromAcl.md index 81c763d90e..5d7898984b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/removeSubnetsFromAcl.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/removeSubnetsFromAcl.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/setCredentialPassword.md b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/setCredentialPassword.md index 64803f8b07..0ea88a2ccc 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/setCredentialPassword.md +++ b/content/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest/setCredentialPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Allowed_Host_VirtualGuest](/reference/services/SoftLayer_Network_Storage_Allowed_Host_VirtualGuest)::setCredentialPassword + Modify the credential password for this SoftLayer_Network_Storage_Allowed_Host diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/_index.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/_index.md index 5d7c04d829..111082a722 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. ### External Links @@ -53,1188 +55,1400 @@ SoftLayer provides the EVault backup system as a part of it's Storage service of #### [allowAccessFromHardware](/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHardware) Allow access to this volume from a specified SoftLayer_Hardware object. +
              #### [allowAccessFromHardwareList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHardwareList) +
              #### [allowAccessFromHost](/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHost) Allow access to this volume from a specified [SoftLayer_Hardware]({{}}) object. +
              #### [allowAccessFromHostList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHostList) Allow access to this volume from multiple [SoftLayer_Hardware]({{}}) objects. +
              #### [allowAccessFromIpAddress](/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromIpAddress) Allow access to this volume from a specified SoftLayer_Network_Subnet_IpAddress object. +
              #### [allowAccessFromIpAddressList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromIpAddressList) +
              #### [allowAccessFromSubnet](/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromSubnet) Allow access to this volume from multiple SoftLayer_Network_Subnet objects. +
              #### [allowAccessFromSubnetList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromSubnetList) +
              #### [allowAccessFromVirtualGuest](/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromVirtualGuest) Allow access to this volume from a specified SoftLayer_Virtual_Guest object. +
              #### [allowAccessFromVirtualGuestList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromVirtualGuestList) Allow access to this volume from multiple SoftLayer_Virtual_Guest objects. +
              #### [allowAccessToReplicantFromHardware](/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromHardware) Allow access to this replicant volume from a specified SoftLayer_Hardware object. +
              #### [allowAccessToReplicantFromHardwareList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromHardwareList) allow access to this volume's replica from multiple SoftLayer_Hardware objects. +
              #### [allowAccessToReplicantFromIpAddress](/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromIpAddress) +
              #### [allowAccessToReplicantFromIpAddressList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromIpAddressList) allow access to this volume's replica from multiple SoftLayer_Network_Subnet_IpAddress objects. +
              #### [allowAccessToReplicantFromSubnet](/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromSubnet) Allow access to this replicant volume from multiple SoftLayer_Network_Subnet objects. +
              #### [allowAccessToReplicantFromSubnetList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromSubnetList) allow access to this volume's replica from multiple SoftLayer_Network_Subnet objects. +
              #### [allowAccessToReplicantFromVirtualGuest](/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromVirtualGuest) Allow access to this replicant volume from a specified SoftLayer_Virtual_Guest object. +
              #### [allowAccessToReplicantFromVirtualGuestList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromVirtualGuestList) allow access to this volume's replica from multiple SoftLayer_Virtual_Guest objects. +
              #### [assignCredential](/reference/services/SoftLayer_Network_Storage_Backup_Evault/assignCredential) This method will assign an existing credential to the current volume. +
              #### [assignNewCredential](/reference/services/SoftLayer_Network_Storage_Backup_Evault/assignNewCredential) This method will set up a new credential for the remote storage volume. +
              #### [changePassword](/reference/services/SoftLayer_Network_Storage_Backup_Evault/changePassword) Change the password for a Storage/Virtual Server Storage account +
              #### [collectBandwidth](/reference/services/SoftLayer_Network_Storage_Backup_Evault/collectBandwidth) Retrieve the bandwidth usage for the current billing cycle. +
              #### [collectBytesUsed](/reference/services/SoftLayer_Network_Storage_Backup_Evault/collectBytesUsed) Retrieve the number of bytes capacity currently in use on a Storage account. +
              #### [convertCloneDependentToIndependent](/reference/services/SoftLayer_Network_Storage_Backup_Evault/convertCloneDependentToIndependent) Splits a clone from its parent allowing it to be an independent volume. +
              #### [createFolder](/reference/services/SoftLayer_Network_Storage_Backup_Evault/createFolder) Create a new folder in the root directory. +
              #### [createOrUpdateLunId](/reference/services/SoftLayer_Network_Storage_Backup_Evault/createOrUpdateLunId) Creates or updates the LUN ID property on a volume. +
              #### [createSnapshot](/reference/services/SoftLayer_Network_Storage_Backup_Evault/createSnapshot) Manually create a new snapshot of a storage volume. +
              #### [deleteAllFiles](/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteAllFiles) Delete all files within a Storage account. +
              #### [deleteFile](/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteFile) Delete an individual file within a Storage account. +
              #### [deleteFiles](/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteFiles) Delete multiple files within a Storage account. +
              #### [deleteFolder](/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteFolder) Delete a folder in the root directory. +
              #### [deleteObject](/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteObject) Delete a network storage volume +
              #### [deleteTasks](/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteTasks) Delete task(s) +
              #### [disableSnapshots](/reference/services/SoftLayer_Network_Storage_Backup_Evault/disableSnapshots) Disable snapshots of this Storage Volume on a schedule. +
              #### [disasterRecoveryFailoverToReplicant](/reference/services/SoftLayer_Network_Storage_Backup_Evault/disasterRecoveryFailoverToReplicant) Failover an inaccessible block/file volume to its available replicant volume. +
              #### [downloadFile](/reference/services/SoftLayer_Network_Storage_Backup_Evault/downloadFile) Download a file from a Storage account. +
              #### [editCredential](/reference/services/SoftLayer_Network_Storage_Backup_Evault/editCredential) This method will change the password of a credential created using the 'addNewCredential' method. +
              #### [editObject](/reference/services/SoftLayer_Network_Storage_Backup_Evault/editObject) Edit the password and/or notes for the Storage service +
              #### [enableSnapshots](/reference/services/SoftLayer_Network_Storage_Backup_Evault/enableSnapshots) Enable snapshots of this Storage Volume on a schedule. +
              #### [failbackFromReplicant](/reference/services/SoftLayer_Network_Storage_Backup_Evault/failbackFromReplicant) Failback from a volume replicant. +
              #### [failoverToReplicant](/reference/services/SoftLayer_Network_Storage_Backup_Evault/failoverToReplicant) Failover to a volume replicant. +
              #### [getAccount](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAccount) Retrieve the account that a Storage services belongs to. +
              #### [getAccountPassword](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAccountPassword) Retrieve other usernames and passwords associated with a Storage volume. +
              #### [getActiveTransactions](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getActiveTransactions) Retrieve the currently active transactions on a network storage volume. +
              #### [getAllFiles](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllFiles) Retrieve a listing of all files in a Storage account's root directory. +
              #### [getAllFilesByFilter](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllFilesByFilter) Retrieve a listing of all files matching the filter's criteria in a Storage account's root directory. + +
              + +
              + +#### [getAllowDisasterRecoveryFailback](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowDisasterRecoveryFailback) + +
              #### [getAllowDisasterRecoveryFailover](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowDisasterRecoveryFailover) +
              #### [getAllowableHardware](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableHardware) Return a list of SoftLayer_Hardware that can be authorized to this volume. +
              #### [getAllowableIpAddresses](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableIpAddresses) Return a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this volume. +
              #### [getAllowableSubnets](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableSubnets) Return a list of SoftLayer_Network_Subnet that can be authorized to this volume. +
              #### [getAllowableVirtualGuests](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableVirtualGuests) Return a list of SoftLayer_Virtual_Guest that can be authorized to this volume. +
              #### [getAllowedHardware](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedHardware) Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume. +
              #### [getAllowedHostsLimit](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedHostsLimit) Retrieves the total number of allowed hosts limit per volume. +
              #### [getAllowedIpAddresses](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedIpAddresses) Retrieve the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. +
              #### [getAllowedReplicationHardware](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationHardware) Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. +
              #### [getAllowedReplicationIpAddresses](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationIpAddresses) Retrieve the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. +
              #### [getAllowedReplicationSubnets](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationSubnets) Retrieve the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. +
              #### [getAllowedReplicationVirtualGuests](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationVirtualGuests) Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. +
              #### [getAllowedSubnets](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedSubnets) Retrieve the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. +
              #### [getAllowedVirtualGuests](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedVirtualGuests) Retrieve the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. +
              #### [getBillingItem](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getBillingItem) Retrieve the current billing item for the Storage volume. +
              #### [getBillingItemCategory](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getBillingItemCategory) +
              #### [getByUsername](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getByUsername) Retrieve network storage accounts by username. +
              #### [getBytesUsed](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getBytesUsed) Retrieve the amount of space used by the volume, in bytes. +
              #### [getCdnUrls](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCdnUrls) +
              #### [getClusterResource](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getClusterResource) +
              #### [getCreationScheduleId](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCreationScheduleId) Retrieve the schedule id which was executed to create a snapshot. +
              #### [getCredentials](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCredentials) +
              #### [getCurrentCyclePeakUsage](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCurrentCyclePeakUsage) Retrieve peak number of bytes used in the vault for the current billing cycle. +
              #### [getDailySchedule](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDailySchedule) Retrieve the Daily Schedule which is associated with this network storage volume. +
              #### [getDependentDuplicate](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDependentDuplicate) Retrieve whether or not a network storage volume is a dependent duplicate. +
              #### [getDependentDuplicates](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDependentDuplicates) Retrieve the network storage volumes configured to be dependent duplicates of a volume. +
              #### [getEvents](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getEvents) Retrieve the events which have taken place on a network storage volume. +
              #### [getFailbackNotAllowed](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFailbackNotAllowed) Retrieve determines whether the volume is allowed to failback + +
              + +
              + +#### [getFailoverNotAllowed](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFailoverNotAllowed) +Retrieve determines whether the volume is allowed to failover +
              #### [getFileBlockEncryptedLocations](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileBlockEncryptedLocations) Returns a list of SoftLayer_Location_Datacenter objects corresponding to Datacenters in which File and Block Storage Volumes with Encryption at Rest may be ordered. +
              #### [getFileByIdentifier](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileByIdentifier) Retrieve an individual file's details. +
              #### [getFileCount](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileCount) Retrieve the file number of files in a Virtual Server Storage account's root directory. +
              #### [getFileList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileList) Retrieve list of files in a given folder for this account. +
              #### [getFileNetworkMountAddress](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileNetworkMountAddress) Retrieve retrieves the NFS Network Mount Address Name for a given File Storage Volume. +
              #### [getFilePendingDeleteCount](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFilePendingDeleteCount) Retrieve the number of files pending deletion in a Storage account's recycle bin. +
              #### [getFilesPendingDelete](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFilesPendingDelete) Retrieve a list of files in a Storage account's recycle bin. +
              #### [getFolderList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFolderList) Retrieve a list of level 1 folders for this account. +
              #### [getGraph](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getGraph) Retrieve a graph representing the bandwidth used by a Storage account. +
              #### [getHardware](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHardware) Retrieve when applicable, the hardware associated with a Storage service. +
              #### [getHardwareWithEvaultFirst](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHardwareWithEvaultFirst) Retrieve all the hardware for the account listing the hardware with EVault Storage service first. The output will be paginated having 25 items on each page. +
              #### [getHasEncryptionAtRest](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHasEncryptionAtRest) +
              #### [getHourlySchedule](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHourlySchedule) Retrieve the Hourly Schedule which is associated with this network storage volume. +
              #### [getIntervalSchedule](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIntervalSchedule) Retrieve the Interval Schedule which is associated with this network storage volume. +
              #### [getIops](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIops) Retrieve the maximum number of IOPs selected for this volume. +
              #### [getIsDependentDuplicateProvisionCompleted](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsDependentDuplicateProvisionCompleted) Retrieve determines whether dependent volume provision is completed on background. +
              #### [getIsInDedicatedServiceResource](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsInDedicatedServiceResource) +
              #### [getIsMagneticStorage](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsMagneticStorage) +
              #### [getIsReadyForSnapshot](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsReadyForSnapshot) Retrieve determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. +
              #### [getIsReadyToMount](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsReadyToMount) Retrieve determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. +
              #### [getIscsiLuns](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIscsiLuns) Retrieve relationship between a container volume and iSCSI LUNs. +
              #### [getIscsiTargetIpAddresses](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIscsiTargetIpAddresses) Retrieve returns the target IP addresses of an iSCSI volume. +
              #### [getLunId](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getLunId) Retrieve the ID of the LUN volume. +
              #### [getManualSnapshots](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getManualSnapshots) Retrieve the manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. +
              #### [getMaximumExpansionSize](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMaximumExpansionSize) Returns the maximum volume expansion size in GB. +
              #### [getMetricTrackingObject](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMetricTrackingObject) Retrieve a network storage volume's metric tracking object. This object records all periodic polled data available to this volume. +
              #### [getMountPath](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMountPath) Retrieve retrieves the NFS Network Mount Path for a given File Storage Volume. +
              #### [getMountableFlag](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMountableFlag) Retrieve whether or not a network storage volume may be mounted. +
              #### [getMoveAndSplitStatus](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMoveAndSplitStatus) Retrieve the current status of split or move operation as a part of volume duplication. +
              #### [getNetworkConnectionDetails](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNetworkConnectionDetails) Retrieve network connection details for complex network storage volumes. +
              #### [getNetworkMountAddress](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNetworkMountAddress) Displays the mount path of a storage volume. +
              #### [getNetworkMountPath](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNetworkMountPath) Displays the mount path of a storage volume. +
              #### [getNotificationSubscribers](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNotificationSubscribers) Retrieve the subscribers that will be notified for usage amount warnings and overages. +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getObject) Retrieve a SoftLayer_Network_Storage_Backup_Evault record. +
              #### [getObjectStorageConnectionInformation](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getObjectStorageConnectionInformation) Retrieve all object storage details for connection +
              #### [getObjectsByCredential](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getObjectsByCredential) Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object. +
              #### [getOriginalSnapshotName](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalSnapshotName) Retrieve the name of the snapshot that this volume was duplicated from. +
              #### [getOriginalVolumeName](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalVolumeName) Retrieve the name of the volume that this volume was duplicated from. +
              #### [getOriginalVolumeSize](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalVolumeSize) Retrieve the size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. +
              #### [getOsType](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOsType) Retrieve a volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. +
              #### [getOsTypeId](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOsTypeId) Retrieve a volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. +
              #### [getParentPartnerships](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getParentPartnerships) Retrieve the volumes or snapshots partnered with a network storage volume in a parental role. +
              #### [getParentVolume](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getParentVolume) Retrieve the parent volume of a volume in a complex storage relationship. +
              #### [getPartnerships](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getPartnerships) Retrieve the volumes or snapshots partnered with a network storage volume. +
              #### [getPermissionsGroups](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getPermissionsGroups) Retrieve all permissions group(s) this volume is in. +
              #### [getPreviousCyclePeakUsage](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getPreviousCyclePeakUsage) Retrieve peak number of bytes used in the vault for the previous billing cycle. +
              #### [getProperties](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getProperties) Retrieve the properties used to provide additional details about a network storage volume. +
              #### [getProvisionedIops](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getProvisionedIops) Retrieve the number of IOPs provisioned for this volume. +
              #### [getRecycleBinFileByIdentifier](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getRecycleBinFileByIdentifier) Retrieve all files that are in the recycle bin (pending delete). This method is only used for Virtual Server Storage accounts at moment but may expanded to other Storage types in the future. +
              #### [getRemainingAllowedHosts](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getRemainingAllowedHosts) Retrieves the remaining number of allowed hosts per volume. +
              #### [getRemainingAllowedHostsForReplicant](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getRemainingAllowedHostsForReplicant) Retrieves the remaining number of allowed hosts for a volume's replicant. +
              #### [getReplicatingLuns](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicatingLuns) Retrieve the iSCSI LUN volumes being replicated by this network storage volume. +
              #### [getReplicatingVolume](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicatingVolume) Retrieve the network storage volume being replicated by a volume. +
              #### [getReplicationEvents](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationEvents) Retrieve the volume replication events. +
              #### [getReplicationPartners](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationPartners) Retrieve the network storage volumes configured to be replicants of a volume. +
              #### [getReplicationSchedule](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationSchedule) Retrieve the Replication Schedule associated with a network storage volume. +
              #### [getReplicationStatus](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationStatus) Retrieve the current replication status of a network storage volume. Indicates Failover or Failback status. +
              #### [getReplicationTimestamp](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationTimestamp) An API call to fetch the last timestamp of the replication process +
              #### [getSchedules](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSchedules) Retrieve the schedules which are associated with a network storage volume. +
              #### [getServiceResource](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getServiceResource) Retrieve the network resource a Storage service is connected to. +
              #### [getServiceResourceBackendIpAddress](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getServiceResourceBackendIpAddress) Retrieve the IP address of a Storage resource. +
              #### [getServiceResourceName](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getServiceResourceName) Retrieve the name of a Storage's network resource. +
              #### [getSnapshotCapacityGb](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotCapacityGb) Retrieve a volume's configured snapshot space size. +
              #### [getSnapshotCreationTimestamp](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotCreationTimestamp) Retrieve the creation timestamp of the snapshot on the storage platform. +
              #### [getSnapshotDeletionThresholdPercentage](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotDeletionThresholdPercentage) Retrieve the percentage of used snapshot space after which to delete automated snapshots. +
              #### [getSnapshotNotificationStatus](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotNotificationStatus) Retrieve whether or not a network storage volume may be mounted. +
              #### [getSnapshotSizeBytes](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotSizeBytes) Retrieve the snapshot size in bytes. +
              #### [getSnapshotSpaceAvailable](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotSpaceAvailable) Retrieve a volume's available snapshot reservation space. +
              #### [getSnapshots](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshots) Retrieve the snapshots associated with this SoftLayer_Network_Storage volume. +
              #### [getSnapshotsForVolume](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotsForVolume) Retrieves a list oƒf snapshots for a given volume. +
              #### [getStaasVersion](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStaasVersion) +
              #### [getStorageGroups](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageGroups) Retrieve the network storage groups this volume is attached to. +
              #### [getStorageGroupsNetworkConnectionDetails](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageGroupsNetworkConnectionDetails) +
              #### [getStorageTierLevel](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageTierLevel) +
              #### [getStorageType](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageType) Retrieve a description of the Storage object. +
              #### [getTargetIpAddresses](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getTargetIpAddresses) +
              #### [getTotalBytesUsed](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getTotalBytesUsed) Retrieve the amount of space used by the volume. +
              #### [getTotalScheduleSnapshotRetentionCount](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getTotalScheduleSnapshotRetentionCount) Retrieve the total snapshot retention count of all schedules on this network storage volume. +
              #### [getUsageNotification](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getUsageNotification) Retrieve the usage notification for SL Storage services. +
              #### [getValidReplicationTargetDatacenterLocations](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getValidReplicationTargetDatacenterLocations) +
              #### [getVendorName](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVendorName) Retrieve the type of network storage service. +
              #### [getVirtualGuest](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVirtualGuest) Retrieve when applicable, the virtual guest associated with a Storage service. +
              #### [getVolumeCountLimits](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeCountLimits) Retrieves an array of volume count limits per location and globally. +
              #### [getVolumeDuplicateParameters](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeDuplicateParameters) +
              #### [getVolumeHistory](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeHistory) Retrieve the username and password history for a Storage service. +
              #### [getVolumeStatus](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeStatus) Retrieve the current status of a network storage volume. +
              #### [getWebCCAuthenticationDetails](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getWebCCAuthenticationDetails) Retrieve WebCC authentication details value. This value is required for the login process associated to the session information for WebCC. +
              #### [getWebccAccount](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getWebccAccount) Retrieve the account username and password for the EVault webCC interface. +
              #### [getWeeklySchedule](/reference/services/SoftLayer_Network_Storage_Backup_Evault/getWeeklySchedule) Retrieve the Weekly Schedule which is associated with this network storage volume. +
              #### [immediateFailoverToReplicant](/reference/services/SoftLayer_Network_Storage_Backup_Evault/immediateFailoverToReplicant) Immediate Failover to a volume replicant. +
              #### [initiateBareMetalRestore](/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateBareMetalRestore) Initiate a bare metal restore for the server tied to the EVault account +
              #### [initiateBareMetalRestoreForServer](/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateBareMetalRestoreForServer) Initiate a bare metal restore for the specified server +
              #### [initiateOriginVolumeReclaim](/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateOriginVolumeReclaim) Initiates Origin Volume Reclaim to delete volume from NetApp. +
              #### [initiateVolumeCutover](/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateVolumeCutover) Initiates Volume Cutover to remove access from the old volume. +
              #### [isBlockingOperationInProgress](/reference/services/SoftLayer_Network_Storage_Backup_Evault/isBlockingOperationInProgress) +
              #### [isDuplicateReadyForSnapshot](/reference/services/SoftLayer_Network_Storage_Backup_Evault/isDuplicateReadyForSnapshot) Displays the if clone snapshots can be ordered. +
              #### [isDuplicateReadyToMount](/reference/services/SoftLayer_Network_Storage_Backup_Evault/isDuplicateReadyToMount) Displays the status of a clone mount. +
              #### [isVolumeActive](/reference/services/SoftLayer_Network_Storage_Backup_Evault/isVolumeActive) +
              #### [refreshDependentDuplicate](/reference/services/SoftLayer_Network_Storage_Backup_Evault/refreshDependentDuplicate) Refreshes a duplicate volume with a snapshot taken from its parent. This is deprecated now. +
              #### [refreshDuplicate](/reference/services/SoftLayer_Network_Storage_Backup_Evault/refreshDuplicate) Refreshes any duplicate volume with a snapshot taken from its parent. +
              #### [removeAccessFromHardware](/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHardware) Remove access to this volume from a specified SoftLayer_Hardware object. +
              #### [removeAccessFromHardwareList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHardwareList) Remove access to this volume from multiple SoftLayer_Hardware objects. +
              #### [removeAccessFromHost](/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHost) Remove access to this volume from a specified [SoftLayer_Hardware]({{}}) object. +
              #### [removeAccessFromHostList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHostList) Remove access to this volume from multiple [SoftLayer_Hardware]({{}}) objects. +
              #### [removeAccessFromIpAddress](/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromIpAddress) Remove access to this volume from a specified SoftLayer_Network_Subnet_IpAddress object. +
              #### [removeAccessFromIpAddressList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromIpAddressList) +
              #### [removeAccessFromSubnet](/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromSubnet) +
              #### [removeAccessFromSubnetList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromSubnetList) +
              #### [removeAccessFromVirtualGuest](/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromVirtualGuest) Remove access to this volume from a specified SoftLayer_Virtual_Guest object. +
              #### [removeAccessFromVirtualGuestList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromVirtualGuestList) Remove access to this volume from multiple SoftLayer_Virtual_Guest objects. +
              #### [removeAccessToReplicantFromHardwareList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromHardwareList) Remove access to this volume's replica from multiple SoftLayer_Hardware objects. +
              #### [removeAccessToReplicantFromIpAddressList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromIpAddressList) Remove access to this replica volume's replica from multiple SoftLayer_Network_Subnet_IpAddress objects. +
              #### [removeAccessToReplicantFromSubnet](/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromSubnet) +
              #### [removeAccessToReplicantFromSubnetList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromSubnetList) Remove access to this volume's replica from multiple SoftLayer_Network_Subnet objects. +
              #### [removeAccessToReplicantFromVirtualGuestList](/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromVirtualGuestList) Remove access to this volume's replica from multiple SoftLayer_Virtual_Guest objects. +
              #### [removeCredential](/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeCredential) This method will remove a credential from the current volume. +
              #### [restoreFile](/reference/services/SoftLayer_Network_Storage_Backup_Evault/restoreFile) Restore access to an individual file in a Storage account. +
              #### [restoreFromSnapshot](/reference/services/SoftLayer_Network_Storage_Backup_Evault/restoreFromSnapshot) Restore from a volume snapshot. +
              #### [sendPasswordReminderEmail](/reference/services/SoftLayer_Network_Storage_Backup_Evault/sendPasswordReminderEmail) Email the password for the Storage account to the master user. +
              #### [setMountable](/reference/services/SoftLayer_Network_Storage_Backup_Evault/setMountable) Enable or disable mounting of a Storage volume. +
              #### [setSnapshotAllocation](/reference/services/SoftLayer_Network_Storage_Backup_Evault/setSnapshotAllocation) +
              #### [setSnapshotNotification](/reference/services/SoftLayer_Network_Storage_Backup_Evault/setSnapshotNotification) Function to enable/disable snapshot warning notification. +
              #### [upgradeVolumeCapacity](/reference/services/SoftLayer_Network_Storage_Backup_Evault/upgradeVolumeCapacity) Edit the Storage volume to a different package +
              #### [uploadFile](/reference/services/SoftLayer_Network_Storage_Backup_Evault/uploadFile) Upload a file to a Storage account's root directory. +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHardware.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHardware.md index 107fa004c3..6054116589 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::allowAccessFromHardware + Allow access to this volume from a specified SoftLayer_Hardware object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHardwareList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHardwareList.md index fff4ddfc38..a5c65a271c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHardwareList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHardwareList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHost.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHost.md index d85e14e228..5d1b6c5ffa 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHost.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::allowAccessFromHost + Allow access to this volume from a specified [SoftLayer_Hardware]({{}}) object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHostList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHostList.md index 0662fd0b98..77ce679df3 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHostList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromHostList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::allowAccessFromHostList + Allow access to this volume from multiple [SoftLayer_Hardware]({{}}) objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromIpAddress.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromIpAddress.md index 1d4b0c2479..b45febe619 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::allowAccessFromIpAddress + Allow access to this volume from a specified SoftLayer_Network_Subnet_IpAddress object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromIpAddressList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromIpAddressList.md index 8e1de8cd73..9139503715 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromIpAddressList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromIpAddressList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromSubnet.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromSubnet.md index 9fa3ecae71..9c9e5f791c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromSubnet.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromSubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::allowAccessFromSubnet + Allow access to this volume from multiple SoftLayer_Network_Subnet objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromSubnetList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromSubnetList.md index 2f75fcfa93..117c59107c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromSubnetList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromSubnetList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromVirtualGuest.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromVirtualGuest.md index ee456b9726..bd618db6b3 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromVirtualGuest.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::allowAccessFromVirtualGuest + Allow access to this volume from a specified SoftLayer_Virtual_Guest object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromVirtualGuestList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromVirtualGuestList.md index c3469ad654..ecd35185bf 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromVirtualGuestList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessFromVirtualGuestList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::allowAccessFromVirtualGuestList + Allow access to this volume from multiple SoftLayer_Virtual_Guest objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromHardware.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromHardware.md index b4d79f9379..4666f6efa6 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::allowAccessToReplicantFromHardware + Allow access to this replicant volume from a specified SoftLayer_Hardware object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromHardwareList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromHardwareList.md index 8d044f7a69..0c37d07f8b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromHardwareList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromHardwareList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::allowAccessToReplicantFromHardwareList + allow access to this volume's replica from multiple SoftLayer_Hardware objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromIpAddress.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromIpAddress.md index 30ac174f4a..f684ad03dc 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromIpAddress.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromIpAddressList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromIpAddressList.md index d92dc8444a..2ebc8e02a0 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromIpAddressList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromIpAddressList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::allowAccessToReplicantFromIpAddressList + allow access to this volume's replica from multiple SoftLayer_Network_Subnet_IpAddress objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromSubnet.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromSubnet.md index 0c4dbccc64..fdfecacf8d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromSubnet.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromSubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::allowAccessToReplicantFromSubnet + Allow access to this replicant volume from multiple SoftLayer_Network_Subnet objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromSubnetList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromSubnetList.md index 1a53bdbf19..1b50f3b7ef 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromSubnetList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromSubnetList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::allowAccessToReplicantFromSubnetList + allow access to this volume's replica from multiple SoftLayer_Network_Subnet objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromVirtualGuest.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromVirtualGuest.md index b4478b3251..25429fafc6 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromVirtualGuest.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::allowAccessToReplicantFromVirtualGuest + Allow access to this replicant volume from a specified SoftLayer_Virtual_Guest object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromVirtualGuestList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromVirtualGuestList.md index c1dcef173a..3ad59d16c9 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromVirtualGuestList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/allowAccessToReplicantFromVirtualGuestList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::allowAccessToReplicantFromVirtualGuestList + allow access to this volume's replica from multiple SoftLayer_Virtual_Guest objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/assignCredential.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/assignCredential.md index 8d601891ba..6ddac8696a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/assignCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/assignCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::assignCredential + This method will assign an existing credential to the current volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/assignNewCredential.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/assignNewCredential.md index 39d3b277c9..358021297c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/assignNewCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/assignNewCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::assignNewCredential + This method will set up a new credential for the remote storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/changePassword.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/changePassword.md index fbad54b034..b0e6fc92e6 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/changePassword.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/changePassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::changePassword + Change the password for a Storage/Virtual Server Storage account diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/collectBandwidth.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/collectBandwidth.md index dad41d73aa..834f4bd5b3 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/collectBandwidth.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/collectBandwidth.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::collectBandwidth + Retrieve the bandwidth usage for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/collectBytesUsed.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/collectBytesUsed.md index 3ed1def195..c6929637b2 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/collectBytesUsed.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/collectBytesUsed.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::collectBytesUsed + Retrieve the number of bytes capacity currently in use on a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/convertCloneDependentToIndependent.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/convertCloneDependentToIndependent.md index 35a882852f..a24e7d721d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/convertCloneDependentToIndependent.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/convertCloneDependentToIndependent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::convertCloneDependentToIndependent + Splits a clone from its parent allowing it to be an independent volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/createFolder.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/createFolder.md index 78c1c5e2a0..079d7d2a7c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/createFolder.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/createFolder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::createFolder + Create a new folder in the root directory. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/createOrUpdateLunId.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/createOrUpdateLunId.md index 4d0e38ce6a..a49898802f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/createOrUpdateLunId.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/createOrUpdateLunId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::createOrUpdateLunId + Creates or updates the LUN ID property on a volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/createSnapshot.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/createSnapshot.md index 53f5dd2789..1954158e7e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/createSnapshot.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/createSnapshot.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::createSnapshot + Manually create a new snapshot of a storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteAllFiles.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteAllFiles.md index 5b021fc2e1..f8a9320ab5 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteAllFiles.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteAllFiles.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::deleteAllFiles + Delete all files within a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteFile.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteFile.md index 7c47a7f680..5eb5ca3a96 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteFile.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::deleteFile + Delete an individual file within a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteFiles.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteFiles.md index ca2e702712..aa93e0d27f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteFiles.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteFiles.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::deleteFiles + Delete multiple files within a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteFolder.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteFolder.md index 10b43e7c33..e7dc8d3b4a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteFolder.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteFolder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::deleteFolder + Delete a folder in the root directory. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteObject.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteObject.md index 2a3c67d7db..0b8845f924 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::deleteObject + Delete a network storage volume diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteTasks.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteTasks.md index 54686e9a49..5e5bff396b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteTasks.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/deleteTasks.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::deleteTasks + Delete task(s) diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/disableSnapshots.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/disableSnapshots.md index aa3add144c..35190329d6 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/disableSnapshots.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/disableSnapshots.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::disableSnapshots + Disable snapshots of this Storage Volume on a schedule. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/disasterRecoveryFailoverToReplicant.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/disasterRecoveryFailoverToReplicant.md index 009f526789..f61efb7074 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/disasterRecoveryFailoverToReplicant.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/disasterRecoveryFailoverToReplicant.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::disasterRecoveryFailoverToReplicant + Failover an inaccessible block/file volume to its available replicant volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/downloadFile.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/downloadFile.md index 96935fa726..ebd4ada37e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/downloadFile.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/downloadFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::downloadFile + Download a file from a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/editCredential.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/editCredential.md index bdae99a848..21b475c59e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/editCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/editCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::editCredential + This method will change the password of a credential created using the 'addNewCredential' method. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/editObject.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/editObject.md index d92d5aa014..18d46515ba 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/editObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::editObject + Edit the password and/or notes for the Storage service diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/enableSnapshots.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/enableSnapshots.md index bfd756b8e0..2827e25bfe 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/enableSnapshots.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/enableSnapshots.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::enableSnapshots + Enable snapshots of this Storage Volume on a schedule. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/failbackFromReplicant.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/failbackFromReplicant.md index 39429b537a..70f8eab666 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/failbackFromReplicant.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/failbackFromReplicant.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::failbackFromReplicant + Failback from a volume replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/failoverToReplicant.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/failoverToReplicant.md index 1c340eb64a..896f411640 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/failoverToReplicant.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/failoverToReplicant.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::failoverToReplicant + Failover to a volume replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAccount.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAccount.md index 9aa612728c..43b5077731 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getAccount + Retrieve the account that a Storage services belongs to. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAccountPassword.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAccountPassword.md index e4a30082c6..b8075b2167 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAccountPassword.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAccountPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getAccountPassword + Retrieve other usernames and passwords associated with a Storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getActiveTransactions.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getActiveTransactions.md index e404819f69..8ba2b61489 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getActiveTransactions.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getActiveTransactions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getActiveTransactions + Retrieve the currently active transactions on a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllFiles.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllFiles.md index e10cdd1d1f..422f0b6545 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllFiles.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllFiles.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getAllFiles + Retrieve a listing of all files in a Storage account's root directory. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllFilesByFilter.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllFilesByFilter.md index 6eea9bece4..ac3e266fc7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllFilesByFilter.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllFilesByFilter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getAllFilesByFilter + Retrieve a listing of all files matching the filter's criteria in a Storage account's root directory. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowDisasterRecoveryFailback.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowDisasterRecoveryFailback.md new file mode 100644 index 0000000000..4c843aea59 --- /dev/null +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowDisasterRecoveryFailback.md @@ -0,0 +1,45 @@ +--- +title: "getAllowDisasterRecoveryFailback" +description: "" +layout: "method" +tags: + - "method" + - "sldn" + - "Network" +classes: + - "SoftLayer_Network_Storage_Backup_Evault" +aliases: + - "/reference/services/softlayer_network_storage_backup_evault/getAllowDisasterRecoveryFailback" +--- +# [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getAllowDisasterRecoveryFailback + + + + + +## Overview + + +----- + +### Parameters +|Name | Type | Description | +| --- | --- | --- | + + +### Required Headers +* SoftLayer_Network_Storage_Backup_EvaultInitParameters +* authenticate + + +### Optional Headers +* SoftLayer_Network_Storage_Backup_EvaultObjectMask +* SoftLayer_Network_Storage_Backup_EvaultObjectFilter +* SoftLayer_ObjectMask + +### Return Values +* string + + + + diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowDisasterRecoveryFailover.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowDisasterRecoveryFailover.md index c588dfdf55..df04ceb3e1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowDisasterRecoveryFailover.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowDisasterRecoveryFailover.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableHardware.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableHardware.md index bf927b31b2..e7166ba58b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getAllowableHardware + Return a list of SoftLayer_Hardware that can be authorized to this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableIpAddresses.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableIpAddresses.md index 5cfad1ab59..07a856cbd5 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getAllowableIpAddresses + Return a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableSubnets.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableSubnets.md index a53805b7d2..558646e6c3 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableSubnets.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getAllowableSubnets + Return a list of SoftLayer_Network_Subnet that can be authorized to this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableVirtualGuests.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableVirtualGuests.md index ec791c7457..a74a4c78eb 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableVirtualGuests.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowableVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getAllowableVirtualGuests + Return a list of SoftLayer_Virtual_Guest that can be authorized to this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedHardware.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedHardware.md index ef9a7da5de..03a751fe79 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getAllowedHardware + Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedHostsLimit.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedHostsLimit.md index 5efa3d3710..721c8c136f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedHostsLimit.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedHostsLimit.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getAllowedHostsLimit + Retrieves the total number of allowed hosts limit per volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedIpAddresses.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedIpAddresses.md index 62e2a85168..741b60f72f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getAllowedIpAddresses + Retrieve the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationHardware.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationHardware.md index 94c7558308..da130b9e8f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getAllowedReplicationHardware + Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationIpAddresses.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationIpAddresses.md index adbac76f3a..1a74b3108e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getAllowedReplicationIpAddresses + Retrieve the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationSubnets.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationSubnets.md index f6542d3ebe..7ce5db629b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationSubnets.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getAllowedReplicationSubnets + Retrieve the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationVirtualGuests.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationVirtualGuests.md index 82fa1f1641..89d9be9b68 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationVirtualGuests.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedReplicationVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getAllowedReplicationVirtualGuests + Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedSubnets.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedSubnets.md index e3ee3e8b6b..0a3e1406d2 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedSubnets.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getAllowedSubnets + Retrieve the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedVirtualGuests.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedVirtualGuests.md index cd9439f882..3fc48aeac9 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedVirtualGuests.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getAllowedVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getAllowedVirtualGuests + Retrieve the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getBillingItem.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getBillingItem.md index 12fda3af0e..ec6a559e83 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getBillingItem + Retrieve the current billing item for the Storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getBillingItemCategory.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getBillingItemCategory.md index 8b5eda77f3..9fcdc73c07 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getBillingItemCategory.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getBillingItemCategory.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getByUsername.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getByUsername.md index 435c7dc769..8dd18e381b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getByUsername.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getByUsername.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getByUsername + Retrieve network storage accounts by username. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getBytesUsed.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getBytesUsed.md index 18fcff1097..9665147942 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getBytesUsed.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getBytesUsed.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getBytesUsed + Retrieve the amount of space used by the volume, in bytes. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCdnUrls.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCdnUrls.md index ab94b0872b..655f0a4427 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCdnUrls.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCdnUrls.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getClusterResource.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getClusterResource.md index 20ccd17bfc..d66bfcc0a7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getClusterResource.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getClusterResource.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCreationScheduleId.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCreationScheduleId.md index 7b3a6f2dce..683d01f284 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCreationScheduleId.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCreationScheduleId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getCreationScheduleId + Retrieve the schedule id which was executed to create a snapshot. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCredentials.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCredentials.md index a3d132de93..a92e21e586 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCredentials.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCredentials.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCurrentCyclePeakUsage.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCurrentCyclePeakUsage.md index 6a85b95a08..1aede4a425 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCurrentCyclePeakUsage.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCurrentCyclePeakUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getCurrentCyclePeakUsage + Retrieve peak number of bytes used in the vault for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDailySchedule.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDailySchedule.md index f25b218ca8..657c04eaee 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDailySchedule.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDailySchedule.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getDailySchedule + Retrieve the Daily Schedule which is associated with this network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDependentDuplicate.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDependentDuplicate.md index 2ec039d7c6..0f662316b7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDependentDuplicate.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDependentDuplicate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getDependentDuplicate + Retrieve whether or not a network storage volume is a dependent duplicate. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDependentDuplicates.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDependentDuplicates.md index e23e1f6de7..13845d5f44 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDependentDuplicates.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getDependentDuplicates.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getDependentDuplicates + Retrieve the network storage volumes configured to be dependent duplicates of a volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getEvents.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getEvents.md index 32675e123a..0212b8091d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getEvents.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getEvents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getEvents + Retrieve the events which have taken place on a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFailbackNotAllowed.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFailbackNotAllowed.md index b17fe82ec8..50c7d867f7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFailbackNotAllowed.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFailbackNotAllowed.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getFailbackNotAllowed + Retrieve determines whether the volume is allowed to failback diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFailoverNotAllowed.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFailoverNotAllowed.md new file mode 100644 index 0000000000..451d8d19fd --- /dev/null +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFailoverNotAllowed.md @@ -0,0 +1,45 @@ +--- +title: "getFailoverNotAllowed" +description: "Retrieve determines whether the volume is allowed to failover" +layout: "method" +tags: + - "method" + - "sldn" + - "Network" +classes: + - "SoftLayer_Network_Storage_Backup_Evault" +aliases: + - "/reference/services/softlayer_network_storage_backup_evault/getFailoverNotAllowed" +--- +# [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getFailoverNotAllowed + + +Retrieve determines whether the volume is allowed to failover + + +## Overview +Retrieve determines whether the volume is allowed to failover + +----- + +### Parameters +|Name | Type | Description | +| --- | --- | --- | + + +### Required Headers +* SoftLayer_Network_Storage_Backup_EvaultInitParameters +* authenticate + + +### Optional Headers +* SoftLayer_Network_Storage_Backup_EvaultObjectMask +* SoftLayer_Network_Storage_Backup_EvaultObjectFilter +* SoftLayer_ObjectMask + +### Return Values +* string + + + + diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileBlockEncryptedLocations.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileBlockEncryptedLocations.md index 59ee5b1391..de4a7216c7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileBlockEncryptedLocations.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileBlockEncryptedLocations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getFileBlockEncryptedLocations + Returns a list of SoftLayer_Location_Datacenter objects corresponding to Datacenters in which File and Block Storage Volumes with Encryption at Rest may be ordered. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileByIdentifier.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileByIdentifier.md index baa33d397e..b6f79da3af 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileByIdentifier.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileByIdentifier.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getFileByIdentifier + Retrieve an individual file's details. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileCount.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileCount.md index 51ee425a68..9c43a2d9b6 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileCount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getFileCount + Retrieve the file number of files in a Virtual Server Storage account's root directory. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileList.md index 660ec79633..3564bc124f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getFileList + Retrieve list of files in a given folder for this account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileNetworkMountAddress.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileNetworkMountAddress.md index e023719079..4cbe5290f7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileNetworkMountAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFileNetworkMountAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getFileNetworkMountAddress + Retrieve retrieves the NFS Network Mount Address Name for a given File Storage Volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFilePendingDeleteCount.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFilePendingDeleteCount.md index b74ae4f904..75acd56721 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFilePendingDeleteCount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFilePendingDeleteCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getFilePendingDeleteCount + Retrieve the number of files pending deletion in a Storage account's recycle bin. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFilesPendingDelete.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFilesPendingDelete.md index d835966802..d523bdfcae 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFilesPendingDelete.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFilesPendingDelete.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getFilesPendingDelete + Retrieve a list of files in a Storage account's recycle bin. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFolderList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFolderList.md index 0d31c26744..1f926b8c89 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFolderList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getFolderList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getFolderList + Retrieve a list of level 1 folders for this account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getGraph.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getGraph.md index 8d5aecc58b..af3c622379 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getGraph.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getGraph.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getGraph + Retrieve a graph representing the bandwidth used by a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHardware.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHardware.md index 6ff398f951..d48dfa16c0 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getHardware + Retrieve when applicable, the hardware associated with a Storage service. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHardwareWithEvaultFirst.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHardwareWithEvaultFirst.md index 77dde2673a..bcf274bb5e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHardwareWithEvaultFirst.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHardwareWithEvaultFirst.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getHardwareWithEvaultFirst + Retrieve all the hardware for the account listing the hardware with EVault Storage service first. The output will be paginated having 25 items on each page. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHasEncryptionAtRest.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHasEncryptionAtRest.md index b9709688b9..1f9cf86090 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHasEncryptionAtRest.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHasEncryptionAtRest.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHourlySchedule.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHourlySchedule.md index 36006965e0..a4288d54a0 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHourlySchedule.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getHourlySchedule.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getHourlySchedule + Retrieve the Hourly Schedule which is associated with this network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIntervalSchedule.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIntervalSchedule.md index 99837b5841..547fcd8b9e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIntervalSchedule.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIntervalSchedule.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getIntervalSchedule + Retrieve the Interval Schedule which is associated with this network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIops.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIops.md index 914c297200..f91f512764 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIops.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIops.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getIops + Retrieve the maximum number of IOPs selected for this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsDependentDuplicateProvisionCompleted.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsDependentDuplicateProvisionCompleted.md index 69aec479df..73ea92ecc1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsDependentDuplicateProvisionCompleted.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsDependentDuplicateProvisionCompleted.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getIsDependentDuplicateProvisionCompleted + Retrieve determines whether dependent volume provision is completed on background. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsInDedicatedServiceResource.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsInDedicatedServiceResource.md index 5c6815486f..c57867d55b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsInDedicatedServiceResource.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsInDedicatedServiceResource.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsMagneticStorage.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsMagneticStorage.md index 5ab2dd61e0..e9d881369e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsMagneticStorage.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsMagneticStorage.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsReadyForSnapshot.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsReadyForSnapshot.md index 40b96bf37c..8c44d52249 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsReadyForSnapshot.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsReadyForSnapshot.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getIsReadyForSnapshot + Retrieve determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsReadyToMount.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsReadyToMount.md index 796be5c707..a72e64dc62 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsReadyToMount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIsReadyToMount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getIsReadyToMount + Retrieve determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIscsiLuns.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIscsiLuns.md index a21a22d4ac..f2e4499912 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIscsiLuns.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIscsiLuns.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getIscsiLuns + Retrieve relationship between a container volume and iSCSI LUNs. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIscsiTargetIpAddresses.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIscsiTargetIpAddresses.md index b1f878fbdf..98098b8975 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIscsiTargetIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getIscsiTargetIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getIscsiTargetIpAddresses + Retrieve returns the target IP addresses of an iSCSI volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getLunId.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getLunId.md index f7478911c5..8367e341b6 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getLunId.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getLunId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getLunId + Retrieve the ID of the LUN volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getManualSnapshots.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getManualSnapshots.md index a44144cbb3..c5ec98086b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getManualSnapshots.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getManualSnapshots.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getManualSnapshots + Retrieve the manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMaximumExpansionSize.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMaximumExpansionSize.md index b5a4fbb84c..42f5788d79 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMaximumExpansionSize.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMaximumExpansionSize.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getMaximumExpansionSize + Returns the maximum volume expansion size in GB. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMetricTrackingObject.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMetricTrackingObject.md index e4e41faa06..05fa8fbd87 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMetricTrackingObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMetricTrackingObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getMetricTrackingObject + Retrieve a network storage volume's metric tracking object. This object records all periodic polled data available to this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMountPath.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMountPath.md index 22638ee794..f505047ec1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMountPath.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMountPath.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getMountPath + Retrieve retrieves the NFS Network Mount Path for a given File Storage Volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMountableFlag.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMountableFlag.md index 1e15fe0068..95e13305dc 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMountableFlag.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMountableFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getMountableFlag + Retrieve whether or not a network storage volume may be mounted. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMoveAndSplitStatus.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMoveAndSplitStatus.md index 8eb105b619..707cb2adbe 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMoveAndSplitStatus.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getMoveAndSplitStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getMoveAndSplitStatus + Retrieve the current status of split or move operation as a part of volume duplication. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNetworkConnectionDetails.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNetworkConnectionDetails.md index 00ddb6070c..221b0f283f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNetworkConnectionDetails.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNetworkConnectionDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getNetworkConnectionDetails + Retrieve network connection details for complex network storage volumes. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNetworkMountAddress.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNetworkMountAddress.md index 41f512d2d7..97767691d3 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNetworkMountAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNetworkMountAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getNetworkMountAddress + Displays the mount path of a storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNetworkMountPath.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNetworkMountPath.md index 0718ae9649..a9b2ddedeb 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNetworkMountPath.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNetworkMountPath.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getNetworkMountPath + Displays the mount path of a storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNotificationSubscribers.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNotificationSubscribers.md index 37f8b25325..8172ec93b9 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNotificationSubscribers.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getNotificationSubscribers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getNotificationSubscribers + Retrieve the subscribers that will be notified for usage amount warnings and overages. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getObject.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getObject.md index d8dba18a05..e2ed0b0f97 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getObject + Retrieve a SoftLayer_Network_Storage_Backup_Evault record. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getObjectStorageConnectionInformation.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getObjectStorageConnectionInformation.md index 50f5913e55..80b1f637c9 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getObjectStorageConnectionInformation.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getObjectStorageConnectionInformation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getObjectStorageConnectionInformation + Retrieve all object storage details for connection diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getObjectsByCredential.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getObjectsByCredential.md index 4596e34b87..b32b1f67b2 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getObjectsByCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getObjectsByCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getObjectsByCredential + Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalSnapshotName.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalSnapshotName.md index 15f1ed045e..4e698ccd21 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalSnapshotName.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalSnapshotName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getOriginalSnapshotName + Retrieve the name of the snapshot that this volume was duplicated from. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalVolumeName.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalVolumeName.md index 6ed9201a44..708304ae50 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalVolumeName.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalVolumeName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getOriginalVolumeName + Retrieve the name of the volume that this volume was duplicated from. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalVolumeSize.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalVolumeSize.md index 00f60701e0..0c2f7988f2 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalVolumeSize.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOriginalVolumeSize.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getOriginalVolumeSize + Retrieve the size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOsType.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOsType.md index 127662252c..45c8b1be48 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOsType.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOsType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getOsType + Retrieve a volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOsTypeId.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOsTypeId.md index 66b1425579..7b5888d3d3 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOsTypeId.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getOsTypeId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getOsTypeId + Retrieve a volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getParentPartnerships.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getParentPartnerships.md index 7130aea017..96fb4a6d48 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getParentPartnerships.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getParentPartnerships.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getParentPartnerships + Retrieve the volumes or snapshots partnered with a network storage volume in a parental role. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getParentVolume.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getParentVolume.md index 6d88e382dc..abceed8ea9 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getParentVolume.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getParentVolume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getParentVolume + Retrieve the parent volume of a volume in a complex storage relationship. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getPartnerships.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getPartnerships.md index 1b5e0446d4..a4f8aa3223 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getPartnerships.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getPartnerships.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getPartnerships + Retrieve the volumes or snapshots partnered with a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getPermissionsGroups.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getPermissionsGroups.md index 8053ff026c..05bdf46387 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getPermissionsGroups.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getPermissionsGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getPermissionsGroups + Retrieve all permissions group(s) this volume is in. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getPreviousCyclePeakUsage.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getPreviousCyclePeakUsage.md index 90f1b9ab7a..704dd6acd0 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getPreviousCyclePeakUsage.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getPreviousCyclePeakUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getPreviousCyclePeakUsage + Retrieve peak number of bytes used in the vault for the previous billing cycle. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getProperties.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getProperties.md index 1f96c2122b..8efe5eb3ff 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getProperties.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getProperties.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getProperties + Retrieve the properties used to provide additional details about a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getProvisionedIops.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getProvisionedIops.md index b39ba4a176..7537e00236 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getProvisionedIops.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getProvisionedIops.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getProvisionedIops + Retrieve the number of IOPs provisioned for this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getRecycleBinFileByIdentifier.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getRecycleBinFileByIdentifier.md index 294ad734eb..acba4ba046 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getRecycleBinFileByIdentifier.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getRecycleBinFileByIdentifier.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getRecycleBinFileByIdentifier + Retrieve all files that are in the recycle bin (pending delete). This method is only used for Virtual Server Storage accounts at moment but may expanded to other Storage types in the future. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getRemainingAllowedHosts.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getRemainingAllowedHosts.md index 681e1a5fcf..0b2bb91104 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getRemainingAllowedHosts.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getRemainingAllowedHosts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getRemainingAllowedHosts + Retrieves the remaining number of allowed hosts per volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getRemainingAllowedHostsForReplicant.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getRemainingAllowedHostsForReplicant.md index 92c4ed19fb..8cfd97846b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getRemainingAllowedHostsForReplicant.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getRemainingAllowedHostsForReplicant.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getRemainingAllowedHostsForReplicant + Retrieves the remaining number of allowed hosts for a volume's replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicatingLuns.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicatingLuns.md index a447e4bad4..40d8f39b13 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicatingLuns.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicatingLuns.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getReplicatingLuns + Retrieve the iSCSI LUN volumes being replicated by this network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicatingVolume.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicatingVolume.md index d8a08f6859..fc952470ce 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicatingVolume.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicatingVolume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getReplicatingVolume + Retrieve the network storage volume being replicated by a volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationEvents.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationEvents.md index 4d41b2ddd4..3fc3c9c788 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationEvents.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationEvents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getReplicationEvents + Retrieve the volume replication events. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationPartners.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationPartners.md index 5db04af7c8..530041857e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationPartners.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationPartners.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getReplicationPartners + Retrieve the network storage volumes configured to be replicants of a volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationSchedule.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationSchedule.md index d4dc580303..49ff87e628 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationSchedule.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationSchedule.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getReplicationSchedule + Retrieve the Replication Schedule associated with a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationStatus.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationStatus.md index fa4cad4832..18f9124438 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationStatus.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getReplicationStatus + Retrieve the current replication status of a network storage volume. Indicates Failover or Failback status. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationTimestamp.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationTimestamp.md index a9b298f772..76ffff257b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationTimestamp.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getReplicationTimestamp.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getReplicationTimestamp + An API call to fetch the last timestamp of the replication process diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSchedules.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSchedules.md index ac84988899..64f4bcfdc4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSchedules.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSchedules.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getSchedules + Retrieve the schedules which are associated with a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getServiceResource.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getServiceResource.md index 542268f373..4b3b3bed44 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getServiceResource.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getServiceResource.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getServiceResource + Retrieve the network resource a Storage service is connected to. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getServiceResourceBackendIpAddress.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getServiceResourceBackendIpAddress.md index 4bf57a7b2f..57ec704979 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getServiceResourceBackendIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getServiceResourceBackendIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getServiceResourceBackendIpAddress + Retrieve the IP address of a Storage resource. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getServiceResourceName.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getServiceResourceName.md index bb589fcbe1..ed814a7435 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getServiceResourceName.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getServiceResourceName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getServiceResourceName + Retrieve the name of a Storage's network resource. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotCapacityGb.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotCapacityGb.md index 0093417277..e6112676e7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotCapacityGb.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotCapacityGb.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getSnapshotCapacityGb + Retrieve a volume's configured snapshot space size. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotCreationTimestamp.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotCreationTimestamp.md index fc63f1d4d2..0a182ee425 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotCreationTimestamp.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotCreationTimestamp.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getSnapshotCreationTimestamp + Retrieve the creation timestamp of the snapshot on the storage platform. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotDeletionThresholdPercentage.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotDeletionThresholdPercentage.md index c0af96c701..855ddf8cac 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotDeletionThresholdPercentage.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotDeletionThresholdPercentage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getSnapshotDeletionThresholdPercentage + Retrieve the percentage of used snapshot space after which to delete automated snapshots. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotNotificationStatus.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotNotificationStatus.md index b23da8121c..983e218bf3 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotNotificationStatus.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotNotificationStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getSnapshotNotificationStatus + Retrieve whether or not a network storage volume may be mounted. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotSizeBytes.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotSizeBytes.md index 357ea82d87..1184457bb7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotSizeBytes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotSizeBytes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getSnapshotSizeBytes + Retrieve the snapshot size in bytes. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotSpaceAvailable.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotSpaceAvailable.md index ef3ce257aa..b2aeb0428c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotSpaceAvailable.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotSpaceAvailable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getSnapshotSpaceAvailable + Retrieve a volume's available snapshot reservation space. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshots.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshots.md index 1626a04e7f..3ff31c06be 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshots.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshots.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getSnapshots + Retrieve the snapshots associated with this SoftLayer_Network_Storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotsForVolume.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotsForVolume.md index 1cff01c591..19489d30e5 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotsForVolume.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getSnapshotsForVolume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getSnapshotsForVolume + Retrieves a list oƒf snapshots for a given volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStaasVersion.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStaasVersion.md index 51701b6e6b..e0a23183cb 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStaasVersion.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStaasVersion.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageGroups.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageGroups.md index da90acbdd8..d6c9d8cf53 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageGroups.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getStorageGroups + Retrieve the network storage groups this volume is attached to. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageGroupsNetworkConnectionDetails.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageGroupsNetworkConnectionDetails.md index c9fcea279e..bfe4978218 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageGroupsNetworkConnectionDetails.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageGroupsNetworkConnectionDetails.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageTierLevel.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageTierLevel.md index d7f5f4fc0e..007203c103 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageTierLevel.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageTierLevel.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageType.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageType.md index 5ab796b97f..c11045b939 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageType.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getStorageType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getStorageType + Retrieve a description of the Storage object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getTargetIpAddresses.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getTargetIpAddresses.md index 1aab4b7318..51e988aa58 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getTargetIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getTargetIpAddresses.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getTotalBytesUsed.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getTotalBytesUsed.md index 9dcaf64926..cb4a5cefa4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getTotalBytesUsed.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getTotalBytesUsed.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getTotalBytesUsed + Retrieve the amount of space used by the volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getTotalScheduleSnapshotRetentionCount.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getTotalScheduleSnapshotRetentionCount.md index e612ba4443..d23a8d70ad 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getTotalScheduleSnapshotRetentionCount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getTotalScheduleSnapshotRetentionCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getTotalScheduleSnapshotRetentionCount + Retrieve the total snapshot retention count of all schedules on this network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getUsageNotification.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getUsageNotification.md index 84b16ac149..1e42ffdf13 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getUsageNotification.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getUsageNotification.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getUsageNotification + Retrieve the usage notification for SL Storage services. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getValidReplicationTargetDatacenterLocations.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getValidReplicationTargetDatacenterLocations.md index f22b1db4c2..7717d36e85 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getValidReplicationTargetDatacenterLocations.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getValidReplicationTargetDatacenterLocations.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVendorName.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVendorName.md index 223f23e7f1..9a6cfacb40 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVendorName.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVendorName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getVendorName + Retrieve the type of network storage service. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVirtualGuest.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVirtualGuest.md index 27054c4b33..0166234106 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVirtualGuest.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getVirtualGuest + Retrieve when applicable, the virtual guest associated with a Storage service. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeCountLimits.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeCountLimits.md index 3dfd55b311..16de628ef4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeCountLimits.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeCountLimits.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getVolumeCountLimits + Retrieves an array of volume count limits per location and globally. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeDuplicateParameters.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeDuplicateParameters.md index c83649a919..0623cd3a56 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeDuplicateParameters.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeDuplicateParameters.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method returns the parameters for cloning a volume diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeHistory.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeHistory.md index ca511bada9..a523b315b2 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeHistory.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getVolumeHistory + Retrieve the username and password history for a Storage service. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeStatus.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeStatus.md index bf78c377e3..29ba45a199 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeStatus.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getVolumeStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getVolumeStatus + Retrieve the current status of a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getWebCCAuthenticationDetails.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getWebCCAuthenticationDetails.md index 4c7a8fe7d5..42f5fda33e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getWebCCAuthenticationDetails.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getWebCCAuthenticationDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getWebCCAuthenticationDetails + Retrieve WebCC authentication details value. This value is required for the login process associated to the session information for WebCC. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getWebccAccount.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getWebccAccount.md index 1da872114c..8588ca6554 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getWebccAccount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getWebccAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getWebccAccount + Retrieve the account username and password for the EVault webCC interface. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getWeeklySchedule.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getWeeklySchedule.md index e837dda45b..5b59b82805 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getWeeklySchedule.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/getWeeklySchedule.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::getWeeklySchedule + Retrieve the Weekly Schedule which is associated with this network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/immediateFailoverToReplicant.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/immediateFailoverToReplicant.md index 227012a9f5..342c7a575c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/immediateFailoverToReplicant.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/immediateFailoverToReplicant.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::immediateFailoverToReplicant + Immediate Failover to a volume replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateBareMetalRestore.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateBareMetalRestore.md index 09621dd519..bbff32140c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateBareMetalRestore.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateBareMetalRestore.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::initiateBareMetalRestore + Initiate a bare metal restore for the server tied to the EVault account diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateBareMetalRestoreForServer.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateBareMetalRestoreForServer.md index 104bfc1bff..7f420b9f68 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateBareMetalRestoreForServer.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateBareMetalRestoreForServer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::initiateBareMetalRestoreForServer + Initiate a bare metal restore for the specified server diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateOriginVolumeReclaim.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateOriginVolumeReclaim.md index d67d77724d..d9cbfa4b4d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateOriginVolumeReclaim.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateOriginVolumeReclaim.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::initiateOriginVolumeReclaim + Initiates Origin Volume Reclaim to delete volume from NetApp. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateVolumeCutover.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateVolumeCutover.md index 8b720bc0ec..64e41618f4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateVolumeCutover.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/initiateVolumeCutover.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::initiateVolumeCutover + Initiates Volume Cutover to remove access from the old volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/isBlockingOperationInProgress.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/isBlockingOperationInProgress.md index 9858167e93..6d084bca88 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/isBlockingOperationInProgress.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/isBlockingOperationInProgress.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/isDuplicateReadyForSnapshot.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/isDuplicateReadyForSnapshot.md index d5140140a1..1cad1800e0 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/isDuplicateReadyForSnapshot.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/isDuplicateReadyForSnapshot.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::isDuplicateReadyForSnapshot + Displays the if clone snapshots can be ordered. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/isDuplicateReadyToMount.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/isDuplicateReadyToMount.md index ec511b5cde..57678f249c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/isDuplicateReadyToMount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/isDuplicateReadyToMount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::isDuplicateReadyToMount + Displays the status of a clone mount. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/isVolumeActive.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/isVolumeActive.md index 4b4881457f..6e6220dec7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/isVolumeActive.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/isVolumeActive.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/refreshDependentDuplicate.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/refreshDependentDuplicate.md index 3a7d9b9091..38f602c38b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/refreshDependentDuplicate.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/refreshDependentDuplicate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::refreshDependentDuplicate + Refreshes a duplicate volume with a snapshot taken from its parent. This is deprecated now. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/refreshDuplicate.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/refreshDuplicate.md index 3ffa36c547..f37dae0585 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/refreshDuplicate.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/refreshDuplicate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::refreshDuplicate + Refreshes any duplicate volume with a snapshot taken from its parent. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHardware.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHardware.md index 3900127cf3..38b80366df 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::removeAccessFromHardware + Remove access to this volume from a specified SoftLayer_Hardware object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHardwareList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHardwareList.md index 1777d4a675..27b754592d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHardwareList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHardwareList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::removeAccessFromHardwareList + Remove access to this volume from multiple SoftLayer_Hardware objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHost.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHost.md index 64ff7feca9..e86db9658d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHost.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::removeAccessFromHost + Remove access to this volume from a specified [SoftLayer_Hardware]({{}}) object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHostList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHostList.md index ab0ed4cad4..455e50d990 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHostList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromHostList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::removeAccessFromHostList + Remove access to this volume from multiple [SoftLayer_Hardware]({{}}) objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromIpAddress.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromIpAddress.md index c64b4bd755..1e5411e223 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::removeAccessFromIpAddress + Remove access to this volume from a specified SoftLayer_Network_Subnet_IpAddress object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromIpAddressList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromIpAddressList.md index 0fcf43c0a1..fbf7c524ca 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromIpAddressList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromIpAddressList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromSubnet.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromSubnet.md index c2edc4ff35..95200f5d44 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromSubnet.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromSubnet.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromSubnetList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromSubnetList.md index 040ff5402b..c955a56edc 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromSubnetList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromSubnetList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromVirtualGuest.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromVirtualGuest.md index 31fe2f79e6..b18f88e17d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromVirtualGuest.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::removeAccessFromVirtualGuest + Remove access to this volume from a specified SoftLayer_Virtual_Guest object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromVirtualGuestList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromVirtualGuestList.md index 02653ccbb6..41f9b65937 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromVirtualGuestList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessFromVirtualGuestList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::removeAccessFromVirtualGuestList + Remove access to this volume from multiple SoftLayer_Virtual_Guest objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromHardwareList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromHardwareList.md index 71ea21204b..fb80aeb5b7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromHardwareList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromHardwareList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::removeAccessToReplicantFromHardwareList + Remove access to this volume's replica from multiple SoftLayer_Hardware objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromIpAddressList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromIpAddressList.md index 0d44b3103f..a8a467b762 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromIpAddressList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromIpAddressList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::removeAccessToReplicantFromIpAddressList + Remove access to this replica volume's replica from multiple SoftLayer_Network_Subnet_IpAddress objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromSubnet.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromSubnet.md index cc74e70f76..e802b05ba7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromSubnet.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromSubnet.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromSubnetList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromSubnetList.md index f5608e32e5..5f47e029f9 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromSubnetList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromSubnetList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::removeAccessToReplicantFromSubnetList + Remove access to this volume's replica from multiple SoftLayer_Network_Subnet objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromVirtualGuestList.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromVirtualGuestList.md index 87d638fec4..db999ad033 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromVirtualGuestList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeAccessToReplicantFromVirtualGuestList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::removeAccessToReplicantFromVirtualGuestList + Remove access to this volume's replica from multiple SoftLayer_Virtual_Guest objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeCredential.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeCredential.md index 96f2d8eb4c..39a9603b1c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/removeCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::removeCredential + This method will remove a credential from the current volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/restoreFile.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/restoreFile.md index 059a2b0971..5238cc4165 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/restoreFile.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/restoreFile.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::restoreFile + Restore access to an individual file in a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/restoreFromSnapshot.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/restoreFromSnapshot.md index 42aa0e5185..6db63766ed 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/restoreFromSnapshot.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/restoreFromSnapshot.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::restoreFromSnapshot + Restore from a volume snapshot. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/sendPasswordReminderEmail.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/sendPasswordReminderEmail.md index 9db1e060a3..8826b9d8ea 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/sendPasswordReminderEmail.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/sendPasswordReminderEmail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::sendPasswordReminderEmail + Email the password for the Storage account to the master user. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/setMountable.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/setMountable.md index 3eefd55d17..d458c13c77 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/setMountable.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/setMountable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::setMountable + Enable or disable mounting of a Storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/setSnapshotAllocation.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/setSnapshotAllocation.md index 5cd058b63e..232a3a8bb9 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/setSnapshotAllocation.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/setSnapshotAllocation.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/setSnapshotNotification.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/setSnapshotNotification.md index 286e88fb78..3ff4cba3a9 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/setSnapshotNotification.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/setSnapshotNotification.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::setSnapshotNotification + Function to enable/disable snapshot warning notification. diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/upgradeVolumeCapacity.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/upgradeVolumeCapacity.md index e2bd9dd1fa..74e326173c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/upgradeVolumeCapacity.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/upgradeVolumeCapacity.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::upgradeVolumeCapacity + Edit the Storage volume to a different package diff --git a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/uploadFile.md b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/uploadFile.md index e19be363d1..74e6ed0a23 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/uploadFile.md +++ b/content/reference/services/SoftLayer_Network_Storage_Backup_Evault/uploadFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Backup_Evault](/reference/services/SoftLayer_Network_Storage_Backup_Evault)::uploadFile + Upload a file to a Storage account's root directory. diff --git a/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/_index.md b/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/_index.md index 5fa2b936b7..5f735d794d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,24 +44,28 @@ classes: #### [getAccount](/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getAccount) +
              #### [getDedicatedClusterList](/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getDedicatedClusterList) +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getObject) Retrieve a SoftLayer_Network_Storage_DedicatedCluster record. +
              #### [getServiceResource](/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getServiceResource) +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getAccount.md b/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getAccount.md index cb147da448..e5d8ea8095 100644 --- a/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getDedicatedClusterList.md b/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getDedicatedClusterList.md index 16d5dccc60..1e9a74f92b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getDedicatedClusterList.md +++ b/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getDedicatedClusterList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getObject.md b/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getObject.md index f17332327e..549cc8ad41 100644 --- a/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_DedicatedCluster](/reference/services/SoftLayer_Network_Storage_DedicatedCluster)::getObject + Retrieve a SoftLayer_Network_Storage_DedicatedCluster record. diff --git a/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getServiceResource.md b/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getServiceResource.md index ae1669cf2a..5a258d7273 100644 --- a/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getServiceResource.md +++ b/content/reference/services/SoftLayer_Network_Storage_DedicatedCluster/getServiceResource.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Group/_index.md b/content/reference/services/SoftLayer_Network_Storage_Group/_index.md index 1948e8cc13..6ce9d29787 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,96 +44,112 @@ classes: #### [addAllowedHost](/reference/services/SoftLayer_Network_Storage_Group/addAllowedHost) Attach a SoftLayer_Network_Storage_Allowed_Host object to this group +
              #### [attachToVolume](/reference/services/SoftLayer_Network_Storage_Group/attachToVolume) Attach a SoftLayer_Network_Storage volume to this group +
              #### [createObject](/reference/services/SoftLayer_Network_Storage_Group/createObject) +
              #### [deleteObject](/reference/services/SoftLayer_Network_Storage_Group/deleteObject) +
              #### [editObject](/reference/services/SoftLayer_Network_Storage_Group/editObject) +
              #### [getAccount](/reference/services/SoftLayer_Network_Storage_Group/getAccount) Retrieve the SoftLayer_Account which owns this group. +
              #### [getAllObjects](/reference/services/SoftLayer_Network_Storage_Group/getAllObjects) Returns all network storage groups +
              #### [getAllowedHosts](/reference/services/SoftLayer_Network_Storage_Group/getAllowedHosts) Retrieve the allowed hosts list for this group. +
              #### [getAttachedVolumes](/reference/services/SoftLayer_Network_Storage_Group/getAttachedVolumes) Retrieve the network storage volumes this group is attached to. +
              #### [getGroupType](/reference/services/SoftLayer_Network_Storage_Group/getGroupType) Retrieve the type which defines this group. +
              #### [getNetworkConnectionDetails](/reference/services/SoftLayer_Network_Storage_Group/getNetworkConnectionDetails) Retrieve network connection information for SoftLayer_Network_Storage_Allowed_Host objects to connect to the Network Storage Volumes within this group +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_Group/getObject) Retrieve a SoftLayer_Network_Storage_Group record. +
              #### [getOsType](/reference/services/SoftLayer_Network_Storage_Group/getOsType) Retrieve the OS Type this group is configured for. +
              #### [getServiceResource](/reference/services/SoftLayer_Network_Storage_Group/getServiceResource) Retrieve the network resource this group is created on. +
              #### [removeAllowedHost](/reference/services/SoftLayer_Network_Storage_Group/removeAllowedHost) Remove a SoftLayer_Network_Storage_Allowed_Host object from this group +
              #### [removeFromVolume](/reference/services/SoftLayer_Network_Storage_Group/removeFromVolume) Remove a SoftLayer_Network_Storage volume from this group +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_Group/addAllowedHost.md b/content/reference/services/SoftLayer_Network_Storage_Group/addAllowedHost.md index 2ab97374d1..a209194e2d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group/addAllowedHost.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group/addAllowedHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group](/reference/services/SoftLayer_Network_Storage_Group)::addAllowedHost + Attach a SoftLayer_Network_Storage_Allowed_Host object to this group diff --git a/content/reference/services/SoftLayer_Network_Storage_Group/attachToVolume.md b/content/reference/services/SoftLayer_Network_Storage_Group/attachToVolume.md index 1a66d0249a..fe6710fa90 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group/attachToVolume.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group/attachToVolume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group](/reference/services/SoftLayer_Network_Storage_Group)::attachToVolume + Attach a SoftLayer_Network_Storage volume to this group diff --git a/content/reference/services/SoftLayer_Network_Storage_Group/createObject.md b/content/reference/services/SoftLayer_Network_Storage_Group/createObject.md index 4cddd2acfc..ff0097a247 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group/createObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group/createObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Group/deleteObject.md b/content/reference/services/SoftLayer_Network_Storage_Group/deleteObject.md index 6ae4eb3cbe..ae47e8a4c2 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group/deleteObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Group/editObject.md b/content/reference/services/SoftLayer_Network_Storage_Group/editObject.md index 3507724df7..0149d386eb 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group/editObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Group/getAccount.md b/content/reference/services/SoftLayer_Network_Storage_Group/getAccount.md index d3c38292c3..e10d6a7d61 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group](/reference/services/SoftLayer_Network_Storage_Group)::getAccount + Retrieve the SoftLayer_Account which owns this group. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group/getAllObjects.md b/content/reference/services/SoftLayer_Network_Storage_Group/getAllObjects.md index 0c8c8d12a6..b4bc82cbe7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group](/reference/services/SoftLayer_Network_Storage_Group)::getAllObjects + Returns all network storage groups diff --git a/content/reference/services/SoftLayer_Network_Storage_Group/getAllowedHosts.md b/content/reference/services/SoftLayer_Network_Storage_Group/getAllowedHosts.md index 9a35189e7f..5a5a36cc51 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group/getAllowedHosts.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group/getAllowedHosts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group](/reference/services/SoftLayer_Network_Storage_Group)::getAllowedHosts + Retrieve the allowed hosts list for this group. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group/getAttachedVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Group/getAttachedVolumes.md index 6196a3efda..bd21d521ab 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group/getAttachedVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group/getAttachedVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group](/reference/services/SoftLayer_Network_Storage_Group)::getAttachedVolumes + Retrieve the network storage volumes this group is attached to. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group/getGroupType.md b/content/reference/services/SoftLayer_Network_Storage_Group/getGroupType.md index 674d451aef..583df4c7f0 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group/getGroupType.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group/getGroupType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group](/reference/services/SoftLayer_Network_Storage_Group)::getGroupType + Retrieve the type which defines this group. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group/getNetworkConnectionDetails.md b/content/reference/services/SoftLayer_Network_Storage_Group/getNetworkConnectionDetails.md index 1215b551e2..c03bc1406b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group/getNetworkConnectionDetails.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group/getNetworkConnectionDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group](/reference/services/SoftLayer_Network_Storage_Group)::getNetworkConnectionDetails + Retrieve network connection information for SoftLayer_Network_Storage_Allowed_Host objects to connect to the Network Storage Volumes within this group diff --git a/content/reference/services/SoftLayer_Network_Storage_Group/getObject.md b/content/reference/services/SoftLayer_Network_Storage_Group/getObject.md index 519b3de3fd..7730470d2c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group](/reference/services/SoftLayer_Network_Storage_Group)::getObject + Retrieve a SoftLayer_Network_Storage_Group record. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group/getOsType.md b/content/reference/services/SoftLayer_Network_Storage_Group/getOsType.md index 26611b7a98..a36474df15 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group/getOsType.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group/getOsType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group](/reference/services/SoftLayer_Network_Storage_Group)::getOsType + Retrieve the OS Type this group is configured for. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group/getServiceResource.md b/content/reference/services/SoftLayer_Network_Storage_Group/getServiceResource.md index 97eee12fd5..76c3db0573 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group/getServiceResource.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group/getServiceResource.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group](/reference/services/SoftLayer_Network_Storage_Group)::getServiceResource + Retrieve the network resource this group is created on. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group/removeAllowedHost.md b/content/reference/services/SoftLayer_Network_Storage_Group/removeAllowedHost.md index 67c5189be3..c6ed2ecb12 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group/removeAllowedHost.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group/removeAllowedHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group](/reference/services/SoftLayer_Network_Storage_Group)::removeAllowedHost + Remove a SoftLayer_Network_Storage_Allowed_Host object from this group diff --git a/content/reference/services/SoftLayer_Network_Storage_Group/removeFromVolume.md b/content/reference/services/SoftLayer_Network_Storage_Group/removeFromVolume.md index 8e9139685f..16ec5f58b7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group/removeFromVolume.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group/removeFromVolume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group](/reference/services/SoftLayer_Network_Storage_Group)::removeFromVolume + Remove a SoftLayer_Network_Storage volume from this group diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/_index.md b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/_index.md index 37b1c01a14..089293af1a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,96 +44,112 @@ classes: #### [addAllowedHost](/reference/services/SoftLayer_Network_Storage_Group_Iscsi/addAllowedHost) Attach a SoftLayer_Network_Storage_Allowed_Host object to this group +
              #### [attachToVolume](/reference/services/SoftLayer_Network_Storage_Group_Iscsi/attachToVolume) Attach a SoftLayer_Network_Storage volume to this group +
              #### [createObject](/reference/services/SoftLayer_Network_Storage_Group_Iscsi/createObject) +
              #### [deleteObject](/reference/services/SoftLayer_Network_Storage_Group_Iscsi/deleteObject) +
              #### [editObject](/reference/services/SoftLayer_Network_Storage_Group_Iscsi/editObject) +
              #### [getAccount](/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAccount) Retrieve the SoftLayer_Account which owns this group. +
              #### [getAllObjects](/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAllObjects) Returns all network storage groups +
              #### [getAllowedHosts](/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAllowedHosts) Retrieve the allowed hosts list for this group. +
              #### [getAttachedVolumes](/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAttachedVolumes) Retrieve the network storage volumes this group is attached to. +
              #### [getGroupType](/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getGroupType) Retrieve the type which defines this group. +
              #### [getNetworkConnectionDetails](/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getNetworkConnectionDetails) Retrieve network connection information for SoftLayer_Network_Storage_Allowed_Host objects to connect to the Network Storage Volumes within this group +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getObject) Retrieve a SoftLayer_Network_Storage_Group_Iscsi record. +
              #### [getOsType](/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getOsType) Retrieve the OS Type this group is configured for. +
              #### [getServiceResource](/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getServiceResource) Retrieve the network resource this group is created on. +
              #### [removeAllowedHost](/reference/services/SoftLayer_Network_Storage_Group_Iscsi/removeAllowedHost) Remove a SoftLayer_Network_Storage_Allowed_Host object from this group +
              #### [removeFromVolume](/reference/services/SoftLayer_Network_Storage_Group_Iscsi/removeFromVolume) Remove a SoftLayer_Network_Storage volume from this group +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/addAllowedHost.md b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/addAllowedHost.md index a3ead99991..9d1d730218 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/addAllowedHost.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/addAllowedHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Iscsi](/reference/services/SoftLayer_Network_Storage_Group_Iscsi)::addAllowedHost + Attach a SoftLayer_Network_Storage_Allowed_Host object to this group diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/attachToVolume.md b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/attachToVolume.md index 19759a0b66..de71aeffae 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/attachToVolume.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/attachToVolume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Iscsi](/reference/services/SoftLayer_Network_Storage_Group_Iscsi)::attachToVolume + Attach a SoftLayer_Network_Storage volume to this group diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/createObject.md b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/createObject.md index d468fb81a0..16963f6d8d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/createObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/createObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/deleteObject.md b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/deleteObject.md index 8247b499e2..eea0df32e9 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/deleteObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/editObject.md b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/editObject.md index 4dcc355c87..b899d661d7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/editObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAccount.md b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAccount.md index 544dc3917c..7f30607e5e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Iscsi](/reference/services/SoftLayer_Network_Storage_Group_Iscsi)::getAccount + Retrieve the SoftLayer_Account which owns this group. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAllObjects.md b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAllObjects.md index 04b5eb46a8..ad1713124b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Iscsi](/reference/services/SoftLayer_Network_Storage_Group_Iscsi)::getAllObjects + Returns all network storage groups diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAllowedHosts.md b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAllowedHosts.md index d4f621a1ca..e53973655a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAllowedHosts.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAllowedHosts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Iscsi](/reference/services/SoftLayer_Network_Storage_Group_Iscsi)::getAllowedHosts + Retrieve the allowed hosts list for this group. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAttachedVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAttachedVolumes.md index 117bc96535..41695db63c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAttachedVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getAttachedVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Iscsi](/reference/services/SoftLayer_Network_Storage_Group_Iscsi)::getAttachedVolumes + Retrieve the network storage volumes this group is attached to. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getGroupType.md b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getGroupType.md index 8da8ee7bbc..cce92df42c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getGroupType.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getGroupType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Iscsi](/reference/services/SoftLayer_Network_Storage_Group_Iscsi)::getGroupType + Retrieve the type which defines this group. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getNetworkConnectionDetails.md b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getNetworkConnectionDetails.md index 20c587a3a1..bd63010066 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getNetworkConnectionDetails.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getNetworkConnectionDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Iscsi](/reference/services/SoftLayer_Network_Storage_Group_Iscsi)::getNetworkConnectionDetails + Retrieve network connection information for SoftLayer_Network_Storage_Allowed_Host objects to connect to the Network Storage Volumes within this group diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getObject.md b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getObject.md index b8d138d6bf..82fad6751d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Iscsi](/reference/services/SoftLayer_Network_Storage_Group_Iscsi)::getObject + Retrieve a SoftLayer_Network_Storage_Group_Iscsi record. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getOsType.md b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getOsType.md index b5612a0e7d..4547a18a45 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getOsType.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getOsType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Iscsi](/reference/services/SoftLayer_Network_Storage_Group_Iscsi)::getOsType + Retrieve the OS Type this group is configured for. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getServiceResource.md b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getServiceResource.md index b703113cae..65df0cbb76 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getServiceResource.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/getServiceResource.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Iscsi](/reference/services/SoftLayer_Network_Storage_Group_Iscsi)::getServiceResource + Retrieve the network resource this group is created on. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/removeAllowedHost.md b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/removeAllowedHost.md index 31a6ae0927..908fec7dc4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/removeAllowedHost.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/removeAllowedHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Iscsi](/reference/services/SoftLayer_Network_Storage_Group_Iscsi)::removeAllowedHost + Remove a SoftLayer_Network_Storage_Allowed_Host object from this group diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/removeFromVolume.md b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/removeFromVolume.md index 2752f327f3..6a8efc1f4f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/removeFromVolume.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Iscsi/removeFromVolume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Iscsi](/reference/services/SoftLayer_Network_Storage_Group_Iscsi)::removeFromVolume + Remove a SoftLayer_Network_Storage volume from this group diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/_index.md b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/_index.md index aa93860aab..a33a1b4d6a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,96 +44,112 @@ classes: #### [addAllowedHost](/reference/services/SoftLayer_Network_Storage_Group_Nfs/addAllowedHost) Attach a SoftLayer_Network_Storage_Allowed_Host object to this group +
              #### [attachToVolume](/reference/services/SoftLayer_Network_Storage_Group_Nfs/attachToVolume) Attach a SoftLayer_Network_Storage volume to this group +
              #### [createObject](/reference/services/SoftLayer_Network_Storage_Group_Nfs/createObject) +
              #### [deleteObject](/reference/services/SoftLayer_Network_Storage_Group_Nfs/deleteObject) +
              #### [editObject](/reference/services/SoftLayer_Network_Storage_Group_Nfs/editObject) +
              #### [getAccount](/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAccount) Retrieve the SoftLayer_Account which owns this group. +
              #### [getAllObjects](/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAllObjects) Returns all network storage groups +
              #### [getAllowedHosts](/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAllowedHosts) Retrieve the allowed hosts list for this group. +
              #### [getAttachedVolumes](/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAttachedVolumes) Retrieve the network storage volumes this group is attached to. +
              #### [getGroupType](/reference/services/SoftLayer_Network_Storage_Group_Nfs/getGroupType) Retrieve the type which defines this group. +
              #### [getNetworkConnectionDetails](/reference/services/SoftLayer_Network_Storage_Group_Nfs/getNetworkConnectionDetails) Retrieve network connection information for SoftLayer_Network_Storage_Allowed_Host objects to connect to the Network Storage Volumes within this group +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_Group_Nfs/getObject) Retrieve a SoftLayer_Network_Storage_Group_Nfs record. +
              #### [getOsType](/reference/services/SoftLayer_Network_Storage_Group_Nfs/getOsType) Retrieve the OS Type this group is configured for. +
              #### [getServiceResource](/reference/services/SoftLayer_Network_Storage_Group_Nfs/getServiceResource) Retrieve the network resource this group is created on. +
              #### [removeAllowedHost](/reference/services/SoftLayer_Network_Storage_Group_Nfs/removeAllowedHost) Remove a SoftLayer_Network_Storage_Allowed_Host object from this group +
              #### [removeFromVolume](/reference/services/SoftLayer_Network_Storage_Group_Nfs/removeFromVolume) Remove a SoftLayer_Network_Storage volume from this group +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/addAllowedHost.md b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/addAllowedHost.md index 10b1821737..6a50b32d8c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/addAllowedHost.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/addAllowedHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Nfs](/reference/services/SoftLayer_Network_Storage_Group_Nfs)::addAllowedHost + Attach a SoftLayer_Network_Storage_Allowed_Host object to this group diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/attachToVolume.md b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/attachToVolume.md index c9ce6e074c..8c52da94a3 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/attachToVolume.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/attachToVolume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Nfs](/reference/services/SoftLayer_Network_Storage_Group_Nfs)::attachToVolume + Attach a SoftLayer_Network_Storage volume to this group diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/createObject.md b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/createObject.md index f542483e95..54ec909d81 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/createObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/createObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/deleteObject.md b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/deleteObject.md index 64bd87af4a..e795a0564d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/deleteObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/editObject.md b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/editObject.md index 4384ed72e9..bb066bcdc2 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/editObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAccount.md b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAccount.md index 9ab9bfb083..112064807c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Nfs](/reference/services/SoftLayer_Network_Storage_Group_Nfs)::getAccount + Retrieve the SoftLayer_Account which owns this group. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAllObjects.md b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAllObjects.md index 9df1940766..bf0806bf7d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Nfs](/reference/services/SoftLayer_Network_Storage_Group_Nfs)::getAllObjects + Returns all network storage groups diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAllowedHosts.md b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAllowedHosts.md index 4409118cb5..6736a672e4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAllowedHosts.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAllowedHosts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Nfs](/reference/services/SoftLayer_Network_Storage_Group_Nfs)::getAllowedHosts + Retrieve the allowed hosts list for this group. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAttachedVolumes.md b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAttachedVolumes.md index 0e304bc956..88e7ec7561 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAttachedVolumes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getAttachedVolumes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Nfs](/reference/services/SoftLayer_Network_Storage_Group_Nfs)::getAttachedVolumes + Retrieve the network storage volumes this group is attached to. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getGroupType.md b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getGroupType.md index c11971c443..476582d27c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getGroupType.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getGroupType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Nfs](/reference/services/SoftLayer_Network_Storage_Group_Nfs)::getGroupType + Retrieve the type which defines this group. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getNetworkConnectionDetails.md b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getNetworkConnectionDetails.md index 800df57435..517fd0fd01 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getNetworkConnectionDetails.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getNetworkConnectionDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Nfs](/reference/services/SoftLayer_Network_Storage_Group_Nfs)::getNetworkConnectionDetails + Retrieve network connection information for SoftLayer_Network_Storage_Allowed_Host objects to connect to the Network Storage Volumes within this group diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getObject.md b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getObject.md index 2be850d2a3..4eec3f974c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Nfs](/reference/services/SoftLayer_Network_Storage_Group_Nfs)::getObject + Retrieve a SoftLayer_Network_Storage_Group_Nfs record. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getOsType.md b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getOsType.md index 1f4803876e..d8f7c0f92b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getOsType.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getOsType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Nfs](/reference/services/SoftLayer_Network_Storage_Group_Nfs)::getOsType + Retrieve the OS Type this group is configured for. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getServiceResource.md b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getServiceResource.md index ea328b7f8e..26496164c4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getServiceResource.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/getServiceResource.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Nfs](/reference/services/SoftLayer_Network_Storage_Group_Nfs)::getServiceResource + Retrieve the network resource this group is created on. diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/removeAllowedHost.md b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/removeAllowedHost.md index 92a68ccc35..14106e770e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/removeAllowedHost.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/removeAllowedHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Nfs](/reference/services/SoftLayer_Network_Storage_Group_Nfs)::removeAllowedHost + Remove a SoftLayer_Network_Storage_Allowed_Host object from this group diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/removeFromVolume.md b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/removeFromVolume.md index 78b8c73962..b7190e4d6c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/removeFromVolume.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Nfs/removeFromVolume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Nfs](/reference/services/SoftLayer_Network_Storage_Group_Nfs)::removeFromVolume + Remove a SoftLayer_Network_Storage volume from this group diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Type/_index.md b/content/reference/services/SoftLayer_Network_Storage_Group_Type/_index.md index a19cbe2df1..cde55b0b1b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Type/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Network_Storage_Group_Type/getAllObjects) Returns all storage group types available +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_Group_Type/getObject) Retrieve a SoftLayer_Network_Storage_Group_Type record. +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Type/getAllObjects.md b/content/reference/services/SoftLayer_Network_Storage_Group_Type/getAllObjects.md index 4e3b8848a3..e7b196617d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Type/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Type](/reference/services/SoftLayer_Network_Storage_Group_Type)::getAllObjects + Returns all storage group types available diff --git a/content/reference/services/SoftLayer_Network_Storage_Group_Type/getObject.md b/content/reference/services/SoftLayer_Network_Storage_Group_Type/getObject.md index 3c994cfb09..5c501cc9ca 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Group_Type/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Group_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Group_Type](/reference/services/SoftLayer_Network_Storage_Group_Type)::getObject + Retrieve a SoftLayer_Network_Storage_Group_Type record. diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/_index.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/_index.md index 3b90edf4ea..1cd4eea837 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This class provides an interface for the management of IBM Cloud Object Storage Accounts and Credentials. @@ -42,96 +44,112 @@ This class provides an interface for the management of IBM Cloud Object Storage #### [credentialCreate](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/credentialCreate) +
              #### [credentialDelete](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/credentialDelete) +
              #### [getAccount](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getAccount) Retrieve softLayer account to which an IBM Cloud Object Storage account belongs to. +
              #### [getAllObjects](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getAllObjects) +
              #### [getBillingItem](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getBillingItem) Retrieve an associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future. +
              #### [getBuckets](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getBuckets) +
              #### [getCancelledBillingItem](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCancelledBillingItem) Retrieve an associated parent billing item which has been cancelled. +
              #### [getCapacityUsage](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCapacityUsage) +
              #### [getCloudObjectStorageMetrics](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCloudObjectStorageMetrics) +
              #### [getCredentialLimit](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCredentialLimit) +
              #### [getCredentials](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCredentials) Retrieve credentials used for generating an AWS signature. Max of 2. +
              #### [getEndpoints](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getEndpoints) +
              #### [getEndpointsWithRefetch](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getEndpointsWithRefetch) +
              #### [getMetricTrackingObject](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getMetricTrackingObject) Retrieve provides an interface to various metrics relating to the usage of an IBM Cloud Object Storage account. +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getObject) Retrieve a SoftLayer_Network_Storage_Hub_Cleversafe_Account record. +
              #### [getUuid](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getUuid) Retrieve unique identifier for an IBM Cloud Object Storage account. +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/credentialCreate.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/credentialCreate.md index 89746feacd..47a7697807 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/credentialCreate.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/credentialCreate.md @@ -16,6 +16,7 @@ aliases: + ## Overview Create credentials for an IBM Cloud Object Storage Account diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/credentialDelete.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/credentialDelete.md index f6cb8dc109..fce4399e3c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/credentialDelete.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/credentialDelete.md @@ -16,6 +16,7 @@ aliases: + ## Overview Delete a credential diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getAccount.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getAccount.md index 499c9845b6..c1d7948765 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Hub_Cleversafe_Account](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account)::getAccount + Retrieve softLayer account to which an IBM Cloud Object Storage account belongs to. diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getAllObjects.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getAllObjects.md index 0b72229454..25b1d4a1b7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getBillingItem.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getBillingItem.md index 656d50b0b5..56016f99a1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Hub_Cleversafe_Account](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account)::getBillingItem + Retrieve an associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future. diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getBuckets.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getBuckets.md index 138b135127..97ff089bdb 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getBuckets.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getBuckets.md @@ -16,6 +16,7 @@ aliases: + ## Overview Get buckets diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCancelledBillingItem.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCancelledBillingItem.md index a772617e1f..f950a883d8 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCancelledBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCancelledBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Hub_Cleversafe_Account](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account)::getCancelledBillingItem + Retrieve an associated parent billing item which has been cancelled. diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCapacityUsage.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCapacityUsage.md index 511bc6b6d9..499faf6e34 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCapacityUsage.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCapacityUsage.md @@ -16,6 +16,7 @@ aliases: + ## Overview Returns the capacity usage for an IBM Cloud Object Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCloudObjectStorageMetrics.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCloudObjectStorageMetrics.md index f45f821c0d..4feb26c297 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCloudObjectStorageMetrics.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCloudObjectStorageMetrics.md @@ -16,6 +16,7 @@ aliases: + ## Overview Makes a request to Cloud Object Storage metricsAPI service and when successful, returns an associative array with two elements: diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCredentialLimit.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCredentialLimit.md index b158b5ed15..2b43b00642 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCredentialLimit.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCredentialLimit.md @@ -16,6 +16,7 @@ aliases: + ## Overview Returns credential limits for this IBM Cloud Object Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCredentials.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCredentials.md index 389a2eaf0b..822f32186b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCredentials.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getCredentials.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Hub_Cleversafe_Account](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account)::getCredentials + Retrieve credentials used for generating an AWS signature. Max of 2. diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getEndpoints.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getEndpoints.md index 35628b4bd5..6361d626a9 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getEndpoints.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getEndpoints.md @@ -16,6 +16,7 @@ aliases: + ## Overview Returns a collection of endpoint URLs available to this IBM Cloud Object Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getEndpointsWithRefetch.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getEndpointsWithRefetch.md index 406b451760..7d198c9ac3 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getEndpointsWithRefetch.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getEndpointsWithRefetch.md @@ -16,6 +16,7 @@ aliases: + ## Overview Returns a collection of endpoint URLs available to this IBM Cloud Object Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getMetricTrackingObject.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getMetricTrackingObject.md index 32271a18bb..d87992c245 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getMetricTrackingObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getMetricTrackingObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Hub_Cleversafe_Account](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account)::getMetricTrackingObject + Retrieve provides an interface to various metrics relating to the usage of an IBM Cloud Object Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getObject.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getObject.md index d2cf70c1c3..0ee6781269 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Hub_Cleversafe_Account](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account)::getObject + Retrieve a SoftLayer_Network_Storage_Hub_Cleversafe_Account record. diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getUuid.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getUuid.md index 9c0e8cfb59..1546ca3698 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getUuid.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account/getUuid.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Hub_Cleversafe_Account](/reference/services/SoftLayer_Network_Storage_Hub_Cleversafe_Account)::getUuid + Retrieve unique identifier for an IBM Cloud Object Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Metrics/_index.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Metrics/_index.md index 27025efba1..af793537f2 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Metrics/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Metrics/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This service provides summarization functionality for Swift based accounts. It uses influxDB as a backend @@ -42,12 +44,14 @@ This service provides summarization functionality for Swift based accounts. It u #### [getMetricData](/reference/services/SoftLayer_Network_Storage_Hub_Swift_Metrics/getMetricData) +
              #### [getSummaryData](/reference/services/SoftLayer_Network_Storage_Hub_Swift_Metrics/getSummaryData) +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Metrics/getMetricData.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Metrics/getMetricData.md index 66464784a9..10916a39a5 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Metrics/getMetricData.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Metrics/getMetricData.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Metrics/getSummaryData.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Metrics/getSummaryData.md index 4f84112a97..5a0f4da728 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Metrics/getSummaryData.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Metrics/getSummaryData.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/_index.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/_index.md index f1b00693db..78af90a993 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,18 +44,21 @@ classes: #### [getContainerList](/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/getContainerList) Get a list of the file containers for a brand. +
              #### [getFile](/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/getFile) Download a file. +
              #### [getFileList](/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/getFileList) Get a list of the files in a container and path. +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/getContainerList.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/getContainerList.md index 69f96808ff..03150982a4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/getContainerList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/getContainerList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Hub_Swift_Share](/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share)::getContainerList + Get a list of the file containers for a brand. diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/getFile.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/getFile.md index 44da4e3ead..371d15d3ce 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/getFile.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/getFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Hub_Swift_Share](/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share)::getFile + Download a file. diff --git a/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/getFileList.md b/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/getFileList.md index cfc1f00a32..7d9e0990e1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/getFileList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share/getFileList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Hub_Swift_Share](/reference/services/SoftLayer_Network_Storage_Hub_Swift_Share)::getFileList + Get a list of the files in a container and path. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/_index.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/_index.md index 719f95f431..d8f850e505 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,1146 +44,1351 @@ SoftLayer's iscsi product extends upon the base functionality of SoftLayer offer #### [allowAccessFromHardware](/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHardware) Allow access to this volume from a specified SoftLayer_Hardware object. +
              #### [allowAccessFromHardwareList](/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHardwareList) +
              #### [allowAccessFromHost](/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHost) Allow access to this volume from a specified [SoftLayer_Hardware]({{}}) object. +
              #### [allowAccessFromHostList](/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHostList) Allow access to this volume from multiple [SoftLayer_Hardware]({{}}) objects. +
              #### [allowAccessFromIpAddress](/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromIpAddress) +
              #### [allowAccessFromIpAddressList](/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromIpAddressList) +
              #### [allowAccessFromSubnet](/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromSubnet) Allow access to this volume from multiple SoftLayer_Network_Subnet objects. +
              #### [allowAccessFromSubnetList](/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromSubnetList) +
              #### [allowAccessFromVirtualGuest](/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromVirtualGuest) Allow access to this volume from a specified SoftLayer_Virtual_Guest object. +
              #### [allowAccessFromVirtualGuestList](/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromVirtualGuestList) Allow access to this volume from multiple SoftLayer_Virtual_Guest objects. +
              #### [allowAccessToReplicantFromHardware](/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromHardware) Allow access to this replicant volume from a specified SoftLayer_Hardware object. +
              #### [allowAccessToReplicantFromHardwareList](/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromHardwareList) allow access to this replica volume from multiple SoftLayer_Hardware objects. +
              #### [allowAccessToReplicantFromIpAddress](/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromIpAddress) +
              #### [allowAccessToReplicantFromIpAddressList](/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromIpAddressList) allow access to this volume from multiple SoftLayer_Network_Subnet_IpAddress objects. +
              #### [allowAccessToReplicantFromSubnet](/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromSubnet) Allow access to this replicant volume from multiple SoftLayer_Network_Subnet objects. +
              #### [allowAccessToReplicantFromSubnetList](/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromSubnetList) allow access to this volume's replica from multiple SoftLayer_Network_Subnet objects. +
              #### [allowAccessToReplicantFromVirtualGuest](/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromVirtualGuest) Allow access to this replicant volume from a specified SoftLayer_Virtual_Guest object. +
              #### [allowAccessToReplicantFromVirtualGuestList](/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromVirtualGuestList) allow access to this volume from multiple SoftLayer_Virtual_Guest objects. +
              #### [assignCredential](/reference/services/SoftLayer_Network_Storage_Iscsi/assignCredential) This method will assign an existing credential to the current volume. +
              #### [assignNewCredential](/reference/services/SoftLayer_Network_Storage_Iscsi/assignNewCredential) This method will set up a new credential for the remote storage volume. +
              #### [changePassword](/reference/services/SoftLayer_Network_Storage_Iscsi/changePassword) Change the password for a Storage/Virtual Server Storage account +
              #### [collectBandwidth](/reference/services/SoftLayer_Network_Storage_Iscsi/collectBandwidth) Retrieve the bandwidth usage for the current billing cycle. +
              #### [collectBytesUsed](/reference/services/SoftLayer_Network_Storage_Iscsi/collectBytesUsed) Retrieve the number of bytes capacity currently in use on a Storage account. +
              #### [convertCloneDependentToIndependent](/reference/services/SoftLayer_Network_Storage_Iscsi/convertCloneDependentToIndependent) Splits a clone from its parent allowing it to be an independent volume. +
              #### [createFolder](/reference/services/SoftLayer_Network_Storage_Iscsi/createFolder) Create a new folder in the root directory. +
              #### [createOrUpdateLunId](/reference/services/SoftLayer_Network_Storage_Iscsi/createOrUpdateLunId) Creates or updates the LUN ID property on a volume. +
              #### [createSnapshot](/reference/services/SoftLayer_Network_Storage_Iscsi/createSnapshot) Manually create a new snapshot of a storage volume. +
              #### [deleteAllFiles](/reference/services/SoftLayer_Network_Storage_Iscsi/deleteAllFiles) Delete all files within a Storage account. +
              #### [deleteFile](/reference/services/SoftLayer_Network_Storage_Iscsi/deleteFile) Delete an individual file within a Storage account. +
              #### [deleteFiles](/reference/services/SoftLayer_Network_Storage_Iscsi/deleteFiles) Delete multiple files within a Storage account. +
              #### [deleteFolder](/reference/services/SoftLayer_Network_Storage_Iscsi/deleteFolder) Delete a folder in the root directory. +
              #### [deleteObject](/reference/services/SoftLayer_Network_Storage_Iscsi/deleteObject) Delete a network storage volume +
              #### [disableSnapshots](/reference/services/SoftLayer_Network_Storage_Iscsi/disableSnapshots) Disable snapshots of this Storage Volume on a schedule. +
              #### [disasterRecoveryFailoverToReplicant](/reference/services/SoftLayer_Network_Storage_Iscsi/disasterRecoveryFailoverToReplicant) Failover an inaccessible block/file volume to its available replicant volume. +
              #### [downloadFile](/reference/services/SoftLayer_Network_Storage_Iscsi/downloadFile) Download a file from a Storage account. +
              #### [editCredential](/reference/services/SoftLayer_Network_Storage_Iscsi/editCredential) This method will change the password of a credential created using the 'addNewCredential' method. +
              #### [editObject](/reference/services/SoftLayer_Network_Storage_Iscsi/editObject) Edit the password and/or notes for the Storage service +
              #### [enableSnapshots](/reference/services/SoftLayer_Network_Storage_Iscsi/enableSnapshots) Enable snapshots of this Storage Volume on a schedule. +
              #### [failbackFromReplicant](/reference/services/SoftLayer_Network_Storage_Iscsi/failbackFromReplicant) Failback from a volume replicant. +
              #### [failoverToReplicant](/reference/services/SoftLayer_Network_Storage_Iscsi/failoverToReplicant) Failover to a volume replicant. +
              #### [getAccount](/reference/services/SoftLayer_Network_Storage_Iscsi/getAccount) Retrieve the account that a Storage services belongs to. +
              #### [getAccountPassword](/reference/services/SoftLayer_Network_Storage_Iscsi/getAccountPassword) Retrieve other usernames and passwords associated with a Storage volume. +
              #### [getActiveTransactions](/reference/services/SoftLayer_Network_Storage_Iscsi/getActiveTransactions) Retrieve the currently active transactions on a network storage volume. +
              #### [getAllFiles](/reference/services/SoftLayer_Network_Storage_Iscsi/getAllFiles) Retrieve a listing of all files in a Storage account's root directory. +
              #### [getAllFilesByFilter](/reference/services/SoftLayer_Network_Storage_Iscsi/getAllFilesByFilter) Retrieve a listing of all files matching the filter's criteria in a Storage account's root directory. + +
              + +
              + +#### [getAllowDisasterRecoveryFailback](/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowDisasterRecoveryFailback) + +
              #### [getAllowDisasterRecoveryFailover](/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowDisasterRecoveryFailover) +
              #### [getAllowableHardware](/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableHardware) Return a list of SoftLayer_Hardware that can be authorized to this volume. +
              #### [getAllowableIpAddresses](/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableIpAddresses) Return a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this volume. +
              #### [getAllowableSubnets](/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableSubnets) Return a list of SoftLayer_Network_Subnet that can be authorized to this volume. +
              #### [getAllowableVirtualGuests](/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableVirtualGuests) Return a list of SoftLayer_Virtual_Guest that can be authorized to this volume. +
              #### [getAllowedHardware](/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedHardware) Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume. +
              #### [getAllowedHostsLimit](/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedHostsLimit) Retrieves the total number of allowed hosts limit per volume. +
              #### [getAllowedIpAddresses](/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedIpAddresses) Retrieve the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. +
              #### [getAllowedReplicationHardware](/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationHardware) Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. +
              #### [getAllowedReplicationIpAddresses](/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationIpAddresses) Retrieve the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. +
              #### [getAllowedReplicationSubnets](/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationSubnets) Retrieve the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. +
              #### [getAllowedReplicationVirtualGuests](/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationVirtualGuests) Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. +
              #### [getAllowedSubnets](/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedSubnets) Retrieve the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. +
              #### [getAllowedVirtualGuests](/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedVirtualGuests) Retrieve the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. +
              #### [getBillingItem](/reference/services/SoftLayer_Network_Storage_Iscsi/getBillingItem) Retrieve the current billing item for a Storage volume. +
              #### [getBillingItemCategory](/reference/services/SoftLayer_Network_Storage_Iscsi/getBillingItemCategory) +
              #### [getByUsername](/reference/services/SoftLayer_Network_Storage_Iscsi/getByUsername) Retrieve network storage accounts by username. +
              #### [getBytesUsed](/reference/services/SoftLayer_Network_Storage_Iscsi/getBytesUsed) Retrieve the amount of space used by the volume, in bytes. +
              #### [getCdnUrls](/reference/services/SoftLayer_Network_Storage_Iscsi/getCdnUrls) +
              #### [getClusterResource](/reference/services/SoftLayer_Network_Storage_Iscsi/getClusterResource) +
              #### [getCreationScheduleId](/reference/services/SoftLayer_Network_Storage_Iscsi/getCreationScheduleId) Retrieve the schedule id which was executed to create a snapshot. +
              #### [getCredentials](/reference/services/SoftLayer_Network_Storage_Iscsi/getCredentials) +
              #### [getDailySchedule](/reference/services/SoftLayer_Network_Storage_Iscsi/getDailySchedule) Retrieve the Daily Schedule which is associated with this network storage volume. +
              #### [getDependentDuplicate](/reference/services/SoftLayer_Network_Storage_Iscsi/getDependentDuplicate) Retrieve whether or not a network storage volume is a dependent duplicate. +
              #### [getDependentDuplicates](/reference/services/SoftLayer_Network_Storage_Iscsi/getDependentDuplicates) Retrieve the network storage volumes configured to be dependent duplicates of a volume. +
              #### [getEvents](/reference/services/SoftLayer_Network_Storage_Iscsi/getEvents) Retrieve the events which have taken place on a network storage volume. +
              #### [getFailbackNotAllowed](/reference/services/SoftLayer_Network_Storage_Iscsi/getFailbackNotAllowed) Retrieve determines whether the volume is allowed to failback + +
              + +
              + +#### [getFailoverNotAllowed](/reference/services/SoftLayer_Network_Storage_Iscsi/getFailoverNotAllowed) +Retrieve determines whether the volume is allowed to failover +
              #### [getFileBlockEncryptedLocations](/reference/services/SoftLayer_Network_Storage_Iscsi/getFileBlockEncryptedLocations) Returns a list of SoftLayer_Location_Datacenter objects corresponding to Datacenters in which File and Block Storage Volumes with Encryption at Rest may be ordered. +
              #### [getFileByIdentifier](/reference/services/SoftLayer_Network_Storage_Iscsi/getFileByIdentifier) Retrieve an individual file's details. +
              #### [getFileCount](/reference/services/SoftLayer_Network_Storage_Iscsi/getFileCount) Retrieve the file number of files in a Virtual Server Storage account's root directory. +
              #### [getFileList](/reference/services/SoftLayer_Network_Storage_Iscsi/getFileList) Retrieve list of files in a given folder for this account. +
              #### [getFileNetworkMountAddress](/reference/services/SoftLayer_Network_Storage_Iscsi/getFileNetworkMountAddress) Retrieve retrieves the NFS Network Mount Address Name for a given File Storage Volume. +
              #### [getFilePendingDeleteCount](/reference/services/SoftLayer_Network_Storage_Iscsi/getFilePendingDeleteCount) Retrieve the number of files pending deletion in a Storage account's recycle bin. +
              #### [getFilesPendingDelete](/reference/services/SoftLayer_Network_Storage_Iscsi/getFilesPendingDelete) Retrieve a list of files in a Storage account's recycle bin. +
              #### [getFolderList](/reference/services/SoftLayer_Network_Storage_Iscsi/getFolderList) Retrieve a list of level 1 folders for this account. +
              #### [getGraph](/reference/services/SoftLayer_Network_Storage_Iscsi/getGraph) Retrieve a graph representing the bandwidth used by a Storage account. +
              #### [getHardware](/reference/services/SoftLayer_Network_Storage_Iscsi/getHardware) Retrieve when applicable, the hardware associated with a Storage service. +
              #### [getHasEncryptionAtRest](/reference/services/SoftLayer_Network_Storage_Iscsi/getHasEncryptionAtRest) +
              #### [getHourlySchedule](/reference/services/SoftLayer_Network_Storage_Iscsi/getHourlySchedule) Retrieve the Hourly Schedule which is associated with this network storage volume. +
              #### [getIntervalSchedule](/reference/services/SoftLayer_Network_Storage_Iscsi/getIntervalSchedule) Retrieve the Interval Schedule which is associated with this network storage volume. +
              #### [getIops](/reference/services/SoftLayer_Network_Storage_Iscsi/getIops) Retrieve the maximum number of IOPs guaranteed for this LUN. +
              #### [getIsDependentDuplicateProvisionCompleted](/reference/services/SoftLayer_Network_Storage_Iscsi/getIsDependentDuplicateProvisionCompleted) Retrieve determines whether dependent volume provision is completed on background. +
              #### [getIsInDedicatedServiceResource](/reference/services/SoftLayer_Network_Storage_Iscsi/getIsInDedicatedServiceResource) +
              #### [getIsMagneticStorage](/reference/services/SoftLayer_Network_Storage_Iscsi/getIsMagneticStorage) +
              #### [getIsReadyForSnapshot](/reference/services/SoftLayer_Network_Storage_Iscsi/getIsReadyForSnapshot) Retrieve determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. +
              #### [getIsReadyToMount](/reference/services/SoftLayer_Network_Storage_Iscsi/getIsReadyToMount) Retrieve determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. +
              #### [getIscsiLuns](/reference/services/SoftLayer_Network_Storage_Iscsi/getIscsiLuns) Retrieve relationship between a container volume and iSCSI LUNs. +
              #### [getIscsiTargetIpAddresses](/reference/services/SoftLayer_Network_Storage_Iscsi/getIscsiTargetIpAddresses) Retrieve returns the target IP addresses of an iSCSI volume. +
              #### [getLunId](/reference/services/SoftLayer_Network_Storage_Iscsi/getLunId) Retrieve the ID of the LUN volume. +
              #### [getManualSnapshots](/reference/services/SoftLayer_Network_Storage_Iscsi/getManualSnapshots) Retrieve the snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. +
              #### [getMaximumExpansionSize](/reference/services/SoftLayer_Network_Storage_Iscsi/getMaximumExpansionSize) Returns the maximum volume expansion size in GB. +
              #### [getMetricTrackingObject](/reference/services/SoftLayer_Network_Storage_Iscsi/getMetricTrackingObject) Retrieve a network storage volume's metric tracking object. This object records all periodic polled data available to this volume. +
              #### [getMountPath](/reference/services/SoftLayer_Network_Storage_Iscsi/getMountPath) Retrieve retrieves the NFS Network Mount Path for a given File Storage Volume. +
              #### [getMountableFlag](/reference/services/SoftLayer_Network_Storage_Iscsi/getMountableFlag) Retrieve whether or not a network storage volume may be mounted. +
              #### [getMoveAndSplitStatus](/reference/services/SoftLayer_Network_Storage_Iscsi/getMoveAndSplitStatus) Retrieve the current status of split or move operation as a part of volume duplication. +
              #### [getNetworkConnectionDetails](/reference/services/SoftLayer_Network_Storage_Iscsi/getNetworkConnectionDetails) Retrieve network connection details for complex network storage volumes. +
              #### [getNetworkMountAddress](/reference/services/SoftLayer_Network_Storage_Iscsi/getNetworkMountAddress) Displays the mount path of a storage volume. +
              #### [getNetworkMountPath](/reference/services/SoftLayer_Network_Storage_Iscsi/getNetworkMountPath) Displays the mount path of a storage volume. +
              #### [getNotificationSubscribers](/reference/services/SoftLayer_Network_Storage_Iscsi/getNotificationSubscribers) Retrieve the subscribers that will be notified for usage amount warnings and overages. +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_Iscsi/getObject) Retrieve a SoftLayer_Network_Storage_Iscsi record. +
              #### [getObjectStorageConnectionInformation](/reference/services/SoftLayer_Network_Storage_Iscsi/getObjectStorageConnectionInformation) Retrieve all object storage details for connection +
              #### [getObjectsByCredential](/reference/services/SoftLayer_Network_Storage_Iscsi/getObjectsByCredential) Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object. +
              #### [getOriginalSnapshotName](/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalSnapshotName) Retrieve the name of the snapshot that this volume was duplicated from. +
              #### [getOriginalVolumeName](/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalVolumeName) Retrieve the name of the volume that this volume was duplicated from. +
              #### [getOriginalVolumeSize](/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalVolumeSize) Retrieve the size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. +
              #### [getOsType](/reference/services/SoftLayer_Network_Storage_Iscsi/getOsType) Retrieve a volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. +
              #### [getOsTypeId](/reference/services/SoftLayer_Network_Storage_Iscsi/getOsTypeId) Retrieve a volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. +
              #### [getParentPartnerships](/reference/services/SoftLayer_Network_Storage_Iscsi/getParentPartnerships) Retrieve the volumes or snapshots partnered with a network storage volume in a parental role. +
              #### [getParentVolume](/reference/services/SoftLayer_Network_Storage_Iscsi/getParentVolume) Retrieve the volume on which this iSCSI LUN is provisioned. +
              #### [getPartnerships](/reference/services/SoftLayer_Network_Storage_Iscsi/getPartnerships) Retrieve the volumes or snapshots partnered with a network storage volume. +
              #### [getPermissionsGroups](/reference/services/SoftLayer_Network_Storage_Iscsi/getPermissionsGroups) Retrieve all permissions group(s) this volume is in. +
              #### [getProperties](/reference/services/SoftLayer_Network_Storage_Iscsi/getProperties) Retrieve the properties used to provide additional details about a network storage volume. +
              #### [getProvisionedIops](/reference/services/SoftLayer_Network_Storage_Iscsi/getProvisionedIops) Retrieve the number of IOPs provisioned for this volume. +
              #### [getRecycleBinFileByIdentifier](/reference/services/SoftLayer_Network_Storage_Iscsi/getRecycleBinFileByIdentifier) Retrieve all files that are in the recycle bin (pending delete). This method is only used for Virtual Server Storage accounts at moment but may expanded to other Storage types in the future. +
              #### [getRemainingAllowedHosts](/reference/services/SoftLayer_Network_Storage_Iscsi/getRemainingAllowedHosts) Retrieves the remaining number of allowed hosts per volume. +
              #### [getRemainingAllowedHostsForReplicant](/reference/services/SoftLayer_Network_Storage_Iscsi/getRemainingAllowedHostsForReplicant) Retrieves the remaining number of allowed hosts for a volume's replicant. +
              #### [getReplicatingLuns](/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicatingLuns) Retrieve the iSCSI LUN volumes being replicated by this network storage volume. +
              #### [getReplicatingVolume](/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicatingVolume) Retrieve the network storage volume being replicated by a volume. +
              #### [getReplicationEvents](/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationEvents) Retrieve the volume replication events. +
              #### [getReplicationPartners](/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationPartners) Retrieve the network storage volumes configured to be replicants of a volume. +
              #### [getReplicationSchedule](/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationSchedule) Retrieve the Replication Schedule associated with a network storage volume. +
              #### [getReplicationStatus](/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationStatus) Retrieve the current replication status of a network storage volume. Indicates Failover or Failback status. +
              #### [getReplicationTimestamp](/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationTimestamp) An API call to fetch the last timestamp of the replication process +
              #### [getSchedules](/reference/services/SoftLayer_Network_Storage_Iscsi/getSchedules) Retrieve the schedules which are associated with a network storage volume. +
              #### [getServiceResource](/reference/services/SoftLayer_Network_Storage_Iscsi/getServiceResource) Retrieve the network resource a Storage service is connected to. +
              #### [getServiceResourceBackendIpAddress](/reference/services/SoftLayer_Network_Storage_Iscsi/getServiceResourceBackendIpAddress) Retrieve the IP address of a Storage resource. +
              #### [getServiceResourceName](/reference/services/SoftLayer_Network_Storage_Iscsi/getServiceResourceName) Retrieve the name of a Storage's network resource. +
              #### [getSnapshotCapacityGb](/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotCapacityGb) Retrieve a volume's configured snapshot space size. +
              #### [getSnapshotCreationTimestamp](/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotCreationTimestamp) Retrieve the creation timestamp of the snapshot on the storage platform. +
              #### [getSnapshotDeletionThresholdPercentage](/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotDeletionThresholdPercentage) Retrieve the percentage of used snapshot space after which to delete automated snapshots. +
              #### [getSnapshotNotificationStatus](/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotNotificationStatus) Retrieve whether or not a network storage volume may be mounted. +
              #### [getSnapshotSizeBytes](/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotSizeBytes) Retrieve the snapshot size in bytes. +
              #### [getSnapshotSpaceAvailable](/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotSpaceAvailable) Retrieve an volume's available snapshot reservation space. +
              #### [getSnapshots](/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshots) Retrieve the snapshots associated with this iSCSI LUN's container volume, if applicable +
              #### [getSnapshotsForVolume](/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotsForVolume) Retrieves a list of snapshots for a given volume. +
              #### [getStaasVersion](/reference/services/SoftLayer_Network_Storage_Iscsi/getStaasVersion) +
              #### [getStorageGroups](/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageGroups) Retrieve the network storage groups this volume is attached to. +
              #### [getStorageGroupsNetworkConnectionDetails](/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageGroupsNetworkConnectionDetails) +
              #### [getStorageTierLevel](/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageTierLevel) +
              #### [getStorageType](/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageType) Retrieve a description of the Storage object. +
              #### [getTargetIpAddresses](/reference/services/SoftLayer_Network_Storage_Iscsi/getTargetIpAddresses) +
              #### [getTotalBytesUsed](/reference/services/SoftLayer_Network_Storage_Iscsi/getTotalBytesUsed) Retrieve the amount of space used by the volume. +
              #### [getTotalScheduleSnapshotRetentionCount](/reference/services/SoftLayer_Network_Storage_Iscsi/getTotalScheduleSnapshotRetentionCount) Retrieve the total snapshot retention count of all schedules on this network storage volume. +
              #### [getUsageNotification](/reference/services/SoftLayer_Network_Storage_Iscsi/getUsageNotification) Retrieve the usage notification for SL Storage services. +
              #### [getValidReplicationTargetDatacenterLocations](/reference/services/SoftLayer_Network_Storage_Iscsi/getValidReplicationTargetDatacenterLocations) +
              #### [getVendorName](/reference/services/SoftLayer_Network_Storage_Iscsi/getVendorName) Retrieve the type of network storage service. +
              #### [getVirtualGuest](/reference/services/SoftLayer_Network_Storage_Iscsi/getVirtualGuest) Retrieve when applicable, the virtual guest associated with a Storage service. +
              #### [getVolumeCountLimits](/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeCountLimits) Retrieves an array of volume count limits per location and globally. +
              #### [getVolumeDuplicateParameters](/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeDuplicateParameters) +
              #### [getVolumeHistory](/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeHistory) Retrieve the username and password history for a Storage service. +
              #### [getVolumeStatus](/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeStatus) Retrieve the current status of a network storage volume. +
              #### [getWebccAccount](/reference/services/SoftLayer_Network_Storage_Iscsi/getWebccAccount) Retrieve the account username and password for the EVault webCC interface. +
              #### [getWeeklySchedule](/reference/services/SoftLayer_Network_Storage_Iscsi/getWeeklySchedule) Retrieve the Weekly Schedule which is associated with this network storage volume. +
              #### [immediateFailoverToReplicant](/reference/services/SoftLayer_Network_Storage_Iscsi/immediateFailoverToReplicant) Immediate Failover to a volume replicant. +
              #### [initiateOriginVolumeReclaim](/reference/services/SoftLayer_Network_Storage_Iscsi/initiateOriginVolumeReclaim) Initiates Origin Volume Reclaim to delete volume from NetApp. +
              #### [initiateVolumeCutover](/reference/services/SoftLayer_Network_Storage_Iscsi/initiateVolumeCutover) Initiates Volume Cutover to remove access from the old volume. +
              #### [isBlockingOperationInProgress](/reference/services/SoftLayer_Network_Storage_Iscsi/isBlockingOperationInProgress) +
              #### [isDuplicateReadyForSnapshot](/reference/services/SoftLayer_Network_Storage_Iscsi/isDuplicateReadyForSnapshot) Displays the if clone snapshots can be ordered. +
              #### [isDuplicateReadyToMount](/reference/services/SoftLayer_Network_Storage_Iscsi/isDuplicateReadyToMount) Displays the status of a clone mount. +
              #### [isVolumeActive](/reference/services/SoftLayer_Network_Storage_Iscsi/isVolumeActive) +
              #### [refreshDependentDuplicate](/reference/services/SoftLayer_Network_Storage_Iscsi/refreshDependentDuplicate) Refreshes a duplicate volume with a snapshot taken from its parent. This is deprecated now. +
              #### [refreshDuplicate](/reference/services/SoftLayer_Network_Storage_Iscsi/refreshDuplicate) Refreshes any duplicate volume with a snapshot taken from its parent. +
              #### [removeAccessFromHardware](/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHardware) Remove access to this volume from a specified SoftLayer_Hardware object. +
              #### [removeAccessFromHardwareList](/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHardwareList) Remove access to this volume from multiple SoftLayer_Hardware objects. +
              #### [removeAccessFromHost](/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHost) Remove access to this volume from a specified [SoftLayer_Hardware]({{}}) object. +
              #### [removeAccessFromHostList](/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHostList) Remove access to this volume from multiple [SoftLayer_Hardware]({{}}) objects. +
              #### [removeAccessFromIpAddress](/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromIpAddress) +
              #### [removeAccessFromIpAddressList](/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromIpAddressList) +
              #### [removeAccessFromSubnet](/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromSubnet) +
              #### [removeAccessFromSubnetList](/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromSubnetList) +
              #### [removeAccessFromVirtualGuest](/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromVirtualGuest) Remove access to this volume from a specified SoftLayer_Virtual_Guest object. +
              #### [removeAccessFromVirtualGuestList](/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromVirtualGuestList) Remove access to this volume from multiple SoftLayer_Virtual_Guest objects. +
              #### [removeAccessToReplicantFromHardwareList](/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromHardwareList) Remove access to this volume from multiple SoftLayer_Hardware objects. +
              #### [removeAccessToReplicantFromIpAddressList](/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromIpAddressList) Remove access to this replica volume from multiple SoftLayer_Network_Subnet_IpAddress objects. +
              #### [removeAccessToReplicantFromSubnet](/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromSubnet) +
              #### [removeAccessToReplicantFromSubnetList](/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromSubnetList) Remove access to this volume's replica from multiple SoftLayer_Network_Subnet objects. +
              #### [removeAccessToReplicantFromVirtualGuestList](/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromVirtualGuestList) Remove access to this replica volume from multiple SoftLayer_Virtual_Guest objects. +
              #### [removeCredential](/reference/services/SoftLayer_Network_Storage_Iscsi/removeCredential) This method will remove a credential from the current volume. +
              #### [restoreFile](/reference/services/SoftLayer_Network_Storage_Iscsi/restoreFile) Restore access to an individual file in a Storage account. +
              #### [restoreFromSnapshot](/reference/services/SoftLayer_Network_Storage_Iscsi/restoreFromSnapshot) Restore from a volume snapshot. +
              #### [sendPasswordReminderEmail](/reference/services/SoftLayer_Network_Storage_Iscsi/sendPasswordReminderEmail) Email the password for the Storage account to the master user. +
              #### [setMountable](/reference/services/SoftLayer_Network_Storage_Iscsi/setMountable) Enable or disable mounting of a Storage volume. +
              #### [setSnapshotAllocation](/reference/services/SoftLayer_Network_Storage_Iscsi/setSnapshotAllocation) +
              #### [setSnapshotNotification](/reference/services/SoftLayer_Network_Storage_Iscsi/setSnapshotNotification) Function to enable/disable snapshot warning notification. +
              #### [upgradeVolumeCapacity](/reference/services/SoftLayer_Network_Storage_Iscsi/upgradeVolumeCapacity) Edit the Storage volume to a different package +
              #### [uploadFile](/reference/services/SoftLayer_Network_Storage_Iscsi/uploadFile) Upload a file to a Storage account's root directory. +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHardware.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHardware.md index 61ddbece15..c921d6acce 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::allowAccessFromHardware + Allow access to this volume from a specified SoftLayer_Hardware object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHardwareList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHardwareList.md index 9041e85760..1bc62f5fe4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHardwareList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHardwareList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHost.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHost.md index 1e74fabb1b..3296d8ab27 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHost.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::allowAccessFromHost + Allow access to this volume from a specified [SoftLayer_Hardware]({{}}) object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHostList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHostList.md index 6d39777a9a..640f96e82b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHostList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromHostList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::allowAccessFromHostList + Allow access to this volume from multiple [SoftLayer_Hardware]({{}}) objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromIpAddress.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromIpAddress.md index b4ae99e0a3..84eacc1acf 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromIpAddress.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromIpAddressList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromIpAddressList.md index c83ab82764..bb02edb7f5 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromIpAddressList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromIpAddressList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromSubnet.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromSubnet.md index ec84650e17..df35464733 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromSubnet.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromSubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::allowAccessFromSubnet + Allow access to this volume from multiple SoftLayer_Network_Subnet objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromSubnetList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromSubnetList.md index 1478d33ac9..3a1224ad07 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromSubnetList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromSubnetList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromVirtualGuest.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromVirtualGuest.md index 44eea8bfb9..663bcb68a4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromVirtualGuest.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::allowAccessFromVirtualGuest + Allow access to this volume from a specified SoftLayer_Virtual_Guest object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromVirtualGuestList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromVirtualGuestList.md index 2f824a4ccf..9c652df63e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromVirtualGuestList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessFromVirtualGuestList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::allowAccessFromVirtualGuestList + Allow access to this volume from multiple SoftLayer_Virtual_Guest objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromHardware.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromHardware.md index 497264fad2..50f72166ed 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::allowAccessToReplicantFromHardware + Allow access to this replicant volume from a specified SoftLayer_Hardware object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromHardwareList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromHardwareList.md index 231e173a7c..90ead97299 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromHardwareList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromHardwareList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::allowAccessToReplicantFromHardwareList + allow access to this replica volume from multiple SoftLayer_Hardware objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromIpAddress.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromIpAddress.md index 11e7efba8e..2fea401efa 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromIpAddress.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromIpAddressList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromIpAddressList.md index e5ca2f34c1..c1381cf14c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromIpAddressList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromIpAddressList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::allowAccessToReplicantFromIpAddressList + allow access to this volume from multiple SoftLayer_Network_Subnet_IpAddress objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromSubnet.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromSubnet.md index de574a8c13..55558e5046 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromSubnet.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromSubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::allowAccessToReplicantFromSubnet + Allow access to this replicant volume from multiple SoftLayer_Network_Subnet objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromSubnetList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromSubnetList.md index 22f59c0578..5cf313d474 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromSubnetList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromSubnetList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::allowAccessToReplicantFromSubnetList + allow access to this volume's replica from multiple SoftLayer_Network_Subnet objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromVirtualGuest.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromVirtualGuest.md index 90580ca4bf..3570285b40 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromVirtualGuest.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::allowAccessToReplicantFromVirtualGuest + Allow access to this replicant volume from a specified SoftLayer_Virtual_Guest object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromVirtualGuestList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromVirtualGuestList.md index fca4fa7b1e..1389c168b1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromVirtualGuestList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/allowAccessToReplicantFromVirtualGuestList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::allowAccessToReplicantFromVirtualGuestList + allow access to this volume from multiple SoftLayer_Virtual_Guest objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/assignCredential.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/assignCredential.md index f331b9749d..4149076d3f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/assignCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/assignCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::assignCredential + This method will assign an existing credential to the current volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/assignNewCredential.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/assignNewCredential.md index 8f2ed24463..031b495e42 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/assignNewCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/assignNewCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::assignNewCredential + This method will set up a new credential for the remote storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/changePassword.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/changePassword.md index 2d6a37970c..838873f88a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/changePassword.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/changePassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::changePassword + Change the password for a Storage/Virtual Server Storage account diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/collectBandwidth.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/collectBandwidth.md index 0153322a70..71385a51bb 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/collectBandwidth.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/collectBandwidth.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::collectBandwidth + Retrieve the bandwidth usage for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/collectBytesUsed.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/collectBytesUsed.md index a6de610e30..0935bb9678 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/collectBytesUsed.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/collectBytesUsed.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::collectBytesUsed + Retrieve the number of bytes capacity currently in use on a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/convertCloneDependentToIndependent.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/convertCloneDependentToIndependent.md index b5a77b2236..1a7c46ef65 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/convertCloneDependentToIndependent.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/convertCloneDependentToIndependent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::convertCloneDependentToIndependent + Splits a clone from its parent allowing it to be an independent volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/createFolder.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/createFolder.md index 97129f38b6..b5bcd5f19b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/createFolder.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/createFolder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::createFolder + Create a new folder in the root directory. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/createOrUpdateLunId.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/createOrUpdateLunId.md index 8bb198fe59..033ffeaac4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/createOrUpdateLunId.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/createOrUpdateLunId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::createOrUpdateLunId + Creates or updates the LUN ID property on a volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/createSnapshot.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/createSnapshot.md index 40ab62b8a1..c6b83b1fa1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/createSnapshot.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/createSnapshot.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::createSnapshot + Manually create a new snapshot of a storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteAllFiles.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteAllFiles.md index 7384a53cc0..35054bed9f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteAllFiles.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteAllFiles.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::deleteAllFiles + Delete all files within a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteFile.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteFile.md index 8422faab7e..ee016a80de 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteFile.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::deleteFile + Delete an individual file within a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteFiles.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteFiles.md index 303cc44ef5..0cf5836d3b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteFiles.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteFiles.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::deleteFiles + Delete multiple files within a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteFolder.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteFolder.md index 7c809fb44a..baae2fc403 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteFolder.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteFolder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::deleteFolder + Delete a folder in the root directory. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteObject.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteObject.md index f3073757c3..eda0a4606e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::deleteObject + Delete a network storage volume diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/disableSnapshots.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/disableSnapshots.md index 66bf1a0c06..b610bca2ea 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/disableSnapshots.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/disableSnapshots.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::disableSnapshots + Disable snapshots of this Storage Volume on a schedule. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/disasterRecoveryFailoverToReplicant.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/disasterRecoveryFailoverToReplicant.md index 9ea6da676d..c3f53ae5d7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/disasterRecoveryFailoverToReplicant.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/disasterRecoveryFailoverToReplicant.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::disasterRecoveryFailoverToReplicant + Failover an inaccessible block/file volume to its available replicant volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/downloadFile.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/downloadFile.md index f79daa66c8..7d728d2c86 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/downloadFile.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/downloadFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::downloadFile + Download a file from a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/editCredential.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/editCredential.md index 154ed9810b..b574b3696c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/editCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/editCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::editCredential + This method will change the password of a credential created using the 'addNewCredential' method. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/editObject.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/editObject.md index 63402c2268..4f989b0f4b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/editObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::editObject + Edit the password and/or notes for the Storage service diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/enableSnapshots.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/enableSnapshots.md index c7d185d9c5..7090b036fb 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/enableSnapshots.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/enableSnapshots.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::enableSnapshots + Enable snapshots of this Storage Volume on a schedule. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/failbackFromReplicant.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/failbackFromReplicant.md index 6fc1755d85..d413259c94 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/failbackFromReplicant.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/failbackFromReplicant.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::failbackFromReplicant + Failback from a volume replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/failoverToReplicant.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/failoverToReplicant.md index 4d811f1302..5e5b604d7b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/failoverToReplicant.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/failoverToReplicant.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::failoverToReplicant + Failover to a volume replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAccount.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAccount.md index 7ee5a9dbb5..c9471fe965 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getAccount + Retrieve the account that a Storage services belongs to. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAccountPassword.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAccountPassword.md index 1d89fd1c36..985ba9da5e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAccountPassword.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAccountPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getAccountPassword + Retrieve other usernames and passwords associated with a Storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getActiveTransactions.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getActiveTransactions.md index a10c245178..c4f4c1a70b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getActiveTransactions.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getActiveTransactions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getActiveTransactions + Retrieve the currently active transactions on a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllFiles.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllFiles.md index eb6cc5a652..945ac19f6f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllFiles.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllFiles.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getAllFiles + Retrieve a listing of all files in a Storage account's root directory. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllFilesByFilter.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllFilesByFilter.md index bb00ec8fb4..a48182d71d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllFilesByFilter.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllFilesByFilter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getAllFilesByFilter + Retrieve a listing of all files matching the filter's criteria in a Storage account's root directory. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowDisasterRecoveryFailback.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowDisasterRecoveryFailback.md new file mode 100644 index 0000000000..5be9c202c7 --- /dev/null +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowDisasterRecoveryFailback.md @@ -0,0 +1,45 @@ +--- +title: "getAllowDisasterRecoveryFailback" +description: "" +layout: "method" +tags: + - "method" + - "sldn" + - "Network" +classes: + - "SoftLayer_Network_Storage_Iscsi" +aliases: + - "/reference/services/softlayer_network_storage_iscsi/getAllowDisasterRecoveryFailback" +--- +# [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getAllowDisasterRecoveryFailback + + + + + +## Overview + + +----- + +### Parameters +|Name | Type | Description | +| --- | --- | --- | + + +### Required Headers +* SoftLayer_Network_Storage_IscsiInitParameters +* authenticate + + +### Optional Headers +* SoftLayer_Network_Storage_IscsiObjectMask +* SoftLayer_Network_Storage_IscsiObjectFilter +* SoftLayer_ObjectMask + +### Return Values +* string + + + + diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowDisasterRecoveryFailover.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowDisasterRecoveryFailover.md index 0f1cce07d1..28c36519f8 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowDisasterRecoveryFailover.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowDisasterRecoveryFailover.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableHardware.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableHardware.md index fbfe7f6cac..08779f1e7a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getAllowableHardware + Return a list of SoftLayer_Hardware that can be authorized to this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableIpAddresses.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableIpAddresses.md index 7fa67ca428..5cb5e88121 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getAllowableIpAddresses + Return a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableSubnets.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableSubnets.md index 20d8f3d31c..9cbf7781ea 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableSubnets.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getAllowableSubnets + Return a list of SoftLayer_Network_Subnet that can be authorized to this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableVirtualGuests.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableVirtualGuests.md index f78e7f829b..6656eafdbb 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableVirtualGuests.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowableVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getAllowableVirtualGuests + Return a list of SoftLayer_Virtual_Guest that can be authorized to this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedHardware.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedHardware.md index 93e603638c..5b1556498e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getAllowedHardware + Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedHostsLimit.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedHostsLimit.md index dc8c7ad39a..3e3fd5f7b8 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedHostsLimit.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedHostsLimit.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getAllowedHostsLimit + Retrieves the total number of allowed hosts limit per volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedIpAddresses.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedIpAddresses.md index 9c06a6204f..03dcc30992 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getAllowedIpAddresses + Retrieve the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationHardware.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationHardware.md index 7f511a61a9..d22e099351 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getAllowedReplicationHardware + Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationIpAddresses.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationIpAddresses.md index e25641d929..97c7abe9b6 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getAllowedReplicationIpAddresses + Retrieve the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationSubnets.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationSubnets.md index 7ccf2a1930..389f85b2f1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationSubnets.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getAllowedReplicationSubnets + Retrieve the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationVirtualGuests.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationVirtualGuests.md index f7285365b7..71c41fb159 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationVirtualGuests.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedReplicationVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getAllowedReplicationVirtualGuests + Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedSubnets.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedSubnets.md index 344d2662a2..ddff83dc0f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedSubnets.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getAllowedSubnets + Retrieve the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedVirtualGuests.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedVirtualGuests.md index ab08ece047..6695003cc2 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedVirtualGuests.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getAllowedVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getAllowedVirtualGuests + Retrieve the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getBillingItem.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getBillingItem.md index 68dd4e6c11..0ad1bef9a8 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getBillingItem + Retrieve the current billing item for a Storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getBillingItemCategory.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getBillingItemCategory.md index 1278e85362..9d2933a150 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getBillingItemCategory.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getBillingItemCategory.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getByUsername.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getByUsername.md index 93b1d7ab15..a303cfe5fa 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getByUsername.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getByUsername.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getByUsername + Retrieve network storage accounts by username. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getBytesUsed.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getBytesUsed.md index bcf5b49dd4..e80e80b2f6 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getBytesUsed.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getBytesUsed.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getBytesUsed + Retrieve the amount of space used by the volume, in bytes. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getCdnUrls.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getCdnUrls.md index ddfca69929..3a76745a0f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getCdnUrls.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getCdnUrls.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getClusterResource.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getClusterResource.md index a45eb24df5..989fb67d1a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getClusterResource.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getClusterResource.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getCreationScheduleId.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getCreationScheduleId.md index 05b453ba75..3393f2e12d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getCreationScheduleId.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getCreationScheduleId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getCreationScheduleId + Retrieve the schedule id which was executed to create a snapshot. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getCredentials.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getCredentials.md index ee2989968b..fdd316fa7a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getCredentials.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getCredentials.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getDailySchedule.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getDailySchedule.md index 6b7bafa686..1eaf6dd07e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getDailySchedule.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getDailySchedule.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getDailySchedule + Retrieve the Daily Schedule which is associated with this network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getDependentDuplicate.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getDependentDuplicate.md index 5b9337221c..12ade7703b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getDependentDuplicate.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getDependentDuplicate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getDependentDuplicate + Retrieve whether or not a network storage volume is a dependent duplicate. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getDependentDuplicates.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getDependentDuplicates.md index 4c8c102572..d27872d8b4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getDependentDuplicates.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getDependentDuplicates.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getDependentDuplicates + Retrieve the network storage volumes configured to be dependent duplicates of a volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getEvents.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getEvents.md index 720832e169..fd911c677f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getEvents.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getEvents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getEvents + Retrieve the events which have taken place on a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFailbackNotAllowed.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFailbackNotAllowed.md index ee7e4bc3a9..6d97e2ab5d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFailbackNotAllowed.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFailbackNotAllowed.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getFailbackNotAllowed + Retrieve determines whether the volume is allowed to failback diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFailoverNotAllowed.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFailoverNotAllowed.md new file mode 100644 index 0000000000..b58bdf5079 --- /dev/null +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFailoverNotAllowed.md @@ -0,0 +1,45 @@ +--- +title: "getFailoverNotAllowed" +description: "Retrieve determines whether the volume is allowed to failover" +layout: "method" +tags: + - "method" + - "sldn" + - "Network" +classes: + - "SoftLayer_Network_Storage_Iscsi" +aliases: + - "/reference/services/softlayer_network_storage_iscsi/getFailoverNotAllowed" +--- +# [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getFailoverNotAllowed + + +Retrieve determines whether the volume is allowed to failover + + +## Overview +Retrieve determines whether the volume is allowed to failover + +----- + +### Parameters +|Name | Type | Description | +| --- | --- | --- | + + +### Required Headers +* SoftLayer_Network_Storage_IscsiInitParameters +* authenticate + + +### Optional Headers +* SoftLayer_Network_Storage_IscsiObjectMask +* SoftLayer_Network_Storage_IscsiObjectFilter +* SoftLayer_ObjectMask + +### Return Values +* string + + + + diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileBlockEncryptedLocations.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileBlockEncryptedLocations.md index c2d3c42306..b56c1ed584 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileBlockEncryptedLocations.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileBlockEncryptedLocations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getFileBlockEncryptedLocations + Returns a list of SoftLayer_Location_Datacenter objects corresponding to Datacenters in which File and Block Storage Volumes with Encryption at Rest may be ordered. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileByIdentifier.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileByIdentifier.md index c6d812dc46..3ebf0899e7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileByIdentifier.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileByIdentifier.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getFileByIdentifier + Retrieve an individual file's details. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileCount.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileCount.md index 845e0fc69e..21132bae7b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileCount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getFileCount + Retrieve the file number of files in a Virtual Server Storage account's root directory. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileList.md index 8f1a8cfd3e..e2d324154d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getFileList + Retrieve list of files in a given folder for this account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileNetworkMountAddress.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileNetworkMountAddress.md index 0eff2808b7..5c39b05be5 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileNetworkMountAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFileNetworkMountAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getFileNetworkMountAddress + Retrieve retrieves the NFS Network Mount Address Name for a given File Storage Volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFilePendingDeleteCount.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFilePendingDeleteCount.md index b1bb546a60..60cb22b2d9 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFilePendingDeleteCount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFilePendingDeleteCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getFilePendingDeleteCount + Retrieve the number of files pending deletion in a Storage account's recycle bin. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFilesPendingDelete.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFilesPendingDelete.md index b892c10bff..9b22550803 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFilesPendingDelete.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFilesPendingDelete.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getFilesPendingDelete + Retrieve a list of files in a Storage account's recycle bin. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFolderList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFolderList.md index fb506fb7f7..00fcfe3f30 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFolderList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getFolderList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getFolderList + Retrieve a list of level 1 folders for this account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getGraph.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getGraph.md index c9ab67d39f..fd2fe72fe0 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getGraph.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getGraph.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getGraph + Retrieve a graph representing the bandwidth used by a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getHardware.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getHardware.md index cbe5ba5c64..5fe7e363be 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getHardware + Retrieve when applicable, the hardware associated with a Storage service. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getHasEncryptionAtRest.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getHasEncryptionAtRest.md index 9e0374ba48..6feb4f5f1a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getHasEncryptionAtRest.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getHasEncryptionAtRest.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getHourlySchedule.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getHourlySchedule.md index e900c59ce8..86da24a23d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getHourlySchedule.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getHourlySchedule.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getHourlySchedule + Retrieve the Hourly Schedule which is associated with this network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIntervalSchedule.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIntervalSchedule.md index 94b1b9bada..632fb7265e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIntervalSchedule.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIntervalSchedule.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getIntervalSchedule + Retrieve the Interval Schedule which is associated with this network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIops.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIops.md index 0fe7061685..21afea2c74 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIops.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIops.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getIops + Retrieve the maximum number of IOPs guaranteed for this LUN. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsDependentDuplicateProvisionCompleted.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsDependentDuplicateProvisionCompleted.md index f89a93ea69..8aa4f6745b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsDependentDuplicateProvisionCompleted.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsDependentDuplicateProvisionCompleted.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getIsDependentDuplicateProvisionCompleted + Retrieve determines whether dependent volume provision is completed on background. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsInDedicatedServiceResource.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsInDedicatedServiceResource.md index 59d9e7006c..d0f1ef61eb 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsInDedicatedServiceResource.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsInDedicatedServiceResource.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsMagneticStorage.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsMagneticStorage.md index 1159462d8a..7246b00208 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsMagneticStorage.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsMagneticStorage.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsReadyForSnapshot.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsReadyForSnapshot.md index df7a47d0e6..b8c406d1b2 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsReadyForSnapshot.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsReadyForSnapshot.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getIsReadyForSnapshot + Retrieve determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsReadyToMount.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsReadyToMount.md index dd823744b4..ef31373587 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsReadyToMount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIsReadyToMount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getIsReadyToMount + Retrieve determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIscsiLuns.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIscsiLuns.md index ee51ec9a0f..e72fca8f37 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIscsiLuns.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIscsiLuns.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getIscsiLuns + Retrieve relationship between a container volume and iSCSI LUNs. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIscsiTargetIpAddresses.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIscsiTargetIpAddresses.md index 90142e8faf..d40a50ed0b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIscsiTargetIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getIscsiTargetIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getIscsiTargetIpAddresses + Retrieve returns the target IP addresses of an iSCSI volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getLunId.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getLunId.md index 215edc6f25..120a204ba5 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getLunId.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getLunId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getLunId + Retrieve the ID of the LUN volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getManualSnapshots.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getManualSnapshots.md index 2769fbc8e4..66dff1a640 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getManualSnapshots.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getManualSnapshots.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getManualSnapshots + Retrieve the snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMaximumExpansionSize.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMaximumExpansionSize.md index 0708a7df78..afe6f1c33f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMaximumExpansionSize.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMaximumExpansionSize.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getMaximumExpansionSize + Returns the maximum volume expansion size in GB. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMetricTrackingObject.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMetricTrackingObject.md index 3f7436a86a..e732990262 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMetricTrackingObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMetricTrackingObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getMetricTrackingObject + Retrieve a network storage volume's metric tracking object. This object records all periodic polled data available to this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMountPath.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMountPath.md index 0ab7a96c05..a20ec48301 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMountPath.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMountPath.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getMountPath + Retrieve retrieves the NFS Network Mount Path for a given File Storage Volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMountableFlag.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMountableFlag.md index d18b5b1455..5b7929de6b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMountableFlag.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMountableFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getMountableFlag + Retrieve whether or not a network storage volume may be mounted. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMoveAndSplitStatus.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMoveAndSplitStatus.md index 57a6822df4..c23811cbd6 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMoveAndSplitStatus.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getMoveAndSplitStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getMoveAndSplitStatus + Retrieve the current status of split or move operation as a part of volume duplication. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getNetworkConnectionDetails.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getNetworkConnectionDetails.md index 1f83d51ea6..8380601bb1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getNetworkConnectionDetails.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getNetworkConnectionDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getNetworkConnectionDetails + Retrieve network connection details for complex network storage volumes. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getNetworkMountAddress.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getNetworkMountAddress.md index 795c2cbf34..d063a73e86 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getNetworkMountAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getNetworkMountAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getNetworkMountAddress + Displays the mount path of a storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getNetworkMountPath.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getNetworkMountPath.md index 456c6ea4d4..2e5e4041d4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getNetworkMountPath.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getNetworkMountPath.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getNetworkMountPath + Displays the mount path of a storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getNotificationSubscribers.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getNotificationSubscribers.md index 816b90272f..49fa4501c5 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getNotificationSubscribers.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getNotificationSubscribers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getNotificationSubscribers + Retrieve the subscribers that will be notified for usage amount warnings and overages. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getObject.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getObject.md index 1886a0b683..348f7ef8e1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getObject + Retrieve a SoftLayer_Network_Storage_Iscsi record. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getObjectStorageConnectionInformation.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getObjectStorageConnectionInformation.md index 4991d60687..d257f0f8f1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getObjectStorageConnectionInformation.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getObjectStorageConnectionInformation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getObjectStorageConnectionInformation + Retrieve all object storage details for connection diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getObjectsByCredential.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getObjectsByCredential.md index b9d1833408..e6d4d7beef 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getObjectsByCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getObjectsByCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getObjectsByCredential + Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalSnapshotName.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalSnapshotName.md index f0d246f666..6d7be08863 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalSnapshotName.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalSnapshotName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getOriginalSnapshotName + Retrieve the name of the snapshot that this volume was duplicated from. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalVolumeName.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalVolumeName.md index 23fdf2148e..56915fd9ae 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalVolumeName.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalVolumeName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getOriginalVolumeName + Retrieve the name of the volume that this volume was duplicated from. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalVolumeSize.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalVolumeSize.md index 345da934ee..3501049c8a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalVolumeSize.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOriginalVolumeSize.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getOriginalVolumeSize + Retrieve the size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOsType.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOsType.md index 1a0451694d..ad563e4c34 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOsType.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOsType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getOsType + Retrieve a volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOsTypeId.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOsTypeId.md index 58980908fb..ad2bfd56e8 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOsTypeId.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getOsTypeId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getOsTypeId + Retrieve a volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getParentPartnerships.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getParentPartnerships.md index 9282fd8a7a..57dc2502d6 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getParentPartnerships.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getParentPartnerships.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getParentPartnerships + Retrieve the volumes or snapshots partnered with a network storage volume in a parental role. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getParentVolume.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getParentVolume.md index 2906e7da6a..14618340e1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getParentVolume.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getParentVolume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getParentVolume + Retrieve the volume on which this iSCSI LUN is provisioned. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getPartnerships.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getPartnerships.md index 3cb64e3fc2..496dcbf8d7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getPartnerships.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getPartnerships.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getPartnerships + Retrieve the volumes or snapshots partnered with a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getPermissionsGroups.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getPermissionsGroups.md index 0a0e37baaf..1af14133f8 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getPermissionsGroups.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getPermissionsGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getPermissionsGroups + Retrieve all permissions group(s) this volume is in. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getProperties.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getProperties.md index b706d7fa0d..9f60d960ea 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getProperties.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getProperties.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getProperties + Retrieve the properties used to provide additional details about a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getProvisionedIops.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getProvisionedIops.md index 2ea06bcaa5..07f422220f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getProvisionedIops.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getProvisionedIops.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getProvisionedIops + Retrieve the number of IOPs provisioned for this volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getRecycleBinFileByIdentifier.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getRecycleBinFileByIdentifier.md index f66ceefe8c..7f3469f30b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getRecycleBinFileByIdentifier.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getRecycleBinFileByIdentifier.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getRecycleBinFileByIdentifier + Retrieve all files that are in the recycle bin (pending delete). This method is only used for Virtual Server Storage accounts at moment but may expanded to other Storage types in the future. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getRemainingAllowedHosts.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getRemainingAllowedHosts.md index f5268f2aad..e38893d82d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getRemainingAllowedHosts.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getRemainingAllowedHosts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getRemainingAllowedHosts + Retrieves the remaining number of allowed hosts per volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getRemainingAllowedHostsForReplicant.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getRemainingAllowedHostsForReplicant.md index e91aa45107..74e11826d3 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getRemainingAllowedHostsForReplicant.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getRemainingAllowedHostsForReplicant.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getRemainingAllowedHostsForReplicant + Retrieves the remaining number of allowed hosts for a volume's replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicatingLuns.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicatingLuns.md index 160841bd1f..56a439651c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicatingLuns.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicatingLuns.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getReplicatingLuns + Retrieve the iSCSI LUN volumes being replicated by this network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicatingVolume.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicatingVolume.md index a467961beb..598a50f25d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicatingVolume.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicatingVolume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getReplicatingVolume + Retrieve the network storage volume being replicated by a volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationEvents.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationEvents.md index 41e905196b..d249bae751 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationEvents.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationEvents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getReplicationEvents + Retrieve the volume replication events. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationPartners.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationPartners.md index 22319a54e2..7adec9e567 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationPartners.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationPartners.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getReplicationPartners + Retrieve the network storage volumes configured to be replicants of a volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationSchedule.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationSchedule.md index 126ac21782..ce00e683a3 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationSchedule.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationSchedule.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getReplicationSchedule + Retrieve the Replication Schedule associated with a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationStatus.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationStatus.md index f5a8376661..33b1204d6f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationStatus.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getReplicationStatus + Retrieve the current replication status of a network storage volume. Indicates Failover or Failback status. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationTimestamp.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationTimestamp.md index b77eb1f546..672a7cadad 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationTimestamp.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getReplicationTimestamp.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getReplicationTimestamp + An API call to fetch the last timestamp of the replication process diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSchedules.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSchedules.md index 0566c784c5..34ac990f2a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSchedules.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSchedules.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getSchedules + Retrieve the schedules which are associated with a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getServiceResource.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getServiceResource.md index 7c76b09644..8db30ecb91 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getServiceResource.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getServiceResource.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getServiceResource + Retrieve the network resource a Storage service is connected to. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getServiceResourceBackendIpAddress.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getServiceResourceBackendIpAddress.md index 39c4b8caee..5b8acc4f9f 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getServiceResourceBackendIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getServiceResourceBackendIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getServiceResourceBackendIpAddress + Retrieve the IP address of a Storage resource. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getServiceResourceName.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getServiceResourceName.md index 4770bbe900..90efdd9d78 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getServiceResourceName.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getServiceResourceName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getServiceResourceName + Retrieve the name of a Storage's network resource. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotCapacityGb.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotCapacityGb.md index 144e4bd98a..abd490fe71 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotCapacityGb.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotCapacityGb.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getSnapshotCapacityGb + Retrieve a volume's configured snapshot space size. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotCreationTimestamp.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotCreationTimestamp.md index 2b075707bb..4bcda6a643 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotCreationTimestamp.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotCreationTimestamp.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getSnapshotCreationTimestamp + Retrieve the creation timestamp of the snapshot on the storage platform. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotDeletionThresholdPercentage.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotDeletionThresholdPercentage.md index 1300947246..3f793e37e7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotDeletionThresholdPercentage.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotDeletionThresholdPercentage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getSnapshotDeletionThresholdPercentage + Retrieve the percentage of used snapshot space after which to delete automated snapshots. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotNotificationStatus.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotNotificationStatus.md index 019e72cbb8..85eec85830 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotNotificationStatus.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotNotificationStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getSnapshotNotificationStatus + Retrieve whether or not a network storage volume may be mounted. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotSizeBytes.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotSizeBytes.md index 226d9528ba..4e753272b4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotSizeBytes.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotSizeBytes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getSnapshotSizeBytes + Retrieve the snapshot size in bytes. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotSpaceAvailable.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotSpaceAvailable.md index eb985d5fed..4b2f8f549d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotSpaceAvailable.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotSpaceAvailable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getSnapshotSpaceAvailable + Retrieve an volume's available snapshot reservation space. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshots.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshots.md index 36909c6296..31518ed28a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshots.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshots.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getSnapshots + Retrieve the snapshots associated with this iSCSI LUN's container volume, if applicable diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotsForVolume.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotsForVolume.md index d761f86ebc..eb2946aef2 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotsForVolume.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getSnapshotsForVolume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getSnapshotsForVolume + Retrieves a list of snapshots for a given volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStaasVersion.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStaasVersion.md index 8172838e05..94d5f844fc 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStaasVersion.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStaasVersion.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageGroups.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageGroups.md index 7fa3ff4c7e..17851a8246 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageGroups.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getStorageGroups + Retrieve the network storage groups this volume is attached to. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageGroupsNetworkConnectionDetails.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageGroupsNetworkConnectionDetails.md index 86dff4a6e0..a584ff7b94 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageGroupsNetworkConnectionDetails.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageGroupsNetworkConnectionDetails.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageTierLevel.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageTierLevel.md index 0b1aebe324..28ae76821b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageTierLevel.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageTierLevel.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageType.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageType.md index e9bcf8e35e..56a3505735 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageType.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getStorageType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getStorageType + Retrieve a description of the Storage object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getTargetIpAddresses.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getTargetIpAddresses.md index 028963b4a2..70016cc3e3 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getTargetIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getTargetIpAddresses.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getTotalBytesUsed.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getTotalBytesUsed.md index 26a7c0b690..5ffa37dbd8 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getTotalBytesUsed.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getTotalBytesUsed.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getTotalBytesUsed + Retrieve the amount of space used by the volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getTotalScheduleSnapshotRetentionCount.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getTotalScheduleSnapshotRetentionCount.md index 1dbec68058..f85700d108 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getTotalScheduleSnapshotRetentionCount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getTotalScheduleSnapshotRetentionCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getTotalScheduleSnapshotRetentionCount + Retrieve the total snapshot retention count of all schedules on this network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getUsageNotification.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getUsageNotification.md index 679b821d11..656bd60992 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getUsageNotification.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getUsageNotification.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getUsageNotification + Retrieve the usage notification for SL Storage services. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getValidReplicationTargetDatacenterLocations.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getValidReplicationTargetDatacenterLocations.md index 781769b5bf..da3673c720 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getValidReplicationTargetDatacenterLocations.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getValidReplicationTargetDatacenterLocations.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVendorName.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVendorName.md index 16d5747faa..edbc22311a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVendorName.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVendorName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getVendorName + Retrieve the type of network storage service. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVirtualGuest.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVirtualGuest.md index 3078bf1da6..6b64787c33 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVirtualGuest.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getVirtualGuest + Retrieve when applicable, the virtual guest associated with a Storage service. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeCountLimits.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeCountLimits.md index 98d11b8bdb..7c6216cb2a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeCountLimits.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeCountLimits.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getVolumeCountLimits + Retrieves an array of volume count limits per location and globally. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeDuplicateParameters.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeDuplicateParameters.md index 56c2e3a703..1d61d93b19 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeDuplicateParameters.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeDuplicateParameters.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method returns the parameters for cloning a volume diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeHistory.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeHistory.md index 8b3649ef6d..5810749803 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeHistory.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getVolumeHistory + Retrieve the username and password history for a Storage service. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeStatus.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeStatus.md index bea37492f5..c720899213 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeStatus.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getVolumeStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getVolumeStatus + Retrieve the current status of a network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getWebccAccount.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getWebccAccount.md index 82fa10b2df..930aa5b694 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getWebccAccount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getWebccAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getWebccAccount + Retrieve the account username and password for the EVault webCC interface. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getWeeklySchedule.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getWeeklySchedule.md index bddbb7fdca..d660c8f5b1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/getWeeklySchedule.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/getWeeklySchedule.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::getWeeklySchedule + Retrieve the Weekly Schedule which is associated with this network storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/immediateFailoverToReplicant.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/immediateFailoverToReplicant.md index b0ba65f87f..5607835f79 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/immediateFailoverToReplicant.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/immediateFailoverToReplicant.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::immediateFailoverToReplicant + Immediate Failover to a volume replicant. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/initiateOriginVolumeReclaim.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/initiateOriginVolumeReclaim.md index e2d60ad184..0a27cbb9ef 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/initiateOriginVolumeReclaim.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/initiateOriginVolumeReclaim.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::initiateOriginVolumeReclaim + Initiates Origin Volume Reclaim to delete volume from NetApp. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/initiateVolumeCutover.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/initiateVolumeCutover.md index 45121e0e87..3c88c5bb74 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/initiateVolumeCutover.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/initiateVolumeCutover.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::initiateVolumeCutover + Initiates Volume Cutover to remove access from the old volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/isBlockingOperationInProgress.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/isBlockingOperationInProgress.md index f95f7781b9..34f0532c03 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/isBlockingOperationInProgress.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/isBlockingOperationInProgress.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/isDuplicateReadyForSnapshot.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/isDuplicateReadyForSnapshot.md index b45cb73df0..8559e06a06 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/isDuplicateReadyForSnapshot.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/isDuplicateReadyForSnapshot.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::isDuplicateReadyForSnapshot + Displays the if clone snapshots can be ordered. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/isDuplicateReadyToMount.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/isDuplicateReadyToMount.md index 98f14cf2fd..8dea9af15a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/isDuplicateReadyToMount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/isDuplicateReadyToMount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::isDuplicateReadyToMount + Displays the status of a clone mount. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/isVolumeActive.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/isVolumeActive.md index 2c2476e197..30522d73ba 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/isVolumeActive.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/isVolumeActive.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/refreshDependentDuplicate.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/refreshDependentDuplicate.md index 147777860b..acfca00b24 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/refreshDependentDuplicate.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/refreshDependentDuplicate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::refreshDependentDuplicate + Refreshes a duplicate volume with a snapshot taken from its parent. This is deprecated now. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/refreshDuplicate.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/refreshDuplicate.md index 6d050230ae..db9e403d51 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/refreshDuplicate.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/refreshDuplicate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::refreshDuplicate + Refreshes any duplicate volume with a snapshot taken from its parent. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHardware.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHardware.md index f1f2772d9a..16ce4c8962 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHardware.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::removeAccessFromHardware + Remove access to this volume from a specified SoftLayer_Hardware object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHardwareList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHardwareList.md index 366a73d191..693121dbb1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHardwareList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHardwareList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::removeAccessFromHardwareList + Remove access to this volume from multiple SoftLayer_Hardware objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHost.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHost.md index eb501227d0..c10275a2d9 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHost.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::removeAccessFromHost + Remove access to this volume from a specified [SoftLayer_Hardware]({{}}) object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHostList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHostList.md index 2605e5123f..bcdef89757 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHostList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromHostList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::removeAccessFromHostList + Remove access to this volume from multiple [SoftLayer_Hardware]({{}}) objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromIpAddress.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromIpAddress.md index c701d5e7e9..abfe6dc9d0 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromIpAddress.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromIpAddressList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromIpAddressList.md index 53a338b0a6..f706f6225d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromIpAddressList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromIpAddressList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromSubnet.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromSubnet.md index 286caed4e3..560e1bb885 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromSubnet.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromSubnet.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromSubnetList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromSubnetList.md index e2501ae74f..5a6ee47ba7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromSubnetList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromSubnetList.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromVirtualGuest.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromVirtualGuest.md index de458cda94..482acfb7a7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromVirtualGuest.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::removeAccessFromVirtualGuest + Remove access to this volume from a specified SoftLayer_Virtual_Guest object. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromVirtualGuestList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromVirtualGuestList.md index 23d6bada5f..6370fc7bb6 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromVirtualGuestList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessFromVirtualGuestList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::removeAccessFromVirtualGuestList + Remove access to this volume from multiple SoftLayer_Virtual_Guest objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromHardwareList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromHardwareList.md index 30a047109c..a9b47bc7a8 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromHardwareList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromHardwareList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::removeAccessToReplicantFromHardwareList + Remove access to this volume from multiple SoftLayer_Hardware objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromIpAddressList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromIpAddressList.md index 6de688da15..a731db5fd1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromIpAddressList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromIpAddressList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::removeAccessToReplicantFromIpAddressList + Remove access to this replica volume from multiple SoftLayer_Network_Subnet_IpAddress objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromSubnet.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromSubnet.md index d408610b78..91068e0e86 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromSubnet.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromSubnet.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromSubnetList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromSubnetList.md index b1378cf94f..451fc572ce 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromSubnetList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromSubnetList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::removeAccessToReplicantFromSubnetList + Remove access to this volume's replica from multiple SoftLayer_Network_Subnet objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromVirtualGuestList.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromVirtualGuestList.md index b06477d1ea..c202f574fe 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromVirtualGuestList.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeAccessToReplicantFromVirtualGuestList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::removeAccessToReplicantFromVirtualGuestList + Remove access to this replica volume from multiple SoftLayer_Virtual_Guest objects. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeCredential.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeCredential.md index 84a6fb6af7..0071d7cfcf 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeCredential.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/removeCredential.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::removeCredential + This method will remove a credential from the current volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/restoreFile.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/restoreFile.md index 3c4eefaf41..0744bf5445 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/restoreFile.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/restoreFile.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::restoreFile + Restore access to an individual file in a Storage account. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/restoreFromSnapshot.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/restoreFromSnapshot.md index 9ac6133c8b..17beb76949 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/restoreFromSnapshot.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/restoreFromSnapshot.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::restoreFromSnapshot + Restore from a volume snapshot. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/sendPasswordReminderEmail.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/sendPasswordReminderEmail.md index 7a2b04cc48..7f2355fde0 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/sendPasswordReminderEmail.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/sendPasswordReminderEmail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::sendPasswordReminderEmail + Email the password for the Storage account to the master user. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/setMountable.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/setMountable.md index 0b0735b769..ba0e65b058 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/setMountable.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/setMountable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::setMountable + Enable or disable mounting of a Storage volume. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/setSnapshotAllocation.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/setSnapshotAllocation.md index 2397e6f1d6..6f612fc51b 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/setSnapshotAllocation.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/setSnapshotAllocation.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/setSnapshotNotification.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/setSnapshotNotification.md index 61cd753cbd..4b599684de 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/setSnapshotNotification.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/setSnapshotNotification.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::setSnapshotNotification + Function to enable/disable snapshot warning notification. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/upgradeVolumeCapacity.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/upgradeVolumeCapacity.md index 694e89f14d..96f9ea928d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/upgradeVolumeCapacity.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/upgradeVolumeCapacity.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::upgradeVolumeCapacity + Edit the Storage volume to a different package diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi/uploadFile.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi/uploadFile.md index 1df5b6165f..875a0be6a5 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi/uploadFile.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi/uploadFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi](/reference/services/SoftLayer_Network_Storage_Iscsi)::uploadFile + Upload a file to a Storage account's root directory. diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi_OS_Type/_index.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi_OS_Type/_index.md index 41ef868dae..287c05cf26 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi_OS_Type/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi_OS_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Network_Storage_Iscsi_OS_Type/getAllObjects) Returns all iSCSI OS Types +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_Iscsi_OS_Type/getObject) Retrieve a SoftLayer_Network_Storage_Iscsi_OS_Type record. +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi_OS_Type/getAllObjects.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi_OS_Type/getAllObjects.md index a107c2b234..365cff8694 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi_OS_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi_OS_Type/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi_OS_Type](/reference/services/SoftLayer_Network_Storage_Iscsi_OS_Type)::getAllObjects + Returns all iSCSI OS Types diff --git a/content/reference/services/SoftLayer_Network_Storage_Iscsi_OS_Type/getObject.md b/content/reference/services/SoftLayer_Network_Storage_Iscsi_OS_Type/getObject.md index ea447e65c4..ac998a9401 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Iscsi_OS_Type/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Iscsi_OS_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Iscsi_OS_Type](/reference/services/SoftLayer_Network_Storage_Iscsi_OS_Type)::getObject + Retrieve a SoftLayer_Network_Storage_Iscsi_OS_Type record. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/_index.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/_index.md index 94e388c77a..5e51016613 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + MassDataMigration_CrossRegion_Country_Xref provides a list of countries where Mass Data Migration Device could be shipped for each CleverSafe Object Storage Region. @@ -42,30 +44,35 @@ MassDataMigration_CrossRegion_Country_Xref provides a list of countries where Ma #### [getAllObjects](/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getAllObjects) +
              #### [getCountry](/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getCountry) Retrieve softLayer_Locale_Country Id. +
              #### [getLocationGroup](/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getLocationGroup) Retrieve location Group ID of CleverSafe cross region. +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getObject) Retrieve a SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref record. +
              #### [getValidCountriesForRegion](/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getValidCountriesForRegion) return countries assigned to the region having pricing info set. +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getAllObjects.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getAllObjects.md index 8477ce1f8a..c7e4bc84cd 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getCountry.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getCountry.md index a9f76ef981..39b8cddc43 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getCountry.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getCountry.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref](/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref)::getCountry + Retrieve softLayer_Locale_Country Id. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getLocationGroup.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getLocationGroup.md index b76db7f9a2..0efcf180c6 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getLocationGroup.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getLocationGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref](/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref)::getLocationGroup + Retrieve location Group ID of CleverSafe cross region. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getObject.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getObject.md index 280491d2d6..0446e0a1b7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref](/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref)::getObject + Retrieve a SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref record. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getValidCountriesForRegion.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getValidCountriesForRegion.md index 678d1976fa..66bdcafd70 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getValidCountriesForRegion.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getValidCountriesForRegion.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref](/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref)::getValidCountriesForRegion + return countries assigned to the region having pricing info set. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/_index.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/_index.md index bc1f70191a..42e3e87fd3 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Mass Data Migration Request Service allows users to request Massive storage device to copy onsite data. Once user has copied their data onto device, they ship it back to SoftLayer where device is connected to network and data is transferred to Object Storage bucket. Currently, the initial usage period is two weeks . Additional time for maintaining the media for continued may be purchased. Please contact sales for additional information regarding this. Once the usage period has elapsed. SoftLayer will disconnect the device. @@ -42,114 +44,133 @@ Mass Data Migration Request Service allows users to request Massive storage devi #### [getAccount](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAccount) Retrieve the account to which the request belongs. +
              #### [getActiveTickets](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getActiveTickets) Retrieve the active tickets that are attached to the MDMS request. +
              #### [getAddress](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAddress) Retrieve the customer address where the device is shipped to. +
              #### [getAllObjects](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAllObjects) +
              #### [getAllRequestStatuses](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAllRequestStatuses) Retrieves a list of all the possible statuses +
              #### [getBillingItem](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getBillingItem) Retrieve an associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future. +
              #### [getCreateEmployee](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getCreateEmployee) Retrieve the employee user who created the request. +
              #### [getCreateUser](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getCreateUser) Retrieve the customer user who created the request. +
              #### [getDeviceConfiguration](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getDeviceConfiguration) Retrieve the device configurations. +
              #### [getDeviceModel](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getDeviceModel) Retrieve the model of device assigned to this request. +
              #### [getKeyContacts](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getKeyContacts) Retrieve the key contacts for this requests. +
              #### [getModifyEmployee](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getModifyEmployee) Retrieve the employee who last modified the request. +
              #### [getModifyUser](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getModifyUser) Retrieve the customer user who last modified the request. +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getObject) Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request record. +
              #### [getPendingRequests](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getPendingRequests) Returns placeholder MDMS requests for any MDMS order pending approval. +
              #### [getShipments](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getShipments) Retrieve the shipments of the request. +
              #### [getStatus](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getStatus) Retrieve the status of the request. +
              #### [getTicket](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getTicket) Retrieve ticket that is attached to this mass data migration request. +
              #### [getTickets](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getTickets) Retrieve all tickets that are attached to the mass data migration request. +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAccount.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAccount.md index eba2043129..21a4243e6d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request)::getAccount + Retrieve the account to which the request belongs. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getActiveTickets.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getActiveTickets.md index 92935ab527..40f779b62c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getActiveTickets.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getActiveTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request)::getActiveTickets + Retrieve the active tickets that are attached to the MDMS request. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAddress.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAddress.md index 2d91a05d31..27fe770aad 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAddress.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request)::getAddress + Retrieve the customer address where the device is shipped to. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAllObjects.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAllObjects.md index 4bdddd56a5..acb9bee605 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAllRequestStatuses.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAllRequestStatuses.md index 624f744660..9eaf2b0bbc 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAllRequestStatuses.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAllRequestStatuses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request)::getAllRequestStatuses + Retrieves a list of all the possible statuses diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getBillingItem.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getBillingItem.md index cf9aeb6417..24f559c9bd 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request)::getBillingItem + Retrieve an associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getCreateEmployee.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getCreateEmployee.md index beec2979ee..f1e3b747b9 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getCreateEmployee.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getCreateEmployee.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request)::getCreateEmployee + Retrieve the employee user who created the request. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getCreateUser.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getCreateUser.md index 3f6891cfa0..e500fc3b84 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getCreateUser.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getCreateUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request)::getCreateUser + Retrieve the customer user who created the request. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getDeviceConfiguration.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getDeviceConfiguration.md index c373b09331..0a06d3823e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getDeviceConfiguration.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getDeviceConfiguration.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request)::getDeviceConfiguration + Retrieve the device configurations. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getDeviceModel.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getDeviceModel.md index 93cf71df83..5a6ff56926 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getDeviceModel.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getDeviceModel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request)::getDeviceModel + Retrieve the model of device assigned to this request. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getKeyContacts.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getKeyContacts.md index 00bd058890..2a97ae31a0 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getKeyContacts.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getKeyContacts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request)::getKeyContacts + Retrieve the key contacts for this requests. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getModifyEmployee.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getModifyEmployee.md index 6560b88e05..8217a1a0a6 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getModifyEmployee.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getModifyEmployee.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request)::getModifyEmployee + Retrieve the employee who last modified the request. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getModifyUser.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getModifyUser.md index f10ee569ce..d276c865f4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getModifyUser.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getModifyUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request)::getModifyUser + Retrieve the customer user who last modified the request. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getObject.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getObject.md index d0c3330ad0..867c82a748 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request)::getObject + Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request record. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getPendingRequests.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getPendingRequests.md index 26f4599533..95e7725cd1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getPendingRequests.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getPendingRequests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request)::getPendingRequests + Returns placeholder MDMS requests for any MDMS order pending approval. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getShipments.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getShipments.md index 3dfd6ed2bf..18a85d3279 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getShipments.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getShipments.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request)::getShipments + Retrieve the shipments of the request. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getStatus.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getStatus.md index 8075cddbb5..cb31f6c499 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getStatus.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request)::getStatus + Retrieve the status of the request. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getTicket.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getTicket.md index 3d6f803781..d90baafaec 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getTicket.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getTicket.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request)::getTicket + Retrieve ticket that is attached to this mass data migration request. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getTickets.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getTickets.md index c8e6361440..97b1430406 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getTickets.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request)::getTickets + Retrieve all tickets that are attached to the mass data migration request. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/_index.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/_index.md index e7b7661e68..c0532bfc76 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,18 +44,21 @@ The SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact data type con #### [getAccount](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getAccount) Retrieve the request this key contact belongs to. +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getObject) Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact record. +
              #### [getRequest](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getRequest) Retrieve the request this key contact belongs to. +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getAccount.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getAccount.md index a2ab962b8e..7a0f709cae 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact)::getAccount + Retrieve the request this key contact belongs to. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getObject.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getObject.md index d30c2bbb9e..b050e80508 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact)::getObject + Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact record. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getRequest.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getRequest.md index 19a4b7cd5d..cb2c14a22a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getRequest.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact)::getRequest + Retrieve the request this key contact belongs to. diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_Status/_index.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_Status/_index.md index f542704e16..1b515567b4 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_Status/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_Status/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,6 +44,7 @@ classes: #### [getObject](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_Status/getObject) Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request_Status record. +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_Status/getObject.md b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_Status/getObject.md index 8e6518ef1f..38a151e375 100644 --- a/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_Status/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_Status/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_MassDataMigration_Request_Status](/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_Status)::getObject + Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request_Status record. diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/_index.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/_index.md index 781a36c8cc..f8bc9607ba 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -44,114 +46,133 @@ The schedule service can be used to create, edit, or delete a schedule. Schedule #### [createObject](/reference/services/SoftLayer_Network_Storage_Schedule/createObject) Create a nas volume schedule +
              #### [deleteObject](/reference/services/SoftLayer_Network_Storage_Schedule/deleteObject) Delete a network storage schedule +
              #### [editObject](/reference/services/SoftLayer_Network_Storage_Schedule/editObject) Edit a nas volume schedule +
              #### [getDay](/reference/services/SoftLayer_Network_Storage_Schedule/getDay) Retrieve the hour parameter of this schedule. +
              #### [getDayOfMonth](/reference/services/SoftLayer_Network_Storage_Schedule/getDayOfMonth) Retrieve the day of the month parameter of this schedule. +
              #### [getDayOfWeek](/reference/services/SoftLayer_Network_Storage_Schedule/getDayOfWeek) Retrieve the day of the week parameter of this schedule. +
              #### [getEvents](/reference/services/SoftLayer_Network_Storage_Schedule/getEvents) Retrieve events which have been created as the result of a schedule execution. +
              #### [getHour](/reference/services/SoftLayer_Network_Storage_Schedule/getHour) Retrieve the hour parameter of this schedule. +
              #### [getMinute](/reference/services/SoftLayer_Network_Storage_Schedule/getMinute) Retrieve the minute parameter of this schedule. +
              #### [getMonthOfYear](/reference/services/SoftLayer_Network_Storage_Schedule/getMonthOfYear) Retrieve the month of the year parameter of this schedule. +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_Schedule/getObject) Retrieve a SoftLayer_Network_Storage_Schedule record. +
              #### [getPartnership](/reference/services/SoftLayer_Network_Storage_Schedule/getPartnership) Retrieve the associated partnership for a schedule. +
              #### [getProperties](/reference/services/SoftLayer_Network_Storage_Schedule/getProperties) Retrieve properties used for configuration of a schedule. +
              #### [getReplicaSnapshots](/reference/services/SoftLayer_Network_Storage_Schedule/getReplicaSnapshots) Retrieve replica snapshots which have been created as the result of this schedule's execution. +
              #### [getRetentionCount](/reference/services/SoftLayer_Network_Storage_Schedule/getRetentionCount) Retrieve the number of snapshots this schedule is configured to retain. +
              #### [getSecond](/reference/services/SoftLayer_Network_Storage_Schedule/getSecond) Retrieve the minute parameter of this schedule. +
              #### [getSnapshots](/reference/services/SoftLayer_Network_Storage_Schedule/getSnapshots) Retrieve snapshots which have been created as the result of this schedule's execution. +
              #### [getType](/reference/services/SoftLayer_Network_Storage_Schedule/getType) Retrieve the type provides a standardized definition for a schedule. +
              #### [getVolume](/reference/services/SoftLayer_Network_Storage_Schedule/getVolume) Retrieve the associated volume for a schedule. +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/createObject.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/createObject.md index c822607ae2..6a0fe790c8 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/createObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::createObject + Create a nas volume schedule diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/deleteObject.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/deleteObject.md index 0f2c7e2bb4..f651c76a5e 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::deleteObject + Delete a network storage schedule diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/editObject.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/editObject.md index b0804dc4b3..5bc3458d5c 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/editObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::editObject + Edit a nas volume schedule diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/getDay.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/getDay.md index 9df87ba83a..80617b4c22 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/getDay.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/getDay.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::getDay + Retrieve the hour parameter of this schedule. diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/getDayOfMonth.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/getDayOfMonth.md index cd635cafec..5a339e13af 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/getDayOfMonth.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/getDayOfMonth.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::getDayOfMonth + Retrieve the day of the month parameter of this schedule. diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/getDayOfWeek.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/getDayOfWeek.md index fc644006b7..f925fab6a7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/getDayOfWeek.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/getDayOfWeek.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::getDayOfWeek + Retrieve the day of the week parameter of this schedule. diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/getEvents.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/getEvents.md index 33448ca9d7..1e0f4d1ecc 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/getEvents.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/getEvents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::getEvents + Retrieve events which have been created as the result of a schedule execution. diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/getHour.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/getHour.md index 8458f7492b..7c7185ca07 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/getHour.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/getHour.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::getHour + Retrieve the hour parameter of this schedule. diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/getMinute.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/getMinute.md index be05ecbe72..7e2a2a24e7 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/getMinute.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/getMinute.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::getMinute + Retrieve the minute parameter of this schedule. diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/getMonthOfYear.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/getMonthOfYear.md index 663b5cf0ad..fdc0296181 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/getMonthOfYear.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/getMonthOfYear.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::getMonthOfYear + Retrieve the month of the year parameter of this schedule. diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/getObject.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/getObject.md index 1eca36766c..f49e6278ba 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::getObject + Retrieve a SoftLayer_Network_Storage_Schedule record. diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/getPartnership.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/getPartnership.md index e9347c55a7..18d5caabf2 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/getPartnership.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/getPartnership.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::getPartnership + Retrieve the associated partnership for a schedule. diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/getProperties.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/getProperties.md index c5aaf41e28..815e0666a5 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/getProperties.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/getProperties.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::getProperties + Retrieve properties used for configuration of a schedule. diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/getReplicaSnapshots.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/getReplicaSnapshots.md index d96f876463..9031bc48f1 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/getReplicaSnapshots.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/getReplicaSnapshots.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::getReplicaSnapshots + Retrieve replica snapshots which have been created as the result of this schedule's execution. diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/getRetentionCount.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/getRetentionCount.md index 3a79bf2e54..9ce04d6144 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/getRetentionCount.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/getRetentionCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::getRetentionCount + Retrieve the number of snapshots this schedule is configured to retain. diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/getSecond.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/getSecond.md index feeccd11fd..e02f7c6e3d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/getSecond.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/getSecond.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::getSecond + Retrieve the minute parameter of this schedule. diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/getSnapshots.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/getSnapshots.md index 1c3d91a761..62db17330d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/getSnapshots.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/getSnapshots.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::getSnapshots + Retrieve snapshots which have been created as the result of this schedule's execution. diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/getType.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/getType.md index d7c5358d63..b1238e080a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/getType.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::getType + Retrieve the type provides a standardized definition for a schedule. diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule/getVolume.md b/content/reference/services/SoftLayer_Network_Storage_Schedule/getVolume.md index efaf400f96..408d57c074 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule/getVolume.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule/getVolume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule](/reference/services/SoftLayer_Network_Storage_Schedule)::getVolume + Retrieve the associated volume for a schedule. diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule_Property_Type/_index.md b/content/reference/services/SoftLayer_Network_Storage_Schedule_Property_Type/_index.md index cfdccf2517..a898f60292 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule_Property_Type/_index.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule_Property_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Network_Storage_Schedule_Property_Type/getAllObjects) Returns all network storage schedule property types +
              #### [getObject](/reference/services/SoftLayer_Network_Storage_Schedule_Property_Type/getObject) Retrieve a SoftLayer_Network_Storage_Schedule_Property_Type record. +
              diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule_Property_Type/getAllObjects.md b/content/reference/services/SoftLayer_Network_Storage_Schedule_Property_Type/getAllObjects.md index 5dcfc1e4ce..bf13aff25d 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule_Property_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule_Property_Type/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule_Property_Type](/reference/services/SoftLayer_Network_Storage_Schedule_Property_Type)::getAllObjects + Returns all network storage schedule property types diff --git a/content/reference/services/SoftLayer_Network_Storage_Schedule_Property_Type/getObject.md b/content/reference/services/SoftLayer_Network_Storage_Schedule_Property_Type/getObject.md index f97915e25a..9d5876891a 100644 --- a/content/reference/services/SoftLayer_Network_Storage_Schedule_Property_Type/getObject.md +++ b/content/reference/services/SoftLayer_Network_Storage_Schedule_Property_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Storage_Schedule_Property_Type](/reference/services/SoftLayer_Network_Storage_Schedule_Property_Type)::getObject + Retrieve a SoftLayer_Network_Storage_Schedule_Property_Type record. diff --git a/content/reference/services/SoftLayer_Network_Subnet/_index.md b/content/reference/services/SoftLayer_Network_Subnet/_index.md index dd59d5972c..efb338df31 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/_index.md +++ b/content/reference/services/SoftLayer_Network_Subnet/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Every SoftLayer ip address is associated with a subnet which is defined in the SoftLayer_Network_Subnet service. SoftLayer subnets define a group of ip addresses and are assigned to a SoftLayer_Network_Vlan. The SoftLayer_Network_Subnet service gives you information about your subnet such as your network address, broadcast address, the subnet gateway address, and the total number of IP addresses within the subnet. Use the data returned by these methods with other API services to get more detailed information about your services. Along with VLANs, subnets are an integral part of the SoftLayer network. Each server ordered by SoftLayer comes with at least one public and one private subnet, with more available for order in the customer portal. Subnets exist in the SoftLayer network as either interfaces on a VLAN or as route destination from an IP address or VLAN. @@ -63,330 +65,394 @@ SoftLayer customers can order and manage subnets through the customer portal. If #### [allowAccessToNetworkStorage](/reference/services/SoftLayer_Network_Subnet/allowAccessToNetworkStorage) Allow access to a SoftLayer_Network_Storage volume from this device. +
              #### [allowAccessToNetworkStorageList](/reference/services/SoftLayer_Network_Subnet/allowAccessToNetworkStorageList) Allow access to multiple SoftLayer_Network_Storage volumes from this device. +
              #### [clearRoute](/reference/services/SoftLayer_Network_Subnet/clearRoute) +
              #### [createReverseDomainRecords](/reference/services/SoftLayer_Network_Subnet/createReverseDomainRecords) Create the default PTR records for this subnet +
              -
              +
              #### [createSubnetRouteUpdateTransaction](/reference/services/SoftLayer_Network_Subnet/createSubnetRouteUpdateTransaction) create a new transaction to modify a subnet route. + +Deprecated + +
              -
              +
              #### [createSwipTransaction](/reference/services/SoftLayer_Network_Subnet/createSwipTransaction) create a SWIP transaction for a subnet + +Deprecated + +
              #### [editNote](/reference/services/SoftLayer_Network_Subnet/editNote) Edit the note for this subnet. +
              -
              +
              #### [findAllSubnetsAndActiveSwipTransactionStatus](/reference/services/SoftLayer_Network_Subnet/findAllSubnetsAndActiveSwipTransactionStatus) Retrieve a list of subnets along with their SWIP transaction statuses. + +Deprecated + +
              #### [getAccount](/reference/services/SoftLayer_Network_Subnet/getAccount) +
              #### [getActiveRegistration](/reference/services/SoftLayer_Network_Subnet/getActiveRegistration) Retrieve if present, the active registration for this subnet. +
              #### [getActiveSwipTransaction](/reference/services/SoftLayer_Network_Subnet/getActiveSwipTransaction) Retrieval: DEPRECATED +
              #### [getActiveTransaction](/reference/services/SoftLayer_Network_Subnet/getActiveTransaction) Retrieval: DEPRECATED +
              #### [getAddressSpace](/reference/services/SoftLayer_Network_Subnet/getAddressSpace) Retrieve identifier which distinguishes what classification of addresses the subnet represents. +
              #### [getAllowedHost](/reference/services/SoftLayer_Network_Subnet/getAllowedHost) Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this Subnet to Network Storage supporting access control lists. +
              #### [getAllowedNetworkStorage](/reference/services/SoftLayer_Network_Subnet/getAllowedNetworkStorage) Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. +
              #### [getAllowedNetworkStorageReplicas](/reference/services/SoftLayer_Network_Subnet/getAllowedNetworkStorageReplicas) Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. +
              #### [getAttachedNetworkStorages](/reference/services/SoftLayer_Network_Subnet/getAttachedNetworkStorages) Return a list of SoftLayer_Network_Storage volumes authorized to this device. +
              #### [getAvailableNetworkStorages](/reference/services/SoftLayer_Network_Subnet/getAvailableNetworkStorages) Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. +
              #### [getBillingItem](/reference/services/SoftLayer_Network_Subnet/getBillingItem) Retrieve the billing item for a subnet. +
              #### [getBoundDescendants](/reference/services/SoftLayer_Network_Subnet/getBoundDescendants) +
              #### [getBoundRouterFlag](/reference/services/SoftLayer_Network_Subnet/getBoundRouterFlag) Retrieve whether or not this subnet is associated with a router. Subnets that are not associated with a router cannot be routed. +
              #### [getBoundRouters](/reference/services/SoftLayer_Network_Subnet/getBoundRouters) +
              #### [getChildren](/reference/services/SoftLayer_Network_Subnet/getChildren) +
              #### [getDatacenter](/reference/services/SoftLayer_Network_Subnet/getDatacenter) Retrieve the data center this subnet may be routed within. +
              #### [getDescendants](/reference/services/SoftLayer_Network_Subnet/getDescendants) +
              #### [getDisplayLabel](/reference/services/SoftLayer_Network_Subnet/getDisplayLabel) +
              #### [getEndPointIpAddress](/reference/services/SoftLayer_Network_Subnet/getEndPointIpAddress) Retrieve a static routed ip address +
              #### [getGlobalIpRecord](/reference/services/SoftLayer_Network_Subnet/getGlobalIpRecord) +
              #### [getHardware](/reference/services/SoftLayer_Network_Subnet/getHardware) Retrieve the hardware using IP addresses on this subnet. +
              #### [getIpAddresses](/reference/services/SoftLayer_Network_Subnet/getIpAddresses) Retrieve all the ip addresses associated with a subnet. +
              #### [getNetworkComponentFirewall](/reference/services/SoftLayer_Network_Subnet/getNetworkComponentFirewall) Retrieve the upstream network component firewall. +
              #### [getNetworkProtectionAddresses](/reference/services/SoftLayer_Network_Subnet/getNetworkProtectionAddresses) +
              #### [getNetworkTunnelContexts](/reference/services/SoftLayer_Network_Subnet/getNetworkTunnelContexts) Retrieve iPSec network tunnels that have access to a private subnet. +
              #### [getNetworkVlan](/reference/services/SoftLayer_Network_Subnet/getNetworkVlan) Retrieve the VLAN object that a subnet is associated with. +
              #### [getObject](/reference/services/SoftLayer_Network_Subnet/getObject) Retrieve a SoftLayer_Network_Subnet record. +
              #### [getPodName](/reference/services/SoftLayer_Network_Subnet/getPodName) Retrieve the pod in which this subnet resides. +
              #### [getProtectedIpAddresses](/reference/services/SoftLayer_Network_Subnet/getProtectedIpAddresses) +
              #### [getRegionalInternetRegistry](/reference/services/SoftLayer_Network_Subnet/getRegionalInternetRegistry) +
              #### [getRegistrations](/reference/services/SoftLayer_Network_Subnet/getRegistrations) Retrieve all registrations that have been created for this subnet. +
              #### [getReverseDomain](/reference/services/SoftLayer_Network_Subnet/getReverseDomain) Retrieve the reverse DNS domain associated with this subnet. +
              #### [getReverseDomainRecords](/reference/services/SoftLayer_Network_Subnet/getReverseDomainRecords) Retrieve all reverse DNS records associated with a subnet. +
              #### [getRoleKeyName](/reference/services/SoftLayer_Network_Subnet/getRoleKeyName) Retrieve an identifier of the role the subnet is within. Roles dictate how a subnet may be used. +
              #### [getRoleName](/reference/services/SoftLayer_Network_Subnet/getRoleName) Retrieve the name of the role the subnet is within. Roles dictate how a subnet may be used. +
              #### [getRoutableEndpointIpAddresses](/reference/services/SoftLayer_Network_Subnet/getRoutableEndpointIpAddresses) Retrieve IP addresses which may be used as a routing endpoint from a subnet. +
              #### [getRoutingTypeKeyName](/reference/services/SoftLayer_Network_Subnet/getRoutingTypeKeyName) Retrieve the identifier for the type of route then subnet is currently configured for. +
              #### [getRoutingTypeName](/reference/services/SoftLayer_Network_Subnet/getRoutingTypeName) Retrieve the name for the type of route then subnet is currently configured for. +
              #### [getSubnetForIpAddress](/reference/services/SoftLayer_Network_Subnet/getSubnetForIpAddress) Retrieve an IP addresses's associated subnet. +
              #### [getSwipTransaction](/reference/services/SoftLayer_Network_Subnet/getSwipTransaction) Retrieval: DEPRECATED +
              #### [getTagReferences](/reference/services/SoftLayer_Network_Subnet/getTagReferences) Retrieve references to all tags for this subnet. +
              #### [getUnboundDescendants](/reference/services/SoftLayer_Network_Subnet/getUnboundDescendants) +
              #### [getUtilizedIpAddressCount](/reference/services/SoftLayer_Network_Subnet/getUtilizedIpAddressCount) Retrieve provides the total number of utilized IP addresses on this subnet. The primary consumer of IP addresses are compute resources, which can consume more than one address. This value is only supported for primary subnet types. +
              #### [getVirtualGuests](/reference/services/SoftLayer_Network_Subnet/getVirtualGuests) Retrieve the Virtual Servers using IP addresses on this subnet. +
              #### [removeAccessToNetworkStorageList](/reference/services/SoftLayer_Network_Subnet/removeAccessToNetworkStorageList) Remove access to multiple SoftLayer_Network_Storage volumes from this device. +
              #### [route](/reference/services/SoftLayer_Network_Subnet/route) +
              #### [setTags](/reference/services/SoftLayer_Network_Subnet/setTags) +
              diff --git a/content/reference/services/SoftLayer_Network_Subnet/allowAccessToNetworkStorage.md b/content/reference/services/SoftLayer_Network_Subnet/allowAccessToNetworkStorage.md index 5dbcc9bacc..2b44ebfed2 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/allowAccessToNetworkStorage.md +++ b/content/reference/services/SoftLayer_Network_Subnet/allowAccessToNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::allowAccessToNetworkStorage + Allow access to a SoftLayer_Network_Storage volume from this device. diff --git a/content/reference/services/SoftLayer_Network_Subnet/allowAccessToNetworkStorageList.md b/content/reference/services/SoftLayer_Network_Subnet/allowAccessToNetworkStorageList.md index b2846ffc4a..30a0c66353 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/allowAccessToNetworkStorageList.md +++ b/content/reference/services/SoftLayer_Network_Subnet/allowAccessToNetworkStorageList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::allowAccessToNetworkStorageList + Allow access to multiple SoftLayer_Network_Storage volumes from this device. diff --git a/content/reference/services/SoftLayer_Network_Subnet/clearRoute.md b/content/reference/services/SoftLayer_Network_Subnet/clearRoute.md index 4107ac5aa7..deeee266a1 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/clearRoute.md +++ b/content/reference/services/SoftLayer_Network_Subnet/clearRoute.md @@ -16,6 +16,7 @@ aliases: + ## Overview This interface allows you to remove the route of your Account Owned subnets. The result will be a subnet that is no longer routed on the network. Remove the route of subnets you are not actively using, as it will make it easier to identify available subnets later. diff --git a/content/reference/services/SoftLayer_Network_Subnet/createReverseDomainRecords.md b/content/reference/services/SoftLayer_Network_Subnet/createReverseDomainRecords.md index c0ab384588..d735f1c721 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/createReverseDomainRecords.md +++ b/content/reference/services/SoftLayer_Network_Subnet/createReverseDomainRecords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::createReverseDomainRecords + Create the default PTR records for this subnet diff --git a/content/reference/services/SoftLayer_Network_Subnet/createSubnetRouteUpdateTransaction.md b/content/reference/services/SoftLayer_Network_Subnet/createSubnetRouteUpdateTransaction.md index 6cfde7928e..211bc29d03 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/createSubnetRouteUpdateTransaction.md +++ b/content/reference/services/SoftLayer_Network_Subnet/createSubnetRouteUpdateTransaction.md @@ -14,6 +14,8 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::createSubnetRouteUpdateTransaction +
              Deprecated
              + create a new transaction to modify a subnet route. diff --git a/content/reference/services/SoftLayer_Network_Subnet/createSwipTransaction.md b/content/reference/services/SoftLayer_Network_Subnet/createSwipTransaction.md index 47f38df7a1..9ba8dbc252 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/createSwipTransaction.md +++ b/content/reference/services/SoftLayer_Network_Subnet/createSwipTransaction.md @@ -14,6 +14,8 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::createSwipTransaction +
              Deprecated
              + create a SWIP transaction for a subnet diff --git a/content/reference/services/SoftLayer_Network_Subnet/editNote.md b/content/reference/services/SoftLayer_Network_Subnet/editNote.md index e3480d1897..4b514f734c 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/editNote.md +++ b/content/reference/services/SoftLayer_Network_Subnet/editNote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::editNote + Edit the note for this subnet. diff --git a/content/reference/services/SoftLayer_Network_Subnet/findAllSubnetsAndActiveSwipTransactionStatus.md b/content/reference/services/SoftLayer_Network_Subnet/findAllSubnetsAndActiveSwipTransactionStatus.md index b3e77d2ef1..24fa98277b 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/findAllSubnetsAndActiveSwipTransactionStatus.md +++ b/content/reference/services/SoftLayer_Network_Subnet/findAllSubnetsAndActiveSwipTransactionStatus.md @@ -14,6 +14,8 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::findAllSubnetsAndActiveSwipTransactionStatus +
              Deprecated
              + Retrieve a list of subnets along with their SWIP transaction statuses. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getAccount.md b/content/reference/services/SoftLayer_Network_Subnet/getAccount.md index f4fd5d64ab..cf0cf241b1 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Subnet/getActiveRegistration.md b/content/reference/services/SoftLayer_Network_Subnet/getActiveRegistration.md index a4be2fe03e..8c47d9ddbd 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getActiveRegistration.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getActiveRegistration.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getActiveRegistration + Retrieve if present, the active registration for this subnet. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getActiveSwipTransaction.md b/content/reference/services/SoftLayer_Network_Subnet/getActiveSwipTransaction.md index 5744bb6b02..0391fc49e6 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getActiveSwipTransaction.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getActiveSwipTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getActiveSwipTransaction + Retrieval: DEPRECATED diff --git a/content/reference/services/SoftLayer_Network_Subnet/getActiveTransaction.md b/content/reference/services/SoftLayer_Network_Subnet/getActiveTransaction.md index a7da6bb2ad..2a96bb966f 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getActiveTransaction.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getActiveTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getActiveTransaction + Retrieval: DEPRECATED diff --git a/content/reference/services/SoftLayer_Network_Subnet/getAddressSpace.md b/content/reference/services/SoftLayer_Network_Subnet/getAddressSpace.md index 9ad025bd8a..d92a6b1e9d 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getAddressSpace.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getAddressSpace.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getAddressSpace + Retrieve identifier which distinguishes what classification of addresses the subnet represents. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getAllowedHost.md b/content/reference/services/SoftLayer_Network_Subnet/getAllowedHost.md index ae7dbf5a03..23ed4880dc 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getAllowedHost.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getAllowedHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getAllowedHost + Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this Subnet to Network Storage supporting access control lists. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getAllowedNetworkStorage.md b/content/reference/services/SoftLayer_Network_Subnet/getAllowedNetworkStorage.md index f9048f3c49..1aedec8d7e 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getAllowedNetworkStorage.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getAllowedNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getAllowedNetworkStorage + Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getAllowedNetworkStorageReplicas.md b/content/reference/services/SoftLayer_Network_Subnet/getAllowedNetworkStorageReplicas.md index 86a46c317e..48687fff81 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getAllowedNetworkStorageReplicas.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getAllowedNetworkStorageReplicas.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getAllowedNetworkStorageReplicas + Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getAttachedNetworkStorages.md b/content/reference/services/SoftLayer_Network_Subnet/getAttachedNetworkStorages.md index ab2bfe2505..9ff4fb85a2 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getAttachedNetworkStorages.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getAttachedNetworkStorages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getAttachedNetworkStorages + Return a list of SoftLayer_Network_Storage volumes authorized to this device. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getAvailableNetworkStorages.md b/content/reference/services/SoftLayer_Network_Subnet/getAvailableNetworkStorages.md index d20c8f42d6..e84fc045c3 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getAvailableNetworkStorages.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getAvailableNetworkStorages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getAvailableNetworkStorages + Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getBillingItem.md b/content/reference/services/SoftLayer_Network_Subnet/getBillingItem.md index 47546888d4..54f899a26b 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getBillingItem + Retrieve the billing item for a subnet. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getBoundDescendants.md b/content/reference/services/SoftLayer_Network_Subnet/getBoundDescendants.md index cec9fd1647..0e33e7f6eb 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getBoundDescendants.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getBoundDescendants.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Subnet/getBoundRouterFlag.md b/content/reference/services/SoftLayer_Network_Subnet/getBoundRouterFlag.md index fff85de9be..bc0e4fb7cf 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getBoundRouterFlag.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getBoundRouterFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getBoundRouterFlag + Retrieve whether or not this subnet is associated with a router. Subnets that are not associated with a router cannot be routed. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getBoundRouters.md b/content/reference/services/SoftLayer_Network_Subnet/getBoundRouters.md index e3a4788963..248cca39f6 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getBoundRouters.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getBoundRouters.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Subnet/getChildren.md b/content/reference/services/SoftLayer_Network_Subnet/getChildren.md index f81d7e7783..582192892a 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getChildren.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getChildren.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Subnet/getDatacenter.md b/content/reference/services/SoftLayer_Network_Subnet/getDatacenter.md index 05349e7163..efdc2e92ec 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getDatacenter.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getDatacenter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getDatacenter + Retrieve the data center this subnet may be routed within. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getDescendants.md b/content/reference/services/SoftLayer_Network_Subnet/getDescendants.md index 53d024b405..5d2b75961c 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getDescendants.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getDescendants.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Subnet/getDisplayLabel.md b/content/reference/services/SoftLayer_Network_Subnet/getDisplayLabel.md index 1d341fb35a..97eb1c4772 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getDisplayLabel.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getDisplayLabel.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Subnet/getEndPointIpAddress.md b/content/reference/services/SoftLayer_Network_Subnet/getEndPointIpAddress.md index 1d5609c52a..6ce1246310 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getEndPointIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getEndPointIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getEndPointIpAddress + Retrieve a static routed ip address diff --git a/content/reference/services/SoftLayer_Network_Subnet/getGlobalIpRecord.md b/content/reference/services/SoftLayer_Network_Subnet/getGlobalIpRecord.md index 8e6e527222..d5cfc12f84 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getGlobalIpRecord.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getGlobalIpRecord.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Subnet/getHardware.md b/content/reference/services/SoftLayer_Network_Subnet/getHardware.md index 308fd97b4d..05f9551a11 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getHardware.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getHardware + Retrieve the hardware using IP addresses on this subnet. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getIpAddresses.md b/content/reference/services/SoftLayer_Network_Subnet/getIpAddresses.md index 5a20a5ed39..37595d4d9c 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getIpAddresses + Retrieve all the ip addresses associated with a subnet. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getNetworkComponentFirewall.md b/content/reference/services/SoftLayer_Network_Subnet/getNetworkComponentFirewall.md index f4949b00d4..9486f55ed0 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getNetworkComponentFirewall.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getNetworkComponentFirewall.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getNetworkComponentFirewall + Retrieve the upstream network component firewall. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getNetworkProtectionAddresses.md b/content/reference/services/SoftLayer_Network_Subnet/getNetworkProtectionAddresses.md index be0b2e3007..2467ed5a4d 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getNetworkProtectionAddresses.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getNetworkProtectionAddresses.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Subnet/getNetworkTunnelContexts.md b/content/reference/services/SoftLayer_Network_Subnet/getNetworkTunnelContexts.md index efa6b8a2b2..f5bd8ab285 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getNetworkTunnelContexts.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getNetworkTunnelContexts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getNetworkTunnelContexts + Retrieve iPSec network tunnels that have access to a private subnet. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getNetworkVlan.md b/content/reference/services/SoftLayer_Network_Subnet/getNetworkVlan.md index ac8849765d..9afa3dd808 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getNetworkVlan.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getNetworkVlan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getNetworkVlan + Retrieve the VLAN object that a subnet is associated with. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getObject.md b/content/reference/services/SoftLayer_Network_Subnet/getObject.md index 27a8170177..724da6406a 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getObject.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getObject + Retrieve a SoftLayer_Network_Subnet record. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getPodName.md b/content/reference/services/SoftLayer_Network_Subnet/getPodName.md index dadc5e80b9..0aff717ebd 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getPodName.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getPodName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getPodName + Retrieve the pod in which this subnet resides. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getProtectedIpAddresses.md b/content/reference/services/SoftLayer_Network_Subnet/getProtectedIpAddresses.md index d67b6a9f57..f956c36c49 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getProtectedIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getProtectedIpAddresses.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Subnet/getRegionalInternetRegistry.md b/content/reference/services/SoftLayer_Network_Subnet/getRegionalInternetRegistry.md index 09e80349e4..80d6edb54f 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getRegionalInternetRegistry.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getRegionalInternetRegistry.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Subnet/getRegistrations.md b/content/reference/services/SoftLayer_Network_Subnet/getRegistrations.md index 610632cd34..32791b6339 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getRegistrations.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getRegistrations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getRegistrations + Retrieve all registrations that have been created for this subnet. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getReverseDomain.md b/content/reference/services/SoftLayer_Network_Subnet/getReverseDomain.md index 5d731659e2..0dccdaf137 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getReverseDomain.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getReverseDomain.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getReverseDomain + Retrieve the reverse DNS domain associated with this subnet. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getReverseDomainRecords.md b/content/reference/services/SoftLayer_Network_Subnet/getReverseDomainRecords.md index 2b90587660..ddb7e66b36 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getReverseDomainRecords.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getReverseDomainRecords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getReverseDomainRecords + Retrieve all reverse DNS records associated with a subnet. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getRoleKeyName.md b/content/reference/services/SoftLayer_Network_Subnet/getRoleKeyName.md index 566480503c..897f5ca3da 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getRoleKeyName.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getRoleKeyName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getRoleKeyName + Retrieve an identifier of the role the subnet is within. Roles dictate how a subnet may be used. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getRoleName.md b/content/reference/services/SoftLayer_Network_Subnet/getRoleName.md index 4635c9f4d9..5447493e54 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getRoleName.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getRoleName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getRoleName + Retrieve the name of the role the subnet is within. Roles dictate how a subnet may be used. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getRoutableEndpointIpAddresses.md b/content/reference/services/SoftLayer_Network_Subnet/getRoutableEndpointIpAddresses.md index efc73c7ccd..3c83711b86 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getRoutableEndpointIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getRoutableEndpointIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getRoutableEndpointIpAddresses + Retrieve IP addresses which may be used as a routing endpoint from a subnet. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getRoutingTypeKeyName.md b/content/reference/services/SoftLayer_Network_Subnet/getRoutingTypeKeyName.md index 5aee6489f7..5f338bd01a 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getRoutingTypeKeyName.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getRoutingTypeKeyName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getRoutingTypeKeyName + Retrieve the identifier for the type of route then subnet is currently configured for. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getRoutingTypeName.md b/content/reference/services/SoftLayer_Network_Subnet/getRoutingTypeName.md index 496c6aa89b..e803eb99b9 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getRoutingTypeName.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getRoutingTypeName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getRoutingTypeName + Retrieve the name for the type of route then subnet is currently configured for. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getSubnetForIpAddress.md b/content/reference/services/SoftLayer_Network_Subnet/getSubnetForIpAddress.md index 9c4013a3fe..748b2ce70b 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getSubnetForIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getSubnetForIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getSubnetForIpAddress + Retrieve an IP addresses's associated subnet. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getSwipTransaction.md b/content/reference/services/SoftLayer_Network_Subnet/getSwipTransaction.md index e63d91238f..2b7179561f 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getSwipTransaction.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getSwipTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getSwipTransaction + Retrieval: DEPRECATED diff --git a/content/reference/services/SoftLayer_Network_Subnet/getTagReferences.md b/content/reference/services/SoftLayer_Network_Subnet/getTagReferences.md index 670b2b093d..e1a47e262c 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getTagReferences.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getTagReferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getTagReferences + Retrieve references to all tags for this subnet. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getUnboundDescendants.md b/content/reference/services/SoftLayer_Network_Subnet/getUnboundDescendants.md index d6e9e0308b..1a80711d68 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getUnboundDescendants.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getUnboundDescendants.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Subnet/getUtilizedIpAddressCount.md b/content/reference/services/SoftLayer_Network_Subnet/getUtilizedIpAddressCount.md index 0faefe5b72..9aece9c450 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getUtilizedIpAddressCount.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getUtilizedIpAddressCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getUtilizedIpAddressCount + Retrieve provides the total number of utilized IP addresses on this subnet. The primary consumer of IP addresses are compute resources, which can consume more than one address. This value is only supported for primary subnet types. diff --git a/content/reference/services/SoftLayer_Network_Subnet/getVirtualGuests.md b/content/reference/services/SoftLayer_Network_Subnet/getVirtualGuests.md index b06d380f18..3a1afdb948 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/getVirtualGuests.md +++ b/content/reference/services/SoftLayer_Network_Subnet/getVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::getVirtualGuests + Retrieve the Virtual Servers using IP addresses on this subnet. diff --git a/content/reference/services/SoftLayer_Network_Subnet/removeAccessToNetworkStorageList.md b/content/reference/services/SoftLayer_Network_Subnet/removeAccessToNetworkStorageList.md index cd3b1b5c4e..c6282642db 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/removeAccessToNetworkStorageList.md +++ b/content/reference/services/SoftLayer_Network_Subnet/removeAccessToNetworkStorageList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet](/reference/services/SoftLayer_Network_Subnet)::removeAccessToNetworkStorageList + Remove access to multiple SoftLayer_Network_Storage volumes from this device. diff --git a/content/reference/services/SoftLayer_Network_Subnet/route.md b/content/reference/services/SoftLayer_Network_Subnet/route.md index 927ee9b365..c3dc771af7 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/route.md +++ b/content/reference/services/SoftLayer_Network_Subnet/route.md @@ -16,6 +16,7 @@ aliases: + ## Overview This interface allows you to change the route of your Account Owned subnets. It accommodates a number of ways to identify your desired routing destination through the use of a 'type' and 'identifier'. Subnets may be routed as either Static or Portable, and that designation is dictated by the routing destination specified. diff --git a/content/reference/services/SoftLayer_Network_Subnet/setTags.md b/content/reference/services/SoftLayer_Network_Subnet/setTags.md index 30cc164c08..ab31ac3baf 100644 --- a/content/reference/services/SoftLayer_Network_Subnet/setTags.md +++ b/content/reference/services/SoftLayer_Network_Subnet/setTags.md @@ -16,6 +16,7 @@ aliases: + ## Overview Tag a subnet by passing in one or more tags separated by a comma. Any existing tags you wish to keep should be included in the set of tags, as any missing tags will be removed. To remove all tags from the subnet, send an empty string. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/_index.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/_index.md index 4aa4a84dc0..acf1fa2fe2 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/_index.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + 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. @@ -64,222 +66,259 @@ SoftLayer customers can order and manage IP addresses through the customer porta #### [allowAccessToNetworkStorage](/reference/services/SoftLayer_Network_Subnet_IpAddress/allowAccessToNetworkStorage) Allow access to a SoftLayer_Network_Storage volume from this device. +
              #### [allowAccessToNetworkStorageList](/reference/services/SoftLayer_Network_Subnet_IpAddress/allowAccessToNetworkStorageList) Allow access to multiple SoftLayer_Network_Storage volumes from this device. +
              #### [editObject](/reference/services/SoftLayer_Network_Subnet_IpAddress/editObject) Edit the object by passing in a modified instance of the object +
              #### [editObjects](/reference/services/SoftLayer_Network_Subnet_IpAddress/editObjects) Edit multiple objects by passing in modified instances of the object. +
              #### [findByIpv4Address](/reference/services/SoftLayer_Network_Subnet_IpAddress/findByIpv4Address) Search for an IP address record by IPv4 address. +
              #### [getAllowedHost](/reference/services/SoftLayer_Network_Subnet_IpAddress/getAllowedHost) Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this IP Address to Network Storage supporting access control lists. +
              #### [getAllowedNetworkStorage](/reference/services/SoftLayer_Network_Subnet_IpAddress/getAllowedNetworkStorage) Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. +
              #### [getAllowedNetworkStorageReplicas](/reference/services/SoftLayer_Network_Subnet_IpAddress/getAllowedNetworkStorageReplicas) Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. +
              #### [getApplicationDeliveryController](/reference/services/SoftLayer_Network_Subnet_IpAddress/getApplicationDeliveryController) Retrieve the application delivery controller using this address. +
              #### [getAttachedNetworkStorages](/reference/services/SoftLayer_Network_Subnet_IpAddress/getAttachedNetworkStorages) Return a list of SoftLayer_Network_Storage volumes authorized to this device. +
              #### [getAvailableNetworkStorages](/reference/services/SoftLayer_Network_Subnet_IpAddress/getAvailableNetworkStorages) Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. +
              #### [getByIpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress/getByIpAddress) Search for an IP address record. +
              #### [getContextTunnelTranslations](/reference/services/SoftLayer_Network_Subnet_IpAddress/getContextTunnelTranslations) Retrieve an IPSec network tunnel's address translations. These translations use a SoftLayer ip address from an assigned static NAT subnet to deliver the packets to the remote (customer) destination. +
              #### [getEndpointSubnets](/reference/services/SoftLayer_Network_Subnet_IpAddress/getEndpointSubnets) Retrieve all the subnets routed to an IP address. +
              #### [getGuestNetworkComponent](/reference/services/SoftLayer_Network_Subnet_IpAddress/getGuestNetworkComponent) Retrieve a network component that is statically routed to an IP address. +
              #### [getGuestNetworkComponentBinding](/reference/services/SoftLayer_Network_Subnet_IpAddress/getGuestNetworkComponentBinding) Retrieve a network component that is statically routed to an IP address. +
              #### [getHardware](/reference/services/SoftLayer_Network_Subnet_IpAddress/getHardware) Retrieve a server that this IP address is routed to. +
              #### [getNetworkComponent](/reference/services/SoftLayer_Network_Subnet_IpAddress/getNetworkComponent) Retrieve a network component that is statically routed to an IP address. +
              #### [getObject](/reference/services/SoftLayer_Network_Subnet_IpAddress/getObject) Retrieve a SoftLayer_Network_Subnet_IpAddress record. +
              #### [getPrivateNetworkGateway](/reference/services/SoftLayer_Network_Subnet_IpAddress/getPrivateNetworkGateway) Retrieve the network gateway appliance using this address as the private IP address. +
              #### [getProtectionAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress/getProtectionAddress) +
              #### [getPublicNetworkGateway](/reference/services/SoftLayer_Network_Subnet_IpAddress/getPublicNetworkGateway) Retrieve the network gateway appliance using this address as the public IP address. +
              #### [getRemoteManagementNetworkComponent](/reference/services/SoftLayer_Network_Subnet_IpAddress/getRemoteManagementNetworkComponent) Retrieve an IPMI-based management network component of the IP address. +
              #### [getSubnet](/reference/services/SoftLayer_Network_Subnet_IpAddress/getSubnet) Retrieve an IP address' associated subnet. +
              #### [getSyslogEventsOneDay](/reference/services/SoftLayer_Network_Subnet_IpAddress/getSyslogEventsOneDay) Retrieve all events for this IP address stored in the datacenter syslogs from the last 24 hours +
              #### [getSyslogEventsSevenDays](/reference/services/SoftLayer_Network_Subnet_IpAddress/getSyslogEventsSevenDays) Retrieve all events for this IP address stored in the datacenter syslogs from the last 7 days +
              #### [getTopTenSyslogEventsByDestinationPortOneDay](/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByDestinationPortOneDay) Retrieve top Ten network datacenter syslog events, grouped by destination port, for the last 24 hours +
              #### [getTopTenSyslogEventsByDestinationPortSevenDays](/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByDestinationPortSevenDays) Retrieve top Ten network datacenter syslog events, grouped by destination port, for the last 7 days +
              #### [getTopTenSyslogEventsByProtocolsOneDay](/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByProtocolsOneDay) Retrieve top Ten network datacenter syslog events, grouped by source port, for the last 24 hours +
              #### [getTopTenSyslogEventsByProtocolsSevenDays](/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByProtocolsSevenDays) Retrieve top Ten network datacenter syslog events, grouped by source port, for the last 7 days +
              #### [getTopTenSyslogEventsBySourceIpOneDay](/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourceIpOneDay) Retrieve top Ten network datacenter syslog events, grouped by source ip address, for the last 24 hours +
              #### [getTopTenSyslogEventsBySourceIpSevenDays](/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourceIpSevenDays) Retrieve top Ten network datacenter syslog events, grouped by source ip address, for the last 7 days +
              #### [getTopTenSyslogEventsBySourcePortOneDay](/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourcePortOneDay) Retrieve top Ten network datacenter syslog events, grouped by source port, for the last 24 hours +
              #### [getTopTenSyslogEventsBySourcePortSevenDays](/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourcePortSevenDays) Retrieve top Ten network datacenter syslog events, grouped by source port, for the last 7 days +
              #### [getVirtualGuest](/reference/services/SoftLayer_Network_Subnet_IpAddress/getVirtualGuest) Retrieve a virtual guest that this IP address is routed to. +
              #### [getVirtualLicenses](/reference/services/SoftLayer_Network_Subnet_IpAddress/getVirtualLicenses) Retrieve virtual licenses allocated for an IP Address. +
              #### [removeAccessToNetworkStorageList](/reference/services/SoftLayer_Network_Subnet_IpAddress/removeAccessToNetworkStorageList) Remove access to multiple SoftLayer_Network_Storage volumes from this device. +
              diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/allowAccessToNetworkStorage.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/allowAccessToNetworkStorage.md index 46a3dda19b..a62187c609 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/allowAccessToNetworkStorage.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/allowAccessToNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::allowAccessToNetworkStorage + Allow access to a SoftLayer_Network_Storage volume from this device. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/allowAccessToNetworkStorageList.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/allowAccessToNetworkStorageList.md index 981d3c8f43..d0511ed0ca 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/allowAccessToNetworkStorageList.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/allowAccessToNetworkStorageList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::allowAccessToNetworkStorageList + Allow access to multiple SoftLayer_Network_Storage volumes from this device. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/editObject.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/editObject.md index d240614f36..79665aedf5 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/editObject.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::editObject + Edit the object by passing in a modified instance of the object diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/editObjects.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/editObjects.md index 059eb12fdb..7e3f51394f 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/editObjects.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/editObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::editObjects + Edit multiple objects by passing in modified instances of the object. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/findByIpv4Address.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/findByIpv4Address.md index 3449438973..1f96746034 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/findByIpv4Address.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/findByIpv4Address.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::findByIpv4Address + Search for an IP address record by IPv4 address. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAllowedHost.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAllowedHost.md index e3ba2fbcab..9b73882e3e 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAllowedHost.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAllowedHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getAllowedHost + Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this IP Address to Network Storage supporting access control lists. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAllowedNetworkStorage.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAllowedNetworkStorage.md index 597520b35f..66d9b9da61 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAllowedNetworkStorage.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAllowedNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getAllowedNetworkStorage + Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAllowedNetworkStorageReplicas.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAllowedNetworkStorageReplicas.md index 7fc6ba65fb..1e8914fc03 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAllowedNetworkStorageReplicas.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAllowedNetworkStorageReplicas.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getAllowedNetworkStorageReplicas + Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getApplicationDeliveryController.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getApplicationDeliveryController.md index b46547cb6b..d57e46640b 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getApplicationDeliveryController.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getApplicationDeliveryController.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getApplicationDeliveryController + Retrieve the application delivery controller using this address. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAttachedNetworkStorages.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAttachedNetworkStorages.md index 8480511b1f..af7c124dc3 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAttachedNetworkStorages.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAttachedNetworkStorages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getAttachedNetworkStorages + Return a list of SoftLayer_Network_Storage volumes authorized to this device. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAvailableNetworkStorages.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAvailableNetworkStorages.md index adca161925..e9f4be3e08 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAvailableNetworkStorages.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getAvailableNetworkStorages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getAvailableNetworkStorages + Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getByIpAddress.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getByIpAddress.md index 028fad638a..5b46ed89a4 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getByIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getByIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getByIpAddress + Search for an IP address record. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getContextTunnelTranslations.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getContextTunnelTranslations.md index 91ded91bbc..63e8f95439 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getContextTunnelTranslations.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getContextTunnelTranslations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getContextTunnelTranslations + Retrieve an IPSec network tunnel's address translations. These translations use a SoftLayer ip address from an assigned static NAT subnet to deliver the packets to the remote (customer) destination. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getEndpointSubnets.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getEndpointSubnets.md index 473c0478a7..964634d534 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getEndpointSubnets.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getEndpointSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getEndpointSubnets + Retrieve all the subnets routed to an IP address. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getGuestNetworkComponent.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getGuestNetworkComponent.md index 14256f2a5d..788ea8fec8 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getGuestNetworkComponent.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getGuestNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getGuestNetworkComponent + Retrieve a network component that is statically routed to an IP address. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getGuestNetworkComponentBinding.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getGuestNetworkComponentBinding.md index 1b4379ee8e..fd5ff9bf98 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getGuestNetworkComponentBinding.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getGuestNetworkComponentBinding.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getGuestNetworkComponentBinding + Retrieve a network component that is statically routed to an IP address. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getHardware.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getHardware.md index 6db96a2c07..387fcc68ff 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getHardware.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getHardware + Retrieve a server that this IP address is routed to. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getNetworkComponent.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getNetworkComponent.md index 7a3517cb13..0520cf6585 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getNetworkComponent.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getNetworkComponent + Retrieve a network component that is statically routed to an IP address. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getObject.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getObject.md index 957ac0f187..486d4358ec 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getObject.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getObject + Retrieve a SoftLayer_Network_Subnet_IpAddress record. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getPrivateNetworkGateway.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getPrivateNetworkGateway.md index fde7ca7eb3..e7d21a14ad 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getPrivateNetworkGateway.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getPrivateNetworkGateway.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getPrivateNetworkGateway + Retrieve the network gateway appliance using this address as the private IP address. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getProtectionAddress.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getProtectionAddress.md index d5ed3d7c56..777d03bd2f 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getProtectionAddress.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getProtectionAddress.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getPublicNetworkGateway.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getPublicNetworkGateway.md index fd7c59a0c1..77c0e2dfab 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getPublicNetworkGateway.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getPublicNetworkGateway.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getPublicNetworkGateway + Retrieve the network gateway appliance using this address as the public IP address. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getRemoteManagementNetworkComponent.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getRemoteManagementNetworkComponent.md index f42b2b2ae4..9ff349b083 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getRemoteManagementNetworkComponent.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getRemoteManagementNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getRemoteManagementNetworkComponent + Retrieve an IPMI-based management network component of the IP address. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getSubnet.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getSubnet.md index 17ca4a3caf..3244ff1384 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getSubnet.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getSubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getSubnet + Retrieve an IP address' associated subnet. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getSyslogEventsOneDay.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getSyslogEventsOneDay.md index e464d6d4dd..711c4a07ef 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getSyslogEventsOneDay.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getSyslogEventsOneDay.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getSyslogEventsOneDay + Retrieve all events for this IP address stored in the datacenter syslogs from the last 24 hours diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getSyslogEventsSevenDays.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getSyslogEventsSevenDays.md index 4c0ae3312f..dfb1727d7c 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getSyslogEventsSevenDays.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getSyslogEventsSevenDays.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getSyslogEventsSevenDays + Retrieve all events for this IP address stored in the datacenter syslogs from the last 7 days diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByDestinationPortOneDay.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByDestinationPortOneDay.md index 839513dc13..f7ea9fc37e 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByDestinationPortOneDay.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByDestinationPortOneDay.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getTopTenSyslogEventsByDestinationPortOneDay + Retrieve top Ten network datacenter syslog events, grouped by destination port, for the last 24 hours diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByDestinationPortSevenDays.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByDestinationPortSevenDays.md index 9336b66055..cc42ca6018 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByDestinationPortSevenDays.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByDestinationPortSevenDays.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getTopTenSyslogEventsByDestinationPortSevenDays + Retrieve top Ten network datacenter syslog events, grouped by destination port, for the last 7 days diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByProtocolsOneDay.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByProtocolsOneDay.md index 687e9836d9..58a03cd2f3 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByProtocolsOneDay.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByProtocolsOneDay.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getTopTenSyslogEventsByProtocolsOneDay + Retrieve top Ten network datacenter syslog events, grouped by source port, for the last 24 hours diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByProtocolsSevenDays.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByProtocolsSevenDays.md index f8a13a304a..fad745d5af 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByProtocolsSevenDays.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsByProtocolsSevenDays.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getTopTenSyslogEventsByProtocolsSevenDays + Retrieve top Ten network datacenter syslog events, grouped by source port, for the last 7 days diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourceIpOneDay.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourceIpOneDay.md index 56e5be562c..fd1299c8aa 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourceIpOneDay.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourceIpOneDay.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getTopTenSyslogEventsBySourceIpOneDay + Retrieve top Ten network datacenter syslog events, grouped by source ip address, for the last 24 hours diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourceIpSevenDays.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourceIpSevenDays.md index 35b3fba7b8..cfeda1c8e1 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourceIpSevenDays.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourceIpSevenDays.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getTopTenSyslogEventsBySourceIpSevenDays + Retrieve top Ten network datacenter syslog events, grouped by source ip address, for the last 7 days diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourcePortOneDay.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourcePortOneDay.md index bf4d8150ff..88e541ffee 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourcePortOneDay.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourcePortOneDay.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getTopTenSyslogEventsBySourcePortOneDay + Retrieve top Ten network datacenter syslog events, grouped by source port, for the last 24 hours diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourcePortSevenDays.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourcePortSevenDays.md index ba21c146d0..ff837fb789 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourcePortSevenDays.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getTopTenSyslogEventsBySourcePortSevenDays.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getTopTenSyslogEventsBySourcePortSevenDays + Retrieve top Ten network datacenter syslog events, grouped by source port, for the last 7 days diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getVirtualGuest.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getVirtualGuest.md index 723d6079f4..e9166e6b23 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getVirtualGuest.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getVirtualGuest + Retrieve a virtual guest that this IP address is routed to. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getVirtualLicenses.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getVirtualLicenses.md index 97702aac98..5d307f65f8 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getVirtualLicenses.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/getVirtualLicenses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::getVirtualLicenses + Retrieve virtual licenses allocated for an IP Address. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/removeAccessToNetworkStorageList.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/removeAccessToNetworkStorageList.md index 4b9c9c310b..de52b8dc48 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress/removeAccessToNetworkStorageList.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress/removeAccessToNetworkStorageList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress)::removeAccessToNetworkStorageList + Remove access to multiple SoftLayer_Network_Storage volumes from this device. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/_index.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/_index.md index ecae87615a..504d9f00b5 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/_index.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,48 +44,62 @@ Global IP Addresses are static IP addresses that can be routed to any server wit #### [getAccount](/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getAccount) +
              #### [getActiveTransaction](/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getActiveTransaction) Retrieval: DEPRECATED +
              #### [getBillingItem](/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getBillingItem) Retrieve the billing item for this Global IP. +
              #### [getDestinationIpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getDestinationIpAddress) +
              #### [getIpAddress](/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getIpAddress) +
              #### [getObject](/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getObject) Retrieve a SoftLayer_Network_Subnet_IpAddress_Global record. +
              -
              +
              #### [route](/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/route) + +Deprecated + +
              -
              +
              #### [unroute](/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/unroute) + +Deprecated + +
              diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getAccount.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getAccount.md index c37fe6142d..6792af7a2b 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getActiveTransaction.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getActiveTransaction.md index ac3e30ef58..c06d8a9aeb 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getActiveTransaction.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getActiveTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress_Global](/reference/services/SoftLayer_Network_Subnet_IpAddress_Global)::getActiveTransaction + Retrieval: DEPRECATED diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getBillingItem.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getBillingItem.md index 53919e6b36..a67429b1a1 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress_Global](/reference/services/SoftLayer_Network_Subnet_IpAddress_Global)::getBillingItem + Retrieve the billing item for this Global IP. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getDestinationIpAddress.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getDestinationIpAddress.md index 7de102660f..737c84dbae 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getDestinationIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getDestinationIpAddress.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getIpAddress.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getIpAddress.md index f0b353584f..4c4ebd00c5 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getIpAddress.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getObject.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getObject.md index 6ded384432..b68d8fdab6 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getObject.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress_Global](/reference/services/SoftLayer_Network_Subnet_IpAddress_Global)::getObject + Retrieve a SoftLayer_Network_Subnet_IpAddress_Global record. diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/route.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/route.md index 414cbdb15a..d23af28d6d 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/route.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/route.md @@ -14,6 +14,8 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress_Global](/reference/services/SoftLayer_Network_Subnet_IpAddress_Global)::route +
              Deprecated
              + diff --git a/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/unroute.md b/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/unroute.md index 8f93383d06..53c0ec86bb 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/unroute.md +++ b/content/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/unroute.md @@ -14,6 +14,8 @@ aliases: --- # [SoftLayer_Network_Subnet_IpAddress_Global](/reference/services/SoftLayer_Network_Subnet_IpAddress_Global)::unroute +
              Deprecated
              + diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/_index.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/_index.md index 44ce26beb0..7c42127a54 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/_index.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + Subnet registration objects are used to request and track registration of the subnet with the appropriate Regional Internet Registry (RIR). Registration for public subnets can be requested any time after assignment of the subnet. Subnet Registration objects can be updated any time after they are created. This will result in the information being submitted to the RIR and the records on their end being refreshed. @@ -44,90 +46,105 @@ Subnet Registration objects can be updated any time after they are created. This #### [clearRegistration](/reference/services/SoftLayer_Network_Subnet_Registration/clearRegistration) Clear an existing registration +
              #### [createObject](/reference/services/SoftLayer_Network_Subnet_Registration/createObject) Create a new subnet registration +
              #### [createObjects](/reference/services/SoftLayer_Network_Subnet_Registration/createObjects) Create registrations for multiple subnets +
              #### [editObject](/reference/services/SoftLayer_Network_Subnet_Registration/editObject) Edit an existing registration object +
              #### [editRegistrationAttachedDetails](/reference/services/SoftLayer_Network_Subnet_Registration/editRegistrationAttachedDetails) Modify the link between a [SoftLayer_Network_Subnet_Registration]({{}}) object and two [SoftLayer_Account_Regional_Registry_Detail]({{}}) objects simultaneously. +
              #### [getAccount](/reference/services/SoftLayer_Network_Subnet_Registration/getAccount) Retrieve the account that this registration belongs to. +
              #### [getDetailReferences](/reference/services/SoftLayer_Network_Subnet_Registration/getDetailReferences) Retrieve the cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail]({{}}) objects to the registration object. +
              #### [getEvents](/reference/services/SoftLayer_Network_Subnet_Registration/getEvents) Retrieve the related registration events. +
              #### [getNetworkDetail](/reference/services/SoftLayer_Network_Subnet_Registration/getNetworkDetail) Retrieve the "network" detail object. +
              #### [getObject](/reference/services/SoftLayer_Network_Subnet_Registration/getObject) Retrieve a SoftLayer_Network_Subnet_Registration record. +
              #### [getPersonDetail](/reference/services/SoftLayer_Network_Subnet_Registration/getPersonDetail) Retrieve the "person" detail object. +
              #### [getRegionalInternetRegistry](/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistry) Retrieve the related Regional Internet Registry. +
              #### [getRegionalInternetRegistryHandle](/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistryHandle) Retrieve the RIR handle that this registration object belongs to. This field may not be populated until the registration is complete. +
              #### [getStatus](/reference/services/SoftLayer_Network_Subnet_Registration/getStatus) Retrieve the status of this registration. +
              #### [getSubnet](/reference/services/SoftLayer_Network_Subnet_Registration/getSubnet) Retrieve the subnet that this registration pertains to. +
              diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/clearRegistration.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/clearRegistration.md index 8e925a4c08..6148dde9df 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/clearRegistration.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/clearRegistration.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration](/reference/services/SoftLayer_Network_Subnet_Registration)::clearRegistration + Clear an existing registration diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/createObject.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/createObject.md index 3ede03f17b..206765d823 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/createObject.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/createObject.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration](/reference/services/SoftLayer_Network_Subnet_Registration)::createObject + Create a new subnet registration diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/createObjects.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/createObjects.md index d5a0df7e50..e8d139e53f 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/createObjects.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/createObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration](/reference/services/SoftLayer_Network_Subnet_Registration)::createObjects + Create registrations for multiple subnets diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/editObject.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/editObject.md index aa333a60f2..a9ce669c4f 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/editObject.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration](/reference/services/SoftLayer_Network_Subnet_Registration)::editObject + Edit an existing registration object diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/editRegistrationAttachedDetails.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/editRegistrationAttachedDetails.md index 8cc930e2cd..6a0ea1d381 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/editRegistrationAttachedDetails.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/editRegistrationAttachedDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration](/reference/services/SoftLayer_Network_Subnet_Registration)::editRegistrationAttachedDetails + Modify the link between a [SoftLayer_Network_Subnet_Registration]({{}}) object and two [SoftLayer_Account_Regional_Registry_Detail]({{}}) objects simultaneously. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getAccount.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getAccount.md index 5dd5714717..cfd6cf3e51 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration](/reference/services/SoftLayer_Network_Subnet_Registration)::getAccount + Retrieve the account that this registration belongs to. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getDetailReferences.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getDetailReferences.md index b6f3e6f757..369817a7c4 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getDetailReferences.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getDetailReferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration](/reference/services/SoftLayer_Network_Subnet_Registration)::getDetailReferences + Retrieve the cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail]({{}}) objects to the registration object. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getEvents.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getEvents.md index 2f7a0ada62..db682f0bb8 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getEvents.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getEvents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration](/reference/services/SoftLayer_Network_Subnet_Registration)::getEvents + Retrieve the related registration events. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getNetworkDetail.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getNetworkDetail.md index 1a86bc132b..fba99420bb 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getNetworkDetail.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getNetworkDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration](/reference/services/SoftLayer_Network_Subnet_Registration)::getNetworkDetail + Retrieve the "network" detail object. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getObject.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getObject.md index 747e321757..25a19d9835 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getObject.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration](/reference/services/SoftLayer_Network_Subnet_Registration)::getObject + Retrieve a SoftLayer_Network_Subnet_Registration record. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getPersonDetail.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getPersonDetail.md index 124624022d..1a1d20810d 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getPersonDetail.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getPersonDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration](/reference/services/SoftLayer_Network_Subnet_Registration)::getPersonDetail + Retrieve the "person" detail object. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistry.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistry.md index bfead2e694..209491fac2 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistry.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistry.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration](/reference/services/SoftLayer_Network_Subnet_Registration)::getRegionalInternetRegistry + Retrieve the related Regional Internet Registry. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistryHandle.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistryHandle.md index 42e4243680..c492961c48 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistryHandle.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistryHandle.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration](/reference/services/SoftLayer_Network_Subnet_Registration)::getRegionalInternetRegistryHandle + Retrieve the RIR handle that this registration object belongs to. This field may not be populated until the registration is complete. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getStatus.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getStatus.md index f20aa0a5bc..162709f8a4 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getStatus.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration](/reference/services/SoftLayer_Network_Subnet_Registration)::getStatus + Retrieve the status of this registration. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration/getSubnet.md b/content/reference/services/SoftLayer_Network_Subnet_Registration/getSubnet.md index 93f936ce2c..4b0e43284f 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration/getSubnet.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration/getSubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration](/reference/services/SoftLayer_Network_Subnet_Registration)::getSubnet + Retrieve the subnet that this registration pertains to. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/_index.md b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/_index.md index 319287f1b2..0982e56904 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/_index.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,30 +44,35 @@ classes: #### [createObject](/reference/services/SoftLayer_Network_Subnet_Registration_Details/createObject) Create a new association between a [SoftLayer_Network_Subnet_Registration]({{}}) object and a [SoftLayer_Account_Regional_Registry_Detail]({{}}) object. +
              #### [deleteObject](/reference/services/SoftLayer_Network_Subnet_Registration_Details/deleteObject) Remove an existing association between a [SoftLayer_Network_Subnet_Registration]({{}}) object and a [SoftLayer_Account_Regional_Registry_Detail]({{}}) object. +
              #### [getDetail](/reference/services/SoftLayer_Network_Subnet_Registration_Details/getDetail) Retrieve the related [SoftLayer_Account_Regional_Registry_Detail]({{}}). +
              #### [getObject](/reference/services/SoftLayer_Network_Subnet_Registration_Details/getObject) Retrieve a SoftLayer_Network_Subnet_Registration_Details record. +
              #### [getRegistration](/reference/services/SoftLayer_Network_Subnet_Registration_Details/getRegistration) Retrieve the related [SoftLayer_Network_Subnet_Registration]({{}}). +
              diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/createObject.md b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/createObject.md index 5fb1c4c7e6..5e2dd21759 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/createObject.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration_Details](/reference/services/SoftLayer_Network_Subnet_Registration_Details)::createObject + Create a new association between a [SoftLayer_Network_Subnet_Registration]({{}}) object and a [SoftLayer_Account_Regional_Registry_Detail]({{}}) object. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/deleteObject.md b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/deleteObject.md index 244a522897..8f7654db02 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/deleteObject.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration_Details](/reference/services/SoftLayer_Network_Subnet_Registration_Details)::deleteObject + Remove an existing association between a [SoftLayer_Network_Subnet_Registration]({{}}) object and a [SoftLayer_Account_Regional_Registry_Detail]({{}}) object. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getDetail.md b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getDetail.md index 2fd6d4c2e5..89955ceb93 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getDetail.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration_Details](/reference/services/SoftLayer_Network_Subnet_Registration_Details)::getDetail + Retrieve the related [SoftLayer_Account_Regional_Registry_Detail]({{}}). diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getObject.md b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getObject.md index 73681f2de7..326136be21 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getObject.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration_Details](/reference/services/SoftLayer_Network_Subnet_Registration_Details)::getObject + Retrieve a SoftLayer_Network_Subnet_Registration_Details record. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getRegistration.md b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getRegistration.md index 3cec4209a4..13a5174277 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getRegistration.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration_Details/getRegistration.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration_Details](/reference/services/SoftLayer_Network_Subnet_Registration_Details)::getRegistration + Retrieve the related [SoftLayer_Network_Subnet_Registration]({{}}). diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration_Status/_index.md b/content/reference/services/SoftLayer_Network_Subnet_Registration_Status/_index.md index 8e8e00f432..2a65280571 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration_Status/_index.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration_Status/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Network_Subnet_Registration_Status/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_Network_Subnet_Registration_Status/getObject) Retrieve a SoftLayer_Network_Subnet_Registration_Status record. +
              diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration_Status/getAllObjects.md b/content/reference/services/SoftLayer_Network_Subnet_Registration_Status/getAllObjects.md index 0bf319f1e3..6c0a73cdfd 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration_Status/getAllObjects.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration_Status/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Subnet_Registration_Status/getObject.md b/content/reference/services/SoftLayer_Network_Subnet_Registration_Status/getObject.md index d9e32b050b..d2fb99b599 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Registration_Status/getObject.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Registration_Status/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Registration_Status](/reference/services/SoftLayer_Network_Subnet_Registration_Status)::getObject + Retrieve a SoftLayer_Network_Subnet_Registration_Status record. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/_index.md b/content/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/_index.md index 12367e730d..7e63b2829f 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/_index.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/_index.md @@ -22,6 +22,9 @@ classes: ## Description +
              Deprecated
              + + **DEPRECATED** Use SoftLayer_Account_Regional_Registry_Detail and SoftLayer_Network_Subnet_Registration instead. @@ -52,7 +55,7 @@ This service allows you to update your stored RWHOIS record. Changing this reco
              -
              +
              #### [editObject](/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/editObject) Edit the RWHOIS record by passing in a modified version of the record object. All fields are editable. The fields are as follows: @@ -64,18 +67,24 @@ Edit the RWHOIS record by passing in a modified version of the record object. Al * postalCode * abuseEmail * address1 + +Deprecated + +
              #### [getAccount](/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/getAccount) Retrieve the SoftLayer customer account associated with this reverse WHOIS data. +
              #### [getObject](/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/getObject) Retrieve a SoftLayer_Network_Subnet_Rwhois_Data record. +
              diff --git a/content/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/editObject.md b/content/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/editObject.md index fb32846685..df6bb88ad8 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/editObject.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/editObject.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Network_Subnet_Rwhois_Data](/reference/services/SoftLayer_Network_Subnet_Rwhois_Data)::editObject +
              Deprecated
              + Edit the RWHOIS record by passing in a modified version of the record object. All fields are editable. The fields are as follows: * companyName * firstName diff --git a/content/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/getAccount.md b/content/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/getAccount.md index fa63825ce1..2648895072 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Rwhois_Data](/reference/services/SoftLayer_Network_Subnet_Rwhois_Data)::getAccount + Retrieve the SoftLayer customer account associated with this reverse WHOIS data. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/getObject.md b/content/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/getObject.md index c51bc16909..8a4d95b196 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/getObject.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Rwhois_Data](/reference/services/SoftLayer_Network_Subnet_Rwhois_Data)::getObject + Retrieve a SoftLayer_Network_Subnet_Rwhois_Data record. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/_index.md b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/_index.md index 3e377d283b..8f13a13500 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/_index.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/_index.md @@ -20,6 +20,9 @@ classes: ## Description +
              Deprecated
              + + **DEPRECATED** SoftLayer's Automated Swip System is a finite state machine; it works by locally tracking a transaction between SoftLayer and the relevant Regional Internet Registry (RIR), assigning responsibility of a subnet to a customer. Transactions are dictated by the RIR's processing system, and the nature of the communication medium with each RIR, namely their REST API. @@ -54,58 +57,85 @@ Using this API, SoftLayer Customers are able to initiate, monitor, update, and r
              -
              +
              #### [findMyTransactions](/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/findMyTransactions) returns SWIP transaction objects that are currently in transaction with ARIN. + +Deprecated + +
              #### [getAccount](/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getAccount) Retrieve the Account whose RWHOIS data was used to SWIP this subnet +
              #### [getObject](/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getObject) Retrieve a SoftLayer_Network_Subnet_Swip_Transaction record. +
              #### [getSubnet](/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getSubnet) Retrieve the subnet that this SWIP transaction was created for. +
              -
              +
              #### [removeAllSubnetSwips](/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/removeAllSubnetSwips) Removes registration information from ARIN for all your subnets + +Deprecated + +
              -
              +
              #### [removeSwipData](/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/removeSwipData) Deletes registration information from ARIN for a single subnet + +Deprecated + +
              -
              +
              #### [resendSwipData](/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/resendSwipData) Sends updated RWHOIS information to ARIN for a single subnet. + +Deprecated + +
              -
              +
              #### [swipAllSubnets](/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/swipAllSubnets) create SWIP transactions for all subnets that do not already have a SWIP transaction in progress. + +Deprecated + +
              -
              +
              #### [updateAllSubnetSwips](/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/updateAllSubnetSwips) Update all subnets on the account with an "OK" status. + +Deprecated + +
              diff --git a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/findMyTransactions.md b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/findMyTransactions.md index bccf797a79..25dad14d10 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/findMyTransactions.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/findMyTransactions.md @@ -14,6 +14,8 @@ aliases: --- # [SoftLayer_Network_Subnet_Swip_Transaction](/reference/services/SoftLayer_Network_Subnet_Swip_Transaction)::findMyTransactions +
              Deprecated
              + returns SWIP transaction objects that are currently in transaction with ARIN. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getAccount.md b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getAccount.md index c2e693302d..0a9ca48d82 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Swip_Transaction](/reference/services/SoftLayer_Network_Subnet_Swip_Transaction)::getAccount + Retrieve the Account whose RWHOIS data was used to SWIP this subnet diff --git a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getObject.md b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getObject.md index 6171cf6066..3c871b7f41 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getObject.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getObject.md @@ -14,6 +14,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Swip_Transaction](/reference/services/SoftLayer_Network_Subnet_Swip_Transaction)::getObject + Retrieve a SoftLayer_Network_Subnet_Swip_Transaction record. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getSubnet.md b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getSubnet.md index 3c0d645402..3b8979850c 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getSubnet.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getSubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Subnet_Swip_Transaction](/reference/services/SoftLayer_Network_Subnet_Swip_Transaction)::getSubnet + Retrieve the subnet that this SWIP transaction was created for. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/removeAllSubnetSwips.md b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/removeAllSubnetSwips.md index dde1017425..b821c57151 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/removeAllSubnetSwips.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/removeAllSubnetSwips.md @@ -14,6 +14,8 @@ aliases: --- # [SoftLayer_Network_Subnet_Swip_Transaction](/reference/services/SoftLayer_Network_Subnet_Swip_Transaction)::removeAllSubnetSwips +
              Deprecated
              + Removes registration information from ARIN for all your subnets diff --git a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/removeSwipData.md b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/removeSwipData.md index 7c12422393..67a5f9dd6b 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/removeSwipData.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/removeSwipData.md @@ -14,6 +14,8 @@ aliases: --- # [SoftLayer_Network_Subnet_Swip_Transaction](/reference/services/SoftLayer_Network_Subnet_Swip_Transaction)::removeSwipData +
              Deprecated
              + Deletes registration information from ARIN for a single subnet diff --git a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/resendSwipData.md b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/resendSwipData.md index 15a179b450..73582a1a17 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/resendSwipData.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/resendSwipData.md @@ -14,6 +14,8 @@ aliases: --- # [SoftLayer_Network_Subnet_Swip_Transaction](/reference/services/SoftLayer_Network_Subnet_Swip_Transaction)::resendSwipData +
              Deprecated
              + Sends updated RWHOIS information to ARIN for a single subnet. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/swipAllSubnets.md b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/swipAllSubnets.md index 16e0f707e0..237db2d55c 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/swipAllSubnets.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/swipAllSubnets.md @@ -14,6 +14,8 @@ aliases: --- # [SoftLayer_Network_Subnet_Swip_Transaction](/reference/services/SoftLayer_Network_Subnet_Swip_Transaction)::swipAllSubnets +
              Deprecated
              + create SWIP transactions for all subnets that do not already have a SWIP transaction in progress. diff --git a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/updateAllSubnetSwips.md b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/updateAllSubnetSwips.md index 0338b3d1b6..137b388536 100644 --- a/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/updateAllSubnetSwips.md +++ b/content/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/updateAllSubnetSwips.md @@ -14,6 +14,8 @@ aliases: --- # [SoftLayer_Network_Subnet_Swip_Transaction](/reference/services/SoftLayer_Network_Subnet_Swip_Transaction)::updateAllSubnetSwips +
              Deprecated
              + Update all subnets on the account with an "OK" status. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/_index.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/_index.md index 021c125eb7..984845b12c 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/_index.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/_index.md @@ -20,6 +20,8 @@ classes:
              ## Description + + A SoftLayer network tunnel allows customer to authenticate and encrypt all IP traffic between two locations. Manage the entire network tunnel using this service. The SoftLayer_Network_Tunnel_Module_Context allows customers to manage subnets on both ends of the network tunnel. Address translations can also be managed. SoftLayer also provides the ability to apply the network tunnel configurations on the SoftLayer network devices. @@ -46,228 +48,266 @@ Manage the entire network tunnel using this service. The SoftLayer_Network_Tunn #### [addCustomerSubnetToNetworkTunnel](/reference/services/SoftLayer_Network_Tunnel_Module_Context/addCustomerSubnetToNetworkTunnel) Associate a remote subnet to a network tunnel +
              #### [addPrivateSubnetToNetworkTunnel](/reference/services/SoftLayer_Network_Tunnel_Module_Context/addPrivateSubnetToNetworkTunnel) Associate a private subnet to a network tunnel. +
              #### [addServiceSubnetToNetworkTunnel](/reference/services/SoftLayer_Network_Tunnel_Module_Context/addServiceSubnetToNetworkTunnel) Associate a service subnet to a network tunnel. +
              #### [applyConfigurationsToDevice](/reference/services/SoftLayer_Network_Tunnel_Module_Context/applyConfigurationsToDevice) Apply current configuration settings to the network device +
              #### [createAddressTranslation](/reference/services/SoftLayer_Network_Tunnel_Module_Context/createAddressTranslation) Create an address translation for a network tunnel +
              #### [createAddressTranslations](/reference/services/SoftLayer_Network_Tunnel_Module_Context/createAddressTranslations) Create address translations for a network tunnel +
              #### [deleteAddressTranslation](/reference/services/SoftLayer_Network_Tunnel_Module_Context/deleteAddressTranslation) Delete an address translation from a network tunnel +
              #### [downloadAddressTranslationConfigurations](/reference/services/SoftLayer_Network_Tunnel_Module_Context/downloadAddressTranslationConfigurations) Returns IPSec VPN tunnel address translation configurations in a text file. +
              #### [downloadParameterConfigurations](/reference/services/SoftLayer_Network_Tunnel_Module_Context/downloadParameterConfigurations) Returns IPSec VPN tunnel configurations in a text file. +
              #### [editAddressTranslation](/reference/services/SoftLayer_Network_Tunnel_Module_Context/editAddressTranslation) Edit an address translation for a network tunnel +
              #### [editAddressTranslations](/reference/services/SoftLayer_Network_Tunnel_Module_Context/editAddressTranslations) Edit address translations for a network tunnel +
              #### [editObject](/reference/services/SoftLayer_Network_Tunnel_Module_Context/editObject) Edit various settings for a network tunnel. +
              #### [getAccount](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAccount) Retrieve the account that a network tunnel belongs to. +
              #### [getActiveTransaction](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getActiveTransaction) Retrieval: DEPRECATED +
              #### [getAddressTranslationConfigurations](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAddressTranslationConfigurations) Build and returns IPsec VPN tunnel address translation configurations +
              #### [getAddressTranslations](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAddressTranslations) Retrieve a network tunnel's address translations. +
              #### [getAllAvailableServiceSubnets](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAllAvailableServiceSubnets) Retrieve subnets that provide access to SoftLayer services such as the management portal and the SoftLayer API. +
              #### [getAuthenticationDefault](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAuthenticationDefault) Returns the authentication default. +
              #### [getAuthenticationOptions](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAuthenticationOptions) Returns the authentication options. +
              #### [getBillingItem](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getBillingItem) Retrieve the current billing item for network tunnel. +
              #### [getCustomerSubnets](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getCustomerSubnets) Retrieve remote subnets that are allowed access through a network tunnel. +
              #### [getDatacenter](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getDatacenter) Retrieve the datacenter location for one end of the network tunnel that allows access to account's private subnets. +
              #### [getDiffieHellmanGroupDefault](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getDiffieHellmanGroupDefault) Returns the diffie hellman group default. +
              #### [getDiffieHellmanGroupOptions](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getDiffieHellmanGroupOptions) Returns the diffie-hellman group options. +
              #### [getEncryptionDefault](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getEncryptionDefault) Returns the encryption default. +
              #### [getEncryptionOptions](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getEncryptionOptions) Returns the encryption options. +
              #### [getInternalSubnets](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getInternalSubnets) Retrieve private subnets that can be accessed through the network tunnel. +
              #### [getKeylifeLimits](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getKeylifeLimits) Returns the keylife min and max limits. +
              #### [getObject](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getObject) Retrieve a SoftLayer_Network_Tunnel_Module_Context record. +
              #### [getParameterConfigurationsForCustomerView](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getParameterConfigurationsForCustomerView) Build and returns IPsec VPN tunnel configurations +
              #### [getPhaseOneKeylifeDefault](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getPhaseOneKeylifeDefault) Returns the phase one keylife default. +
              #### [getPhaseTwoKeylifeDefault](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getPhaseTwoKeylifeDefault) Returns phase two keylife default. +
              #### [getServiceSubnets](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getServiceSubnets) Retrieve service subnets that can be access through the network tunnel. +
              #### [getStaticRouteSubnets](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getStaticRouteSubnets) Retrieve subnets used for a network tunnel's address translations. +
              #### [getTransactionHistory](/reference/services/SoftLayer_Network_Tunnel_Module_Context/getTransactionHistory) Retrieval: DEPRECATED +
              #### [removeCustomerSubnetFromNetworkTunnel](/reference/services/SoftLayer_Network_Tunnel_Module_Context/removeCustomerSubnetFromNetworkTunnel) Disassociate a customer (remote) subnet from a network tunnel +
              #### [removePrivateSubnetFromNetworkTunnel](/reference/services/SoftLayer_Network_Tunnel_Module_Context/removePrivateSubnetFromNetworkTunnel) Disassociate a private subnet from a network tunnel +
              #### [removeServiceSubnetFromNetworkTunnel](/reference/services/SoftLayer_Network_Tunnel_Module_Context/removeServiceSubnetFromNetworkTunnel) Disassociate service subnet from a network tunnel +
              diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/addCustomerSubnetToNetworkTunnel.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/addCustomerSubnetToNetworkTunnel.md index ea2c455b0f..fd187f1431 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/addCustomerSubnetToNetworkTunnel.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/addCustomerSubnetToNetworkTunnel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::addCustomerSubnetToNetworkTunnel + Associate a remote subnet to a network tunnel diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/addPrivateSubnetToNetworkTunnel.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/addPrivateSubnetToNetworkTunnel.md index a2043165ca..1338515ece 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/addPrivateSubnetToNetworkTunnel.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/addPrivateSubnetToNetworkTunnel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::addPrivateSubnetToNetworkTunnel + Associate a private subnet to a network tunnel. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/addServiceSubnetToNetworkTunnel.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/addServiceSubnetToNetworkTunnel.md index ab4d7d867e..ece3b24fcf 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/addServiceSubnetToNetworkTunnel.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/addServiceSubnetToNetworkTunnel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::addServiceSubnetToNetworkTunnel + Associate a service subnet to a network tunnel. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/applyConfigurationsToDevice.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/applyConfigurationsToDevice.md index 347949ebac..c299a0ceef 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/applyConfigurationsToDevice.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/applyConfigurationsToDevice.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::applyConfigurationsToDevice + Apply current configuration settings to the network device diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/createAddressTranslation.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/createAddressTranslation.md index f831adc288..4dd393da00 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/createAddressTranslation.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/createAddressTranslation.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::createAddressTranslation + Create an address translation for a network tunnel diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/createAddressTranslations.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/createAddressTranslations.md index f82d590d1d..baa8bb563b 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/createAddressTranslations.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/createAddressTranslations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::createAddressTranslations + Create address translations for a network tunnel diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/deleteAddressTranslation.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/deleteAddressTranslation.md index aee3275337..3e5ef84a90 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/deleteAddressTranslation.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/deleteAddressTranslation.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::deleteAddressTranslation + Delete an address translation from a network tunnel diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/downloadAddressTranslationConfigurations.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/downloadAddressTranslationConfigurations.md index 42b0477214..876d586d54 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/downloadAddressTranslationConfigurations.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/downloadAddressTranslationConfigurations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::downloadAddressTranslationConfigurations + Returns IPSec VPN tunnel address translation configurations in a text file. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/downloadParameterConfigurations.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/downloadParameterConfigurations.md index 6e237eea32..e69b23848c 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/downloadParameterConfigurations.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/downloadParameterConfigurations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::downloadParameterConfigurations + Returns IPSec VPN tunnel configurations in a text file. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/editAddressTranslation.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/editAddressTranslation.md index ad016cd939..1b077b5453 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/editAddressTranslation.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/editAddressTranslation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::editAddressTranslation + Edit an address translation for a network tunnel diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/editAddressTranslations.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/editAddressTranslations.md index c78491b4c1..664596bc2e 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/editAddressTranslations.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/editAddressTranslations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::editAddressTranslations + Edit address translations for a network tunnel diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/editObject.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/editObject.md index 35ad9b4009..772f45e9ae 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/editObject.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::editObject + Edit various settings for a network tunnel. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAccount.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAccount.md index ce13e49903..62da2932fa 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getAccount + Retrieve the account that a network tunnel belongs to. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getActiveTransaction.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getActiveTransaction.md index 8cff0c906c..02cbae6b02 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getActiveTransaction.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getActiveTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getActiveTransaction + Retrieval: DEPRECATED diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAddressTranslationConfigurations.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAddressTranslationConfigurations.md index 806a660ed2..08a89b80b3 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAddressTranslationConfigurations.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAddressTranslationConfigurations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getAddressTranslationConfigurations + Build and returns IPsec VPN tunnel address translation configurations diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAddressTranslations.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAddressTranslations.md index 1b72f9ee81..2c9bca6484 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAddressTranslations.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAddressTranslations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getAddressTranslations + Retrieve a network tunnel's address translations. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAllAvailableServiceSubnets.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAllAvailableServiceSubnets.md index 9ebb18766b..c96a4ede00 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAllAvailableServiceSubnets.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAllAvailableServiceSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getAllAvailableServiceSubnets + Retrieve subnets that provide access to SoftLayer services such as the management portal and the SoftLayer API. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAuthenticationDefault.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAuthenticationDefault.md index b26be6a47d..412f27d1df 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAuthenticationDefault.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAuthenticationDefault.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getAuthenticationDefault + Returns the authentication default. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAuthenticationOptions.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAuthenticationOptions.md index b4db0ebf4e..52cf2e29b7 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAuthenticationOptions.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getAuthenticationOptions.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getAuthenticationOptions + Returns the authentication options. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getBillingItem.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getBillingItem.md index 872028c244..51c4f5cfa2 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getBillingItem + Retrieve the current billing item for network tunnel. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getCustomerSubnets.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getCustomerSubnets.md index 379e7e4eac..e7de4900a0 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getCustomerSubnets.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getCustomerSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getCustomerSubnets + Retrieve remote subnets that are allowed access through a network tunnel. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getDatacenter.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getDatacenter.md index 426fc579f9..d630a4766a 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getDatacenter.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getDatacenter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getDatacenter + Retrieve the datacenter location for one end of the network tunnel that allows access to account's private subnets. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getDiffieHellmanGroupDefault.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getDiffieHellmanGroupDefault.md index 7c68afb223..f66b412490 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getDiffieHellmanGroupDefault.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getDiffieHellmanGroupDefault.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getDiffieHellmanGroupDefault + Returns the diffie hellman group default. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getDiffieHellmanGroupOptions.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getDiffieHellmanGroupOptions.md index 0e7ccc40ab..2e61836562 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getDiffieHellmanGroupOptions.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getDiffieHellmanGroupOptions.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getDiffieHellmanGroupOptions + Returns the diffie-hellman group options. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getEncryptionDefault.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getEncryptionDefault.md index b760532a1b..cdf1902d6e 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getEncryptionDefault.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getEncryptionDefault.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getEncryptionDefault + Returns the encryption default. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getEncryptionOptions.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getEncryptionOptions.md index 4c3fa99c36..cd77891f7e 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getEncryptionOptions.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getEncryptionOptions.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getEncryptionOptions + Returns the encryption options. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getInternalSubnets.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getInternalSubnets.md index 6e98835b2f..03a6e11b21 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getInternalSubnets.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getInternalSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getInternalSubnets + Retrieve private subnets that can be accessed through the network tunnel. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getKeylifeLimits.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getKeylifeLimits.md index ce35a0e8a8..f1824fc9aa 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getKeylifeLimits.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getKeylifeLimits.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getKeylifeLimits + Returns the keylife min and max limits. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getObject.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getObject.md index e2b2d891a7..d187a8f7b1 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getObject.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getObject + Retrieve a SoftLayer_Network_Tunnel_Module_Context record. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getParameterConfigurationsForCustomerView.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getParameterConfigurationsForCustomerView.md index 2f9daa1fe7..2b50728746 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getParameterConfigurationsForCustomerView.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getParameterConfigurationsForCustomerView.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getParameterConfigurationsForCustomerView + Build and returns IPsec VPN tunnel configurations diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getPhaseOneKeylifeDefault.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getPhaseOneKeylifeDefault.md index f380232015..f101987b9f 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getPhaseOneKeylifeDefault.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getPhaseOneKeylifeDefault.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getPhaseOneKeylifeDefault + Returns the phase one keylife default. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getPhaseTwoKeylifeDefault.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getPhaseTwoKeylifeDefault.md index 379f8bffdc..40afe188c3 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getPhaseTwoKeylifeDefault.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getPhaseTwoKeylifeDefault.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getPhaseTwoKeylifeDefault + Returns phase two keylife default. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getServiceSubnets.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getServiceSubnets.md index ac5b649276..e3acbc4208 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getServiceSubnets.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getServiceSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getServiceSubnets + Retrieve service subnets that can be access through the network tunnel. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getStaticRouteSubnets.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getStaticRouteSubnets.md index abe8eabad7..24f5b71f8c 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getStaticRouteSubnets.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getStaticRouteSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getStaticRouteSubnets + Retrieve subnets used for a network tunnel's address translations. diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getTransactionHistory.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getTransactionHistory.md index 4f98a1d353..901a8b924d 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getTransactionHistory.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/getTransactionHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::getTransactionHistory + Retrieval: DEPRECATED diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/removeCustomerSubnetFromNetworkTunnel.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/removeCustomerSubnetFromNetworkTunnel.md index d6710e19e0..936d8ab1c8 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/removeCustomerSubnetFromNetworkTunnel.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/removeCustomerSubnetFromNetworkTunnel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::removeCustomerSubnetFromNetworkTunnel + Disassociate a customer (remote) subnet from a network tunnel diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/removePrivateSubnetFromNetworkTunnel.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/removePrivateSubnetFromNetworkTunnel.md index ce7dd30ce4..af0d8d0785 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/removePrivateSubnetFromNetworkTunnel.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/removePrivateSubnetFromNetworkTunnel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::removePrivateSubnetFromNetworkTunnel + Disassociate a private subnet from a network tunnel diff --git a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/removeServiceSubnetFromNetworkTunnel.md b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/removeServiceSubnetFromNetworkTunnel.md index 0a35df7314..fe38845f7d 100644 --- a/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/removeServiceSubnetFromNetworkTunnel.md +++ b/content/reference/services/SoftLayer_Network_Tunnel_Module_Context/removeServiceSubnetFromNetworkTunnel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Tunnel_Module_Context](/reference/services/SoftLayer_Network_Tunnel_Module_Context)::removeServiceSubnetFromNetworkTunnel + Disassociate service subnet from a network tunnel diff --git a/content/reference/services/SoftLayer_Network_Vlan/_index.md b/content/reference/services/SoftLayer_Network_Vlan/_index.md index d03615a256..3bff8570b6 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/_index.md +++ b/content/reference/services/SoftLayer_Network_Vlan/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + Virtual LANs are an integral part of SoftLayer' s public and private networks. A VLAN is a networking concept in which network interfaces on different routers, switches, and servers act as if they're on the same local network broadcast domain. This kind of network segmentation helps keep SoftLayer customers' networks separate from each other and provides a convenient mechanism for routing new IP subnets to servers. They also enable easy IP address sharing and swapping between servers on the same VLAN. SoftLayer servers are provisioned on private VLANs per router on the public and private networks. The SoftLayer_Network_Vlan service controls these VLANs and provides relationships between VLANs, subnets, IP addresses, and network components. @@ -58,306 +60,360 @@ The SoftLayer_Network_Vlan service controls these VLANs and provides relationshi #### [editObject](/reference/services/SoftLayer_Network_Vlan/editObject) Edit a VLAN's properties +
              #### [getAccount](/reference/services/SoftLayer_Network_Vlan/getAccount) Retrieve the SoftLayer customer account associated with a VLAN. +
              #### [getAdditionalPrimarySubnets](/reference/services/SoftLayer_Network_Vlan/getAdditionalPrimarySubnets) Retrieve a VLAN's additional primary subnets. These are used to extend the number of servers attached to the VLAN by adding more ip addresses to the primary IP address pool. +
              #### [getAttachedNetworkGateway](/reference/services/SoftLayer_Network_Vlan/getAttachedNetworkGateway) Retrieve the gateway this VLAN is inside of. +
              #### [getAttachedNetworkGatewayFlag](/reference/services/SoftLayer_Network_Vlan/getAttachedNetworkGatewayFlag) Retrieve whether or not this VLAN is inside a gateway. +
              #### [getAttachedNetworkGatewayVlan](/reference/services/SoftLayer_Network_Vlan/getAttachedNetworkGatewayVlan) Retrieve the inside VLAN record if this VLAN is inside a network gateway. +
              #### [getBillingItem](/reference/services/SoftLayer_Network_Vlan/getBillingItem) Retrieve the billing item for a network vlan. +
              #### [getCancelFailureReasons](/reference/services/SoftLayer_Network_Vlan/getCancelFailureReasons) Get a set of reasons why this VLAN may not be cancelled. +
              #### [getDedicatedFirewallFlag](/reference/services/SoftLayer_Network_Vlan/getDedicatedFirewallFlag) Retrieve a flag indicating that a network vlan is on a Hardware Firewall (Dedicated). +
              #### [getExtensionRouter](/reference/services/SoftLayer_Network_Vlan/getExtensionRouter) Retrieve the extension router that a VLAN is associated with. +
              #### [getFirewallGuestNetworkComponents](/reference/services/SoftLayer_Network_Vlan/getFirewallGuestNetworkComponents) Retrieve a firewalled Vlan's network components. +
              #### [getFirewallInterfaces](/reference/services/SoftLayer_Network_Vlan/getFirewallInterfaces) Retrieve a firewalled vlan's inbound/outbound interfaces. +
              #### [getFirewallNetworkComponents](/reference/services/SoftLayer_Network_Vlan/getFirewallNetworkComponents) Retrieve a firewalled Vlan's network components. +
              #### [getFirewallProtectableIpAddresses](/reference/services/SoftLayer_Network_Vlan/getFirewallProtectableIpAddresses) Get the IP addresses associated with this server that are protectable by a network component firewall. +
              #### [getFirewallProtectableSubnets](/reference/services/SoftLayer_Network_Vlan/getFirewallProtectableSubnets) Get the subnets associated with this server that are protectable by a network component firewall. +
              #### [getFirewallRules](/reference/services/SoftLayer_Network_Vlan/getFirewallRules) Retrieve the currently running rule set of a firewalled VLAN. +
              #### [getGuestNetworkComponents](/reference/services/SoftLayer_Network_Vlan/getGuestNetworkComponents) Retrieve the networking components that are connected to a VLAN. +
              #### [getHardware](/reference/services/SoftLayer_Network_Vlan/getHardware) Retrieve all of the hardware that exists on a VLAN. Hardware is associated with a VLAN by its networking components. +
              #### [getHighAvailabilityFirewallFlag](/reference/services/SoftLayer_Network_Vlan/getHighAvailabilityFirewallFlag) +
              #### [getLocalDiskStorageCapabilityFlag](/reference/services/SoftLayer_Network_Vlan/getLocalDiskStorageCapabilityFlag) Retrieve a flag indicating that a vlan can be assigned to a host that has local disk functionality. +
              #### [getNetwork](/reference/services/SoftLayer_Network_Vlan/getNetwork) Retrieve the network in which this VLAN resides. +
              #### [getNetworkComponentTrunks](/reference/services/SoftLayer_Network_Vlan/getNetworkComponentTrunks) Retrieve the network components that are connected to this VLAN through a trunk. +
              #### [getNetworkComponents](/reference/services/SoftLayer_Network_Vlan/getNetworkComponents) Retrieve the networking components that are connected to a VLAN. +
              #### [getNetworkComponentsTrunkable](/reference/services/SoftLayer_Network_Vlan/getNetworkComponentsTrunkable) Retrieve the viable trunking targets of this VLAN. Viable targets include accessible components of assigned hardware in the same pod and network as this VLAN, which are not already natively attached nor trunked. +
              #### [getNetworkSpace](/reference/services/SoftLayer_Network_Vlan/getNetworkSpace) Retrieve identifier to denote whether a VLAN is used for public or private connectivity. +
              #### [getNetworkVlanFirewall](/reference/services/SoftLayer_Network_Vlan/getNetworkVlanFirewall) Retrieve the Hardware Firewall (Dedicated) for a network vlan. +
              #### [getObject](/reference/services/SoftLayer_Network_Vlan/getObject) Retrieve a SoftLayer_Network_Vlan record. +
              #### [getPrimaryRouter](/reference/services/SoftLayer_Network_Vlan/getPrimaryRouter) Retrieve the primary router that a VLAN is associated with. Every SoftLayer VLAN is connected to more than one router for greater network redundancy. +
              #### [getPrimarySubnet](/reference/services/SoftLayer_Network_Vlan/getPrimarySubnet) Retrieve a VLAN's primary subnet. Each VLAN has at least one subnet, usually the subnet that is assigned to a server or new IP address block when it's purchased. +
              #### [getPrimarySubnetVersion6](/reference/services/SoftLayer_Network_Vlan/getPrimarySubnetVersion6) Retrieve a VLAN's primary IPv6 subnet. Some VLAN's may not have a primary IPv6 subnet. +
              #### [getPrimarySubnets](/reference/services/SoftLayer_Network_Vlan/getPrimarySubnets) +
              #### [getPrivateNetworkGateways](/reference/services/SoftLayer_Network_Vlan/getPrivateNetworkGateways) Retrieve the gateways this VLAN is the private VLAN of. +
              #### [getPrivateVlan](/reference/services/SoftLayer_Network_Vlan/getPrivateVlan) Retrieve a VLAN's associated private network VLAN. +
              -
              +
              #### [getPrivateVlanByIpAddress](/reference/services/SoftLayer_Network_Vlan/getPrivateVlanByIpAddress) Retrieve the private network VLAN associated with an IP address. + +Deprecated + +
              #### [getProtectedIpAddresses](/reference/services/SoftLayer_Network_Vlan/getProtectedIpAddresses) +
              #### [getPublicNetworkGateways](/reference/services/SoftLayer_Network_Vlan/getPublicNetworkGateways) Retrieve the gateways this VLAN is the public VLAN of. +
              #### [getPublicVlanByFqdn](/reference/services/SoftLayer_Network_Vlan/getPublicVlanByFqdn) Retrieve a server's public VLAN based on it's fully-qualified domain name +
              #### [getReverseDomainRecords](/reference/services/SoftLayer_Network_Vlan/getReverseDomainRecords) Retrieve all reverse DNS records associated with a VLAN. +
              #### [getSanStorageCapabilityFlag](/reference/services/SoftLayer_Network_Vlan/getSanStorageCapabilityFlag) Retrieve a flag indicating that a vlan can be assigned to a host that has SAN disk functionality. +
              #### [getScaleVlans](/reference/services/SoftLayer_Network_Vlan/getScaleVlans) Retrieve collection of scale VLANs this VLAN applies to. +
              #### [getSecondaryRouter](/reference/services/SoftLayer_Network_Vlan/getSecondaryRouter) Retrieve the secondary router that a VLAN is associated with. Every SoftLayer VLAN is connected to more than one router for greater network redundancy. +
              #### [getSecondarySubnets](/reference/services/SoftLayer_Network_Vlan/getSecondarySubnets) Retrieve the subnets that exist as secondary interfaces on a VLAN +
              #### [getSubnets](/reference/services/SoftLayer_Network_Vlan/getSubnets) Retrieve all of the subnets that exist as VLAN interfaces. +
              #### [getTagReferences](/reference/services/SoftLayer_Network_Vlan/getTagReferences) Retrieve references to all tags for this VLAN. +
              #### [getTotalPrimaryIpAddressCount](/reference/services/SoftLayer_Network_Vlan/getTotalPrimaryIpAddressCount) Retrieve the number of primary IP addresses in a VLAN. +
              #### [getType](/reference/services/SoftLayer_Network_Vlan/getType) Retrieve the type of this VLAN. +
              #### [getVirtualGuests](/reference/services/SoftLayer_Network_Vlan/getVirtualGuests) Retrieve all of the Virtual Servers that are connected to a VLAN. +
              #### [getVlanForIpAddress](/reference/services/SoftLayer_Network_Vlan/getVlanForIpAddress) Retrieve an IP addresses's associated VLAN. +
              #### [setTags](/reference/services/SoftLayer_Network_Vlan/setTags) +
              #### [updateFirewallIntraVlanCommunication](/reference/services/SoftLayer_Network_Vlan/updateFirewallIntraVlanCommunication) Update a VLAN's firewall to allow or disallow intra-VLAN communication. +
              #### [upgrade](/reference/services/SoftLayer_Network_Vlan/upgrade) Convert the VLAN to a paid resource. That is, from an Automatic to a Premium VLAN. +
              diff --git a/content/reference/services/SoftLayer_Network_Vlan/editObject.md b/content/reference/services/SoftLayer_Network_Vlan/editObject.md index 455d105d20..cce6bdf6fd 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/editObject.md +++ b/content/reference/services/SoftLayer_Network_Vlan/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::editObject + Edit a VLAN's properties diff --git a/content/reference/services/SoftLayer_Network_Vlan/getAccount.md b/content/reference/services/SoftLayer_Network_Vlan/getAccount.md index c1daccf691..e2f2709237 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getAccount.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getAccount + Retrieve the SoftLayer customer account associated with a VLAN. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getAdditionalPrimarySubnets.md b/content/reference/services/SoftLayer_Network_Vlan/getAdditionalPrimarySubnets.md index 5c79125809..174e4cee83 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getAdditionalPrimarySubnets.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getAdditionalPrimarySubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getAdditionalPrimarySubnets + Retrieve a VLAN's additional primary subnets. These are used to extend the number of servers attached to the VLAN by adding more ip addresses to the primary IP address pool. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getAttachedNetworkGateway.md b/content/reference/services/SoftLayer_Network_Vlan/getAttachedNetworkGateway.md index 5e31ee704f..8f14058951 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getAttachedNetworkGateway.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getAttachedNetworkGateway.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getAttachedNetworkGateway + Retrieve the gateway this VLAN is inside of. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getAttachedNetworkGatewayFlag.md b/content/reference/services/SoftLayer_Network_Vlan/getAttachedNetworkGatewayFlag.md index 3665a2c048..d7e1bab380 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getAttachedNetworkGatewayFlag.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getAttachedNetworkGatewayFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getAttachedNetworkGatewayFlag + Retrieve whether or not this VLAN is inside a gateway. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getAttachedNetworkGatewayVlan.md b/content/reference/services/SoftLayer_Network_Vlan/getAttachedNetworkGatewayVlan.md index d11257ac26..a55a94e589 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getAttachedNetworkGatewayVlan.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getAttachedNetworkGatewayVlan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getAttachedNetworkGatewayVlan + Retrieve the inside VLAN record if this VLAN is inside a network gateway. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getBillingItem.md b/content/reference/services/SoftLayer_Network_Vlan/getBillingItem.md index 16fc3ebe21..9eaa173b39 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getBillingItem + Retrieve the billing item for a network vlan. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getCancelFailureReasons.md b/content/reference/services/SoftLayer_Network_Vlan/getCancelFailureReasons.md index dc60633860..5b469900c9 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getCancelFailureReasons.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getCancelFailureReasons.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getCancelFailureReasons + Get a set of reasons why this VLAN may not be cancelled. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getDedicatedFirewallFlag.md b/content/reference/services/SoftLayer_Network_Vlan/getDedicatedFirewallFlag.md index 98e2344492..cea1765c2b 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getDedicatedFirewallFlag.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getDedicatedFirewallFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getDedicatedFirewallFlag + Retrieve a flag indicating that a network vlan is on a Hardware Firewall (Dedicated). diff --git a/content/reference/services/SoftLayer_Network_Vlan/getExtensionRouter.md b/content/reference/services/SoftLayer_Network_Vlan/getExtensionRouter.md index ccbc47af07..e5dbeb86b9 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getExtensionRouter.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getExtensionRouter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getExtensionRouter + Retrieve the extension router that a VLAN is associated with. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getFirewallGuestNetworkComponents.md b/content/reference/services/SoftLayer_Network_Vlan/getFirewallGuestNetworkComponents.md index 9c6dce4f28..5159112148 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getFirewallGuestNetworkComponents.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getFirewallGuestNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getFirewallGuestNetworkComponents + Retrieve a firewalled Vlan's network components. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getFirewallInterfaces.md b/content/reference/services/SoftLayer_Network_Vlan/getFirewallInterfaces.md index d535fba2e8..1b894a904d 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getFirewallInterfaces.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getFirewallInterfaces.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getFirewallInterfaces + Retrieve a firewalled vlan's inbound/outbound interfaces. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getFirewallNetworkComponents.md b/content/reference/services/SoftLayer_Network_Vlan/getFirewallNetworkComponents.md index 508c36dab7..c1b39e3323 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getFirewallNetworkComponents.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getFirewallNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getFirewallNetworkComponents + Retrieve a firewalled Vlan's network components. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getFirewallProtectableIpAddresses.md b/content/reference/services/SoftLayer_Network_Vlan/getFirewallProtectableIpAddresses.md index 208293d322..d6d1fa2af5 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getFirewallProtectableIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getFirewallProtectableIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getFirewallProtectableIpAddresses + Get the IP addresses associated with this server that are protectable by a network component firewall. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getFirewallProtectableSubnets.md b/content/reference/services/SoftLayer_Network_Vlan/getFirewallProtectableSubnets.md index a35c1b4e10..e3ef88a316 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getFirewallProtectableSubnets.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getFirewallProtectableSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getFirewallProtectableSubnets + Get the subnets associated with this server that are protectable by a network component firewall. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getFirewallRules.md b/content/reference/services/SoftLayer_Network_Vlan/getFirewallRules.md index 53bb6fd309..6a16154df5 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getFirewallRules.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getFirewallRules.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getFirewallRules + Retrieve the currently running rule set of a firewalled VLAN. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getGuestNetworkComponents.md b/content/reference/services/SoftLayer_Network_Vlan/getGuestNetworkComponents.md index 8496717b10..03388c84a3 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getGuestNetworkComponents.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getGuestNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getGuestNetworkComponents + Retrieve the networking components that are connected to a VLAN. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getHardware.md b/content/reference/services/SoftLayer_Network_Vlan/getHardware.md index 285f220415..77d352a54c 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getHardware.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getHardware + Retrieve all of the hardware that exists on a VLAN. Hardware is associated with a VLAN by its networking components. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getHighAvailabilityFirewallFlag.md b/content/reference/services/SoftLayer_Network_Vlan/getHighAvailabilityFirewallFlag.md index e51a61402d..af299cb8bb 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getHighAvailabilityFirewallFlag.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getHighAvailabilityFirewallFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Vlan/getLocalDiskStorageCapabilityFlag.md b/content/reference/services/SoftLayer_Network_Vlan/getLocalDiskStorageCapabilityFlag.md index 6cc1ba212a..3e35e909fe 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getLocalDiskStorageCapabilityFlag.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getLocalDiskStorageCapabilityFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getLocalDiskStorageCapabilityFlag + Retrieve a flag indicating that a vlan can be assigned to a host that has local disk functionality. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getNetwork.md b/content/reference/services/SoftLayer_Network_Vlan/getNetwork.md index 2a544fb15b..e867451c37 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getNetwork.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getNetwork.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getNetwork + Retrieve the network in which this VLAN resides. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getNetworkComponentTrunks.md b/content/reference/services/SoftLayer_Network_Vlan/getNetworkComponentTrunks.md index 0b2224d0ee..58afc959d6 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getNetworkComponentTrunks.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getNetworkComponentTrunks.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getNetworkComponentTrunks + Retrieve the network components that are connected to this VLAN through a trunk. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getNetworkComponents.md b/content/reference/services/SoftLayer_Network_Vlan/getNetworkComponents.md index 7daca8a868..876b3f1f73 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getNetworkComponents.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getNetworkComponents + Retrieve the networking components that are connected to a VLAN. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getNetworkComponentsTrunkable.md b/content/reference/services/SoftLayer_Network_Vlan/getNetworkComponentsTrunkable.md index 9dd8337932..7a1c032a2c 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getNetworkComponentsTrunkable.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getNetworkComponentsTrunkable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getNetworkComponentsTrunkable + Retrieve the viable trunking targets of this VLAN. Viable targets include accessible components of assigned hardware in the same pod and network as this VLAN, which are not already natively attached nor trunked. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getNetworkSpace.md b/content/reference/services/SoftLayer_Network_Vlan/getNetworkSpace.md index 7418a25b5c..f20baa80eb 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getNetworkSpace.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getNetworkSpace.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getNetworkSpace + Retrieve identifier to denote whether a VLAN is used for public or private connectivity. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getNetworkVlanFirewall.md b/content/reference/services/SoftLayer_Network_Vlan/getNetworkVlanFirewall.md index 5936d4ed5e..6ccedf334b 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getNetworkVlanFirewall.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getNetworkVlanFirewall.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getNetworkVlanFirewall + Retrieve the Hardware Firewall (Dedicated) for a network vlan. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getObject.md b/content/reference/services/SoftLayer_Network_Vlan/getObject.md index 3fa22c88e6..aecb798ee0 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getObject.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getObject + Retrieve a SoftLayer_Network_Vlan record. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getPrimaryRouter.md b/content/reference/services/SoftLayer_Network_Vlan/getPrimaryRouter.md index fc8c431f66..eac6246710 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getPrimaryRouter.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getPrimaryRouter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getPrimaryRouter + Retrieve the primary router that a VLAN is associated with. Every SoftLayer VLAN is connected to more than one router for greater network redundancy. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getPrimarySubnet.md b/content/reference/services/SoftLayer_Network_Vlan/getPrimarySubnet.md index 801c55cb7c..a1da52404a 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getPrimarySubnet.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getPrimarySubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getPrimarySubnet + Retrieve a VLAN's primary subnet. Each VLAN has at least one subnet, usually the subnet that is assigned to a server or new IP address block when it's purchased. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getPrimarySubnetVersion6.md b/content/reference/services/SoftLayer_Network_Vlan/getPrimarySubnetVersion6.md index 5cbbba83e2..d160ddbb87 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getPrimarySubnetVersion6.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getPrimarySubnetVersion6.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getPrimarySubnetVersion6 + Retrieve a VLAN's primary IPv6 subnet. Some VLAN's may not have a primary IPv6 subnet. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getPrimarySubnets.md b/content/reference/services/SoftLayer_Network_Vlan/getPrimarySubnets.md index 3abbf456bb..ff40d4110f 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getPrimarySubnets.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getPrimarySubnets.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Vlan/getPrivateNetworkGateways.md b/content/reference/services/SoftLayer_Network_Vlan/getPrivateNetworkGateways.md index bc389567a3..d8f01dfe35 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getPrivateNetworkGateways.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getPrivateNetworkGateways.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getPrivateNetworkGateways + Retrieve the gateways this VLAN is the private VLAN of. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getPrivateVlan.md b/content/reference/services/SoftLayer_Network_Vlan/getPrivateVlan.md index 6d42cbf8d8..714cc7ac08 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getPrivateVlan.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getPrivateVlan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getPrivateVlan + Retrieve a VLAN's associated private network VLAN. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getPrivateVlanByIpAddress.md b/content/reference/services/SoftLayer_Network_Vlan/getPrivateVlanByIpAddress.md index c7b7840589..bf8a1127af 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getPrivateVlanByIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getPrivateVlanByIpAddress.md @@ -14,6 +14,8 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getPrivateVlanByIpAddress +
              Deprecated
              + Retrieve the private network VLAN associated with an IP address. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getProtectedIpAddresses.md b/content/reference/services/SoftLayer_Network_Vlan/getProtectedIpAddresses.md index 49eabc6f43..7b849c51cd 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getProtectedIpAddresses.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getProtectedIpAddresses.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Vlan/getPublicNetworkGateways.md b/content/reference/services/SoftLayer_Network_Vlan/getPublicNetworkGateways.md index 22d5bcaab8..9c7e83f350 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getPublicNetworkGateways.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getPublicNetworkGateways.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getPublicNetworkGateways + Retrieve the gateways this VLAN is the public VLAN of. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getPublicVlanByFqdn.md b/content/reference/services/SoftLayer_Network_Vlan/getPublicVlanByFqdn.md index ba815dc5f6..3ee822745f 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getPublicVlanByFqdn.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getPublicVlanByFqdn.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getPublicVlanByFqdn + Retrieve a server's public VLAN based on it's fully-qualified domain name diff --git a/content/reference/services/SoftLayer_Network_Vlan/getReverseDomainRecords.md b/content/reference/services/SoftLayer_Network_Vlan/getReverseDomainRecords.md index 5199eaa766..d3ae13a4b0 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getReverseDomainRecords.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getReverseDomainRecords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getReverseDomainRecords + Retrieve all reverse DNS records associated with a VLAN. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getSanStorageCapabilityFlag.md b/content/reference/services/SoftLayer_Network_Vlan/getSanStorageCapabilityFlag.md index a5778aaa6e..9b615f87b3 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getSanStorageCapabilityFlag.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getSanStorageCapabilityFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getSanStorageCapabilityFlag + Retrieve a flag indicating that a vlan can be assigned to a host that has SAN disk functionality. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getScaleVlans.md b/content/reference/services/SoftLayer_Network_Vlan/getScaleVlans.md index 5739433ae7..a2a055e573 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getScaleVlans.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getScaleVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getScaleVlans + Retrieve collection of scale VLANs this VLAN applies to. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getSecondaryRouter.md b/content/reference/services/SoftLayer_Network_Vlan/getSecondaryRouter.md index 4e98c666f9..ef0bbca425 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getSecondaryRouter.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getSecondaryRouter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getSecondaryRouter + Retrieve the secondary router that a VLAN is associated with. Every SoftLayer VLAN is connected to more than one router for greater network redundancy. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getSecondarySubnets.md b/content/reference/services/SoftLayer_Network_Vlan/getSecondarySubnets.md index f2199ccc7b..7c6bb65c46 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getSecondarySubnets.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getSecondarySubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getSecondarySubnets + Retrieve the subnets that exist as secondary interfaces on a VLAN diff --git a/content/reference/services/SoftLayer_Network_Vlan/getSubnets.md b/content/reference/services/SoftLayer_Network_Vlan/getSubnets.md index 9e0754cbc8..2f46ab14a1 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getSubnets.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getSubnets + Retrieve all of the subnets that exist as VLAN interfaces. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getTagReferences.md b/content/reference/services/SoftLayer_Network_Vlan/getTagReferences.md index 2c473c2037..698100f53f 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getTagReferences.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getTagReferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getTagReferences + Retrieve references to all tags for this VLAN. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getTotalPrimaryIpAddressCount.md b/content/reference/services/SoftLayer_Network_Vlan/getTotalPrimaryIpAddressCount.md index 5f0a10b4e9..d197201bc0 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getTotalPrimaryIpAddressCount.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getTotalPrimaryIpAddressCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getTotalPrimaryIpAddressCount + Retrieve the number of primary IP addresses in a VLAN. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getType.md b/content/reference/services/SoftLayer_Network_Vlan/getType.md index cbaedca9e8..549b3a0242 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getType.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getType + Retrieve the type of this VLAN. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getVirtualGuests.md b/content/reference/services/SoftLayer_Network_Vlan/getVirtualGuests.md index bf0e6be8ee..66144e6a00 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getVirtualGuests.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getVirtualGuests + Retrieve all of the Virtual Servers that are connected to a VLAN. diff --git a/content/reference/services/SoftLayer_Network_Vlan/getVlanForIpAddress.md b/content/reference/services/SoftLayer_Network_Vlan/getVlanForIpAddress.md index 94c84e3176..62659bf092 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/getVlanForIpAddress.md +++ b/content/reference/services/SoftLayer_Network_Vlan/getVlanForIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::getVlanForIpAddress + Retrieve an IP addresses's associated VLAN. diff --git a/content/reference/services/SoftLayer_Network_Vlan/setTags.md b/content/reference/services/SoftLayer_Network_Vlan/setTags.md index dbc1e11c74..6077f144c4 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/setTags.md +++ b/content/reference/services/SoftLayer_Network_Vlan/setTags.md @@ -16,6 +16,7 @@ aliases: + ## Overview Tag a VLAN by passing in one or more tags separated by a comma. Tag references are cleared out every time this method is called. If your VLAN is already tagged you will need to pass the current tags along with any new ones. To remove all tag references pass an empty string. To remove one or more tags omit them from the tag list. diff --git a/content/reference/services/SoftLayer_Network_Vlan/updateFirewallIntraVlanCommunication.md b/content/reference/services/SoftLayer_Network_Vlan/updateFirewallIntraVlanCommunication.md index 152ab73a89..2a76482341 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/updateFirewallIntraVlanCommunication.md +++ b/content/reference/services/SoftLayer_Network_Vlan/updateFirewallIntraVlanCommunication.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::updateFirewallIntraVlanCommunication + Update a VLAN's firewall to allow or disallow intra-VLAN communication. diff --git a/content/reference/services/SoftLayer_Network_Vlan/upgrade.md b/content/reference/services/SoftLayer_Network_Vlan/upgrade.md index f94a3ec941..77ade6998c 100644 --- a/content/reference/services/SoftLayer_Network_Vlan/upgrade.md +++ b/content/reference/services/SoftLayer_Network_Vlan/upgrade.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan](/reference/services/SoftLayer_Network_Vlan)::upgrade + Convert the VLAN to a paid resource. That is, from an Automatic to a Premium VLAN. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/_index.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/_index.md index 10dbcd3a25..2af3ba54f9 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/_index.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + 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. ### External Links @@ -56,180 +58,210 @@ The SoftLayer_Network_Vlan_Firewall service accesses general information relatin #### [approveBypassRequest](/reference/services/SoftLayer_Network_Vlan_Firewall/approveBypassRequest) Approve a request from technical support to bypass the firewall. +
              #### [getAccountId](/reference/services/SoftLayer_Network_Vlan_Firewall/getAccountId) +
              #### [getBandwidthAllocation](/reference/services/SoftLayer_Network_Vlan_Firewall/getBandwidthAllocation) Retrieve a firewall's allotted bandwidth (measured in GB). +
              #### [getBillingCycleBandwidthUsage](/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingCycleBandwidthUsage) Retrieve the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this firewall is attached to. +
              #### [getBillingCyclePrivateBandwidthUsage](/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingCyclePrivateBandwidthUsage) Retrieve the raw private bandwidth usage data for the current billing cycle. +
              #### [getBillingCyclePublicBandwidthUsage](/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingCyclePublicBandwidthUsage) Retrieve the raw public bandwidth usage data for the current billing cycle. +
              #### [getBillingItem](/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingItem) Retrieve the billing item for a Hardware Firewall (Dedicated). +
              #### [getBypassRequestStatus](/reference/services/SoftLayer_Network_Vlan_Firewall/getBypassRequestStatus) Retrieve administrative bypass request status. +
              #### [getDatacenter](/reference/services/SoftLayer_Network_Vlan_Firewall/getDatacenter) Retrieve the datacenter that the firewall resides in. +
              #### [getFirewallFirmwareVersion](/reference/services/SoftLayer_Network_Vlan_Firewall/getFirewallFirmwareVersion) +
              #### [getFirewallType](/reference/services/SoftLayer_Network_Vlan_Firewall/getFirewallType) Retrieve the firewall device type. +
              #### [getFullyQualifiedDomainName](/reference/services/SoftLayer_Network_Vlan_Firewall/getFullyQualifiedDomainName) Retrieve a name reflecting the hostname and domain of the firewall. This is created from the combined values of the firewall's logical name and vlan number automatically, and thus can not be edited directly. +
              #### [getManagementCredentials](/reference/services/SoftLayer_Network_Vlan_Firewall/getManagementCredentials) Retrieve the credentials to log in to a firewall device. This is only present for dedicated appliances. +
              #### [getMetricTrackingObject](/reference/services/SoftLayer_Network_Vlan_Firewall/getMetricTrackingObject) Retrieve a firewall's metric tracking object. +
              #### [getMetricTrackingObjectId](/reference/services/SoftLayer_Network_Vlan_Firewall/getMetricTrackingObjectId) Retrieve the metric tracking object ID for this firewall. +
              #### [getNetworkFirewallUpdateRequests](/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkFirewallUpdateRequests) Retrieve the update requests made for this firewall. +
              #### [getNetworkGateway](/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkGateway) Retrieve the gateway associated with this firewall, if any. +
              #### [getNetworkVlan](/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkVlan) Retrieve the VLAN object that a firewall is associated with and protecting. +
              #### [getNetworkVlans](/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkVlans) Retrieve the VLAN objects that a firewall is associated with and protecting. +
              #### [getObject](/reference/services/SoftLayer_Network_Vlan_Firewall/getObject) Retrieve a SoftLayer_Network_Vlan_Firewall record. +
              #### [getRules](/reference/services/SoftLayer_Network_Vlan_Firewall/getRules) Retrieve the currently running rule set of this network component firewall. +
              #### [getTagReferences](/reference/services/SoftLayer_Network_Vlan_Firewall/getTagReferences) +
              #### [getUpgradeRequest](/reference/services/SoftLayer_Network_Vlan_Firewall/getUpgradeRequest) Retrieve a firewall's associated upgrade request object, if any. +
              #### [hasActiveTransactions](/reference/services/SoftLayer_Network_Vlan_Firewall/hasActiveTransactions) +
              #### [isAccountAllowed](/reference/services/SoftLayer_Network_Vlan_Firewall/isAccountAllowed) +
              #### [isHighAvailabilityUpgradeAvailable](/reference/services/SoftLayer_Network_Vlan_Firewall/isHighAvailabilityUpgradeAvailable) +
              #### [rejectBypassRequest](/reference/services/SoftLayer_Network_Vlan_Firewall/rejectBypassRequest) Reject a request from technical support to bypass the firewall. +
              #### [restoreDefaults](/reference/services/SoftLayer_Network_Vlan_Firewall/restoreDefaults) Reset the FSA 10G firewall to factory settings. +
              #### [setTags](/reference/services/SoftLayer_Network_Vlan_Firewall/setTags) +
              #### [updateRouteBypass](/reference/services/SoftLayer_Network_Vlan_Firewall/updateRouteBypass) Enable or disable route bypass. +
              diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/approveBypassRequest.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/approveBypassRequest.md index cead59541c..858f7bdfdf 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/approveBypassRequest.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/approveBypassRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::approveBypassRequest + Approve a request from technical support to bypass the firewall. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getAccountId.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getAccountId.md index 1058c5c005..2e59c96263 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getAccountId.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getAccountId.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBandwidthAllocation.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBandwidthAllocation.md index 66e476a7ab..1d480dcf96 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBandwidthAllocation.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBandwidthAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getBandwidthAllocation + Retrieve a firewall's allotted bandwidth (measured in GB). diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingCycleBandwidthUsage.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingCycleBandwidthUsage.md index d7bfad98c2..b7bf50ab70 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingCycleBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingCycleBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getBillingCycleBandwidthUsage + Retrieve the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this firewall is attached to. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingCyclePrivateBandwidthUsage.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingCyclePrivateBandwidthUsage.md index c770b7446b..b2b2a41f17 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingCyclePrivateBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingCyclePrivateBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getBillingCyclePrivateBandwidthUsage + Retrieve the raw private bandwidth usage data for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingCyclePublicBandwidthUsage.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingCyclePublicBandwidthUsage.md index 217e81c362..b9b3ffb289 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingCyclePublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingCyclePublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getBillingCyclePublicBandwidthUsage + Retrieve the raw public bandwidth usage data for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingItem.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingItem.md index b65b21a0fc..e7ab299e4b 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingItem.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getBillingItem + Retrieve the billing item for a Hardware Firewall (Dedicated). diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBypassRequestStatus.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBypassRequestStatus.md index dc03c7bfd4..3b0509740f 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBypassRequestStatus.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getBypassRequestStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getBypassRequestStatus + Retrieve administrative bypass request status. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getDatacenter.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getDatacenter.md index d09b6cc857..148791b499 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getDatacenter.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getDatacenter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getDatacenter + Retrieve the datacenter that the firewall resides in. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getFirewallFirmwareVersion.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getFirewallFirmwareVersion.md index 248257470f..e42c97500d 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getFirewallFirmwareVersion.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getFirewallFirmwareVersion.md @@ -16,6 +16,7 @@ aliases: + ## Overview Retrieve the firewall device firmware version from database. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getFirewallType.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getFirewallType.md index aac6ea8ca4..01efd062c4 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getFirewallType.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getFirewallType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getFirewallType + Retrieve the firewall device type. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getFullyQualifiedDomainName.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getFullyQualifiedDomainName.md index af3adba317..b2641b14da 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getFullyQualifiedDomainName.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getFullyQualifiedDomainName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getFullyQualifiedDomainName + Retrieve a name reflecting the hostname and domain of the firewall. This is created from the combined values of the firewall's logical name and vlan number automatically, and thus can not be edited directly. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getManagementCredentials.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getManagementCredentials.md index 0a662408b9..20c0c61895 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getManagementCredentials.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getManagementCredentials.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getManagementCredentials + Retrieve the credentials to log in to a firewall device. This is only present for dedicated appliances. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getMetricTrackingObject.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getMetricTrackingObject.md index 4cc0f8f83e..168d8f5692 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getMetricTrackingObject.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getMetricTrackingObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getMetricTrackingObject + Retrieve a firewall's metric tracking object. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getMetricTrackingObjectId.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getMetricTrackingObjectId.md index acbe51f198..523f5cd2af 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getMetricTrackingObjectId.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getMetricTrackingObjectId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getMetricTrackingObjectId + Retrieve the metric tracking object ID for this firewall. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkFirewallUpdateRequests.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkFirewallUpdateRequests.md index 2f9b1dc7a5..2f7f089c7d 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkFirewallUpdateRequests.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkFirewallUpdateRequests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getNetworkFirewallUpdateRequests + Retrieve the update requests made for this firewall. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkGateway.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkGateway.md index 2b992f6cf5..a9c7538c02 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkGateway.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkGateway.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getNetworkGateway + Retrieve the gateway associated with this firewall, if any. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkVlan.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkVlan.md index 87e38ba0b7..6b13b6cb27 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkVlan.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkVlan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getNetworkVlan + Retrieve the VLAN object that a firewall is associated with and protecting. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkVlans.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkVlans.md index a4395d1781..fa96f4bae4 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkVlans.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getNetworkVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getNetworkVlans + Retrieve the VLAN objects that a firewall is associated with and protecting. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getObject.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getObject.md index 7f430fbbd6..8aa9f32193 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getObject.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getObject + Retrieve a SoftLayer_Network_Vlan_Firewall record. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getRules.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getRules.md index 5386ec934a..184109fe1b 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getRules.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getRules.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getRules + Retrieve the currently running rule set of this network component firewall. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getTagReferences.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getTagReferences.md index 082632439f..266dec2f40 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getTagReferences.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getTagReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getUpgradeRequest.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getUpgradeRequest.md index f57c20b34c..1dcd512fc9 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/getUpgradeRequest.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/getUpgradeRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::getUpgradeRequest + Retrieve a firewall's associated upgrade request object, if any. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/hasActiveTransactions.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/hasActiveTransactions.md index 4317e3165c..68769a363b 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/hasActiveTransactions.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/hasActiveTransactions.md @@ -16,6 +16,7 @@ aliases: + ## Overview Check for active transactions for the Firewall. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/isAccountAllowed.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/isAccountAllowed.md index d30068e5a6..03d40b68cb 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/isAccountAllowed.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/isAccountAllowed.md @@ -16,6 +16,7 @@ aliases: + ## Overview Checks if the account is allowed to use some features of FSA1G and Hardware firewall (Dedicated) diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/isHighAvailabilityUpgradeAvailable.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/isHighAvailabilityUpgradeAvailable.md index 106cc1c5bd..30513d7916 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/isHighAvailabilityUpgradeAvailable.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/isHighAvailabilityUpgradeAvailable.md @@ -16,6 +16,7 @@ aliases: + ## Overview Whether this firewall qualifies for High Availability upgrade. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/rejectBypassRequest.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/rejectBypassRequest.md index 239eeb840e..3b31173c23 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/rejectBypassRequest.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/rejectBypassRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::rejectBypassRequest + Reject a request from technical support to bypass the firewall. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/restoreDefaults.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/restoreDefaults.md index 39e02c6e95..998652cc64 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/restoreDefaults.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/restoreDefaults.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::restoreDefaults + Reset the FSA 10G firewall to factory settings. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/setTags.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/setTags.md index 67e93a8e7e..7f3b2efbb8 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/setTags.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/setTags.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method will associate a comma separated list of tags with this object. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Firewall/updateRouteBypass.md b/content/reference/services/SoftLayer_Network_Vlan_Firewall/updateRouteBypass.md index 6890458fd9..a90ecefd83 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Firewall/updateRouteBypass.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Firewall/updateRouteBypass.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Firewall](/reference/services/SoftLayer_Network_Vlan_Firewall)::updateRouteBypass + Enable or disable route bypass. diff --git a/content/reference/services/SoftLayer_Network_Vlan_Type/_index.md b/content/reference/services/SoftLayer_Network_Vlan_Type/_index.md index 33c639e521..5abcf4d050 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Type/_index.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Type/_index.md @@ -21,6 +21,8 @@ classes: ## Description + + A network VLAN type is a value representing the type of a network VLAN. The possible values are: @@ -49,6 +51,7 @@ A network VLAN type is a value representing the type of a network VLAN. The poss #### [getObject](/reference/services/SoftLayer_Network_Vlan_Type/getObject) Retrieve a SoftLayer_Network_Vlan_Type record. + diff --git a/content/reference/services/SoftLayer_Network_Vlan_Type/getObject.md b/content/reference/services/SoftLayer_Network_Vlan_Type/getObject.md index bdb2fb2be5..5ea4083850 100644 --- a/content/reference/services/SoftLayer_Network_Vlan_Type/getObject.md +++ b/content/reference/services/SoftLayer_Network_Vlan_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Network_Vlan_Type](/reference/services/SoftLayer_Network_Vlan_Type)::getObject + Retrieve a SoftLayer_Network_Vlan_Type record. diff --git a/content/reference/services/SoftLayer_Notification/_index.md b/content/reference/services/SoftLayer_Notification/_index.md index bb24bacf3e..90114b5e55 100644 --- a/content/reference/services/SoftLayer_Notification/_index.md +++ b/content/reference/services/SoftLayer_Notification/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,24 +44,28 @@ SoftLayer Customers can use this service to view all of the available notificati #### [getAllObjects](/reference/services/SoftLayer_Notification/getAllObjects) Retrieve all Notifications that can be subscribed to. +
              #### [getObject](/reference/services/SoftLayer_Notification/getObject) Retrieve a SoftLayer_Notification record. +
              #### [getPreferences](/reference/services/SoftLayer_Notification/getPreferences) Retrieve the preferences related to the notification. These are preferences are configurable and optional for subscribers to use. +
              #### [getRequiredPreferences](/reference/services/SoftLayer_Notification/getRequiredPreferences) Retrieve the required preferences related to the notification. While configurable, the subscriber does not have the option whether to use the preference. +
              diff --git a/content/reference/services/SoftLayer_Notification/getAllObjects.md b/content/reference/services/SoftLayer_Notification/getAllObjects.md index b08c4dfb7b..655b3a9c18 100644 --- a/content/reference/services/SoftLayer_Notification/getAllObjects.md +++ b/content/reference/services/SoftLayer_Notification/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification](/reference/services/SoftLayer_Notification)::getAllObjects + Retrieve all Notifications that can be subscribed to. diff --git a/content/reference/services/SoftLayer_Notification/getObject.md b/content/reference/services/SoftLayer_Notification/getObject.md index 4f0684d88f..a3ea9ea396 100644 --- a/content/reference/services/SoftLayer_Notification/getObject.md +++ b/content/reference/services/SoftLayer_Notification/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification](/reference/services/SoftLayer_Notification)::getObject + Retrieve a SoftLayer_Notification record. diff --git a/content/reference/services/SoftLayer_Notification/getPreferences.md b/content/reference/services/SoftLayer_Notification/getPreferences.md index ad821947ee..693ab14331 100644 --- a/content/reference/services/SoftLayer_Notification/getPreferences.md +++ b/content/reference/services/SoftLayer_Notification/getPreferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification](/reference/services/SoftLayer_Notification)::getPreferences + Retrieve the preferences related to the notification. These are preferences are configurable and optional for subscribers to use. diff --git a/content/reference/services/SoftLayer_Notification/getRequiredPreferences.md b/content/reference/services/SoftLayer_Notification/getRequiredPreferences.md index 87a8044581..84bb5dee93 100644 --- a/content/reference/services/SoftLayer_Notification/getRequiredPreferences.md +++ b/content/reference/services/SoftLayer_Notification/getRequiredPreferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification](/reference/services/SoftLayer_Notification)::getRequiredPreferences + Retrieve the required preferences related to the notification. While configurable, the subscriber does not have the option whether to use the preference. diff --git a/content/reference/services/SoftLayer_Notification_Mobile/_index.md b/content/reference/services/SoftLayer_Notification_Mobile/_index.md index eda5a22601..a310a537ba 100644 --- a/content/reference/services/SoftLayer_Notification_Mobile/_index.md +++ b/content/reference/services/SoftLayer_Notification_Mobile/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer Customers can use this service to view all of the available mobile notifications that can be subscribed to. No mobile notifications are required. @@ -42,30 +44,35 @@ SoftLayer Customers can use this service to view all of the available mobile not #### [createSubscriberForMobileDevice](/reference/services/SoftLayer_Notification_Mobile/createSubscriberForMobileDevice) Create a new subscriber for a given resource. +
              #### [getAllObjects](/reference/services/SoftLayer_Notification_Mobile/getAllObjects) Retrieve all Notifications that can be subscribed to. +
              #### [getObject](/reference/services/SoftLayer_Notification_Mobile/getObject) Retrieve a SoftLayer_Notification_Mobile record. +
              #### [getPreferences](/reference/services/SoftLayer_Notification_Mobile/getPreferences) Retrieve the preferences related to the notification. These are preferences are configurable and optional for subscribers to use. +
              #### [getRequiredPreferences](/reference/services/SoftLayer_Notification_Mobile/getRequiredPreferences) Retrieve the required preferences related to the notification. While configurable, the subscriber does not have the option whether to use the preference. +
              diff --git a/content/reference/services/SoftLayer_Notification_Mobile/createSubscriberForMobileDevice.md b/content/reference/services/SoftLayer_Notification_Mobile/createSubscriberForMobileDevice.md index 2f5407e6f9..fdbe3ddc0e 100644 --- a/content/reference/services/SoftLayer_Notification_Mobile/createSubscriberForMobileDevice.md +++ b/content/reference/services/SoftLayer_Notification_Mobile/createSubscriberForMobileDevice.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Mobile](/reference/services/SoftLayer_Notification_Mobile)::createSubscriberForMobileDevice + Create a new subscriber for a given resource. diff --git a/content/reference/services/SoftLayer_Notification_Mobile/getAllObjects.md b/content/reference/services/SoftLayer_Notification_Mobile/getAllObjects.md index fe26b404a5..3bcf7ab6d3 100644 --- a/content/reference/services/SoftLayer_Notification_Mobile/getAllObjects.md +++ b/content/reference/services/SoftLayer_Notification_Mobile/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Mobile](/reference/services/SoftLayer_Notification_Mobile)::getAllObjects + Retrieve all Notifications that can be subscribed to. diff --git a/content/reference/services/SoftLayer_Notification_Mobile/getObject.md b/content/reference/services/SoftLayer_Notification_Mobile/getObject.md index 0b752d3363..b42d92b935 100644 --- a/content/reference/services/SoftLayer_Notification_Mobile/getObject.md +++ b/content/reference/services/SoftLayer_Notification_Mobile/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Mobile](/reference/services/SoftLayer_Notification_Mobile)::getObject + Retrieve a SoftLayer_Notification_Mobile record. diff --git a/content/reference/services/SoftLayer_Notification_Mobile/getPreferences.md b/content/reference/services/SoftLayer_Notification_Mobile/getPreferences.md index ccea984fbd..71f2bbdc31 100644 --- a/content/reference/services/SoftLayer_Notification_Mobile/getPreferences.md +++ b/content/reference/services/SoftLayer_Notification_Mobile/getPreferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Mobile](/reference/services/SoftLayer_Notification_Mobile)::getPreferences + Retrieve the preferences related to the notification. These are preferences are configurable and optional for subscribers to use. diff --git a/content/reference/services/SoftLayer_Notification_Mobile/getRequiredPreferences.md b/content/reference/services/SoftLayer_Notification_Mobile/getRequiredPreferences.md index 8c2ea1a8b1..564346693c 100644 --- a/content/reference/services/SoftLayer_Notification_Mobile/getRequiredPreferences.md +++ b/content/reference/services/SoftLayer_Notification_Mobile/getRequiredPreferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Mobile](/reference/services/SoftLayer_Notification_Mobile)::getRequiredPreferences + Retrieve the required preferences related to the notification. While configurable, the subscriber does not have the option whether to use the preference. diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_Event/_index.md b/content/reference/services/SoftLayer_Notification_Occurrence_Event/_index.md index 136aaeb299..df1205685b 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_Event/_index.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_Event/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The [SoftLayer_Notification_Occurrence_Event]({{}}) service represents all events with potential to cause a disruption in service. @@ -42,102 +44,119 @@ The [SoftLayer_Notification_Occurrence_Event]({{
              #### [getAcknowledgedFlag](/reference/services/SoftLayer_Notification_Occurrence_Event/getAcknowledgedFlag) Retrieve indicates whether or not this event has been acknowledged by the user. +
              #### [getAllObjects](/reference/services/SoftLayer_Notification_Occurrence_Event/getAllObjects) +
              #### [getAttachedFile](/reference/services/SoftLayer_Notification_Occurrence_Event/getAttachedFile) Retrieve a file attached to an event. +
              #### [getAttachments](/reference/services/SoftLayer_Notification_Occurrence_Event/getAttachments) Retrieve a collection of attachments for this event which provide supplementary information to impacted users some examples are RFO (Reason For Outage) and root cause analysis documents. +
              #### [getFirstUpdate](/reference/services/SoftLayer_Notification_Occurrence_Event/getFirstUpdate) Retrieve the first update for this event. +
              #### [getImpactedAccountCount](/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedAccountCount) Get the number of impacted owned accounts for the current user. +
              #### [getImpactedAccounts](/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedAccounts) Retrieve a collection of accounts impacted by this event. Each impacted account record relates directly to a [SoftLayer_Account]({{}}). +
              #### [getImpactedDeviceCount](/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedDeviceCount) Get the number of impacted devices. +
              #### [getImpactedDevices](/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedDevices) Get devices impacted by this event +
              #### [getImpactedResources](/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedResources) Retrieve a collection of resources impacted by this event. Each record will relate to some physical resource that the user has access to such as [SoftLayer_Hardware]({{}}) or [SoftLayer_Virtual_Guest]({{}}). +
              #### [getImpactedUsers](/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedUsers) Retrieve a collection of users impacted by this event. Each impacted user record relates directly to a [SoftLayer_User_Customer]({{}}). +
              #### [getLastUpdate](/reference/services/SoftLayer_Notification_Occurrence_Event/getLastUpdate) Retrieve the last update for this event. +
              #### [getNotificationOccurrenceEventType](/reference/services/SoftLayer_Notification_Occurrence_Event/getNotificationOccurrenceEventType) Retrieve the type of event such as planned or unplanned maintenance. +
              #### [getObject](/reference/services/SoftLayer_Notification_Occurrence_Event/getObject) Retrieve a SoftLayer_Notification_Occurrence_Event record. +
              #### [getStatusCode](/reference/services/SoftLayer_Notification_Occurrence_Event/getStatusCode) +
              #### [getUpdates](/reference/services/SoftLayer_Notification_Occurrence_Event/getUpdates) Retrieve all updates for this event. +
              diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_Event/acknowledgeNotification.md b/content/reference/services/SoftLayer_Notification_Occurrence_Event/acknowledgeNotification.md index abd20b2e4e..af9d04216a 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_Event/acknowledgeNotification.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_Event/acknowledgeNotification.md @@ -16,6 +16,7 @@ aliases: + ## Overview <<<< EOT diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getAcknowledgedFlag.md b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getAcknowledgedFlag.md index 9f00171182..32d1a65815 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getAcknowledgedFlag.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getAcknowledgedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_Event](/reference/services/SoftLayer_Notification_Occurrence_Event)::getAcknowledgedFlag + Retrieve indicates whether or not this event has been acknowledged by the user. diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getAllObjects.md b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getAllObjects.md index aa8829b8e8..855184fa8c 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getAllObjects.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getAttachedFile.md b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getAttachedFile.md index e80305bbaf..d3737a3400 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getAttachedFile.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getAttachedFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_Event](/reference/services/SoftLayer_Notification_Occurrence_Event)::getAttachedFile + Retrieve a file attached to an event. diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getAttachments.md b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getAttachments.md index e186abaab2..7fdcee4ce8 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getAttachments.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getAttachments.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_Event](/reference/services/SoftLayer_Notification_Occurrence_Event)::getAttachments + Retrieve a collection of attachments for this event which provide supplementary information to impacted users some examples are RFO (Reason For Outage) and root cause analysis documents. diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getFirstUpdate.md b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getFirstUpdate.md index a482c51ace..2844101155 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getFirstUpdate.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getFirstUpdate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_Event](/reference/services/SoftLayer_Notification_Occurrence_Event)::getFirstUpdate + Retrieve the first update for this event. diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedAccountCount.md b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedAccountCount.md index db278ccbe3..22d6200cf7 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedAccountCount.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedAccountCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_Event](/reference/services/SoftLayer_Notification_Occurrence_Event)::getImpactedAccountCount + Get the number of impacted owned accounts for the current user. diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedAccounts.md b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedAccounts.md index 4cbca0d10c..9152589269 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedAccounts.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedAccounts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_Event](/reference/services/SoftLayer_Notification_Occurrence_Event)::getImpactedAccounts + Retrieve a collection of accounts impacted by this event. Each impacted account record relates directly to a [SoftLayer_Account]({{}}). diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedDeviceCount.md b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedDeviceCount.md index f55dea5e65..c0000d0495 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedDeviceCount.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedDeviceCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_Event](/reference/services/SoftLayer_Notification_Occurrence_Event)::getImpactedDeviceCount + Get the number of impacted devices. diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedDevices.md b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedDevices.md index 80595a4068..735c89a27d 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedDevices.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedDevices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_Event](/reference/services/SoftLayer_Notification_Occurrence_Event)::getImpactedDevices + Get devices impacted by this event diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedResources.md b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedResources.md index acdb5138cf..d396fb7339 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedResources.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedResources.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_Event](/reference/services/SoftLayer_Notification_Occurrence_Event)::getImpactedResources + Retrieve a collection of resources impacted by this event. Each record will relate to some physical resource that the user has access to such as [SoftLayer_Hardware]({{}}) or [SoftLayer_Virtual_Guest]({{}}). diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedUsers.md b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedUsers.md index f3fe69b8d3..e193e7bebc 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedUsers.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getImpactedUsers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_Event](/reference/services/SoftLayer_Notification_Occurrence_Event)::getImpactedUsers + Retrieve a collection of users impacted by this event. Each impacted user record relates directly to a [SoftLayer_User_Customer]({{}}). diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getLastUpdate.md b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getLastUpdate.md index 72ada7f23d..3766e9844f 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getLastUpdate.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getLastUpdate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_Event](/reference/services/SoftLayer_Notification_Occurrence_Event)::getLastUpdate + Retrieve the last update for this event. diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getNotificationOccurrenceEventType.md b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getNotificationOccurrenceEventType.md index ade2f64221..6fa4eaf35b 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getNotificationOccurrenceEventType.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getNotificationOccurrenceEventType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_Event](/reference/services/SoftLayer_Notification_Occurrence_Event)::getNotificationOccurrenceEventType + Retrieve the type of event such as planned or unplanned maintenance. diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getObject.md b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getObject.md index 8c247c3b1a..1eea44d283 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getObject.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_Event](/reference/services/SoftLayer_Notification_Occurrence_Event)::getObject + Retrieve a SoftLayer_Notification_Occurrence_Event record. diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getStatusCode.md b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getStatusCode.md index 5f397b66fb..c8a787af36 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getStatusCode.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getStatusCode.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getUpdates.md b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getUpdates.md index ed4b703eda..a62223d3dd 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_Event/getUpdates.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_Event/getUpdates.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_Event](/reference/services/SoftLayer_Notification_Occurrence_Event)::getUpdates + Retrieve all updates for this event. diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_User/_index.md b/content/reference/services/SoftLayer_Notification_Occurrence_User/_index.md index b8a0388ae3..91c58819de 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_User/_index.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_User/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,42 +44,49 @@ classes: #### [acknowledge](/reference/services/SoftLayer_Notification_Occurrence_User/acknowledge) Acknowledge the associated [SoftLayer_Notification_Occurrence_Event]({{}}) for this impacted user. +
              #### [getAllObjects](/reference/services/SoftLayer_Notification_Occurrence_User/getAllObjects) Returns a collection of impacted users, an account master user has the ability to see all impacted users under the account. +
              #### [getImpactedDeviceCount](/reference/services/SoftLayer_Notification_Occurrence_User/getImpactedDeviceCount) A count representing the number of the user's devices currently impacted by the associated event will be returned. +
              #### [getImpactedResources](/reference/services/SoftLayer_Notification_Occurrence_User/getImpactedResources) Retrieve a collection of resources impacted by the associated event. +
              #### [getNotificationOccurrenceEvent](/reference/services/SoftLayer_Notification_Occurrence_User/getNotificationOccurrenceEvent) Retrieve the associated event. +
              #### [getObject](/reference/services/SoftLayer_Notification_Occurrence_User/getObject) Retrieve a SoftLayer_Notification_Occurrence_User record. +
              #### [getUser](/reference/services/SoftLayer_Notification_Occurrence_User/getUser) Retrieve the impacted user. +
              diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_User/acknowledge.md b/content/reference/services/SoftLayer_Notification_Occurrence_User/acknowledge.md index cf9370283c..d1257c5bd7 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_User/acknowledge.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_User/acknowledge.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_User](/reference/services/SoftLayer_Notification_Occurrence_User)::acknowledge + Acknowledge the associated [SoftLayer_Notification_Occurrence_Event]({{}}) for this impacted user. diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_User/getAllObjects.md b/content/reference/services/SoftLayer_Notification_Occurrence_User/getAllObjects.md index b58eb9a4a1..bdf340ce70 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_User/getAllObjects.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_User/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_User](/reference/services/SoftLayer_Notification_Occurrence_User)::getAllObjects + Returns a collection of impacted users, an account master user has the ability to see all impacted users under the account. diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_User/getImpactedDeviceCount.md b/content/reference/services/SoftLayer_Notification_Occurrence_User/getImpactedDeviceCount.md index c26a02288f..4cb2c7ae17 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_User/getImpactedDeviceCount.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_User/getImpactedDeviceCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_User](/reference/services/SoftLayer_Notification_Occurrence_User)::getImpactedDeviceCount + A count representing the number of the user's devices currently impacted by the associated event will be returned. diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_User/getImpactedResources.md b/content/reference/services/SoftLayer_Notification_Occurrence_User/getImpactedResources.md index 2038304dca..d88f723aff 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_User/getImpactedResources.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_User/getImpactedResources.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_User](/reference/services/SoftLayer_Notification_Occurrence_User)::getImpactedResources + Retrieve a collection of resources impacted by the associated event. diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_User/getNotificationOccurrenceEvent.md b/content/reference/services/SoftLayer_Notification_Occurrence_User/getNotificationOccurrenceEvent.md index fde24ee47c..7b4089b1e1 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_User/getNotificationOccurrenceEvent.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_User/getNotificationOccurrenceEvent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_User](/reference/services/SoftLayer_Notification_Occurrence_User)::getNotificationOccurrenceEvent + Retrieve the associated event. diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_User/getObject.md b/content/reference/services/SoftLayer_Notification_Occurrence_User/getObject.md index fbd32d32bc..4ad17d553d 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_User/getObject.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_User/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_User](/reference/services/SoftLayer_Notification_Occurrence_User)::getObject + Retrieve a SoftLayer_Notification_Occurrence_User record. diff --git a/content/reference/services/SoftLayer_Notification_Occurrence_User/getUser.md b/content/reference/services/SoftLayer_Notification_Occurrence_User/getUser.md index 487298641d..032a47f44a 100644 --- a/content/reference/services/SoftLayer_Notification_Occurrence_User/getUser.md +++ b/content/reference/services/SoftLayer_Notification_Occurrence_User/getUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_Occurrence_User](/reference/services/SoftLayer_Notification_Occurrence_User)::getUser + Retrieve the impacted user. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber/_index.md b/content/reference/services/SoftLayer_Notification_User_Subscriber/_index.md index 7c4d33069c..51e7c31bbd 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber/_index.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,54 +44,63 @@ SoftLayer Customers can subscribe to receive notifications for various notificat #### [createObject](/reference/services/SoftLayer_Notification_User_Subscriber/createObject) Create a new notification subscriber. +
              #### [editObject](/reference/services/SoftLayer_Notification_User_Subscriber/editObject) Edit a notification subscriber active status +
              #### [getDeliveryMethods](/reference/services/SoftLayer_Notification_User_Subscriber/getDeliveryMethods) Retrieve the delivery methods used to send the subscribed notification. +
              #### [getNotification](/reference/services/SoftLayer_Notification_User_Subscriber/getNotification) Retrieve notification subscribed to. +
              #### [getObject](/reference/services/SoftLayer_Notification_User_Subscriber/getObject) Retrieve a SoftLayer_Notification_User_Subscriber record. +
              #### [getPreferences](/reference/services/SoftLayer_Notification_User_Subscriber/getPreferences) Retrieve associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold. +
              #### [getPreferencesDetails](/reference/services/SoftLayer_Notification_User_Subscriber/getPreferencesDetails) Retrieve preference details such as description, minimum and maximum limits, default value and unit of measure. +
              #### [getResourceRecord](/reference/services/SoftLayer_Notification_User_Subscriber/getResourceRecord) Retrieve the subscriber id to resource id mapping. +
              #### [getUserRecord](/reference/services/SoftLayer_Notification_User_Subscriber/getUserRecord) Retrieve user record for the subscription. +
              diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber/createObject.md b/content/reference/services/SoftLayer_Notification_User_Subscriber/createObject.md index 197a3fdcbd..c38467102d 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber/createObject.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber](/reference/services/SoftLayer_Notification_User_Subscriber)::createObject + Create a new notification subscriber. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber/editObject.md b/content/reference/services/SoftLayer_Notification_User_Subscriber/editObject.md index f103c0ba51..1dbff0298e 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber/editObject.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber/editObject.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber](/reference/services/SoftLayer_Notification_User_Subscriber)::editObject + Edit a notification subscriber active status diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber/getDeliveryMethods.md b/content/reference/services/SoftLayer_Notification_User_Subscriber/getDeliveryMethods.md index 026b97bc6e..644deed55e 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber/getDeliveryMethods.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber/getDeliveryMethods.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber](/reference/services/SoftLayer_Notification_User_Subscriber)::getDeliveryMethods + Retrieve the delivery methods used to send the subscribed notification. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber/getNotification.md b/content/reference/services/SoftLayer_Notification_User_Subscriber/getNotification.md index 54654792b8..84a4ca359a 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber/getNotification.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber/getNotification.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber](/reference/services/SoftLayer_Notification_User_Subscriber)::getNotification + Retrieve notification subscribed to. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber/getObject.md b/content/reference/services/SoftLayer_Notification_User_Subscriber/getObject.md index 4311938356..5c977d879b 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber/getObject.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber](/reference/services/SoftLayer_Notification_User_Subscriber)::getObject + Retrieve a SoftLayer_Notification_User_Subscriber record. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber/getPreferences.md b/content/reference/services/SoftLayer_Notification_User_Subscriber/getPreferences.md index 555f4c3e2a..27aad979e9 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber/getPreferences.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber/getPreferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber](/reference/services/SoftLayer_Notification_User_Subscriber)::getPreferences + Retrieve associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber/getPreferencesDetails.md b/content/reference/services/SoftLayer_Notification_User_Subscriber/getPreferencesDetails.md index 464915457a..2d480b1b36 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber/getPreferencesDetails.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber/getPreferencesDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber](/reference/services/SoftLayer_Notification_User_Subscriber)::getPreferencesDetails + Retrieve preference details such as description, minimum and maximum limits, default value and unit of measure. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber/getResourceRecord.md b/content/reference/services/SoftLayer_Notification_User_Subscriber/getResourceRecord.md index 365d4a7724..48a9de3f4e 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber/getResourceRecord.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber/getResourceRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber](/reference/services/SoftLayer_Notification_User_Subscriber)::getResourceRecord + Retrieve the subscriber id to resource id mapping. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber/getUserRecord.md b/content/reference/services/SoftLayer_Notification_User_Subscriber/getUserRecord.md index 7637291134..456405527a 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber/getUserRecord.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber/getUserRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber](/reference/services/SoftLayer_Notification_User_Subscriber)::getUserRecord + Retrieve user record for the subscription. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/_index.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/_index.md index 8da78850c2..45d52d8368 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/_index.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,54 +44,63 @@ SoftLayer Customers can subscribe to receive notifications for various notificat #### [createObject](/reference/services/SoftLayer_Notification_User_Subscriber_Billing/createObject) Create a new notification subscriber. +
              #### [editObject](/reference/services/SoftLayer_Notification_User_Subscriber_Billing/editObject) Edit a notification subscriber active status +
              #### [getDeliveryMethods](/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getDeliveryMethods) Retrieve the delivery methods used to send the subscribed notification. +
              #### [getNotification](/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getNotification) Retrieve notification subscribed to. +
              #### [getObject](/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getObject) Retrieve a SoftLayer_Notification_User_Subscriber_Billing record. +
              #### [getPreferences](/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getPreferences) Retrieve associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold. +
              #### [getPreferencesDetails](/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getPreferencesDetails) Retrieve preference details such as description, minimum and maximum limits, default value and unit of measure. +
              #### [getResourceRecord](/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getResourceRecord) Retrieve the subscriber id to resource id mapping. +
              #### [getUserRecord](/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getUserRecord) Retrieve user record for the subscription. +
              diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/createObject.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/createObject.md index fc0ea67fca..4a8f8678df 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/createObject.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Billing](/reference/services/SoftLayer_Notification_User_Subscriber_Billing)::createObject + Create a new notification subscriber. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/editObject.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/editObject.md index 00b7c98b7f..3942abb91a 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/editObject.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/editObject.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Billing](/reference/services/SoftLayer_Notification_User_Subscriber_Billing)::editObject + Edit a notification subscriber active status diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getDeliveryMethods.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getDeliveryMethods.md index 6f33561e8c..fdc9f3e113 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getDeliveryMethods.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getDeliveryMethods.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Billing](/reference/services/SoftLayer_Notification_User_Subscriber_Billing)::getDeliveryMethods + Retrieve the delivery methods used to send the subscribed notification. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getNotification.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getNotification.md index c55fd237a7..b37c7ce4b0 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getNotification.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getNotification.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Billing](/reference/services/SoftLayer_Notification_User_Subscriber_Billing)::getNotification + Retrieve notification subscribed to. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getObject.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getObject.md index 25265907c8..3a86a8272a 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getObject.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Billing](/reference/services/SoftLayer_Notification_User_Subscriber_Billing)::getObject + Retrieve a SoftLayer_Notification_User_Subscriber_Billing record. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getPreferences.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getPreferences.md index 59114b71a9..27f561feb2 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getPreferences.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getPreferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Billing](/reference/services/SoftLayer_Notification_User_Subscriber_Billing)::getPreferences + Retrieve associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getPreferencesDetails.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getPreferencesDetails.md index d08ef77edf..0a0424f0bc 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getPreferencesDetails.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getPreferencesDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Billing](/reference/services/SoftLayer_Notification_User_Subscriber_Billing)::getPreferencesDetails + Retrieve preference details such as description, minimum and maximum limits, default value and unit of measure. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getResourceRecord.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getResourceRecord.md index 5c3a93c728..96cf659d16 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getResourceRecord.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getResourceRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Billing](/reference/services/SoftLayer_Notification_User_Subscriber_Billing)::getResourceRecord + Retrieve the subscriber id to resource id mapping. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getUserRecord.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getUserRecord.md index 595e83f8af..fdd5ff413b 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getUserRecord.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Billing/getUserRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Billing](/reference/services/SoftLayer_Notification_User_Subscriber_Billing)::getUserRecord + Retrieve user record for the subscription. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/_index.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/_index.md index d8bfdd6d19..c15a71c650 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/_index.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,66 +44,77 @@ SoftLayer Customers can subscribe to receive notifications for various notificat #### [clearSnoozeTimer](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/clearSnoozeTimer) +
              #### [createObject](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/createObject) Create a new notification subscriber. +
              #### [editObject](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/editObject) Edit a notification subscriber active status +
              #### [getDeliveryMethods](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getDeliveryMethods) Retrieve the delivery methods used to send the subscribed notification. +
              #### [getNotification](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getNotification) Retrieve notification subscribed to. +
              #### [getObject](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getObject) Retrieve a SoftLayer_Notification_User_Subscriber_Mobile record. +
              #### [getPreferences](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getPreferences) Retrieve associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold. +
              #### [getPreferencesDetails](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getPreferencesDetails) Retrieve preference details such as description, minimum and maximum limits, default value and unit of measure. +
              #### [getResourceRecord](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getResourceRecord) Retrieve the subscriber id to resource id mapping. +
              #### [getUserRecord](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getUserRecord) Retrieve user record for the subscription. +
              #### [setSnoozeTimer](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/setSnoozeTimer) +
              diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/clearSnoozeTimer.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/clearSnoozeTimer.md index 95438bbc21..f2619d3b06 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/clearSnoozeTimer.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/clearSnoozeTimer.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/createObject.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/createObject.md index 146cbd48b5..a0857fe202 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/createObject.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Mobile](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile)::createObject + Create a new notification subscriber. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/editObject.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/editObject.md index 1cc7907d86..bf87cedb94 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/editObject.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/editObject.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Mobile](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile)::editObject + Edit a notification subscriber active status diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getDeliveryMethods.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getDeliveryMethods.md index 3e3f295c1b..6d83e0ee2a 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getDeliveryMethods.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getDeliveryMethods.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Mobile](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile)::getDeliveryMethods + Retrieve the delivery methods used to send the subscribed notification. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getNotification.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getNotification.md index c0894081c3..f183b6d8d7 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getNotification.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getNotification.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Mobile](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile)::getNotification + Retrieve notification subscribed to. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getObject.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getObject.md index 6eafdc992b..b6f62c8042 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getObject.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Mobile](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile)::getObject + Retrieve a SoftLayer_Notification_User_Subscriber_Mobile record. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getPreferences.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getPreferences.md index e282ea1525..2d61ead30d 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getPreferences.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getPreferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Mobile](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile)::getPreferences + Retrieve associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getPreferencesDetails.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getPreferencesDetails.md index 374627208f..9d41cb417b 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getPreferencesDetails.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getPreferencesDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Mobile](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile)::getPreferencesDetails + Retrieve preference details such as description, minimum and maximum limits, default value and unit of measure. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getResourceRecord.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getResourceRecord.md index 74d077b1f8..044d895566 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getResourceRecord.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getResourceRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Mobile](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile)::getResourceRecord + Retrieve the subscriber id to resource id mapping. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getUserRecord.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getUserRecord.md index d4f0be351e..69654151a7 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getUserRecord.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/getUserRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Mobile](/reference/services/SoftLayer_Notification_User_Subscriber_Mobile)::getUserRecord + Retrieve user record for the subscription. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/setSnoozeTimer.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/setSnoozeTimer.md index f30a08e17e..7f142a4a99 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/setSnoozeTimer.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Mobile/setSnoozeTimer.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/_index.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/_index.md index 551d1aa9d0..9ecb4d24f3 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/_index.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,30 +44,35 @@ classes: #### [createObject](/reference/services/SoftLayer_Notification_User_Subscriber_Preference/createObject) Create a new notification preference for a subscriber. +
              #### [editObjects](/reference/services/SoftLayer_Notification_User_Subscriber_Preference/editObjects) +
              #### [getDefaultPreference](/reference/services/SoftLayer_Notification_User_Subscriber_Preference/getDefaultPreference) Retrieve details such name, keyname, minimum and maximum values for the preference. +
              #### [getNotificationUserSubscriber](/reference/services/SoftLayer_Notification_User_Subscriber_Preference/getNotificationUserSubscriber) Retrieve details of the subscriber tied to the preference. +
              #### [getObject](/reference/services/SoftLayer_Notification_User_Subscriber_Preference/getObject) Retrieve a SoftLayer_Notification_User_Subscriber_Preference record. +
              diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/createObject.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/createObject.md index a71b11b277..221fd274a6 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/createObject.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Preference](/reference/services/SoftLayer_Notification_User_Subscriber_Preference)::createObject + Create a new notification preference for a subscriber. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/editObjects.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/editObjects.md index c21223d620..37ca8df540 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/editObjects.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/editObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/getDefaultPreference.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/getDefaultPreference.md index c76391dfe5..ee309e1fda 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/getDefaultPreference.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/getDefaultPreference.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Preference](/reference/services/SoftLayer_Notification_User_Subscriber_Preference)::getDefaultPreference + Retrieve details such name, keyname, minimum and maximum values for the preference. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/getNotificationUserSubscriber.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/getNotificationUserSubscriber.md index fbfa813137..4c2e85d6cb 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/getNotificationUserSubscriber.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/getNotificationUserSubscriber.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Preference](/reference/services/SoftLayer_Notification_User_Subscriber_Preference)::getNotificationUserSubscriber + Retrieve details of the subscriber tied to the preference. diff --git a/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/getObject.md b/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/getObject.md index 9b1f2061ba..35bf4e4307 100644 --- a/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/getObject.md +++ b/content/reference/services/SoftLayer_Notification_User_Subscriber_Preference/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Notification_User_Subscriber_Preference](/reference/services/SoftLayer_Notification_User_Subscriber_Preference)::getObject + Retrieve a SoftLayer_Notification_User_Subscriber_Preference record. diff --git a/content/reference/services/SoftLayer_Product_Item_Category/_index.md b/content/reference/services/SoftLayer_Product_Item_Category/_index.md index 7f811a5f45..dcd8d4c752 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/_index.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Retrieve the category information for a product item. @@ -42,120 +44,140 @@ Retrieve the category information for a product item. #### [getAdditionalProductsForCategory](/reference/services/SoftLayer_Product_Item_Category/getAdditionalProductsForCategory) Return a list of Items in the "Additional Services" package with their active prices for a given product item category. +
              #### [getBandwidthCategories](/reference/services/SoftLayer_Product_Item_Category/getBandwidthCategories) +
              #### [getBillingItems](/reference/services/SoftLayer_Product_Item_Category/getBillingItems) Retrieve the billing items associated with an account that share a category code with an item category's category code. +
              #### [getComputingCategories](/reference/services/SoftLayer_Product_Item_Category/getComputingCategories) Returns a collection of computing categories. +
              #### [getCustomUsageRatesCategories](/reference/services/SoftLayer_Product_Item_Category/getCustomUsageRatesCategories) +
              #### [getExternalResourceCategories](/reference/services/SoftLayer_Product_Item_Category/getExternalResourceCategories) +
              #### [getGroup](/reference/services/SoftLayer_Product_Item_Category/getGroup) Retrieve this invoice item's "item category group". +
              #### [getGroups](/reference/services/SoftLayer_Product_Item_Category/getGroups) Retrieve a collection of service offering category groups. Each group contains a collection of items associated with this category. +
              #### [getObject](/reference/services/SoftLayer_Product_Item_Category/getObject) Retrieve a SoftLayer_Product_Item_Category record. +
              #### [getObjectStorageCategories](/reference/services/SoftLayer_Product_Item_Category/getObjectStorageCategories) +
              #### [getOrderOptions](/reference/services/SoftLayer_Product_Item_Category/getOrderOptions) Retrieve any unique options associated with an item category. +
              #### [getPackageConfigurations](/reference/services/SoftLayer_Product_Item_Category/getPackageConfigurations) Retrieve a list of configuration available in this category.' +
              #### [getPresetConfigurations](/reference/services/SoftLayer_Product_Item_Category/getPresetConfigurations) Retrieve a list of preset configurations this category is used in.' +
              #### [getQuestionReferences](/reference/services/SoftLayer_Product_Item_Category/getQuestionReferences) Retrieve the question references that are associated with an item category. +
              #### [getQuestions](/reference/services/SoftLayer_Product_Item_Category/getQuestions) Retrieve the questions that are associated with an item category. +
              #### [getSoftwareCategories](/reference/services/SoftLayer_Product_Item_Category/getSoftwareCategories) +
              #### [getSubnetCategories](/reference/services/SoftLayer_Product_Item_Category/getSubnetCategories) Returns a list of subnet categories. +
              #### [getTopLevelCategories](/reference/services/SoftLayer_Product_Item_Category/getTopLevelCategories) Returns a collection of top-level categories. +
              #### [getValidCancelableServiceItemCategories](/reference/services/SoftLayer_Product_Item_Category/getValidCancelableServiceItemCategories) Returns service product categories that can be canceled via API +
              #### [getVlanCategories](/reference/services/SoftLayer_Product_Item_Category/getVlanCategories) +
              diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getAdditionalProductsForCategory.md b/content/reference/services/SoftLayer_Product_Item_Category/getAdditionalProductsForCategory.md index afa81cafbb..63ca820bfe 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getAdditionalProductsForCategory.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getAdditionalProductsForCategory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Category](/reference/services/SoftLayer_Product_Item_Category)::getAdditionalProductsForCategory + Return a list of Items in the "Additional Services" package with their active prices for a given product item category. diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getBandwidthCategories.md b/content/reference/services/SoftLayer_Product_Item_Category/getBandwidthCategories.md index 76e3ae28d8..cd0b22d73e 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getBandwidthCategories.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getBandwidthCategories.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getBillingItems.md b/content/reference/services/SoftLayer_Product_Item_Category/getBillingItems.md index 51e994f5dc..e5afa2ba07 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getBillingItems.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getBillingItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Category](/reference/services/SoftLayer_Product_Item_Category)::getBillingItems + Retrieve the billing items associated with an account that share a category code with an item category's category code. diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getComputingCategories.md b/content/reference/services/SoftLayer_Product_Item_Category/getComputingCategories.md index 00a0bcbda6..02c030b926 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getComputingCategories.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getComputingCategories.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Category](/reference/services/SoftLayer_Product_Item_Category)::getComputingCategories + Returns a collection of computing categories. diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getCustomUsageRatesCategories.md b/content/reference/services/SoftLayer_Product_Item_Category/getCustomUsageRatesCategories.md index f304860f0f..e9bb732089 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getCustomUsageRatesCategories.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getCustomUsageRatesCategories.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getExternalResourceCategories.md b/content/reference/services/SoftLayer_Product_Item_Category/getExternalResourceCategories.md index 60f8309464..2e353e2bdc 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getExternalResourceCategories.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getExternalResourceCategories.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getGroup.md b/content/reference/services/SoftLayer_Product_Item_Category/getGroup.md index 0bbf6f16c1..bd634a947c 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getGroup.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Category](/reference/services/SoftLayer_Product_Item_Category)::getGroup + Retrieve this invoice item's "item category group". diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getGroups.md b/content/reference/services/SoftLayer_Product_Item_Category/getGroups.md index c32f639f53..d9fd172d28 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getGroups.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Category](/reference/services/SoftLayer_Product_Item_Category)::getGroups + Retrieve a collection of service offering category groups. Each group contains a collection of items associated with this category. diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getObject.md b/content/reference/services/SoftLayer_Product_Item_Category/getObject.md index c0455a0a1b..ac50a2e7c9 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getObject.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Category](/reference/services/SoftLayer_Product_Item_Category)::getObject + Retrieve a SoftLayer_Product_Item_Category record. diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getObjectStorageCategories.md b/content/reference/services/SoftLayer_Product_Item_Category/getObjectStorageCategories.md index 2f5e04ab68..d6cc49d29f 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getObjectStorageCategories.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getObjectStorageCategories.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getOrderOptions.md b/content/reference/services/SoftLayer_Product_Item_Category/getOrderOptions.md index 2bd8799414..2a80b55ba1 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getOrderOptions.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getOrderOptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Category](/reference/services/SoftLayer_Product_Item_Category)::getOrderOptions + Retrieve any unique options associated with an item category. diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getPackageConfigurations.md b/content/reference/services/SoftLayer_Product_Item_Category/getPackageConfigurations.md index 714eb6d350..c3c0c1c09b 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getPackageConfigurations.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getPackageConfigurations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Category](/reference/services/SoftLayer_Product_Item_Category)::getPackageConfigurations + Retrieve a list of configuration available in this category.' diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getPresetConfigurations.md b/content/reference/services/SoftLayer_Product_Item_Category/getPresetConfigurations.md index be456fd392..fe0ba9a967 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getPresetConfigurations.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getPresetConfigurations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Category](/reference/services/SoftLayer_Product_Item_Category)::getPresetConfigurations + Retrieve a list of preset configurations this category is used in.' diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getQuestionReferences.md b/content/reference/services/SoftLayer_Product_Item_Category/getQuestionReferences.md index 0efd1834fa..63a44fcdce 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getQuestionReferences.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getQuestionReferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Category](/reference/services/SoftLayer_Product_Item_Category)::getQuestionReferences + Retrieve the question references that are associated with an item category. diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getQuestions.md b/content/reference/services/SoftLayer_Product_Item_Category/getQuestions.md index 902e1deb2b..89de76067e 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getQuestions.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getQuestions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Category](/reference/services/SoftLayer_Product_Item_Category)::getQuestions + Retrieve the questions that are associated with an item category. diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getSoftwareCategories.md b/content/reference/services/SoftLayer_Product_Item_Category/getSoftwareCategories.md index 5e922aa372..6e5e7d124a 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getSoftwareCategories.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getSoftwareCategories.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getSubnetCategories.md b/content/reference/services/SoftLayer_Product_Item_Category/getSubnetCategories.md index 5c2c156f5b..0be1350ccd 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getSubnetCategories.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getSubnetCategories.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Category](/reference/services/SoftLayer_Product_Item_Category)::getSubnetCategories + Returns a list of subnet categories. diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getTopLevelCategories.md b/content/reference/services/SoftLayer_Product_Item_Category/getTopLevelCategories.md index f80143a536..93940022d3 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getTopLevelCategories.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getTopLevelCategories.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Category](/reference/services/SoftLayer_Product_Item_Category)::getTopLevelCategories + Returns a collection of top-level categories. diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getValidCancelableServiceItemCategories.md b/content/reference/services/SoftLayer_Product_Item_Category/getValidCancelableServiceItemCategories.md index 4911569d9f..2b4d5d8ad6 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getValidCancelableServiceItemCategories.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getValidCancelableServiceItemCategories.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Category](/reference/services/SoftLayer_Product_Item_Category)::getValidCancelableServiceItemCategories + Returns service product categories that can be canceled via API diff --git a/content/reference/services/SoftLayer_Product_Item_Category/getVlanCategories.md b/content/reference/services/SoftLayer_Product_Item_Category/getVlanCategories.md index a33a638694..8f4ecec1d4 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category/getVlanCategories.md +++ b/content/reference/services/SoftLayer_Product_Item_Category/getVlanCategories.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Item_Category_Group/_index.md b/content/reference/services/SoftLayer_Product_Item_Category_Group/_index.md index 474a76bd8a..d4012e20dd 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category_Group/_index.md +++ b/content/reference/services/SoftLayer_Product_Item_Category_Group/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Retrieve the category group information for a product item. @@ -42,6 +44,7 @@ Retrieve the category group information for a product item. #### [getObject](/reference/services/SoftLayer_Product_Item_Category_Group/getObject) Retrieve a SoftLayer_Product_Item_Category_Group record. + diff --git a/content/reference/services/SoftLayer_Product_Item_Category_Group/getObject.md b/content/reference/services/SoftLayer_Product_Item_Category_Group/getObject.md index 2aa84978a3..b5405ebad3 100644 --- a/content/reference/services/SoftLayer_Product_Item_Category_Group/getObject.md +++ b/content/reference/services/SoftLayer_Product_Item_Category_Group/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Category_Group](/reference/services/SoftLayer_Product_Item_Category_Group)::getObject + Retrieve a SoftLayer_Product_Item_Category_Group record. diff --git a/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/_index.md b/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/_index.md index 6c2d306439..5e849caa72 100644 --- a/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/_index.md +++ b/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Serves as a data source for additional information about the policy to product assignment. @@ -42,30 +44,35 @@ Serves as a data source for additional information about the policy to product a #### [acceptFromTicket](/reference/services/SoftLayer_Product_Item_Policy_Assignment/acceptFromTicket) Register acceptance of this assignment linking this record to a Ticket. +
              #### [getObject](/reference/services/SoftLayer_Product_Item_Policy_Assignment/getObject) Retrieve a SoftLayer_Product_Item_Policy_Assignment record. +
              #### [getPolicyDocumentContents](/reference/services/SoftLayer_Product_Item_Policy_Assignment/getPolicyDocumentContents) Retrieve the binary content of the policy document. +
              #### [getPolicyName](/reference/services/SoftLayer_Product_Item_Policy_Assignment/getPolicyName) Retrieve the name of the assigned policy. +
              #### [getProduct](/reference/services/SoftLayer_Product_Item_Policy_Assignment/getProduct) Retrieve the [SoftLayer_Product_Item]({{}}) for this policy assignment. +
              diff --git a/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/acceptFromTicket.md b/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/acceptFromTicket.md index 0bd79fa4fd..bac43f17a3 100644 --- a/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/acceptFromTicket.md +++ b/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/acceptFromTicket.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Policy_Assignment](/reference/services/SoftLayer_Product_Item_Policy_Assignment)::acceptFromTicket + Register acceptance of this assignment linking this record to a Ticket. diff --git a/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/getObject.md b/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/getObject.md index ecd1860ba3..ea57712c23 100644 --- a/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/getObject.md +++ b/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Policy_Assignment](/reference/services/SoftLayer_Product_Item_Policy_Assignment)::getObject + Retrieve a SoftLayer_Product_Item_Policy_Assignment record. diff --git a/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/getPolicyDocumentContents.md b/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/getPolicyDocumentContents.md index c3646e3439..d90eb9c4f7 100644 --- a/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/getPolicyDocumentContents.md +++ b/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/getPolicyDocumentContents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Policy_Assignment](/reference/services/SoftLayer_Product_Item_Policy_Assignment)::getPolicyDocumentContents + Retrieve the binary content of the policy document. diff --git a/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/getPolicyName.md b/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/getPolicyName.md index 90755f46b8..b1a735a9a9 100644 --- a/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/getPolicyName.md +++ b/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/getPolicyName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Policy_Assignment](/reference/services/SoftLayer_Product_Item_Policy_Assignment)::getPolicyName + Retrieve the name of the assigned policy. diff --git a/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/getProduct.md b/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/getProduct.md index 5bac64f95e..695269d1b3 100644 --- a/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/getProduct.md +++ b/content/reference/services/SoftLayer_Product_Item_Policy_Assignment/getProduct.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Policy_Assignment](/reference/services/SoftLayer_Product_Item_Policy_Assignment)::getProduct + Retrieve the [SoftLayer_Product_Item]({{}}) for this policy assignment. diff --git a/content/reference/services/SoftLayer_Product_Item_Price/_index.md b/content/reference/services/SoftLayer_Product_Item_Price/_index.md index 0e53d0f1cb..dc8f7a7748 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/_index.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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). @@ -42,138 +44,161 @@ The SoftLayer_Product_Item_Price contains general information relating to a sing #### [getAccountRestrictions](/reference/services/SoftLayer_Product_Item_Price/getAccountRestrictions) Retrieve the account that the item price is restricted to. +
              #### [getAttributes](/reference/services/SoftLayer_Product_Item_Price/getAttributes) +
              #### [getBareMetalReservedCapacityFlag](/reference/services/SoftLayer_Product_Item_Price/getBareMetalReservedCapacityFlag) Retrieve signifies pricing that is only available on a bare metal reserved capacity order. +
              #### [getBigDataOsJournalDiskFlag](/reference/services/SoftLayer_Product_Item_Price/getBigDataOsJournalDiskFlag) Retrieve whether the price is for Big Data OS/Journal disks only. (Deprecated) +
              #### [getBundleReferences](/reference/services/SoftLayer_Product_Item_Price/getBundleReferences) Retrieve cross reference for bundles +
              #### [getCapacityRestrictionMaximum](/reference/services/SoftLayer_Product_Item_Price/getCapacityRestrictionMaximum) Retrieve the maximum capacity value for which this price is suitable. +
              #### [getCapacityRestrictionMinimum](/reference/services/SoftLayer_Product_Item_Price/getCapacityRestrictionMinimum) Retrieve the minimum capacity value for which this price is suitable. +
              #### [getCapacityRestrictionType](/reference/services/SoftLayer_Product_Item_Price/getCapacityRestrictionType) Retrieve the type of capacity restriction by which this price must abide. +
              #### [getCategories](/reference/services/SoftLayer_Product_Item_Price/getCategories) Retrieve all categories which this item is a member. +
              #### [getDedicatedHostInstanceFlag](/reference/services/SoftLayer_Product_Item_Price/getDedicatedHostInstanceFlag) Retrieve signifies pricing that is only available on a dedicated host virtual server order. +
              #### [getDefinedSoftwareLicenseFlag](/reference/services/SoftLayer_Product_Item_Price/getDefinedSoftwareLicenseFlag) Retrieve whether this price defines a software license for its product item. +
              #### [getEligibilityStrategy](/reference/services/SoftLayer_Product_Item_Price/getEligibilityStrategy) Retrieve eligibility strategy to assess if a customer can order using this price. +
              #### [getItem](/reference/services/SoftLayer_Product_Item_Price/getItem) Retrieve the product item a price is tied to. +
              #### [getObject](/reference/services/SoftLayer_Product_Item_Price/getObject) Retrieve a SoftLayer_Product_Item_Price record. +
              #### [getOrderPremiums](/reference/services/SoftLayer_Product_Item_Price/getOrderPremiums) +
              #### [getPackageReferences](/reference/services/SoftLayer_Product_Item_Price/getPackageReferences) Retrieve cross reference for packages +
              #### [getPackages](/reference/services/SoftLayer_Product_Item_Price/getPackages) Retrieve a price's packages under which this item is sold. +
              #### [getPresetConfigurations](/reference/services/SoftLayer_Product_Item_Price/getPresetConfigurations) Retrieve a list of preset configurations this price is used in.' +
              #### [getPriceType](/reference/services/SoftLayer_Product_Item_Price/getPriceType) Retrieve the type keyname of this price which can be STANDARD, TIERED, or TERM. +
              #### [getPricingLocationGroup](/reference/services/SoftLayer_Product_Item_Price/getPricingLocationGroup) Retrieve the pricing location group that this price is applicable for. Prices that have a pricing location group will only be available for ordering with the locations specified on the location group. +
              #### [getRequiredCoreCount](/reference/services/SoftLayer_Product_Item_Price/getRequiredCoreCount) Retrieve the number of server cores required to order this item. This is deprecated. Use [SoftLayer_Product_Item_Price::getCapacityRestrictionMinimum]({{}}) +
              #### [getReservedCapacityInstanceFlag](/reference/services/SoftLayer_Product_Item_Price/getReservedCapacityInstanceFlag) Retrieve signifies pricing that is only available on a reserved capacity virtual server order. +
              #### [getUsageRatePrices](/reference/services/SoftLayer_Product_Item_Price/getUsageRatePrices) Get all the rate-based prices for the location and items specified. +
              diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getAccountRestrictions.md b/content/reference/services/SoftLayer_Product_Item_Price/getAccountRestrictions.md index 3bf8b6b7a1..b6d5c887a6 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getAccountRestrictions.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getAccountRestrictions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getAccountRestrictions + Retrieve the account that the item price is restricted to. diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getAttributes.md b/content/reference/services/SoftLayer_Product_Item_Price/getAttributes.md index a1705ea221..68cb599fa0 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getAttributes.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getAttributes.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getBareMetalReservedCapacityFlag.md b/content/reference/services/SoftLayer_Product_Item_Price/getBareMetalReservedCapacityFlag.md index 3ce5355609..9aef4a8fb3 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getBareMetalReservedCapacityFlag.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getBareMetalReservedCapacityFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getBareMetalReservedCapacityFlag + Retrieve signifies pricing that is only available on a bare metal reserved capacity order. diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getBigDataOsJournalDiskFlag.md b/content/reference/services/SoftLayer_Product_Item_Price/getBigDataOsJournalDiskFlag.md index 7de657258d..367cd62861 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getBigDataOsJournalDiskFlag.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getBigDataOsJournalDiskFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getBigDataOsJournalDiskFlag + Retrieve whether the price is for Big Data OS/Journal disks only. (Deprecated) diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getBundleReferences.md b/content/reference/services/SoftLayer_Product_Item_Price/getBundleReferences.md index b4635e4921..efcfe64afd 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getBundleReferences.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getBundleReferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getBundleReferences + Retrieve cross reference for bundles diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getCapacityRestrictionMaximum.md b/content/reference/services/SoftLayer_Product_Item_Price/getCapacityRestrictionMaximum.md index 64a34639c0..cc5cde59f9 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getCapacityRestrictionMaximum.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getCapacityRestrictionMaximum.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getCapacityRestrictionMaximum + Retrieve the maximum capacity value for which this price is suitable. diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getCapacityRestrictionMinimum.md b/content/reference/services/SoftLayer_Product_Item_Price/getCapacityRestrictionMinimum.md index a4d235d28f..6fcc93b6c0 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getCapacityRestrictionMinimum.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getCapacityRestrictionMinimum.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getCapacityRestrictionMinimum + Retrieve the minimum capacity value for which this price is suitable. diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getCapacityRestrictionType.md b/content/reference/services/SoftLayer_Product_Item_Price/getCapacityRestrictionType.md index 40820d2b26..387cd0ea25 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getCapacityRestrictionType.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getCapacityRestrictionType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getCapacityRestrictionType + Retrieve the type of capacity restriction by which this price must abide. diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getCategories.md b/content/reference/services/SoftLayer_Product_Item_Price/getCategories.md index e0d0709d35..bc3547c9bc 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getCategories.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getCategories.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getCategories + Retrieve all categories which this item is a member. diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getDedicatedHostInstanceFlag.md b/content/reference/services/SoftLayer_Product_Item_Price/getDedicatedHostInstanceFlag.md index 63c574ff3f..a164707f98 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getDedicatedHostInstanceFlag.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getDedicatedHostInstanceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getDedicatedHostInstanceFlag + Retrieve signifies pricing that is only available on a dedicated host virtual server order. diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getDefinedSoftwareLicenseFlag.md b/content/reference/services/SoftLayer_Product_Item_Price/getDefinedSoftwareLicenseFlag.md index 2c2f4dc128..0dfb8d7254 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getDefinedSoftwareLicenseFlag.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getDefinedSoftwareLicenseFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getDefinedSoftwareLicenseFlag + Retrieve whether this price defines a software license for its product item. diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getEligibilityStrategy.md b/content/reference/services/SoftLayer_Product_Item_Price/getEligibilityStrategy.md index 779be9b948..6b10de137c 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getEligibilityStrategy.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getEligibilityStrategy.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getEligibilityStrategy + Retrieve eligibility strategy to assess if a customer can order using this price. diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getItem.md b/content/reference/services/SoftLayer_Product_Item_Price/getItem.md index 2455b3a9e6..7209bdef5d 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getItem.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getItem + Retrieve the product item a price is tied to. diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getObject.md b/content/reference/services/SoftLayer_Product_Item_Price/getObject.md index ccca56a6ad..9a2c7e6df1 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getObject.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getObject + Retrieve a SoftLayer_Product_Item_Price record. diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getOrderPremiums.md b/content/reference/services/SoftLayer_Product_Item_Price/getOrderPremiums.md index e71e29ab0d..4f82904844 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getOrderPremiums.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getOrderPremiums.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getPackageReferences.md b/content/reference/services/SoftLayer_Product_Item_Price/getPackageReferences.md index 66fd82e74c..1186c86fa5 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getPackageReferences.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getPackageReferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getPackageReferences + Retrieve cross reference for packages diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getPackages.md b/content/reference/services/SoftLayer_Product_Item_Price/getPackages.md index cfcc52c866..1716de2cd7 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getPackages.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getPackages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getPackages + Retrieve a price's packages under which this item is sold. diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getPresetConfigurations.md b/content/reference/services/SoftLayer_Product_Item_Price/getPresetConfigurations.md index 4ae7ad7aff..d0deb145f6 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getPresetConfigurations.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getPresetConfigurations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getPresetConfigurations + Retrieve a list of preset configurations this price is used in.' diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getPriceType.md b/content/reference/services/SoftLayer_Product_Item_Price/getPriceType.md index a92f48770b..b6812463e9 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getPriceType.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getPriceType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getPriceType + Retrieve the type keyname of this price which can be STANDARD, TIERED, or TERM. diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getPricingLocationGroup.md b/content/reference/services/SoftLayer_Product_Item_Price/getPricingLocationGroup.md index 890ee54b24..0d48f5844b 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getPricingLocationGroup.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getPricingLocationGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getPricingLocationGroup + Retrieve the pricing location group that this price is applicable for. Prices that have a pricing location group will only be available for ordering with the locations specified on the location group. diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getRequiredCoreCount.md b/content/reference/services/SoftLayer_Product_Item_Price/getRequiredCoreCount.md index 3aeb9253ea..5b7eccb705 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getRequiredCoreCount.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getRequiredCoreCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getRequiredCoreCount + Retrieve the number of server cores required to order this item. This is deprecated. Use [SoftLayer_Product_Item_Price::getCapacityRestrictionMinimum]({{}}) diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getReservedCapacityInstanceFlag.md b/content/reference/services/SoftLayer_Product_Item_Price/getReservedCapacityInstanceFlag.md index f2b5a2ca52..955fb4a859 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getReservedCapacityInstanceFlag.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getReservedCapacityInstanceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getReservedCapacityInstanceFlag + Retrieve signifies pricing that is only available on a reserved capacity virtual server order. diff --git a/content/reference/services/SoftLayer_Product_Item_Price/getUsageRatePrices.md b/content/reference/services/SoftLayer_Product_Item_Price/getUsageRatePrices.md index 2cd3bf2c61..722e103163 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price/getUsageRatePrices.md +++ b/content/reference/services/SoftLayer_Product_Item_Price/getUsageRatePrices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price](/reference/services/SoftLayer_Product_Item_Price)::getUsageRatePrices + Get all the rate-based prices for the location and items specified. diff --git a/content/reference/services/SoftLayer_Product_Item_Price_Premium/_index.md b/content/reference/services/SoftLayer_Product_Item_Price_Premium/_index.md index 27f7439a5f..fc97a97690 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price_Premium/_index.md +++ b/content/reference/services/SoftLayer_Product_Item_Price_Premium/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,24 +44,28 @@ classes: #### [getItemPrice](/reference/services/SoftLayer_Product_Item_Price_Premium/getItemPrice) +
              #### [getLocation](/reference/services/SoftLayer_Product_Item_Price_Premium/getLocation) +
              #### [getObject](/reference/services/SoftLayer_Product_Item_Price_Premium/getObject) Retrieve a SoftLayer_Product_Item_Price_Premium record. +
              #### [getPackage](/reference/services/SoftLayer_Product_Item_Price_Premium/getPackage) +
              diff --git a/content/reference/services/SoftLayer_Product_Item_Price_Premium/getItemPrice.md b/content/reference/services/SoftLayer_Product_Item_Price_Premium/getItemPrice.md index f635081298..43f6db14bf 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price_Premium/getItemPrice.md +++ b/content/reference/services/SoftLayer_Product_Item_Price_Premium/getItemPrice.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Item_Price_Premium/getLocation.md b/content/reference/services/SoftLayer_Product_Item_Price_Premium/getLocation.md index 69f8353383..99fb9a3457 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price_Premium/getLocation.md +++ b/content/reference/services/SoftLayer_Product_Item_Price_Premium/getLocation.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Item_Price_Premium/getObject.md b/content/reference/services/SoftLayer_Product_Item_Price_Premium/getObject.md index 7b8df55504..9efe63aae6 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price_Premium/getObject.md +++ b/content/reference/services/SoftLayer_Product_Item_Price_Premium/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Item_Price_Premium](/reference/services/SoftLayer_Product_Item_Price_Premium)::getObject + Retrieve a SoftLayer_Product_Item_Price_Premium record. diff --git a/content/reference/services/SoftLayer_Product_Item_Price_Premium/getPackage.md b/content/reference/services/SoftLayer_Product_Item_Price_Premium/getPackage.md index 1221dfd618..8303e372d8 100644 --- a/content/reference/services/SoftLayer_Product_Item_Price_Premium/getPackage.md +++ b/content/reference/services/SoftLayer_Product_Item_Price_Premium/getPackage.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Order/_index.md b/content/reference/services/SoftLayer_Product_Order/_index.md index e9e98afe45..105e977ce4 100644 --- a/content/reference/services/SoftLayer_Product_Order/_index.md +++ b/content/reference/services/SoftLayer_Product_Order/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + All orders (servers, virtual servers and services) pass through the [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]({{}}). For server orders, you would use [SoftLayer_Container_Product_Order_Hardware_Server]({{}}). For virtual server orders, you would use [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: @@ -58,78 +60,94 @@ While this service provides detailed customization for ordering, some customers #### [checkItemAvailability](/reference/services/SoftLayer_Product_Order/checkItemAvailability) +
              #### [checkItemAvailabilityForImageTemplate](/reference/services/SoftLayer_Product_Order/checkItemAvailabilityForImageTemplate) +
              #### [checkItemConflicts](/reference/services/SoftLayer_Product_Order/checkItemConflicts) Check order items for conflicts +
              #### [getExternalPaymentAuthorizationReceipt](/reference/services/SoftLayer_Product_Order/getExternalPaymentAuthorizationReceipt) Returns an order receipt for a completed external (PayPal) payment authorization. +
              -
              +
              #### [getNetworks](/reference/services/SoftLayer_Product_Order/getNetworks) (DEPRECATED) Retrieve the networks that are available during ordering. + +Deprecated + +
              #### [getResellerOrder](/reference/services/SoftLayer_Product_Order/getResellerOrder) Get External Reseller pricing where applicable +
              #### [getTaxCalculationResult](/reference/services/SoftLayer_Product_Order/getTaxCalculationResult) Get the results of a tax calculation. +
              #### [getVlans](/reference/services/SoftLayer_Product_Order/getVlans) Get the VLANs that are available during ordering +
              #### [placeOrder](/reference/services/SoftLayer_Product_Order/placeOrder) Place an order using the [SoftLayer_Container_Product_Order]({{}}) data type. +
              #### [placeQuote](/reference/services/SoftLayer_Product_Order/placeQuote) Place a quote +
              #### [processExternalPaymentAuthorization](/reference/services/SoftLayer_Product_Order/processExternalPaymentAuthorization) Process an external (PayPal) payment authorization. +
              #### [requiredItems](/reference/services/SoftLayer_Product_Order/requiredItems) Get list of items that are required with the item prices provided +
              #### [verifyOrder](/reference/services/SoftLayer_Product_Order/verifyOrder) Verify that an order may be successfully placed with the details provided. +
              diff --git a/content/reference/services/SoftLayer_Product_Order/checkItemAvailability.md b/content/reference/services/SoftLayer_Product_Order/checkItemAvailability.md index 73e4153879..f882e2e27f 100644 --- a/content/reference/services/SoftLayer_Product_Order/checkItemAvailability.md +++ b/content/reference/services/SoftLayer_Product_Order/checkItemAvailability.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Order/checkItemAvailabilityForImageTemplate.md b/content/reference/services/SoftLayer_Product_Order/checkItemAvailabilityForImageTemplate.md index 8d2919d9f0..36290212a6 100644 --- a/content/reference/services/SoftLayer_Product_Order/checkItemAvailabilityForImageTemplate.md +++ b/content/reference/services/SoftLayer_Product_Order/checkItemAvailabilityForImageTemplate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Order/checkItemConflicts.md b/content/reference/services/SoftLayer_Product_Order/checkItemConflicts.md index 9ff51fe7aa..2c1338ad8a 100644 --- a/content/reference/services/SoftLayer_Product_Order/checkItemConflicts.md +++ b/content/reference/services/SoftLayer_Product_Order/checkItemConflicts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Order](/reference/services/SoftLayer_Product_Order)::checkItemConflicts + Check order items for conflicts diff --git a/content/reference/services/SoftLayer_Product_Order/getExternalPaymentAuthorizationReceipt.md b/content/reference/services/SoftLayer_Product_Order/getExternalPaymentAuthorizationReceipt.md index f408b0d7d4..f7b1756c83 100644 --- a/content/reference/services/SoftLayer_Product_Order/getExternalPaymentAuthorizationReceipt.md +++ b/content/reference/services/SoftLayer_Product_Order/getExternalPaymentAuthorizationReceipt.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Order](/reference/services/SoftLayer_Product_Order)::getExternalPaymentAuthorizationReceipt + Returns an order receipt for a completed external (PayPal) payment authorization. diff --git a/content/reference/services/SoftLayer_Product_Order/getNetworks.md b/content/reference/services/SoftLayer_Product_Order/getNetworks.md index 762a87b278..f8553c7e14 100644 --- a/content/reference/services/SoftLayer_Product_Order/getNetworks.md +++ b/content/reference/services/SoftLayer_Product_Order/getNetworks.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Product_Order](/reference/services/SoftLayer_Product_Order)::getNetworks +
              Deprecated
              + (DEPRECATED) Retrieve the networks that are available during ordering. diff --git a/content/reference/services/SoftLayer_Product_Order/getResellerOrder.md b/content/reference/services/SoftLayer_Product_Order/getResellerOrder.md index c7fec900e1..d8a8996998 100644 --- a/content/reference/services/SoftLayer_Product_Order/getResellerOrder.md +++ b/content/reference/services/SoftLayer_Product_Order/getResellerOrder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Order](/reference/services/SoftLayer_Product_Order)::getResellerOrder + Get External Reseller pricing where applicable diff --git a/content/reference/services/SoftLayer_Product_Order/getTaxCalculationResult.md b/content/reference/services/SoftLayer_Product_Order/getTaxCalculationResult.md index c1d0c53b4f..6a59468b9c 100644 --- a/content/reference/services/SoftLayer_Product_Order/getTaxCalculationResult.md +++ b/content/reference/services/SoftLayer_Product_Order/getTaxCalculationResult.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Order](/reference/services/SoftLayer_Product_Order)::getTaxCalculationResult + Get the results of a tax calculation. diff --git a/content/reference/services/SoftLayer_Product_Order/getVlans.md b/content/reference/services/SoftLayer_Product_Order/getVlans.md index 5b2cf525f6..a89b35dee0 100644 --- a/content/reference/services/SoftLayer_Product_Order/getVlans.md +++ b/content/reference/services/SoftLayer_Product_Order/getVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Order](/reference/services/SoftLayer_Product_Order)::getVlans + Get the VLANs that are available during ordering diff --git a/content/reference/services/SoftLayer_Product_Order/placeOrder.md b/content/reference/services/SoftLayer_Product_Order/placeOrder.md index 355e12851c..e996850f75 100644 --- a/content/reference/services/SoftLayer_Product_Order/placeOrder.md +++ b/content/reference/services/SoftLayer_Product_Order/placeOrder.md @@ -14,6 +14,7 @@ aliases: --- # [SoftLayer_Product_Order](/reference/services/SoftLayer_Product_Order)::placeOrder + Place an order using the [SoftLayer_Container_Product_Order]({{}}) data type. diff --git a/content/reference/services/SoftLayer_Product_Order/placeQuote.md b/content/reference/services/SoftLayer_Product_Order/placeQuote.md index 7f5c16f904..4f2b1c374d 100644 --- a/content/reference/services/SoftLayer_Product_Order/placeQuote.md +++ b/content/reference/services/SoftLayer_Product_Order/placeQuote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Order](/reference/services/SoftLayer_Product_Order)::placeQuote + Place a quote diff --git a/content/reference/services/SoftLayer_Product_Order/processExternalPaymentAuthorization.md b/content/reference/services/SoftLayer_Product_Order/processExternalPaymentAuthorization.md index da766ca9a1..a2b7a59a8d 100644 --- a/content/reference/services/SoftLayer_Product_Order/processExternalPaymentAuthorization.md +++ b/content/reference/services/SoftLayer_Product_Order/processExternalPaymentAuthorization.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Order](/reference/services/SoftLayer_Product_Order)::processExternalPaymentAuthorization + Process an external (PayPal) payment authorization. diff --git a/content/reference/services/SoftLayer_Product_Order/requiredItems.md b/content/reference/services/SoftLayer_Product_Order/requiredItems.md index 902385d249..1cd71ed220 100644 --- a/content/reference/services/SoftLayer_Product_Order/requiredItems.md +++ b/content/reference/services/SoftLayer_Product_Order/requiredItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Order](/reference/services/SoftLayer_Product_Order)::requiredItems + Get list of items that are required with the item prices provided diff --git a/content/reference/services/SoftLayer_Product_Order/verifyOrder.md b/content/reference/services/SoftLayer_Product_Order/verifyOrder.md index 21b71dc5e4..186ba39c19 100644 --- a/content/reference/services/SoftLayer_Product_Order/verifyOrder.md +++ b/content/reference/services/SoftLayer_Product_Order/verifyOrder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Order](/reference/services/SoftLayer_Product_Order)::verifyOrder + Verify that an order may be successfully placed with the details provided. diff --git a/content/reference/services/SoftLayer_Product_Package/_index.md b/content/reference/services/SoftLayer_Product_Package/_index.md index 824225c04b..e8dea95ba2 100644 --- a/content/reference/services/SoftLayer_Product_Package/_index.md +++ b/content/reference/services/SoftLayer_Product_Package/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,414 +44,489 @@ Every SoftLayer_Product_Package contains information related products and servic #### [getAccountRestrictedActivePresets](/reference/services/SoftLayer_Product_Package/getAccountRestrictedActivePresets) Retrieve the preset configurations available only for the authenticated account and this package. +
              #### [getAccountRestrictedCategories](/reference/services/SoftLayer_Product_Package/getAccountRestrictedCategories) Retrieve the results from this call are similar to [SoftLayer_Product_Package::getCategories]({{}}), but these ONLY include account-restricted prices. Not all accounts have restricted pricing. +
              #### [getAccountRestrictedPricesFlag](/reference/services/SoftLayer_Product_Package/getAccountRestrictedPricesFlag) Retrieve the flag to indicate if there are any restricted prices in a package for the currently-active account. +
              #### [getActiveItems](/reference/services/SoftLayer_Product_Package/getActiveItems) Retrieve the active items, as well as their prices and categories for this package +
              -
              +
              #### [getActivePackagesByAttribute](/reference/services/SoftLayer_Product_Package/getActivePackagesByAttribute) [DEPRECATED] Retrieve the active [SoftLayer_Product_Package]({{}}) objects from which you can order a server, service or software filtered by an attribute type ([SoftLayer_Product_Package_Attribute_Type]({{}})) on the package. + +Deprecated + +
              #### [getActivePresets](/reference/services/SoftLayer_Product_Package/getActivePresets) Retrieve the available preset configurations for this package. +
              -
              +
              #### [getActivePrivateHostedCloudPackages](/reference/services/SoftLayer_Product_Package/getActivePrivateHostedCloudPackages) [DEPRECATED] Get the Active SoftLayer_Product_Packages from which one can order private hosted cloud configurations. + +Deprecated + +
              #### [getActiveRamItems](/reference/services/SoftLayer_Product_Package/getActiveRamItems) Retrieve a collection of valid RAM items available for purchase in this package. +
              #### [getActiveServerItems](/reference/services/SoftLayer_Product_Package/getActiveServerItems) Retrieve a collection of valid server items available for purchase in this package. +
              #### [getActiveSoftwareItems](/reference/services/SoftLayer_Product_Package/getActiveSoftwareItems) Retrieve a collection of valid software items available for purchase in this package. +
              #### [getActiveUsagePrices](/reference/services/SoftLayer_Product_Package/getActiveUsagePrices) Retrieve a collection of [SoftLayer_Product_Item_Price]({{}}) objects for pay-as-you-go usage. +
              #### [getActiveUsageRatePrices](/reference/services/SoftLayer_Product_Package/getActiveUsageRatePrices) Return the active usage rate prices for the current package. +
              #### [getAdditionalServiceFlag](/reference/services/SoftLayer_Product_Package/getAdditionalServiceFlag) Retrieve this flag indicates that the package is an additional service. +
              #### [getAllObjects](/reference/services/SoftLayer_Product_Package/getAllObjects) Get the Active SoftLayer_Product_Packages +
              #### [getAttributes](/reference/services/SoftLayer_Product_Package/getAttributes) +
              #### [getAvailableLocations](/reference/services/SoftLayer_Product_Package/getAvailableLocations) Retrieve a collection of valid locations for this package. (Deprecated - Use [SoftLayer_Product_Package::getRegions]({{}})) +
              #### [getAvailablePackagesForImageTemplate](/reference/services/SoftLayer_Product_Package/getAvailablePackagesForImageTemplate) +
              #### [getAvailableStorageUnits](/reference/services/SoftLayer_Product_Package/getAvailableStorageUnits) Retrieve the maximum number of available disk storage units associated with the servers in a package. +
              #### [getCategories](/reference/services/SoftLayer_Product_Package/getCategories) Retrieve this is a collection of categories ([SoftLayer_Product_Item_Category]({{}})) associated with a package which can be used for ordering. These categories have several objects prepopulated which are useful when determining the available products for purchase. The categories contain groups ([SoftLayer_Product_Package_Item_Category_Group]({{}})) that organize the products and prices by similar features. For example, operating systems will be grouped by their manufacturer and virtual server disks will be grouped by their disk type (SAN vs. local). Each group will contain prices ([SoftLayer_Product_Item_Price]({{}})) which you can use determine the cost of each product. Each price has a product ([SoftLayer_Product_Item]({{}})) which provides the name and other useful information about the server, service or software you may purchase. +
              #### [getCdnItems](/reference/services/SoftLayer_Product_Package/getCdnItems) +
              #### [getCloudStorageItems](/reference/services/SoftLayer_Product_Package/getCloudStorageItems) +
              #### [getConfiguration](/reference/services/SoftLayer_Product_Package/getConfiguration) Retrieve the item categories associated with a package, including information detailing which item categories are required as part of a SoftLayer product order. +
              #### [getDefaultBootCategoryCode](/reference/services/SoftLayer_Product_Package/getDefaultBootCategoryCode) Retrieve the default boot category code for the package. +
              #### [getDefaultRamItems](/reference/services/SoftLayer_Product_Package/getDefaultRamItems) Retrieve a collection of valid RAM items available for purchase in this package. +
              #### [getDeploymentNodeType](/reference/services/SoftLayer_Product_Package/getDeploymentNodeType) Retrieve the node type for a package in a solution deployment. +
              #### [getDeploymentPackages](/reference/services/SoftLayer_Product_Package/getDeploymentPackages) Retrieve the packages that are allowed in a multi-server solution. (Deprecated) +
              #### [getDeploymentType](/reference/services/SoftLayer_Product_Package/getDeploymentType) Retrieve the solution deployment type. +
              #### [getDeployments](/reference/services/SoftLayer_Product_Package/getDeployments) Retrieve the package that represents a multi-server solution. (Deprecated) +
              #### [getDisallowCustomDiskPartitions](/reference/services/SoftLayer_Product_Package/getDisallowCustomDiskPartitions) Retrieve this flag indicates the package does not allow custom disk partitions. +
              #### [getFirstOrderStep](/reference/services/SoftLayer_Product_Package/getFirstOrderStep) Retrieve the Softlayer order step is optionally step-based. This returns the first SoftLayer_Product_Package_Order_Step in the step-based order process. +
              #### [getGatewayApplianceFlag](/reference/services/SoftLayer_Product_Package/getGatewayApplianceFlag) Retrieve whether the package is a specialized network gateway appliance package. +
              #### [getGpuFlag](/reference/services/SoftLayer_Product_Package/getGpuFlag) Retrieve this flag indicates that the package supports GPUs. +
              #### [getHourlyBillingAvailableFlag](/reference/services/SoftLayer_Product_Package/getHourlyBillingAvailableFlag) Retrieve determines whether the package contains prices that can be ordered hourly. +
              #### [getHourlyOnlyOrders](/reference/services/SoftLayer_Product_Package/getHourlyOnlyOrders) Retrieve packages with this flag do not allow monthly orders. +
              #### [getItemAvailabilityTypes](/reference/services/SoftLayer_Product_Package/getItemAvailabilityTypes) Returns a collection of SoftLayer_Product_Item_Attribute_Type objects. +
              #### [getItemConflicts](/reference/services/SoftLayer_Product_Package/getItemConflicts) Retrieve the item-item conflicts associated with a package. +
              #### [getItemLocationConflicts](/reference/services/SoftLayer_Product_Package/getItemLocationConflicts) Retrieve the item-location conflicts associated with a package. +
              #### [getItemPriceReferences](/reference/services/SoftLayer_Product_Package/getItemPriceReferences) Retrieve cross reference for item prices +
              #### [getItemPrices](/reference/services/SoftLayer_Product_Package/getItemPrices) Retrieve a collection of SoftLayer_Product_Item_Prices that are valid for this package. +
              #### [getItemPricesFromSoftwareDescriptions](/reference/services/SoftLayer_Product_Package/getItemPricesFromSoftwareDescriptions) Returns a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description that are available for the service offering (package). +
              #### [getItems](/reference/services/SoftLayer_Product_Package/getItems) Retrieve a collection of valid items available for purchase in this package. +
              #### [getItemsFromImageTemplate](/reference/services/SoftLayer_Product_Package/getItemsFromImageTemplate) Return a collection of [SoftLayer_Product_Item]({{}}) objects from a [SoftLayer_Virtual_Guest_Block_Device_Template_Group]({{}}) object +
              #### [getLocations](/reference/services/SoftLayer_Product_Package/getLocations) Retrieve a collection of valid locations for this package. (Deprecated - Use [SoftLayer_Product_Package::getRegions]({{}})) +
              #### [getLowestServerPrice](/reference/services/SoftLayer_Product_Package/getLowestServerPrice) Retrieve the lowest server [SoftLayer_Product_Item_Price]({{}}) related to this package. +
              #### [getMaximumPortSpeed](/reference/services/SoftLayer_Product_Package/getMaximumPortSpeed) Retrieve the maximum available network speed associated with the package. +
              #### [getMessageQueueItems](/reference/services/SoftLayer_Product_Package/getMessageQueueItems) +
              #### [getMinimumPortSpeed](/reference/services/SoftLayer_Product_Package/getMinimumPortSpeed) Retrieve the minimum available network speed associated with the package. +
              #### [getMongoDbEngineeredFlag](/reference/services/SoftLayer_Product_Package/getMongoDbEngineeredFlag) Retrieve this flag indicates that this is a MongoDB engineered package. (Deprecated) +
              #### [getNoUpgradesFlag](/reference/services/SoftLayer_Product_Package/getNoUpgradesFlag) Retrieve services ordered from this package cannot have upgrades or downgrades performed. +
              #### [getNonEuCompliantFlag](/reference/services/SoftLayer_Product_Package/getNonEuCompliantFlag) Retrieve whether the package is not in compliance with EU support. +
              #### [getObject](/reference/services/SoftLayer_Product_Package/getObject) Retrieve a SoftLayer_Product_Package record. +
              #### [getObjectStorageDatacenters](/reference/services/SoftLayer_Product_Package/getObjectStorageDatacenters) Returns a collection of datacenters where object storage is available plus the associated active usage rate prices. +
              #### [getObjectStorageLocationGroups](/reference/services/SoftLayer_Product_Package/getObjectStorageLocationGroups) Returns a collection of location groups where object storage is available plus the associated active usage rate prices. +
              #### [getOrderPremiums](/reference/services/SoftLayer_Product_Package/getOrderPremiums) Retrieve the premium price modifiers associated with the [SoftLayer_Product_Item_Price]({{}}) and [SoftLayer_Location]({{}}) objects in a package. +
              #### [getPopLocationAvailabilityFlag](/reference/services/SoftLayer_Product_Package/getPopLocationAvailabilityFlag) Retrieve this flag indicates if the package may be available in PoP locations in addition to Datacenters. +
              #### [getPreconfiguredFlag](/reference/services/SoftLayer_Product_Package/getPreconfiguredFlag) Retrieve this flag indicates the package is pre-configured. (Deprecated) +
              #### [getPresetConfigurationRequiredFlag](/reference/services/SoftLayer_Product_Package/getPresetConfigurationRequiredFlag) Retrieve whether the package requires the user to define a preset configuration. +
              #### [getPreventVlanSelectionFlag](/reference/services/SoftLayer_Product_Package/getPreventVlanSelectionFlag) Retrieve whether the package prevents the user from specifying a Vlan. +
              #### [getPrivateHostedCloudPackageFlag](/reference/services/SoftLayer_Product_Package/getPrivateHostedCloudPackageFlag) Retrieve this flag indicates the package is for a private hosted cloud deployment. (Deprecated) +
              #### [getPrivateHostedCloudPackageType](/reference/services/SoftLayer_Product_Package/getPrivateHostedCloudPackageType) Retrieve the server role of the private hosted cloud deployment. (Deprecated) +
              #### [getPrivateNetworkOnlyFlag](/reference/services/SoftLayer_Product_Package/getPrivateNetworkOnlyFlag) Retrieve whether the package only has access to the private network. +
              #### [getQuantaStorPackageFlag](/reference/services/SoftLayer_Product_Package/getQuantaStorPackageFlag) Retrieve whether the package is a specialized mass storage QuantaStor package. (Deprecated) +
              #### [getRaidDiskRestrictionFlag](/reference/services/SoftLayer_Product_Package/getRaidDiskRestrictionFlag) Retrieve this flag indicates the package does not allow different disks with RAID. +
              #### [getRedundantPowerFlag](/reference/services/SoftLayer_Product_Package/getRedundantPowerFlag) Retrieve this flag determines if the package contains a redundant power supply product. +
              #### [getRegions](/reference/services/SoftLayer_Product_Package/getRegions) Retrieve the regional locations that a package is available in. +
              #### [getResourceGroupTemplate](/reference/services/SoftLayer_Product_Package/getResourceGroupTemplate) Retrieve the resource group template that describes a multi-server solution. (Deprecated) +
              #### [getStandardCategories](/reference/services/SoftLayer_Product_Package/getStandardCategories) This call is similar to [SoftLayer_Product_Package::getCategories]({{}}), except that it does not include account-restricted pricing. Not all accounts have restricted pricing. +
              #### [getTopLevelItemCategoryCode](/reference/services/SoftLayer_Product_Package/getTopLevelItemCategoryCode) Retrieve the top level category code for this service offering. +
              #### [getType](/reference/services/SoftLayer_Product_Package/getType) Retrieve the type of service offering. This property can be used to help filter packages. +
              diff --git a/content/reference/services/SoftLayer_Product_Package/getAccountRestrictedActivePresets.md b/content/reference/services/SoftLayer_Product_Package/getAccountRestrictedActivePresets.md index 5ddf3186a8..099c9dcc8a 100644 --- a/content/reference/services/SoftLayer_Product_Package/getAccountRestrictedActivePresets.md +++ b/content/reference/services/SoftLayer_Product_Package/getAccountRestrictedActivePresets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getAccountRestrictedActivePresets + Retrieve the preset configurations available only for the authenticated account and this package. diff --git a/content/reference/services/SoftLayer_Product_Package/getAccountRestrictedCategories.md b/content/reference/services/SoftLayer_Product_Package/getAccountRestrictedCategories.md index 0c95486d3d..bb4702cbb0 100644 --- a/content/reference/services/SoftLayer_Product_Package/getAccountRestrictedCategories.md +++ b/content/reference/services/SoftLayer_Product_Package/getAccountRestrictedCategories.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getAccountRestrictedCategories + Retrieve the results from this call are similar to [SoftLayer_Product_Package::getCategories]({{}}), but these ONLY include account-restricted prices. Not all accounts have restricted pricing. diff --git a/content/reference/services/SoftLayer_Product_Package/getAccountRestrictedPricesFlag.md b/content/reference/services/SoftLayer_Product_Package/getAccountRestrictedPricesFlag.md index c37a5a53cd..860cd6aa4d 100644 --- a/content/reference/services/SoftLayer_Product_Package/getAccountRestrictedPricesFlag.md +++ b/content/reference/services/SoftLayer_Product_Package/getAccountRestrictedPricesFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getAccountRestrictedPricesFlag + Retrieve the flag to indicate if there are any restricted prices in a package for the currently-active account. diff --git a/content/reference/services/SoftLayer_Product_Package/getActiveItems.md b/content/reference/services/SoftLayer_Product_Package/getActiveItems.md index dd6847d590..72ef2a0dcb 100644 --- a/content/reference/services/SoftLayer_Product_Package/getActiveItems.md +++ b/content/reference/services/SoftLayer_Product_Package/getActiveItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getActiveItems + Retrieve the active items, as well as their prices and categories for this package diff --git a/content/reference/services/SoftLayer_Product_Package/getActivePackagesByAttribute.md b/content/reference/services/SoftLayer_Product_Package/getActivePackagesByAttribute.md index c457d7f06c..46099dd2a4 100644 --- a/content/reference/services/SoftLayer_Product_Package/getActivePackagesByAttribute.md +++ b/content/reference/services/SoftLayer_Product_Package/getActivePackagesByAttribute.md @@ -15,6 +15,8 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getActivePackagesByAttribute +
              Deprecated
              + [DEPRECATED] Retrieve the active [SoftLayer_Product_Package]({{}}) objects from which you can order a server, service or software filtered by an attribute type ([SoftLayer_Product_Package_Attribute_Type]({{}})) on the package. diff --git a/content/reference/services/SoftLayer_Product_Package/getActivePresets.md b/content/reference/services/SoftLayer_Product_Package/getActivePresets.md index d42b877e6c..19407a25cf 100644 --- a/content/reference/services/SoftLayer_Product_Package/getActivePresets.md +++ b/content/reference/services/SoftLayer_Product_Package/getActivePresets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getActivePresets + Retrieve the available preset configurations for this package. diff --git a/content/reference/services/SoftLayer_Product_Package/getActivePrivateHostedCloudPackages.md b/content/reference/services/SoftLayer_Product_Package/getActivePrivateHostedCloudPackages.md index 50c1a80b10..b82e3b7f6a 100644 --- a/content/reference/services/SoftLayer_Product_Package/getActivePrivateHostedCloudPackages.md +++ b/content/reference/services/SoftLayer_Product_Package/getActivePrivateHostedCloudPackages.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getActivePrivateHostedCloudPackages +
              Deprecated
              + [DEPRECATED] Get the Active SoftLayer_Product_Packages from which one can order private hosted cloud configurations. diff --git a/content/reference/services/SoftLayer_Product_Package/getActiveRamItems.md b/content/reference/services/SoftLayer_Product_Package/getActiveRamItems.md index ef258d6bcb..31a1ae5161 100644 --- a/content/reference/services/SoftLayer_Product_Package/getActiveRamItems.md +++ b/content/reference/services/SoftLayer_Product_Package/getActiveRamItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getActiveRamItems + Retrieve a collection of valid RAM items available for purchase in this package. diff --git a/content/reference/services/SoftLayer_Product_Package/getActiveServerItems.md b/content/reference/services/SoftLayer_Product_Package/getActiveServerItems.md index 0d00ddb1a3..897ebbeea0 100644 --- a/content/reference/services/SoftLayer_Product_Package/getActiveServerItems.md +++ b/content/reference/services/SoftLayer_Product_Package/getActiveServerItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getActiveServerItems + Retrieve a collection of valid server items available for purchase in this package. diff --git a/content/reference/services/SoftLayer_Product_Package/getActiveSoftwareItems.md b/content/reference/services/SoftLayer_Product_Package/getActiveSoftwareItems.md index 2aba812069..3d7510aa3e 100644 --- a/content/reference/services/SoftLayer_Product_Package/getActiveSoftwareItems.md +++ b/content/reference/services/SoftLayer_Product_Package/getActiveSoftwareItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getActiveSoftwareItems + Retrieve a collection of valid software items available for purchase in this package. diff --git a/content/reference/services/SoftLayer_Product_Package/getActiveUsagePrices.md b/content/reference/services/SoftLayer_Product_Package/getActiveUsagePrices.md index 445d90f3db..59abb7c41a 100644 --- a/content/reference/services/SoftLayer_Product_Package/getActiveUsagePrices.md +++ b/content/reference/services/SoftLayer_Product_Package/getActiveUsagePrices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getActiveUsagePrices + Retrieve a collection of [SoftLayer_Product_Item_Price]({{}}) objects for pay-as-you-go usage. diff --git a/content/reference/services/SoftLayer_Product_Package/getActiveUsageRatePrices.md b/content/reference/services/SoftLayer_Product_Package/getActiveUsageRatePrices.md index d8f5d1872d..471ac8d8b6 100644 --- a/content/reference/services/SoftLayer_Product_Package/getActiveUsageRatePrices.md +++ b/content/reference/services/SoftLayer_Product_Package/getActiveUsageRatePrices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getActiveUsageRatePrices + Return the active usage rate prices for the current package. diff --git a/content/reference/services/SoftLayer_Product_Package/getAdditionalServiceFlag.md b/content/reference/services/SoftLayer_Product_Package/getAdditionalServiceFlag.md index d88f5fff6f..494eaa0505 100644 --- a/content/reference/services/SoftLayer_Product_Package/getAdditionalServiceFlag.md +++ b/content/reference/services/SoftLayer_Product_Package/getAdditionalServiceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getAdditionalServiceFlag + Retrieve this flag indicates that the package is an additional service. diff --git a/content/reference/services/SoftLayer_Product_Package/getAllObjects.md b/content/reference/services/SoftLayer_Product_Package/getAllObjects.md index cff29763e1..cd00ac1cd5 100644 --- a/content/reference/services/SoftLayer_Product_Package/getAllObjects.md +++ b/content/reference/services/SoftLayer_Product_Package/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getAllObjects + Get the Active SoftLayer_Product_Packages diff --git a/content/reference/services/SoftLayer_Product_Package/getAttributes.md b/content/reference/services/SoftLayer_Product_Package/getAttributes.md index f1ed1f29e1..43040be22e 100644 --- a/content/reference/services/SoftLayer_Product_Package/getAttributes.md +++ b/content/reference/services/SoftLayer_Product_Package/getAttributes.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Package/getAvailableLocations.md b/content/reference/services/SoftLayer_Product_Package/getAvailableLocations.md index 4dfe8a4ba1..4c77382735 100644 --- a/content/reference/services/SoftLayer_Product_Package/getAvailableLocations.md +++ b/content/reference/services/SoftLayer_Product_Package/getAvailableLocations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getAvailableLocations + Retrieve a collection of valid locations for this package. (Deprecated - Use [SoftLayer_Product_Package::getRegions]({{}})) diff --git a/content/reference/services/SoftLayer_Product_Package/getAvailablePackagesForImageTemplate.md b/content/reference/services/SoftLayer_Product_Package/getAvailablePackagesForImageTemplate.md index e77413536b..a161e6b7ab 100644 --- a/content/reference/services/SoftLayer_Product_Package/getAvailablePackagesForImageTemplate.md +++ b/content/reference/services/SoftLayer_Product_Package/getAvailablePackagesForImageTemplate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Package/getAvailableStorageUnits.md b/content/reference/services/SoftLayer_Product_Package/getAvailableStorageUnits.md index eff510feb3..f0db6829b9 100644 --- a/content/reference/services/SoftLayer_Product_Package/getAvailableStorageUnits.md +++ b/content/reference/services/SoftLayer_Product_Package/getAvailableStorageUnits.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getAvailableStorageUnits + Retrieve the maximum number of available disk storage units associated with the servers in a package. diff --git a/content/reference/services/SoftLayer_Product_Package/getCategories.md b/content/reference/services/SoftLayer_Product_Package/getCategories.md index 31d390febd..f628bda6bc 100644 --- a/content/reference/services/SoftLayer_Product_Package/getCategories.md +++ b/content/reference/services/SoftLayer_Product_Package/getCategories.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getCategories + Retrieve this is a collection of categories ([SoftLayer_Product_Item_Category]({{}})) associated with a package which can be used for ordering. These categories have several objects prepopulated which are useful when determining the available products for purchase. The categories contain groups ([SoftLayer_Product_Package_Item_Category_Group]({{}})) that organize the products and prices by similar features. For example, operating systems will be grouped by their manufacturer and virtual server disks will be grouped by their disk type (SAN vs. local). Each group will contain prices ([SoftLayer_Product_Item_Price]({{}})) which you can use determine the cost of each product. Each price has a product ([SoftLayer_Product_Item]({{}})) which provides the name and other useful information about the server, service or software you may purchase. diff --git a/content/reference/services/SoftLayer_Product_Package/getCdnItems.md b/content/reference/services/SoftLayer_Product_Package/getCdnItems.md index c5fd99ba1f..fa88f063c0 100644 --- a/content/reference/services/SoftLayer_Product_Package/getCdnItems.md +++ b/content/reference/services/SoftLayer_Product_Package/getCdnItems.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Package/getCloudStorageItems.md b/content/reference/services/SoftLayer_Product_Package/getCloudStorageItems.md index 4c9f9e944d..245fda9746 100644 --- a/content/reference/services/SoftLayer_Product_Package/getCloudStorageItems.md +++ b/content/reference/services/SoftLayer_Product_Package/getCloudStorageItems.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Package/getConfiguration.md b/content/reference/services/SoftLayer_Product_Package/getConfiguration.md index e9b0d097fb..ae54bebecb 100644 --- a/content/reference/services/SoftLayer_Product_Package/getConfiguration.md +++ b/content/reference/services/SoftLayer_Product_Package/getConfiguration.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getConfiguration + Retrieve the item categories associated with a package, including information detailing which item categories are required as part of a SoftLayer product order. diff --git a/content/reference/services/SoftLayer_Product_Package/getDefaultBootCategoryCode.md b/content/reference/services/SoftLayer_Product_Package/getDefaultBootCategoryCode.md index f7c6edb048..226a947c30 100644 --- a/content/reference/services/SoftLayer_Product_Package/getDefaultBootCategoryCode.md +++ b/content/reference/services/SoftLayer_Product_Package/getDefaultBootCategoryCode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getDefaultBootCategoryCode + Retrieve the default boot category code for the package. diff --git a/content/reference/services/SoftLayer_Product_Package/getDefaultRamItems.md b/content/reference/services/SoftLayer_Product_Package/getDefaultRamItems.md index 2a248db201..c5db94a039 100644 --- a/content/reference/services/SoftLayer_Product_Package/getDefaultRamItems.md +++ b/content/reference/services/SoftLayer_Product_Package/getDefaultRamItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getDefaultRamItems + Retrieve a collection of valid RAM items available for purchase in this package. diff --git a/content/reference/services/SoftLayer_Product_Package/getDeploymentNodeType.md b/content/reference/services/SoftLayer_Product_Package/getDeploymentNodeType.md index 033c8fd288..353a5e31d1 100644 --- a/content/reference/services/SoftLayer_Product_Package/getDeploymentNodeType.md +++ b/content/reference/services/SoftLayer_Product_Package/getDeploymentNodeType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getDeploymentNodeType + Retrieve the node type for a package in a solution deployment. diff --git a/content/reference/services/SoftLayer_Product_Package/getDeploymentPackages.md b/content/reference/services/SoftLayer_Product_Package/getDeploymentPackages.md index 8ac65113cf..a52f442e9b 100644 --- a/content/reference/services/SoftLayer_Product_Package/getDeploymentPackages.md +++ b/content/reference/services/SoftLayer_Product_Package/getDeploymentPackages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getDeploymentPackages + Retrieve the packages that are allowed in a multi-server solution. (Deprecated) diff --git a/content/reference/services/SoftLayer_Product_Package/getDeploymentType.md b/content/reference/services/SoftLayer_Product_Package/getDeploymentType.md index 6e0683fb38..ee34b8e47a 100644 --- a/content/reference/services/SoftLayer_Product_Package/getDeploymentType.md +++ b/content/reference/services/SoftLayer_Product_Package/getDeploymentType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getDeploymentType + Retrieve the solution deployment type. diff --git a/content/reference/services/SoftLayer_Product_Package/getDeployments.md b/content/reference/services/SoftLayer_Product_Package/getDeployments.md index 633b1eb73d..fa896d7a79 100644 --- a/content/reference/services/SoftLayer_Product_Package/getDeployments.md +++ b/content/reference/services/SoftLayer_Product_Package/getDeployments.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getDeployments + Retrieve the package that represents a multi-server solution. (Deprecated) diff --git a/content/reference/services/SoftLayer_Product_Package/getDisallowCustomDiskPartitions.md b/content/reference/services/SoftLayer_Product_Package/getDisallowCustomDiskPartitions.md index 34ca54d54e..a581ecce90 100644 --- a/content/reference/services/SoftLayer_Product_Package/getDisallowCustomDiskPartitions.md +++ b/content/reference/services/SoftLayer_Product_Package/getDisallowCustomDiskPartitions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getDisallowCustomDiskPartitions + Retrieve this flag indicates the package does not allow custom disk partitions. diff --git a/content/reference/services/SoftLayer_Product_Package/getFirstOrderStep.md b/content/reference/services/SoftLayer_Product_Package/getFirstOrderStep.md index caa5a64296..57afd3ea8e 100644 --- a/content/reference/services/SoftLayer_Product_Package/getFirstOrderStep.md +++ b/content/reference/services/SoftLayer_Product_Package/getFirstOrderStep.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getFirstOrderStep + Retrieve the Softlayer order step is optionally step-based. This returns the first SoftLayer_Product_Package_Order_Step in the step-based order process. diff --git a/content/reference/services/SoftLayer_Product_Package/getGatewayApplianceFlag.md b/content/reference/services/SoftLayer_Product_Package/getGatewayApplianceFlag.md index 4ff6cf9b1d..6aec91b87b 100644 --- a/content/reference/services/SoftLayer_Product_Package/getGatewayApplianceFlag.md +++ b/content/reference/services/SoftLayer_Product_Package/getGatewayApplianceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getGatewayApplianceFlag + Retrieve whether the package is a specialized network gateway appliance package. diff --git a/content/reference/services/SoftLayer_Product_Package/getGpuFlag.md b/content/reference/services/SoftLayer_Product_Package/getGpuFlag.md index 077873acfa..08a21ce0d6 100644 --- a/content/reference/services/SoftLayer_Product_Package/getGpuFlag.md +++ b/content/reference/services/SoftLayer_Product_Package/getGpuFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getGpuFlag + Retrieve this flag indicates that the package supports GPUs. diff --git a/content/reference/services/SoftLayer_Product_Package/getHourlyBillingAvailableFlag.md b/content/reference/services/SoftLayer_Product_Package/getHourlyBillingAvailableFlag.md index 1e83be92ce..64a07e109d 100644 --- a/content/reference/services/SoftLayer_Product_Package/getHourlyBillingAvailableFlag.md +++ b/content/reference/services/SoftLayer_Product_Package/getHourlyBillingAvailableFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getHourlyBillingAvailableFlag + Retrieve determines whether the package contains prices that can be ordered hourly. diff --git a/content/reference/services/SoftLayer_Product_Package/getHourlyOnlyOrders.md b/content/reference/services/SoftLayer_Product_Package/getHourlyOnlyOrders.md index b602107aba..a53f37f697 100644 --- a/content/reference/services/SoftLayer_Product_Package/getHourlyOnlyOrders.md +++ b/content/reference/services/SoftLayer_Product_Package/getHourlyOnlyOrders.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getHourlyOnlyOrders + Retrieve packages with this flag do not allow monthly orders. diff --git a/content/reference/services/SoftLayer_Product_Package/getItemAvailabilityTypes.md b/content/reference/services/SoftLayer_Product_Package/getItemAvailabilityTypes.md index 40d1b9bc0d..43a6d5917f 100644 --- a/content/reference/services/SoftLayer_Product_Package/getItemAvailabilityTypes.md +++ b/content/reference/services/SoftLayer_Product_Package/getItemAvailabilityTypes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getItemAvailabilityTypes + Returns a collection of SoftLayer_Product_Item_Attribute_Type objects. diff --git a/content/reference/services/SoftLayer_Product_Package/getItemConflicts.md b/content/reference/services/SoftLayer_Product_Package/getItemConflicts.md index a9dd9a5a8b..b6186abc29 100644 --- a/content/reference/services/SoftLayer_Product_Package/getItemConflicts.md +++ b/content/reference/services/SoftLayer_Product_Package/getItemConflicts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getItemConflicts + Retrieve the item-item conflicts associated with a package. diff --git a/content/reference/services/SoftLayer_Product_Package/getItemLocationConflicts.md b/content/reference/services/SoftLayer_Product_Package/getItemLocationConflicts.md index b8813b0690..bc4cb7fe6c 100644 --- a/content/reference/services/SoftLayer_Product_Package/getItemLocationConflicts.md +++ b/content/reference/services/SoftLayer_Product_Package/getItemLocationConflicts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getItemLocationConflicts + Retrieve the item-location conflicts associated with a package. diff --git a/content/reference/services/SoftLayer_Product_Package/getItemPriceReferences.md b/content/reference/services/SoftLayer_Product_Package/getItemPriceReferences.md index 270e5e4451..ef0fd95059 100644 --- a/content/reference/services/SoftLayer_Product_Package/getItemPriceReferences.md +++ b/content/reference/services/SoftLayer_Product_Package/getItemPriceReferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getItemPriceReferences + Retrieve cross reference for item prices diff --git a/content/reference/services/SoftLayer_Product_Package/getItemPrices.md b/content/reference/services/SoftLayer_Product_Package/getItemPrices.md index 7364040ab4..d04380872a 100644 --- a/content/reference/services/SoftLayer_Product_Package/getItemPrices.md +++ b/content/reference/services/SoftLayer_Product_Package/getItemPrices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getItemPrices + Retrieve a collection of SoftLayer_Product_Item_Prices that are valid for this package. diff --git a/content/reference/services/SoftLayer_Product_Package/getItemPricesFromSoftwareDescriptions.md b/content/reference/services/SoftLayer_Product_Package/getItemPricesFromSoftwareDescriptions.md index 643a5ee620..ceea6060bc 100644 --- a/content/reference/services/SoftLayer_Product_Package/getItemPricesFromSoftwareDescriptions.md +++ b/content/reference/services/SoftLayer_Product_Package/getItemPricesFromSoftwareDescriptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getItemPricesFromSoftwareDescriptions + Returns a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description that are available for the service offering (package). diff --git a/content/reference/services/SoftLayer_Product_Package/getItems.md b/content/reference/services/SoftLayer_Product_Package/getItems.md index 41752ecf88..73cc7f078a 100644 --- a/content/reference/services/SoftLayer_Product_Package/getItems.md +++ b/content/reference/services/SoftLayer_Product_Package/getItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getItems + Retrieve a collection of valid items available for purchase in this package. diff --git a/content/reference/services/SoftLayer_Product_Package/getItemsFromImageTemplate.md b/content/reference/services/SoftLayer_Product_Package/getItemsFromImageTemplate.md index c33c7f3682..8cd03cfbe4 100644 --- a/content/reference/services/SoftLayer_Product_Package/getItemsFromImageTemplate.md +++ b/content/reference/services/SoftLayer_Product_Package/getItemsFromImageTemplate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getItemsFromImageTemplate + Return a collection of [SoftLayer_Product_Item]({{}}) objects from a [SoftLayer_Virtual_Guest_Block_Device_Template_Group]({{}}) object diff --git a/content/reference/services/SoftLayer_Product_Package/getLocations.md b/content/reference/services/SoftLayer_Product_Package/getLocations.md index a937cc88cb..5e12b745d9 100644 --- a/content/reference/services/SoftLayer_Product_Package/getLocations.md +++ b/content/reference/services/SoftLayer_Product_Package/getLocations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getLocations + Retrieve a collection of valid locations for this package. (Deprecated - Use [SoftLayer_Product_Package::getRegions]({{}})) diff --git a/content/reference/services/SoftLayer_Product_Package/getLowestServerPrice.md b/content/reference/services/SoftLayer_Product_Package/getLowestServerPrice.md index cf0e6f4b29..15cdf48e1f 100644 --- a/content/reference/services/SoftLayer_Product_Package/getLowestServerPrice.md +++ b/content/reference/services/SoftLayer_Product_Package/getLowestServerPrice.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getLowestServerPrice + Retrieve the lowest server [SoftLayer_Product_Item_Price]({{}}) related to this package. diff --git a/content/reference/services/SoftLayer_Product_Package/getMaximumPortSpeed.md b/content/reference/services/SoftLayer_Product_Package/getMaximumPortSpeed.md index 64e1772706..badf7e9892 100644 --- a/content/reference/services/SoftLayer_Product_Package/getMaximumPortSpeed.md +++ b/content/reference/services/SoftLayer_Product_Package/getMaximumPortSpeed.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getMaximumPortSpeed + Retrieve the maximum available network speed associated with the package. diff --git a/content/reference/services/SoftLayer_Product_Package/getMessageQueueItems.md b/content/reference/services/SoftLayer_Product_Package/getMessageQueueItems.md index a9ab596600..f86072a477 100644 --- a/content/reference/services/SoftLayer_Product_Package/getMessageQueueItems.md +++ b/content/reference/services/SoftLayer_Product_Package/getMessageQueueItems.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Package/getMinimumPortSpeed.md b/content/reference/services/SoftLayer_Product_Package/getMinimumPortSpeed.md index b523d2eaab..30f1cefb3b 100644 --- a/content/reference/services/SoftLayer_Product_Package/getMinimumPortSpeed.md +++ b/content/reference/services/SoftLayer_Product_Package/getMinimumPortSpeed.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getMinimumPortSpeed + Retrieve the minimum available network speed associated with the package. diff --git a/content/reference/services/SoftLayer_Product_Package/getMongoDbEngineeredFlag.md b/content/reference/services/SoftLayer_Product_Package/getMongoDbEngineeredFlag.md index f6b1cb6f71..50368be82f 100644 --- a/content/reference/services/SoftLayer_Product_Package/getMongoDbEngineeredFlag.md +++ b/content/reference/services/SoftLayer_Product_Package/getMongoDbEngineeredFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getMongoDbEngineeredFlag + Retrieve this flag indicates that this is a MongoDB engineered package. (Deprecated) diff --git a/content/reference/services/SoftLayer_Product_Package/getNoUpgradesFlag.md b/content/reference/services/SoftLayer_Product_Package/getNoUpgradesFlag.md index e5cbbb7e94..47440bee4e 100644 --- a/content/reference/services/SoftLayer_Product_Package/getNoUpgradesFlag.md +++ b/content/reference/services/SoftLayer_Product_Package/getNoUpgradesFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getNoUpgradesFlag + Retrieve services ordered from this package cannot have upgrades or downgrades performed. diff --git a/content/reference/services/SoftLayer_Product_Package/getNonEuCompliantFlag.md b/content/reference/services/SoftLayer_Product_Package/getNonEuCompliantFlag.md index 0f6e203a96..d148925d1f 100644 --- a/content/reference/services/SoftLayer_Product_Package/getNonEuCompliantFlag.md +++ b/content/reference/services/SoftLayer_Product_Package/getNonEuCompliantFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getNonEuCompliantFlag + Retrieve whether the package is not in compliance with EU support. diff --git a/content/reference/services/SoftLayer_Product_Package/getObject.md b/content/reference/services/SoftLayer_Product_Package/getObject.md index 0db8e1f9c0..16b5f7952c 100644 --- a/content/reference/services/SoftLayer_Product_Package/getObject.md +++ b/content/reference/services/SoftLayer_Product_Package/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getObject + Retrieve a SoftLayer_Product_Package record. diff --git a/content/reference/services/SoftLayer_Product_Package/getObjectStorageDatacenters.md b/content/reference/services/SoftLayer_Product_Package/getObjectStorageDatacenters.md index b935430d27..060711553d 100644 --- a/content/reference/services/SoftLayer_Product_Package/getObjectStorageDatacenters.md +++ b/content/reference/services/SoftLayer_Product_Package/getObjectStorageDatacenters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getObjectStorageDatacenters + Returns a collection of datacenters where object storage is available plus the associated active usage rate prices. diff --git a/content/reference/services/SoftLayer_Product_Package/getObjectStorageLocationGroups.md b/content/reference/services/SoftLayer_Product_Package/getObjectStorageLocationGroups.md index a578342db8..664b148e78 100644 --- a/content/reference/services/SoftLayer_Product_Package/getObjectStorageLocationGroups.md +++ b/content/reference/services/SoftLayer_Product_Package/getObjectStorageLocationGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getObjectStorageLocationGroups + Returns a collection of location groups where object storage is available plus the associated active usage rate prices. diff --git a/content/reference/services/SoftLayer_Product_Package/getOrderPremiums.md b/content/reference/services/SoftLayer_Product_Package/getOrderPremiums.md index 5efb8e634c..00e2d34755 100644 --- a/content/reference/services/SoftLayer_Product_Package/getOrderPremiums.md +++ b/content/reference/services/SoftLayer_Product_Package/getOrderPremiums.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getOrderPremiums + Retrieve the premium price modifiers associated with the [SoftLayer_Product_Item_Price]({{}}) and [SoftLayer_Location]({{}}) objects in a package. diff --git a/content/reference/services/SoftLayer_Product_Package/getPopLocationAvailabilityFlag.md b/content/reference/services/SoftLayer_Product_Package/getPopLocationAvailabilityFlag.md index 7a51b49961..bf7c96abc3 100644 --- a/content/reference/services/SoftLayer_Product_Package/getPopLocationAvailabilityFlag.md +++ b/content/reference/services/SoftLayer_Product_Package/getPopLocationAvailabilityFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getPopLocationAvailabilityFlag + Retrieve this flag indicates if the package may be available in PoP locations in addition to Datacenters. diff --git a/content/reference/services/SoftLayer_Product_Package/getPreconfiguredFlag.md b/content/reference/services/SoftLayer_Product_Package/getPreconfiguredFlag.md index 70c417368f..2d0b8bc287 100644 --- a/content/reference/services/SoftLayer_Product_Package/getPreconfiguredFlag.md +++ b/content/reference/services/SoftLayer_Product_Package/getPreconfiguredFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getPreconfiguredFlag + Retrieve this flag indicates the package is pre-configured. (Deprecated) diff --git a/content/reference/services/SoftLayer_Product_Package/getPresetConfigurationRequiredFlag.md b/content/reference/services/SoftLayer_Product_Package/getPresetConfigurationRequiredFlag.md index f92ebe8019..b640a01f43 100644 --- a/content/reference/services/SoftLayer_Product_Package/getPresetConfigurationRequiredFlag.md +++ b/content/reference/services/SoftLayer_Product_Package/getPresetConfigurationRequiredFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getPresetConfigurationRequiredFlag + Retrieve whether the package requires the user to define a preset configuration. diff --git a/content/reference/services/SoftLayer_Product_Package/getPreventVlanSelectionFlag.md b/content/reference/services/SoftLayer_Product_Package/getPreventVlanSelectionFlag.md index f4a6631001..f4643569e4 100644 --- a/content/reference/services/SoftLayer_Product_Package/getPreventVlanSelectionFlag.md +++ b/content/reference/services/SoftLayer_Product_Package/getPreventVlanSelectionFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getPreventVlanSelectionFlag + Retrieve whether the package prevents the user from specifying a Vlan. diff --git a/content/reference/services/SoftLayer_Product_Package/getPrivateHostedCloudPackageFlag.md b/content/reference/services/SoftLayer_Product_Package/getPrivateHostedCloudPackageFlag.md index 37adb6c38d..7fe4660346 100644 --- a/content/reference/services/SoftLayer_Product_Package/getPrivateHostedCloudPackageFlag.md +++ b/content/reference/services/SoftLayer_Product_Package/getPrivateHostedCloudPackageFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getPrivateHostedCloudPackageFlag + Retrieve this flag indicates the package is for a private hosted cloud deployment. (Deprecated) diff --git a/content/reference/services/SoftLayer_Product_Package/getPrivateHostedCloudPackageType.md b/content/reference/services/SoftLayer_Product_Package/getPrivateHostedCloudPackageType.md index c79aeee951..2e3df36a6d 100644 --- a/content/reference/services/SoftLayer_Product_Package/getPrivateHostedCloudPackageType.md +++ b/content/reference/services/SoftLayer_Product_Package/getPrivateHostedCloudPackageType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getPrivateHostedCloudPackageType + Retrieve the server role of the private hosted cloud deployment. (Deprecated) diff --git a/content/reference/services/SoftLayer_Product_Package/getPrivateNetworkOnlyFlag.md b/content/reference/services/SoftLayer_Product_Package/getPrivateNetworkOnlyFlag.md index b22e72abf5..be9f44f65f 100644 --- a/content/reference/services/SoftLayer_Product_Package/getPrivateNetworkOnlyFlag.md +++ b/content/reference/services/SoftLayer_Product_Package/getPrivateNetworkOnlyFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getPrivateNetworkOnlyFlag + Retrieve whether the package only has access to the private network. diff --git a/content/reference/services/SoftLayer_Product_Package/getQuantaStorPackageFlag.md b/content/reference/services/SoftLayer_Product_Package/getQuantaStorPackageFlag.md index 51aa7774f2..e4770fa82f 100644 --- a/content/reference/services/SoftLayer_Product_Package/getQuantaStorPackageFlag.md +++ b/content/reference/services/SoftLayer_Product_Package/getQuantaStorPackageFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getQuantaStorPackageFlag + Retrieve whether the package is a specialized mass storage QuantaStor package. (Deprecated) diff --git a/content/reference/services/SoftLayer_Product_Package/getRaidDiskRestrictionFlag.md b/content/reference/services/SoftLayer_Product_Package/getRaidDiskRestrictionFlag.md index 45594ec124..c893c4092f 100644 --- a/content/reference/services/SoftLayer_Product_Package/getRaidDiskRestrictionFlag.md +++ b/content/reference/services/SoftLayer_Product_Package/getRaidDiskRestrictionFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getRaidDiskRestrictionFlag + Retrieve this flag indicates the package does not allow different disks with RAID. diff --git a/content/reference/services/SoftLayer_Product_Package/getRedundantPowerFlag.md b/content/reference/services/SoftLayer_Product_Package/getRedundantPowerFlag.md index 1676842722..d0b08d3314 100644 --- a/content/reference/services/SoftLayer_Product_Package/getRedundantPowerFlag.md +++ b/content/reference/services/SoftLayer_Product_Package/getRedundantPowerFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getRedundantPowerFlag + Retrieve this flag determines if the package contains a redundant power supply product. diff --git a/content/reference/services/SoftLayer_Product_Package/getRegions.md b/content/reference/services/SoftLayer_Product_Package/getRegions.md index 22e2e31127..6c67d4b2d3 100644 --- a/content/reference/services/SoftLayer_Product_Package/getRegions.md +++ b/content/reference/services/SoftLayer_Product_Package/getRegions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getRegions + Retrieve the regional locations that a package is available in. diff --git a/content/reference/services/SoftLayer_Product_Package/getResourceGroupTemplate.md b/content/reference/services/SoftLayer_Product_Package/getResourceGroupTemplate.md index d22a9c5440..0cec560501 100644 --- a/content/reference/services/SoftLayer_Product_Package/getResourceGroupTemplate.md +++ b/content/reference/services/SoftLayer_Product_Package/getResourceGroupTemplate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getResourceGroupTemplate + Retrieve the resource group template that describes a multi-server solution. (Deprecated) diff --git a/content/reference/services/SoftLayer_Product_Package/getStandardCategories.md b/content/reference/services/SoftLayer_Product_Package/getStandardCategories.md index 0a0345f3c8..d30782d833 100644 --- a/content/reference/services/SoftLayer_Product_Package/getStandardCategories.md +++ b/content/reference/services/SoftLayer_Product_Package/getStandardCategories.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getStandardCategories + This call is similar to [SoftLayer_Product_Package::getCategories]({{}}), except that it does not include account-restricted pricing. Not all accounts have restricted pricing. diff --git a/content/reference/services/SoftLayer_Product_Package/getTopLevelItemCategoryCode.md b/content/reference/services/SoftLayer_Product_Package/getTopLevelItemCategoryCode.md index 52c44ab47a..cf9713008b 100644 --- a/content/reference/services/SoftLayer_Product_Package/getTopLevelItemCategoryCode.md +++ b/content/reference/services/SoftLayer_Product_Package/getTopLevelItemCategoryCode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getTopLevelItemCategoryCode + Retrieve the top level category code for this service offering. diff --git a/content/reference/services/SoftLayer_Product_Package/getType.md b/content/reference/services/SoftLayer_Product_Package/getType.md index 596e272131..51296915a3 100644 --- a/content/reference/services/SoftLayer_Product_Package/getType.md +++ b/content/reference/services/SoftLayer_Product_Package/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package](/reference/services/SoftLayer_Product_Package)::getType + Retrieve the type of service offering. This property can be used to help filter packages. diff --git a/content/reference/services/SoftLayer_Product_Package_Preset/_index.md b/content/reference/services/SoftLayer_Product_Package_Preset/_index.md index 291057a66e..ed358c97fe 100644 --- a/content/reference/services/SoftLayer_Product_Package_Preset/_index.md +++ b/content/reference/services/SoftLayer_Product_Package_Preset/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,102 +44,119 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Product_Package_Preset/getAllObjects) Get all active package presets +
              #### [getAvailableStorageUnits](/reference/services/SoftLayer_Product_Package_Preset/getAvailableStorageUnits) +
              #### [getBareMetalReservedFlag](/reference/services/SoftLayer_Product_Package_Preset/getBareMetalReservedFlag) Retrieve when true this preset is for ordering a Bare Metal Reserved server. +
              #### [getCategories](/reference/services/SoftLayer_Product_Package_Preset/getCategories) Retrieve the item categories that are included in this package preset configuration. +
              #### [getComputeGroup](/reference/services/SoftLayer_Product_Package_Preset/getComputeGroup) Retrieve the compute family this configuration belongs to. +
              #### [getConfiguration](/reference/services/SoftLayer_Product_Package_Preset/getConfiguration) Retrieve the preset configuration (category and price). +
              #### [getDisallowedComputeGroupUpgradeFlag](/reference/services/SoftLayer_Product_Package_Preset/getDisallowedComputeGroupUpgradeFlag) Retrieve when true this preset is only allowed to upgrade/downgrade to other presets in the same compute family. +
              #### [getFixedConfigurationFlag](/reference/services/SoftLayer_Product_Package_Preset/getFixedConfigurationFlag) Retrieve a package preset with this flag set will not allow the price's defined in the preset configuration to be overriden during order placement. +
              #### [getLocations](/reference/services/SoftLayer_Product_Package_Preset/getLocations) Retrieve the locations this preset configuration is available in. If empty the preset is available in all locations the package is available in. +
              #### [getLowestPresetServerPrice](/reference/services/SoftLayer_Product_Package_Preset/getLowestPresetServerPrice) Retrieve the lowest server prices related to this package preset. +
              #### [getObject](/reference/services/SoftLayer_Product_Package_Preset/getObject) Retrieve a SoftLayer_Product_Package_Preset record. +
              #### [getPackage](/reference/services/SoftLayer_Product_Package_Preset/getPackage) Retrieve the package this preset belongs to. +
              #### [getPackageConfiguration](/reference/services/SoftLayer_Product_Package_Preset/getPackageConfiguration) Retrieve the item categories associated with a package preset, including information detailing which item categories are required as part of a SoftLayer product order. +
              #### [getPrices](/reference/services/SoftLayer_Product_Package_Preset/getPrices) Retrieve the item prices that are included in this package preset configuration. +
              #### [getStorageGroupTemplateArrays](/reference/services/SoftLayer_Product_Package_Preset/getStorageGroupTemplateArrays) Retrieve describes how all disks in this preset will be configured. +
              #### [getTotalMinimumHourlyFee](/reference/services/SoftLayer_Product_Package_Preset/getTotalMinimumHourlyFee) Retrieve the starting hourly price for this configuration. Additional options not defined in the preset may increase the cost. +
              #### [getTotalMinimumRecurringFee](/reference/services/SoftLayer_Product_Package_Preset/getTotalMinimumRecurringFee) Retrieve the starting monthly price for this configuration. Additional options not defined in the preset may increase the cost. +
              diff --git a/content/reference/services/SoftLayer_Product_Package_Preset/getAllObjects.md b/content/reference/services/SoftLayer_Product_Package_Preset/getAllObjects.md index 38c9587d70..8e5ae930e9 100644 --- a/content/reference/services/SoftLayer_Product_Package_Preset/getAllObjects.md +++ b/content/reference/services/SoftLayer_Product_Package_Preset/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Preset](/reference/services/SoftLayer_Product_Package_Preset)::getAllObjects + Get all active package presets diff --git a/content/reference/services/SoftLayer_Product_Package_Preset/getAvailableStorageUnits.md b/content/reference/services/SoftLayer_Product_Package_Preset/getAvailableStorageUnits.md index 88f9320e57..bca8ee7b68 100644 --- a/content/reference/services/SoftLayer_Product_Package_Preset/getAvailableStorageUnits.md +++ b/content/reference/services/SoftLayer_Product_Package_Preset/getAvailableStorageUnits.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Package_Preset/getBareMetalReservedFlag.md b/content/reference/services/SoftLayer_Product_Package_Preset/getBareMetalReservedFlag.md index ef680b8e01..3c89b4df3c 100644 --- a/content/reference/services/SoftLayer_Product_Package_Preset/getBareMetalReservedFlag.md +++ b/content/reference/services/SoftLayer_Product_Package_Preset/getBareMetalReservedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Preset](/reference/services/SoftLayer_Product_Package_Preset)::getBareMetalReservedFlag + Retrieve when true this preset is for ordering a Bare Metal Reserved server. diff --git a/content/reference/services/SoftLayer_Product_Package_Preset/getCategories.md b/content/reference/services/SoftLayer_Product_Package_Preset/getCategories.md index a01595cf75..ae934f9064 100644 --- a/content/reference/services/SoftLayer_Product_Package_Preset/getCategories.md +++ b/content/reference/services/SoftLayer_Product_Package_Preset/getCategories.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Preset](/reference/services/SoftLayer_Product_Package_Preset)::getCategories + Retrieve the item categories that are included in this package preset configuration. diff --git a/content/reference/services/SoftLayer_Product_Package_Preset/getComputeGroup.md b/content/reference/services/SoftLayer_Product_Package_Preset/getComputeGroup.md index 9165049363..0380d513d9 100644 --- a/content/reference/services/SoftLayer_Product_Package_Preset/getComputeGroup.md +++ b/content/reference/services/SoftLayer_Product_Package_Preset/getComputeGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Preset](/reference/services/SoftLayer_Product_Package_Preset)::getComputeGroup + Retrieve the compute family this configuration belongs to. diff --git a/content/reference/services/SoftLayer_Product_Package_Preset/getConfiguration.md b/content/reference/services/SoftLayer_Product_Package_Preset/getConfiguration.md index f8fa807a7a..264fbe8fc8 100644 --- a/content/reference/services/SoftLayer_Product_Package_Preset/getConfiguration.md +++ b/content/reference/services/SoftLayer_Product_Package_Preset/getConfiguration.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Preset](/reference/services/SoftLayer_Product_Package_Preset)::getConfiguration + Retrieve the preset configuration (category and price). diff --git a/content/reference/services/SoftLayer_Product_Package_Preset/getDisallowedComputeGroupUpgradeFlag.md b/content/reference/services/SoftLayer_Product_Package_Preset/getDisallowedComputeGroupUpgradeFlag.md index eef3cc28b7..e8c3f86154 100644 --- a/content/reference/services/SoftLayer_Product_Package_Preset/getDisallowedComputeGroupUpgradeFlag.md +++ b/content/reference/services/SoftLayer_Product_Package_Preset/getDisallowedComputeGroupUpgradeFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Preset](/reference/services/SoftLayer_Product_Package_Preset)::getDisallowedComputeGroupUpgradeFlag + Retrieve when true this preset is only allowed to upgrade/downgrade to other presets in the same compute family. diff --git a/content/reference/services/SoftLayer_Product_Package_Preset/getFixedConfigurationFlag.md b/content/reference/services/SoftLayer_Product_Package_Preset/getFixedConfigurationFlag.md index 129f431282..c6e6e06471 100644 --- a/content/reference/services/SoftLayer_Product_Package_Preset/getFixedConfigurationFlag.md +++ b/content/reference/services/SoftLayer_Product_Package_Preset/getFixedConfigurationFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Preset](/reference/services/SoftLayer_Product_Package_Preset)::getFixedConfigurationFlag + Retrieve a package preset with this flag set will not allow the price's defined in the preset configuration to be overriden during order placement. diff --git a/content/reference/services/SoftLayer_Product_Package_Preset/getLocations.md b/content/reference/services/SoftLayer_Product_Package_Preset/getLocations.md index b6475faff5..d443d1ed4a 100644 --- a/content/reference/services/SoftLayer_Product_Package_Preset/getLocations.md +++ b/content/reference/services/SoftLayer_Product_Package_Preset/getLocations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Preset](/reference/services/SoftLayer_Product_Package_Preset)::getLocations + Retrieve the locations this preset configuration is available in. If empty the preset is available in all locations the package is available in. diff --git a/content/reference/services/SoftLayer_Product_Package_Preset/getLowestPresetServerPrice.md b/content/reference/services/SoftLayer_Product_Package_Preset/getLowestPresetServerPrice.md index 678e344db4..be26bfe06a 100644 --- a/content/reference/services/SoftLayer_Product_Package_Preset/getLowestPresetServerPrice.md +++ b/content/reference/services/SoftLayer_Product_Package_Preset/getLowestPresetServerPrice.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Preset](/reference/services/SoftLayer_Product_Package_Preset)::getLowestPresetServerPrice + Retrieve the lowest server prices related to this package preset. diff --git a/content/reference/services/SoftLayer_Product_Package_Preset/getObject.md b/content/reference/services/SoftLayer_Product_Package_Preset/getObject.md index 427cc6f0e4..f9d735d34f 100644 --- a/content/reference/services/SoftLayer_Product_Package_Preset/getObject.md +++ b/content/reference/services/SoftLayer_Product_Package_Preset/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Preset](/reference/services/SoftLayer_Product_Package_Preset)::getObject + Retrieve a SoftLayer_Product_Package_Preset record. diff --git a/content/reference/services/SoftLayer_Product_Package_Preset/getPackage.md b/content/reference/services/SoftLayer_Product_Package_Preset/getPackage.md index 887fd695c8..29e97d32d8 100644 --- a/content/reference/services/SoftLayer_Product_Package_Preset/getPackage.md +++ b/content/reference/services/SoftLayer_Product_Package_Preset/getPackage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Preset](/reference/services/SoftLayer_Product_Package_Preset)::getPackage + Retrieve the package this preset belongs to. diff --git a/content/reference/services/SoftLayer_Product_Package_Preset/getPackageConfiguration.md b/content/reference/services/SoftLayer_Product_Package_Preset/getPackageConfiguration.md index bce0575bf1..5e096ab488 100644 --- a/content/reference/services/SoftLayer_Product_Package_Preset/getPackageConfiguration.md +++ b/content/reference/services/SoftLayer_Product_Package_Preset/getPackageConfiguration.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Preset](/reference/services/SoftLayer_Product_Package_Preset)::getPackageConfiguration + Retrieve the item categories associated with a package preset, including information detailing which item categories are required as part of a SoftLayer product order. diff --git a/content/reference/services/SoftLayer_Product_Package_Preset/getPrices.md b/content/reference/services/SoftLayer_Product_Package_Preset/getPrices.md index 76345f791e..702cc3d304 100644 --- a/content/reference/services/SoftLayer_Product_Package_Preset/getPrices.md +++ b/content/reference/services/SoftLayer_Product_Package_Preset/getPrices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Preset](/reference/services/SoftLayer_Product_Package_Preset)::getPrices + Retrieve the item prices that are included in this package preset configuration. diff --git a/content/reference/services/SoftLayer_Product_Package_Preset/getStorageGroupTemplateArrays.md b/content/reference/services/SoftLayer_Product_Package_Preset/getStorageGroupTemplateArrays.md index fa346d7ed6..1bb8bc3709 100644 --- a/content/reference/services/SoftLayer_Product_Package_Preset/getStorageGroupTemplateArrays.md +++ b/content/reference/services/SoftLayer_Product_Package_Preset/getStorageGroupTemplateArrays.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Preset](/reference/services/SoftLayer_Product_Package_Preset)::getStorageGroupTemplateArrays + Retrieve describes how all disks in this preset will be configured. diff --git a/content/reference/services/SoftLayer_Product_Package_Preset/getTotalMinimumHourlyFee.md b/content/reference/services/SoftLayer_Product_Package_Preset/getTotalMinimumHourlyFee.md index 75ee85dcfd..01de2f1f43 100644 --- a/content/reference/services/SoftLayer_Product_Package_Preset/getTotalMinimumHourlyFee.md +++ b/content/reference/services/SoftLayer_Product_Package_Preset/getTotalMinimumHourlyFee.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Preset](/reference/services/SoftLayer_Product_Package_Preset)::getTotalMinimumHourlyFee + Retrieve the starting hourly price for this configuration. Additional options not defined in the preset may increase the cost. diff --git a/content/reference/services/SoftLayer_Product_Package_Preset/getTotalMinimumRecurringFee.md b/content/reference/services/SoftLayer_Product_Package_Preset/getTotalMinimumRecurringFee.md index 12f566cd54..98dc3f5d6f 100644 --- a/content/reference/services/SoftLayer_Product_Package_Preset/getTotalMinimumRecurringFee.md +++ b/content/reference/services/SoftLayer_Product_Package_Preset/getTotalMinimumRecurringFee.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Preset](/reference/services/SoftLayer_Product_Package_Preset)::getTotalMinimumRecurringFee + Retrieve the starting monthly price for this configuration. Additional options not defined in the preset may increase the cost. diff --git a/content/reference/services/SoftLayer_Product_Package_Server/_index.md b/content/reference/services/SoftLayer_Product_Package_Server/_index.md index 156fa4d64b..70ba384e2b 100644 --- a/content/reference/services/SoftLayer_Product_Package_Server/_index.md +++ b/content/reference/services/SoftLayer_Product_Package_Server/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,42 +44,49 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Product_Package_Server/getAllObjects) Get the package servers +
              #### [getCatalog](/reference/services/SoftLayer_Product_Package_Server/getCatalog) +
              #### [getItem](/reference/services/SoftLayer_Product_Package_Server/getItem) +
              #### [getItemPrice](/reference/services/SoftLayer_Product_Package_Server/getItemPrice) +
              #### [getObject](/reference/services/SoftLayer_Product_Package_Server/getObject) Retrieve a SoftLayer_Product_Package_Server record. +
              #### [getPackage](/reference/services/SoftLayer_Product_Package_Server/getPackage) +
              #### [getPreset](/reference/services/SoftLayer_Product_Package_Server/getPreset) +
              diff --git a/content/reference/services/SoftLayer_Product_Package_Server/getAllObjects.md b/content/reference/services/SoftLayer_Product_Package_Server/getAllObjects.md index 5e413d1280..9cf0def09a 100644 --- a/content/reference/services/SoftLayer_Product_Package_Server/getAllObjects.md +++ b/content/reference/services/SoftLayer_Product_Package_Server/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Server](/reference/services/SoftLayer_Product_Package_Server)::getAllObjects + Get the package servers diff --git a/content/reference/services/SoftLayer_Product_Package_Server/getCatalog.md b/content/reference/services/SoftLayer_Product_Package_Server/getCatalog.md index b65cbca080..afa6a6f703 100644 --- a/content/reference/services/SoftLayer_Product_Package_Server/getCatalog.md +++ b/content/reference/services/SoftLayer_Product_Package_Server/getCatalog.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Package_Server/getItem.md b/content/reference/services/SoftLayer_Product_Package_Server/getItem.md index 5c6b208593..b719716d69 100644 --- a/content/reference/services/SoftLayer_Product_Package_Server/getItem.md +++ b/content/reference/services/SoftLayer_Product_Package_Server/getItem.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Package_Server/getItemPrice.md b/content/reference/services/SoftLayer_Product_Package_Server/getItemPrice.md index a220d802bb..a1ff2f519e 100644 --- a/content/reference/services/SoftLayer_Product_Package_Server/getItemPrice.md +++ b/content/reference/services/SoftLayer_Product_Package_Server/getItemPrice.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Package_Server/getObject.md b/content/reference/services/SoftLayer_Product_Package_Server/getObject.md index 82bf3b1d40..e89cd793db 100644 --- a/content/reference/services/SoftLayer_Product_Package_Server/getObject.md +++ b/content/reference/services/SoftLayer_Product_Package_Server/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Server](/reference/services/SoftLayer_Product_Package_Server)::getObject + Retrieve a SoftLayer_Product_Package_Server record. diff --git a/content/reference/services/SoftLayer_Product_Package_Server/getPackage.md b/content/reference/services/SoftLayer_Product_Package_Server/getPackage.md index 51362f6f76..d3fda0f6fc 100644 --- a/content/reference/services/SoftLayer_Product_Package_Server/getPackage.md +++ b/content/reference/services/SoftLayer_Product_Package_Server/getPackage.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Package_Server/getPreset.md b/content/reference/services/SoftLayer_Product_Package_Server/getPreset.md index 3a6ece5f2f..c114ac308a 100644 --- a/content/reference/services/SoftLayer_Product_Package_Server/getPreset.md +++ b/content/reference/services/SoftLayer_Product_Package_Server/getPreset.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Product_Package_Server_Option/_index.md b/content/reference/services/SoftLayer_Product_Package_Server_Option/_index.md index 2ed0e14926..3a98d0dc87 100644 --- a/content/reference/services/SoftLayer_Product_Package_Server_Option/_index.md +++ b/content/reference/services/SoftLayer_Product_Package_Server_Option/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,18 +44,21 @@ classes: #### [getAllOptions](/reference/services/SoftLayer_Product_Package_Server_Option/getAllOptions) Get all the package server options +
              #### [getObject](/reference/services/SoftLayer_Product_Package_Server_Option/getObject) Retrieve a SoftLayer_Product_Package_Server_Option record. +
              #### [getOptions](/reference/services/SoftLayer_Product_Package_Server_Option/getOptions) Get all the package server options of a particular type +
              diff --git a/content/reference/services/SoftLayer_Product_Package_Server_Option/getAllOptions.md b/content/reference/services/SoftLayer_Product_Package_Server_Option/getAllOptions.md index 683238f509..4c9a61cbb5 100644 --- a/content/reference/services/SoftLayer_Product_Package_Server_Option/getAllOptions.md +++ b/content/reference/services/SoftLayer_Product_Package_Server_Option/getAllOptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Server_Option](/reference/services/SoftLayer_Product_Package_Server_Option)::getAllOptions + Get all the package server options diff --git a/content/reference/services/SoftLayer_Product_Package_Server_Option/getObject.md b/content/reference/services/SoftLayer_Product_Package_Server_Option/getObject.md index e226e9e9d2..5a251f96ce 100644 --- a/content/reference/services/SoftLayer_Product_Package_Server_Option/getObject.md +++ b/content/reference/services/SoftLayer_Product_Package_Server_Option/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Server_Option](/reference/services/SoftLayer_Product_Package_Server_Option)::getObject + Retrieve a SoftLayer_Product_Package_Server_Option record. diff --git a/content/reference/services/SoftLayer_Product_Package_Server_Option/getOptions.md b/content/reference/services/SoftLayer_Product_Package_Server_Option/getOptions.md index f2871f0fa0..a8a6b0f7e3 100644 --- a/content/reference/services/SoftLayer_Product_Package_Server_Option/getOptions.md +++ b/content/reference/services/SoftLayer_Product_Package_Server_Option/getOptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Server_Option](/reference/services/SoftLayer_Product_Package_Server_Option)::getOptions + Get all the package server options of a particular type diff --git a/content/reference/services/SoftLayer_Product_Package_Type/_index.md b/content/reference/services/SoftLayer_Product_Package_Type/_index.md index 058dfd4594..e5ee8ff1d9 100644 --- a/content/reference/services/SoftLayer_Product_Package_Type/_index.md +++ b/content/reference/services/SoftLayer_Product_Package_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The [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. @@ -42,18 +44,21 @@ The [SoftLayer_Product_Package_Type]({{
              #### [getObject](/reference/services/SoftLayer_Product_Package_Type/getObject) Retrieve a SoftLayer_Product_Package_Type record. +
              #### [getPackages](/reference/services/SoftLayer_Product_Package_Type/getPackages) Retrieve all the packages associated with the given package type. +
              diff --git a/content/reference/services/SoftLayer_Product_Package_Type/getAllObjects.md b/content/reference/services/SoftLayer_Product_Package_Type/getAllObjects.md index b7c4d5231d..e6eaef690d 100644 --- a/content/reference/services/SoftLayer_Product_Package_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_Product_Package_Type/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Type](/reference/services/SoftLayer_Product_Package_Type)::getAllObjects + Get all the package types. diff --git a/content/reference/services/SoftLayer_Product_Package_Type/getObject.md b/content/reference/services/SoftLayer_Product_Package_Type/getObject.md index 99d308053a..3c10b9b957 100644 --- a/content/reference/services/SoftLayer_Product_Package_Type/getObject.md +++ b/content/reference/services/SoftLayer_Product_Package_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Type](/reference/services/SoftLayer_Product_Package_Type)::getObject + Retrieve a SoftLayer_Product_Package_Type record. diff --git a/content/reference/services/SoftLayer_Product_Package_Type/getPackages.md b/content/reference/services/SoftLayer_Product_Package_Type/getPackages.md index b37aa49aa3..7a7fc503ee 100644 --- a/content/reference/services/SoftLayer_Product_Package_Type/getPackages.md +++ b/content/reference/services/SoftLayer_Product_Package_Type/getPackages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Package_Type](/reference/services/SoftLayer_Product_Package_Type)::getPackages + Retrieve all the packages associated with the given package type. diff --git a/content/reference/services/SoftLayer_Product_Promotion/_index.md b/content/reference/services/SoftLayer_Product_Promotion/_index.md index f0dde2da41..bd0086a518 100644 --- a/content/reference/services/SoftLayer_Product_Promotion/_index.md +++ b/content/reference/services/SoftLayer_Product_Promotion/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The promotion web service is used to find information regarding a specific promotion using a promotion code. @@ -42,12 +44,14 @@ The promotion web service is used to find information regarding a specific promo #### [findByPromoCode](/reference/services/SoftLayer_Product_Promotion/findByPromoCode) +
              #### [getObject](/reference/services/SoftLayer_Product_Promotion/getObject) Retrieve a SoftLayer_Product_Promotion record. +
              diff --git a/content/reference/services/SoftLayer_Product_Promotion/findByPromoCode.md b/content/reference/services/SoftLayer_Product_Promotion/findByPromoCode.md index 1bc33b3be0..2050804335 100644 --- a/content/reference/services/SoftLayer_Product_Promotion/findByPromoCode.md +++ b/content/reference/services/SoftLayer_Product_Promotion/findByPromoCode.md @@ -16,6 +16,7 @@ aliases: + ## Overview Retrieves a promotion using its code. diff --git a/content/reference/services/SoftLayer_Product_Promotion/getObject.md b/content/reference/services/SoftLayer_Product_Promotion/getObject.md index 1bcbb6bf8f..c3cfab2f1b 100644 --- a/content/reference/services/SoftLayer_Product_Promotion/getObject.md +++ b/content/reference/services/SoftLayer_Product_Promotion/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Promotion](/reference/services/SoftLayer_Product_Promotion)::getObject + Retrieve a SoftLayer_Product_Promotion record. diff --git a/content/reference/services/SoftLayer_Product_Upgrade_Request/_index.md b/content/reference/services/SoftLayer_Product_Upgrade_Request/_index.md index f9ee3d62f0..5b62b6ccab 100644 --- a/content/reference/services/SoftLayer_Product_Upgrade_Request/_index.md +++ b/content/reference/services/SoftLayer_Product_Upgrade_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Product_Upgrade_Request tracks the progress of an upgrade, and allows modification of the maintenance window and other information. @@ -42,72 +44,84 @@ SoftLayer_Product_Upgrade_Request tracks the progress of an upgrade, and allows #### [approveChanges](/reference/services/SoftLayer_Product_Upgrade_Request/approveChanges) Approves the upgrade request order that was revised by SoftLayer Sales +
              #### [getAccount](/reference/services/SoftLayer_Product_Upgrade_Request/getAccount) Retrieve the account that an order belongs to +
              #### [getCompletedFlag](/reference/services/SoftLayer_Product_Upgrade_Request/getCompletedFlag) Retrieve indicates that the upgrade request has completed or has been cancelled. +
              #### [getInvoice](/reference/services/SoftLayer_Product_Upgrade_Request/getInvoice) Retrieve this is the invoice associated with the upgrade request. For hourly servers or services, an invoice will not be available. +
              #### [getObject](/reference/services/SoftLayer_Product_Upgrade_Request/getObject) Retrieve a SoftLayer_Product_Upgrade_Request record. +
              #### [getOrder](/reference/services/SoftLayer_Product_Upgrade_Request/getOrder) Retrieve an order record associated to the upgrade request +
              #### [getServer](/reference/services/SoftLayer_Product_Upgrade_Request/getServer) Retrieve a server object associated with the upgrade request if any. +
              #### [getStatus](/reference/services/SoftLayer_Product_Upgrade_Request/getStatus) Retrieve the current status of the upgrade request. +
              #### [getTicket](/reference/services/SoftLayer_Product_Upgrade_Request/getTicket) Retrieve the ticket that is used to coordinate the upgrade process. +
              #### [getUser](/reference/services/SoftLayer_Product_Upgrade_Request/getUser) Retrieve the user that placed the order. +
              #### [getVirtualGuest](/reference/services/SoftLayer_Product_Upgrade_Request/getVirtualGuest) Retrieve a virtual server object associated with the upgrade request if any. +
              #### [updateMaintenanceWindow](/reference/services/SoftLayer_Product_Upgrade_Request/updateMaintenanceWindow) Updates the maintenance window +
              diff --git a/content/reference/services/SoftLayer_Product_Upgrade_Request/approveChanges.md b/content/reference/services/SoftLayer_Product_Upgrade_Request/approveChanges.md index 5237506cde..8d86c88622 100644 --- a/content/reference/services/SoftLayer_Product_Upgrade_Request/approveChanges.md +++ b/content/reference/services/SoftLayer_Product_Upgrade_Request/approveChanges.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Upgrade_Request](/reference/services/SoftLayer_Product_Upgrade_Request)::approveChanges + Approves the upgrade request order that was revised by SoftLayer Sales diff --git a/content/reference/services/SoftLayer_Product_Upgrade_Request/getAccount.md b/content/reference/services/SoftLayer_Product_Upgrade_Request/getAccount.md index 129fdd774c..7ffe3c9ee1 100644 --- a/content/reference/services/SoftLayer_Product_Upgrade_Request/getAccount.md +++ b/content/reference/services/SoftLayer_Product_Upgrade_Request/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Upgrade_Request](/reference/services/SoftLayer_Product_Upgrade_Request)::getAccount + Retrieve the account that an order belongs to diff --git a/content/reference/services/SoftLayer_Product_Upgrade_Request/getCompletedFlag.md b/content/reference/services/SoftLayer_Product_Upgrade_Request/getCompletedFlag.md index 817414616f..37ef984a96 100644 --- a/content/reference/services/SoftLayer_Product_Upgrade_Request/getCompletedFlag.md +++ b/content/reference/services/SoftLayer_Product_Upgrade_Request/getCompletedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Upgrade_Request](/reference/services/SoftLayer_Product_Upgrade_Request)::getCompletedFlag + Retrieve indicates that the upgrade request has completed or has been cancelled. diff --git a/content/reference/services/SoftLayer_Product_Upgrade_Request/getInvoice.md b/content/reference/services/SoftLayer_Product_Upgrade_Request/getInvoice.md index 5ca2f7dba3..62e9a7ba56 100644 --- a/content/reference/services/SoftLayer_Product_Upgrade_Request/getInvoice.md +++ b/content/reference/services/SoftLayer_Product_Upgrade_Request/getInvoice.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Upgrade_Request](/reference/services/SoftLayer_Product_Upgrade_Request)::getInvoice + Retrieve this is the invoice associated with the upgrade request. For hourly servers or services, an invoice will not be available. diff --git a/content/reference/services/SoftLayer_Product_Upgrade_Request/getObject.md b/content/reference/services/SoftLayer_Product_Upgrade_Request/getObject.md index dff83de3f1..9b9ed1c695 100644 --- a/content/reference/services/SoftLayer_Product_Upgrade_Request/getObject.md +++ b/content/reference/services/SoftLayer_Product_Upgrade_Request/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Upgrade_Request](/reference/services/SoftLayer_Product_Upgrade_Request)::getObject + Retrieve a SoftLayer_Product_Upgrade_Request record. diff --git a/content/reference/services/SoftLayer_Product_Upgrade_Request/getOrder.md b/content/reference/services/SoftLayer_Product_Upgrade_Request/getOrder.md index b94adbb64a..c4a3850695 100644 --- a/content/reference/services/SoftLayer_Product_Upgrade_Request/getOrder.md +++ b/content/reference/services/SoftLayer_Product_Upgrade_Request/getOrder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Upgrade_Request](/reference/services/SoftLayer_Product_Upgrade_Request)::getOrder + Retrieve an order record associated to the upgrade request diff --git a/content/reference/services/SoftLayer_Product_Upgrade_Request/getServer.md b/content/reference/services/SoftLayer_Product_Upgrade_Request/getServer.md index e6458544cf..beebe5e855 100644 --- a/content/reference/services/SoftLayer_Product_Upgrade_Request/getServer.md +++ b/content/reference/services/SoftLayer_Product_Upgrade_Request/getServer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Upgrade_Request](/reference/services/SoftLayer_Product_Upgrade_Request)::getServer + Retrieve a server object associated with the upgrade request if any. diff --git a/content/reference/services/SoftLayer_Product_Upgrade_Request/getStatus.md b/content/reference/services/SoftLayer_Product_Upgrade_Request/getStatus.md index 47037fb91b..6736133511 100644 --- a/content/reference/services/SoftLayer_Product_Upgrade_Request/getStatus.md +++ b/content/reference/services/SoftLayer_Product_Upgrade_Request/getStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Upgrade_Request](/reference/services/SoftLayer_Product_Upgrade_Request)::getStatus + Retrieve the current status of the upgrade request. diff --git a/content/reference/services/SoftLayer_Product_Upgrade_Request/getTicket.md b/content/reference/services/SoftLayer_Product_Upgrade_Request/getTicket.md index 6374002fb5..f6dd29880d 100644 --- a/content/reference/services/SoftLayer_Product_Upgrade_Request/getTicket.md +++ b/content/reference/services/SoftLayer_Product_Upgrade_Request/getTicket.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Upgrade_Request](/reference/services/SoftLayer_Product_Upgrade_Request)::getTicket + Retrieve the ticket that is used to coordinate the upgrade process. diff --git a/content/reference/services/SoftLayer_Product_Upgrade_Request/getUser.md b/content/reference/services/SoftLayer_Product_Upgrade_Request/getUser.md index 9711dde4b6..3e514678ab 100644 --- a/content/reference/services/SoftLayer_Product_Upgrade_Request/getUser.md +++ b/content/reference/services/SoftLayer_Product_Upgrade_Request/getUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Upgrade_Request](/reference/services/SoftLayer_Product_Upgrade_Request)::getUser + Retrieve the user that placed the order. diff --git a/content/reference/services/SoftLayer_Product_Upgrade_Request/getVirtualGuest.md b/content/reference/services/SoftLayer_Product_Upgrade_Request/getVirtualGuest.md index 0fa90c5adc..fa4f577635 100644 --- a/content/reference/services/SoftLayer_Product_Upgrade_Request/getVirtualGuest.md +++ b/content/reference/services/SoftLayer_Product_Upgrade_Request/getVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Upgrade_Request](/reference/services/SoftLayer_Product_Upgrade_Request)::getVirtualGuest + Retrieve a virtual server object associated with the upgrade request if any. diff --git a/content/reference/services/SoftLayer_Product_Upgrade_Request/updateMaintenanceWindow.md b/content/reference/services/SoftLayer_Product_Upgrade_Request/updateMaintenanceWindow.md index 5a337732e2..92af5347f7 100644 --- a/content/reference/services/SoftLayer_Product_Upgrade_Request/updateMaintenanceWindow.md +++ b/content/reference/services/SoftLayer_Product_Upgrade_Request/updateMaintenanceWindow.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Product_Upgrade_Request](/reference/services/SoftLayer_Product_Upgrade_Request)::updateMaintenanceWindow + Updates the maintenance window diff --git a/content/reference/services/SoftLayer_Provisioning_Hook/_index.md b/content/reference/services/SoftLayer_Provisioning_Hook/_index.md index 241a93aaaf..2a31d7767e 100644 --- a/content/reference/services/SoftLayer_Provisioning_Hook/_index.md +++ b/content/reference/services/SoftLayer_Provisioning_Hook/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,36 +44,42 @@ classes: #### [createObject](/reference/services/SoftLayer_Provisioning_Hook/createObject) +
              #### [deleteObject](/reference/services/SoftLayer_Provisioning_Hook/deleteObject) +
              #### [editObject](/reference/services/SoftLayer_Provisioning_Hook/editObject) +
              #### [getAccount](/reference/services/SoftLayer_Provisioning_Hook/getAccount) +
              #### [getHookType](/reference/services/SoftLayer_Provisioning_Hook/getHookType) +
              #### [getObject](/reference/services/SoftLayer_Provisioning_Hook/getObject) Retrieve a SoftLayer_Provisioning_Hook record. +
              diff --git a/content/reference/services/SoftLayer_Provisioning_Hook/createObject.md b/content/reference/services/SoftLayer_Provisioning_Hook/createObject.md index 0d0286d8eb..f6f15873f9 100644 --- a/content/reference/services/SoftLayer_Provisioning_Hook/createObject.md +++ b/content/reference/services/SoftLayer_Provisioning_Hook/createObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Provisioning_Hook/deleteObject.md b/content/reference/services/SoftLayer_Provisioning_Hook/deleteObject.md index 3e94d67ff5..98cf5ca7b7 100644 --- a/content/reference/services/SoftLayer_Provisioning_Hook/deleteObject.md +++ b/content/reference/services/SoftLayer_Provisioning_Hook/deleteObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Provisioning_Hook/editObject.md b/content/reference/services/SoftLayer_Provisioning_Hook/editObject.md index a3e877f36d..0b57439a53 100644 --- a/content/reference/services/SoftLayer_Provisioning_Hook/editObject.md +++ b/content/reference/services/SoftLayer_Provisioning_Hook/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Provisioning_Hook/getAccount.md b/content/reference/services/SoftLayer_Provisioning_Hook/getAccount.md index 18f6e8ed6e..e35f1bc7a2 100644 --- a/content/reference/services/SoftLayer_Provisioning_Hook/getAccount.md +++ b/content/reference/services/SoftLayer_Provisioning_Hook/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Provisioning_Hook/getHookType.md b/content/reference/services/SoftLayer_Provisioning_Hook/getHookType.md index 0efc40d002..da649d060b 100644 --- a/content/reference/services/SoftLayer_Provisioning_Hook/getHookType.md +++ b/content/reference/services/SoftLayer_Provisioning_Hook/getHookType.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Provisioning_Hook/getObject.md b/content/reference/services/SoftLayer_Provisioning_Hook/getObject.md index a60e431f3b..d799885b92 100644 --- a/content/reference/services/SoftLayer_Provisioning_Hook/getObject.md +++ b/content/reference/services/SoftLayer_Provisioning_Hook/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Provisioning_Hook](/reference/services/SoftLayer_Provisioning_Hook)::getObject + Retrieve a SoftLayer_Provisioning_Hook record. diff --git a/content/reference/services/SoftLayer_Provisioning_Hook_Type/_index.md b/content/reference/services/SoftLayer_Provisioning_Hook_Type/_index.md index f8ac7ae266..516d8c8f48 100644 --- a/content/reference/services/SoftLayer_Provisioning_Hook_Type/_index.md +++ b/content/reference/services/SoftLayer_Provisioning_Hook_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllHookTypes](/reference/services/SoftLayer_Provisioning_Hook_Type/getAllHookTypes) +
              #### [getObject](/reference/services/SoftLayer_Provisioning_Hook_Type/getObject) Retrieve a SoftLayer_Provisioning_Hook_Type record. +
              diff --git a/content/reference/services/SoftLayer_Provisioning_Hook_Type/getAllHookTypes.md b/content/reference/services/SoftLayer_Provisioning_Hook_Type/getAllHookTypes.md index c8587d8631..50c52ad89f 100644 --- a/content/reference/services/SoftLayer_Provisioning_Hook_Type/getAllHookTypes.md +++ b/content/reference/services/SoftLayer_Provisioning_Hook_Type/getAllHookTypes.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Provisioning_Hook_Type/getObject.md b/content/reference/services/SoftLayer_Provisioning_Hook_Type/getObject.md index 5b1d6d79ca..8c9cd51db5 100644 --- a/content/reference/services/SoftLayer_Provisioning_Hook_Type/getObject.md +++ b/content/reference/services/SoftLayer_Provisioning_Hook_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Provisioning_Hook_Type](/reference/services/SoftLayer_Provisioning_Hook_Type)::getObject + Retrieve a SoftLayer_Provisioning_Hook_Type record. diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/_index.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/_index.md index 85d0afc323..2bd378e0e3 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/_index.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Provisioning_Maintenance_Classification service returns available maintenance classifications. @@ -42,24 +44,28 @@ The SoftLayer_Provisioning_Maintenance_Classification service returns available #### [getItemCategories](/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getItemCategories) +
              #### [getMaintenanceClassification](/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getMaintenanceClassification) Retrieve a maintenance classification. +
              #### [getMaintenanceClassificationsByItemCategory](/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getMaintenanceClassificationsByItemCategory) Retrieve all maintenance classifications. +
              #### [getObject](/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getObject) Retrieve a SoftLayer_Provisioning_Maintenance_Classification record. +
              diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getItemCategories.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getItemCategories.md index 9ffc383a66..6845f4e87e 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getItemCategories.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getItemCategories.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getMaintenanceClassification.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getMaintenanceClassification.md index 3d7e74265a..802b8b8b80 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getMaintenanceClassification.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getMaintenanceClassification.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Provisioning_Maintenance_Classification](/reference/services/SoftLayer_Provisioning_Maintenance_Classification)::getMaintenanceClassification + Retrieve a maintenance classification. diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getMaintenanceClassificationsByItemCategory.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getMaintenanceClassificationsByItemCategory.md index 7c0943a18a..7bb918fb53 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getMaintenanceClassificationsByItemCategory.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getMaintenanceClassificationsByItemCategory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Provisioning_Maintenance_Classification](/reference/services/SoftLayer_Provisioning_Maintenance_Classification)::getMaintenanceClassificationsByItemCategory + Retrieve all maintenance classifications. diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getObject.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getObject.md index b262186bf8..f86b9b8158 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getObject.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Provisioning_Maintenance_Classification](/reference/services/SoftLayer_Provisioning_Maintenance_Classification)::getObject + Retrieve a SoftLayer_Provisioning_Maintenance_Classification record. diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/_index.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/_index.md index e76cb75d5f..97a01ca87e 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/_index.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getMaintenanceClassification](/reference/services/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/getMaintenanceClassification) +
              #### [getObject](/reference/services/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/getObject) Retrieve a SoftLayer_Provisioning_Maintenance_Classification_Item_Category record. +
              diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/getMaintenanceClassification.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/getMaintenanceClassification.md index 0c29f618d3..81cd3c28c0 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/getMaintenanceClassification.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/getMaintenanceClassification.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/getObject.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/getObject.md index 2b53558790..d7649dd924 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/getObject.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Classification_Item_Category/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Provisioning_Maintenance_Classification_Item_Category](/reference/services/SoftLayer_Provisioning_Maintenance_Classification_Item_Category)::getObject + Retrieve a SoftLayer_Provisioning_Maintenance_Classification_Item_Category record. diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Slots/_index.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Slots/_index.md index 3934fc44c8..dc70ac5857 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Slots/_index.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Slots/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Provisioning_Maintenance_Slots service returns available maintenance slots at SoftLayer data centers. @@ -42,6 +44,7 @@ The SoftLayer_Provisioning_Maintenance_Slots service returns available maintenan #### [getObject](/reference/services/SoftLayer_Provisioning_Maintenance_Slots/getObject) Retrieve a SoftLayer_Provisioning_Maintenance_Slots record. + diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Slots/getObject.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Slots/getObject.md index a1a5f9cb3d..55ae2ec098 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Slots/getObject.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Slots/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Provisioning_Maintenance_Slots](/reference/services/SoftLayer_Provisioning_Maintenance_Slots)::getObject + Retrieve a SoftLayer_Provisioning_Maintenance_Slots record. diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/_index.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/_index.md index fae4ba5729..20d51a50e4 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/_index.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,24 +44,28 @@ classes: #### [getAvailableSlots](/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getAvailableSlots) +
              #### [getMaintenanceClass](/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getMaintenanceClass) +
              #### [getObject](/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getObject) Retrieve a SoftLayer_Provisioning_Maintenance_Ticket record. +
              #### [getTicket](/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getTicket) +
              diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getAvailableSlots.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getAvailableSlots.md index eb7dad533c..9b2bd6d632 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getAvailableSlots.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getAvailableSlots.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getMaintenanceClass.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getMaintenanceClass.md index 467340658b..7e5964c353 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getMaintenanceClass.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getMaintenanceClass.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getObject.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getObject.md index bb92ed2f4e..6d7799b13a 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getObject.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Provisioning_Maintenance_Ticket](/reference/services/SoftLayer_Provisioning_Maintenance_Ticket)::getObject + Retrieve a SoftLayer_Provisioning_Maintenance_Ticket record. diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getTicket.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getTicket.md index e9af789d9a..05a82195aa 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getTicket.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Ticket/getTicket.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/_index.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/_index.md index c8f5a62b5c..56830f6f4c 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/_index.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Provisioning_Maintenance_Window service returns available maintenance windows at SoftLayer data centers. @@ -42,48 +44,56 @@ The SoftLayer_Provisioning_Maintenance_Window service returns available maintena #### [addCustomerUpgradeWindow](/reference/services/SoftLayer_Provisioning_Maintenance_Window/addCustomerUpgradeWindow) Updates or creates records in the +
              #### [getMaintenanceClassifications](/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceClassifications) Returns the maintenance classifications +
              #### [getMaintenanceStartEndTime](/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceStartEndTime) Returns a specific maintenance window +
              #### [getMaintenanceWindowForTicket](/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindowForTicket) Returns a specific maintenance window +
              #### [getMaintenanceWindowTicketsByTicketId](/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindowTicketsByTicketId) Returns maintenance window ticket +
              #### [getMaintenanceWindows](/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindows) Returns available maintenance windows +
              #### [getMaintenceWindows](/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenceWindows) Returns available maintenance windows +
              #### [updateCustomerUpgradeWindow](/reference/services/SoftLayer_Provisioning_Maintenance_Window/updateCustomerUpgradeWindow) Creates records in the appropriate +
              diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/addCustomerUpgradeWindow.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/addCustomerUpgradeWindow.md index bff82ca584..f4461f1162 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/addCustomerUpgradeWindow.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/addCustomerUpgradeWindow.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Provisioning_Maintenance_Window](/reference/services/SoftLayer_Provisioning_Maintenance_Window)::addCustomerUpgradeWindow + Updates or creates records in the diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceClassifications.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceClassifications.md index d3e4e0dda2..caf185d82b 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceClassifications.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceClassifications.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Provisioning_Maintenance_Window](/reference/services/SoftLayer_Provisioning_Maintenance_Window)::getMaintenanceClassifications + Returns the maintenance classifications diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceStartEndTime.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceStartEndTime.md index 258754fb57..ee90162e8a 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceStartEndTime.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceStartEndTime.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Provisioning_Maintenance_Window](/reference/services/SoftLayer_Provisioning_Maintenance_Window)::getMaintenanceStartEndTime + Returns a specific maintenance window diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindowForTicket.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindowForTicket.md index bccb09109e..faf36bfbff 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindowForTicket.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindowForTicket.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Provisioning_Maintenance_Window](/reference/services/SoftLayer_Provisioning_Maintenance_Window)::getMaintenanceWindowForTicket + Returns a specific maintenance window diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindowTicketsByTicketId.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindowTicketsByTicketId.md index 583d781da2..0f7a539809 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindowTicketsByTicketId.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindowTicketsByTicketId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Provisioning_Maintenance_Window](/reference/services/SoftLayer_Provisioning_Maintenance_Window)::getMaintenanceWindowTicketsByTicketId + Returns maintenance window ticket diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindows.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindows.md index 3533cafdf4..a8111e7bc1 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindows.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenanceWindows.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Provisioning_Maintenance_Window](/reference/services/SoftLayer_Provisioning_Maintenance_Window)::getMaintenanceWindows + Returns available maintenance windows diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenceWindows.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenceWindows.md index df586c49d4..b1d9a14d62 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenceWindows.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/getMaintenceWindows.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Provisioning_Maintenance_Window](/reference/services/SoftLayer_Provisioning_Maintenance_Window)::getMaintenceWindows + Returns available maintenance windows diff --git a/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/updateCustomerUpgradeWindow.md b/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/updateCustomerUpgradeWindow.md index 528bc8fbf9..030b6f1d27 100644 --- a/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/updateCustomerUpgradeWindow.md +++ b/content/reference/services/SoftLayer_Provisioning_Maintenance_Window/updateCustomerUpgradeWindow.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Provisioning_Maintenance_Window](/reference/services/SoftLayer_Provisioning_Maintenance_Window)::updateCustomerUpgradeWindow + Creates records in the appropriate diff --git a/content/reference/services/SoftLayer_Provisioning_Version1_Transaction_Group/_index.md b/content/reference/services/SoftLayer_Provisioning_Version1_Transaction_Group/_index.md index 721fef5b52..999cfd5e59 100644 --- a/content/reference/services/SoftLayer_Provisioning_Version1_Transaction_Group/_index.md +++ b/content/reference/services/SoftLayer_Provisioning_Version1_Transaction_Group/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The service lists the different types of transactions. This includes operating system reloads and new operating system provisions. @@ -42,12 +44,14 @@ The service lists the different types of transactions. This includes operating s #### [getAllObjects](/reference/services/SoftLayer_Provisioning_Version1_Transaction_Group/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_Provisioning_Version1_Transaction_Group/getObject) Retrieve a SoftLayer_Provisioning_Version1_Transaction_Group record. +
              diff --git a/content/reference/services/SoftLayer_Provisioning_Version1_Transaction_Group/getAllObjects.md b/content/reference/services/SoftLayer_Provisioning_Version1_Transaction_Group/getAllObjects.md index 3cc9d492e5..013b61126e 100644 --- a/content/reference/services/SoftLayer_Provisioning_Version1_Transaction_Group/getAllObjects.md +++ b/content/reference/services/SoftLayer_Provisioning_Version1_Transaction_Group/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Provisioning_Version1_Transaction_Group/getObject.md b/content/reference/services/SoftLayer_Provisioning_Version1_Transaction_Group/getObject.md index 39a97cea74..d6b3663af8 100644 --- a/content/reference/services/SoftLayer_Provisioning_Version1_Transaction_Group/getObject.md +++ b/content/reference/services/SoftLayer_Provisioning_Version1_Transaction_Group/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Provisioning_Version1_Transaction_Group](/reference/services/SoftLayer_Provisioning_Version1_Transaction_Group)::getObject + Retrieve a SoftLayer_Provisioning_Version1_Transaction_Group record. diff --git a/content/reference/services/SoftLayer_Resource_Configuration/_index.md b/content/reference/services/SoftLayer_Resource_Configuration/_index.md index 8dde450843..24ee4daeb7 100644 --- a/content/reference/services/SoftLayer_Resource_Configuration/_index.md +++ b/content/reference/services/SoftLayer_Resource_Configuration/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,6 +44,7 @@ The Resource Configuration service enables the user to update data regarding a r #### [setOsPasswordFromEncrypted](/reference/services/SoftLayer_Resource_Configuration/setOsPasswordFromEncrypted) Set resource operating system password from an encrypted password + diff --git a/content/reference/services/SoftLayer_Resource_Configuration/setOsPasswordFromEncrypted.md b/content/reference/services/SoftLayer_Resource_Configuration/setOsPasswordFromEncrypted.md index e9b59b7932..34c9c9c260 100644 --- a/content/reference/services/SoftLayer_Resource_Configuration/setOsPasswordFromEncrypted.md +++ b/content/reference/services/SoftLayer_Resource_Configuration/setOsPasswordFromEncrypted.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Configuration](/reference/services/SoftLayer_Resource_Configuration)::setOsPasswordFromEncrypted + Set resource operating system password from an encrypted password diff --git a/content/reference/services/SoftLayer_Resource_Group/_index.md b/content/reference/services/SoftLayer_Resource_Group/_index.md index 29ce7d94c7..cc76068e60 100644 --- a/content/reference/services/SoftLayer_Resource_Group/_index.md +++ b/content/reference/services/SoftLayer_Resource_Group/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer's resource group service allows users to access a broad overview of the resource group and its members @@ -42,60 +44,70 @@ SoftLayer's resource group service allows users to access a broad overview of th #### [editObject](/reference/services/SoftLayer_Resource_Group/editObject) +
              #### [getAncestorGroups](/reference/services/SoftLayer_Resource_Group/getAncestorGroups) Retrieve a resource group's associated group ancestors. +
              #### [getAttributes](/reference/services/SoftLayer_Resource_Group/getAttributes) Retrieve a resource group's associated attributes. +
              #### [getHardwareMembers](/reference/services/SoftLayer_Resource_Group/getHardwareMembers) Retrieve a resource group's associated hardware members. +
              #### [getMembers](/reference/services/SoftLayer_Resource_Group/getMembers) Retrieve a resource group's associated members. +
              #### [getObject](/reference/services/SoftLayer_Resource_Group/getObject) Retrieve a SoftLayer_Resource_Group record. +
              #### [getRootResourceGroup](/reference/services/SoftLayer_Resource_Group/getRootResourceGroup) Retrieve a resource group's associated root resource group. +
              #### [getSubnetMembers](/reference/services/SoftLayer_Resource_Group/getSubnetMembers) Retrieve a resource group's associated subnet members. +
              #### [getTemplate](/reference/services/SoftLayer_Resource_Group/getTemplate) Retrieve a resource group's associated template. +
              #### [getVlanMembers](/reference/services/SoftLayer_Resource_Group/getVlanMembers) Retrieve a resource group's associated VLAN members. +
              diff --git a/content/reference/services/SoftLayer_Resource_Group/editObject.md b/content/reference/services/SoftLayer_Resource_Group/editObject.md index b3568316af..209667b8dd 100644 --- a/content/reference/services/SoftLayer_Resource_Group/editObject.md +++ b/content/reference/services/SoftLayer_Resource_Group/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Resource_Group/getAncestorGroups.md b/content/reference/services/SoftLayer_Resource_Group/getAncestorGroups.md index c397967bad..09f6539589 100644 --- a/content/reference/services/SoftLayer_Resource_Group/getAncestorGroups.md +++ b/content/reference/services/SoftLayer_Resource_Group/getAncestorGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Group](/reference/services/SoftLayer_Resource_Group)::getAncestorGroups + Retrieve a resource group's associated group ancestors. diff --git a/content/reference/services/SoftLayer_Resource_Group/getAttributes.md b/content/reference/services/SoftLayer_Resource_Group/getAttributes.md index 1c89cb141a..a3bf1daa3a 100644 --- a/content/reference/services/SoftLayer_Resource_Group/getAttributes.md +++ b/content/reference/services/SoftLayer_Resource_Group/getAttributes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Group](/reference/services/SoftLayer_Resource_Group)::getAttributes + Retrieve a resource group's associated attributes. diff --git a/content/reference/services/SoftLayer_Resource_Group/getHardwareMembers.md b/content/reference/services/SoftLayer_Resource_Group/getHardwareMembers.md index ffec78c0b1..b13e494285 100644 --- a/content/reference/services/SoftLayer_Resource_Group/getHardwareMembers.md +++ b/content/reference/services/SoftLayer_Resource_Group/getHardwareMembers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Group](/reference/services/SoftLayer_Resource_Group)::getHardwareMembers + Retrieve a resource group's associated hardware members. diff --git a/content/reference/services/SoftLayer_Resource_Group/getMembers.md b/content/reference/services/SoftLayer_Resource_Group/getMembers.md index f5b44045e3..0ee70206cf 100644 --- a/content/reference/services/SoftLayer_Resource_Group/getMembers.md +++ b/content/reference/services/SoftLayer_Resource_Group/getMembers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Group](/reference/services/SoftLayer_Resource_Group)::getMembers + Retrieve a resource group's associated members. diff --git a/content/reference/services/SoftLayer_Resource_Group/getObject.md b/content/reference/services/SoftLayer_Resource_Group/getObject.md index d5f6301198..40ace84a1f 100644 --- a/content/reference/services/SoftLayer_Resource_Group/getObject.md +++ b/content/reference/services/SoftLayer_Resource_Group/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Group](/reference/services/SoftLayer_Resource_Group)::getObject + Retrieve a SoftLayer_Resource_Group record. diff --git a/content/reference/services/SoftLayer_Resource_Group/getRootResourceGroup.md b/content/reference/services/SoftLayer_Resource_Group/getRootResourceGroup.md index a8a745f676..ddabb62eaa 100644 --- a/content/reference/services/SoftLayer_Resource_Group/getRootResourceGroup.md +++ b/content/reference/services/SoftLayer_Resource_Group/getRootResourceGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Group](/reference/services/SoftLayer_Resource_Group)::getRootResourceGroup + Retrieve a resource group's associated root resource group. diff --git a/content/reference/services/SoftLayer_Resource_Group/getSubnetMembers.md b/content/reference/services/SoftLayer_Resource_Group/getSubnetMembers.md index 9e86873e85..d225a45a1e 100644 --- a/content/reference/services/SoftLayer_Resource_Group/getSubnetMembers.md +++ b/content/reference/services/SoftLayer_Resource_Group/getSubnetMembers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Group](/reference/services/SoftLayer_Resource_Group)::getSubnetMembers + Retrieve a resource group's associated subnet members. diff --git a/content/reference/services/SoftLayer_Resource_Group/getTemplate.md b/content/reference/services/SoftLayer_Resource_Group/getTemplate.md index b44bf7f938..2af0fe0638 100644 --- a/content/reference/services/SoftLayer_Resource_Group/getTemplate.md +++ b/content/reference/services/SoftLayer_Resource_Group/getTemplate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Group](/reference/services/SoftLayer_Resource_Group)::getTemplate + Retrieve a resource group's associated template. diff --git a/content/reference/services/SoftLayer_Resource_Group/getVlanMembers.md b/content/reference/services/SoftLayer_Resource_Group/getVlanMembers.md index 66f233fea2..f2996f6ecb 100644 --- a/content/reference/services/SoftLayer_Resource_Group/getVlanMembers.md +++ b/content/reference/services/SoftLayer_Resource_Group/getVlanMembers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Group](/reference/services/SoftLayer_Resource_Group)::getVlanMembers + Retrieve a resource group's associated VLAN members. diff --git a/content/reference/services/SoftLayer_Resource_Group_Template/_index.md b/content/reference/services/SoftLayer_Resource_Group_Template/_index.md index 3cf100b195..37c42a53f9 100644 --- a/content/reference/services/SoftLayer_Resource_Group_Template/_index.md +++ b/content/reference/services/SoftLayer_Resource_Group_Template/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,30 +44,35 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Resource_Group_Template/getAllObjects) +
              #### [getChildren](/reference/services/SoftLayer_Resource_Group_Template/getChildren) +
              #### [getMembers](/reference/services/SoftLayer_Resource_Group_Template/getMembers) +
              #### [getObject](/reference/services/SoftLayer_Resource_Group_Template/getObject) Retrieve a SoftLayer_Resource_Group_Template record. +
              #### [getPackage](/reference/services/SoftLayer_Resource_Group_Template/getPackage) +
              diff --git a/content/reference/services/SoftLayer_Resource_Group_Template/getAllObjects.md b/content/reference/services/SoftLayer_Resource_Group_Template/getAllObjects.md index c0bcb77f89..11612bf712 100644 --- a/content/reference/services/SoftLayer_Resource_Group_Template/getAllObjects.md +++ b/content/reference/services/SoftLayer_Resource_Group_Template/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Resource_Group_Template/getChildren.md b/content/reference/services/SoftLayer_Resource_Group_Template/getChildren.md index bae562f49e..fc8625ddd1 100644 --- a/content/reference/services/SoftLayer_Resource_Group_Template/getChildren.md +++ b/content/reference/services/SoftLayer_Resource_Group_Template/getChildren.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Resource_Group_Template/getMembers.md b/content/reference/services/SoftLayer_Resource_Group_Template/getMembers.md index c11f104587..19dc8d58e6 100644 --- a/content/reference/services/SoftLayer_Resource_Group_Template/getMembers.md +++ b/content/reference/services/SoftLayer_Resource_Group_Template/getMembers.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Resource_Group_Template/getObject.md b/content/reference/services/SoftLayer_Resource_Group_Template/getObject.md index 2d84b79f11..347f988b4e 100644 --- a/content/reference/services/SoftLayer_Resource_Group_Template/getObject.md +++ b/content/reference/services/SoftLayer_Resource_Group_Template/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Group_Template](/reference/services/SoftLayer_Resource_Group_Template)::getObject + Retrieve a SoftLayer_Resource_Group_Template record. diff --git a/content/reference/services/SoftLayer_Resource_Group_Template/getPackage.md b/content/reference/services/SoftLayer_Resource_Group_Template/getPackage.md index 4d599b5d6f..ffd86d7c15 100644 --- a/content/reference/services/SoftLayer_Resource_Group_Template/getPackage.md +++ b/content/reference/services/SoftLayer_Resource_Group_Template/getPackage.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Resource_Metadata/_index.md b/content/reference/services/SoftLayer_Resource_Metadata/_index.md index f9fd065b74..588e1b8491 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/_index.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -44,120 +46,140 @@ The primary use of this service is to allow self-discovery for newly provisioned #### [getAccountId](/reference/services/SoftLayer_Resource_Metadata/getAccountId) The id for the account which the resource is in +
              #### [getBackendMacAddresses](/reference/services/SoftLayer_Resource_Metadata/getBackendMacAddresses) A list of backend MAC addresses +
              #### [getDatacenter](/reference/services/SoftLayer_Resource_Metadata/getDatacenter) The name for the datacenter which the resource is in +
              #### [getDatacenterId](/reference/services/SoftLayer_Resource_Metadata/getDatacenterId) The id for the datacenter which the resource is in +
              #### [getDomain](/reference/services/SoftLayer_Resource_Metadata/getDomain) A resource's domain +
              #### [getFrontendMacAddresses](/reference/services/SoftLayer_Resource_Metadata/getFrontendMacAddresses) A list of frontend MAC addresses +
              #### [getFullyQualifiedDomainName](/reference/services/SoftLayer_Resource_Metadata/getFullyQualifiedDomainName) A resource's fully qualified domain name +
              #### [getGlobalIdentifier](/reference/services/SoftLayer_Resource_Metadata/getGlobalIdentifier) A resource's globalIdentifier +
              #### [getHostname](/reference/services/SoftLayer_Resource_Metadata/getHostname) A resource's hostname +
              #### [getId](/reference/services/SoftLayer_Resource_Metadata/getId) A resource's id +
              #### [getPrimaryBackendIpAddress](/reference/services/SoftLayer_Resource_Metadata/getPrimaryBackendIpAddress) The primary backend IP address for the resource +
              #### [getPrimaryIpAddress](/reference/services/SoftLayer_Resource_Metadata/getPrimaryIpAddress) The primary IP address for the resource +
              #### [getProvisionState](/reference/services/SoftLayer_Resource_Metadata/getProvisionState) Obtain the provision state for a resource +
              #### [getRouter](/reference/services/SoftLayer_Resource_Metadata/getRouter) The router associated with a network component +
              #### [getServiceResource](/reference/services/SoftLayer_Resource_Metadata/getServiceResource) Obtain a specific service resource associated with the resource +
              #### [getServiceResources](/reference/services/SoftLayer_Resource_Metadata/getServiceResources) Obtain service resources associated with the resource +
              #### [getTags](/reference/services/SoftLayer_Resource_Metadata/getTags) Obtain tags associated with the resource +
              #### [getUserMetadata](/reference/services/SoftLayer_Resource_Metadata/getUserMetadata) Obtain user data associated with the resource +
              #### [getVlanIds](/reference/services/SoftLayer_Resource_Metadata/getVlanIds) A list of VLAN ids for a network component +
              #### [getVlans](/reference/services/SoftLayer_Resource_Metadata/getVlans) A list of VLAN numbers for a network component +
              diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getAccountId.md b/content/reference/services/SoftLayer_Resource_Metadata/getAccountId.md index ee22bb79e9..ea5e5be4f6 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getAccountId.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getAccountId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getAccountId + The id for the account which the resource is in diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getBackendMacAddresses.md b/content/reference/services/SoftLayer_Resource_Metadata/getBackendMacAddresses.md index c5a55263a9..9e99da262e 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getBackendMacAddresses.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getBackendMacAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getBackendMacAddresses + A list of backend MAC addresses diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getDatacenter.md b/content/reference/services/SoftLayer_Resource_Metadata/getDatacenter.md index 43f8437ecf..ea60dcb809 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getDatacenter.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getDatacenter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getDatacenter + The name for the datacenter which the resource is in diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getDatacenterId.md b/content/reference/services/SoftLayer_Resource_Metadata/getDatacenterId.md index 5a03080f9f..2227877326 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getDatacenterId.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getDatacenterId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getDatacenterId + The id for the datacenter which the resource is in diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getDomain.md b/content/reference/services/SoftLayer_Resource_Metadata/getDomain.md index 6f0834e657..d6bbd30a77 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getDomain.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getDomain.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getDomain + A resource's domain diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getFrontendMacAddresses.md b/content/reference/services/SoftLayer_Resource_Metadata/getFrontendMacAddresses.md index 55020ba599..6ae2ebe298 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getFrontendMacAddresses.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getFrontendMacAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getFrontendMacAddresses + A list of frontend MAC addresses diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getFullyQualifiedDomainName.md b/content/reference/services/SoftLayer_Resource_Metadata/getFullyQualifiedDomainName.md index 5e4c3cfc95..067217bcbd 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getFullyQualifiedDomainName.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getFullyQualifiedDomainName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getFullyQualifiedDomainName + A resource's fully qualified domain name diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getGlobalIdentifier.md b/content/reference/services/SoftLayer_Resource_Metadata/getGlobalIdentifier.md index 080cb98dbb..77edac6f25 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getGlobalIdentifier.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getGlobalIdentifier.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getGlobalIdentifier + A resource's globalIdentifier diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getHostname.md b/content/reference/services/SoftLayer_Resource_Metadata/getHostname.md index aa82f20c42..d1570216f0 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getHostname.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getHostname.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getHostname + A resource's hostname diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getId.md b/content/reference/services/SoftLayer_Resource_Metadata/getId.md index 710ef477a2..d5969a0571 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getId.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getId + A resource's id diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getPrimaryBackendIpAddress.md b/content/reference/services/SoftLayer_Resource_Metadata/getPrimaryBackendIpAddress.md index 062d9d4922..243f82790b 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getPrimaryBackendIpAddress.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getPrimaryBackendIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getPrimaryBackendIpAddress + The primary backend IP address for the resource diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getPrimaryIpAddress.md b/content/reference/services/SoftLayer_Resource_Metadata/getPrimaryIpAddress.md index 98ea6a45b2..e2e6dcb6e4 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getPrimaryIpAddress.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getPrimaryIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getPrimaryIpAddress + The primary IP address for the resource diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getProvisionState.md b/content/reference/services/SoftLayer_Resource_Metadata/getProvisionState.md index cfaeeb2925..28819fda55 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getProvisionState.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getProvisionState.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getProvisionState + Obtain the provision state for a resource diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getRouter.md b/content/reference/services/SoftLayer_Resource_Metadata/getRouter.md index 78829a11a9..af9f13a517 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getRouter.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getRouter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getRouter + The router associated with a network component diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getServiceResource.md b/content/reference/services/SoftLayer_Resource_Metadata/getServiceResource.md index 608b659871..0af63db81b 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getServiceResource.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getServiceResource.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getServiceResource + Obtain a specific service resource associated with the resource diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getServiceResources.md b/content/reference/services/SoftLayer_Resource_Metadata/getServiceResources.md index 67e601ea35..1d875e3430 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getServiceResources.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getServiceResources.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getServiceResources + Obtain service resources associated with the resource diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getTags.md b/content/reference/services/SoftLayer_Resource_Metadata/getTags.md index fee04a9048..f89194bd7d 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getTags.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getTags.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getTags + Obtain tags associated with the resource diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getUserMetadata.md b/content/reference/services/SoftLayer_Resource_Metadata/getUserMetadata.md index b27b7d94e5..d0d49dfafd 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getUserMetadata.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getUserMetadata.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getUserMetadata + Obtain user data associated with the resource diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getVlanIds.md b/content/reference/services/SoftLayer_Resource_Metadata/getVlanIds.md index 37013266dc..bdd0374b00 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getVlanIds.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getVlanIds.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getVlanIds + A list of VLAN ids for a network component diff --git a/content/reference/services/SoftLayer_Resource_Metadata/getVlans.md b/content/reference/services/SoftLayer_Resource_Metadata/getVlans.md index b243f5d1f8..b603a56744 100644 --- a/content/reference/services/SoftLayer_Resource_Metadata/getVlans.md +++ b/content/reference/services/SoftLayer_Resource_Metadata/getVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Resource_Metadata](/reference/services/SoftLayer_Resource_Metadata)::getVlans + A list of VLAN numbers for a network component diff --git a/content/reference/services/SoftLayer_Sales_Presale_Event/_index.md b/content/reference/services/SoftLayer_Sales_Presale_Event/_index.md index aec9a0dcd9..e26fe53906 100644 --- a/content/reference/services/SoftLayer_Sales_Presale_Event/_index.md +++ b/content/reference/services/SoftLayer_Sales_Presale_Event/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -44,42 +46,49 @@ This server allows customer to view the currently-active presale events and thei #### [getActiveFlag](/reference/services/SoftLayer_Sales_Presale_Event/getActiveFlag) Retrieve a flag to indicate that the presale event is currently active. A presale event is active if the current time is between the start and end dates. +
              #### [getAllObjects](/reference/services/SoftLayer_Sales_Presale_Event/getAllObjects) +
              #### [getExpiredFlag](/reference/services/SoftLayer_Sales_Presale_Event/getExpiredFlag) Retrieve a flag to indicate that the presale event is expired. A presale event is expired if the current time is after the end date. +
              #### [getItem](/reference/services/SoftLayer_Sales_Presale_Event/getItem) Retrieve the [SoftLayer_Product_Item]({{}}) associated with the presale event. +
              #### [getLocation](/reference/services/SoftLayer_Sales_Presale_Event/getLocation) Retrieve the [SoftLayer_Location]({{}}) associated with the presale event. +
              #### [getObject](/reference/services/SoftLayer_Sales_Presale_Event/getObject) Retrieve a SoftLayer_Sales_Presale_Event record. +
              #### [getOrders](/reference/services/SoftLayer_Sales_Presale_Event/getOrders) Retrieve the orders ([SoftLayer_Billing_Order]({{}})) associated with this presale event that were created for the customer's account. +
              diff --git a/content/reference/services/SoftLayer_Sales_Presale_Event/getActiveFlag.md b/content/reference/services/SoftLayer_Sales_Presale_Event/getActiveFlag.md index ec92e1f7ef..2cc4e7b1dd 100644 --- a/content/reference/services/SoftLayer_Sales_Presale_Event/getActiveFlag.md +++ b/content/reference/services/SoftLayer_Sales_Presale_Event/getActiveFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Sales_Presale_Event](/reference/services/SoftLayer_Sales_Presale_Event)::getActiveFlag + Retrieve a flag to indicate that the presale event is currently active. A presale event is active if the current time is between the start and end dates. diff --git a/content/reference/services/SoftLayer_Sales_Presale_Event/getAllObjects.md b/content/reference/services/SoftLayer_Sales_Presale_Event/getAllObjects.md index ca2629b7f0..feb11fefe8 100644 --- a/content/reference/services/SoftLayer_Sales_Presale_Event/getAllObjects.md +++ b/content/reference/services/SoftLayer_Sales_Presale_Event/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Sales_Presale_Event/getExpiredFlag.md b/content/reference/services/SoftLayer_Sales_Presale_Event/getExpiredFlag.md index 9897ec46fb..e882cab061 100644 --- a/content/reference/services/SoftLayer_Sales_Presale_Event/getExpiredFlag.md +++ b/content/reference/services/SoftLayer_Sales_Presale_Event/getExpiredFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Sales_Presale_Event](/reference/services/SoftLayer_Sales_Presale_Event)::getExpiredFlag + Retrieve a flag to indicate that the presale event is expired. A presale event is expired if the current time is after the end date. diff --git a/content/reference/services/SoftLayer_Sales_Presale_Event/getItem.md b/content/reference/services/SoftLayer_Sales_Presale_Event/getItem.md index 893ce00567..15eec926d3 100644 --- a/content/reference/services/SoftLayer_Sales_Presale_Event/getItem.md +++ b/content/reference/services/SoftLayer_Sales_Presale_Event/getItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Sales_Presale_Event](/reference/services/SoftLayer_Sales_Presale_Event)::getItem + Retrieve the [SoftLayer_Product_Item]({{}}) associated with the presale event. diff --git a/content/reference/services/SoftLayer_Sales_Presale_Event/getLocation.md b/content/reference/services/SoftLayer_Sales_Presale_Event/getLocation.md index 46f501253d..b4c41a5386 100644 --- a/content/reference/services/SoftLayer_Sales_Presale_Event/getLocation.md +++ b/content/reference/services/SoftLayer_Sales_Presale_Event/getLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Sales_Presale_Event](/reference/services/SoftLayer_Sales_Presale_Event)::getLocation + Retrieve the [SoftLayer_Location]({{}}) associated with the presale event. diff --git a/content/reference/services/SoftLayer_Sales_Presale_Event/getObject.md b/content/reference/services/SoftLayer_Sales_Presale_Event/getObject.md index 3a2ab64baf..1edae9726a 100644 --- a/content/reference/services/SoftLayer_Sales_Presale_Event/getObject.md +++ b/content/reference/services/SoftLayer_Sales_Presale_Event/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Sales_Presale_Event](/reference/services/SoftLayer_Sales_Presale_Event)::getObject + Retrieve a SoftLayer_Sales_Presale_Event record. diff --git a/content/reference/services/SoftLayer_Sales_Presale_Event/getOrders.md b/content/reference/services/SoftLayer_Sales_Presale_Event/getOrders.md index 4b04ff6ec2..75f10eb2c2 100644 --- a/content/reference/services/SoftLayer_Sales_Presale_Event/getOrders.md +++ b/content/reference/services/SoftLayer_Sales_Presale_Event/getOrders.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Sales_Presale_Event](/reference/services/SoftLayer_Sales_Presale_Event)::getOrders + Retrieve the orders ([SoftLayer_Billing_Order]({{}})) associated with this presale event that were created for the customer's account. diff --git a/content/reference/services/SoftLayer_Scale_Asset/_index.md b/content/reference/services/SoftLayer_Scale_Asset/_index.md index a0282abac5..9f746b4c11 100644 --- a/content/reference/services/SoftLayer_Scale_Asset/_index.md +++ b/content/reference/services/SoftLayer_Scale_Asset/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The base asset of a scale group. Assets are fixed, non-volatile units of a scale group. They are pinned to the group and will not be automatically added or removed. Their primary purpose is to provide information for the policies to use to determine when to scale members. @@ -42,18 +44,21 @@ The base asset of a scale group. Assets are fixed, non-volatile units of a scale #### [deleteObject](/reference/services/SoftLayer_Scale_Asset/deleteObject) Delete this group asset. +
              #### [getObject](/reference/services/SoftLayer_Scale_Asset/getObject) Retrieve a SoftLayer_Scale_Asset record. +
              #### [getScaleGroup](/reference/services/SoftLayer_Scale_Asset/getScaleGroup) Retrieve the group this asset belongs to. +
              diff --git a/content/reference/services/SoftLayer_Scale_Asset/deleteObject.md b/content/reference/services/SoftLayer_Scale_Asset/deleteObject.md index 9127798cba..cc553383cf 100644 --- a/content/reference/services/SoftLayer_Scale_Asset/deleteObject.md +++ b/content/reference/services/SoftLayer_Scale_Asset/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Asset](/reference/services/SoftLayer_Scale_Asset)::deleteObject + Delete this group asset. diff --git a/content/reference/services/SoftLayer_Scale_Asset/getObject.md b/content/reference/services/SoftLayer_Scale_Asset/getObject.md index 4533cd6af0..d6954dcd0b 100644 --- a/content/reference/services/SoftLayer_Scale_Asset/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Asset/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Asset](/reference/services/SoftLayer_Scale_Asset)::getObject + Retrieve a SoftLayer_Scale_Asset record. diff --git a/content/reference/services/SoftLayer_Scale_Asset/getScaleGroup.md b/content/reference/services/SoftLayer_Scale_Asset/getScaleGroup.md index d3a23c63a7..d48845567c 100644 --- a/content/reference/services/SoftLayer_Scale_Asset/getScaleGroup.md +++ b/content/reference/services/SoftLayer_Scale_Asset/getScaleGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Asset](/reference/services/SoftLayer_Scale_Asset)::getScaleGroup + Retrieve the group this asset belongs to. diff --git a/content/reference/services/SoftLayer_Scale_Asset_Hardware/_index.md b/content/reference/services/SoftLayer_Scale_Asset_Hardware/_index.md index 50388d0e0c..51de098876 100644 --- a/content/reference/services/SoftLayer_Scale_Asset_Hardware/_index.md +++ b/content/reference/services/SoftLayer_Scale_Asset_Hardware/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A hardware asset is a fixed asset of scale group. It is not automatically scaled up or down in any way. Its purpose is to provide information (e.g. metrics) to policies to affect scaling decisions. Currently hardware assets are unsupported. @@ -42,36 +44,42 @@ A hardware asset is a fixed asset of scale group. It is not automatically scaled #### [createObject](/reference/services/SoftLayer_Scale_Asset_Hardware/createObject) Pin hardware on a group. This can be done at anytime, whether the group is active or not. +
              #### [deleteObject](/reference/services/SoftLayer_Scale_Asset_Hardware/deleteObject) Delete this group asset. +
              #### [getHardware](/reference/services/SoftLayer_Scale_Asset_Hardware/getHardware) Retrieve the hardware for this asset. +
              #### [getHardwareId](/reference/services/SoftLayer_Scale_Asset_Hardware/getHardwareId) Retrieve the identifier of the hardware for this asset. +
              #### [getObject](/reference/services/SoftLayer_Scale_Asset_Hardware/getObject) Retrieve a SoftLayer_Scale_Asset_Hardware record. +
              #### [getScaleGroup](/reference/services/SoftLayer_Scale_Asset_Hardware/getScaleGroup) Retrieve the group this asset belongs to. +
              diff --git a/content/reference/services/SoftLayer_Scale_Asset_Hardware/createObject.md b/content/reference/services/SoftLayer_Scale_Asset_Hardware/createObject.md index 7f943067dd..f51b388112 100644 --- a/content/reference/services/SoftLayer_Scale_Asset_Hardware/createObject.md +++ b/content/reference/services/SoftLayer_Scale_Asset_Hardware/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Asset_Hardware](/reference/services/SoftLayer_Scale_Asset_Hardware)::createObject + Pin hardware on a group. This can be done at anytime, whether the group is active or not. diff --git a/content/reference/services/SoftLayer_Scale_Asset_Hardware/deleteObject.md b/content/reference/services/SoftLayer_Scale_Asset_Hardware/deleteObject.md index c3d0abe980..78e3bcfb8e 100644 --- a/content/reference/services/SoftLayer_Scale_Asset_Hardware/deleteObject.md +++ b/content/reference/services/SoftLayer_Scale_Asset_Hardware/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Asset_Hardware](/reference/services/SoftLayer_Scale_Asset_Hardware)::deleteObject + Delete this group asset. diff --git a/content/reference/services/SoftLayer_Scale_Asset_Hardware/getHardware.md b/content/reference/services/SoftLayer_Scale_Asset_Hardware/getHardware.md index 64c645dce9..0b68bccd85 100644 --- a/content/reference/services/SoftLayer_Scale_Asset_Hardware/getHardware.md +++ b/content/reference/services/SoftLayer_Scale_Asset_Hardware/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Asset_Hardware](/reference/services/SoftLayer_Scale_Asset_Hardware)::getHardware + Retrieve the hardware for this asset. diff --git a/content/reference/services/SoftLayer_Scale_Asset_Hardware/getHardwareId.md b/content/reference/services/SoftLayer_Scale_Asset_Hardware/getHardwareId.md index 7065f4f040..a9fc212151 100644 --- a/content/reference/services/SoftLayer_Scale_Asset_Hardware/getHardwareId.md +++ b/content/reference/services/SoftLayer_Scale_Asset_Hardware/getHardwareId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Asset_Hardware](/reference/services/SoftLayer_Scale_Asset_Hardware)::getHardwareId + Retrieve the identifier of the hardware for this asset. diff --git a/content/reference/services/SoftLayer_Scale_Asset_Hardware/getObject.md b/content/reference/services/SoftLayer_Scale_Asset_Hardware/getObject.md index be6d3353d3..ff04b8a612 100644 --- a/content/reference/services/SoftLayer_Scale_Asset_Hardware/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Asset_Hardware/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Asset_Hardware](/reference/services/SoftLayer_Scale_Asset_Hardware)::getObject + Retrieve a SoftLayer_Scale_Asset_Hardware record. diff --git a/content/reference/services/SoftLayer_Scale_Asset_Hardware/getScaleGroup.md b/content/reference/services/SoftLayer_Scale_Asset_Hardware/getScaleGroup.md index b1fb6f45ae..9d071b4162 100644 --- a/content/reference/services/SoftLayer_Scale_Asset_Hardware/getScaleGroup.md +++ b/content/reference/services/SoftLayer_Scale_Asset_Hardware/getScaleGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Asset_Hardware](/reference/services/SoftLayer_Scale_Asset_Hardware)::getScaleGroup + Retrieve the group this asset belongs to. diff --git a/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/_index.md b/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/_index.md index b21e030a3d..5dbc37da69 100644 --- a/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/_index.md +++ b/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A guest asset is a fixed asset of scale group. It is not automatically scaled up or down in any way. Its purpose is to provide information (e.g. metrics) to policies to affect scaling decisions. @@ -42,36 +44,42 @@ A guest asset is a fixed asset of scale group. It is not automatically scaled up #### [createObject](/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/createObject) Pin a guest on a group. This can be done at anytime, whether the group is active or not. +
              #### [deleteObject](/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/deleteObject) Delete this group asset. +
              #### [getObject](/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getObject) Retrieve a SoftLayer_Scale_Asset_Virtual_Guest record. +
              #### [getScaleGroup](/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getScaleGroup) Retrieve the group this asset belongs to. +
              #### [getVirtualGuest](/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getVirtualGuest) Retrieve the guest for this asset. +
              #### [getVirtualGuestId](/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getVirtualGuestId) Retrieve the identifier of the guest for this asset. +
              diff --git a/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/createObject.md b/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/createObject.md index c0530f165e..56ada982bd 100644 --- a/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/createObject.md +++ b/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Asset_Virtual_Guest](/reference/services/SoftLayer_Scale_Asset_Virtual_Guest)::createObject + Pin a guest on a group. This can be done at anytime, whether the group is active or not. diff --git a/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/deleteObject.md b/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/deleteObject.md index 8237695a83..395a4dc77b 100644 --- a/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/deleteObject.md +++ b/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Asset_Virtual_Guest](/reference/services/SoftLayer_Scale_Asset_Virtual_Guest)::deleteObject + Delete this group asset. diff --git a/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getObject.md b/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getObject.md index 33856892f2..83bff21e5b 100644 --- a/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Asset_Virtual_Guest](/reference/services/SoftLayer_Scale_Asset_Virtual_Guest)::getObject + Retrieve a SoftLayer_Scale_Asset_Virtual_Guest record. diff --git a/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getScaleGroup.md b/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getScaleGroup.md index 64b7c78f34..57f0cad380 100644 --- a/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getScaleGroup.md +++ b/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getScaleGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Asset_Virtual_Guest](/reference/services/SoftLayer_Scale_Asset_Virtual_Guest)::getScaleGroup + Retrieve the group this asset belongs to. diff --git a/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getVirtualGuest.md b/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getVirtualGuest.md index e8fcb80a7a..7f166f2870 100644 --- a/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getVirtualGuest.md +++ b/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Asset_Virtual_Guest](/reference/services/SoftLayer_Scale_Asset_Virtual_Guest)::getVirtualGuest + Retrieve the guest for this asset. diff --git a/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getVirtualGuestId.md b/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getVirtualGuestId.md index b58d30b2ce..05c827682c 100644 --- a/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getVirtualGuestId.md +++ b/content/reference/services/SoftLayer_Scale_Asset_Virtual_Guest/getVirtualGuestId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Asset_Virtual_Guest](/reference/services/SoftLayer_Scale_Asset_Virtual_Guest)::getVirtualGuestId + Retrieve the identifier of the guest for this asset. diff --git a/content/reference/services/SoftLayer_Scale_Group/_index.md b/content/reference/services/SoftLayer_Scale_Group/_index.md index bc8f09fa4d..9604d186f0 100644 --- a/content/reference/services/SoftLayer_Scale_Group/_index.md +++ b/content/reference/services/SoftLayer_Scale_Group/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A scale group can contain a number of guest members which can fluctuate up and down, staying within a defined range, manually or automatically based on policies given. Groups are set of VLANs to be placed behind. Groups can also have static hardware/guests pinned to the group. These static resources can be used to effect things like moving averages for policy triggers but are not counted as group members and are not subject to automatic reclaim. @@ -42,126 +44,147 @@ A scale group can contain a number of guest members which can fluctuate up and d #### [createObject](/reference/services/SoftLayer_Scale_Group/createObject) Create a scale group. +
              #### [deleteObject](/reference/services/SoftLayer_Scale_Group/deleteObject) Delete this group. This can only be done on an empty, active group. +
              #### [editObject](/reference/services/SoftLayer_Scale_Group/editObject) Edit this group. +
              #### [forceDeleteObject](/reference/services/SoftLayer_Scale_Group/forceDeleteObject) Delete this group and destroy all members of it. +
              #### [getAccount](/reference/services/SoftLayer_Scale_Group/getAccount) Retrieve the account for this scaling group. +
              #### [getAvailableHourlyInstanceLimit](/reference/services/SoftLayer_Scale_Group/getAvailableHourlyInstanceLimit) This returns the number of hourly instances an account can add from this point. +
              #### [getAvailableRegionalGroups](/reference/services/SoftLayer_Scale_Group/getAvailableRegionalGroups) Get the regional groups available for use by scaling groups. This also includes datacenter children that are available. +
              #### [getLoadBalancers](/reference/services/SoftLayer_Scale_Group/getLoadBalancers) Retrieve collection of load balancers for this auto scale group. +
              #### [getLogs](/reference/services/SoftLayer_Scale_Group/getLogs) Retrieve collection of log entries for this group. +
              #### [getNetworkVlans](/reference/services/SoftLayer_Scale_Group/getNetworkVlans) Retrieve collection of VLANs for this auto scale group. VLANs are optional. This can contain a public or private VLAN or both. When a single VLAN for a public/private type is given it can be a non-purchased VLAN only if the minimumMemberCount on the group is >= 1. This can also contain any number of public/private purchased VLANs and members are staggered across them when scaled up. +
              #### [getObject](/reference/services/SoftLayer_Scale_Group/getObject) Retrieve a SoftLayer_Scale_Group record. +
              #### [getPolicies](/reference/services/SoftLayer_Scale_Group/getPolicies) Retrieve collection of policies for this group. This can be empty. +
              #### [getRegionalGroup](/reference/services/SoftLayer_Scale_Group/getRegionalGroup) Retrieve the regional group for this scale group. +
              #### [getStatus](/reference/services/SoftLayer_Scale_Group/getStatus) Retrieve the status for this scale group. +
              #### [getTerminationPolicy](/reference/services/SoftLayer_Scale_Group/getTerminationPolicy) Retrieve the termination policy for this scaling group. +
              #### [getVirtualGuestAssets](/reference/services/SoftLayer_Scale_Group/getVirtualGuestAssets) Retrieve collection of guests that have been pinned to this group. Guest assets are only used for certain trigger checks such as resource watches. They do not count towards the auto scaling guest counts of this group in anyway and are never automatically added or removed. +
              #### [getVirtualGuestMembers](/reference/services/SoftLayer_Scale_Group/getVirtualGuestMembers) Retrieve collection of guests that have been scaled with the group. When this group is active, the count of guests here is guaranteed to be between minimumMemberCount and maximumMemberCount inclusively. +
              #### [resume](/reference/services/SoftLayer_Scale_Group/resume) Resume this group. +
              #### [scale](/reference/services/SoftLayer_Scale_Group/scale) Scale this group up or down by the amount given. +
              #### [scaleTo](/reference/services/SoftLayer_Scale_Group/scaleTo) Scale this group up or down to the number given. +
              #### [suspend](/reference/services/SoftLayer_Scale_Group/suspend) Suspend this group. +
              diff --git a/content/reference/services/SoftLayer_Scale_Group/createObject.md b/content/reference/services/SoftLayer_Scale_Group/createObject.md index 380942423c..415d2940ab 100644 --- a/content/reference/services/SoftLayer_Scale_Group/createObject.md +++ b/content/reference/services/SoftLayer_Scale_Group/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::createObject + Create a scale group. diff --git a/content/reference/services/SoftLayer_Scale_Group/deleteObject.md b/content/reference/services/SoftLayer_Scale_Group/deleteObject.md index 148215216d..54c50feaa8 100644 --- a/content/reference/services/SoftLayer_Scale_Group/deleteObject.md +++ b/content/reference/services/SoftLayer_Scale_Group/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::deleteObject + Delete this group. This can only be done on an empty, active group. diff --git a/content/reference/services/SoftLayer_Scale_Group/editObject.md b/content/reference/services/SoftLayer_Scale_Group/editObject.md index 8025efad3c..4afa2f8307 100644 --- a/content/reference/services/SoftLayer_Scale_Group/editObject.md +++ b/content/reference/services/SoftLayer_Scale_Group/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::editObject + Edit this group. diff --git a/content/reference/services/SoftLayer_Scale_Group/forceDeleteObject.md b/content/reference/services/SoftLayer_Scale_Group/forceDeleteObject.md index cfef19a70c..62bca80702 100644 --- a/content/reference/services/SoftLayer_Scale_Group/forceDeleteObject.md +++ b/content/reference/services/SoftLayer_Scale_Group/forceDeleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::forceDeleteObject + Delete this group and destroy all members of it. diff --git a/content/reference/services/SoftLayer_Scale_Group/getAccount.md b/content/reference/services/SoftLayer_Scale_Group/getAccount.md index 3deebba603..9a8e7039e6 100644 --- a/content/reference/services/SoftLayer_Scale_Group/getAccount.md +++ b/content/reference/services/SoftLayer_Scale_Group/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::getAccount + Retrieve the account for this scaling group. diff --git a/content/reference/services/SoftLayer_Scale_Group/getAvailableHourlyInstanceLimit.md b/content/reference/services/SoftLayer_Scale_Group/getAvailableHourlyInstanceLimit.md index 7ae93d0a70..b952122d71 100644 --- a/content/reference/services/SoftLayer_Scale_Group/getAvailableHourlyInstanceLimit.md +++ b/content/reference/services/SoftLayer_Scale_Group/getAvailableHourlyInstanceLimit.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::getAvailableHourlyInstanceLimit + This returns the number of hourly instances an account can add from this point. diff --git a/content/reference/services/SoftLayer_Scale_Group/getAvailableRegionalGroups.md b/content/reference/services/SoftLayer_Scale_Group/getAvailableRegionalGroups.md index 8a9c20be50..a61922db30 100644 --- a/content/reference/services/SoftLayer_Scale_Group/getAvailableRegionalGroups.md +++ b/content/reference/services/SoftLayer_Scale_Group/getAvailableRegionalGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::getAvailableRegionalGroups + Get the regional groups available for use by scaling groups. This also includes datacenter children that are available. diff --git a/content/reference/services/SoftLayer_Scale_Group/getLoadBalancers.md b/content/reference/services/SoftLayer_Scale_Group/getLoadBalancers.md index 17b809d81b..656d4da235 100644 --- a/content/reference/services/SoftLayer_Scale_Group/getLoadBalancers.md +++ b/content/reference/services/SoftLayer_Scale_Group/getLoadBalancers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::getLoadBalancers + Retrieve collection of load balancers for this auto scale group. diff --git a/content/reference/services/SoftLayer_Scale_Group/getLogs.md b/content/reference/services/SoftLayer_Scale_Group/getLogs.md index 7f5c609a1e..7dbb972c79 100644 --- a/content/reference/services/SoftLayer_Scale_Group/getLogs.md +++ b/content/reference/services/SoftLayer_Scale_Group/getLogs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::getLogs + Retrieve collection of log entries for this group. diff --git a/content/reference/services/SoftLayer_Scale_Group/getNetworkVlans.md b/content/reference/services/SoftLayer_Scale_Group/getNetworkVlans.md index 4b47b56eb7..b7eac825e8 100644 --- a/content/reference/services/SoftLayer_Scale_Group/getNetworkVlans.md +++ b/content/reference/services/SoftLayer_Scale_Group/getNetworkVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::getNetworkVlans + Retrieve collection of VLANs for this auto scale group. VLANs are optional. This can contain a public or private VLAN or both. When a single VLAN for a public/private type is given it can be a non-purchased VLAN only if the minimumMemberCount on the group is >= 1. This can also contain any number of public/private purchased VLANs and members are staggered across them when scaled up. diff --git a/content/reference/services/SoftLayer_Scale_Group/getObject.md b/content/reference/services/SoftLayer_Scale_Group/getObject.md index a69edac1da..6d48e8e771 100644 --- a/content/reference/services/SoftLayer_Scale_Group/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Group/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::getObject + Retrieve a SoftLayer_Scale_Group record. diff --git a/content/reference/services/SoftLayer_Scale_Group/getPolicies.md b/content/reference/services/SoftLayer_Scale_Group/getPolicies.md index 70252493a0..64932d1dc0 100644 --- a/content/reference/services/SoftLayer_Scale_Group/getPolicies.md +++ b/content/reference/services/SoftLayer_Scale_Group/getPolicies.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::getPolicies + Retrieve collection of policies for this group. This can be empty. diff --git a/content/reference/services/SoftLayer_Scale_Group/getRegionalGroup.md b/content/reference/services/SoftLayer_Scale_Group/getRegionalGroup.md index 1ccc0077a1..6d64beee47 100644 --- a/content/reference/services/SoftLayer_Scale_Group/getRegionalGroup.md +++ b/content/reference/services/SoftLayer_Scale_Group/getRegionalGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::getRegionalGroup + Retrieve the regional group for this scale group. diff --git a/content/reference/services/SoftLayer_Scale_Group/getStatus.md b/content/reference/services/SoftLayer_Scale_Group/getStatus.md index 3cd97d055f..6ffe290a5e 100644 --- a/content/reference/services/SoftLayer_Scale_Group/getStatus.md +++ b/content/reference/services/SoftLayer_Scale_Group/getStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::getStatus + Retrieve the status for this scale group. diff --git a/content/reference/services/SoftLayer_Scale_Group/getTerminationPolicy.md b/content/reference/services/SoftLayer_Scale_Group/getTerminationPolicy.md index 5724b41ac8..5619ea3b0d 100644 --- a/content/reference/services/SoftLayer_Scale_Group/getTerminationPolicy.md +++ b/content/reference/services/SoftLayer_Scale_Group/getTerminationPolicy.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::getTerminationPolicy + Retrieve the termination policy for this scaling group. diff --git a/content/reference/services/SoftLayer_Scale_Group/getVirtualGuestAssets.md b/content/reference/services/SoftLayer_Scale_Group/getVirtualGuestAssets.md index 6787c8fe0a..262db3f772 100644 --- a/content/reference/services/SoftLayer_Scale_Group/getVirtualGuestAssets.md +++ b/content/reference/services/SoftLayer_Scale_Group/getVirtualGuestAssets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::getVirtualGuestAssets + Retrieve collection of guests that have been pinned to this group. Guest assets are only used for certain trigger checks such as resource watches. They do not count towards the auto scaling guest counts of this group in anyway and are never automatically added or removed. diff --git a/content/reference/services/SoftLayer_Scale_Group/getVirtualGuestMembers.md b/content/reference/services/SoftLayer_Scale_Group/getVirtualGuestMembers.md index d560530a2c..1d06e811ba 100644 --- a/content/reference/services/SoftLayer_Scale_Group/getVirtualGuestMembers.md +++ b/content/reference/services/SoftLayer_Scale_Group/getVirtualGuestMembers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::getVirtualGuestMembers + Retrieve collection of guests that have been scaled with the group. When this group is active, the count of guests here is guaranteed to be between minimumMemberCount and maximumMemberCount inclusively. diff --git a/content/reference/services/SoftLayer_Scale_Group/resume.md b/content/reference/services/SoftLayer_Scale_Group/resume.md index d757e438c8..c68692dfb9 100644 --- a/content/reference/services/SoftLayer_Scale_Group/resume.md +++ b/content/reference/services/SoftLayer_Scale_Group/resume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::resume + Resume this group. diff --git a/content/reference/services/SoftLayer_Scale_Group/scale.md b/content/reference/services/SoftLayer_Scale_Group/scale.md index c9792db72e..b8c2f41491 100644 --- a/content/reference/services/SoftLayer_Scale_Group/scale.md +++ b/content/reference/services/SoftLayer_Scale_Group/scale.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::scale + Scale this group up or down by the amount given. diff --git a/content/reference/services/SoftLayer_Scale_Group/scaleTo.md b/content/reference/services/SoftLayer_Scale_Group/scaleTo.md index 8cdcd05082..0f63374273 100644 --- a/content/reference/services/SoftLayer_Scale_Group/scaleTo.md +++ b/content/reference/services/SoftLayer_Scale_Group/scaleTo.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::scaleTo + Scale this group up or down to the number given. diff --git a/content/reference/services/SoftLayer_Scale_Group/suspend.md b/content/reference/services/SoftLayer_Scale_Group/suspend.md index d34d7dabaa..9bd747155e 100644 --- a/content/reference/services/SoftLayer_Scale_Group/suspend.md +++ b/content/reference/services/SoftLayer_Scale_Group/suspend.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group](/reference/services/SoftLayer_Scale_Group)::suspend + Suspend this group. diff --git a/content/reference/services/SoftLayer_Scale_Group_Status/_index.md b/content/reference/services/SoftLayer_Scale_Group_Status/_index.md index 78cd20f903..f44ac4c424 100644 --- a/content/reference/services/SoftLayer_Scale_Group_Status/_index.md +++ b/content/reference/services/SoftLayer_Scale_Group_Status/_index.md @@ -21,6 +21,8 @@ classes: ## Description + + The status of a scale group. This status affects what actions can occur on a group. The values can be: @@ -52,12 +54,14 @@ suspended state, a scale group cannot have any members added or deleted, or chan #### [getAllObjects](/reference/services/SoftLayer_Scale_Group_Status/getAllObjects) Get all group statuses +
              #### [getObject](/reference/services/SoftLayer_Scale_Group_Status/getObject) Retrieve a SoftLayer_Scale_Group_Status record. +
              diff --git a/content/reference/services/SoftLayer_Scale_Group_Status/getAllObjects.md b/content/reference/services/SoftLayer_Scale_Group_Status/getAllObjects.md index dad3d7218f..c2f400e5e2 100644 --- a/content/reference/services/SoftLayer_Scale_Group_Status/getAllObjects.md +++ b/content/reference/services/SoftLayer_Scale_Group_Status/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group_Status](/reference/services/SoftLayer_Scale_Group_Status)::getAllObjects + Get all group statuses diff --git a/content/reference/services/SoftLayer_Scale_Group_Status/getObject.md b/content/reference/services/SoftLayer_Scale_Group_Status/getObject.md index 5269386dce..4ad84cb74a 100644 --- a/content/reference/services/SoftLayer_Scale_Group_Status/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Group_Status/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Group_Status](/reference/services/SoftLayer_Scale_Group_Status)::getObject + Retrieve a SoftLayer_Scale_Group_Status record. diff --git a/content/reference/services/SoftLayer_Scale_LoadBalancer/_index.md b/content/reference/services/SoftLayer_Scale_LoadBalancer/_index.md index a3224ee5c4..c5e438114f 100644 --- a/content/reference/services/SoftLayer_Scale_LoadBalancer/_index.md +++ b/content/reference/services/SoftLayer_Scale_LoadBalancer/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A scale load balancer is a configuration for a load balancer virtual server that autoscaled members will be automatically configured for. @@ -42,72 +44,84 @@ A scale load balancer is a configuration for a load balancer virtual server that #### [createObject](/reference/services/SoftLayer_Scale_LoadBalancer/createObject) Create a load balancer for a scale group. +
              #### [deleteObject](/reference/services/SoftLayer_Scale_LoadBalancer/deleteObject) Delete this load balancer configuration. +
              #### [editObject](/reference/services/SoftLayer_Scale_LoadBalancer/editObject) Edit this load balancer configuration. +
              #### [getAllocationPercent](/reference/services/SoftLayer_Scale_LoadBalancer/getAllocationPercent) Retrieve the percentage of connections allocated to this virtual server. +
              #### [getHealthCheck](/reference/services/SoftLayer_Scale_LoadBalancer/getHealthCheck) Retrieve the health check for this configuration. +
              #### [getObject](/reference/services/SoftLayer_Scale_LoadBalancer/getObject) Retrieve a SoftLayer_Scale_LoadBalancer record. +
              #### [getRoutingMethod](/reference/services/SoftLayer_Scale_LoadBalancer/getRoutingMethod) Retrieve the routing method. +
              #### [getRoutingType](/reference/services/SoftLayer_Scale_LoadBalancer/getRoutingType) Retrieve the routing type. +
              #### [getScaleGroup](/reference/services/SoftLayer_Scale_LoadBalancer/getScaleGroup) Retrieve the group this load balancer configuration is for. +
              #### [getVirtualIpAddressId](/reference/services/SoftLayer_Scale_LoadBalancer/getVirtualIpAddressId) Retrieve the ID of the virtual IP address. +
              #### [getVirtualServer](/reference/services/SoftLayer_Scale_LoadBalancer/getVirtualServer) Retrieve the virtual server for this configuration. +
              #### [getVirtualServerPort](/reference/services/SoftLayer_Scale_LoadBalancer/getVirtualServerPort) Retrieve the port on the virtual server. +
              diff --git a/content/reference/services/SoftLayer_Scale_LoadBalancer/createObject.md b/content/reference/services/SoftLayer_Scale_LoadBalancer/createObject.md index afbee870c5..61556910d8 100644 --- a/content/reference/services/SoftLayer_Scale_LoadBalancer/createObject.md +++ b/content/reference/services/SoftLayer_Scale_LoadBalancer/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_LoadBalancer](/reference/services/SoftLayer_Scale_LoadBalancer)::createObject + Create a load balancer for a scale group. diff --git a/content/reference/services/SoftLayer_Scale_LoadBalancer/deleteObject.md b/content/reference/services/SoftLayer_Scale_LoadBalancer/deleteObject.md index b8978cb22a..6a7ec69ea2 100644 --- a/content/reference/services/SoftLayer_Scale_LoadBalancer/deleteObject.md +++ b/content/reference/services/SoftLayer_Scale_LoadBalancer/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_LoadBalancer](/reference/services/SoftLayer_Scale_LoadBalancer)::deleteObject + Delete this load balancer configuration. diff --git a/content/reference/services/SoftLayer_Scale_LoadBalancer/editObject.md b/content/reference/services/SoftLayer_Scale_LoadBalancer/editObject.md index 3f3b230fd5..f7856012af 100644 --- a/content/reference/services/SoftLayer_Scale_LoadBalancer/editObject.md +++ b/content/reference/services/SoftLayer_Scale_LoadBalancer/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_LoadBalancer](/reference/services/SoftLayer_Scale_LoadBalancer)::editObject + Edit this load balancer configuration. diff --git a/content/reference/services/SoftLayer_Scale_LoadBalancer/getAllocationPercent.md b/content/reference/services/SoftLayer_Scale_LoadBalancer/getAllocationPercent.md index 87755cf611..daa2b64fa7 100644 --- a/content/reference/services/SoftLayer_Scale_LoadBalancer/getAllocationPercent.md +++ b/content/reference/services/SoftLayer_Scale_LoadBalancer/getAllocationPercent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_LoadBalancer](/reference/services/SoftLayer_Scale_LoadBalancer)::getAllocationPercent + Retrieve the percentage of connections allocated to this virtual server. diff --git a/content/reference/services/SoftLayer_Scale_LoadBalancer/getHealthCheck.md b/content/reference/services/SoftLayer_Scale_LoadBalancer/getHealthCheck.md index 6b1afbc54d..08f82e5ae2 100644 --- a/content/reference/services/SoftLayer_Scale_LoadBalancer/getHealthCheck.md +++ b/content/reference/services/SoftLayer_Scale_LoadBalancer/getHealthCheck.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_LoadBalancer](/reference/services/SoftLayer_Scale_LoadBalancer)::getHealthCheck + Retrieve the health check for this configuration. diff --git a/content/reference/services/SoftLayer_Scale_LoadBalancer/getObject.md b/content/reference/services/SoftLayer_Scale_LoadBalancer/getObject.md index a6b510d890..7b2a04a393 100644 --- a/content/reference/services/SoftLayer_Scale_LoadBalancer/getObject.md +++ b/content/reference/services/SoftLayer_Scale_LoadBalancer/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_LoadBalancer](/reference/services/SoftLayer_Scale_LoadBalancer)::getObject + Retrieve a SoftLayer_Scale_LoadBalancer record. diff --git a/content/reference/services/SoftLayer_Scale_LoadBalancer/getRoutingMethod.md b/content/reference/services/SoftLayer_Scale_LoadBalancer/getRoutingMethod.md index 400b560013..6a55870796 100644 --- a/content/reference/services/SoftLayer_Scale_LoadBalancer/getRoutingMethod.md +++ b/content/reference/services/SoftLayer_Scale_LoadBalancer/getRoutingMethod.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_LoadBalancer](/reference/services/SoftLayer_Scale_LoadBalancer)::getRoutingMethod + Retrieve the routing method. diff --git a/content/reference/services/SoftLayer_Scale_LoadBalancer/getRoutingType.md b/content/reference/services/SoftLayer_Scale_LoadBalancer/getRoutingType.md index 19fa3134c7..b26ddd142b 100644 --- a/content/reference/services/SoftLayer_Scale_LoadBalancer/getRoutingType.md +++ b/content/reference/services/SoftLayer_Scale_LoadBalancer/getRoutingType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_LoadBalancer](/reference/services/SoftLayer_Scale_LoadBalancer)::getRoutingType + Retrieve the routing type. diff --git a/content/reference/services/SoftLayer_Scale_LoadBalancer/getScaleGroup.md b/content/reference/services/SoftLayer_Scale_LoadBalancer/getScaleGroup.md index a15e9cd94e..49a5c16dec 100644 --- a/content/reference/services/SoftLayer_Scale_LoadBalancer/getScaleGroup.md +++ b/content/reference/services/SoftLayer_Scale_LoadBalancer/getScaleGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_LoadBalancer](/reference/services/SoftLayer_Scale_LoadBalancer)::getScaleGroup + Retrieve the group this load balancer configuration is for. diff --git a/content/reference/services/SoftLayer_Scale_LoadBalancer/getVirtualIpAddressId.md b/content/reference/services/SoftLayer_Scale_LoadBalancer/getVirtualIpAddressId.md index 55ff403126..29de875611 100644 --- a/content/reference/services/SoftLayer_Scale_LoadBalancer/getVirtualIpAddressId.md +++ b/content/reference/services/SoftLayer_Scale_LoadBalancer/getVirtualIpAddressId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_LoadBalancer](/reference/services/SoftLayer_Scale_LoadBalancer)::getVirtualIpAddressId + Retrieve the ID of the virtual IP address. diff --git a/content/reference/services/SoftLayer_Scale_LoadBalancer/getVirtualServer.md b/content/reference/services/SoftLayer_Scale_LoadBalancer/getVirtualServer.md index 2befc829fb..112e29c183 100644 --- a/content/reference/services/SoftLayer_Scale_LoadBalancer/getVirtualServer.md +++ b/content/reference/services/SoftLayer_Scale_LoadBalancer/getVirtualServer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_LoadBalancer](/reference/services/SoftLayer_Scale_LoadBalancer)::getVirtualServer + Retrieve the virtual server for this configuration. diff --git a/content/reference/services/SoftLayer_Scale_LoadBalancer/getVirtualServerPort.md b/content/reference/services/SoftLayer_Scale_LoadBalancer/getVirtualServerPort.md index b42e63f315..fac282a1c2 100644 --- a/content/reference/services/SoftLayer_Scale_LoadBalancer/getVirtualServerPort.md +++ b/content/reference/services/SoftLayer_Scale_LoadBalancer/getVirtualServerPort.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_LoadBalancer](/reference/services/SoftLayer_Scale_LoadBalancer)::getVirtualServerPort + Retrieve the port on the virtual server. diff --git a/content/reference/services/SoftLayer_Scale_Member/_index.md b/content/reference/services/SoftLayer_Scale_Member/_index.md index 5ce6510712..4a3c2453f5 100644 --- a/content/reference/services/SoftLayer_Scale_Member/_index.md +++ b/content/reference/services/SoftLayer_Scale_Member/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The base member of a scale group. Members are the volatile scaling units of a scale group. This cannot be used by itself, one of the more specific member types and services must be used. @@ -42,18 +44,21 @@ The base member of a scale group. Members are the volatile scaling units of a sc #### [deleteObject](/reference/services/SoftLayer_Scale_Member/deleteObject) Delete this group member. This is not the recommended way to delete members. Instead, users should use invocations on the group itself to do scaling. +
              #### [getObject](/reference/services/SoftLayer_Scale_Member/getObject) Retrieve a SoftLayer_Scale_Member record. +
              #### [getScaleGroup](/reference/services/SoftLayer_Scale_Member/getScaleGroup) Retrieve the group this member belongs to. +
              diff --git a/content/reference/services/SoftLayer_Scale_Member/deleteObject.md b/content/reference/services/SoftLayer_Scale_Member/deleteObject.md index 9db195dcd6..a4e3acb39b 100644 --- a/content/reference/services/SoftLayer_Scale_Member/deleteObject.md +++ b/content/reference/services/SoftLayer_Scale_Member/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Member](/reference/services/SoftLayer_Scale_Member)::deleteObject + Delete this group member. This is not the recommended way to delete members. Instead, users should use invocations on the group itself to do scaling. diff --git a/content/reference/services/SoftLayer_Scale_Member/getObject.md b/content/reference/services/SoftLayer_Scale_Member/getObject.md index b923359467..378ea64649 100644 --- a/content/reference/services/SoftLayer_Scale_Member/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Member/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Member](/reference/services/SoftLayer_Scale_Member)::getObject + Retrieve a SoftLayer_Scale_Member record. diff --git a/content/reference/services/SoftLayer_Scale_Member/getScaleGroup.md b/content/reference/services/SoftLayer_Scale_Member/getScaleGroup.md index 56e43d6ec1..f7265d0130 100644 --- a/content/reference/services/SoftLayer_Scale_Member/getScaleGroup.md +++ b/content/reference/services/SoftLayer_Scale_Member/getScaleGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Member](/reference/services/SoftLayer_Scale_Member)::getScaleGroup + Retrieve the group this member belongs to. diff --git a/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/_index.md b/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/_index.md index c4c787f929..86c7d7dd23 100644 --- a/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/_index.md +++ b/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A guest member is a scaled guest on a scale group. It is added either automatically or manually based on group settings. It can be removed here, but is usually best removed using one of the scaling features of the group as a whole. @@ -42,30 +44,35 @@ A guest member is a scaled guest on a scale group. It is added either automatica #### [deleteObject](/reference/services/SoftLayer_Scale_Member_Virtual_Guest/deleteObject) Delete this group member. +
              #### [getObject](/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getObject) Retrieve a SoftLayer_Scale_Member_Virtual_Guest record. +
              #### [getScaleGroup](/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getScaleGroup) Retrieve the group this member belongs to. +
              #### [getVirtualGuest](/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getVirtualGuest) Retrieve the guest for this member. +
              #### [getVirtualGuestId](/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getVirtualGuestId) Retrieve the identifier of the guest for this member. +
              diff --git a/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/deleteObject.md b/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/deleteObject.md index 8da6449d15..0b69266f2b 100644 --- a/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/deleteObject.md +++ b/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Member_Virtual_Guest](/reference/services/SoftLayer_Scale_Member_Virtual_Guest)::deleteObject + Delete this group member. diff --git a/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getObject.md b/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getObject.md index 554ab28d2c..4d855ad17e 100644 --- a/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Member_Virtual_Guest](/reference/services/SoftLayer_Scale_Member_Virtual_Guest)::getObject + Retrieve a SoftLayer_Scale_Member_Virtual_Guest record. diff --git a/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getScaleGroup.md b/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getScaleGroup.md index b78ba6c704..ad06097778 100644 --- a/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getScaleGroup.md +++ b/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getScaleGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Member_Virtual_Guest](/reference/services/SoftLayer_Scale_Member_Virtual_Guest)::getScaleGroup + Retrieve the group this member belongs to. diff --git a/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getVirtualGuest.md b/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getVirtualGuest.md index 7fbb0f864b..0695627d23 100644 --- a/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getVirtualGuest.md +++ b/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Member_Virtual_Guest](/reference/services/SoftLayer_Scale_Member_Virtual_Guest)::getVirtualGuest + Retrieve the guest for this member. diff --git a/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getVirtualGuestId.md b/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getVirtualGuestId.md index 77141587df..e5499c63d2 100644 --- a/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getVirtualGuestId.md +++ b/content/reference/services/SoftLayer_Scale_Member_Virtual_Guest/getVirtualGuestId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Member_Virtual_Guest](/reference/services/SoftLayer_Scale_Member_Virtual_Guest)::getVirtualGuestId + Retrieve the identifier of the guest for this member. diff --git a/content/reference/services/SoftLayer_Scale_Network_Vlan/_index.md b/content/reference/services/SoftLayer_Scale_Network_Vlan/_index.md index 28b285b911..784318660b 100644 --- a/content/reference/services/SoftLayer_Scale_Network_Vlan/_index.md +++ b/content/reference/services/SoftLayer_Scale_Network_Vlan/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A scale network VLAN is a VLAN that scaled members will be placed on. @@ -42,30 +44,35 @@ A scale network VLAN is a VLAN that scaled members will be placed on. #### [createObject](/reference/services/SoftLayer_Scale_Network_Vlan/createObject) Create a network VLAN for a scale group. Once created, the VLAN will be used to scale with. +
              #### [deleteObject](/reference/services/SoftLayer_Scale_Network_Vlan/deleteObject) Delete this network VLAN reference. Note, this does not affect existing scaled members. Once deleted however, future scaled members will not be placed on this referenced VLAN. +
              #### [getNetworkVlan](/reference/services/SoftLayer_Scale_Network_Vlan/getNetworkVlan) Retrieve the network VLAN to scale with. +
              #### [getObject](/reference/services/SoftLayer_Scale_Network_Vlan/getObject) Retrieve a SoftLayer_Scale_Network_Vlan record. +
              #### [getScaleGroup](/reference/services/SoftLayer_Scale_Network_Vlan/getScaleGroup) Retrieve the group this network VLAN is for. +
              diff --git a/content/reference/services/SoftLayer_Scale_Network_Vlan/createObject.md b/content/reference/services/SoftLayer_Scale_Network_Vlan/createObject.md index 162fc60d73..2eb5eee1e3 100644 --- a/content/reference/services/SoftLayer_Scale_Network_Vlan/createObject.md +++ b/content/reference/services/SoftLayer_Scale_Network_Vlan/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Network_Vlan](/reference/services/SoftLayer_Scale_Network_Vlan)::createObject + Create a network VLAN for a scale group. Once created, the VLAN will be used to scale with. diff --git a/content/reference/services/SoftLayer_Scale_Network_Vlan/deleteObject.md b/content/reference/services/SoftLayer_Scale_Network_Vlan/deleteObject.md index cfe15f5762..89ed389c57 100644 --- a/content/reference/services/SoftLayer_Scale_Network_Vlan/deleteObject.md +++ b/content/reference/services/SoftLayer_Scale_Network_Vlan/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Network_Vlan](/reference/services/SoftLayer_Scale_Network_Vlan)::deleteObject + Delete this network VLAN reference. Note, this does not affect existing scaled members. Once deleted however, future scaled members will not be placed on this referenced VLAN. diff --git a/content/reference/services/SoftLayer_Scale_Network_Vlan/getNetworkVlan.md b/content/reference/services/SoftLayer_Scale_Network_Vlan/getNetworkVlan.md index cb628f09fd..9e974f858f 100644 --- a/content/reference/services/SoftLayer_Scale_Network_Vlan/getNetworkVlan.md +++ b/content/reference/services/SoftLayer_Scale_Network_Vlan/getNetworkVlan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Network_Vlan](/reference/services/SoftLayer_Scale_Network_Vlan)::getNetworkVlan + Retrieve the network VLAN to scale with. diff --git a/content/reference/services/SoftLayer_Scale_Network_Vlan/getObject.md b/content/reference/services/SoftLayer_Scale_Network_Vlan/getObject.md index e920e09843..43253713b2 100644 --- a/content/reference/services/SoftLayer_Scale_Network_Vlan/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Network_Vlan/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Network_Vlan](/reference/services/SoftLayer_Scale_Network_Vlan)::getObject + Retrieve a SoftLayer_Scale_Network_Vlan record. diff --git a/content/reference/services/SoftLayer_Scale_Network_Vlan/getScaleGroup.md b/content/reference/services/SoftLayer_Scale_Network_Vlan/getScaleGroup.md index 7ee34bed7a..b691cc45e4 100644 --- a/content/reference/services/SoftLayer_Scale_Network_Vlan/getScaleGroup.md +++ b/content/reference/services/SoftLayer_Scale_Network_Vlan/getScaleGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Network_Vlan](/reference/services/SoftLayer_Scale_Network_Vlan)::getScaleGroup + Retrieve the group this network VLAN is for. diff --git a/content/reference/services/SoftLayer_Scale_Policy/_index.md b/content/reference/services/SoftLayer_Scale_Policy/_index.md index ec0e56a8f2..b0dfb3477b 100644 --- a/content/reference/services/SoftLayer_Scale_Policy/_index.md +++ b/content/reference/services/SoftLayer_Scale_Policy/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A scale policy is a combination of triggers and actions that can occur on a scale group. When any trigger is satisfied (or the policy is manually triggered) the actions will be executed. @@ -42,72 +44,84 @@ A scale policy is a combination of triggers and actions that can occur on a scal #### [createObject](/reference/services/SoftLayer_Scale_Policy/createObject) Add a policy to a group. +
              #### [deleteObject](/reference/services/SoftLayer_Scale_Policy/deleteObject) Delete this policy from the group. +
              #### [editObject](/reference/services/SoftLayer_Scale_Policy/editObject) Edit this policy's name. +
              #### [getActions](/reference/services/SoftLayer_Scale_Policy/getActions) Retrieve the actions to perform upon any trigger hit. Currently this must be a single value. +
              #### [getObject](/reference/services/SoftLayer_Scale_Policy/getObject) Retrieve a SoftLayer_Scale_Policy record. +
              #### [getOneTimeTriggers](/reference/services/SoftLayer_Scale_Policy/getOneTimeTriggers) Retrieve the one-time triggers to check for this group. +
              #### [getRepeatingTriggers](/reference/services/SoftLayer_Scale_Policy/getRepeatingTriggers) Retrieve the repeating triggers to check for this group. +
              #### [getResourceUseTriggers](/reference/services/SoftLayer_Scale_Policy/getResourceUseTriggers) Retrieve the resource-use triggers to check for this group. +
              #### [getScaleActions](/reference/services/SoftLayer_Scale_Policy/getScaleActions) Retrieve the scale actions to perform upon any trigger hit. Currently this must be a single value. +
              #### [getScaleGroup](/reference/services/SoftLayer_Scale_Policy/getScaleGroup) Retrieve the group this policy is on. +
              #### [getTriggers](/reference/services/SoftLayer_Scale_Policy/getTriggers) Retrieve the triggers to check for this group. +
              #### [trigger](/reference/services/SoftLayer_Scale_Policy/trigger) Manually trigger the actions on this policy. +
              diff --git a/content/reference/services/SoftLayer_Scale_Policy/createObject.md b/content/reference/services/SoftLayer_Scale_Policy/createObject.md index f9fcb6b4ef..c537370218 100644 --- a/content/reference/services/SoftLayer_Scale_Policy/createObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy](/reference/services/SoftLayer_Scale_Policy)::createObject + Add a policy to a group. diff --git a/content/reference/services/SoftLayer_Scale_Policy/deleteObject.md b/content/reference/services/SoftLayer_Scale_Policy/deleteObject.md index 5acde2be97..12b0b72420 100644 --- a/content/reference/services/SoftLayer_Scale_Policy/deleteObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy](/reference/services/SoftLayer_Scale_Policy)::deleteObject + Delete this policy from the group. diff --git a/content/reference/services/SoftLayer_Scale_Policy/editObject.md b/content/reference/services/SoftLayer_Scale_Policy/editObject.md index cb89b949be..b5f5f9ee03 100644 --- a/content/reference/services/SoftLayer_Scale_Policy/editObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy](/reference/services/SoftLayer_Scale_Policy)::editObject + Edit this policy's name. diff --git a/content/reference/services/SoftLayer_Scale_Policy/getActions.md b/content/reference/services/SoftLayer_Scale_Policy/getActions.md index a1d66f1043..34ffe878c9 100644 --- a/content/reference/services/SoftLayer_Scale_Policy/getActions.md +++ b/content/reference/services/SoftLayer_Scale_Policy/getActions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy](/reference/services/SoftLayer_Scale_Policy)::getActions + Retrieve the actions to perform upon any trigger hit. Currently this must be a single value. diff --git a/content/reference/services/SoftLayer_Scale_Policy/getObject.md b/content/reference/services/SoftLayer_Scale_Policy/getObject.md index a67a8fd991..0b55c881db 100644 --- a/content/reference/services/SoftLayer_Scale_Policy/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy](/reference/services/SoftLayer_Scale_Policy)::getObject + Retrieve a SoftLayer_Scale_Policy record. diff --git a/content/reference/services/SoftLayer_Scale_Policy/getOneTimeTriggers.md b/content/reference/services/SoftLayer_Scale_Policy/getOneTimeTriggers.md index 52dbb01e9a..5ad47202a2 100644 --- a/content/reference/services/SoftLayer_Scale_Policy/getOneTimeTriggers.md +++ b/content/reference/services/SoftLayer_Scale_Policy/getOneTimeTriggers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy](/reference/services/SoftLayer_Scale_Policy)::getOneTimeTriggers + Retrieve the one-time triggers to check for this group. diff --git a/content/reference/services/SoftLayer_Scale_Policy/getRepeatingTriggers.md b/content/reference/services/SoftLayer_Scale_Policy/getRepeatingTriggers.md index dcde56ed99..f395e846a6 100644 --- a/content/reference/services/SoftLayer_Scale_Policy/getRepeatingTriggers.md +++ b/content/reference/services/SoftLayer_Scale_Policy/getRepeatingTriggers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy](/reference/services/SoftLayer_Scale_Policy)::getRepeatingTriggers + Retrieve the repeating triggers to check for this group. diff --git a/content/reference/services/SoftLayer_Scale_Policy/getResourceUseTriggers.md b/content/reference/services/SoftLayer_Scale_Policy/getResourceUseTriggers.md index 95c66dca66..94fc1f928e 100644 --- a/content/reference/services/SoftLayer_Scale_Policy/getResourceUseTriggers.md +++ b/content/reference/services/SoftLayer_Scale_Policy/getResourceUseTriggers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy](/reference/services/SoftLayer_Scale_Policy)::getResourceUseTriggers + Retrieve the resource-use triggers to check for this group. diff --git a/content/reference/services/SoftLayer_Scale_Policy/getScaleActions.md b/content/reference/services/SoftLayer_Scale_Policy/getScaleActions.md index 9348d13db5..507c0845f2 100644 --- a/content/reference/services/SoftLayer_Scale_Policy/getScaleActions.md +++ b/content/reference/services/SoftLayer_Scale_Policy/getScaleActions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy](/reference/services/SoftLayer_Scale_Policy)::getScaleActions + Retrieve the scale actions to perform upon any trigger hit. Currently this must be a single value. diff --git a/content/reference/services/SoftLayer_Scale_Policy/getScaleGroup.md b/content/reference/services/SoftLayer_Scale_Policy/getScaleGroup.md index 9a0aff7230..a43b1df908 100644 --- a/content/reference/services/SoftLayer_Scale_Policy/getScaleGroup.md +++ b/content/reference/services/SoftLayer_Scale_Policy/getScaleGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy](/reference/services/SoftLayer_Scale_Policy)::getScaleGroup + Retrieve the group this policy is on. diff --git a/content/reference/services/SoftLayer_Scale_Policy/getTriggers.md b/content/reference/services/SoftLayer_Scale_Policy/getTriggers.md index 736dbe8984..05f37d1d50 100644 --- a/content/reference/services/SoftLayer_Scale_Policy/getTriggers.md +++ b/content/reference/services/SoftLayer_Scale_Policy/getTriggers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy](/reference/services/SoftLayer_Scale_Policy)::getTriggers + Retrieve the triggers to check for this group. diff --git a/content/reference/services/SoftLayer_Scale_Policy/trigger.md b/content/reference/services/SoftLayer_Scale_Policy/trigger.md index 782b7be987..e360f730da 100644 --- a/content/reference/services/SoftLayer_Scale_Policy/trigger.md +++ b/content/reference/services/SoftLayer_Scale_Policy/trigger.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy](/reference/services/SoftLayer_Scale_Policy)::trigger + Manually trigger the actions on this policy. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Action/_index.md b/content/reference/services/SoftLayer_Scale_Policy_Action/_index.md index 49ed025237..6b2d9a57ab 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Action/_index.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Action/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + An action to execute when a policy is triggered. Currently only one action can be associated with a policy and it must be created with the policy. @@ -42,30 +44,35 @@ An action to execute when a policy is triggered. Currently only one action can b #### [deleteObject](/reference/services/SoftLayer_Scale_Policy_Action/deleteObject) Delete this action. +
              #### [editObject](/reference/services/SoftLayer_Scale_Policy_Action/editObject) Edit this action. +
              #### [getObject](/reference/services/SoftLayer_Scale_Policy_Action/getObject) Retrieve a SoftLayer_Scale_Policy_Action record. +
              #### [getScalePolicy](/reference/services/SoftLayer_Scale_Policy_Action/getScalePolicy) Retrieve the policy this action is on. +
              #### [getType](/reference/services/SoftLayer_Scale_Policy_Action/getType) Retrieve the type of action. +
              diff --git a/content/reference/services/SoftLayer_Scale_Policy_Action/deleteObject.md b/content/reference/services/SoftLayer_Scale_Policy_Action/deleteObject.md index 61f971698f..9a77b63623 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Action/deleteObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Action/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Action](/reference/services/SoftLayer_Scale_Policy_Action)::deleteObject + Delete this action. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Action/editObject.md b/content/reference/services/SoftLayer_Scale_Policy_Action/editObject.md index 38c8c72d45..a6b6fe162f 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Action/editObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Action/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Action](/reference/services/SoftLayer_Scale_Policy_Action)::editObject + Edit this action. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Action/getObject.md b/content/reference/services/SoftLayer_Scale_Policy_Action/getObject.md index c621c7f576..bf4d14b93e 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Action/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Action/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Action](/reference/services/SoftLayer_Scale_Policy_Action)::getObject + Retrieve a SoftLayer_Scale_Policy_Action record. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Action/getScalePolicy.md b/content/reference/services/SoftLayer_Scale_Policy_Action/getScalePolicy.md index 8fd4c73400..abea5b1a41 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Action/getScalePolicy.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Action/getScalePolicy.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Action](/reference/services/SoftLayer_Scale_Policy_Action)::getScalePolicy + Retrieve the policy this action is on. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Action/getType.md b/content/reference/services/SoftLayer_Scale_Policy_Action/getType.md index e97031c079..fabdef9c4c 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Action/getType.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Action/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Action](/reference/services/SoftLayer_Scale_Policy_Action)::getType + Retrieve the type of action. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/_index.md b/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/_index.md index 8257f59662..475e179b2f 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/_index.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A policy action to scale a group. A group can be scaled to an absolute member number or by a relative amount using a fixed number or a percentage. @@ -42,36 +44,42 @@ A policy action to scale a group. A group can be scaled to an absolute member nu #### [createObject](/reference/services/SoftLayer_Scale_Policy_Action_Scale/createObject) Create a one-time policy trigger. +
              #### [deleteObject](/reference/services/SoftLayer_Scale_Policy_Action_Scale/deleteObject) Delete this action. +
              #### [editObject](/reference/services/SoftLayer_Scale_Policy_Action_Scale/editObject) Edit this action. +
              #### [getObject](/reference/services/SoftLayer_Scale_Policy_Action_Scale/getObject) Retrieve a SoftLayer_Scale_Policy_Action_Scale record. +
              #### [getScalePolicy](/reference/services/SoftLayer_Scale_Policy_Action_Scale/getScalePolicy) Retrieve the policy this action is on. +
              #### [getType](/reference/services/SoftLayer_Scale_Policy_Action_Scale/getType) Retrieve the type of action. +
              diff --git a/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/createObject.md b/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/createObject.md index e3e186f9d8..a2ce1e6ee7 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/createObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Action_Scale](/reference/services/SoftLayer_Scale_Policy_Action_Scale)::createObject + Create a one-time policy trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/deleteObject.md b/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/deleteObject.md index 751c600258..17b9253f9e 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/deleteObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Action_Scale](/reference/services/SoftLayer_Scale_Policy_Action_Scale)::deleteObject + Delete this action. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/editObject.md b/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/editObject.md index 74d117f237..1c4a437945 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/editObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Action_Scale](/reference/services/SoftLayer_Scale_Policy_Action_Scale)::editObject + Edit this action. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/getObject.md b/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/getObject.md index b141f30942..6e198ae51e 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Action_Scale](/reference/services/SoftLayer_Scale_Policy_Action_Scale)::getObject + Retrieve a SoftLayer_Scale_Policy_Action_Scale record. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/getScalePolicy.md b/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/getScalePolicy.md index 8fd95a36e1..ce4588ef79 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/getScalePolicy.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/getScalePolicy.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Action_Scale](/reference/services/SoftLayer_Scale_Policy_Action_Scale)::getScalePolicy + Retrieve the policy this action is on. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/getType.md b/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/getType.md index c750fc3970..1daa003815 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/getType.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Action_Scale/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Action_Scale](/reference/services/SoftLayer_Scale_Policy_Action_Scale)::getType + Retrieve the type of action. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Action_Type/_index.md b/content/reference/services/SoftLayer_Scale_Policy_Action_Type/_index.md index b5b28a071e..5e158493a2 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Action_Type/_index.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Action_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + An action type @@ -42,12 +44,14 @@ An action type #### [getAllObjects](/reference/services/SoftLayer_Scale_Policy_Action_Type/getAllObjects) Get all action types +
              #### [getObject](/reference/services/SoftLayer_Scale_Policy_Action_Type/getObject) Retrieve a SoftLayer_Scale_Policy_Action_Type record. +
              diff --git a/content/reference/services/SoftLayer_Scale_Policy_Action_Type/getAllObjects.md b/content/reference/services/SoftLayer_Scale_Policy_Action_Type/getAllObjects.md index 792bf40723..1daa688f12 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Action_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Action_Type/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Action_Type](/reference/services/SoftLayer_Scale_Policy_Action_Type)::getAllObjects + Get all action types diff --git a/content/reference/services/SoftLayer_Scale_Policy_Action_Type/getObject.md b/content/reference/services/SoftLayer_Scale_Policy_Action_Type/getObject.md index 7d241867d2..ed6d227af0 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Action_Type/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Action_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Action_Type](/reference/services/SoftLayer_Scale_Policy_Action_Type)::getObject + Retrieve a SoftLayer_Scale_Policy_Action_Type record. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger/_index.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger/_index.md index bd24b9843e..be71462aaa 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger/_index.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A trigger to determine when a policy's actions should be fired. @@ -42,36 +44,42 @@ A trigger to determine when a policy's actions should be fired. #### [createObject](/reference/services/SoftLayer_Scale_Policy_Trigger/createObject) Create a policy trigger. +
              #### [deleteObject](/reference/services/SoftLayer_Scale_Policy_Trigger/deleteObject) Delete this trigger. +
              #### [editObject](/reference/services/SoftLayer_Scale_Policy_Trigger/editObject) Edit this trigger. +
              #### [getObject](/reference/services/SoftLayer_Scale_Policy_Trigger/getObject) Retrieve a SoftLayer_Scale_Policy_Trigger record. +
              #### [getScalePolicy](/reference/services/SoftLayer_Scale_Policy_Trigger/getScalePolicy) Retrieve the policy this trigger is on. +
              #### [getType](/reference/services/SoftLayer_Scale_Policy_Trigger/getType) Retrieve the type of trigger. +
              diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger/createObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger/createObject.md index efcee0de34..457ae4ce85 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger/createObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger](/reference/services/SoftLayer_Scale_Policy_Trigger)::createObject + Create a policy trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger/deleteObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger/deleteObject.md index 589d2099e5..bf26c93bd2 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger/deleteObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger](/reference/services/SoftLayer_Scale_Policy_Trigger)::deleteObject + Delete this trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger/editObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger/editObject.md index b64fe3ae01..ab785935ae 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger/editObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger](/reference/services/SoftLayer_Scale_Policy_Trigger)::editObject + Edit this trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger/getObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger/getObject.md index f2eaa0f5a1..09dbb5233b 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger](/reference/services/SoftLayer_Scale_Policy_Trigger)::getObject + Retrieve a SoftLayer_Scale_Policy_Trigger record. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger/getScalePolicy.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger/getScalePolicy.md index 21ecd39fdb..5a764af0e4 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger/getScalePolicy.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger/getScalePolicy.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger](/reference/services/SoftLayer_Scale_Policy_Trigger)::getScalePolicy + Retrieve the policy this trigger is on. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger/getType.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger/getType.md index 4835b31945..d98d1dcc42 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger/getType.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger](/reference/services/SoftLayer_Scale_Policy_Trigger)::getType + Retrieve the type of trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/_index.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/_index.md index 3942bb3375..ff82402870 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/_index.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A trigger that will only execute once on the given date. If the auto scale group is suspended this will not occur. @@ -42,36 +44,42 @@ A trigger that will only execute once on the given date. If the auto scale group #### [createObject](/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/createObject) Create a one-time policy trigger. +
              #### [deleteObject](/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/deleteObject) Delete this trigger. +
              #### [editObject](/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/editObject) Edit this trigger. +
              #### [getObject](/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/getObject) Retrieve a SoftLayer_Scale_Policy_Trigger_OneTime record. +
              #### [getScalePolicy](/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/getScalePolicy) Retrieve the policy this trigger is on. +
              #### [getType](/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/getType) Retrieve the type of trigger. +
              diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/createObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/createObject.md index 5f277fadc6..e7bb2a5264 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/createObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_OneTime](/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime)::createObject + Create a one-time policy trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/deleteObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/deleteObject.md index 1fb0255e17..4c64952c5f 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/deleteObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_OneTime](/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime)::deleteObject + Delete this trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/editObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/editObject.md index a7c186cf3f..52d5f1da14 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/editObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_OneTime](/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime)::editObject + Edit this trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/getObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/getObject.md index a95cbe62a3..4d866fe87f 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_OneTime](/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime)::getObject + Retrieve a SoftLayer_Scale_Policy_Trigger_OneTime record. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/getScalePolicy.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/getScalePolicy.md index 45c0c9d4fb..417eb75dad 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/getScalePolicy.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/getScalePolicy.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_OneTime](/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime)::getScalePolicy + Retrieve the policy this trigger is on. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/getType.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/getType.md index 8f9cbdd155..f4988ceecf 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/getType.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_OneTime](/reference/services/SoftLayer_Scale_Policy_Trigger_OneTime)::getType + Retrieve the type of trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/_index.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/_index.md index 32591dc15c..121d4f2c01 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/_index.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A trigger that will execute every so often. @@ -42,42 +44,49 @@ A trigger that will execute every so often. #### [createObject](/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/createObject) Create a repeating policy trigger. +
              #### [deleteObject](/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/deleteObject) Delete this trigger. +
              #### [editObject](/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/editObject) Edit this trigger. +
              #### [getObject](/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/getObject) Retrieve a SoftLayer_Scale_Policy_Trigger_Repeating record. +
              #### [getScalePolicy](/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/getScalePolicy) Retrieve the policy this trigger is on. +
              #### [getType](/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/getType) Retrieve the type of trigger. +
              #### [validateCronExpression](/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/validateCronExpression) Validate a CRON expression. +
              diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/createObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/createObject.md index f671b59621..b49b3956c1 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/createObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_Repeating](/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating)::createObject + Create a repeating policy trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/deleteObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/deleteObject.md index 301b9c3c26..4988261efc 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/deleteObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_Repeating](/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating)::deleteObject + Delete this trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/editObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/editObject.md index 1eaf588991..02bb50b236 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/editObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_Repeating](/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating)::editObject + Edit this trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/getObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/getObject.md index c5a6249c67..9ac24af1aa 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_Repeating](/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating)::getObject + Retrieve a SoftLayer_Scale_Policy_Trigger_Repeating record. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/getScalePolicy.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/getScalePolicy.md index 967b6c41b6..abb4144cd0 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/getScalePolicy.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/getScalePolicy.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_Repeating](/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating)::getScalePolicy + Retrieve the policy this trigger is on. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/getType.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/getType.md index 60bbe119fa..ee768ceaf6 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/getType.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_Repeating](/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating)::getType + Retrieve the type of trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/validateCronExpression.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/validateCronExpression.md index 0601fbc0d4..5de2cec929 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/validateCronExpression.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating/validateCronExpression.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_Repeating](/reference/services/SoftLayer_Scale_Policy_Trigger_Repeating)::validateCronExpression + Validate a CRON expression. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/_index.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/_index.md index 375f6ad943..fe0afad1a6 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/_index.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A trigger that will only execute only when all guests on the group (both static and member) satisfy certain resource watches. @@ -42,42 +44,49 @@ A trigger that will only execute only when all guests on the group (both static #### [createObject](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/createObject) Create a resource-use policy trigger. +
              #### [deleteObject](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/deleteObject) Delete this trigger. +
              #### [editObject](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/editObject) Edit this trigger. +
              #### [getObject](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getObject) Retrieve a SoftLayer_Scale_Policy_Trigger_ResourceUse record. +
              #### [getScalePolicy](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getScalePolicy) Retrieve the policy this trigger is on. +
              #### [getType](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getType) Retrieve the type of trigger. +
              #### [getWatches](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getWatches) Retrieve the resource watches for this trigger. +
              diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/createObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/createObject.md index 026ccf19c3..2e14856088 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/createObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_ResourceUse](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse)::createObject + Create a resource-use policy trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/deleteObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/deleteObject.md index 6546c3535b..9d901ec5c4 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/deleteObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_ResourceUse](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse)::deleteObject + Delete this trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/editObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/editObject.md index 7cee2e288b..0ae8a71b02 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/editObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_ResourceUse](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse)::editObject + Edit this trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getObject.md index ee0f89d621..ee9399c200 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_ResourceUse](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse)::getObject + Retrieve a SoftLayer_Scale_Policy_Trigger_ResourceUse record. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getScalePolicy.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getScalePolicy.md index 65b0e5c3ee..a0d720eb21 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getScalePolicy.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getScalePolicy.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_ResourceUse](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse)::getScalePolicy + Retrieve the policy this trigger is on. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getType.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getType.md index c24c38061f..f6f550273d 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getType.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_ResourceUse](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse)::getType + Retrieve the type of trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getWatches.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getWatches.md index b6cd0aeff9..f9b2f29db7 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getWatches.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse/getWatches.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_ResourceUse](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse)::getWatches + Retrieve the resource watches for this trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/_index.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/_index.md index bc9f3e7a2a..8f2ef83cb2 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/_index.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This is a specific watch for a resource use policy trigger. @@ -42,48 +44,56 @@ This is a specific watch for a resource use policy trigger. #### [createObject](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/createObject) Create a watch on an existing resource trigger. +
              #### [deleteObject](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/deleteObject) Delete this watch from the trigger. You cannot delete the last watch on a trigger. +
              #### [editObject](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/editObject) Edit this watch. +
              #### [getAllPossibleAlgorithms](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getAllPossibleAlgorithms) Get all possible values for "algorithm". +
              #### [getAllPossibleMetrics](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getAllPossibleMetrics) Get all possible values for "metric". +
              #### [getAllPossibleOperators](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getAllPossibleOperators) Get all possible values for "operator". +
              #### [getObject](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getObject) Retrieve a SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch record. +
              #### [getScalePolicyTrigger](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getScalePolicyTrigger) Retrieve the trigger this watch is on. +
              diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/createObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/createObject.md index c983c19590..1d1b14b80e 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/createObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch)::createObject + Create a watch on an existing resource trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/deleteObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/deleteObject.md index 72df43f48e..fe4dcec92c 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/deleteObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch)::deleteObject + Delete this watch from the trigger. You cannot delete the last watch on a trigger. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/editObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/editObject.md index 7480a6bbf7..0001c8a471 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/editObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch)::editObject + Edit this watch. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getAllPossibleAlgorithms.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getAllPossibleAlgorithms.md index 1c2d222e8d..40f3e60cb8 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getAllPossibleAlgorithms.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getAllPossibleAlgorithms.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch)::getAllPossibleAlgorithms + Get all possible values for "algorithm". diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getAllPossibleMetrics.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getAllPossibleMetrics.md index 466cc4a5c0..2af8eda27a 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getAllPossibleMetrics.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getAllPossibleMetrics.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch)::getAllPossibleMetrics + Get all possible values for "metric". diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getAllPossibleOperators.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getAllPossibleOperators.md index 95be7b78c4..8dfd9f27c2 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getAllPossibleOperators.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getAllPossibleOperators.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch)::getAllPossibleOperators + Get all possible values for "operator". diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getObject.md index f5657b63b1..882d9400a1 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch)::getObject + Retrieve a SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch record. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getScalePolicyTrigger.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getScalePolicyTrigger.md index 25a03a4d41..56f4770317 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getScalePolicyTrigger.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch/getScalePolicyTrigger.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch](/reference/services/SoftLayer_Scale_Policy_Trigger_ResourceUse_Watch)::getScalePolicyTrigger + Retrieve the trigger this watch is on. diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Type/_index.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Type/_index.md index 19ec143fc6..5a94135125 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Type/_index.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A trigger type @@ -42,12 +44,14 @@ A trigger type #### [getAllObjects](/reference/services/SoftLayer_Scale_Policy_Trigger_Type/getAllObjects) Get all trigger types +
              #### [getObject](/reference/services/SoftLayer_Scale_Policy_Trigger_Type/getObject) Retrieve a SoftLayer_Scale_Policy_Trigger_Type record. +
              diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Type/getAllObjects.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Type/getAllObjects.md index 988ac68546..96002ea683 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Type/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_Type](/reference/services/SoftLayer_Scale_Policy_Trigger_Type)::getAllObjects + Get all trigger types diff --git a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Type/getObject.md b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Type/getObject.md index 246e32a5ad..3dd0f60d7a 100644 --- a/content/reference/services/SoftLayer_Scale_Policy_Trigger_Type/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Policy_Trigger_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Policy_Trigger_Type](/reference/services/SoftLayer_Scale_Policy_Trigger_Type)::getObject + Retrieve a SoftLayer_Scale_Policy_Trigger_Type record. diff --git a/content/reference/services/SoftLayer_Scale_Termination_Policy/_index.md b/content/reference/services/SoftLayer_Scale_Termination_Policy/_index.md index 8424eac6c7..b374480ee8 100644 --- a/content/reference/services/SoftLayer_Scale_Termination_Policy/_index.md +++ b/content/reference/services/SoftLayer_Scale_Termination_Policy/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A policy for automatic removal of members from a group. This policy determines which members are chosen first for removal. The values can be: @@ -50,12 +52,14 @@ will let you remove the member you have gotten the most out of. Note, this is us #### [getAllObjects](/reference/services/SoftLayer_Scale_Termination_Policy/getAllObjects) Get a list of all termination policies +
              #### [getObject](/reference/services/SoftLayer_Scale_Termination_Policy/getObject) Retrieve a SoftLayer_Scale_Termination_Policy record. +
              diff --git a/content/reference/services/SoftLayer_Scale_Termination_Policy/getAllObjects.md b/content/reference/services/SoftLayer_Scale_Termination_Policy/getAllObjects.md index 34c03c58b2..ba1efc8be4 100644 --- a/content/reference/services/SoftLayer_Scale_Termination_Policy/getAllObjects.md +++ b/content/reference/services/SoftLayer_Scale_Termination_Policy/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Termination_Policy](/reference/services/SoftLayer_Scale_Termination_Policy)::getAllObjects + Get a list of all termination policies diff --git a/content/reference/services/SoftLayer_Scale_Termination_Policy/getObject.md b/content/reference/services/SoftLayer_Scale_Termination_Policy/getObject.md index 9a1deaa8ca..9470aa101f 100644 --- a/content/reference/services/SoftLayer_Scale_Termination_Policy/getObject.md +++ b/content/reference/services/SoftLayer_Scale_Termination_Policy/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Scale_Termination_Policy](/reference/services/SoftLayer_Scale_Termination_Policy)::getObject + Retrieve a SoftLayer_Scale_Termination_Policy record. diff --git a/content/reference/services/SoftLayer_Search/_index.md b/content/reference/services/SoftLayer_Search/_index.md index 65be37e847..9bc7d0279c 100644 --- a/content/reference/services/SoftLayer_Search/_index.md +++ b/content/reference/services/SoftLayer_Search/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 @@ -42,18 +44,21 @@ SoftLayer's account historical service allows users to access a broad overview o #### [advancedSearch](/reference/services/SoftLayer_Search/advancedSearch) Search for SoftLayer Resources by simple terms. +
              #### [getObjectTypes](/reference/services/SoftLayer_Search/getObjectTypes) Return a collection of indexed object types. +
              #### [search](/reference/services/SoftLayer_Search/search) Search for SoftLayer Resources by simple phrase. +
              diff --git a/content/reference/services/SoftLayer_Search/advancedSearch.md b/content/reference/services/SoftLayer_Search/advancedSearch.md index 1865925023..82cd88755b 100644 --- a/content/reference/services/SoftLayer_Search/advancedSearch.md +++ b/content/reference/services/SoftLayer_Search/advancedSearch.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Search](/reference/services/SoftLayer_Search)::advancedSearch + Search for SoftLayer Resources by simple terms. diff --git a/content/reference/services/SoftLayer_Search/getObjectTypes.md b/content/reference/services/SoftLayer_Search/getObjectTypes.md index 9014d1f0e4..9c2cf28a2c 100644 --- a/content/reference/services/SoftLayer_Search/getObjectTypes.md +++ b/content/reference/services/SoftLayer_Search/getObjectTypes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Search](/reference/services/SoftLayer_Search)::getObjectTypes + Return a collection of indexed object types. diff --git a/content/reference/services/SoftLayer_Search/search.md b/content/reference/services/SoftLayer_Search/search.md index a6803bc0d0..2ca5cf2a46 100644 --- a/content/reference/services/SoftLayer_Search/search.md +++ b/content/reference/services/SoftLayer_Search/search.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Search](/reference/services/SoftLayer_Search)::search + Search for SoftLayer Resources by simple phrase. diff --git a/content/reference/services/SoftLayer_Security_Certificate/_index.md b/content/reference/services/SoftLayer_Security_Certificate/_index.md index 8e4e75fefb..108440c2bb 100644 --- a/content/reference/services/SoftLayer_Security_Certificate/_index.md +++ b/content/reference/services/SoftLayer_Security_Certificate/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,54 +44,63 @@ classes: #### [createObject](/reference/services/SoftLayer_Security_Certificate/createObject) +
              #### [deleteObject](/reference/services/SoftLayer_Security_Certificate/deleteObject) +
              #### [editObject](/reference/services/SoftLayer_Security_Certificate/editObject) +
              #### [findByCommonName](/reference/services/SoftLayer_Security_Certificate/findByCommonName) +
              #### [getAssociatedServiceCount](/reference/services/SoftLayer_Security_Certificate/getAssociatedServiceCount) Retrieve the number of services currently associated with the certificate. +
              #### [getLbaasListeners](/reference/services/SoftLayer_Security_Certificate/getLbaasListeners) Retrieve cloud Load Balancer [LBaaS] listeners currently associated with the certificate. +
              #### [getLoadBalancerVirtualIpAddresses](/reference/services/SoftLayer_Security_Certificate/getLoadBalancerVirtualIpAddresses) Retrieve the load balancers virtual IP addresses currently associated with the certificate. +
              #### [getObject](/reference/services/SoftLayer_Security_Certificate/getObject) Retrieve a SoftLayer_Security_Certificate record. +
              #### [getPemFormat](/reference/services/SoftLayer_Security_Certificate/getPemFormat) +
              diff --git a/content/reference/services/SoftLayer_Security_Certificate/createObject.md b/content/reference/services/SoftLayer_Security_Certificate/createObject.md index ac07394a2b..e5ad6a6b34 100644 --- a/content/reference/services/SoftLayer_Security_Certificate/createObject.md +++ b/content/reference/services/SoftLayer_Security_Certificate/createObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview Add a certificate to your account for your records, or for use with various services. Only the certificate and private key are usually required. If your issuer provided an intermediate certificate, you must also provide that certificate. Details will be extracted from the certificate. Validation will be performed between the certificate and the private key as well as the certificate and the intermediate certificate, if provided. diff --git a/content/reference/services/SoftLayer_Security_Certificate/deleteObject.md b/content/reference/services/SoftLayer_Security_Certificate/deleteObject.md index 43b52e44fe..7bb84a5044 100644 --- a/content/reference/services/SoftLayer_Security_Certificate/deleteObject.md +++ b/content/reference/services/SoftLayer_Security_Certificate/deleteObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview Remove a certificate from your account. You may not remove a certificate with associated services. diff --git a/content/reference/services/SoftLayer_Security_Certificate/editObject.md b/content/reference/services/SoftLayer_Security_Certificate/editObject.md index f6695f8163..5c90f7b062 100644 --- a/content/reference/services/SoftLayer_Security_Certificate/editObject.md +++ b/content/reference/services/SoftLayer_Security_Certificate/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview Update a certificate. Modifications are restricted to the note and CSR if the are any services associated with the certificate. There are no modification restrictions for a certificate with no associated services. diff --git a/content/reference/services/SoftLayer_Security_Certificate/findByCommonName.md b/content/reference/services/SoftLayer_Security_Certificate/findByCommonName.md index 779e08325f..07723dccb0 100644 --- a/content/reference/services/SoftLayer_Security_Certificate/findByCommonName.md +++ b/content/reference/services/SoftLayer_Security_Certificate/findByCommonName.md @@ -16,6 +16,7 @@ aliases: + ## Overview Locate certificates by their common name, traditionally a domain name. diff --git a/content/reference/services/SoftLayer_Security_Certificate/getAssociatedServiceCount.md b/content/reference/services/SoftLayer_Security_Certificate/getAssociatedServiceCount.md index ebe3a310b6..43d305890b 100644 --- a/content/reference/services/SoftLayer_Security_Certificate/getAssociatedServiceCount.md +++ b/content/reference/services/SoftLayer_Security_Certificate/getAssociatedServiceCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Certificate](/reference/services/SoftLayer_Security_Certificate)::getAssociatedServiceCount + Retrieve the number of services currently associated with the certificate. diff --git a/content/reference/services/SoftLayer_Security_Certificate/getLbaasListeners.md b/content/reference/services/SoftLayer_Security_Certificate/getLbaasListeners.md index e264609216..885046b0f2 100644 --- a/content/reference/services/SoftLayer_Security_Certificate/getLbaasListeners.md +++ b/content/reference/services/SoftLayer_Security_Certificate/getLbaasListeners.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Certificate](/reference/services/SoftLayer_Security_Certificate)::getLbaasListeners + Retrieve cloud Load Balancer [LBaaS] listeners currently associated with the certificate. diff --git a/content/reference/services/SoftLayer_Security_Certificate/getLoadBalancerVirtualIpAddresses.md b/content/reference/services/SoftLayer_Security_Certificate/getLoadBalancerVirtualIpAddresses.md index 3dbc829d3f..c53045e77e 100644 --- a/content/reference/services/SoftLayer_Security_Certificate/getLoadBalancerVirtualIpAddresses.md +++ b/content/reference/services/SoftLayer_Security_Certificate/getLoadBalancerVirtualIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Certificate](/reference/services/SoftLayer_Security_Certificate)::getLoadBalancerVirtualIpAddresses + Retrieve the load balancers virtual IP addresses currently associated with the certificate. diff --git a/content/reference/services/SoftLayer_Security_Certificate/getObject.md b/content/reference/services/SoftLayer_Security_Certificate/getObject.md index 6a2cc1aeb9..f6b1752c5d 100644 --- a/content/reference/services/SoftLayer_Security_Certificate/getObject.md +++ b/content/reference/services/SoftLayer_Security_Certificate/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Certificate](/reference/services/SoftLayer_Security_Certificate)::getObject + Retrieve a SoftLayer_Security_Certificate record. diff --git a/content/reference/services/SoftLayer_Security_Certificate/getPemFormat.md b/content/reference/services/SoftLayer_Security_Certificate/getPemFormat.md index 9aa1417196..a76a2c32eb 100644 --- a/content/reference/services/SoftLayer_Security_Certificate/getPemFormat.md +++ b/content/reference/services/SoftLayer_Security_Certificate/getPemFormat.md @@ -16,6 +16,7 @@ aliases: + ## Overview Retrieve the certificate in PEM (Privacy Enhanced Mail) format, which is a string containing all base64 encoded (DER) certificates delimited by -----BEGIN/END *----- clauses. diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request/_index.md b/content/reference/services/SoftLayer_Security_Certificate_Request/_index.md index 25c38fa686..2ae0144033 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request/_index.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -44,72 +46,84 @@ To create an SSL certificate order, pass a completed SoftLayer_Container_Product #### [cancelSslOrder](/reference/services/SoftLayer_Security_Certificate_Request/cancelSslOrder) Cancels a pending SSL certificate order at the Certificate Authority +
              #### [getAccount](/reference/services/SoftLayer_Security_Certificate_Request/getAccount) Retrieve the account to which a SSL certificate request belongs. +
              #### [getAdministratorEmailDomains](/reference/services/SoftLayer_Security_Certificate_Request/getAdministratorEmailDomains) +
              #### [getAdministratorEmailPrefixes](/reference/services/SoftLayer_Security_Certificate_Request/getAdministratorEmailPrefixes) +
              #### [getObject](/reference/services/SoftLayer_Security_Certificate_Request/getObject) Retrieve a SoftLayer_Security_Certificate_Request record. +
              #### [getOrder](/reference/services/SoftLayer_Security_Certificate_Request/getOrder) Retrieve the order contains the information related to a SSL certificate request. +
              #### [getOrderItem](/reference/services/SoftLayer_Security_Certificate_Request/getOrderItem) Retrieve the associated order item for this SSL certificate request. +
              #### [getPreviousOrderData](/reference/services/SoftLayer_Security_Certificate_Request/getPreviousOrderData) Returns previous SSL certificate order data. +
              #### [getSslCertificateRequests](/reference/services/SoftLayer_Security_Certificate_Request/getSslCertificateRequests) Returns all the SSL certificate requests +
              #### [getStatus](/reference/services/SoftLayer_Security_Certificate_Request/getStatus) Retrieve the status of a SSL certificate request. +
              #### [resendEmail](/reference/services/SoftLayer_Security_Certificate_Request/resendEmail) Have the Certificate Authority send various emails +
              #### [validateCsr](/reference/services/SoftLayer_Security_Certificate_Request/validateCsr) Validates a Certificate Signing Request (CSR) with the certificate authority (CA). +
              diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request/cancelSslOrder.md b/content/reference/services/SoftLayer_Security_Certificate_Request/cancelSslOrder.md index bab55a6be9..23c8b7be29 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request/cancelSslOrder.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request/cancelSslOrder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Certificate_Request](/reference/services/SoftLayer_Security_Certificate_Request)::cancelSslOrder + Cancels a pending SSL certificate order at the Certificate Authority diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request/getAccount.md b/content/reference/services/SoftLayer_Security_Certificate_Request/getAccount.md index c77bc9e510..9fb47fdaa8 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request/getAccount.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Certificate_Request](/reference/services/SoftLayer_Security_Certificate_Request)::getAccount + Retrieve the account to which a SSL certificate request belongs. diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request/getAdministratorEmailDomains.md b/content/reference/services/SoftLayer_Security_Certificate_Request/getAdministratorEmailDomains.md index 021797525f..f4b34f1b42 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request/getAdministratorEmailDomains.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request/getAdministratorEmailDomains.md @@ -16,6 +16,7 @@ aliases: + ## Overview Gets the email domains that can be used to validate a certificate to a domain. diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request/getAdministratorEmailPrefixes.md b/content/reference/services/SoftLayer_Security_Certificate_Request/getAdministratorEmailPrefixes.md index a8e431a8ad..ecaa759066 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request/getAdministratorEmailPrefixes.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request/getAdministratorEmailPrefixes.md @@ -16,6 +16,7 @@ aliases: + ## Overview Gets the email accounts that can be used to validate a certificate to a domain. diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request/getObject.md b/content/reference/services/SoftLayer_Security_Certificate_Request/getObject.md index 348fbff0ea..bf78a34cbe 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request/getObject.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Certificate_Request](/reference/services/SoftLayer_Security_Certificate_Request)::getObject + Retrieve a SoftLayer_Security_Certificate_Request record. diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request/getOrder.md b/content/reference/services/SoftLayer_Security_Certificate_Request/getOrder.md index b37ede4e81..e10c3cc435 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request/getOrder.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request/getOrder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Certificate_Request](/reference/services/SoftLayer_Security_Certificate_Request)::getOrder + Retrieve the order contains the information related to a SSL certificate request. diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request/getOrderItem.md b/content/reference/services/SoftLayer_Security_Certificate_Request/getOrderItem.md index 53e7dba09d..fa45f38dc4 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request/getOrderItem.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request/getOrderItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Certificate_Request](/reference/services/SoftLayer_Security_Certificate_Request)::getOrderItem + Retrieve the associated order item for this SSL certificate request. diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request/getPreviousOrderData.md b/content/reference/services/SoftLayer_Security_Certificate_Request/getPreviousOrderData.md index 0fb790f5b6..ef7ff9b012 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request/getPreviousOrderData.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request/getPreviousOrderData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Certificate_Request](/reference/services/SoftLayer_Security_Certificate_Request)::getPreviousOrderData + Returns previous SSL certificate order data. diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request/getSslCertificateRequests.md b/content/reference/services/SoftLayer_Security_Certificate_Request/getSslCertificateRequests.md index 49c004d1b4..86a986aee0 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request/getSslCertificateRequests.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request/getSslCertificateRequests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Certificate_Request](/reference/services/SoftLayer_Security_Certificate_Request)::getSslCertificateRequests + Returns all the SSL certificate requests diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request/getStatus.md b/content/reference/services/SoftLayer_Security_Certificate_Request/getStatus.md index 1e3ce25087..31550acf17 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request/getStatus.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request/getStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Certificate_Request](/reference/services/SoftLayer_Security_Certificate_Request)::getStatus + Retrieve the status of a SSL certificate request. diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request/resendEmail.md b/content/reference/services/SoftLayer_Security_Certificate_Request/resendEmail.md index 6b243f45f6..50b3575cba 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request/resendEmail.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request/resendEmail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Certificate_Request](/reference/services/SoftLayer_Security_Certificate_Request)::resendEmail + Have the Certificate Authority send various emails diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request/validateCsr.md b/content/reference/services/SoftLayer_Security_Certificate_Request/validateCsr.md index 7698ef1dc1..2669071ca8 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request/validateCsr.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request/validateCsr.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Certificate_Request](/reference/services/SoftLayer_Security_Certificate_Request)::validateCsr + Validates a Certificate Signing Request (CSR) with the certificate authority (CA). diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request_ServerType/_index.md b/content/reference/services/SoftLayer_Security_Certificate_Request_ServerType/_index.md index bcc710220e..5578673395 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request_ServerType/_index.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request_ServerType/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Allows for retrieving the available SSL certificate server types. @@ -42,12 +44,14 @@ Allows for retrieving the available SSL certificate server types. #### [getAllObjects](/reference/services/SoftLayer_Security_Certificate_Request_ServerType/getAllObjects) Returns all SSL certificate server types +
              #### [getObject](/reference/services/SoftLayer_Security_Certificate_Request_ServerType/getObject) Retrieve a SoftLayer_Security_Certificate_Request_ServerType record. +
              diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request_ServerType/getAllObjects.md b/content/reference/services/SoftLayer_Security_Certificate_Request_ServerType/getAllObjects.md index d63ae3e488..fea20b5ed9 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request_ServerType/getAllObjects.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request_ServerType/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Certificate_Request_ServerType](/reference/services/SoftLayer_Security_Certificate_Request_ServerType)::getAllObjects + Returns all SSL certificate server types diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request_ServerType/getObject.md b/content/reference/services/SoftLayer_Security_Certificate_Request_ServerType/getObject.md index 1b641a325d..6b8a6f2485 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request_ServerType/getObject.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request_ServerType/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Certificate_Request_ServerType](/reference/services/SoftLayer_Security_Certificate_Request_ServerType)::getObject + Retrieve a SoftLayer_Security_Certificate_Request_ServerType record. diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request_Status/_index.md b/content/reference/services/SoftLayer_Security_Certificate_Request_Status/_index.md index 301df4f5bd..78c5ba8979 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request_Status/_index.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}). 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. @@ -46,12 +48,14 @@ There might be a chance that your SSL certificate order could rejected by a CA. #### [getObject](/reference/services/SoftLayer_Security_Certificate_Request_Status/getObject) Retrieve a SoftLayer_Security_Certificate_Request_Status record. +
              #### [getSslRequestStatuses](/reference/services/SoftLayer_Security_Certificate_Request_Status/getSslRequestStatuses) Returns all SSL certificate request status objects +
              diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request_Status/getObject.md b/content/reference/services/SoftLayer_Security_Certificate_Request_Status/getObject.md index 88764f02b1..cb5b228628 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request_Status/getObject.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request_Status/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Certificate_Request_Status](/reference/services/SoftLayer_Security_Certificate_Request_Status)::getObject + Retrieve a SoftLayer_Security_Certificate_Request_Status record. diff --git a/content/reference/services/SoftLayer_Security_Certificate_Request_Status/getSslRequestStatuses.md b/content/reference/services/SoftLayer_Security_Certificate_Request_Status/getSslRequestStatuses.md index b8a1400d95..4253f4d0af 100644 --- a/content/reference/services/SoftLayer_Security_Certificate_Request_Status/getSslRequestStatuses.md +++ b/content/reference/services/SoftLayer_Security_Certificate_Request_Status/getSslRequestStatuses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Certificate_Request_Status](/reference/services/SoftLayer_Security_Certificate_Request_Status)::getSslRequestStatuses + Returns all SSL certificate request status objects diff --git a/content/reference/services/SoftLayer_Security_Ssh_Key/_index.md b/content/reference/services/SoftLayer_Security_Ssh_Key/_index.md index e5655e76f9..2056ffd6ea 100644 --- a/content/reference/services/SoftLayer_Security_Ssh_Key/_index.md +++ b/content/reference/services/SoftLayer_Security_Ssh_Key/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,42 +44,49 @@ classes: #### [createObject](/reference/services/SoftLayer_Security_Ssh_Key/createObject) +
              #### [deleteObject](/reference/services/SoftLayer_Security_Ssh_Key/deleteObject) +
              #### [editObject](/reference/services/SoftLayer_Security_Ssh_Key/editObject) +
              #### [getAccount](/reference/services/SoftLayer_Security_Ssh_Key/getAccount) +
              #### [getBlockDeviceTemplateGroups](/reference/services/SoftLayer_Security_Ssh_Key/getBlockDeviceTemplateGroups) Retrieve the image template groups that are linked to an SSH key. +
              #### [getObject](/reference/services/SoftLayer_Security_Ssh_Key/getObject) Retrieve a SoftLayer_Security_Ssh_Key record. +
              #### [getSoftwarePasswords](/reference/services/SoftLayer_Security_Ssh_Key/getSoftwarePasswords) Retrieve the OS root users that are linked to an SSH key. +
              diff --git a/content/reference/services/SoftLayer_Security_Ssh_Key/createObject.md b/content/reference/services/SoftLayer_Security_Ssh_Key/createObject.md index befd20e192..b98c8d734e 100644 --- a/content/reference/services/SoftLayer_Security_Ssh_Key/createObject.md +++ b/content/reference/services/SoftLayer_Security_Ssh_Key/createObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview Add a ssh key to your account for use during server provisioning and os reloads. diff --git a/content/reference/services/SoftLayer_Security_Ssh_Key/deleteObject.md b/content/reference/services/SoftLayer_Security_Ssh_Key/deleteObject.md index 5170c05ad4..f44bceb918 100644 --- a/content/reference/services/SoftLayer_Security_Ssh_Key/deleteObject.md +++ b/content/reference/services/SoftLayer_Security_Ssh_Key/deleteObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview Remove a ssh key from your account. diff --git a/content/reference/services/SoftLayer_Security_Ssh_Key/editObject.md b/content/reference/services/SoftLayer_Security_Ssh_Key/editObject.md index ee1399a7e5..8a0a9f7234 100644 --- a/content/reference/services/SoftLayer_Security_Ssh_Key/editObject.md +++ b/content/reference/services/SoftLayer_Security_Ssh_Key/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview Update a ssh key. diff --git a/content/reference/services/SoftLayer_Security_Ssh_Key/getAccount.md b/content/reference/services/SoftLayer_Security_Ssh_Key/getAccount.md index b8333efbb5..1ed53f77f3 100644 --- a/content/reference/services/SoftLayer_Security_Ssh_Key/getAccount.md +++ b/content/reference/services/SoftLayer_Security_Ssh_Key/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Security_Ssh_Key/getBlockDeviceTemplateGroups.md b/content/reference/services/SoftLayer_Security_Ssh_Key/getBlockDeviceTemplateGroups.md index f414df9262..85130e7f90 100644 --- a/content/reference/services/SoftLayer_Security_Ssh_Key/getBlockDeviceTemplateGroups.md +++ b/content/reference/services/SoftLayer_Security_Ssh_Key/getBlockDeviceTemplateGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Ssh_Key](/reference/services/SoftLayer_Security_Ssh_Key)::getBlockDeviceTemplateGroups + Retrieve the image template groups that are linked to an SSH key. diff --git a/content/reference/services/SoftLayer_Security_Ssh_Key/getObject.md b/content/reference/services/SoftLayer_Security_Ssh_Key/getObject.md index d1a8a68111..ed4464dd46 100644 --- a/content/reference/services/SoftLayer_Security_Ssh_Key/getObject.md +++ b/content/reference/services/SoftLayer_Security_Ssh_Key/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Ssh_Key](/reference/services/SoftLayer_Security_Ssh_Key)::getObject + Retrieve a SoftLayer_Security_Ssh_Key record. diff --git a/content/reference/services/SoftLayer_Security_Ssh_Key/getSoftwarePasswords.md b/content/reference/services/SoftLayer_Security_Ssh_Key/getSoftwarePasswords.md index acae12dffa..a59853a744 100644 --- a/content/reference/services/SoftLayer_Security_Ssh_Key/getSoftwarePasswords.md +++ b/content/reference/services/SoftLayer_Security_Ssh_Key/getSoftwarePasswords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Security_Ssh_Key](/reference/services/SoftLayer_Security_Ssh_Key)::getSoftwarePasswords + Retrieve the OS root users that are linked to an SSH key. diff --git a/content/reference/services/SoftLayer_Software_AccountLicense/_index.md b/content/reference/services/SoftLayer_Software_AccountLicense/_index.md index 1d3921104f..00d2733d90 100644 --- a/content/reference/services/SoftLayer_Software_AccountLicense/_index.md +++ b/content/reference/services/SoftLayer_Software_AccountLicense/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,30 +52,35 @@ SoftLayer_Software_AccountLicense is the application class that handles a specia #### [getAccount](/reference/services/SoftLayer_Software_AccountLicense/getAccount) Retrieve the customer account this Account License belongs to. +
              #### [getAllObjects](/reference/services/SoftLayer_Software_AccountLicense/getAllObjects) Return all account licenses +
              #### [getBillingItem](/reference/services/SoftLayer_Software_AccountLicense/getBillingItem) Retrieve the billing item for a software account license. +
              #### [getObject](/reference/services/SoftLayer_Software_AccountLicense/getObject) Retrieve a SoftLayer_Software_AccountLicense record. +
              #### [getSoftwareDescription](/reference/services/SoftLayer_Software_AccountLicense/getSoftwareDescription) Retrieve the SoftLayer_Software_Description that this account license is for. +
              diff --git a/content/reference/services/SoftLayer_Software_AccountLicense/getAccount.md b/content/reference/services/SoftLayer_Software_AccountLicense/getAccount.md index fad69001a7..3f3dde1976 100644 --- a/content/reference/services/SoftLayer_Software_AccountLicense/getAccount.md +++ b/content/reference/services/SoftLayer_Software_AccountLicense/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_AccountLicense](/reference/services/SoftLayer_Software_AccountLicense)::getAccount + Retrieve the customer account this Account License belongs to. diff --git a/content/reference/services/SoftLayer_Software_AccountLicense/getAllObjects.md b/content/reference/services/SoftLayer_Software_AccountLicense/getAllObjects.md index 3e2db995a6..6364ae8643 100644 --- a/content/reference/services/SoftLayer_Software_AccountLicense/getAllObjects.md +++ b/content/reference/services/SoftLayer_Software_AccountLicense/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_AccountLicense](/reference/services/SoftLayer_Software_AccountLicense)::getAllObjects + Return all account licenses diff --git a/content/reference/services/SoftLayer_Software_AccountLicense/getBillingItem.md b/content/reference/services/SoftLayer_Software_AccountLicense/getBillingItem.md index a9e3fa33a9..78660e1cf2 100644 --- a/content/reference/services/SoftLayer_Software_AccountLicense/getBillingItem.md +++ b/content/reference/services/SoftLayer_Software_AccountLicense/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_AccountLicense](/reference/services/SoftLayer_Software_AccountLicense)::getBillingItem + Retrieve the billing item for a software account license. diff --git a/content/reference/services/SoftLayer_Software_AccountLicense/getObject.md b/content/reference/services/SoftLayer_Software_AccountLicense/getObject.md index 5521d64a91..8659dbdc4b 100644 --- a/content/reference/services/SoftLayer_Software_AccountLicense/getObject.md +++ b/content/reference/services/SoftLayer_Software_AccountLicense/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_AccountLicense](/reference/services/SoftLayer_Software_AccountLicense)::getObject + Retrieve a SoftLayer_Software_AccountLicense record. diff --git a/content/reference/services/SoftLayer_Software_AccountLicense/getSoftwareDescription.md b/content/reference/services/SoftLayer_Software_AccountLicense/getSoftwareDescription.md index 0bc6f2a674..7e0e3eb8ac 100644 --- a/content/reference/services/SoftLayer_Software_AccountLicense/getSoftwareDescription.md +++ b/content/reference/services/SoftLayer_Software_AccountLicense/getSoftwareDescription.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_AccountLicense](/reference/services/SoftLayer_Software_AccountLicense)::getSoftwareDescription + Retrieve the SoftLayer_Software_Description that this account license is for. diff --git a/content/reference/services/SoftLayer_Software_Component/_index.md b/content/reference/services/SoftLayer_Software_Component/_index.md index d1333a7ba9..a5abcd89eb 100644 --- a/content/reference/services/SoftLayer_Software_Component/_index.md +++ b/content/reference/services/SoftLayer_Software_Component/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,66 +44,77 @@ Every installed piece of software is represented in the API as a "Software Compo #### [getAverageInstallationDuration](/reference/services/SoftLayer_Software_Component/getAverageInstallationDuration) Retrieve the average amount of time that a software component takes to install. +
              #### [getBillingItem](/reference/services/SoftLayer_Software_Component/getBillingItem) Retrieve the billing item for a software component. +
              #### [getHardware](/reference/services/SoftLayer_Software_Component/getHardware) Retrieve the hardware this Software Component is installed upon. +
              #### [getLicenseFile](/reference/services/SoftLayer_Software_Component/getLicenseFile) Get the license file for a software component if it is supported. +
              #### [getObject](/reference/services/SoftLayer_Software_Component/getObject) Retrieve a SoftLayer_Software_Component record. +
              #### [getPasswordHistory](/reference/services/SoftLayer_Software_Component/getPasswordHistory) Retrieve history Records for Software Passwords. +
              #### [getPasswords](/reference/services/SoftLayer_Software_Component/getPasswords) Retrieve username/Password pairs used for access to this Software Installation. +
              #### [getSoftwareDescription](/reference/services/SoftLayer_Software_Component/getSoftwareDescription) Retrieve the Software Description of this Software Component. +
              #### [getSoftwareLicense](/reference/services/SoftLayer_Software_Component/getSoftwareLicense) Retrieve the License this Software Component uses. +
              #### [getVendorSetUpConfiguration](/reference/services/SoftLayer_Software_Component/getVendorSetUpConfiguration) +
              #### [getVirtualGuest](/reference/services/SoftLayer_Software_Component/getVirtualGuest) Retrieve the virtual guest this software component is installed upon. +
              diff --git a/content/reference/services/SoftLayer_Software_Component/getAverageInstallationDuration.md b/content/reference/services/SoftLayer_Software_Component/getAverageInstallationDuration.md index 5afa9f7c00..1e2255db4e 100644 --- a/content/reference/services/SoftLayer_Software_Component/getAverageInstallationDuration.md +++ b/content/reference/services/SoftLayer_Software_Component/getAverageInstallationDuration.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component](/reference/services/SoftLayer_Software_Component)::getAverageInstallationDuration + Retrieve the average amount of time that a software component takes to install. diff --git a/content/reference/services/SoftLayer_Software_Component/getBillingItem.md b/content/reference/services/SoftLayer_Software_Component/getBillingItem.md index 24ea37cf61..0fd09ecd88 100644 --- a/content/reference/services/SoftLayer_Software_Component/getBillingItem.md +++ b/content/reference/services/SoftLayer_Software_Component/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component](/reference/services/SoftLayer_Software_Component)::getBillingItem + Retrieve the billing item for a software component. diff --git a/content/reference/services/SoftLayer_Software_Component/getHardware.md b/content/reference/services/SoftLayer_Software_Component/getHardware.md index faa4c8f5ad..61a55724fc 100644 --- a/content/reference/services/SoftLayer_Software_Component/getHardware.md +++ b/content/reference/services/SoftLayer_Software_Component/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component](/reference/services/SoftLayer_Software_Component)::getHardware + Retrieve the hardware this Software Component is installed upon. diff --git a/content/reference/services/SoftLayer_Software_Component/getLicenseFile.md b/content/reference/services/SoftLayer_Software_Component/getLicenseFile.md index 264d6b8c1a..3668bb7a31 100644 --- a/content/reference/services/SoftLayer_Software_Component/getLicenseFile.md +++ b/content/reference/services/SoftLayer_Software_Component/getLicenseFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component](/reference/services/SoftLayer_Software_Component)::getLicenseFile + Get the license file for a software component if it is supported. diff --git a/content/reference/services/SoftLayer_Software_Component/getObject.md b/content/reference/services/SoftLayer_Software_Component/getObject.md index 496a02a13d..1434e81db5 100644 --- a/content/reference/services/SoftLayer_Software_Component/getObject.md +++ b/content/reference/services/SoftLayer_Software_Component/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component](/reference/services/SoftLayer_Software_Component)::getObject + Retrieve a SoftLayer_Software_Component record. diff --git a/content/reference/services/SoftLayer_Software_Component/getPasswordHistory.md b/content/reference/services/SoftLayer_Software_Component/getPasswordHistory.md index f4e21d97cc..1720844907 100644 --- a/content/reference/services/SoftLayer_Software_Component/getPasswordHistory.md +++ b/content/reference/services/SoftLayer_Software_Component/getPasswordHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component](/reference/services/SoftLayer_Software_Component)::getPasswordHistory + Retrieve history Records for Software Passwords. diff --git a/content/reference/services/SoftLayer_Software_Component/getPasswords.md b/content/reference/services/SoftLayer_Software_Component/getPasswords.md index d2a3412fd0..5987ddb87e 100644 --- a/content/reference/services/SoftLayer_Software_Component/getPasswords.md +++ b/content/reference/services/SoftLayer_Software_Component/getPasswords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component](/reference/services/SoftLayer_Software_Component)::getPasswords + Retrieve username/Password pairs used for access to this Software Installation. diff --git a/content/reference/services/SoftLayer_Software_Component/getSoftwareDescription.md b/content/reference/services/SoftLayer_Software_Component/getSoftwareDescription.md index a15429e36f..5acbe87244 100644 --- a/content/reference/services/SoftLayer_Software_Component/getSoftwareDescription.md +++ b/content/reference/services/SoftLayer_Software_Component/getSoftwareDescription.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component](/reference/services/SoftLayer_Software_Component)::getSoftwareDescription + Retrieve the Software Description of this Software Component. diff --git a/content/reference/services/SoftLayer_Software_Component/getSoftwareLicense.md b/content/reference/services/SoftLayer_Software_Component/getSoftwareLicense.md index 9a72c8e868..02c277a8ac 100644 --- a/content/reference/services/SoftLayer_Software_Component/getSoftwareLicense.md +++ b/content/reference/services/SoftLayer_Software_Component/getSoftwareLicense.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component](/reference/services/SoftLayer_Software_Component)::getSoftwareLicense + Retrieve the License this Software Component uses. diff --git a/content/reference/services/SoftLayer_Software_Component/getVendorSetUpConfiguration.md b/content/reference/services/SoftLayer_Software_Component/getVendorSetUpConfiguration.md index 05af5c70c3..aad24107a9 100644 --- a/content/reference/services/SoftLayer_Software_Component/getVendorSetUpConfiguration.md +++ b/content/reference/services/SoftLayer_Software_Component/getVendorSetUpConfiguration.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Software_Component/getVirtualGuest.md b/content/reference/services/SoftLayer_Software_Component/getVirtualGuest.md index e8b4e58da7..32bb432e6f 100644 --- a/content/reference/services/SoftLayer_Software_Component/getVirtualGuest.md +++ b/content/reference/services/SoftLayer_Software_Component/getVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component](/reference/services/SoftLayer_Software_Component)::getVirtualGuest + Retrieve the virtual guest this software component is installed upon. diff --git a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/_index.md b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/_index.md index 9ed3312f3e..c673094269 100644 --- a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/_index.md +++ b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This object specifies a specific type of Software Component: An Anti-virus/spyware instance. @@ -42,72 +44,84 @@ This object specifies a specific type of Software Component: An Anti-virus/spyw #### [getAverageInstallationDuration](/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getAverageInstallationDuration) Retrieve the average amount of time that a software component takes to install. +
              #### [getBillingItem](/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getBillingItem) Retrieve the billing item for a software component. +
              #### [getHardware](/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getHardware) Retrieve the hardware this Software Component is installed upon. +
              #### [getLicenseFile](/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getLicenseFile) Get the license file for a software component if it is supported. +
              #### [getObject](/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getObject) Retrieve a SoftLayer_Software_Component_AntivirusSpyware record. +
              #### [getPasswordHistory](/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getPasswordHistory) Retrieve history Records for Software Passwords. +
              #### [getPasswords](/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getPasswords) Retrieve username/Password pairs used for access to this Software Installation. +
              #### [getSoftwareDescription](/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getSoftwareDescription) Retrieve the Software Description of this Software Component. +
              #### [getSoftwareLicense](/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getSoftwareLicense) Retrieve the License this Software Component uses. +
              #### [getVendorSetUpConfiguration](/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getVendorSetUpConfiguration) +
              #### [getVirtualGuest](/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getVirtualGuest) Retrieve the virtual guest this software component is installed upon. +
              #### [updateAntivirusSpywarePolicy](/reference/services/SoftLayer_Software_Component_AntivirusSpyware/updateAntivirusSpywarePolicy) Update an anti-virus/spyware policy. +
              diff --git a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getAverageInstallationDuration.md b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getAverageInstallationDuration.md index 811dc9aae8..e772ff19b1 100644 --- a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getAverageInstallationDuration.md +++ b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getAverageInstallationDuration.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_AntivirusSpyware](/reference/services/SoftLayer_Software_Component_AntivirusSpyware)::getAverageInstallationDuration + Retrieve the average amount of time that a software component takes to install. diff --git a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getBillingItem.md b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getBillingItem.md index cc341a8fca..6823411051 100644 --- a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getBillingItem.md +++ b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_AntivirusSpyware](/reference/services/SoftLayer_Software_Component_AntivirusSpyware)::getBillingItem + Retrieve the billing item for a software component. diff --git a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getHardware.md b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getHardware.md index 5c8760de03..48af88be89 100644 --- a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getHardware.md +++ b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_AntivirusSpyware](/reference/services/SoftLayer_Software_Component_AntivirusSpyware)::getHardware + Retrieve the hardware this Software Component is installed upon. diff --git a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getLicenseFile.md b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getLicenseFile.md index 07a195b75e..e6f2a39b9f 100644 --- a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getLicenseFile.md +++ b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getLicenseFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_AntivirusSpyware](/reference/services/SoftLayer_Software_Component_AntivirusSpyware)::getLicenseFile + Get the license file for a software component if it is supported. diff --git a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getObject.md b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getObject.md index 2c56bb0cb3..2fba8202d3 100644 --- a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getObject.md +++ b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_AntivirusSpyware](/reference/services/SoftLayer_Software_Component_AntivirusSpyware)::getObject + Retrieve a SoftLayer_Software_Component_AntivirusSpyware record. diff --git a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getPasswordHistory.md b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getPasswordHistory.md index 76f6f6807b..cee1840d8f 100644 --- a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getPasswordHistory.md +++ b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getPasswordHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_AntivirusSpyware](/reference/services/SoftLayer_Software_Component_AntivirusSpyware)::getPasswordHistory + Retrieve history Records for Software Passwords. diff --git a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getPasswords.md b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getPasswords.md index 1f26e9ce3d..5db121dac8 100644 --- a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getPasswords.md +++ b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getPasswords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_AntivirusSpyware](/reference/services/SoftLayer_Software_Component_AntivirusSpyware)::getPasswords + Retrieve username/Password pairs used for access to this Software Installation. diff --git a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getSoftwareDescription.md b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getSoftwareDescription.md index ab768bb4b0..788f65a5d7 100644 --- a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getSoftwareDescription.md +++ b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getSoftwareDescription.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_AntivirusSpyware](/reference/services/SoftLayer_Software_Component_AntivirusSpyware)::getSoftwareDescription + Retrieve the Software Description of this Software Component. diff --git a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getSoftwareLicense.md b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getSoftwareLicense.md index c763d4d5dc..5ac3ebb697 100644 --- a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getSoftwareLicense.md +++ b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getSoftwareLicense.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_AntivirusSpyware](/reference/services/SoftLayer_Software_Component_AntivirusSpyware)::getSoftwareLicense + Retrieve the License this Software Component uses. diff --git a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getVendorSetUpConfiguration.md b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getVendorSetUpConfiguration.md index 418551b2bb..faa5252168 100644 --- a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getVendorSetUpConfiguration.md +++ b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getVendorSetUpConfiguration.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getVirtualGuest.md b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getVirtualGuest.md index 4d1972e7a3..0cfdceaee8 100644 --- a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getVirtualGuest.md +++ b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/getVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_AntivirusSpyware](/reference/services/SoftLayer_Software_Component_AntivirusSpyware)::getVirtualGuest + Retrieve the virtual guest this software component is installed upon. diff --git a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/updateAntivirusSpywarePolicy.md b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/updateAntivirusSpywarePolicy.md index c3fe39c97a..7c2c8214dc 100644 --- a/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/updateAntivirusSpywarePolicy.md +++ b/content/reference/services/SoftLayer_Software_Component_AntivirusSpyware/updateAntivirusSpywarePolicy.md @@ -16,6 +16,7 @@ aliases: --- # [SoftLayer_Software_Component_AntivirusSpyware](/reference/services/SoftLayer_Software_Component_AntivirusSpyware)::updateAntivirusSpywarePolicy + Update an anti-virus/spyware policy. diff --git a/content/reference/services/SoftLayer_Software_Component_HostIps/_index.md b/content/reference/services/SoftLayer_Software_Component_HostIps/_index.md index 75bc3c7aba..c5006b9f55 100644 --- a/content/reference/services/SoftLayer_Software_Component_HostIps/_index.md +++ b/content/reference/services/SoftLayer_Software_Component_HostIps/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This service specifies a specific type of Software Component: A Host Intrusion Protection System instance. @@ -42,78 +44,91 @@ This service specifies a specific type of Software Component: A Host Intrusion #### [getAverageInstallationDuration](/reference/services/SoftLayer_Software_Component_HostIps/getAverageInstallationDuration) Retrieve the average amount of time that a software component takes to install. +
              #### [getBillingItem](/reference/services/SoftLayer_Software_Component_HostIps/getBillingItem) Retrieve the billing item for a software component. +
              #### [getCurrentHostIpsPolicies](/reference/services/SoftLayer_Software_Component_HostIps/getCurrentHostIpsPolicies) Get the current Host IPS policies. +
              #### [getHardware](/reference/services/SoftLayer_Software_Component_HostIps/getHardware) Retrieve the hardware this Software Component is installed upon. +
              #### [getLicenseFile](/reference/services/SoftLayer_Software_Component_HostIps/getLicenseFile) Get the license file for a software component if it is supported. +
              #### [getObject](/reference/services/SoftLayer_Software_Component_HostIps/getObject) Retrieve a SoftLayer_Software_Component_HostIps record. +
              #### [getPasswordHistory](/reference/services/SoftLayer_Software_Component_HostIps/getPasswordHistory) Retrieve history Records for Software Passwords. +
              #### [getPasswords](/reference/services/SoftLayer_Software_Component_HostIps/getPasswords) Retrieve username/Password pairs used for access to this Software Installation. +
              #### [getSoftwareDescription](/reference/services/SoftLayer_Software_Component_HostIps/getSoftwareDescription) Retrieve the Software Description of this Software Component. +
              #### [getSoftwareLicense](/reference/services/SoftLayer_Software_Component_HostIps/getSoftwareLicense) Retrieve the License this Software Component uses. +
              #### [getVendorSetUpConfiguration](/reference/services/SoftLayer_Software_Component_HostIps/getVendorSetUpConfiguration) +
              #### [getVirtualGuest](/reference/services/SoftLayer_Software_Component_HostIps/getVirtualGuest) Retrieve the virtual guest this software component is installed upon. +
              #### [updateHipsPolicies](/reference/services/SoftLayer_Software_Component_HostIps/updateHipsPolicies) Update the Host IPS policies. +
              diff --git a/content/reference/services/SoftLayer_Software_Component_HostIps/getAverageInstallationDuration.md b/content/reference/services/SoftLayer_Software_Component_HostIps/getAverageInstallationDuration.md index 0f78abc6ff..9492d750a7 100644 --- a/content/reference/services/SoftLayer_Software_Component_HostIps/getAverageInstallationDuration.md +++ b/content/reference/services/SoftLayer_Software_Component_HostIps/getAverageInstallationDuration.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_HostIps](/reference/services/SoftLayer_Software_Component_HostIps)::getAverageInstallationDuration + Retrieve the average amount of time that a software component takes to install. diff --git a/content/reference/services/SoftLayer_Software_Component_HostIps/getBillingItem.md b/content/reference/services/SoftLayer_Software_Component_HostIps/getBillingItem.md index 987ecdc282..8096f76954 100644 --- a/content/reference/services/SoftLayer_Software_Component_HostIps/getBillingItem.md +++ b/content/reference/services/SoftLayer_Software_Component_HostIps/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_HostIps](/reference/services/SoftLayer_Software_Component_HostIps)::getBillingItem + Retrieve the billing item for a software component. diff --git a/content/reference/services/SoftLayer_Software_Component_HostIps/getCurrentHostIpsPolicies.md b/content/reference/services/SoftLayer_Software_Component_HostIps/getCurrentHostIpsPolicies.md index aab85d501a..43bd2ea885 100644 --- a/content/reference/services/SoftLayer_Software_Component_HostIps/getCurrentHostIpsPolicies.md +++ b/content/reference/services/SoftLayer_Software_Component_HostIps/getCurrentHostIpsPolicies.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_HostIps](/reference/services/SoftLayer_Software_Component_HostIps)::getCurrentHostIpsPolicies + Get the current Host IPS policies. diff --git a/content/reference/services/SoftLayer_Software_Component_HostIps/getHardware.md b/content/reference/services/SoftLayer_Software_Component_HostIps/getHardware.md index 0d7b7d74dc..c587eddb8c 100644 --- a/content/reference/services/SoftLayer_Software_Component_HostIps/getHardware.md +++ b/content/reference/services/SoftLayer_Software_Component_HostIps/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_HostIps](/reference/services/SoftLayer_Software_Component_HostIps)::getHardware + Retrieve the hardware this Software Component is installed upon. diff --git a/content/reference/services/SoftLayer_Software_Component_HostIps/getLicenseFile.md b/content/reference/services/SoftLayer_Software_Component_HostIps/getLicenseFile.md index bbcf2f1df1..fae1881d2c 100644 --- a/content/reference/services/SoftLayer_Software_Component_HostIps/getLicenseFile.md +++ b/content/reference/services/SoftLayer_Software_Component_HostIps/getLicenseFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_HostIps](/reference/services/SoftLayer_Software_Component_HostIps)::getLicenseFile + Get the license file for a software component if it is supported. diff --git a/content/reference/services/SoftLayer_Software_Component_HostIps/getObject.md b/content/reference/services/SoftLayer_Software_Component_HostIps/getObject.md index 6b1334dd60..22a20a85c6 100644 --- a/content/reference/services/SoftLayer_Software_Component_HostIps/getObject.md +++ b/content/reference/services/SoftLayer_Software_Component_HostIps/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_HostIps](/reference/services/SoftLayer_Software_Component_HostIps)::getObject + Retrieve a SoftLayer_Software_Component_HostIps record. diff --git a/content/reference/services/SoftLayer_Software_Component_HostIps/getPasswordHistory.md b/content/reference/services/SoftLayer_Software_Component_HostIps/getPasswordHistory.md index 0a48bede29..b66e30ed73 100644 --- a/content/reference/services/SoftLayer_Software_Component_HostIps/getPasswordHistory.md +++ b/content/reference/services/SoftLayer_Software_Component_HostIps/getPasswordHistory.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_HostIps](/reference/services/SoftLayer_Software_Component_HostIps)::getPasswordHistory + Retrieve history Records for Software Passwords. diff --git a/content/reference/services/SoftLayer_Software_Component_HostIps/getPasswords.md b/content/reference/services/SoftLayer_Software_Component_HostIps/getPasswords.md index 51283dfcfd..53d97792d4 100644 --- a/content/reference/services/SoftLayer_Software_Component_HostIps/getPasswords.md +++ b/content/reference/services/SoftLayer_Software_Component_HostIps/getPasswords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_HostIps](/reference/services/SoftLayer_Software_Component_HostIps)::getPasswords + Retrieve username/Password pairs used for access to this Software Installation. diff --git a/content/reference/services/SoftLayer_Software_Component_HostIps/getSoftwareDescription.md b/content/reference/services/SoftLayer_Software_Component_HostIps/getSoftwareDescription.md index cb361c6ba6..d757489dbc 100644 --- a/content/reference/services/SoftLayer_Software_Component_HostIps/getSoftwareDescription.md +++ b/content/reference/services/SoftLayer_Software_Component_HostIps/getSoftwareDescription.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_HostIps](/reference/services/SoftLayer_Software_Component_HostIps)::getSoftwareDescription + Retrieve the Software Description of this Software Component. diff --git a/content/reference/services/SoftLayer_Software_Component_HostIps/getSoftwareLicense.md b/content/reference/services/SoftLayer_Software_Component_HostIps/getSoftwareLicense.md index 1019045d20..4cc771e83f 100644 --- a/content/reference/services/SoftLayer_Software_Component_HostIps/getSoftwareLicense.md +++ b/content/reference/services/SoftLayer_Software_Component_HostIps/getSoftwareLicense.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_HostIps](/reference/services/SoftLayer_Software_Component_HostIps)::getSoftwareLicense + Retrieve the License this Software Component uses. diff --git a/content/reference/services/SoftLayer_Software_Component_HostIps/getVendorSetUpConfiguration.md b/content/reference/services/SoftLayer_Software_Component_HostIps/getVendorSetUpConfiguration.md index e743da4940..367448f424 100644 --- a/content/reference/services/SoftLayer_Software_Component_HostIps/getVendorSetUpConfiguration.md +++ b/content/reference/services/SoftLayer_Software_Component_HostIps/getVendorSetUpConfiguration.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Software_Component_HostIps/getVirtualGuest.md b/content/reference/services/SoftLayer_Software_Component_HostIps/getVirtualGuest.md index d6ecb8e0bd..d59df14572 100644 --- a/content/reference/services/SoftLayer_Software_Component_HostIps/getVirtualGuest.md +++ b/content/reference/services/SoftLayer_Software_Component_HostIps/getVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_HostIps](/reference/services/SoftLayer_Software_Component_HostIps)::getVirtualGuest + Retrieve the virtual guest this software component is installed upon. diff --git a/content/reference/services/SoftLayer_Software_Component_HostIps/updateHipsPolicies.md b/content/reference/services/SoftLayer_Software_Component_HostIps/updateHipsPolicies.md index 10b61fe30e..4f68573616 100644 --- a/content/reference/services/SoftLayer_Software_Component_HostIps/updateHipsPolicies.md +++ b/content/reference/services/SoftLayer_Software_Component_HostIps/updateHipsPolicies.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_HostIps](/reference/services/SoftLayer_Software_Component_HostIps)::updateHipsPolicies + Update the Host IPS policies. diff --git a/content/reference/services/SoftLayer_Software_Component_Password/_index.md b/content/reference/services/SoftLayer_Software_Component_Password/_index.md index 70e958e162..fce6f3f09c 100644 --- a/content/reference/services/SoftLayer_Software_Component_Password/_index.md +++ b/content/reference/services/SoftLayer_Software_Component_Password/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,54 +44,63 @@ The software component password service represents the passwords for a software #### [createObject](/reference/services/SoftLayer_Software_Component_Password/createObject) Create a password for a software component. +
              #### [createObjects](/reference/services/SoftLayer_Software_Component_Password/createObjects) Create more than one password for a software component. +
              #### [deleteObject](/reference/services/SoftLayer_Software_Component_Password/deleteObject) Delete a password from a software component. +
              #### [deleteObjects](/reference/services/SoftLayer_Software_Component_Password/deleteObjects) Delete more than one passwords from a software component. +
              #### [editObject](/reference/services/SoftLayer_Software_Component_Password/editObject) Edit the properties of a software component password. +
              #### [editObjects](/reference/services/SoftLayer_Software_Component_Password/editObjects) Edit more than one password from a software component. +
              #### [getObject](/reference/services/SoftLayer_Software_Component_Password/getObject) Retrieve a SoftLayer_Software_Component_Password record. +
              #### [getSoftware](/reference/services/SoftLayer_Software_Component_Password/getSoftware) Retrieve the SoftLayer_Software_Component instance that this username/password pair is valid for. +
              #### [getSshKeys](/reference/services/SoftLayer_Software_Component_Password/getSshKeys) Retrieve sSH keys to be installed on the server during provisioning or an OS reload. +
              diff --git a/content/reference/services/SoftLayer_Software_Component_Password/createObject.md b/content/reference/services/SoftLayer_Software_Component_Password/createObject.md index 3356b91391..368e726e1d 100644 --- a/content/reference/services/SoftLayer_Software_Component_Password/createObject.md +++ b/content/reference/services/SoftLayer_Software_Component_Password/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_Password](/reference/services/SoftLayer_Software_Component_Password)::createObject + Create a password for a software component. diff --git a/content/reference/services/SoftLayer_Software_Component_Password/createObjects.md b/content/reference/services/SoftLayer_Software_Component_Password/createObjects.md index a2981372ec..4718ffdcb5 100644 --- a/content/reference/services/SoftLayer_Software_Component_Password/createObjects.md +++ b/content/reference/services/SoftLayer_Software_Component_Password/createObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_Password](/reference/services/SoftLayer_Software_Component_Password)::createObjects + Create more than one password for a software component. diff --git a/content/reference/services/SoftLayer_Software_Component_Password/deleteObject.md b/content/reference/services/SoftLayer_Software_Component_Password/deleteObject.md index 3c3c652094..c9f15a825d 100644 --- a/content/reference/services/SoftLayer_Software_Component_Password/deleteObject.md +++ b/content/reference/services/SoftLayer_Software_Component_Password/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_Password](/reference/services/SoftLayer_Software_Component_Password)::deleteObject + Delete a password from a software component. diff --git a/content/reference/services/SoftLayer_Software_Component_Password/deleteObjects.md b/content/reference/services/SoftLayer_Software_Component_Password/deleteObjects.md index 5db6887195..80807e1407 100644 --- a/content/reference/services/SoftLayer_Software_Component_Password/deleteObjects.md +++ b/content/reference/services/SoftLayer_Software_Component_Password/deleteObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_Password](/reference/services/SoftLayer_Software_Component_Password)::deleteObjects + Delete more than one passwords from a software component. diff --git a/content/reference/services/SoftLayer_Software_Component_Password/editObject.md b/content/reference/services/SoftLayer_Software_Component_Password/editObject.md index da5c0286e9..3126ce6a66 100644 --- a/content/reference/services/SoftLayer_Software_Component_Password/editObject.md +++ b/content/reference/services/SoftLayer_Software_Component_Password/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_Password](/reference/services/SoftLayer_Software_Component_Password)::editObject + Edit the properties of a software component password. diff --git a/content/reference/services/SoftLayer_Software_Component_Password/editObjects.md b/content/reference/services/SoftLayer_Software_Component_Password/editObjects.md index fd29510e7a..f1d6cc8f46 100644 --- a/content/reference/services/SoftLayer_Software_Component_Password/editObjects.md +++ b/content/reference/services/SoftLayer_Software_Component_Password/editObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_Password](/reference/services/SoftLayer_Software_Component_Password)::editObjects + Edit more than one password from a software component. diff --git a/content/reference/services/SoftLayer_Software_Component_Password/getObject.md b/content/reference/services/SoftLayer_Software_Component_Password/getObject.md index 7d5c7e9896..a2ddcc2e64 100644 --- a/content/reference/services/SoftLayer_Software_Component_Password/getObject.md +++ b/content/reference/services/SoftLayer_Software_Component_Password/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_Password](/reference/services/SoftLayer_Software_Component_Password)::getObject + Retrieve a SoftLayer_Software_Component_Password record. diff --git a/content/reference/services/SoftLayer_Software_Component_Password/getSoftware.md b/content/reference/services/SoftLayer_Software_Component_Password/getSoftware.md index 1241e7aed8..56e854520a 100644 --- a/content/reference/services/SoftLayer_Software_Component_Password/getSoftware.md +++ b/content/reference/services/SoftLayer_Software_Component_Password/getSoftware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_Password](/reference/services/SoftLayer_Software_Component_Password)::getSoftware + Retrieve the SoftLayer_Software_Component instance that this username/password pair is valid for. diff --git a/content/reference/services/SoftLayer_Software_Component_Password/getSshKeys.md b/content/reference/services/SoftLayer_Software_Component_Password/getSshKeys.md index 3f5ca91285..20dd05b0c7 100644 --- a/content/reference/services/SoftLayer_Software_Component_Password/getSshKeys.md +++ b/content/reference/services/SoftLayer_Software_Component_Password/getSshKeys.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Component_Password](/reference/services/SoftLayer_Software_Component_Password)::getSshKeys + Retrieve sSH keys to be installed on the server during provisioning or an OS reload. diff --git a/content/reference/services/SoftLayer_Software_Description/_index.md b/content/reference/services/SoftLayer_Software_Description/_index.md index b6bd0bc65f..43ffe9b0ca 100644 --- a/content/reference/services/SoftLayer_Software_Description/_index.md +++ b/content/reference/services/SoftLayer_Software_Description/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,96 +44,112 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Software_Description/getAllObjects) +
              #### [getAttributes](/reference/services/SoftLayer_Software_Description/getAttributes) +
              #### [getAverageInstallationDuration](/reference/services/SoftLayer_Software_Description/getAverageInstallationDuration) Retrieve the average amount of time that a software description takes to install. +
              #### [getCompatibleSoftwareDescriptions](/reference/services/SoftLayer_Software_Description/getCompatibleSoftwareDescriptions) Retrieve a list of the software descriptions that are compatible with this software description. +
              #### [getCustomerOwnedLicenseDescriptions](/reference/services/SoftLayer_Software_Description/getCustomerOwnedLicenseDescriptions) +
              #### [getFeatures](/reference/services/SoftLayer_Software_Description/getFeatures) Retrieve the feature attributes of a software description. +
              #### [getLatestVersion](/reference/services/SoftLayer_Software_Description/getLatestVersion) Retrieve the latest version of a software description. +
              #### [getObject](/reference/services/SoftLayer_Software_Description/getObject) Retrieve a SoftLayer_Software_Description record. +
              #### [getProductItems](/reference/services/SoftLayer_Software_Description/getProductItems) Retrieve the various product items to which this software description is linked. +
              #### [getProvisionTransactionGroup](/reference/services/SoftLayer_Software_Description/getProvisionTransactionGroup) Retrieve this details the provisioning transaction group for this software. This is only valid for Operating System software. +
              #### [getReloadTransactionGroup](/reference/services/SoftLayer_Software_Description/getReloadTransactionGroup) Retrieve the transaction group that a software description belongs to. A transaction group is a sequence of transactions that must be performed in a specific order for the installation of software. +
              #### [getRequiredUser](/reference/services/SoftLayer_Software_Description/getRequiredUser) Retrieve the default user created for a given a software description. +
              #### [getSoftwareLicenses](/reference/services/SoftLayer_Software_Description/getSoftwareLicenses) Retrieve software Licenses that govern this Software Description. +
              #### [getUpgradeSoftwareDescription](/reference/services/SoftLayer_Software_Description/getUpgradeSoftwareDescription) Retrieve a suggestion for an upgrade path from this Software Description +
              #### [getUpgradeSwDesc](/reference/services/SoftLayer_Software_Description/getUpgradeSwDesc) Retrieve a suggestion for an upgrade path from this Software Description (Deprecated - Use upgradeSoftwareDescription) +
              #### [getValidFilesystemTypes](/reference/services/SoftLayer_Software_Description/getValidFilesystemTypes) +
              diff --git a/content/reference/services/SoftLayer_Software_Description/getAllObjects.md b/content/reference/services/SoftLayer_Software_Description/getAllObjects.md index aaec9f1c7e..4cbb075b3d 100644 --- a/content/reference/services/SoftLayer_Software_Description/getAllObjects.md +++ b/content/reference/services/SoftLayer_Software_Description/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Software_Description/getAttributes.md b/content/reference/services/SoftLayer_Software_Description/getAttributes.md index 1021c017d7..89789989a2 100644 --- a/content/reference/services/SoftLayer_Software_Description/getAttributes.md +++ b/content/reference/services/SoftLayer_Software_Description/getAttributes.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Software_Description/getAverageInstallationDuration.md b/content/reference/services/SoftLayer_Software_Description/getAverageInstallationDuration.md index bdc590d9ed..f2a45ec6f9 100644 --- a/content/reference/services/SoftLayer_Software_Description/getAverageInstallationDuration.md +++ b/content/reference/services/SoftLayer_Software_Description/getAverageInstallationDuration.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Description](/reference/services/SoftLayer_Software_Description)::getAverageInstallationDuration + Retrieve the average amount of time that a software description takes to install. diff --git a/content/reference/services/SoftLayer_Software_Description/getCompatibleSoftwareDescriptions.md b/content/reference/services/SoftLayer_Software_Description/getCompatibleSoftwareDescriptions.md index 5ed7b87b94..109a38699f 100644 --- a/content/reference/services/SoftLayer_Software_Description/getCompatibleSoftwareDescriptions.md +++ b/content/reference/services/SoftLayer_Software_Description/getCompatibleSoftwareDescriptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Description](/reference/services/SoftLayer_Software_Description)::getCompatibleSoftwareDescriptions + Retrieve a list of the software descriptions that are compatible with this software description. diff --git a/content/reference/services/SoftLayer_Software_Description/getCustomerOwnedLicenseDescriptions.md b/content/reference/services/SoftLayer_Software_Description/getCustomerOwnedLicenseDescriptions.md index 9ba7d6ab1d..58749d16e1 100644 --- a/content/reference/services/SoftLayer_Software_Description/getCustomerOwnedLicenseDescriptions.md +++ b/content/reference/services/SoftLayer_Software_Description/getCustomerOwnedLicenseDescriptions.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Software_Description/getFeatures.md b/content/reference/services/SoftLayer_Software_Description/getFeatures.md index 519f1789de..2b72cd6967 100644 --- a/content/reference/services/SoftLayer_Software_Description/getFeatures.md +++ b/content/reference/services/SoftLayer_Software_Description/getFeatures.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Description](/reference/services/SoftLayer_Software_Description)::getFeatures + Retrieve the feature attributes of a software description. diff --git a/content/reference/services/SoftLayer_Software_Description/getLatestVersion.md b/content/reference/services/SoftLayer_Software_Description/getLatestVersion.md index d8bf676e2f..e10d2cc682 100644 --- a/content/reference/services/SoftLayer_Software_Description/getLatestVersion.md +++ b/content/reference/services/SoftLayer_Software_Description/getLatestVersion.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Description](/reference/services/SoftLayer_Software_Description)::getLatestVersion + Retrieve the latest version of a software description. diff --git a/content/reference/services/SoftLayer_Software_Description/getObject.md b/content/reference/services/SoftLayer_Software_Description/getObject.md index 9849f11db5..aceac6eff6 100644 --- a/content/reference/services/SoftLayer_Software_Description/getObject.md +++ b/content/reference/services/SoftLayer_Software_Description/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Description](/reference/services/SoftLayer_Software_Description)::getObject + Retrieve a SoftLayer_Software_Description record. diff --git a/content/reference/services/SoftLayer_Software_Description/getProductItems.md b/content/reference/services/SoftLayer_Software_Description/getProductItems.md index eed14b3da4..13030e7f78 100644 --- a/content/reference/services/SoftLayer_Software_Description/getProductItems.md +++ b/content/reference/services/SoftLayer_Software_Description/getProductItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Description](/reference/services/SoftLayer_Software_Description)::getProductItems + Retrieve the various product items to which this software description is linked. diff --git a/content/reference/services/SoftLayer_Software_Description/getProvisionTransactionGroup.md b/content/reference/services/SoftLayer_Software_Description/getProvisionTransactionGroup.md index c57470b900..14e1575d75 100644 --- a/content/reference/services/SoftLayer_Software_Description/getProvisionTransactionGroup.md +++ b/content/reference/services/SoftLayer_Software_Description/getProvisionTransactionGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Description](/reference/services/SoftLayer_Software_Description)::getProvisionTransactionGroup + Retrieve this details the provisioning transaction group for this software. This is only valid for Operating System software. diff --git a/content/reference/services/SoftLayer_Software_Description/getReloadTransactionGroup.md b/content/reference/services/SoftLayer_Software_Description/getReloadTransactionGroup.md index 7294a30ad3..53077431dd 100644 --- a/content/reference/services/SoftLayer_Software_Description/getReloadTransactionGroup.md +++ b/content/reference/services/SoftLayer_Software_Description/getReloadTransactionGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Description](/reference/services/SoftLayer_Software_Description)::getReloadTransactionGroup + Retrieve the transaction group that a software description belongs to. A transaction group is a sequence of transactions that must be performed in a specific order for the installation of software. diff --git a/content/reference/services/SoftLayer_Software_Description/getRequiredUser.md b/content/reference/services/SoftLayer_Software_Description/getRequiredUser.md index 4bcbfdfd80..a8edb41dbf 100644 --- a/content/reference/services/SoftLayer_Software_Description/getRequiredUser.md +++ b/content/reference/services/SoftLayer_Software_Description/getRequiredUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Description](/reference/services/SoftLayer_Software_Description)::getRequiredUser + Retrieve the default user created for a given a software description. diff --git a/content/reference/services/SoftLayer_Software_Description/getSoftwareLicenses.md b/content/reference/services/SoftLayer_Software_Description/getSoftwareLicenses.md index 0910af78dc..5fed4d8129 100644 --- a/content/reference/services/SoftLayer_Software_Description/getSoftwareLicenses.md +++ b/content/reference/services/SoftLayer_Software_Description/getSoftwareLicenses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Description](/reference/services/SoftLayer_Software_Description)::getSoftwareLicenses + Retrieve software Licenses that govern this Software Description. diff --git a/content/reference/services/SoftLayer_Software_Description/getUpgradeSoftwareDescription.md b/content/reference/services/SoftLayer_Software_Description/getUpgradeSoftwareDescription.md index 295c6d90bd..f266b8cb98 100644 --- a/content/reference/services/SoftLayer_Software_Description/getUpgradeSoftwareDescription.md +++ b/content/reference/services/SoftLayer_Software_Description/getUpgradeSoftwareDescription.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Description](/reference/services/SoftLayer_Software_Description)::getUpgradeSoftwareDescription + Retrieve a suggestion for an upgrade path from this Software Description diff --git a/content/reference/services/SoftLayer_Software_Description/getUpgradeSwDesc.md b/content/reference/services/SoftLayer_Software_Description/getUpgradeSwDesc.md index 012cd35239..a42a39b79e 100644 --- a/content/reference/services/SoftLayer_Software_Description/getUpgradeSwDesc.md +++ b/content/reference/services/SoftLayer_Software_Description/getUpgradeSwDesc.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_Description](/reference/services/SoftLayer_Software_Description)::getUpgradeSwDesc + Retrieve a suggestion for an upgrade path from this Software Description (Deprecated - Use upgradeSoftwareDescription) diff --git a/content/reference/services/SoftLayer_Software_Description/getValidFilesystemTypes.md b/content/reference/services/SoftLayer_Software_Description/getValidFilesystemTypes.md index 1164cad553..eb6a368b50 100644 --- a/content/reference/services/SoftLayer_Software_Description/getValidFilesystemTypes.md +++ b/content/reference/services/SoftLayer_Software_Description/getValidFilesystemTypes.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Software_VirtualLicense/_index.md b/content/reference/services/SoftLayer_Software_VirtualLicense/_index.md index 1d1e5b6c28..57df3e960d 100644 --- a/content/reference/services/SoftLayer_Software_VirtualLicense/_index.md +++ b/content/reference/services/SoftLayer_Software_VirtualLicense/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -54,48 +56,56 @@ You can also retrieve the subnet that the IP to which a software virtual license #### [getAccount](/reference/services/SoftLayer_Software_VirtualLicense/getAccount) Retrieve the customer account this Virtual License belongs to. +
              #### [getBillingItem](/reference/services/SoftLayer_Software_VirtualLicense/getBillingItem) Retrieve the billing item for a software virtual license. +
              #### [getHostHardware](/reference/services/SoftLayer_Software_VirtualLicense/getHostHardware) Retrieve the hardware record to which the software virtual license is assigned. +
              #### [getIpAddressRecord](/reference/services/SoftLayer_Software_VirtualLicense/getIpAddressRecord) Retrieve the IP Address record associated with a virtual license. +
              #### [getLicenseFile](/reference/services/SoftLayer_Software_VirtualLicense/getLicenseFile) Get the file for a virtual license, if it exists +
              #### [getObject](/reference/services/SoftLayer_Software_VirtualLicense/getObject) Retrieve a SoftLayer_Software_VirtualLicense record. +
              #### [getSoftwareDescription](/reference/services/SoftLayer_Software_VirtualLicense/getSoftwareDescription) Retrieve the SoftLayer_Software_Description that this virtual license is for. +
              #### [getSubnet](/reference/services/SoftLayer_Software_VirtualLicense/getSubnet) Retrieve the subnet this Virtual License's IP address belongs to. +
              diff --git a/content/reference/services/SoftLayer_Software_VirtualLicense/getAccount.md b/content/reference/services/SoftLayer_Software_VirtualLicense/getAccount.md index a441d51c57..58b457fca6 100644 --- a/content/reference/services/SoftLayer_Software_VirtualLicense/getAccount.md +++ b/content/reference/services/SoftLayer_Software_VirtualLicense/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_VirtualLicense](/reference/services/SoftLayer_Software_VirtualLicense)::getAccount + Retrieve the customer account this Virtual License belongs to. diff --git a/content/reference/services/SoftLayer_Software_VirtualLicense/getBillingItem.md b/content/reference/services/SoftLayer_Software_VirtualLicense/getBillingItem.md index 7873bcee9e..c65863b6d8 100644 --- a/content/reference/services/SoftLayer_Software_VirtualLicense/getBillingItem.md +++ b/content/reference/services/SoftLayer_Software_VirtualLicense/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_VirtualLicense](/reference/services/SoftLayer_Software_VirtualLicense)::getBillingItem + Retrieve the billing item for a software virtual license. diff --git a/content/reference/services/SoftLayer_Software_VirtualLicense/getHostHardware.md b/content/reference/services/SoftLayer_Software_VirtualLicense/getHostHardware.md index 590e65b87d..60775c87bb 100644 --- a/content/reference/services/SoftLayer_Software_VirtualLicense/getHostHardware.md +++ b/content/reference/services/SoftLayer_Software_VirtualLicense/getHostHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_VirtualLicense](/reference/services/SoftLayer_Software_VirtualLicense)::getHostHardware + Retrieve the hardware record to which the software virtual license is assigned. diff --git a/content/reference/services/SoftLayer_Software_VirtualLicense/getIpAddressRecord.md b/content/reference/services/SoftLayer_Software_VirtualLicense/getIpAddressRecord.md index 562365c34d..7c36574094 100644 --- a/content/reference/services/SoftLayer_Software_VirtualLicense/getIpAddressRecord.md +++ b/content/reference/services/SoftLayer_Software_VirtualLicense/getIpAddressRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_VirtualLicense](/reference/services/SoftLayer_Software_VirtualLicense)::getIpAddressRecord + Retrieve the IP Address record associated with a virtual license. diff --git a/content/reference/services/SoftLayer_Software_VirtualLicense/getLicenseFile.md b/content/reference/services/SoftLayer_Software_VirtualLicense/getLicenseFile.md index b90d851a7e..eb81e0c3de 100644 --- a/content/reference/services/SoftLayer_Software_VirtualLicense/getLicenseFile.md +++ b/content/reference/services/SoftLayer_Software_VirtualLicense/getLicenseFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_VirtualLicense](/reference/services/SoftLayer_Software_VirtualLicense)::getLicenseFile + Get the file for a virtual license, if it exists diff --git a/content/reference/services/SoftLayer_Software_VirtualLicense/getObject.md b/content/reference/services/SoftLayer_Software_VirtualLicense/getObject.md index 4d2938b868..5ec520153c 100644 --- a/content/reference/services/SoftLayer_Software_VirtualLicense/getObject.md +++ b/content/reference/services/SoftLayer_Software_VirtualLicense/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_VirtualLicense](/reference/services/SoftLayer_Software_VirtualLicense)::getObject + Retrieve a SoftLayer_Software_VirtualLicense record. diff --git a/content/reference/services/SoftLayer_Software_VirtualLicense/getSoftwareDescription.md b/content/reference/services/SoftLayer_Software_VirtualLicense/getSoftwareDescription.md index bd790d4511..cfb25d9f78 100644 --- a/content/reference/services/SoftLayer_Software_VirtualLicense/getSoftwareDescription.md +++ b/content/reference/services/SoftLayer_Software_VirtualLicense/getSoftwareDescription.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_VirtualLicense](/reference/services/SoftLayer_Software_VirtualLicense)::getSoftwareDescription + Retrieve the SoftLayer_Software_Description that this virtual license is for. diff --git a/content/reference/services/SoftLayer_Software_VirtualLicense/getSubnet.md b/content/reference/services/SoftLayer_Software_VirtualLicense/getSubnet.md index 3d7be38233..20b55a0f5f 100644 --- a/content/reference/services/SoftLayer_Software_VirtualLicense/getSubnet.md +++ b/content/reference/services/SoftLayer_Software_VirtualLicense/getSubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Software_VirtualLicense](/reference/services/SoftLayer_Software_VirtualLicense)::getSubnet + Retrieve the subnet this Virtual License's IP address belongs to. diff --git a/content/reference/services/SoftLayer_Survey/_index.md b/content/reference/services/SoftLayer_Survey/_index.md index 4583fbe2b7..3f8b7ff618 100644 --- a/content/reference/services/SoftLayer_Survey/_index.md +++ b/content/reference/services/SoftLayer_Survey/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Every SoftLayer survey is defined in the SoftLayer_Survey service. Softlayer survey's have questions and answers from SoftLayer users. @@ -42,36 +44,42 @@ Every SoftLayer survey is defined in the SoftLayer_Survey service. Softlayer sur #### [getActiveSurveyByType](/reference/services/SoftLayer_Survey/getActiveSurveyByType) Provides survey details for the given type +
              #### [getObject](/reference/services/SoftLayer_Survey/getObject) Retrieve a SoftLayer_Survey record. +
              #### [getQuestions](/reference/services/SoftLayer_Survey/getQuestions) Retrieve the questions for a survey. +
              #### [getStatus](/reference/services/SoftLayer_Survey/getStatus) Retrieve the status of the survey +
              #### [getType](/reference/services/SoftLayer_Survey/getType) Retrieve the type of survey +
              #### [takeSurvey](/reference/services/SoftLayer_Survey/takeSurvey) Respond to the questions that a survey has. +
              diff --git a/content/reference/services/SoftLayer_Survey/getActiveSurveyByType.md b/content/reference/services/SoftLayer_Survey/getActiveSurveyByType.md index ee5f7916fd..8c0924c18e 100644 --- a/content/reference/services/SoftLayer_Survey/getActiveSurveyByType.md +++ b/content/reference/services/SoftLayer_Survey/getActiveSurveyByType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Survey](/reference/services/SoftLayer_Survey)::getActiveSurveyByType + Provides survey details for the given type diff --git a/content/reference/services/SoftLayer_Survey/getObject.md b/content/reference/services/SoftLayer_Survey/getObject.md index 8f633e6770..c93c642805 100644 --- a/content/reference/services/SoftLayer_Survey/getObject.md +++ b/content/reference/services/SoftLayer_Survey/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Survey](/reference/services/SoftLayer_Survey)::getObject + Retrieve a SoftLayer_Survey record. diff --git a/content/reference/services/SoftLayer_Survey/getQuestions.md b/content/reference/services/SoftLayer_Survey/getQuestions.md index a044b0234d..c1b0a54aa6 100644 --- a/content/reference/services/SoftLayer_Survey/getQuestions.md +++ b/content/reference/services/SoftLayer_Survey/getQuestions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Survey](/reference/services/SoftLayer_Survey)::getQuestions + Retrieve the questions for a survey. diff --git a/content/reference/services/SoftLayer_Survey/getStatus.md b/content/reference/services/SoftLayer_Survey/getStatus.md index 38f93cc706..961b39f08f 100644 --- a/content/reference/services/SoftLayer_Survey/getStatus.md +++ b/content/reference/services/SoftLayer_Survey/getStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Survey](/reference/services/SoftLayer_Survey)::getStatus + Retrieve the status of the survey diff --git a/content/reference/services/SoftLayer_Survey/getType.md b/content/reference/services/SoftLayer_Survey/getType.md index fe8ab5f97b..17743fd606 100644 --- a/content/reference/services/SoftLayer_Survey/getType.md +++ b/content/reference/services/SoftLayer_Survey/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Survey](/reference/services/SoftLayer_Survey)::getType + Retrieve the type of survey diff --git a/content/reference/services/SoftLayer_Survey/takeSurvey.md b/content/reference/services/SoftLayer_Survey/takeSurvey.md index ceece7bca4..191326a2c5 100644 --- a/content/reference/services/SoftLayer_Survey/takeSurvey.md +++ b/content/reference/services/SoftLayer_Survey/takeSurvey.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Survey](/reference/services/SoftLayer_Survey)::takeSurvey + Respond to the questions that a survey has. diff --git a/content/reference/services/SoftLayer_Tag/_index.md b/content/reference/services/SoftLayer_Tag/_index.md index 9d0098617e..66b72726ea 100644 --- a/content/reference/services/SoftLayer_Tag/_index.md +++ b/content/reference/services/SoftLayer_Tag/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer's tagging service gives customers the ability to tag devices with keywords that can later be used to search upon. @@ -42,60 +44,70 @@ SoftLayer's tagging service gives customers the ability to tag devices with keyw #### [autoComplete](/reference/services/SoftLayer_Tag/autoComplete) Autocomplete tag inputted by a user. +
              #### [deleteTag](/reference/services/SoftLayer_Tag/deleteTag) delete tag for a given object. +
              #### [getAccount](/reference/services/SoftLayer_Tag/getAccount) Retrieve the account to which the tag is tied. +
              #### [getAllTagTypes](/reference/services/SoftLayer_Tag/getAllTagTypes) Get all valid tag types. +
              #### [getAttachedTagsForCurrentUser](/reference/services/SoftLayer_Tag/getAttachedTagsForCurrentUser) Get the tags attached to references. +
              #### [getObject](/reference/services/SoftLayer_Tag/getObject) Retrieve a SoftLayer_Tag record. +
              #### [getReferences](/reference/services/SoftLayer_Tag/getReferences) Retrieve references that tie object to the tag. +
              #### [getTagByTagName](/reference/services/SoftLayer_Tag/getTagByTagName) Get the tag object based on what the user inputs. +
              #### [getUnattachedTagsForCurrentUser](/reference/services/SoftLayer_Tag/getUnattachedTagsForCurrentUser) Get the tags not attached to references. +
              #### [setTags](/reference/services/SoftLayer_Tag/setTags) Set the tags for a given object. +
              diff --git a/content/reference/services/SoftLayer_Tag/autoComplete.md b/content/reference/services/SoftLayer_Tag/autoComplete.md index fc64bb4b11..d986e63930 100644 --- a/content/reference/services/SoftLayer_Tag/autoComplete.md +++ b/content/reference/services/SoftLayer_Tag/autoComplete.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Tag](/reference/services/SoftLayer_Tag)::autoComplete + Autocomplete tag inputted by a user. diff --git a/content/reference/services/SoftLayer_Tag/deleteTag.md b/content/reference/services/SoftLayer_Tag/deleteTag.md index 177268a99c..89f378454f 100644 --- a/content/reference/services/SoftLayer_Tag/deleteTag.md +++ b/content/reference/services/SoftLayer_Tag/deleteTag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Tag](/reference/services/SoftLayer_Tag)::deleteTag + delete tag for a given object. diff --git a/content/reference/services/SoftLayer_Tag/getAccount.md b/content/reference/services/SoftLayer_Tag/getAccount.md index 47777d5dfa..333784f0b0 100644 --- a/content/reference/services/SoftLayer_Tag/getAccount.md +++ b/content/reference/services/SoftLayer_Tag/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Tag](/reference/services/SoftLayer_Tag)::getAccount + Retrieve the account to which the tag is tied. diff --git a/content/reference/services/SoftLayer_Tag/getAllTagTypes.md b/content/reference/services/SoftLayer_Tag/getAllTagTypes.md index 6b6cfb8d86..aa9bb0a34b 100644 --- a/content/reference/services/SoftLayer_Tag/getAllTagTypes.md +++ b/content/reference/services/SoftLayer_Tag/getAllTagTypes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Tag](/reference/services/SoftLayer_Tag)::getAllTagTypes + Get all valid tag types. diff --git a/content/reference/services/SoftLayer_Tag/getAttachedTagsForCurrentUser.md b/content/reference/services/SoftLayer_Tag/getAttachedTagsForCurrentUser.md index 17480e37a1..813d0503bf 100644 --- a/content/reference/services/SoftLayer_Tag/getAttachedTagsForCurrentUser.md +++ b/content/reference/services/SoftLayer_Tag/getAttachedTagsForCurrentUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Tag](/reference/services/SoftLayer_Tag)::getAttachedTagsForCurrentUser + Get the tags attached to references. diff --git a/content/reference/services/SoftLayer_Tag/getObject.md b/content/reference/services/SoftLayer_Tag/getObject.md index 7bd434b916..7c40a9ec29 100644 --- a/content/reference/services/SoftLayer_Tag/getObject.md +++ b/content/reference/services/SoftLayer_Tag/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Tag](/reference/services/SoftLayer_Tag)::getObject + Retrieve a SoftLayer_Tag record. diff --git a/content/reference/services/SoftLayer_Tag/getReferences.md b/content/reference/services/SoftLayer_Tag/getReferences.md index e865a2483e..71be117bdc 100644 --- a/content/reference/services/SoftLayer_Tag/getReferences.md +++ b/content/reference/services/SoftLayer_Tag/getReferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Tag](/reference/services/SoftLayer_Tag)::getReferences + Retrieve references that tie object to the tag. diff --git a/content/reference/services/SoftLayer_Tag/getTagByTagName.md b/content/reference/services/SoftLayer_Tag/getTagByTagName.md index 6a0ac75acf..1e898d7a16 100644 --- a/content/reference/services/SoftLayer_Tag/getTagByTagName.md +++ b/content/reference/services/SoftLayer_Tag/getTagByTagName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Tag](/reference/services/SoftLayer_Tag)::getTagByTagName + Get the tag object based on what the user inputs. diff --git a/content/reference/services/SoftLayer_Tag/getUnattachedTagsForCurrentUser.md b/content/reference/services/SoftLayer_Tag/getUnattachedTagsForCurrentUser.md index 4e796b7517..d648393b15 100644 --- a/content/reference/services/SoftLayer_Tag/getUnattachedTagsForCurrentUser.md +++ b/content/reference/services/SoftLayer_Tag/getUnattachedTagsForCurrentUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Tag](/reference/services/SoftLayer_Tag)::getUnattachedTagsForCurrentUser + Get the tags not attached to references. diff --git a/content/reference/services/SoftLayer_Tag/setTags.md b/content/reference/services/SoftLayer_Tag/setTags.md index a43439bf01..ab1490a1ab 100644 --- a/content/reference/services/SoftLayer_Tag/setTags.md +++ b/content/reference/services/SoftLayer_Tag/setTags.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Tag](/reference/services/SoftLayer_Tag)::setTags + Set the tags for a given object. diff --git a/content/reference/services/SoftLayer_Ticket/_index.md b/content/reference/services/SoftLayer_Ticket/_index.md index 5dd6863fab..ed9fc4d9a1 100644 --- a/content/reference/services/SoftLayer_Ticket/_index.md +++ b/content/reference/services/SoftLayer_Ticket/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -73,396 +75,465 @@ Typically the only tickets an account user may create are technical support tick #### [addAssignedAgent](/reference/services/SoftLayer_Ticket/addAssignedAgent) Assign an Agent to a ticket. +
              #### [addAttachedAdditionalEmails](/reference/services/SoftLayer_Ticket/addAttachedAdditionalEmails) Add non-user email addresses to a ticket's email notify list. +
              #### [addAttachedDedicatedHost](/reference/services/SoftLayer_Ticket/addAttachedDedicatedHost) Attach a Dedicated Host to a ticket. +
              #### [addAttachedFile](/reference/services/SoftLayer_Ticket/addAttachedFile) Attach a file to a ticket. +
              #### [addAttachedHardware](/reference/services/SoftLayer_Ticket/addAttachedHardware) Attach hardware to a ticket. +
              #### [addAttachedVirtualGuest](/reference/services/SoftLayer_Ticket/addAttachedVirtualGuest) Attach a CloudLayer Computing Instance to a ticket. +
              #### [addFinalComments](/reference/services/SoftLayer_Ticket/addFinalComments) Add final comments to a closed ticket. +
              #### [addScheduledAlert](/reference/services/SoftLayer_Ticket/addScheduledAlert) +
              #### [addScheduledAutoClose](/reference/services/SoftLayer_Ticket/addScheduledAutoClose) +
              #### [addUpdate](/reference/services/SoftLayer_Ticket/addUpdate) Add an update to a ticket. +
              #### [createAdministrativeTicket](/reference/services/SoftLayer_Ticket/createAdministrativeTicket) Create an administrative support ticket. +
              #### [createCancelServerTicket](/reference/services/SoftLayer_Ticket/createCancelServerTicket) Create a sales cancel server ticket to be cancelled on next bill date. +
              #### [createCancelServiceTicket](/reference/services/SoftLayer_Ticket/createCancelServiceTicket) Create a sales cancel service ticket. +
              #### [createStandardTicket](/reference/services/SoftLayer_Ticket/createStandardTicket) Create a standard support ticket. +
              #### [createUpgradeTicket](/reference/services/SoftLayer_Ticket/createUpgradeTicket) Create an upgrade request ticket for the SoftLayer sales team. +
              #### [edit](/reference/services/SoftLayer_Ticket/edit) Edit or update a SoftLayer ticket. +
              #### [getAccount](/reference/services/SoftLayer_Ticket/getAccount) Retrieve the SoftLayer customer account associated with a ticket. +
              #### [getAllTicketGroups](/reference/services/SoftLayer_Ticket/getAllTicketGroups) Retrieve all available ticket groups. +
              #### [getAllTicketStatuses](/reference/services/SoftLayer_Ticket/getAllTicketStatuses) Retrieve all available ticket statuses. +
              #### [getAssignedAgents](/reference/services/SoftLayer_Ticket/getAssignedAgents) +
              #### [getAssignedUser](/reference/services/SoftLayer_Ticket/getAssignedUser) Retrieve the portal user that a ticket is assigned to. +
              #### [getAttachedAdditionalEmails](/reference/services/SoftLayer_Ticket/getAttachedAdditionalEmails) Retrieve the list of additional emails to notify when a ticket update is made. +
              #### [getAttachedDedicatedHosts](/reference/services/SoftLayer_Ticket/getAttachedDedicatedHosts) Retrieve the Dedicated Hosts associated with a ticket. This is used in cases where a ticket is directly associated with one or more Dedicated Hosts. +
              #### [getAttachedFile](/reference/services/SoftLayer_Ticket/getAttachedFile) Retrieve a file attached to a ticket. +
              #### [getAttachedFiles](/reference/services/SoftLayer_Ticket/getAttachedFiles) Retrieve the files attached to a ticket. +
              #### [getAttachedHardware](/reference/services/SoftLayer_Ticket/getAttachedHardware) Retrieve the hardware associated with a ticket. This is used in cases where a ticket is directly associated with one or more pieces of hardware. +
              #### [getAttachedHardwareCount](/reference/services/SoftLayer_Ticket/getAttachedHardwareCount) +
              #### [getAttachedResources](/reference/services/SoftLayer_Ticket/getAttachedResources) +
              #### [getAttachedVirtualGuests](/reference/services/SoftLayer_Ticket/getAttachedVirtualGuests) Retrieve the virtual guests associated with a ticket. This is used in cases where a ticket is directly associated with one or more virtualized guests installations or Virtual Servers. +
              #### [getAwaitingUserResponseFlag](/reference/services/SoftLayer_Ticket/getAwaitingUserResponseFlag) Retrieve ticket is waiting on a response from a customer flag. +
              #### [getBnppSupportedFlag](/reference/services/SoftLayer_Ticket/getBnppSupportedFlag) Retrieve a ticket's associated BNPP compliant record +
              #### [getCancellationRequest](/reference/services/SoftLayer_Ticket/getCancellationRequest) Retrieve a service cancellation request. +
              #### [getEmployeeAttachments](/reference/services/SoftLayer_Ticket/getEmployeeAttachments) +
              #### [getEuSupportedFlag](/reference/services/SoftLayer_Ticket/getEuSupportedFlag) Retrieve a ticket's associated EU compliant record +
              #### [getFirstAttachedResource](/reference/services/SoftLayer_Ticket/getFirstAttachedResource) Retrieve the first physical or virtual server attached to a ticket. +
              #### [getFirstUpdate](/reference/services/SoftLayer_Ticket/getFirstUpdate) Retrieve the first update made to a ticket. This is typically the contents of a ticket when it's created. +
              #### [getFsboaSupportedFlag](/reference/services/SoftLayer_Ticket/getFsboaSupportedFlag) Retrieve a ticket's associated FSBOA compliant record +
              #### [getGroup](/reference/services/SoftLayer_Ticket/getGroup) Retrieve the SoftLayer department that a ticket is assigned to. +
              #### [getInvoiceItems](/reference/services/SoftLayer_Ticket/getInvoiceItems) Retrieve the invoice items associated with a ticket. Ticket based invoice items only exist when a ticket incurs a fee that has been invoiced. +
              #### [getLastActivity](/reference/services/SoftLayer_Ticket/getLastActivity) +
              #### [getLastEditor](/reference/services/SoftLayer_Ticket/getLastEditor) +
              #### [getLastUpdate](/reference/services/SoftLayer_Ticket/getLastUpdate) Retrieve the last update made to a ticket. +
              #### [getLocation](/reference/services/SoftLayer_Ticket/getLocation) Retrieve a ticket's associated location within the SoftLayer location hierarchy. +
              #### [getNewUpdatesFlag](/reference/services/SoftLayer_Ticket/getNewUpdatesFlag) Retrieve true if there are new, unread updates to this ticket for the current user, False otherwise. +
              #### [getObject](/reference/services/SoftLayer_Ticket/getObject) Retrieve a SoftLayer_Ticket record. +
              #### [getScheduledActions](/reference/services/SoftLayer_Ticket/getScheduledActions) +
              #### [getServerAdministrationBillingInvoice](/reference/services/SoftLayer_Ticket/getServerAdministrationBillingInvoice) Retrieve the invoice associated with a ticket. Only tickets with an associated administrative charge have an invoice. +
              #### [getServerAdministrationRefundInvoice](/reference/services/SoftLayer_Ticket/getServerAdministrationRefundInvoice) Retrieve the refund invoice associated with a ticket. Only tickets with a refund applied in them have an associated refund invoice. +
              #### [getServiceProvider](/reference/services/SoftLayer_Ticket/getServiceProvider) +
              #### [getState](/reference/services/SoftLayer_Ticket/getState) +
              #### [getStatus](/reference/services/SoftLayer_Ticket/getStatus) Retrieve a ticket's status. +
              #### [getSubject](/reference/services/SoftLayer_Ticket/getSubject) Retrieve a ticket's subject. Only standard support tickets have an associated subject. A standard support ticket's title corresponds with it's subject's name. +
              #### [getTagReferences](/reference/services/SoftLayer_Ticket/getTagReferences) +
              #### [getTicketsClosedSinceDate](/reference/services/SoftLayer_Ticket/getTicketsClosedSinceDate) Retrieve tickets closed since a given date. +
              #### [getUpdateRatingFlag](/reference/services/SoftLayer_Ticket/getUpdateRatingFlag) Retrieve whether employees' updates of this ticket could be rated by customer +
              #### [getUpdates](/reference/services/SoftLayer_Ticket/getUpdates) Retrieve a ticket's updates. +
              #### [markAsViewed](/reference/services/SoftLayer_Ticket/markAsViewed) +
              #### [removeAssignedAgent](/reference/services/SoftLayer_Ticket/removeAssignedAgent) Remove an assigned agent from a ticket. +
              #### [removeAttachedAdditionalEmails](/reference/services/SoftLayer_Ticket/removeAttachedAdditionalEmails) Detaches non-user additional email addresses from a ticket. +
              #### [removeAttachedHardware](/reference/services/SoftLayer_Ticket/removeAttachedHardware) detach hardware from a ticket. +
              #### [removeAttachedVirtualGuest](/reference/services/SoftLayer_Ticket/removeAttachedVirtualGuest) Detach a CloudLayer Computing Instance from a ticket. +
              #### [removeScheduledAlert](/reference/services/SoftLayer_Ticket/removeScheduledAlert) +
              #### [removeScheduledAutoClose](/reference/services/SoftLayer_Ticket/removeScheduledAutoClose) +
              #### [setTags](/reference/services/SoftLayer_Ticket/setTags) +
              -
              +
              #### [surveyEligible](/reference/services/SoftLayer_Ticket/surveyEligible) + +Deprecated + +
              #### [updateAttachedAdditionalEmails](/reference/services/SoftLayer_Ticket/updateAttachedAdditionalEmails) Update non-user email addresses attached to a ticket's email notify list. +
              diff --git a/content/reference/services/SoftLayer_Ticket/addAssignedAgent.md b/content/reference/services/SoftLayer_Ticket/addAssignedAgent.md index 04c2feaddd..daf8e6da22 100644 --- a/content/reference/services/SoftLayer_Ticket/addAssignedAgent.md +++ b/content/reference/services/SoftLayer_Ticket/addAssignedAgent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::addAssignedAgent + Assign an Agent to a ticket. diff --git a/content/reference/services/SoftLayer_Ticket/addAttachedAdditionalEmails.md b/content/reference/services/SoftLayer_Ticket/addAttachedAdditionalEmails.md index dd67f1fdc5..e97f87e08f 100644 --- a/content/reference/services/SoftLayer_Ticket/addAttachedAdditionalEmails.md +++ b/content/reference/services/SoftLayer_Ticket/addAttachedAdditionalEmails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::addAttachedAdditionalEmails + Add non-user email addresses to a ticket's email notify list. diff --git a/content/reference/services/SoftLayer_Ticket/addAttachedDedicatedHost.md b/content/reference/services/SoftLayer_Ticket/addAttachedDedicatedHost.md index 74d378b9d5..994c7b8536 100644 --- a/content/reference/services/SoftLayer_Ticket/addAttachedDedicatedHost.md +++ b/content/reference/services/SoftLayer_Ticket/addAttachedDedicatedHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::addAttachedDedicatedHost + Attach a Dedicated Host to a ticket. diff --git a/content/reference/services/SoftLayer_Ticket/addAttachedFile.md b/content/reference/services/SoftLayer_Ticket/addAttachedFile.md index 2c2affa5be..83f745c514 100644 --- a/content/reference/services/SoftLayer_Ticket/addAttachedFile.md +++ b/content/reference/services/SoftLayer_Ticket/addAttachedFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::addAttachedFile + Attach a file to a ticket. diff --git a/content/reference/services/SoftLayer_Ticket/addAttachedHardware.md b/content/reference/services/SoftLayer_Ticket/addAttachedHardware.md index 5f3edbd368..ac45158131 100644 --- a/content/reference/services/SoftLayer_Ticket/addAttachedHardware.md +++ b/content/reference/services/SoftLayer_Ticket/addAttachedHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::addAttachedHardware + Attach hardware to a ticket. diff --git a/content/reference/services/SoftLayer_Ticket/addAttachedVirtualGuest.md b/content/reference/services/SoftLayer_Ticket/addAttachedVirtualGuest.md index b81418a4d8..b493cf12fc 100644 --- a/content/reference/services/SoftLayer_Ticket/addAttachedVirtualGuest.md +++ b/content/reference/services/SoftLayer_Ticket/addAttachedVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::addAttachedVirtualGuest + Attach a CloudLayer Computing Instance to a ticket. diff --git a/content/reference/services/SoftLayer_Ticket/addFinalComments.md b/content/reference/services/SoftLayer_Ticket/addFinalComments.md index a3feafdd34..461f225c5c 100644 --- a/content/reference/services/SoftLayer_Ticket/addFinalComments.md +++ b/content/reference/services/SoftLayer_Ticket/addFinalComments.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::addFinalComments + Add final comments to a closed ticket. diff --git a/content/reference/services/SoftLayer_Ticket/addScheduledAlert.md b/content/reference/services/SoftLayer_Ticket/addScheduledAlert.md index 088bd16652..37738188a7 100644 --- a/content/reference/services/SoftLayer_Ticket/addScheduledAlert.md +++ b/content/reference/services/SoftLayer_Ticket/addScheduledAlert.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket/addScheduledAutoClose.md b/content/reference/services/SoftLayer_Ticket/addScheduledAutoClose.md index f6895488ec..498ec9492e 100644 --- a/content/reference/services/SoftLayer_Ticket/addScheduledAutoClose.md +++ b/content/reference/services/SoftLayer_Ticket/addScheduledAutoClose.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket/addUpdate.md b/content/reference/services/SoftLayer_Ticket/addUpdate.md index dd85d02025..10a66d9ec7 100644 --- a/content/reference/services/SoftLayer_Ticket/addUpdate.md +++ b/content/reference/services/SoftLayer_Ticket/addUpdate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::addUpdate + Add an update to a ticket. diff --git a/content/reference/services/SoftLayer_Ticket/createAdministrativeTicket.md b/content/reference/services/SoftLayer_Ticket/createAdministrativeTicket.md index 6a7ca8640a..be92f97e6d 100644 --- a/content/reference/services/SoftLayer_Ticket/createAdministrativeTicket.md +++ b/content/reference/services/SoftLayer_Ticket/createAdministrativeTicket.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::createAdministrativeTicket + Create an administrative support ticket. diff --git a/content/reference/services/SoftLayer_Ticket/createCancelServerTicket.md b/content/reference/services/SoftLayer_Ticket/createCancelServerTicket.md index daf3150d76..e30b8c5554 100644 --- a/content/reference/services/SoftLayer_Ticket/createCancelServerTicket.md +++ b/content/reference/services/SoftLayer_Ticket/createCancelServerTicket.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::createCancelServerTicket + Create a sales cancel server ticket to be cancelled on next bill date. diff --git a/content/reference/services/SoftLayer_Ticket/createCancelServiceTicket.md b/content/reference/services/SoftLayer_Ticket/createCancelServiceTicket.md index 44e043c6d7..494461fcfe 100644 --- a/content/reference/services/SoftLayer_Ticket/createCancelServiceTicket.md +++ b/content/reference/services/SoftLayer_Ticket/createCancelServiceTicket.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::createCancelServiceTicket + Create a sales cancel service ticket. diff --git a/content/reference/services/SoftLayer_Ticket/createStandardTicket.md b/content/reference/services/SoftLayer_Ticket/createStandardTicket.md index ed539f317d..670e91083c 100644 --- a/content/reference/services/SoftLayer_Ticket/createStandardTicket.md +++ b/content/reference/services/SoftLayer_Ticket/createStandardTicket.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::createStandardTicket + Create a standard support ticket. diff --git a/content/reference/services/SoftLayer_Ticket/createUpgradeTicket.md b/content/reference/services/SoftLayer_Ticket/createUpgradeTicket.md index 1e3142800b..c503e414d4 100644 --- a/content/reference/services/SoftLayer_Ticket/createUpgradeTicket.md +++ b/content/reference/services/SoftLayer_Ticket/createUpgradeTicket.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::createUpgradeTicket + Create an upgrade request ticket for the SoftLayer sales team. diff --git a/content/reference/services/SoftLayer_Ticket/edit.md b/content/reference/services/SoftLayer_Ticket/edit.md index 715723bf4f..b3be3f837d 100644 --- a/content/reference/services/SoftLayer_Ticket/edit.md +++ b/content/reference/services/SoftLayer_Ticket/edit.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::edit + Edit or update a SoftLayer ticket. diff --git a/content/reference/services/SoftLayer_Ticket/getAccount.md b/content/reference/services/SoftLayer_Ticket/getAccount.md index c62d5e5831..ae07cbbd3e 100644 --- a/content/reference/services/SoftLayer_Ticket/getAccount.md +++ b/content/reference/services/SoftLayer_Ticket/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getAccount + Retrieve the SoftLayer customer account associated with a ticket. diff --git a/content/reference/services/SoftLayer_Ticket/getAllTicketGroups.md b/content/reference/services/SoftLayer_Ticket/getAllTicketGroups.md index 7c554097ec..ebc6d86d0f 100644 --- a/content/reference/services/SoftLayer_Ticket/getAllTicketGroups.md +++ b/content/reference/services/SoftLayer_Ticket/getAllTicketGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getAllTicketGroups + Retrieve all available ticket groups. diff --git a/content/reference/services/SoftLayer_Ticket/getAllTicketStatuses.md b/content/reference/services/SoftLayer_Ticket/getAllTicketStatuses.md index a53f984b9b..0c51ec17e6 100644 --- a/content/reference/services/SoftLayer_Ticket/getAllTicketStatuses.md +++ b/content/reference/services/SoftLayer_Ticket/getAllTicketStatuses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getAllTicketStatuses + Retrieve all available ticket statuses. diff --git a/content/reference/services/SoftLayer_Ticket/getAssignedAgents.md b/content/reference/services/SoftLayer_Ticket/getAssignedAgents.md index 18bdc2309a..ec455fb82e 100644 --- a/content/reference/services/SoftLayer_Ticket/getAssignedAgents.md +++ b/content/reference/services/SoftLayer_Ticket/getAssignedAgents.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket/getAssignedUser.md b/content/reference/services/SoftLayer_Ticket/getAssignedUser.md index 84d95d8c72..df1aece7d8 100644 --- a/content/reference/services/SoftLayer_Ticket/getAssignedUser.md +++ b/content/reference/services/SoftLayer_Ticket/getAssignedUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getAssignedUser + Retrieve the portal user that a ticket is assigned to. diff --git a/content/reference/services/SoftLayer_Ticket/getAttachedAdditionalEmails.md b/content/reference/services/SoftLayer_Ticket/getAttachedAdditionalEmails.md index 98634ec745..5846c6abba 100644 --- a/content/reference/services/SoftLayer_Ticket/getAttachedAdditionalEmails.md +++ b/content/reference/services/SoftLayer_Ticket/getAttachedAdditionalEmails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getAttachedAdditionalEmails + Retrieve the list of additional emails to notify when a ticket update is made. diff --git a/content/reference/services/SoftLayer_Ticket/getAttachedDedicatedHosts.md b/content/reference/services/SoftLayer_Ticket/getAttachedDedicatedHosts.md index d75f7dd117..20dfa0aae1 100644 --- a/content/reference/services/SoftLayer_Ticket/getAttachedDedicatedHosts.md +++ b/content/reference/services/SoftLayer_Ticket/getAttachedDedicatedHosts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getAttachedDedicatedHosts + Retrieve the Dedicated Hosts associated with a ticket. This is used in cases where a ticket is directly associated with one or more Dedicated Hosts. diff --git a/content/reference/services/SoftLayer_Ticket/getAttachedFile.md b/content/reference/services/SoftLayer_Ticket/getAttachedFile.md index e3f6af933d..0c07c043e3 100644 --- a/content/reference/services/SoftLayer_Ticket/getAttachedFile.md +++ b/content/reference/services/SoftLayer_Ticket/getAttachedFile.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getAttachedFile + Retrieve a file attached to a ticket. diff --git a/content/reference/services/SoftLayer_Ticket/getAttachedFiles.md b/content/reference/services/SoftLayer_Ticket/getAttachedFiles.md index 0a4582f6c4..121948012d 100644 --- a/content/reference/services/SoftLayer_Ticket/getAttachedFiles.md +++ b/content/reference/services/SoftLayer_Ticket/getAttachedFiles.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getAttachedFiles + Retrieve the files attached to a ticket. diff --git a/content/reference/services/SoftLayer_Ticket/getAttachedHardware.md b/content/reference/services/SoftLayer_Ticket/getAttachedHardware.md index 6ce66385da..bec9100ea3 100644 --- a/content/reference/services/SoftLayer_Ticket/getAttachedHardware.md +++ b/content/reference/services/SoftLayer_Ticket/getAttachedHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getAttachedHardware + Retrieve the hardware associated with a ticket. This is used in cases where a ticket is directly associated with one or more pieces of hardware. diff --git a/content/reference/services/SoftLayer_Ticket/getAttachedHardwareCount.md b/content/reference/services/SoftLayer_Ticket/getAttachedHardwareCount.md index 2410190f34..21b207e393 100644 --- a/content/reference/services/SoftLayer_Ticket/getAttachedHardwareCount.md +++ b/content/reference/services/SoftLayer_Ticket/getAttachedHardwareCount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket/getAttachedResources.md b/content/reference/services/SoftLayer_Ticket/getAttachedResources.md index bdd126cf13..b4b7042f6c 100644 --- a/content/reference/services/SoftLayer_Ticket/getAttachedResources.md +++ b/content/reference/services/SoftLayer_Ticket/getAttachedResources.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket/getAttachedVirtualGuests.md b/content/reference/services/SoftLayer_Ticket/getAttachedVirtualGuests.md index ff3598bdee..b789d699e8 100644 --- a/content/reference/services/SoftLayer_Ticket/getAttachedVirtualGuests.md +++ b/content/reference/services/SoftLayer_Ticket/getAttachedVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getAttachedVirtualGuests + Retrieve the virtual guests associated with a ticket. This is used in cases where a ticket is directly associated with one or more virtualized guests installations or Virtual Servers. diff --git a/content/reference/services/SoftLayer_Ticket/getAwaitingUserResponseFlag.md b/content/reference/services/SoftLayer_Ticket/getAwaitingUserResponseFlag.md index e6ad2cd005..04e7085f4d 100644 --- a/content/reference/services/SoftLayer_Ticket/getAwaitingUserResponseFlag.md +++ b/content/reference/services/SoftLayer_Ticket/getAwaitingUserResponseFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getAwaitingUserResponseFlag + Retrieve ticket is waiting on a response from a customer flag. diff --git a/content/reference/services/SoftLayer_Ticket/getBnppSupportedFlag.md b/content/reference/services/SoftLayer_Ticket/getBnppSupportedFlag.md index 560185d6db..8a45f5b0fe 100644 --- a/content/reference/services/SoftLayer_Ticket/getBnppSupportedFlag.md +++ b/content/reference/services/SoftLayer_Ticket/getBnppSupportedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getBnppSupportedFlag + Retrieve a ticket's associated BNPP compliant record diff --git a/content/reference/services/SoftLayer_Ticket/getCancellationRequest.md b/content/reference/services/SoftLayer_Ticket/getCancellationRequest.md index ac7dc41f4a..75d7133856 100644 --- a/content/reference/services/SoftLayer_Ticket/getCancellationRequest.md +++ b/content/reference/services/SoftLayer_Ticket/getCancellationRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getCancellationRequest + Retrieve a service cancellation request. diff --git a/content/reference/services/SoftLayer_Ticket/getEmployeeAttachments.md b/content/reference/services/SoftLayer_Ticket/getEmployeeAttachments.md index 8a0227bdd9..fc6db5f1bc 100644 --- a/content/reference/services/SoftLayer_Ticket/getEmployeeAttachments.md +++ b/content/reference/services/SoftLayer_Ticket/getEmployeeAttachments.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket/getEuSupportedFlag.md b/content/reference/services/SoftLayer_Ticket/getEuSupportedFlag.md index f3cd641519..68ccb59108 100644 --- a/content/reference/services/SoftLayer_Ticket/getEuSupportedFlag.md +++ b/content/reference/services/SoftLayer_Ticket/getEuSupportedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getEuSupportedFlag + Retrieve a ticket's associated EU compliant record diff --git a/content/reference/services/SoftLayer_Ticket/getFirstAttachedResource.md b/content/reference/services/SoftLayer_Ticket/getFirstAttachedResource.md index b1e096f2f1..2336762a72 100644 --- a/content/reference/services/SoftLayer_Ticket/getFirstAttachedResource.md +++ b/content/reference/services/SoftLayer_Ticket/getFirstAttachedResource.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getFirstAttachedResource + Retrieve the first physical or virtual server attached to a ticket. diff --git a/content/reference/services/SoftLayer_Ticket/getFirstUpdate.md b/content/reference/services/SoftLayer_Ticket/getFirstUpdate.md index 3f1bd37c61..c9270fbab3 100644 --- a/content/reference/services/SoftLayer_Ticket/getFirstUpdate.md +++ b/content/reference/services/SoftLayer_Ticket/getFirstUpdate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getFirstUpdate + Retrieve the first update made to a ticket. This is typically the contents of a ticket when it's created. diff --git a/content/reference/services/SoftLayer_Ticket/getFsboaSupportedFlag.md b/content/reference/services/SoftLayer_Ticket/getFsboaSupportedFlag.md index 806f640a06..ee47311417 100644 --- a/content/reference/services/SoftLayer_Ticket/getFsboaSupportedFlag.md +++ b/content/reference/services/SoftLayer_Ticket/getFsboaSupportedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getFsboaSupportedFlag + Retrieve a ticket's associated FSBOA compliant record diff --git a/content/reference/services/SoftLayer_Ticket/getGroup.md b/content/reference/services/SoftLayer_Ticket/getGroup.md index 8a2371bbff..b25f219c0a 100644 --- a/content/reference/services/SoftLayer_Ticket/getGroup.md +++ b/content/reference/services/SoftLayer_Ticket/getGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getGroup + Retrieve the SoftLayer department that a ticket is assigned to. diff --git a/content/reference/services/SoftLayer_Ticket/getInvoiceItems.md b/content/reference/services/SoftLayer_Ticket/getInvoiceItems.md index 736e147251..bcc742b396 100644 --- a/content/reference/services/SoftLayer_Ticket/getInvoiceItems.md +++ b/content/reference/services/SoftLayer_Ticket/getInvoiceItems.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getInvoiceItems + Retrieve the invoice items associated with a ticket. Ticket based invoice items only exist when a ticket incurs a fee that has been invoiced. diff --git a/content/reference/services/SoftLayer_Ticket/getLastActivity.md b/content/reference/services/SoftLayer_Ticket/getLastActivity.md index a60ac60341..cb2a44bf29 100644 --- a/content/reference/services/SoftLayer_Ticket/getLastActivity.md +++ b/content/reference/services/SoftLayer_Ticket/getLastActivity.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket/getLastEditor.md b/content/reference/services/SoftLayer_Ticket/getLastEditor.md index 6426079204..ddc2e022ba 100644 --- a/content/reference/services/SoftLayer_Ticket/getLastEditor.md +++ b/content/reference/services/SoftLayer_Ticket/getLastEditor.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket/getLastUpdate.md b/content/reference/services/SoftLayer_Ticket/getLastUpdate.md index 7b4ea3847f..251dde48d1 100644 --- a/content/reference/services/SoftLayer_Ticket/getLastUpdate.md +++ b/content/reference/services/SoftLayer_Ticket/getLastUpdate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getLastUpdate + Retrieve the last update made to a ticket. diff --git a/content/reference/services/SoftLayer_Ticket/getLocation.md b/content/reference/services/SoftLayer_Ticket/getLocation.md index be52cb1bbf..92f8b701fd 100644 --- a/content/reference/services/SoftLayer_Ticket/getLocation.md +++ b/content/reference/services/SoftLayer_Ticket/getLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getLocation + Retrieve a ticket's associated location within the SoftLayer location hierarchy. diff --git a/content/reference/services/SoftLayer_Ticket/getNewUpdatesFlag.md b/content/reference/services/SoftLayer_Ticket/getNewUpdatesFlag.md index b1f5509a34..cca94f99ee 100644 --- a/content/reference/services/SoftLayer_Ticket/getNewUpdatesFlag.md +++ b/content/reference/services/SoftLayer_Ticket/getNewUpdatesFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getNewUpdatesFlag + Retrieve true if there are new, unread updates to this ticket for the current user, False otherwise. diff --git a/content/reference/services/SoftLayer_Ticket/getObject.md b/content/reference/services/SoftLayer_Ticket/getObject.md index 07aaa25489..cd23ad3156 100644 --- a/content/reference/services/SoftLayer_Ticket/getObject.md +++ b/content/reference/services/SoftLayer_Ticket/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getObject + Retrieve a SoftLayer_Ticket record. diff --git a/content/reference/services/SoftLayer_Ticket/getScheduledActions.md b/content/reference/services/SoftLayer_Ticket/getScheduledActions.md index bde109abfc..f71bd5054d 100644 --- a/content/reference/services/SoftLayer_Ticket/getScheduledActions.md +++ b/content/reference/services/SoftLayer_Ticket/getScheduledActions.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket/getServerAdministrationBillingInvoice.md b/content/reference/services/SoftLayer_Ticket/getServerAdministrationBillingInvoice.md index 2b9fa71027..f157772cf9 100644 --- a/content/reference/services/SoftLayer_Ticket/getServerAdministrationBillingInvoice.md +++ b/content/reference/services/SoftLayer_Ticket/getServerAdministrationBillingInvoice.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getServerAdministrationBillingInvoice + Retrieve the invoice associated with a ticket. Only tickets with an associated administrative charge have an invoice. diff --git a/content/reference/services/SoftLayer_Ticket/getServerAdministrationRefundInvoice.md b/content/reference/services/SoftLayer_Ticket/getServerAdministrationRefundInvoice.md index 4428b61345..f68e30560c 100644 --- a/content/reference/services/SoftLayer_Ticket/getServerAdministrationRefundInvoice.md +++ b/content/reference/services/SoftLayer_Ticket/getServerAdministrationRefundInvoice.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getServerAdministrationRefundInvoice + Retrieve the refund invoice associated with a ticket. Only tickets with a refund applied in them have an associated refund invoice. diff --git a/content/reference/services/SoftLayer_Ticket/getServiceProvider.md b/content/reference/services/SoftLayer_Ticket/getServiceProvider.md index 1416243c20..bd9b6343ce 100644 --- a/content/reference/services/SoftLayer_Ticket/getServiceProvider.md +++ b/content/reference/services/SoftLayer_Ticket/getServiceProvider.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket/getState.md b/content/reference/services/SoftLayer_Ticket/getState.md index 5b99dc6e48..0b3bcf05fe 100644 --- a/content/reference/services/SoftLayer_Ticket/getState.md +++ b/content/reference/services/SoftLayer_Ticket/getState.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket/getStatus.md b/content/reference/services/SoftLayer_Ticket/getStatus.md index 56f1189c93..e4c5f2b0bd 100644 --- a/content/reference/services/SoftLayer_Ticket/getStatus.md +++ b/content/reference/services/SoftLayer_Ticket/getStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getStatus + Retrieve a ticket's status. diff --git a/content/reference/services/SoftLayer_Ticket/getSubject.md b/content/reference/services/SoftLayer_Ticket/getSubject.md index 408a1baf54..75a8b2ca17 100644 --- a/content/reference/services/SoftLayer_Ticket/getSubject.md +++ b/content/reference/services/SoftLayer_Ticket/getSubject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getSubject + Retrieve a ticket's subject. Only standard support tickets have an associated subject. A standard support ticket's title corresponds with it's subject's name. diff --git a/content/reference/services/SoftLayer_Ticket/getTagReferences.md b/content/reference/services/SoftLayer_Ticket/getTagReferences.md index 32f95c9d43..82ce2c3289 100644 --- a/content/reference/services/SoftLayer_Ticket/getTagReferences.md +++ b/content/reference/services/SoftLayer_Ticket/getTagReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket/getTicketsClosedSinceDate.md b/content/reference/services/SoftLayer_Ticket/getTicketsClosedSinceDate.md index 6919600d6f..0b5e462928 100644 --- a/content/reference/services/SoftLayer_Ticket/getTicketsClosedSinceDate.md +++ b/content/reference/services/SoftLayer_Ticket/getTicketsClosedSinceDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getTicketsClosedSinceDate + Retrieve tickets closed since a given date. diff --git a/content/reference/services/SoftLayer_Ticket/getUpdateRatingFlag.md b/content/reference/services/SoftLayer_Ticket/getUpdateRatingFlag.md index ae1ba50f7d..8181217ab1 100644 --- a/content/reference/services/SoftLayer_Ticket/getUpdateRatingFlag.md +++ b/content/reference/services/SoftLayer_Ticket/getUpdateRatingFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getUpdateRatingFlag + Retrieve whether employees' updates of this ticket could be rated by customer diff --git a/content/reference/services/SoftLayer_Ticket/getUpdates.md b/content/reference/services/SoftLayer_Ticket/getUpdates.md index e0641529a0..f2d8e3bec6 100644 --- a/content/reference/services/SoftLayer_Ticket/getUpdates.md +++ b/content/reference/services/SoftLayer_Ticket/getUpdates.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::getUpdates + Retrieve a ticket's updates. diff --git a/content/reference/services/SoftLayer_Ticket/markAsViewed.md b/content/reference/services/SoftLayer_Ticket/markAsViewed.md index b8e352a14f..e599811e10 100644 --- a/content/reference/services/SoftLayer_Ticket/markAsViewed.md +++ b/content/reference/services/SoftLayer_Ticket/markAsViewed.md @@ -16,6 +16,7 @@ aliases: + ## Overview Mark a ticket as viewed. All currently posted updates will be marked as viewed. The lastViewedDate property will be updated to the current time. diff --git a/content/reference/services/SoftLayer_Ticket/removeAssignedAgent.md b/content/reference/services/SoftLayer_Ticket/removeAssignedAgent.md index f2d860bce1..3c4b34ec98 100644 --- a/content/reference/services/SoftLayer_Ticket/removeAssignedAgent.md +++ b/content/reference/services/SoftLayer_Ticket/removeAssignedAgent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::removeAssignedAgent + Remove an assigned agent from a ticket. diff --git a/content/reference/services/SoftLayer_Ticket/removeAttachedAdditionalEmails.md b/content/reference/services/SoftLayer_Ticket/removeAttachedAdditionalEmails.md index c8da790adf..54c887640d 100644 --- a/content/reference/services/SoftLayer_Ticket/removeAttachedAdditionalEmails.md +++ b/content/reference/services/SoftLayer_Ticket/removeAttachedAdditionalEmails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::removeAttachedAdditionalEmails + Detaches non-user additional email addresses from a ticket. diff --git a/content/reference/services/SoftLayer_Ticket/removeAttachedHardware.md b/content/reference/services/SoftLayer_Ticket/removeAttachedHardware.md index fae6edc9f1..d765427a3a 100644 --- a/content/reference/services/SoftLayer_Ticket/removeAttachedHardware.md +++ b/content/reference/services/SoftLayer_Ticket/removeAttachedHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::removeAttachedHardware + detach hardware from a ticket. diff --git a/content/reference/services/SoftLayer_Ticket/removeAttachedVirtualGuest.md b/content/reference/services/SoftLayer_Ticket/removeAttachedVirtualGuest.md index 1c32083c55..5ce8b342d8 100644 --- a/content/reference/services/SoftLayer_Ticket/removeAttachedVirtualGuest.md +++ b/content/reference/services/SoftLayer_Ticket/removeAttachedVirtualGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::removeAttachedVirtualGuest + Detach a CloudLayer Computing Instance from a ticket. diff --git a/content/reference/services/SoftLayer_Ticket/removeScheduledAlert.md b/content/reference/services/SoftLayer_Ticket/removeScheduledAlert.md index df4beba341..4acecdcd81 100644 --- a/content/reference/services/SoftLayer_Ticket/removeScheduledAlert.md +++ b/content/reference/services/SoftLayer_Ticket/removeScheduledAlert.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket/removeScheduledAutoClose.md b/content/reference/services/SoftLayer_Ticket/removeScheduledAutoClose.md index 31452e21ea..8b1f9058b1 100644 --- a/content/reference/services/SoftLayer_Ticket/removeScheduledAutoClose.md +++ b/content/reference/services/SoftLayer_Ticket/removeScheduledAutoClose.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket/setTags.md b/content/reference/services/SoftLayer_Ticket/setTags.md index 32515e0853..25faf78c7d 100644 --- a/content/reference/services/SoftLayer_Ticket/setTags.md +++ b/content/reference/services/SoftLayer_Ticket/setTags.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket/surveyEligible.md b/content/reference/services/SoftLayer_Ticket/surveyEligible.md index 5dbd9e1459..19891ede80 100644 --- a/content/reference/services/SoftLayer_Ticket/surveyEligible.md +++ b/content/reference/services/SoftLayer_Ticket/surveyEligible.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::surveyEligible +
              Deprecated
              + diff --git a/content/reference/services/SoftLayer_Ticket/updateAttachedAdditionalEmails.md b/content/reference/services/SoftLayer_Ticket/updateAttachedAdditionalEmails.md index 63623e79d7..68b8ba9d12 100644 --- a/content/reference/services/SoftLayer_Ticket/updateAttachedAdditionalEmails.md +++ b/content/reference/services/SoftLayer_Ticket/updateAttachedAdditionalEmails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket](/reference/services/SoftLayer_Ticket)::updateAttachedAdditionalEmails + Update non-user email addresses attached to a ticket's email notify list. diff --git a/content/reference/services/SoftLayer_Ticket_Attachment_File/_index.md b/content/reference/services/SoftLayer_Ticket_Attachment_File/_index.md index 5099ef37d4..48a17baf03 100644 --- a/content/reference/services/SoftLayer_Ticket_Attachment_File/_index.md +++ b/content/reference/services/SoftLayer_Ticket_Attachment_File/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,24 +44,28 @@ classes: #### [getExtensionWhitelist](/reference/services/SoftLayer_Ticket_Attachment_File/getExtensionWhitelist) +
              #### [getObject](/reference/services/SoftLayer_Ticket_Attachment_File/getObject) Retrieve a SoftLayer_Ticket_Attachment_File record. +
              #### [getTicket](/reference/services/SoftLayer_Ticket_Attachment_File/getTicket) +
              #### [getUpdate](/reference/services/SoftLayer_Ticket_Attachment_File/getUpdate) Retrieve the ticket that a file is attached to. +
              diff --git a/content/reference/services/SoftLayer_Ticket_Attachment_File/getExtensionWhitelist.md b/content/reference/services/SoftLayer_Ticket_Attachment_File/getExtensionWhitelist.md index cc44c1b1af..be1bb24d5e 100644 --- a/content/reference/services/SoftLayer_Ticket_Attachment_File/getExtensionWhitelist.md +++ b/content/reference/services/SoftLayer_Ticket_Attachment_File/getExtensionWhitelist.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket_Attachment_File/getObject.md b/content/reference/services/SoftLayer_Ticket_Attachment_File/getObject.md index 1f878bc8d9..ea1f7240be 100644 --- a/content/reference/services/SoftLayer_Ticket_Attachment_File/getObject.md +++ b/content/reference/services/SoftLayer_Ticket_Attachment_File/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Attachment_File](/reference/services/SoftLayer_Ticket_Attachment_File)::getObject + Retrieve a SoftLayer_Ticket_Attachment_File record. diff --git a/content/reference/services/SoftLayer_Ticket_Attachment_File/getTicket.md b/content/reference/services/SoftLayer_Ticket_Attachment_File/getTicket.md index 60c739454a..7138996a3d 100644 --- a/content/reference/services/SoftLayer_Ticket_Attachment_File/getTicket.md +++ b/content/reference/services/SoftLayer_Ticket_Attachment_File/getTicket.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket_Attachment_File/getUpdate.md b/content/reference/services/SoftLayer_Ticket_Attachment_File/getUpdate.md index 1d4191cee8..55311e832a 100644 --- a/content/reference/services/SoftLayer_Ticket_Attachment_File/getUpdate.md +++ b/content/reference/services/SoftLayer_Ticket_Attachment_File/getUpdate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Attachment_File](/reference/services/SoftLayer_Ticket_Attachment_File)::getUpdate + Retrieve the ticket that a file is attached to. diff --git a/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/_index.md b/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/_index.md index 06993f1403..80edb421c2 100644 --- a/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/_index.md +++ b/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,24 +44,28 @@ classes: #### [getExtensionWhitelist](/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getExtensionWhitelist) +
              #### [getObject](/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getObject) Retrieve a SoftLayer_Ticket_Attachment_File_ServiceNow record. +
              #### [getTicket](/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getTicket) +
              #### [getUpdate](/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getUpdate) Retrieve the ticket that a file is attached to. +
              diff --git a/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getExtensionWhitelist.md b/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getExtensionWhitelist.md index 3b1edfe7f4..0816b5bb6e 100644 --- a/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getExtensionWhitelist.md +++ b/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getExtensionWhitelist.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getObject.md b/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getObject.md index d4d44d72b0..944160060f 100644 --- a/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getObject.md +++ b/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Attachment_File_ServiceNow](/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow)::getObject + Retrieve a SoftLayer_Ticket_Attachment_File_ServiceNow record. diff --git a/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getTicket.md b/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getTicket.md index cf1dc20265..6335200417 100644 --- a/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getTicket.md +++ b/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getTicket.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getUpdate.md b/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getUpdate.md index cc12fcfa59..a149163330 100644 --- a/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getUpdate.md +++ b/content/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow/getUpdate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Attachment_File_ServiceNow](/reference/services/SoftLayer_Ticket_Attachment_File_ServiceNow)::getUpdate + Retrieve the ticket that a file is attached to. diff --git a/content/reference/services/SoftLayer_Ticket_Priority/_index.md b/content/reference/services/SoftLayer_Ticket_Priority/_index.md index 25545213af..9eefeccd43 100644 --- a/content/reference/services/SoftLayer_Ticket_Priority/_index.md +++ b/content/reference/services/SoftLayer_Ticket_Priority/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,6 +44,7 @@ classes: #### [getPriorities](/reference/services/SoftLayer_Ticket_Priority/getPriorities) Obtain a container of valid ticket priority values with value/name key pairs. +
              diff --git a/content/reference/services/SoftLayer_Ticket_Priority/getPriorities.md b/content/reference/services/SoftLayer_Ticket_Priority/getPriorities.md index 3e0fe87084..ceb7bc8c14 100644 --- a/content/reference/services/SoftLayer_Ticket_Priority/getPriorities.md +++ b/content/reference/services/SoftLayer_Ticket_Priority/getPriorities.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Priority](/reference/services/SoftLayer_Ticket_Priority)::getPriorities + Obtain a container of valid ticket priority values with value/name key pairs. diff --git a/content/reference/services/SoftLayer_Ticket_Subject/_index.md b/content/reference/services/SoftLayer_Ticket_Subject/_index.md index 4fefe80f85..d247916066 100644 --- a/content/reference/services/SoftLayer_Ticket_Subject/_index.md +++ b/content/reference/services/SoftLayer_Ticket_Subject/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -50,42 +52,49 @@ Every standard support ticket submitted to SoftLayer contains a relationship to #### [getAllObjects](/reference/services/SoftLayer_Ticket_Subject/getAllObjects) Retrieve all ticket subjects. +
              #### [getCategory](/reference/services/SoftLayer_Ticket_Subject/getCategory) +
              #### [getChildren](/reference/services/SoftLayer_Ticket_Subject/getChildren) Retrieve a child subject +
              #### [getGroup](/reference/services/SoftLayer_Ticket_Subject/getGroup) +
              #### [getObject](/reference/services/SoftLayer_Ticket_Subject/getObject) Retrieve a SoftLayer_Ticket_Subject record. +
              #### [getParent](/reference/services/SoftLayer_Ticket_Subject/getParent) Retrieve a parent subject +
              #### [getTopFiveKnowledgeLayerQuestions](/reference/services/SoftLayer_Ticket_Subject/getTopFiveKnowledgeLayerQuestions) Retrieve the top five KnowledgeLayer questions for a ticket subject +
              diff --git a/content/reference/services/SoftLayer_Ticket_Subject/getAllObjects.md b/content/reference/services/SoftLayer_Ticket_Subject/getAllObjects.md index 243e366dcc..65d6465c07 100644 --- a/content/reference/services/SoftLayer_Ticket_Subject/getAllObjects.md +++ b/content/reference/services/SoftLayer_Ticket_Subject/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Subject](/reference/services/SoftLayer_Ticket_Subject)::getAllObjects + Retrieve all ticket subjects. diff --git a/content/reference/services/SoftLayer_Ticket_Subject/getCategory.md b/content/reference/services/SoftLayer_Ticket_Subject/getCategory.md index 2ede62cba2..ce2f8dc2d5 100644 --- a/content/reference/services/SoftLayer_Ticket_Subject/getCategory.md +++ b/content/reference/services/SoftLayer_Ticket_Subject/getCategory.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket_Subject/getChildren.md b/content/reference/services/SoftLayer_Ticket_Subject/getChildren.md index c72d59a6f3..c4b49d5d8a 100644 --- a/content/reference/services/SoftLayer_Ticket_Subject/getChildren.md +++ b/content/reference/services/SoftLayer_Ticket_Subject/getChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Subject](/reference/services/SoftLayer_Ticket_Subject)::getChildren + Retrieve a child subject diff --git a/content/reference/services/SoftLayer_Ticket_Subject/getGroup.md b/content/reference/services/SoftLayer_Ticket_Subject/getGroup.md index f76ad96b85..b2ff847008 100644 --- a/content/reference/services/SoftLayer_Ticket_Subject/getGroup.md +++ b/content/reference/services/SoftLayer_Ticket_Subject/getGroup.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket_Subject/getObject.md b/content/reference/services/SoftLayer_Ticket_Subject/getObject.md index 909a2d8e43..681c5867f0 100644 --- a/content/reference/services/SoftLayer_Ticket_Subject/getObject.md +++ b/content/reference/services/SoftLayer_Ticket_Subject/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Subject](/reference/services/SoftLayer_Ticket_Subject)::getObject + Retrieve a SoftLayer_Ticket_Subject record. diff --git a/content/reference/services/SoftLayer_Ticket_Subject/getParent.md b/content/reference/services/SoftLayer_Ticket_Subject/getParent.md index 01af48e622..d0ec4da5ca 100644 --- a/content/reference/services/SoftLayer_Ticket_Subject/getParent.md +++ b/content/reference/services/SoftLayer_Ticket_Subject/getParent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Subject](/reference/services/SoftLayer_Ticket_Subject)::getParent + Retrieve a parent subject diff --git a/content/reference/services/SoftLayer_Ticket_Subject/getTopFiveKnowledgeLayerQuestions.md b/content/reference/services/SoftLayer_Ticket_Subject/getTopFiveKnowledgeLayerQuestions.md index d10ea2e68f..44d8813358 100644 --- a/content/reference/services/SoftLayer_Ticket_Subject/getTopFiveKnowledgeLayerQuestions.md +++ b/content/reference/services/SoftLayer_Ticket_Subject/getTopFiveKnowledgeLayerQuestions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Subject](/reference/services/SoftLayer_Ticket_Subject)::getTopFiveKnowledgeLayerQuestions + Retrieve the top five KnowledgeLayer questions for a ticket subject diff --git a/content/reference/services/SoftLayer_Ticket_Subject_Category/_index.md b/content/reference/services/SoftLayer_Ticket_Subject_Category/_index.md index 103b355185..1fb98cfe9d 100644 --- a/content/reference/services/SoftLayer_Ticket_Subject_Category/_index.md +++ b/content/reference/services/SoftLayer_Ticket_Subject_Category/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,18 +44,21 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Ticket_Subject_Category/getAllObjects) Retrieve all ticket subject categories. +
              #### [getObject](/reference/services/SoftLayer_Ticket_Subject_Category/getObject) Retrieve a SoftLayer_Ticket_Subject_Category record. +
              #### [getSubjects](/reference/services/SoftLayer_Ticket_Subject_Category/getSubjects) +
              diff --git a/content/reference/services/SoftLayer_Ticket_Subject_Category/getAllObjects.md b/content/reference/services/SoftLayer_Ticket_Subject_Category/getAllObjects.md index f74e95e364..b66dd470f1 100644 --- a/content/reference/services/SoftLayer_Ticket_Subject_Category/getAllObjects.md +++ b/content/reference/services/SoftLayer_Ticket_Subject_Category/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Subject_Category](/reference/services/SoftLayer_Ticket_Subject_Category)::getAllObjects + Retrieve all ticket subject categories. diff --git a/content/reference/services/SoftLayer_Ticket_Subject_Category/getObject.md b/content/reference/services/SoftLayer_Ticket_Subject_Category/getObject.md index 39023be541..44c16d0d5a 100644 --- a/content/reference/services/SoftLayer_Ticket_Subject_Category/getObject.md +++ b/content/reference/services/SoftLayer_Ticket_Subject_Category/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Subject_Category](/reference/services/SoftLayer_Ticket_Subject_Category)::getObject + Retrieve a SoftLayer_Ticket_Subject_Category record. diff --git a/content/reference/services/SoftLayer_Ticket_Subject_Category/getSubjects.md b/content/reference/services/SoftLayer_Ticket_Subject_Category/getSubjects.md index d04c702de9..dda7d0dfc9 100644 --- a/content/reference/services/SoftLayer_Ticket_Subject_Category/getSubjects.md +++ b/content/reference/services/SoftLayer_Ticket_Subject_Category/getSubjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket_Survey/_index.md b/content/reference/services/SoftLayer_Ticket_Survey/_index.md index c3420f2fce..ecc21da885 100644 --- a/content/reference/services/SoftLayer_Ticket_Survey/_index.md +++ b/content/reference/services/SoftLayer_Ticket_Survey/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -38,22 +40,34 @@ classes:
              -
              +
              #### [getPreference](/reference/services/SoftLayer_Ticket_Survey/getPreference) + +Deprecated + +
              -
              +
              #### [optIn](/reference/services/SoftLayer_Ticket_Survey/optIn) + +Deprecated + +
              -
              +
              #### [optOut](/reference/services/SoftLayer_Ticket_Survey/optOut) + +Deprecated + +
              diff --git a/content/reference/services/SoftLayer_Ticket_Survey/getPreference.md b/content/reference/services/SoftLayer_Ticket_Survey/getPreference.md index 9da6c77500..e37999b091 100644 --- a/content/reference/services/SoftLayer_Ticket_Survey/getPreference.md +++ b/content/reference/services/SoftLayer_Ticket_Survey/getPreference.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Ticket_Survey](/reference/services/SoftLayer_Ticket_Survey)::getPreference +
              Deprecated
              + diff --git a/content/reference/services/SoftLayer_Ticket_Survey/optIn.md b/content/reference/services/SoftLayer_Ticket_Survey/optIn.md index 8193ac90e7..ea7796180d 100644 --- a/content/reference/services/SoftLayer_Ticket_Survey/optIn.md +++ b/content/reference/services/SoftLayer_Ticket_Survey/optIn.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Ticket_Survey](/reference/services/SoftLayer_Ticket_Survey)::optIn +
              Deprecated
              + diff --git a/content/reference/services/SoftLayer_Ticket_Survey/optOut.md b/content/reference/services/SoftLayer_Ticket_Survey/optOut.md index 2f9991fcf0..fea15547c0 100644 --- a/content/reference/services/SoftLayer_Ticket_Survey/optOut.md +++ b/content/reference/services/SoftLayer_Ticket_Survey/optOut.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Ticket_Survey](/reference/services/SoftLayer_Ticket_Survey)::optOut +
              Deprecated
              + diff --git a/content/reference/services/SoftLayer_Ticket_Update_Employee/_index.md b/content/reference/services/SoftLayer_Ticket_Update_Employee/_index.md index 4ded5c17bd..658fda3d50 100644 --- a/content/reference/services/SoftLayer_Ticket_Update_Employee/_index.md +++ b/content/reference/services/SoftLayer_Ticket_Update_Employee/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + 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. @@ -50,48 +52,56 @@ Retrieve an update to a ticket made by a SoftLayer employee. Ticket updates crea #### [addResponseRating](/reference/services/SoftLayer_Ticket_Update_Employee/addResponseRating) Set an update's response rating. +
              #### [getChangeOwnerActivity](/reference/services/SoftLayer_Ticket_Update_Employee/getChangeOwnerActivity) +
              #### [getChat](/reference/services/SoftLayer_Ticket_Update_Employee/getChat) Retrieve the chat between the Customer and Agent +
              #### [getEditor](/reference/services/SoftLayer_Ticket_Update_Employee/getEditor) Retrieve a representation of the SoftLayer employee who created a ticket update. +
              #### [getFileAttachment](/reference/services/SoftLayer_Ticket_Update_Employee/getFileAttachment) Retrieve the files attached to a ticket update. +
              #### [getObject](/reference/services/SoftLayer_Ticket_Update_Employee/getObject) Retrieve a SoftLayer_Ticket_Update_Employee record. +
              #### [getTicket](/reference/services/SoftLayer_Ticket_Update_Employee/getTicket) Retrieve the ticket that a ticket update belongs to. +
              #### [getType](/reference/services/SoftLayer_Ticket_Update_Employee/getType) Retrieve the Type of update to this ticket +
              diff --git a/content/reference/services/SoftLayer_Ticket_Update_Employee/addResponseRating.md b/content/reference/services/SoftLayer_Ticket_Update_Employee/addResponseRating.md index 3645dbf46b..4b86992a44 100644 --- a/content/reference/services/SoftLayer_Ticket_Update_Employee/addResponseRating.md +++ b/content/reference/services/SoftLayer_Ticket_Update_Employee/addResponseRating.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Update_Employee](/reference/services/SoftLayer_Ticket_Update_Employee)::addResponseRating + Set an update's response rating. diff --git a/content/reference/services/SoftLayer_Ticket_Update_Employee/getChangeOwnerActivity.md b/content/reference/services/SoftLayer_Ticket_Update_Employee/getChangeOwnerActivity.md index d8c47f500b..22d1d03004 100644 --- a/content/reference/services/SoftLayer_Ticket_Update_Employee/getChangeOwnerActivity.md +++ b/content/reference/services/SoftLayer_Ticket_Update_Employee/getChangeOwnerActivity.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Ticket_Update_Employee/getChat.md b/content/reference/services/SoftLayer_Ticket_Update_Employee/getChat.md index 48f7db1425..4cb10777f2 100644 --- a/content/reference/services/SoftLayer_Ticket_Update_Employee/getChat.md +++ b/content/reference/services/SoftLayer_Ticket_Update_Employee/getChat.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Update_Employee](/reference/services/SoftLayer_Ticket_Update_Employee)::getChat + Retrieve the chat between the Customer and Agent diff --git a/content/reference/services/SoftLayer_Ticket_Update_Employee/getEditor.md b/content/reference/services/SoftLayer_Ticket_Update_Employee/getEditor.md index 259daa741c..440e1730ab 100644 --- a/content/reference/services/SoftLayer_Ticket_Update_Employee/getEditor.md +++ b/content/reference/services/SoftLayer_Ticket_Update_Employee/getEditor.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Update_Employee](/reference/services/SoftLayer_Ticket_Update_Employee)::getEditor + Retrieve a representation of the SoftLayer employee who created a ticket update. diff --git a/content/reference/services/SoftLayer_Ticket_Update_Employee/getFileAttachment.md b/content/reference/services/SoftLayer_Ticket_Update_Employee/getFileAttachment.md index 52217980bb..17472099a2 100644 --- a/content/reference/services/SoftLayer_Ticket_Update_Employee/getFileAttachment.md +++ b/content/reference/services/SoftLayer_Ticket_Update_Employee/getFileAttachment.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Update_Employee](/reference/services/SoftLayer_Ticket_Update_Employee)::getFileAttachment + Retrieve the files attached to a ticket update. diff --git a/content/reference/services/SoftLayer_Ticket_Update_Employee/getObject.md b/content/reference/services/SoftLayer_Ticket_Update_Employee/getObject.md index 023fe1bc5f..afc360e87c 100644 --- a/content/reference/services/SoftLayer_Ticket_Update_Employee/getObject.md +++ b/content/reference/services/SoftLayer_Ticket_Update_Employee/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Update_Employee](/reference/services/SoftLayer_Ticket_Update_Employee)::getObject + Retrieve a SoftLayer_Ticket_Update_Employee record. diff --git a/content/reference/services/SoftLayer_Ticket_Update_Employee/getTicket.md b/content/reference/services/SoftLayer_Ticket_Update_Employee/getTicket.md index d7cc57472f..dc0ebeee40 100644 --- a/content/reference/services/SoftLayer_Ticket_Update_Employee/getTicket.md +++ b/content/reference/services/SoftLayer_Ticket_Update_Employee/getTicket.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Update_Employee](/reference/services/SoftLayer_Ticket_Update_Employee)::getTicket + Retrieve the ticket that a ticket update belongs to. diff --git a/content/reference/services/SoftLayer_Ticket_Update_Employee/getType.md b/content/reference/services/SoftLayer_Ticket_Update_Employee/getType.md index b5dbfa044f..6f24001dc2 100644 --- a/content/reference/services/SoftLayer_Ticket_Update_Employee/getType.md +++ b/content/reference/services/SoftLayer_Ticket_Update_Employee/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Ticket_Update_Employee](/reference/services/SoftLayer_Ticket_Update_Employee)::getType + Retrieve the Type of update to this ticket diff --git a/content/reference/services/SoftLayer_User_Customer/_index.md b/content/reference/services/SoftLayer_User_Customer/_index.md index 4a973cb1f5..c31ba90fd1 100644 --- a/content/reference/services/SoftLayer_User_Customer/_index.md +++ b/content/reference/services/SoftLayer_User_Customer/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + 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. @@ -46,768 +48,899 @@ There are two relational properties that contain the permissions assigned to a c #### [acknowledgeSupportPolicy](/reference/services/SoftLayer_User_Customer/acknowledgeSupportPolicy) +
              #### [addApiAuthenticationKey](/reference/services/SoftLayer_User_Customer/addApiAuthenticationKey) Create a user's API authentication key. +
              #### [addBulkDedicatedHostAccess](/reference/services/SoftLayer_User_Customer/addBulkDedicatedHostAccess) Grant access to the user for one or more dedicated hosts devices. +
              #### [addBulkHardwareAccess](/reference/services/SoftLayer_User_Customer/addBulkHardwareAccess) Add multiple hardware to a portal user's hardware access list. +
              #### [addBulkPortalPermission](/reference/services/SoftLayer_User_Customer/addBulkPortalPermission) Add multiple permissions to a portal user's permission set. +
              #### [addBulkRoles](/reference/services/SoftLayer_User_Customer/addBulkRoles) +
              #### [addBulkVirtualGuestAccess](/reference/services/SoftLayer_User_Customer/addBulkVirtualGuestAccess) Add multiple CloudLayer Computing Instances to a portal user's access list. +
              #### [addDedicatedHostAccess](/reference/services/SoftLayer_User_Customer/addDedicatedHostAccess) Grant access to the user for a single dedicated host device. +
              #### [addExternalBinding](/reference/services/SoftLayer_User_Customer/addExternalBinding) +
              #### [addHardwareAccess](/reference/services/SoftLayer_User_Customer/addHardwareAccess) Add hardware to a portal user's hardware access list. +
              #### [addNotificationSubscriber](/reference/services/SoftLayer_User_Customer/addNotificationSubscriber) Create a notification subscription record for the user. +
              #### [addPortalPermission](/reference/services/SoftLayer_User_Customer/addPortalPermission) Add a permission to a portal user's permission set. +
              #### [addRole](/reference/services/SoftLayer_User_Customer/addRole) +
              #### [addVirtualGuestAccess](/reference/services/SoftLayer_User_Customer/addVirtualGuestAccess) Add a CloudLayer Computing Instance to a portal user's access list. +
              #### [assignNewParentId](/reference/services/SoftLayer_User_Customer/assignNewParentId) Assign a different parent to this user. +
              #### [changePreference](/reference/services/SoftLayer_User_Customer/changePreference) Change preference values for the current user +
              #### [checkExternalAuthenticationStatus](/reference/services/SoftLayer_User_Customer/checkExternalAuthenticationStatus) Checks if an external authentication is complete or not +
              #### [checkPhoneFactorAuthenticationForPasswordSet](/reference/services/SoftLayer_User_Customer/checkPhoneFactorAuthenticationForPasswordSet) Check the status of an outstanding Phone Factor Authentication for Password Set +
              #### [createNotificationSubscriber](/reference/services/SoftLayer_User_Customer/createNotificationSubscriber) Create a new subscriber for a given resource. +
              #### [createObject](/reference/services/SoftLayer_User_Customer/createObject) Create a new user record. +
              #### [createSubscriberDeliveryMethods](/reference/services/SoftLayer_User_Customer/createSubscriberDeliveryMethods) Create delivery methods for the subscriber. +
              #### [deactivateNotificationSubscriber](/reference/services/SoftLayer_User_Customer/deactivateNotificationSubscriber) Delete a subscriber for a given resource. +
              #### [editObject](/reference/services/SoftLayer_User_Customer/editObject) Update a user's information. +
              #### [editObjects](/reference/services/SoftLayer_User_Customer/editObjects) Update a collection of users' information +
              #### [findUserPreference](/reference/services/SoftLayer_User_Customer/findUserPreference) +
              #### [getAccount](/reference/services/SoftLayer_User_Customer/getAccount) Retrieve the customer account that a user belongs to. +
              #### [getActions](/reference/services/SoftLayer_User_Customer/getActions) +
              #### [getActiveExternalAuthenticationVendors](/reference/services/SoftLayer_User_Customer/getActiveExternalAuthenticationVendors) Get a list of active external authentication vendors for a SoftLayer user. +
              #### [getAdditionalEmails](/reference/services/SoftLayer_User_Customer/getAdditionalEmails) Retrieve a portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets. +
              #### [getAgentImpersonationToken](/reference/services/SoftLayer_User_Customer/getAgentImpersonationToken) +
              #### [getAllowedDedicatedHostIds](/reference/services/SoftLayer_User_Customer/getAllowedDedicatedHostIds) +
              #### [getAllowedHardwareIds](/reference/services/SoftLayer_User_Customer/getAllowedHardwareIds) +
              #### [getAllowedVirtualGuestIds](/reference/services/SoftLayer_User_Customer/getAllowedVirtualGuestIds) +
              #### [getApiAuthenticationKeys](/reference/services/SoftLayer_User_Customer/getApiAuthenticationKeys) Retrieve a portal user's API Authentication keys. There is a max limit of one API key per user. +
              #### [getAuthenticationToken](/reference/services/SoftLayer_User_Customer/getAuthenticationToken) +
              #### [getChildUsers](/reference/services/SoftLayer_User_Customer/getChildUsers) Retrieve a portal user's child users. Some portal users may not have child users. +
              #### [getClosedTickets](/reference/services/SoftLayer_User_Customer/getClosedTickets) Retrieve an user's associated closed tickets. +
              #### [getDedicatedHosts](/reference/services/SoftLayer_User_Customer/getDedicatedHosts) Retrieve the dedicated hosts to which the user has been granted access. +
              #### [getDefaultAccount](/reference/services/SoftLayer_User_Customer/getDefaultAccount) This method should never be invoked as it is not applicable to legacy SoftLayer-authenticated users. See SoftLayer_User_Customer_OpenIdConnect::getDefaultAccount instead. +
              #### [getExternalBindings](/reference/services/SoftLayer_User_Customer/getExternalBindings) Retrieve the external authentication bindings that link an external identifier to a SoftLayer user. +
              #### [getHardware](/reference/services/SoftLayer_User_Customer/getHardware) Retrieve a portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal. +
              #### [getHardwareCount](/reference/services/SoftLayer_User_Customer/getHardwareCount) Retrieve the current number of servers a portal user has access to. +
              #### [getHardwareNotifications](/reference/services/SoftLayer_User_Customer/getHardwareNotifications) Retrieve hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'. +
              #### [getHasAcknowledgedSupportPolicyFlag](/reference/services/SoftLayer_User_Customer/getHasAcknowledgedSupportPolicyFlag) Retrieve whether or not a user has acknowledged the support policy. +
              #### [getHasFullDedicatedHostAccessFlag](/reference/services/SoftLayer_User_Customer/getHasFullDedicatedHostAccessFlag) Retrieve permission granting the user access to all Dedicated Host devices on the account. +
              #### [getHasFullHardwareAccessFlag](/reference/services/SoftLayer_User_Customer/getHasFullHardwareAccessFlag) Retrieve whether or not a portal user has access to all hardware on their account. +
              #### [getHasFullVirtualGuestAccessFlag](/reference/services/SoftLayer_User_Customer/getHasFullVirtualGuestAccessFlag) Retrieve whether or not a portal user has access to all virtual guests on their account. +
              #### [getIbmIdLink](/reference/services/SoftLayer_User_Customer/getIbmIdLink) Retrieve specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link. +
              #### [getImpersonationToken](/reference/services/SoftLayer_User_Customer/getImpersonationToken) +
              #### [getLayoutProfiles](/reference/services/SoftLayer_User_Customer/getLayoutProfiles) Retrieve contains the definition of the layout profile. +
              #### [getLocale](/reference/services/SoftLayer_User_Customer/getLocale) Retrieve a user's locale. Locale holds user's language and region information. +
              #### [getLoginAttempts](/reference/services/SoftLayer_User_Customer/getLoginAttempts) Retrieve a user's attempts to log into the SoftLayer customer portal. +
              #### [getLoginToken](/reference/services/SoftLayer_User_Customer/getLoginToken) Authenticate a user for the SoftLayer customer portal +
              #### [getMappedAccounts](/reference/services/SoftLayer_User_Customer/getMappedAccounts) Retrieve a list of all the accounts that belong to this customer. +
              #### [getMobileDevices](/reference/services/SoftLayer_User_Customer/getMobileDevices) Retrieve a portal user's associated mobile device profiles. +
              #### [getNotificationSubscribers](/reference/services/SoftLayer_User_Customer/getNotificationSubscribers) Retrieve notification subscription records for the user. +
              #### [getObject](/reference/services/SoftLayer_User_Customer/getObject) Retrieve a SoftLayer_User_Customer record. +
              #### [getOpenIdConnectMigrationState](/reference/services/SoftLayer_User_Customer/getOpenIdConnectMigrationState) Get the OpenId migration state +
              #### [getOpenTickets](/reference/services/SoftLayer_User_Customer/getOpenTickets) Retrieve an user's associated open tickets. +
              #### [getOverrides](/reference/services/SoftLayer_User_Customer/getOverrides) Retrieve a portal user's vpn accessible subnets. +
              #### [getParent](/reference/services/SoftLayer_User_Customer/getParent) Retrieve a portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user. +
              #### [getPasswordRequirements](/reference/services/SoftLayer_User_Customer/getPasswordRequirements) +
              #### [getPermissions](/reference/services/SoftLayer_User_Customer/getPermissions) Retrieve a portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API. +
              #### [getPortalLoginToken](/reference/services/SoftLayer_User_Customer/getPortalLoginToken) Authenticate a user for the SoftLayer customer portal +
              #### [getPreference](/reference/services/SoftLayer_User_Customer/getPreference) Get a preference value for the current user +
              #### [getPreferenceTypes](/reference/services/SoftLayer_User_Customer/getPreferenceTypes) Get all available preference types +
              #### [getPreferences](/reference/services/SoftLayer_User_Customer/getPreferences) Retrieve data type contains a single user preference to a specific preference type. +
              #### [getRequirementsForPasswordSet](/reference/services/SoftLayer_User_Customer/getRequirementsForPasswordSet) Retrieve the authentication requirements for a user when attempting +
              #### [getRoles](/reference/services/SoftLayer_User_Customer/getRoles) +
              #### [getSalesforceUserLink](/reference/services/SoftLayer_User_Customer/getSalesforceUserLink) Retrieve [DEPRECATED] +
              #### [getSecurityAnswers](/reference/services/SoftLayer_User_Customer/getSecurityAnswers) Retrieve a portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login. +
              #### [getSubscribers](/reference/services/SoftLayer_User_Customer/getSubscribers) Retrieve a user's notification subscription records. +
              #### [getSuccessfulLogins](/reference/services/SoftLayer_User_Customer/getSuccessfulLogins) Retrieve a user's successful attempts to log into the SoftLayer customer portal. +
              #### [getSupportPolicyAcknowledgementRequiredFlag](/reference/services/SoftLayer_User_Customer/getSupportPolicyAcknowledgementRequiredFlag) Retrieve whether or not a user is required to acknowledge the support policy for portal access. +
              #### [getSupportPolicyDocument](/reference/services/SoftLayer_User_Customer/getSupportPolicyDocument) +
              #### [getSupportPolicyName](/reference/services/SoftLayer_User_Customer/getSupportPolicyName) +
              #### [getSupportedLocales](/reference/services/SoftLayer_User_Customer/getSupportedLocales) Returns all supported locales for the current user +
              #### [getSurveyRequiredFlag](/reference/services/SoftLayer_User_Customer/getSurveyRequiredFlag) Retrieve whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal. +
              #### [getSurveys](/reference/services/SoftLayer_User_Customer/getSurveys) Retrieve the surveys that a user has taken in the SoftLayer customer portal. +
              #### [getTickets](/reference/services/SoftLayer_User_Customer/getTickets) Retrieve an user's associated tickets. +
              #### [getTimezone](/reference/services/SoftLayer_User_Customer/getTimezone) Retrieve a portal user's time zone. +
              #### [getUnsuccessfulLogins](/reference/services/SoftLayer_User_Customer/getUnsuccessfulLogins) Retrieve a user's unsuccessful attempts to log into the SoftLayer customer portal. +
              #### [getUserIdForPasswordSet](/reference/services/SoftLayer_User_Customer/getUserIdForPasswordSet) Retrieve a user id using a password request key +
              #### [getUserLinks](/reference/services/SoftLayer_User_Customer/getUserLinks) Retrieve user customer link with IBMid and IAMid. +
              #### [getUserPreferences](/reference/services/SoftLayer_User_Customer/getUserPreferences) +
              #### [getUserStatus](/reference/services/SoftLayer_User_Customer/getUserStatus) Retrieve a portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network. +
              #### [getVirtualGuestCount](/reference/services/SoftLayer_User_Customer/getVirtualGuestCount) Retrieve the current number of CloudLayer Computing Instances a portal user has access to. +
              #### [getVirtualGuests](/reference/services/SoftLayer_User_Customer/getVirtualGuests) Retrieve a portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal. +
              #### [inTerminalStatus](/reference/services/SoftLayer_User_Customer/inTerminalStatus) +
              #### [initiateExternalAuthentication](/reference/services/SoftLayer_User_Customer/initiateExternalAuthentication) Initiates an external authentication using the given authentication container. +
              #### [initiatePortalPasswordChange](/reference/services/SoftLayer_User_Customer/initiatePortalPasswordChange) Request email to allow user to change their password +
              #### [initiatePortalPasswordChangeByBrandAgent](/reference/services/SoftLayer_User_Customer/initiatePortalPasswordChangeByBrandAgent) Allows a Brand Agent to request password reset email to be sent to +
              #### [inviteUserToLinkOpenIdConnect](/reference/services/SoftLayer_User_Customer/inviteUserToLinkOpenIdConnect) Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect. +
              -
              +
              #### [isMasterUser](/reference/services/SoftLayer_User_Customer/isMasterUser) Determine if a portal user is a master user. + +Deprecated + +
              #### [isValidPortalPassword](/reference/services/SoftLayer_User_Customer/isValidPortalPassword) Determine if a string is a user's portal password. +
              #### [performExternalAuthentication](/reference/services/SoftLayer_User_Customer/performExternalAuthentication) Perform an external authentication using the given authentication container. +
              #### [processPasswordSetRequest](/reference/services/SoftLayer_User_Customer/processPasswordSetRequest) Set the password for a user who has a valid password request key +
              #### [removeAllDedicatedHostAccessForThisUser](/reference/services/SoftLayer_User_Customer/removeAllDedicatedHostAccessForThisUser) Revoke access to all dedicated hosts on the account for this user. +
              #### [removeAllHardwareAccessForThisUser](/reference/services/SoftLayer_User_Customer/removeAllHardwareAccessForThisUser) Remove all hardware from a portal user's hardware access list. +
              #### [removeAllVirtualAccessForThisUser](/reference/services/SoftLayer_User_Customer/removeAllVirtualAccessForThisUser) Remove all cloud computing instances from a portal user's instance access list. +
              #### [removeApiAuthenticationKey](/reference/services/SoftLayer_User_Customer/removeApiAuthenticationKey) Remove a user's API authentication key. +
              #### [removeBulkDedicatedHostAccess](/reference/services/SoftLayer_User_Customer/removeBulkDedicatedHostAccess) Revoke access for the user for one or more dedicated hosts devices. +
              #### [removeBulkHardwareAccess](/reference/services/SoftLayer_User_Customer/removeBulkHardwareAccess) Remove multiple hardware from a portal user's hardware access list. +
              #### [removeBulkPortalPermission](/reference/services/SoftLayer_User_Customer/removeBulkPortalPermission) Remove multiple permissions from a portal user's permission set. +
              #### [removeBulkRoles](/reference/services/SoftLayer_User_Customer/removeBulkRoles) +
              #### [removeBulkVirtualGuestAccess](/reference/services/SoftLayer_User_Customer/removeBulkVirtualGuestAccess) Remove multiple CloudLayer Computing Instances from a portal user's access list. +
              #### [removeDedicatedHostAccess](/reference/services/SoftLayer_User_Customer/removeDedicatedHostAccess) Revoke access for the user to a single dedicated hosts device. +
              #### [removeExternalBinding](/reference/services/SoftLayer_User_Customer/removeExternalBinding) Remove an external binding from this user. +
              #### [removeHardwareAccess](/reference/services/SoftLayer_User_Customer/removeHardwareAccess) Remove hardware from a portal user's hardware access list. +
              #### [removePortalPermission](/reference/services/SoftLayer_User_Customer/removePortalPermission) Remove a permission from a portal user's permission set. +
              #### [removeRole](/reference/services/SoftLayer_User_Customer/removeRole) +
              #### [removeSecurityAnswers](/reference/services/SoftLayer_User_Customer/removeSecurityAnswers) +
              #### [removeVirtualGuestAccess](/reference/services/SoftLayer_User_Customer/removeVirtualGuestAccess) Remove a CloudLayer Computing Instance from a portal user's access list. +
              #### [resetOpenIdConnectLink](/reference/services/SoftLayer_User_Customer/resetOpenIdConnectLink) Change the link of a user for OpenIdConnect managed accounts, provided the +
              #### [resetOpenIdConnectLinkUnifiedUserManagementMode](/reference/services/SoftLayer_User_Customer/resetOpenIdConnectLinkUnifiedUserManagementMode) Change the link of a master user for OpenIdConnect managed accounts, +
              #### [samlAuthenticate](/reference/services/SoftLayer_User_Customer/samlAuthenticate) +
              #### [samlBeginAuthentication](/reference/services/SoftLayer_User_Customer/samlBeginAuthentication) +
              #### [samlBeginLogout](/reference/services/SoftLayer_User_Customer/samlBeginLogout) +
              #### [samlLogout](/reference/services/SoftLayer_User_Customer/samlLogout) +
              #### [selfPasswordChange](/reference/services/SoftLayer_User_Customer/selfPasswordChange) +
              #### [setDefaultAccount](/reference/services/SoftLayer_User_Customer/setDefaultAccount) Sets the default account for the OpenIdConnect identity that is linked to the current SoftLayer user identity. +
              #### [silentlyMigrateUserOpenIdConnect](/reference/services/SoftLayer_User_Customer/silentlyMigrateUserOpenIdConnect) This api is used to migrate a user to IBMid without sending an invitation. +
              #### [updateNotificationSubscriber](/reference/services/SoftLayer_User_Customer/updateNotificationSubscriber) Update the active status for a notification subscription. +
              #### [updateSecurityAnswers](/reference/services/SoftLayer_User_Customer/updateSecurityAnswers) Update portal login security questions and answers. +
              #### [updateSubscriberDeliveryMethod](/reference/services/SoftLayer_User_Customer/updateSubscriberDeliveryMethod) Update a delivery method for the subscriber. +
              #### [updateVpnPassword](/reference/services/SoftLayer_User_Customer/updateVpnPassword) Update a user's VPN password +
              #### [updateVpnUser](/reference/services/SoftLayer_User_Customer/updateVpnUser) Creates or updates a user's VPN access privileges. +
              #### [validateAuthenticationToken](/reference/services/SoftLayer_User_Customer/validateAuthenticationToken) +
              diff --git a/content/reference/services/SoftLayer_User_Customer/acknowledgeSupportPolicy.md b/content/reference/services/SoftLayer_User_Customer/acknowledgeSupportPolicy.md index 9e6d4347a8..d883bf96bd 100644 --- a/content/reference/services/SoftLayer_User_Customer/acknowledgeSupportPolicy.md +++ b/content/reference/services/SoftLayer_User_Customer/acknowledgeSupportPolicy.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/addApiAuthenticationKey.md b/content/reference/services/SoftLayer_User_Customer/addApiAuthenticationKey.md index 71f10618f0..0ebbe3be40 100644 --- a/content/reference/services/SoftLayer_User_Customer/addApiAuthenticationKey.md +++ b/content/reference/services/SoftLayer_User_Customer/addApiAuthenticationKey.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::addApiAuthenticationKey + Create a user's API authentication key. diff --git a/content/reference/services/SoftLayer_User_Customer/addBulkDedicatedHostAccess.md b/content/reference/services/SoftLayer_User_Customer/addBulkDedicatedHostAccess.md index 2f2fbbaf08..36016f2476 100644 --- a/content/reference/services/SoftLayer_User_Customer/addBulkDedicatedHostAccess.md +++ b/content/reference/services/SoftLayer_User_Customer/addBulkDedicatedHostAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::addBulkDedicatedHostAccess + Grant access to the user for one or more dedicated hosts devices. diff --git a/content/reference/services/SoftLayer_User_Customer/addBulkHardwareAccess.md b/content/reference/services/SoftLayer_User_Customer/addBulkHardwareAccess.md index c55361f94f..e048f1428a 100644 --- a/content/reference/services/SoftLayer_User_Customer/addBulkHardwareAccess.md +++ b/content/reference/services/SoftLayer_User_Customer/addBulkHardwareAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::addBulkHardwareAccess + Add multiple hardware to a portal user's hardware access list. diff --git a/content/reference/services/SoftLayer_User_Customer/addBulkPortalPermission.md b/content/reference/services/SoftLayer_User_Customer/addBulkPortalPermission.md index 387136b167..71fdad8bcd 100644 --- a/content/reference/services/SoftLayer_User_Customer/addBulkPortalPermission.md +++ b/content/reference/services/SoftLayer_User_Customer/addBulkPortalPermission.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::addBulkPortalPermission + Add multiple permissions to a portal user's permission set. diff --git a/content/reference/services/SoftLayer_User_Customer/addBulkRoles.md b/content/reference/services/SoftLayer_User_Customer/addBulkRoles.md index bfedfb28d4..bb81414724 100644 --- a/content/reference/services/SoftLayer_User_Customer/addBulkRoles.md +++ b/content/reference/services/SoftLayer_User_Customer/addBulkRoles.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/addBulkVirtualGuestAccess.md b/content/reference/services/SoftLayer_User_Customer/addBulkVirtualGuestAccess.md index 7d12601e6f..e992747c40 100644 --- a/content/reference/services/SoftLayer_User_Customer/addBulkVirtualGuestAccess.md +++ b/content/reference/services/SoftLayer_User_Customer/addBulkVirtualGuestAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::addBulkVirtualGuestAccess + Add multiple CloudLayer Computing Instances to a portal user's access list. diff --git a/content/reference/services/SoftLayer_User_Customer/addDedicatedHostAccess.md b/content/reference/services/SoftLayer_User_Customer/addDedicatedHostAccess.md index 497316b07b..07d627892b 100644 --- a/content/reference/services/SoftLayer_User_Customer/addDedicatedHostAccess.md +++ b/content/reference/services/SoftLayer_User_Customer/addDedicatedHostAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::addDedicatedHostAccess + Grant access to the user for a single dedicated host device. diff --git a/content/reference/services/SoftLayer_User_Customer/addExternalBinding.md b/content/reference/services/SoftLayer_User_Customer/addExternalBinding.md index 78eacfbaf6..5e2175a3d0 100644 --- a/content/reference/services/SoftLayer_User_Customer/addExternalBinding.md +++ b/content/reference/services/SoftLayer_User_Customer/addExternalBinding.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/addHardwareAccess.md b/content/reference/services/SoftLayer_User_Customer/addHardwareAccess.md index 0de3ef3a64..a40901d797 100644 --- a/content/reference/services/SoftLayer_User_Customer/addHardwareAccess.md +++ b/content/reference/services/SoftLayer_User_Customer/addHardwareAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::addHardwareAccess + Add hardware to a portal user's hardware access list. diff --git a/content/reference/services/SoftLayer_User_Customer/addNotificationSubscriber.md b/content/reference/services/SoftLayer_User_Customer/addNotificationSubscriber.md index 9f7711061a..e6bcc07a24 100644 --- a/content/reference/services/SoftLayer_User_Customer/addNotificationSubscriber.md +++ b/content/reference/services/SoftLayer_User_Customer/addNotificationSubscriber.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::addNotificationSubscriber + Create a notification subscription record for the user. diff --git a/content/reference/services/SoftLayer_User_Customer/addPortalPermission.md b/content/reference/services/SoftLayer_User_Customer/addPortalPermission.md index 2cb1969093..1531829d79 100644 --- a/content/reference/services/SoftLayer_User_Customer/addPortalPermission.md +++ b/content/reference/services/SoftLayer_User_Customer/addPortalPermission.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::addPortalPermission + Add a permission to a portal user's permission set. diff --git a/content/reference/services/SoftLayer_User_Customer/addRole.md b/content/reference/services/SoftLayer_User_Customer/addRole.md index d6928ccd2a..602f924e2b 100644 --- a/content/reference/services/SoftLayer_User_Customer/addRole.md +++ b/content/reference/services/SoftLayer_User_Customer/addRole.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/addVirtualGuestAccess.md b/content/reference/services/SoftLayer_User_Customer/addVirtualGuestAccess.md index 8d036c9c39..889ca08fcc 100644 --- a/content/reference/services/SoftLayer_User_Customer/addVirtualGuestAccess.md +++ b/content/reference/services/SoftLayer_User_Customer/addVirtualGuestAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::addVirtualGuestAccess + Add a CloudLayer Computing Instance to a portal user's access list. diff --git a/content/reference/services/SoftLayer_User_Customer/assignNewParentId.md b/content/reference/services/SoftLayer_User_Customer/assignNewParentId.md index d704f929f5..a4c52da81f 100644 --- a/content/reference/services/SoftLayer_User_Customer/assignNewParentId.md +++ b/content/reference/services/SoftLayer_User_Customer/assignNewParentId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::assignNewParentId + Assign a different parent to this user. diff --git a/content/reference/services/SoftLayer_User_Customer/changePreference.md b/content/reference/services/SoftLayer_User_Customer/changePreference.md index c0919f2b94..33aca20305 100644 --- a/content/reference/services/SoftLayer_User_Customer/changePreference.md +++ b/content/reference/services/SoftLayer_User_Customer/changePreference.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::changePreference + Change preference values for the current user diff --git a/content/reference/services/SoftLayer_User_Customer/checkExternalAuthenticationStatus.md b/content/reference/services/SoftLayer_User_Customer/checkExternalAuthenticationStatus.md index f351548010..b7318e3300 100644 --- a/content/reference/services/SoftLayer_User_Customer/checkExternalAuthenticationStatus.md +++ b/content/reference/services/SoftLayer_User_Customer/checkExternalAuthenticationStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::checkExternalAuthenticationStatus + Checks if an external authentication is complete or not diff --git a/content/reference/services/SoftLayer_User_Customer/checkPhoneFactorAuthenticationForPasswordSet.md b/content/reference/services/SoftLayer_User_Customer/checkPhoneFactorAuthenticationForPasswordSet.md index 102d71e131..7c563d7782 100644 --- a/content/reference/services/SoftLayer_User_Customer/checkPhoneFactorAuthenticationForPasswordSet.md +++ b/content/reference/services/SoftLayer_User_Customer/checkPhoneFactorAuthenticationForPasswordSet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::checkPhoneFactorAuthenticationForPasswordSet + Check the status of an outstanding Phone Factor Authentication for Password Set diff --git a/content/reference/services/SoftLayer_User_Customer/createNotificationSubscriber.md b/content/reference/services/SoftLayer_User_Customer/createNotificationSubscriber.md index a3466c475d..5bc43d85d8 100644 --- a/content/reference/services/SoftLayer_User_Customer/createNotificationSubscriber.md +++ b/content/reference/services/SoftLayer_User_Customer/createNotificationSubscriber.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::createNotificationSubscriber + Create a new subscriber for a given resource. diff --git a/content/reference/services/SoftLayer_User_Customer/createObject.md b/content/reference/services/SoftLayer_User_Customer/createObject.md index a0c4697b0f..fe4808b964 100644 --- a/content/reference/services/SoftLayer_User_Customer/createObject.md +++ b/content/reference/services/SoftLayer_User_Customer/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::createObject + Create a new user record. diff --git a/content/reference/services/SoftLayer_User_Customer/createSubscriberDeliveryMethods.md b/content/reference/services/SoftLayer_User_Customer/createSubscriberDeliveryMethods.md index f2a598f4ec..759b4f831b 100644 --- a/content/reference/services/SoftLayer_User_Customer/createSubscriberDeliveryMethods.md +++ b/content/reference/services/SoftLayer_User_Customer/createSubscriberDeliveryMethods.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::createSubscriberDeliveryMethods + Create delivery methods for the subscriber. diff --git a/content/reference/services/SoftLayer_User_Customer/deactivateNotificationSubscriber.md b/content/reference/services/SoftLayer_User_Customer/deactivateNotificationSubscriber.md index 6b7ad14c7d..f02db7543f 100644 --- a/content/reference/services/SoftLayer_User_Customer/deactivateNotificationSubscriber.md +++ b/content/reference/services/SoftLayer_User_Customer/deactivateNotificationSubscriber.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::deactivateNotificationSubscriber + Delete a subscriber for a given resource. diff --git a/content/reference/services/SoftLayer_User_Customer/editObject.md b/content/reference/services/SoftLayer_User_Customer/editObject.md index 6fd103fbca..ee42b4f960 100644 --- a/content/reference/services/SoftLayer_User_Customer/editObject.md +++ b/content/reference/services/SoftLayer_User_Customer/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::editObject + Update a user's information. diff --git a/content/reference/services/SoftLayer_User_Customer/editObjects.md b/content/reference/services/SoftLayer_User_Customer/editObjects.md index c539a08981..cb7dfdeaa2 100644 --- a/content/reference/services/SoftLayer_User_Customer/editObjects.md +++ b/content/reference/services/SoftLayer_User_Customer/editObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::editObjects + Update a collection of users' information diff --git a/content/reference/services/SoftLayer_User_Customer/findUserPreference.md b/content/reference/services/SoftLayer_User_Customer/findUserPreference.md index dd9e353fd3..d32a1e8381 100644 --- a/content/reference/services/SoftLayer_User_Customer/findUserPreference.md +++ b/content/reference/services/SoftLayer_User_Customer/findUserPreference.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/getAccount.md b/content/reference/services/SoftLayer_User_Customer/getAccount.md index eefbdd8a85..974f19ac24 100644 --- a/content/reference/services/SoftLayer_User_Customer/getAccount.md +++ b/content/reference/services/SoftLayer_User_Customer/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getAccount + Retrieve the customer account that a user belongs to. diff --git a/content/reference/services/SoftLayer_User_Customer/getActions.md b/content/reference/services/SoftLayer_User_Customer/getActions.md index 3c4c5d62b7..508cfa1253 100644 --- a/content/reference/services/SoftLayer_User_Customer/getActions.md +++ b/content/reference/services/SoftLayer_User_Customer/getActions.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/getActiveExternalAuthenticationVendors.md b/content/reference/services/SoftLayer_User_Customer/getActiveExternalAuthenticationVendors.md index 6549af219e..512830baa3 100644 --- a/content/reference/services/SoftLayer_User_Customer/getActiveExternalAuthenticationVendors.md +++ b/content/reference/services/SoftLayer_User_Customer/getActiveExternalAuthenticationVendors.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getActiveExternalAuthenticationVendors + Get a list of active external authentication vendors for a SoftLayer user. diff --git a/content/reference/services/SoftLayer_User_Customer/getAdditionalEmails.md b/content/reference/services/SoftLayer_User_Customer/getAdditionalEmails.md index 8132fcbaca..1a4f6a1fb3 100644 --- a/content/reference/services/SoftLayer_User_Customer/getAdditionalEmails.md +++ b/content/reference/services/SoftLayer_User_Customer/getAdditionalEmails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getAdditionalEmails + Retrieve a portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets. diff --git a/content/reference/services/SoftLayer_User_Customer/getAgentImpersonationToken.md b/content/reference/services/SoftLayer_User_Customer/getAgentImpersonationToken.md index 4d473fe875..4e3eb81c59 100644 --- a/content/reference/services/SoftLayer_User_Customer/getAgentImpersonationToken.md +++ b/content/reference/services/SoftLayer_User_Customer/getAgentImpersonationToken.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/getAllowedDedicatedHostIds.md b/content/reference/services/SoftLayer_User_Customer/getAllowedDedicatedHostIds.md index 0064f3c29d..452021efa1 100644 --- a/content/reference/services/SoftLayer_User_Customer/getAllowedDedicatedHostIds.md +++ b/content/reference/services/SoftLayer_User_Customer/getAllowedDedicatedHostIds.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/getAllowedHardwareIds.md b/content/reference/services/SoftLayer_User_Customer/getAllowedHardwareIds.md index 871a1fabd1..6caa83918c 100644 --- a/content/reference/services/SoftLayer_User_Customer/getAllowedHardwareIds.md +++ b/content/reference/services/SoftLayer_User_Customer/getAllowedHardwareIds.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/getAllowedVirtualGuestIds.md b/content/reference/services/SoftLayer_User_Customer/getAllowedVirtualGuestIds.md index 6c71a1f48d..ea19f0cff2 100644 --- a/content/reference/services/SoftLayer_User_Customer/getAllowedVirtualGuestIds.md +++ b/content/reference/services/SoftLayer_User_Customer/getAllowedVirtualGuestIds.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/getApiAuthenticationKeys.md b/content/reference/services/SoftLayer_User_Customer/getApiAuthenticationKeys.md index 1d5479036f..76d6e253e8 100644 --- a/content/reference/services/SoftLayer_User_Customer/getApiAuthenticationKeys.md +++ b/content/reference/services/SoftLayer_User_Customer/getApiAuthenticationKeys.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getApiAuthenticationKeys + Retrieve a portal user's API Authentication keys. There is a max limit of one API key per user. diff --git a/content/reference/services/SoftLayer_User_Customer/getAuthenticationToken.md b/content/reference/services/SoftLayer_User_Customer/getAuthenticationToken.md index e2d815a2a2..42fd6d8295 100644 --- a/content/reference/services/SoftLayer_User_Customer/getAuthenticationToken.md +++ b/content/reference/services/SoftLayer_User_Customer/getAuthenticationToken.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/getChildUsers.md b/content/reference/services/SoftLayer_User_Customer/getChildUsers.md index 41d9c67fa8..d6022323e3 100644 --- a/content/reference/services/SoftLayer_User_Customer/getChildUsers.md +++ b/content/reference/services/SoftLayer_User_Customer/getChildUsers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getChildUsers + Retrieve a portal user's child users. Some portal users may not have child users. diff --git a/content/reference/services/SoftLayer_User_Customer/getClosedTickets.md b/content/reference/services/SoftLayer_User_Customer/getClosedTickets.md index f288636710..45a2ba808c 100644 --- a/content/reference/services/SoftLayer_User_Customer/getClosedTickets.md +++ b/content/reference/services/SoftLayer_User_Customer/getClosedTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getClosedTickets + Retrieve an user's associated closed tickets. diff --git a/content/reference/services/SoftLayer_User_Customer/getDedicatedHosts.md b/content/reference/services/SoftLayer_User_Customer/getDedicatedHosts.md index 4b2e28a5fc..9f6d976c16 100644 --- a/content/reference/services/SoftLayer_User_Customer/getDedicatedHosts.md +++ b/content/reference/services/SoftLayer_User_Customer/getDedicatedHosts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getDedicatedHosts + Retrieve the dedicated hosts to which the user has been granted access. diff --git a/content/reference/services/SoftLayer_User_Customer/getDefaultAccount.md b/content/reference/services/SoftLayer_User_Customer/getDefaultAccount.md index b054119a41..1ce18423d2 100644 --- a/content/reference/services/SoftLayer_User_Customer/getDefaultAccount.md +++ b/content/reference/services/SoftLayer_User_Customer/getDefaultAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getDefaultAccount + This method should never be invoked as it is not applicable to legacy SoftLayer-authenticated users. See SoftLayer_User_Customer_OpenIdConnect::getDefaultAccount instead. diff --git a/content/reference/services/SoftLayer_User_Customer/getExternalBindings.md b/content/reference/services/SoftLayer_User_Customer/getExternalBindings.md index 4b0ef3c82a..b8b2e998ee 100644 --- a/content/reference/services/SoftLayer_User_Customer/getExternalBindings.md +++ b/content/reference/services/SoftLayer_User_Customer/getExternalBindings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getExternalBindings + Retrieve the external authentication bindings that link an external identifier to a SoftLayer user. diff --git a/content/reference/services/SoftLayer_User_Customer/getHardware.md b/content/reference/services/SoftLayer_User_Customer/getHardware.md index 425345c859..49d52127d1 100644 --- a/content/reference/services/SoftLayer_User_Customer/getHardware.md +++ b/content/reference/services/SoftLayer_User_Customer/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getHardware + Retrieve a portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer/getHardwareCount.md b/content/reference/services/SoftLayer_User_Customer/getHardwareCount.md index 8c9c1f02de..98042402dd 100644 --- a/content/reference/services/SoftLayer_User_Customer/getHardwareCount.md +++ b/content/reference/services/SoftLayer_User_Customer/getHardwareCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getHardwareCount + Retrieve the current number of servers a portal user has access to. diff --git a/content/reference/services/SoftLayer_User_Customer/getHardwareNotifications.md b/content/reference/services/SoftLayer_User_Customer/getHardwareNotifications.md index e2a4797baf..c4dac24e43 100644 --- a/content/reference/services/SoftLayer_User_Customer/getHardwareNotifications.md +++ b/content/reference/services/SoftLayer_User_Customer/getHardwareNotifications.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getHardwareNotifications + Retrieve hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'. diff --git a/content/reference/services/SoftLayer_User_Customer/getHasAcknowledgedSupportPolicyFlag.md b/content/reference/services/SoftLayer_User_Customer/getHasAcknowledgedSupportPolicyFlag.md index dcdfd35861..9acfd435ef 100644 --- a/content/reference/services/SoftLayer_User_Customer/getHasAcknowledgedSupportPolicyFlag.md +++ b/content/reference/services/SoftLayer_User_Customer/getHasAcknowledgedSupportPolicyFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getHasAcknowledgedSupportPolicyFlag + Retrieve whether or not a user has acknowledged the support policy. diff --git a/content/reference/services/SoftLayer_User_Customer/getHasFullDedicatedHostAccessFlag.md b/content/reference/services/SoftLayer_User_Customer/getHasFullDedicatedHostAccessFlag.md index 9ed42456bb..06925ade0c 100644 --- a/content/reference/services/SoftLayer_User_Customer/getHasFullDedicatedHostAccessFlag.md +++ b/content/reference/services/SoftLayer_User_Customer/getHasFullDedicatedHostAccessFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getHasFullDedicatedHostAccessFlag + Retrieve permission granting the user access to all Dedicated Host devices on the account. diff --git a/content/reference/services/SoftLayer_User_Customer/getHasFullHardwareAccessFlag.md b/content/reference/services/SoftLayer_User_Customer/getHasFullHardwareAccessFlag.md index a933d9289e..d93f68a6be 100644 --- a/content/reference/services/SoftLayer_User_Customer/getHasFullHardwareAccessFlag.md +++ b/content/reference/services/SoftLayer_User_Customer/getHasFullHardwareAccessFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getHasFullHardwareAccessFlag + Retrieve whether or not a portal user has access to all hardware on their account. diff --git a/content/reference/services/SoftLayer_User_Customer/getHasFullVirtualGuestAccessFlag.md b/content/reference/services/SoftLayer_User_Customer/getHasFullVirtualGuestAccessFlag.md index 3426db5149..9fd56e3426 100644 --- a/content/reference/services/SoftLayer_User_Customer/getHasFullVirtualGuestAccessFlag.md +++ b/content/reference/services/SoftLayer_User_Customer/getHasFullVirtualGuestAccessFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getHasFullVirtualGuestAccessFlag + Retrieve whether or not a portal user has access to all virtual guests on their account. diff --git a/content/reference/services/SoftLayer_User_Customer/getIbmIdLink.md b/content/reference/services/SoftLayer_User_Customer/getIbmIdLink.md index 1b8eabe2a8..bf03a978f4 100644 --- a/content/reference/services/SoftLayer_User_Customer/getIbmIdLink.md +++ b/content/reference/services/SoftLayer_User_Customer/getIbmIdLink.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getIbmIdLink + Retrieve specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link. diff --git a/content/reference/services/SoftLayer_User_Customer/getImpersonationToken.md b/content/reference/services/SoftLayer_User_Customer/getImpersonationToken.md index 6f905b6237..f09e633c63 100644 --- a/content/reference/services/SoftLayer_User_Customer/getImpersonationToken.md +++ b/content/reference/services/SoftLayer_User_Customer/getImpersonationToken.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/getLayoutProfiles.md b/content/reference/services/SoftLayer_User_Customer/getLayoutProfiles.md index 7bd4230a26..f7e6cf1019 100644 --- a/content/reference/services/SoftLayer_User_Customer/getLayoutProfiles.md +++ b/content/reference/services/SoftLayer_User_Customer/getLayoutProfiles.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getLayoutProfiles + Retrieve contains the definition of the layout profile. diff --git a/content/reference/services/SoftLayer_User_Customer/getLocale.md b/content/reference/services/SoftLayer_User_Customer/getLocale.md index 0287cca73a..97e5ae96e7 100644 --- a/content/reference/services/SoftLayer_User_Customer/getLocale.md +++ b/content/reference/services/SoftLayer_User_Customer/getLocale.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getLocale + Retrieve a user's locale. Locale holds user's language and region information. diff --git a/content/reference/services/SoftLayer_User_Customer/getLoginAttempts.md b/content/reference/services/SoftLayer_User_Customer/getLoginAttempts.md index 0e438da7d4..e9e537accf 100644 --- a/content/reference/services/SoftLayer_User_Customer/getLoginAttempts.md +++ b/content/reference/services/SoftLayer_User_Customer/getLoginAttempts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getLoginAttempts + Retrieve a user's attempts to log into the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer/getLoginToken.md b/content/reference/services/SoftLayer_User_Customer/getLoginToken.md index 0c905ca97a..18328971ef 100644 --- a/content/reference/services/SoftLayer_User_Customer/getLoginToken.md +++ b/content/reference/services/SoftLayer_User_Customer/getLoginToken.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getLoginToken + Authenticate a user for the SoftLayer customer portal diff --git a/content/reference/services/SoftLayer_User_Customer/getMappedAccounts.md b/content/reference/services/SoftLayer_User_Customer/getMappedAccounts.md index 3e173f44ad..14df4c0ada 100644 --- a/content/reference/services/SoftLayer_User_Customer/getMappedAccounts.md +++ b/content/reference/services/SoftLayer_User_Customer/getMappedAccounts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getMappedAccounts + Retrieve a list of all the accounts that belong to this customer. diff --git a/content/reference/services/SoftLayer_User_Customer/getMobileDevices.md b/content/reference/services/SoftLayer_User_Customer/getMobileDevices.md index c6066afb0a..9d7ca015da 100644 --- a/content/reference/services/SoftLayer_User_Customer/getMobileDevices.md +++ b/content/reference/services/SoftLayer_User_Customer/getMobileDevices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getMobileDevices + Retrieve a portal user's associated mobile device profiles. diff --git a/content/reference/services/SoftLayer_User_Customer/getNotificationSubscribers.md b/content/reference/services/SoftLayer_User_Customer/getNotificationSubscribers.md index 2d591feaf9..c7a479f5a6 100644 --- a/content/reference/services/SoftLayer_User_Customer/getNotificationSubscribers.md +++ b/content/reference/services/SoftLayer_User_Customer/getNotificationSubscribers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getNotificationSubscribers + Retrieve notification subscription records for the user. diff --git a/content/reference/services/SoftLayer_User_Customer/getObject.md b/content/reference/services/SoftLayer_User_Customer/getObject.md index 6b6ce4b9a5..99dd3d5fa6 100644 --- a/content/reference/services/SoftLayer_User_Customer/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getObject + Retrieve a SoftLayer_User_Customer record. diff --git a/content/reference/services/SoftLayer_User_Customer/getOpenIdConnectMigrationState.md b/content/reference/services/SoftLayer_User_Customer/getOpenIdConnectMigrationState.md index b54ad7ff38..a3e18112ac 100644 --- a/content/reference/services/SoftLayer_User_Customer/getOpenIdConnectMigrationState.md +++ b/content/reference/services/SoftLayer_User_Customer/getOpenIdConnectMigrationState.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getOpenIdConnectMigrationState + Get the OpenId migration state diff --git a/content/reference/services/SoftLayer_User_Customer/getOpenTickets.md b/content/reference/services/SoftLayer_User_Customer/getOpenTickets.md index 5e949b238d..bed6aa2e4e 100644 --- a/content/reference/services/SoftLayer_User_Customer/getOpenTickets.md +++ b/content/reference/services/SoftLayer_User_Customer/getOpenTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getOpenTickets + Retrieve an user's associated open tickets. diff --git a/content/reference/services/SoftLayer_User_Customer/getOverrides.md b/content/reference/services/SoftLayer_User_Customer/getOverrides.md index 9918808dce..8186d67327 100644 --- a/content/reference/services/SoftLayer_User_Customer/getOverrides.md +++ b/content/reference/services/SoftLayer_User_Customer/getOverrides.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getOverrides + Retrieve a portal user's vpn accessible subnets. diff --git a/content/reference/services/SoftLayer_User_Customer/getParent.md b/content/reference/services/SoftLayer_User_Customer/getParent.md index 597649d0cc..410d433910 100644 --- a/content/reference/services/SoftLayer_User_Customer/getParent.md +++ b/content/reference/services/SoftLayer_User_Customer/getParent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getParent + Retrieve a portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user. diff --git a/content/reference/services/SoftLayer_User_Customer/getPasswordRequirements.md b/content/reference/services/SoftLayer_User_Customer/getPasswordRequirements.md index c19b3c1396..4bca7e1ef1 100644 --- a/content/reference/services/SoftLayer_User_Customer/getPasswordRequirements.md +++ b/content/reference/services/SoftLayer_User_Customer/getPasswordRequirements.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/getPermissions.md b/content/reference/services/SoftLayer_User_Customer/getPermissions.md index 1b77aa88fd..b8dc92ccd3 100644 --- a/content/reference/services/SoftLayer_User_Customer/getPermissions.md +++ b/content/reference/services/SoftLayer_User_Customer/getPermissions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getPermissions + Retrieve a portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API. diff --git a/content/reference/services/SoftLayer_User_Customer/getPortalLoginToken.md b/content/reference/services/SoftLayer_User_Customer/getPortalLoginToken.md index a945484fe0..bc91ce5a1c 100644 --- a/content/reference/services/SoftLayer_User_Customer/getPortalLoginToken.md +++ b/content/reference/services/SoftLayer_User_Customer/getPortalLoginToken.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getPortalLoginToken + Authenticate a user for the SoftLayer customer portal diff --git a/content/reference/services/SoftLayer_User_Customer/getPreference.md b/content/reference/services/SoftLayer_User_Customer/getPreference.md index 40d90089b3..913cd2a2a1 100644 --- a/content/reference/services/SoftLayer_User_Customer/getPreference.md +++ b/content/reference/services/SoftLayer_User_Customer/getPreference.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getPreference + Get a preference value for the current user diff --git a/content/reference/services/SoftLayer_User_Customer/getPreferenceTypes.md b/content/reference/services/SoftLayer_User_Customer/getPreferenceTypes.md index 30b109a09c..dd0a2b18b8 100644 --- a/content/reference/services/SoftLayer_User_Customer/getPreferenceTypes.md +++ b/content/reference/services/SoftLayer_User_Customer/getPreferenceTypes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getPreferenceTypes + Get all available preference types diff --git a/content/reference/services/SoftLayer_User_Customer/getPreferences.md b/content/reference/services/SoftLayer_User_Customer/getPreferences.md index 685bdd4c13..5139acd479 100644 --- a/content/reference/services/SoftLayer_User_Customer/getPreferences.md +++ b/content/reference/services/SoftLayer_User_Customer/getPreferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getPreferences + Retrieve data type contains a single user preference to a specific preference type. diff --git a/content/reference/services/SoftLayer_User_Customer/getRequirementsForPasswordSet.md b/content/reference/services/SoftLayer_User_Customer/getRequirementsForPasswordSet.md index 2a670c1319..04580c8796 100644 --- a/content/reference/services/SoftLayer_User_Customer/getRequirementsForPasswordSet.md +++ b/content/reference/services/SoftLayer_User_Customer/getRequirementsForPasswordSet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getRequirementsForPasswordSet + Retrieve the authentication requirements for a user when attempting diff --git a/content/reference/services/SoftLayer_User_Customer/getRoles.md b/content/reference/services/SoftLayer_User_Customer/getRoles.md index fb741a8be2..42818ba8fd 100644 --- a/content/reference/services/SoftLayer_User_Customer/getRoles.md +++ b/content/reference/services/SoftLayer_User_Customer/getRoles.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/getSalesforceUserLink.md b/content/reference/services/SoftLayer_User_Customer/getSalesforceUserLink.md index 32d4222180..80a78bdab1 100644 --- a/content/reference/services/SoftLayer_User_Customer/getSalesforceUserLink.md +++ b/content/reference/services/SoftLayer_User_Customer/getSalesforceUserLink.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getSalesforceUserLink + Retrieve [DEPRECATED] diff --git a/content/reference/services/SoftLayer_User_Customer/getSecurityAnswers.md b/content/reference/services/SoftLayer_User_Customer/getSecurityAnswers.md index a29a3f73d9..ea115273cc 100644 --- a/content/reference/services/SoftLayer_User_Customer/getSecurityAnswers.md +++ b/content/reference/services/SoftLayer_User_Customer/getSecurityAnswers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getSecurityAnswers + Retrieve a portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login. diff --git a/content/reference/services/SoftLayer_User_Customer/getSubscribers.md b/content/reference/services/SoftLayer_User_Customer/getSubscribers.md index 978cd79cfc..2fa95badcd 100644 --- a/content/reference/services/SoftLayer_User_Customer/getSubscribers.md +++ b/content/reference/services/SoftLayer_User_Customer/getSubscribers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getSubscribers + Retrieve a user's notification subscription records. diff --git a/content/reference/services/SoftLayer_User_Customer/getSuccessfulLogins.md b/content/reference/services/SoftLayer_User_Customer/getSuccessfulLogins.md index 565cf6077b..30a7f40a09 100644 --- a/content/reference/services/SoftLayer_User_Customer/getSuccessfulLogins.md +++ b/content/reference/services/SoftLayer_User_Customer/getSuccessfulLogins.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getSuccessfulLogins + Retrieve a user's successful attempts to log into the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer/getSupportPolicyAcknowledgementRequiredFlag.md b/content/reference/services/SoftLayer_User_Customer/getSupportPolicyAcknowledgementRequiredFlag.md index aa23a8dde1..d0cd0d56ea 100644 --- a/content/reference/services/SoftLayer_User_Customer/getSupportPolicyAcknowledgementRequiredFlag.md +++ b/content/reference/services/SoftLayer_User_Customer/getSupportPolicyAcknowledgementRequiredFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getSupportPolicyAcknowledgementRequiredFlag + Retrieve whether or not a user is required to acknowledge the support policy for portal access. diff --git a/content/reference/services/SoftLayer_User_Customer/getSupportPolicyDocument.md b/content/reference/services/SoftLayer_User_Customer/getSupportPolicyDocument.md index ef21d1a6ae..4b7752db23 100644 --- a/content/reference/services/SoftLayer_User_Customer/getSupportPolicyDocument.md +++ b/content/reference/services/SoftLayer_User_Customer/getSupportPolicyDocument.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/getSupportPolicyName.md b/content/reference/services/SoftLayer_User_Customer/getSupportPolicyName.md index a5ea09e766..c3d8bbce16 100644 --- a/content/reference/services/SoftLayer_User_Customer/getSupportPolicyName.md +++ b/content/reference/services/SoftLayer_User_Customer/getSupportPolicyName.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/getSupportedLocales.md b/content/reference/services/SoftLayer_User_Customer/getSupportedLocales.md index b27fce9504..0169dd0bf1 100644 --- a/content/reference/services/SoftLayer_User_Customer/getSupportedLocales.md +++ b/content/reference/services/SoftLayer_User_Customer/getSupportedLocales.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getSupportedLocales + Returns all supported locales for the current user diff --git a/content/reference/services/SoftLayer_User_Customer/getSurveyRequiredFlag.md b/content/reference/services/SoftLayer_User_Customer/getSurveyRequiredFlag.md index 636e575228..1a0c61016d 100644 --- a/content/reference/services/SoftLayer_User_Customer/getSurveyRequiredFlag.md +++ b/content/reference/services/SoftLayer_User_Customer/getSurveyRequiredFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getSurveyRequiredFlag + Retrieve whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer/getSurveys.md b/content/reference/services/SoftLayer_User_Customer/getSurveys.md index c93237cd8e..7d52c05e1d 100644 --- a/content/reference/services/SoftLayer_User_Customer/getSurveys.md +++ b/content/reference/services/SoftLayer_User_Customer/getSurveys.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getSurveys + Retrieve the surveys that a user has taken in the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer/getTickets.md b/content/reference/services/SoftLayer_User_Customer/getTickets.md index b6bae9dec3..47a08451bf 100644 --- a/content/reference/services/SoftLayer_User_Customer/getTickets.md +++ b/content/reference/services/SoftLayer_User_Customer/getTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getTickets + Retrieve an user's associated tickets. diff --git a/content/reference/services/SoftLayer_User_Customer/getTimezone.md b/content/reference/services/SoftLayer_User_Customer/getTimezone.md index 61aaa5c0f6..c88af728c9 100644 --- a/content/reference/services/SoftLayer_User_Customer/getTimezone.md +++ b/content/reference/services/SoftLayer_User_Customer/getTimezone.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getTimezone + Retrieve a portal user's time zone. diff --git a/content/reference/services/SoftLayer_User_Customer/getUnsuccessfulLogins.md b/content/reference/services/SoftLayer_User_Customer/getUnsuccessfulLogins.md index 1822dc4503..8a0b505509 100644 --- a/content/reference/services/SoftLayer_User_Customer/getUnsuccessfulLogins.md +++ b/content/reference/services/SoftLayer_User_Customer/getUnsuccessfulLogins.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getUnsuccessfulLogins + Retrieve a user's unsuccessful attempts to log into the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer/getUserIdForPasswordSet.md b/content/reference/services/SoftLayer_User_Customer/getUserIdForPasswordSet.md index 40ce34f5a2..680b079080 100644 --- a/content/reference/services/SoftLayer_User_Customer/getUserIdForPasswordSet.md +++ b/content/reference/services/SoftLayer_User_Customer/getUserIdForPasswordSet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getUserIdForPasswordSet + Retrieve a user id using a password request key diff --git a/content/reference/services/SoftLayer_User_Customer/getUserLinks.md b/content/reference/services/SoftLayer_User_Customer/getUserLinks.md index a3d596349b..ad36f2a914 100644 --- a/content/reference/services/SoftLayer_User_Customer/getUserLinks.md +++ b/content/reference/services/SoftLayer_User_Customer/getUserLinks.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getUserLinks + Retrieve user customer link with IBMid and IAMid. diff --git a/content/reference/services/SoftLayer_User_Customer/getUserPreferences.md b/content/reference/services/SoftLayer_User_Customer/getUserPreferences.md index d0fae6b372..16675c1146 100644 --- a/content/reference/services/SoftLayer_User_Customer/getUserPreferences.md +++ b/content/reference/services/SoftLayer_User_Customer/getUserPreferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/getUserStatus.md b/content/reference/services/SoftLayer_User_Customer/getUserStatus.md index 615b7557cd..35a6649708 100644 --- a/content/reference/services/SoftLayer_User_Customer/getUserStatus.md +++ b/content/reference/services/SoftLayer_User_Customer/getUserStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getUserStatus + Retrieve a portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network. diff --git a/content/reference/services/SoftLayer_User_Customer/getVirtualGuestCount.md b/content/reference/services/SoftLayer_User_Customer/getVirtualGuestCount.md index b9c3f5b9ca..8a250ffe6e 100644 --- a/content/reference/services/SoftLayer_User_Customer/getVirtualGuestCount.md +++ b/content/reference/services/SoftLayer_User_Customer/getVirtualGuestCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getVirtualGuestCount + Retrieve the current number of CloudLayer Computing Instances a portal user has access to. diff --git a/content/reference/services/SoftLayer_User_Customer/getVirtualGuests.md b/content/reference/services/SoftLayer_User_Customer/getVirtualGuests.md index 31b19956d0..97aec06409 100644 --- a/content/reference/services/SoftLayer_User_Customer/getVirtualGuests.md +++ b/content/reference/services/SoftLayer_User_Customer/getVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::getVirtualGuests + Retrieve a portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer/inTerminalStatus.md b/content/reference/services/SoftLayer_User_Customer/inTerminalStatus.md index ac52f42036..1ab3793975 100644 --- a/content/reference/services/SoftLayer_User_Customer/inTerminalStatus.md +++ b/content/reference/services/SoftLayer_User_Customer/inTerminalStatus.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/initiateExternalAuthentication.md b/content/reference/services/SoftLayer_User_Customer/initiateExternalAuthentication.md index 5acd9f8c0a..e6272b08ef 100644 --- a/content/reference/services/SoftLayer_User_Customer/initiateExternalAuthentication.md +++ b/content/reference/services/SoftLayer_User_Customer/initiateExternalAuthentication.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::initiateExternalAuthentication + Initiates an external authentication using the given authentication container. diff --git a/content/reference/services/SoftLayer_User_Customer/initiatePortalPasswordChange.md b/content/reference/services/SoftLayer_User_Customer/initiatePortalPasswordChange.md index e07e027a28..7d4ddc8ea9 100644 --- a/content/reference/services/SoftLayer_User_Customer/initiatePortalPasswordChange.md +++ b/content/reference/services/SoftLayer_User_Customer/initiatePortalPasswordChange.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::initiatePortalPasswordChange + Request email to allow user to change their password diff --git a/content/reference/services/SoftLayer_User_Customer/initiatePortalPasswordChangeByBrandAgent.md b/content/reference/services/SoftLayer_User_Customer/initiatePortalPasswordChangeByBrandAgent.md index 91802c353f..7003b40b90 100644 --- a/content/reference/services/SoftLayer_User_Customer/initiatePortalPasswordChangeByBrandAgent.md +++ b/content/reference/services/SoftLayer_User_Customer/initiatePortalPasswordChangeByBrandAgent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::initiatePortalPasswordChangeByBrandAgent + Allows a Brand Agent to request password reset email to be sent to diff --git a/content/reference/services/SoftLayer_User_Customer/inviteUserToLinkOpenIdConnect.md b/content/reference/services/SoftLayer_User_Customer/inviteUserToLinkOpenIdConnect.md index 95b7a45e27..d5609996a2 100644 --- a/content/reference/services/SoftLayer_User_Customer/inviteUserToLinkOpenIdConnect.md +++ b/content/reference/services/SoftLayer_User_Customer/inviteUserToLinkOpenIdConnect.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::inviteUserToLinkOpenIdConnect + Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect. diff --git a/content/reference/services/SoftLayer_User_Customer/isMasterUser.md b/content/reference/services/SoftLayer_User_Customer/isMasterUser.md index ce209a9243..c18002de14 100644 --- a/content/reference/services/SoftLayer_User_Customer/isMasterUser.md +++ b/content/reference/services/SoftLayer_User_Customer/isMasterUser.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::isMasterUser +
              Deprecated
              + Determine if a portal user is a master user. diff --git a/content/reference/services/SoftLayer_User_Customer/isValidPortalPassword.md b/content/reference/services/SoftLayer_User_Customer/isValidPortalPassword.md index e7c10a6b4c..8fa0420acc 100644 --- a/content/reference/services/SoftLayer_User_Customer/isValidPortalPassword.md +++ b/content/reference/services/SoftLayer_User_Customer/isValidPortalPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::isValidPortalPassword + Determine if a string is a user's portal password. diff --git a/content/reference/services/SoftLayer_User_Customer/performExternalAuthentication.md b/content/reference/services/SoftLayer_User_Customer/performExternalAuthentication.md index a43a0c488f..6120152ae0 100644 --- a/content/reference/services/SoftLayer_User_Customer/performExternalAuthentication.md +++ b/content/reference/services/SoftLayer_User_Customer/performExternalAuthentication.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::performExternalAuthentication + Perform an external authentication using the given authentication container. diff --git a/content/reference/services/SoftLayer_User_Customer/processPasswordSetRequest.md b/content/reference/services/SoftLayer_User_Customer/processPasswordSetRequest.md index d8a28913bb..d76c6a7879 100644 --- a/content/reference/services/SoftLayer_User_Customer/processPasswordSetRequest.md +++ b/content/reference/services/SoftLayer_User_Customer/processPasswordSetRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::processPasswordSetRequest + Set the password for a user who has a valid password request key diff --git a/content/reference/services/SoftLayer_User_Customer/removeAllDedicatedHostAccessForThisUser.md b/content/reference/services/SoftLayer_User_Customer/removeAllDedicatedHostAccessForThisUser.md index 7c16b34cff..0706f2a2db 100644 --- a/content/reference/services/SoftLayer_User_Customer/removeAllDedicatedHostAccessForThisUser.md +++ b/content/reference/services/SoftLayer_User_Customer/removeAllDedicatedHostAccessForThisUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::removeAllDedicatedHostAccessForThisUser + Revoke access to all dedicated hosts on the account for this user. diff --git a/content/reference/services/SoftLayer_User_Customer/removeAllHardwareAccessForThisUser.md b/content/reference/services/SoftLayer_User_Customer/removeAllHardwareAccessForThisUser.md index 856aa6b681..caf2108a53 100644 --- a/content/reference/services/SoftLayer_User_Customer/removeAllHardwareAccessForThisUser.md +++ b/content/reference/services/SoftLayer_User_Customer/removeAllHardwareAccessForThisUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::removeAllHardwareAccessForThisUser + Remove all hardware from a portal user's hardware access list. diff --git a/content/reference/services/SoftLayer_User_Customer/removeAllVirtualAccessForThisUser.md b/content/reference/services/SoftLayer_User_Customer/removeAllVirtualAccessForThisUser.md index 9da55e8daa..ac4cff5140 100644 --- a/content/reference/services/SoftLayer_User_Customer/removeAllVirtualAccessForThisUser.md +++ b/content/reference/services/SoftLayer_User_Customer/removeAllVirtualAccessForThisUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::removeAllVirtualAccessForThisUser + Remove all cloud computing instances from a portal user's instance access list. diff --git a/content/reference/services/SoftLayer_User_Customer/removeApiAuthenticationKey.md b/content/reference/services/SoftLayer_User_Customer/removeApiAuthenticationKey.md index ee9b22ed05..5006f3ca47 100644 --- a/content/reference/services/SoftLayer_User_Customer/removeApiAuthenticationKey.md +++ b/content/reference/services/SoftLayer_User_Customer/removeApiAuthenticationKey.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::removeApiAuthenticationKey + Remove a user's API authentication key. diff --git a/content/reference/services/SoftLayer_User_Customer/removeBulkDedicatedHostAccess.md b/content/reference/services/SoftLayer_User_Customer/removeBulkDedicatedHostAccess.md index 48169f8ddb..8474fafb37 100644 --- a/content/reference/services/SoftLayer_User_Customer/removeBulkDedicatedHostAccess.md +++ b/content/reference/services/SoftLayer_User_Customer/removeBulkDedicatedHostAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::removeBulkDedicatedHostAccess + Revoke access for the user for one or more dedicated hosts devices. diff --git a/content/reference/services/SoftLayer_User_Customer/removeBulkHardwareAccess.md b/content/reference/services/SoftLayer_User_Customer/removeBulkHardwareAccess.md index 81081540df..7de129b92e 100644 --- a/content/reference/services/SoftLayer_User_Customer/removeBulkHardwareAccess.md +++ b/content/reference/services/SoftLayer_User_Customer/removeBulkHardwareAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::removeBulkHardwareAccess + Remove multiple hardware from a portal user's hardware access list. diff --git a/content/reference/services/SoftLayer_User_Customer/removeBulkPortalPermission.md b/content/reference/services/SoftLayer_User_Customer/removeBulkPortalPermission.md index 3f5665bec1..82570cfb8d 100644 --- a/content/reference/services/SoftLayer_User_Customer/removeBulkPortalPermission.md +++ b/content/reference/services/SoftLayer_User_Customer/removeBulkPortalPermission.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::removeBulkPortalPermission + Remove multiple permissions from a portal user's permission set. diff --git a/content/reference/services/SoftLayer_User_Customer/removeBulkRoles.md b/content/reference/services/SoftLayer_User_Customer/removeBulkRoles.md index 4b6e30d433..161f973597 100644 --- a/content/reference/services/SoftLayer_User_Customer/removeBulkRoles.md +++ b/content/reference/services/SoftLayer_User_Customer/removeBulkRoles.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/removeBulkVirtualGuestAccess.md b/content/reference/services/SoftLayer_User_Customer/removeBulkVirtualGuestAccess.md index d596111b65..4f92b0bd98 100644 --- a/content/reference/services/SoftLayer_User_Customer/removeBulkVirtualGuestAccess.md +++ b/content/reference/services/SoftLayer_User_Customer/removeBulkVirtualGuestAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::removeBulkVirtualGuestAccess + Remove multiple CloudLayer Computing Instances from a portal user's access list. diff --git a/content/reference/services/SoftLayer_User_Customer/removeDedicatedHostAccess.md b/content/reference/services/SoftLayer_User_Customer/removeDedicatedHostAccess.md index a228a2786a..76dc114598 100644 --- a/content/reference/services/SoftLayer_User_Customer/removeDedicatedHostAccess.md +++ b/content/reference/services/SoftLayer_User_Customer/removeDedicatedHostAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::removeDedicatedHostAccess + Revoke access for the user to a single dedicated hosts device. diff --git a/content/reference/services/SoftLayer_User_Customer/removeExternalBinding.md b/content/reference/services/SoftLayer_User_Customer/removeExternalBinding.md index e00197f8f5..dbb97d5704 100644 --- a/content/reference/services/SoftLayer_User_Customer/removeExternalBinding.md +++ b/content/reference/services/SoftLayer_User_Customer/removeExternalBinding.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::removeExternalBinding + Remove an external binding from this user. diff --git a/content/reference/services/SoftLayer_User_Customer/removeHardwareAccess.md b/content/reference/services/SoftLayer_User_Customer/removeHardwareAccess.md index 8848a76b98..91cd55c276 100644 --- a/content/reference/services/SoftLayer_User_Customer/removeHardwareAccess.md +++ b/content/reference/services/SoftLayer_User_Customer/removeHardwareAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::removeHardwareAccess + Remove hardware from a portal user's hardware access list. diff --git a/content/reference/services/SoftLayer_User_Customer/removePortalPermission.md b/content/reference/services/SoftLayer_User_Customer/removePortalPermission.md index 98a76c9808..dad9a2e01f 100644 --- a/content/reference/services/SoftLayer_User_Customer/removePortalPermission.md +++ b/content/reference/services/SoftLayer_User_Customer/removePortalPermission.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::removePortalPermission + Remove a permission from a portal user's permission set. diff --git a/content/reference/services/SoftLayer_User_Customer/removeRole.md b/content/reference/services/SoftLayer_User_Customer/removeRole.md index bb932f5e80..ec0a9c05f5 100644 --- a/content/reference/services/SoftLayer_User_Customer/removeRole.md +++ b/content/reference/services/SoftLayer_User_Customer/removeRole.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/removeSecurityAnswers.md b/content/reference/services/SoftLayer_User_Customer/removeSecurityAnswers.md index b03ce3c110..d53ff10ed4 100644 --- a/content/reference/services/SoftLayer_User_Customer/removeSecurityAnswers.md +++ b/content/reference/services/SoftLayer_User_Customer/removeSecurityAnswers.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/removeVirtualGuestAccess.md b/content/reference/services/SoftLayer_User_Customer/removeVirtualGuestAccess.md index c1f2b9d5a3..992e8d6fa0 100644 --- a/content/reference/services/SoftLayer_User_Customer/removeVirtualGuestAccess.md +++ b/content/reference/services/SoftLayer_User_Customer/removeVirtualGuestAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::removeVirtualGuestAccess + Remove a CloudLayer Computing Instance from a portal user's access list. diff --git a/content/reference/services/SoftLayer_User_Customer/resetOpenIdConnectLink.md b/content/reference/services/SoftLayer_User_Customer/resetOpenIdConnectLink.md index 2ce79f3073..a06e6a6194 100644 --- a/content/reference/services/SoftLayer_User_Customer/resetOpenIdConnectLink.md +++ b/content/reference/services/SoftLayer_User_Customer/resetOpenIdConnectLink.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::resetOpenIdConnectLink + Change the link of a user for OpenIdConnect managed accounts, provided the diff --git a/content/reference/services/SoftLayer_User_Customer/resetOpenIdConnectLinkUnifiedUserManagementMode.md b/content/reference/services/SoftLayer_User_Customer/resetOpenIdConnectLinkUnifiedUserManagementMode.md index f5410a53a5..fc16599c2c 100644 --- a/content/reference/services/SoftLayer_User_Customer/resetOpenIdConnectLinkUnifiedUserManagementMode.md +++ b/content/reference/services/SoftLayer_User_Customer/resetOpenIdConnectLinkUnifiedUserManagementMode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::resetOpenIdConnectLinkUnifiedUserManagementMode + Change the link of a master user for OpenIdConnect managed accounts, diff --git a/content/reference/services/SoftLayer_User_Customer/samlAuthenticate.md b/content/reference/services/SoftLayer_User_Customer/samlAuthenticate.md index 1d8ab93223..cb8988a4b5 100644 --- a/content/reference/services/SoftLayer_User_Customer/samlAuthenticate.md +++ b/content/reference/services/SoftLayer_User_Customer/samlAuthenticate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/samlBeginAuthentication.md b/content/reference/services/SoftLayer_User_Customer/samlBeginAuthentication.md index f76226894c..2d5121baa9 100644 --- a/content/reference/services/SoftLayer_User_Customer/samlBeginAuthentication.md +++ b/content/reference/services/SoftLayer_User_Customer/samlBeginAuthentication.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/samlBeginLogout.md b/content/reference/services/SoftLayer_User_Customer/samlBeginLogout.md index 33993e48d3..ad05ca74ce 100644 --- a/content/reference/services/SoftLayer_User_Customer/samlBeginLogout.md +++ b/content/reference/services/SoftLayer_User_Customer/samlBeginLogout.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/samlLogout.md b/content/reference/services/SoftLayer_User_Customer/samlLogout.md index f5d9babc04..07c6b83c1c 100644 --- a/content/reference/services/SoftLayer_User_Customer/samlLogout.md +++ b/content/reference/services/SoftLayer_User_Customer/samlLogout.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/selfPasswordChange.md b/content/reference/services/SoftLayer_User_Customer/selfPasswordChange.md index c25ab65cc0..0040ff9638 100644 --- a/content/reference/services/SoftLayer_User_Customer/selfPasswordChange.md +++ b/content/reference/services/SoftLayer_User_Customer/selfPasswordChange.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer/setDefaultAccount.md b/content/reference/services/SoftLayer_User_Customer/setDefaultAccount.md index 46356c3a88..8dc57306a1 100644 --- a/content/reference/services/SoftLayer_User_Customer/setDefaultAccount.md +++ b/content/reference/services/SoftLayer_User_Customer/setDefaultAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::setDefaultAccount + Sets the default account for the OpenIdConnect identity that is linked to the current SoftLayer user identity. diff --git a/content/reference/services/SoftLayer_User_Customer/silentlyMigrateUserOpenIdConnect.md b/content/reference/services/SoftLayer_User_Customer/silentlyMigrateUserOpenIdConnect.md index dec416e36a..a10e83cf20 100644 --- a/content/reference/services/SoftLayer_User_Customer/silentlyMigrateUserOpenIdConnect.md +++ b/content/reference/services/SoftLayer_User_Customer/silentlyMigrateUserOpenIdConnect.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::silentlyMigrateUserOpenIdConnect + This api is used to migrate a user to IBMid without sending an invitation. diff --git a/content/reference/services/SoftLayer_User_Customer/updateNotificationSubscriber.md b/content/reference/services/SoftLayer_User_Customer/updateNotificationSubscriber.md index df996fc5b3..93050fc795 100644 --- a/content/reference/services/SoftLayer_User_Customer/updateNotificationSubscriber.md +++ b/content/reference/services/SoftLayer_User_Customer/updateNotificationSubscriber.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::updateNotificationSubscriber + Update the active status for a notification subscription. diff --git a/content/reference/services/SoftLayer_User_Customer/updateSecurityAnswers.md b/content/reference/services/SoftLayer_User_Customer/updateSecurityAnswers.md index 7dd819ad28..a5fad84aba 100644 --- a/content/reference/services/SoftLayer_User_Customer/updateSecurityAnswers.md +++ b/content/reference/services/SoftLayer_User_Customer/updateSecurityAnswers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::updateSecurityAnswers + Update portal login security questions and answers. diff --git a/content/reference/services/SoftLayer_User_Customer/updateSubscriberDeliveryMethod.md b/content/reference/services/SoftLayer_User_Customer/updateSubscriberDeliveryMethod.md index 172a7c2cba..e0baad24c9 100644 --- a/content/reference/services/SoftLayer_User_Customer/updateSubscriberDeliveryMethod.md +++ b/content/reference/services/SoftLayer_User_Customer/updateSubscriberDeliveryMethod.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::updateSubscriberDeliveryMethod + Update a delivery method for the subscriber. diff --git a/content/reference/services/SoftLayer_User_Customer/updateVpnPassword.md b/content/reference/services/SoftLayer_User_Customer/updateVpnPassword.md index 0a5186673c..358c5192af 100644 --- a/content/reference/services/SoftLayer_User_Customer/updateVpnPassword.md +++ b/content/reference/services/SoftLayer_User_Customer/updateVpnPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::updateVpnPassword + Update a user's VPN password diff --git a/content/reference/services/SoftLayer_User_Customer/updateVpnUser.md b/content/reference/services/SoftLayer_User_Customer/updateVpnUser.md index 343a66c80b..6af5797d63 100644 --- a/content/reference/services/SoftLayer_User_Customer/updateVpnUser.md +++ b/content/reference/services/SoftLayer_User_Customer/updateVpnUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer](/reference/services/SoftLayer_User_Customer)::updateVpnUser + Creates or updates a user's VPN access privileges. diff --git a/content/reference/services/SoftLayer_User_Customer/validateAuthenticationToken.md b/content/reference/services/SoftLayer_User_Customer/validateAuthenticationToken.md index a922948096..065f6f6bd5 100644 --- a/content/reference/services/SoftLayer_User_Customer/validateAuthenticationToken.md +++ b/content/reference/services/SoftLayer_User_Customer/validateAuthenticationToken.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_ApiAuthentication/_index.md b/content/reference/services/SoftLayer_User_Customer_ApiAuthentication/_index.md index 0ee3854596..be28fb6611 100644 --- a/content/reference/services/SoftLayer_User_Customer_ApiAuthentication/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_ApiAuthentication/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + An account's user may obtain access to SoftLayer's API through this authentication service. @@ -42,18 +44,21 @@ An account's user may obtain access to SoftLayer's API through this authenticati #### [editObject](/reference/services/SoftLayer_User_Customer_ApiAuthentication/editObject) +
              #### [getObject](/reference/services/SoftLayer_User_Customer_ApiAuthentication/getObject) Retrieve a SoftLayer_User_Customer_ApiAuthentication record. +
              #### [getUser](/reference/services/SoftLayer_User_Customer_ApiAuthentication/getUser) Retrieve the user who owns the api authentication key. +
              diff --git a/content/reference/services/SoftLayer_User_Customer_ApiAuthentication/editObject.md b/content/reference/services/SoftLayer_User_Customer_ApiAuthentication/editObject.md index 52a0e885d3..309e612493 100644 --- a/content/reference/services/SoftLayer_User_Customer_ApiAuthentication/editObject.md +++ b/content/reference/services/SoftLayer_User_Customer_ApiAuthentication/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_ApiAuthentication/getObject.md b/content/reference/services/SoftLayer_User_Customer_ApiAuthentication/getObject.md index ef37b926f9..794e5d0996 100644 --- a/content/reference/services/SoftLayer_User_Customer_ApiAuthentication/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer_ApiAuthentication/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_ApiAuthentication](/reference/services/SoftLayer_User_Customer_ApiAuthentication)::getObject + Retrieve a SoftLayer_User_Customer_ApiAuthentication record. diff --git a/content/reference/services/SoftLayer_User_Customer_ApiAuthentication/getUser.md b/content/reference/services/SoftLayer_User_Customer_ApiAuthentication/getUser.md index 94ce11fa85..cc03aabcf7 100644 --- a/content/reference/services/SoftLayer_User_Customer_ApiAuthentication/getUser.md +++ b/content/reference/services/SoftLayer_User_Customer_ApiAuthentication/getUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_ApiAuthentication](/reference/services/SoftLayer_User_Customer_ApiAuthentication)::getUser + Retrieve the user who owns the api authentication key. diff --git a/content/reference/services/SoftLayer_User_Customer_CustomerPermission_Permission/_index.md b/content/reference/services/SoftLayer_User_Customer_CustomerPermission_Permission/_index.md index 8742ec6cc4..2872022318 100644 --- a/content/reference/services/SoftLayer_User_Customer_CustomerPermission_Permission/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_CustomerPermission_Permission/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Portal account users who are not the master user (account owner) have permissions to allow them access to portal functionalities. @@ -38,16 +40,21 @@ Portal account users who are not the master user (account owner) have permission
              -
              +
              #### [getAllObjects](/reference/services/SoftLayer_User_Customer_CustomerPermission_Permission/getAllObjects) Retrieve all available permissions. + +Deprecated + +
              #### [getObject](/reference/services/SoftLayer_User_Customer_CustomerPermission_Permission/getObject) Retrieve a SoftLayer_User_Customer_CustomerPermission_Permission record. +
              diff --git a/content/reference/services/SoftLayer_User_Customer_CustomerPermission_Permission/getAllObjects.md b/content/reference/services/SoftLayer_User_Customer_CustomerPermission_Permission/getAllObjects.md index 28d34aa09e..dbd37064ed 100644 --- a/content/reference/services/SoftLayer_User_Customer_CustomerPermission_Permission/getAllObjects.md +++ b/content/reference/services/SoftLayer_User_Customer_CustomerPermission_Permission/getAllObjects.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/services/SoftLayer_User_Customer_CustomerPermission_Permission)::getAllObjects +
              Deprecated
              + Retrieve all available permissions. diff --git a/content/reference/services/SoftLayer_User_Customer_CustomerPermission_Permission/getObject.md b/content/reference/services/SoftLayer_User_Customer_CustomerPermission_Permission/getObject.md index 014dcb82c6..44e4102b7c 100644 --- a/content/reference/services/SoftLayer_User_Customer_CustomerPermission_Permission/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer_CustomerPermission_Permission/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/services/SoftLayer_User_Customer_CustomerPermission_Permission)::getObject + Retrieve a SoftLayer_User_Customer_CustomerPermission_Permission record. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding/_index.md b/content/reference/services/SoftLayer_User_Customer_External_Binding/_index.md index 4c957a8834..a50eb45235 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding/_index.md @@ -18,6 +18,8 @@ classes:
              ## Description + + <<< @@ -42,66 +44,77 @@ classes: #### [deleteObject](/reference/services/SoftLayer_User_Customer_External_Binding/deleteObject) Delete an external authentication binding. +
              #### [disable](/reference/services/SoftLayer_User_Customer_External_Binding/disable) Disable an external binding. +
              #### [enable](/reference/services/SoftLayer_User_Customer_External_Binding/enable) Enable an external binding. +
              #### [getAttributes](/reference/services/SoftLayer_User_Customer_External_Binding/getAttributes) Retrieve attributes of an external authentication binding. +
              #### [getBillingItem](/reference/services/SoftLayer_User_Customer_External_Binding/getBillingItem) Retrieve information regarding the billing item for external authentication. +
              #### [getNote](/reference/services/SoftLayer_User_Customer_External_Binding/getNote) Retrieve an optional note for identifying the external binding. +
              #### [getObject](/reference/services/SoftLayer_User_Customer_External_Binding/getObject) Retrieve a SoftLayer_User_Customer_External_Binding record. +
              #### [getType](/reference/services/SoftLayer_User_Customer_External_Binding/getType) Retrieve the type of external authentication binding. +
              #### [getUser](/reference/services/SoftLayer_User_Customer_External_Binding/getUser) Retrieve the SoftLayer user that the external authentication binding belongs to. +
              #### [getVendor](/reference/services/SoftLayer_User_Customer_External_Binding/getVendor) Retrieve the vendor of an external authentication binding. +
              #### [updateNote](/reference/services/SoftLayer_User_Customer_External_Binding/updateNote) Update the note of an external binding. +
              diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding/deleteObject.md b/content/reference/services/SoftLayer_User_Customer_External_Binding/deleteObject.md index 5c5dcf76c4..85fff12d1d 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding/deleteObject.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding](/reference/services/SoftLayer_User_Customer_External_Binding)::deleteObject + Delete an external authentication binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding/disable.md b/content/reference/services/SoftLayer_User_Customer_External_Binding/disable.md index 62b5f50c1c..921c55bb09 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding/disable.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding/disable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding](/reference/services/SoftLayer_User_Customer_External_Binding)::disable + Disable an external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding/enable.md b/content/reference/services/SoftLayer_User_Customer_External_Binding/enable.md index d9fad2e7f4..666fd8f2e3 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding/enable.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding/enable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding](/reference/services/SoftLayer_User_Customer_External_Binding)::enable + Enable an external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding/getAttributes.md b/content/reference/services/SoftLayer_User_Customer_External_Binding/getAttributes.md index d3c3780345..dab5c3b3d0 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding/getAttributes.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding/getAttributes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding](/reference/services/SoftLayer_User_Customer_External_Binding)::getAttributes + Retrieve attributes of an external authentication binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding/getBillingItem.md b/content/reference/services/SoftLayer_User_Customer_External_Binding/getBillingItem.md index 8eaaf868a3..92780901c1 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding/getBillingItem.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding](/reference/services/SoftLayer_User_Customer_External_Binding)::getBillingItem + Retrieve information regarding the billing item for external authentication. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding/getNote.md b/content/reference/services/SoftLayer_User_Customer_External_Binding/getNote.md index 0cd9b7cbc9..4c71fdca05 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding/getNote.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding/getNote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding](/reference/services/SoftLayer_User_Customer_External_Binding)::getNote + Retrieve an optional note for identifying the external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding/getObject.md b/content/reference/services/SoftLayer_User_Customer_External_Binding/getObject.md index 64be0b4558..3ece3b2499 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding](/reference/services/SoftLayer_User_Customer_External_Binding)::getObject + Retrieve a SoftLayer_User_Customer_External_Binding record. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding/getType.md b/content/reference/services/SoftLayer_User_Customer_External_Binding/getType.md index 80df08c60f..44bb379d89 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding/getType.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding](/reference/services/SoftLayer_User_Customer_External_Binding)::getType + Retrieve the type of external authentication binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding/getUser.md b/content/reference/services/SoftLayer_User_Customer_External_Binding/getUser.md index 4aa00158af..b338ae5ec7 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding/getUser.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding/getUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding](/reference/services/SoftLayer_User_Customer_External_Binding)::getUser + Retrieve the SoftLayer user that the external authentication binding belongs to. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding/getVendor.md b/content/reference/services/SoftLayer_User_Customer_External_Binding/getVendor.md index 14915b0911..11de9c16a3 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding/getVendor.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding/getVendor.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding](/reference/services/SoftLayer_User_Customer_External_Binding)::getVendor + Retrieve the vendor of an external authentication binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding/updateNote.md b/content/reference/services/SoftLayer_User_Customer_External_Binding/updateNote.md index 56de109b32..653d179045 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding/updateNote.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding/updateNote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding](/reference/services/SoftLayer_User_Customer_External_Binding)::updateNote + Update the note of an external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/_index.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/_index.md index 8927e7d996..e702483856 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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 such as PhoneFactor. When the SoftLayer user attempts to log in to the SoftLayer customer portal or VPN, they will first be prompted for their normal SoftLayer username and password. Once that information is verified they will be asked to authenticate via phone, SMS or mobile phone application. Once authenticated with the trusted vendor the user will be allowed access to the SoftLayer customer portal or VPN. The Phone external binding service allows a user to create an external binding, enable, disable, or unlock an external binding, and delete an external binding. @@ -46,132 +48,154 @@ Once a SoftLayer user has a valid and active external binding, they will be requ #### [checkPhoneValidationResult](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/checkPhoneValidationResult) Return a phone validation result +
              #### [deleteObject](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/deleteObject) Delete an external authentication binding. +
              #### [disable](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/disable) Disable an external binding. +
              #### [enable](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/enable) Enable an external binding. +
              #### [getAllAuthenticationModes](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAllAuthenticationModes) Returns available authentication modes +
              #### [getAllAuthenticationPinModes](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAllAuthenticationPinModes) Returns available authentication pin modes +
              #### [getAttributes](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAttributes) Retrieve attributes of an external authentication binding. +
              #### [getAuthenticationMode](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAuthenticationMode) Returns the authentication mode +
              #### [getBillingItem](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getBillingItem) Retrieve the current billing item for an external binding. +
              #### [getBindingStatus](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getBindingStatus) Retrieve the current external binding status. It can be "ACTIVE" or "BLOCKED". +
              #### [getNote](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getNote) Retrieve an optional note for identifying the external binding. +
              #### [getObject](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getObject) Retrieve a SoftLayer_User_Customer_External_Binding_Phone record. +
              #### [getPhoneAppActivationCode](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getPhoneAppActivationCode) Return a mobile phone app activation code +
              #### [getPhoneData](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getPhoneData) Returns the authentication phone data. +
              #### [getPinLength](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getPinLength) +
              #### [getType](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getType) Retrieve the type of external authentication binding. +
              #### [getUser](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getUser) Retrieve the SoftLayer user that the external authentication binding belongs to. +
              #### [getVendor](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getVendor) Retrieve the vendor of an external authentication binding. +
              #### [requestPhoneValidation](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/requestPhoneValidation) Initiates a phone validation requests and returns a unique token +
              #### [updateAuthenticationMode](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/updateAuthenticationMode) Updates the authentication mode +
              #### [updateNote](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/updateNote) Update the note of an external binding. +
              #### [updatePhone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone/updatePhone) Updates the authentication phone numbers. +
              diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/checkPhoneValidationResult.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/checkPhoneValidationResult.md index ace05c469e..3e0e428c8f 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/checkPhoneValidationResult.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/checkPhoneValidationResult.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::checkPhoneValidationResult + Return a phone validation result diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/deleteObject.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/deleteObject.md index 5ace000b1c..dee046ef1a 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/deleteObject.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::deleteObject + Delete an external authentication binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/disable.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/disable.md index ee5b8e43b8..719eb2d8a8 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/disable.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/disable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::disable + Disable an external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/enable.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/enable.md index 73f5cb99c2..ab3ab8ce85 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/enable.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/enable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::enable + Enable an external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAllAuthenticationModes.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAllAuthenticationModes.md index 605a7b0a64..63d5042b46 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAllAuthenticationModes.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAllAuthenticationModes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::getAllAuthenticationModes + Returns available authentication modes diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAllAuthenticationPinModes.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAllAuthenticationPinModes.md index a9ba2f556f..a92fa0d5c6 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAllAuthenticationPinModes.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAllAuthenticationPinModes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::getAllAuthenticationPinModes + Returns available authentication pin modes diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAttributes.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAttributes.md index 70120b0399..de559fad4d 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAttributes.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAttributes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::getAttributes + Retrieve attributes of an external authentication binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAuthenticationMode.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAuthenticationMode.md index 9dbc68350a..4e0269e9ec 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAuthenticationMode.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getAuthenticationMode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::getAuthenticationMode + Returns the authentication mode diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getBillingItem.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getBillingItem.md index 0db6272349..81ce5739d6 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getBillingItem.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::getBillingItem + Retrieve the current billing item for an external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getBindingStatus.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getBindingStatus.md index 53019ba2ed..e0efb44a1a 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getBindingStatus.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getBindingStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::getBindingStatus + Retrieve the current external binding status. It can be "ACTIVE" or "BLOCKED". diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getNote.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getNote.md index a8d75c08fe..701640e201 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getNote.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getNote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::getNote + Retrieve an optional note for identifying the external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getObject.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getObject.md index 2f0a09e22f..5635138c8d 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::getObject + Retrieve a SoftLayer_User_Customer_External_Binding_Phone record. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getPhoneAppActivationCode.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getPhoneAppActivationCode.md index 8ff4aef18e..7b53446e66 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getPhoneAppActivationCode.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getPhoneAppActivationCode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::getPhoneAppActivationCode + Return a mobile phone app activation code diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getPhoneData.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getPhoneData.md index 9548e397fe..82bc39f921 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getPhoneData.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getPhoneData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::getPhoneData + Returns the authentication phone data. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getPinLength.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getPinLength.md index ad5bc33df4..b66145cb01 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getPinLength.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getPinLength.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getType.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getType.md index 7b28599ed3..9de22319f2 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getType.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::getType + Retrieve the type of external authentication binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getUser.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getUser.md index 5ca2a30016..5787ae7541 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getUser.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::getUser + Retrieve the SoftLayer user that the external authentication binding belongs to. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getVendor.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getVendor.md index c084969ed3..bb40275c2c 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getVendor.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/getVendor.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::getVendor + Retrieve the vendor of an external authentication binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/requestPhoneValidation.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/requestPhoneValidation.md index 6373190ea2..7b0bbb819f 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/requestPhoneValidation.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/requestPhoneValidation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::requestPhoneValidation + Initiates a phone validation requests and returns a unique token diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/updateAuthenticationMode.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/updateAuthenticationMode.md index d548619310..909aaac26c 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/updateAuthenticationMode.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/updateAuthenticationMode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::updateAuthenticationMode + Updates the authentication mode diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/updateNote.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/updateNote.md index d3405a2a27..f9610f285b 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/updateNote.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/updateNote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::updateNote + Update the note of an external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/updatePhone.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/updatePhone.md index ca09098a4d..83398aa1c8 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/updatePhone.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Phone/updatePhone.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Phone](/reference/services/SoftLayer_User_Customer_External_Binding_Phone)::updatePhone + Updates the authentication phone numbers. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/_index.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/_index.md index 29a9b1799f..bb0dd0efc1 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -46,84 +48,98 @@ Once a SoftLayer user has a valid and active time-based one time password extern #### [activate](/reference/services/SoftLayer_User_Customer_External_Binding_Totp/activate) +
              #### [deactivate](/reference/services/SoftLayer_User_Customer_External_Binding_Totp/deactivate) +
              #### [deleteObject](/reference/services/SoftLayer_User_Customer_External_Binding_Totp/deleteObject) Delete an external authentication binding. +
              #### [disable](/reference/services/SoftLayer_User_Customer_External_Binding_Totp/disable) Disable an external binding. +
              #### [enable](/reference/services/SoftLayer_User_Customer_External_Binding_Totp/enable) Enable an external binding. +
              #### [generateSecretKey](/reference/services/SoftLayer_User_Customer_External_Binding_Totp/generateSecretKey) +
              #### [getAttributes](/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getAttributes) Retrieve attributes of an external authentication binding. +
              #### [getBillingItem](/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getBillingItem) Retrieve information regarding the billing item for external authentication. +
              #### [getNote](/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getNote) Retrieve an optional note for identifying the external binding. +
              #### [getObject](/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getObject) Retrieve a SoftLayer_User_Customer_External_Binding_Totp record. +
              #### [getType](/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getType) Retrieve the type of external authentication binding. +
              #### [getUser](/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getUser) Retrieve the SoftLayer user that the external authentication binding belongs to. +
              #### [getVendor](/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getVendor) Retrieve the vendor of an external authentication binding. +
              #### [updateNote](/reference/services/SoftLayer_User_Customer_External_Binding_Totp/updateNote) Update the note of an external binding. +
              diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/activate.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/activate.md index 712147eafc..581f57297f 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/activate.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/activate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/deactivate.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/deactivate.md index 5141546698..350cbab46e 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/deactivate.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/deactivate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/deleteObject.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/deleteObject.md index 82a8550d6a..9a9206b95d 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/deleteObject.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Totp](/reference/services/SoftLayer_User_Customer_External_Binding_Totp)::deleteObject + Delete an external authentication binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/disable.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/disable.md index b46025a9e6..92a5b0c116 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/disable.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/disable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Totp](/reference/services/SoftLayer_User_Customer_External_Binding_Totp)::disable + Disable an external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/enable.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/enable.md index c43d7c02a8..4331f86f03 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/enable.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/enable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Totp](/reference/services/SoftLayer_User_Customer_External_Binding_Totp)::enable + Enable an external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/generateSecretKey.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/generateSecretKey.md index 56d831c8cb..d9f225f2f7 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/generateSecretKey.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/generateSecretKey.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getAttributes.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getAttributes.md index 7b824b4a09..5e44761e70 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getAttributes.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getAttributes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Totp](/reference/services/SoftLayer_User_Customer_External_Binding_Totp)::getAttributes + Retrieve attributes of an external authentication binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getBillingItem.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getBillingItem.md index 530ac4b183..2445dc4fbc 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getBillingItem.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Totp](/reference/services/SoftLayer_User_Customer_External_Binding_Totp)::getBillingItem + Retrieve information regarding the billing item for external authentication. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getNote.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getNote.md index 64a64551b9..5be26c6764 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getNote.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getNote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Totp](/reference/services/SoftLayer_User_Customer_External_Binding_Totp)::getNote + Retrieve an optional note for identifying the external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getObject.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getObject.md index 25855b34bd..bc84c6e976 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Totp](/reference/services/SoftLayer_User_Customer_External_Binding_Totp)::getObject + Retrieve a SoftLayer_User_Customer_External_Binding_Totp record. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getType.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getType.md index 6dc9a13a2f..9db8544a92 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getType.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Totp](/reference/services/SoftLayer_User_Customer_External_Binding_Totp)::getType + Retrieve the type of external authentication binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getUser.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getUser.md index 08095a5ea9..c2ec8a027a 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getUser.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Totp](/reference/services/SoftLayer_User_Customer_External_Binding_Totp)::getUser + Retrieve the SoftLayer user that the external authentication binding belongs to. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getVendor.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getVendor.md index 17d5623e57..3c7008eec8 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getVendor.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/getVendor.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Totp](/reference/services/SoftLayer_User_Customer_External_Binding_Totp)::getVendor + Retrieve the vendor of an external authentication binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/updateNote.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/updateNote.md index ecb862d4c7..b2aaf995b1 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/updateNote.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Totp/updateNote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Totp](/reference/services/SoftLayer_User_Customer_External_Binding_Totp)::updateNote + Update the note of an external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Vendor/_index.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Vendor/_index.md index d4d48c05af..81d12ef8d1 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Vendor/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Vendor/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,12 +44,14 @@ The SoftLayer_User_Customer_External_Binding_Vendor service is used to retrieve #### [getAllObjects](/reference/services/SoftLayer_User_Customer_External_Binding_Vendor/getAllObjects) Get a list of all available external binding vendors that SoftLayer supports. +
              #### [getObject](/reference/services/SoftLayer_User_Customer_External_Binding_Vendor/getObject) Retrieve a SoftLayer_User_Customer_External_Binding_Vendor record. +
              diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Vendor/getAllObjects.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Vendor/getAllObjects.md index 10f3671f83..ea6c4f2d5f 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Vendor/getAllObjects.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Vendor/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Vendor](/reference/services/SoftLayer_User_Customer_External_Binding_Vendor)::getAllObjects + Get a list of all available external binding vendors that SoftLayer supports. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Vendor/getObject.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Vendor/getObject.md index f328a04368..f2876db444 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Vendor/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Vendor/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Vendor](/reference/services/SoftLayer_User_Customer_External_Binding_Vendor)::getObject + Retrieve a SoftLayer_User_Customer_External_Binding_Vendor record. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/_index.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/_index.md index 3cfc95aca1..51033a344c 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -46,108 +48,126 @@ Once a SoftLayer user has a valid and active VeriSign external binding, they wil #### [deleteObject](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/deleteObject) Delete a VeriSign external binding. +
              #### [disable](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/disable) Disable an external binding. +
              #### [enable](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/enable) Enable an external binding. +
              #### [getActivationCodeForMobileClient](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getActivationCodeForMobileClient) Get an activation code that is used for provisioning a mobile credential. +
              #### [getAttributes](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getAttributes) Retrieve attributes of an external authentication binding. +
              #### [getBillingItem](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getBillingItem) Retrieve the current billing item for an external binding. +
              #### [getCredentialExpirationDate](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialExpirationDate) Retrieve the date that a VeriSign credential expires. +
              #### [getCredentialLastUpdateDate](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialLastUpdateDate) Retrieve the last time a VeriSign credential was updated. +
              #### [getCredentialState](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialState) Retrieve the current state of a VeriSign credential. This can be 'Enabled', 'Disabled', or 'Locked'. +
              #### [getCredentialType](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialType) Retrieve the type of VeriSign credential. This can be either 'Hardware' or 'Software'. +
              #### [getNote](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getNote) Retrieve an optional note for identifying the external binding. +
              #### [getObject](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getObject) Retrieve a SoftLayer_User_Customer_External_Binding_Verisign record. +
              #### [getType](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getType) Retrieve the type of external authentication binding. +
              #### [getUser](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getUser) Retrieve the SoftLayer user that the external authentication binding belongs to. +
              #### [getVendor](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getVendor) Retrieve the vendor of an external authentication binding. +
              #### [unlock](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/unlock) +
              #### [updateNote](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/updateNote) Update the note of an external binding. +
              #### [validateCredentialId](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/validateCredentialId) Validate a VeriSign credential id. +
              diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/deleteObject.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/deleteObject.md index bd39c89f14..679066b90c 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/deleteObject.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Verisign](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign)::deleteObject + Delete a VeriSign external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/disable.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/disable.md index 73b6a74792..21a043aa0b 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/disable.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/disable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Verisign](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign)::disable + Disable an external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/enable.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/enable.md index ae3f3f3014..382b527767 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/enable.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/enable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Verisign](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign)::enable + Enable an external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getActivationCodeForMobileClient.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getActivationCodeForMobileClient.md index d35115365c..78ccbac124 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getActivationCodeForMobileClient.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getActivationCodeForMobileClient.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Verisign](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign)::getActivationCodeForMobileClient + Get an activation code that is used for provisioning a mobile credential. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getAttributes.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getAttributes.md index 55d679b597..822e10def8 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getAttributes.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getAttributes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Verisign](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign)::getAttributes + Retrieve attributes of an external authentication binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getBillingItem.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getBillingItem.md index 4c48dbe586..682e2fbdab 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getBillingItem.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Verisign](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign)::getBillingItem + Retrieve the current billing item for an external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialExpirationDate.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialExpirationDate.md index 04c7470641..114d7f0085 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialExpirationDate.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialExpirationDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Verisign](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign)::getCredentialExpirationDate + Retrieve the date that a VeriSign credential expires. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialLastUpdateDate.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialLastUpdateDate.md index 44eb110052..f2e55d67cb 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialLastUpdateDate.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialLastUpdateDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Verisign](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign)::getCredentialLastUpdateDate + Retrieve the last time a VeriSign credential was updated. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialState.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialState.md index 2443861905..dc1e41ac21 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialState.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialState.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Verisign](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign)::getCredentialState + Retrieve the current state of a VeriSign credential. This can be 'Enabled', 'Disabled', or 'Locked'. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialType.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialType.md index f93f707f49..29ac85ef83 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialType.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getCredentialType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Verisign](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign)::getCredentialType + Retrieve the type of VeriSign credential. This can be either 'Hardware' or 'Software'. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getNote.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getNote.md index b8190e110c..1690daaeed 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getNote.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getNote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Verisign](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign)::getNote + Retrieve an optional note for identifying the external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getObject.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getObject.md index f5f80177af..759c826796 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Verisign](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign)::getObject + Retrieve a SoftLayer_User_Customer_External_Binding_Verisign record. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getType.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getType.md index cad732f70b..4a89ef7e65 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getType.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Verisign](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign)::getType + Retrieve the type of external authentication binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getUser.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getUser.md index a86c71eb9c..b692f1c0eb 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getUser.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Verisign](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign)::getUser + Retrieve the SoftLayer user that the external authentication binding belongs to. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getVendor.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getVendor.md index 18445e7be7..f74feb929d 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getVendor.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/getVendor.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Verisign](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign)::getVendor + Retrieve the vendor of an external authentication binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/unlock.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/unlock.md index a48e1c0614..fd27dbf293 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/unlock.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/unlock.md @@ -16,6 +16,7 @@ aliases: + ## Overview If a VeriSign credential becomes locked because of too many failed login attempts the unlock method can be used to unlock a VeriSign credential. As a security precaution a valid security code generated by the credential will be required before the credential is unlocked. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/updateNote.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/updateNote.md index 663c40b894..fad3f37093 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/updateNote.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/updateNote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Verisign](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign)::updateNote + Update the note of an external binding. diff --git a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/validateCredentialId.md b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/validateCredentialId.md index 85119b8765..2d7f4f0fc5 100644 --- a/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/validateCredentialId.md +++ b/content/reference/services/SoftLayer_User_Customer_External_Binding_Verisign/validateCredentialId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_External_Binding_Verisign](/reference/services/SoftLayer_User_Customer_External_Binding_Verisign)::validateCredentialId + Validate a VeriSign credential id. diff --git a/content/reference/services/SoftLayer_User_Customer_Invitation/_index.md b/content/reference/services/SoftLayer_User_Customer_Invitation/_index.md index cc0b182cbb..1e4c099c92 100644 --- a/content/reference/services/SoftLayer_User_Customer_Invitation/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_Invitation/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getObject](/reference/services/SoftLayer_User_Customer_Invitation/getObject) Retrieve a SoftLayer_User_Customer_Invitation record. +
              #### [getUser](/reference/services/SoftLayer_User_Customer_Invitation/getUser) +
              diff --git a/content/reference/services/SoftLayer_User_Customer_Invitation/getObject.md b/content/reference/services/SoftLayer_User_Customer_Invitation/getObject.md index ebf345acd9..f9850424bc 100644 --- a/content/reference/services/SoftLayer_User_Customer_Invitation/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer_Invitation/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Invitation](/reference/services/SoftLayer_User_Customer_Invitation)::getObject + Retrieve a SoftLayer_User_Customer_Invitation record. diff --git a/content/reference/services/SoftLayer_User_Customer_Invitation/getUser.md b/content/reference/services/SoftLayer_User_Customer_Invitation/getUser.md index 9424faad6e..a0f3fd99bf 100644 --- a/content/reference/services/SoftLayer_User_Customer_Invitation/getUser.md +++ b/content/reference/services/SoftLayer_User_Customer_Invitation/getUser.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_MobileDevice/_index.md b/content/reference/services/SoftLayer_User_Customer_MobileDevice/_index.md index 7225929e1b..31b3ff7d50 100644 --- a/content/reference/services/SoftLayer_User_Customer_MobileDevice/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_MobileDevice/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,54 +44,63 @@ classes: #### [createObject](/reference/services/SoftLayer_User_Customer_MobileDevice/createObject) Create a new mobile device association for a user. +
              #### [deleteObject](/reference/services/SoftLayer_User_Customer_MobileDevice/deleteObject) Delete a mobile device association for a user. +
              #### [editObject](/reference/services/SoftLayer_User_Customer_MobileDevice/editObject) Edit the object by passing in a modified instance of the object. +
              #### [getAvailablePushNotificationSubscriptions](/reference/services/SoftLayer_User_Customer_MobileDevice/getAvailablePushNotificationSubscriptions) Retrieve notification subscriptions available to a mobile device. +
              #### [getCustomer](/reference/services/SoftLayer_User_Customer_MobileDevice/getCustomer) Retrieve the user this mobile device belongs to. +
              #### [getObject](/reference/services/SoftLayer_User_Customer_MobileDevice/getObject) Retrieve a SoftLayer_User_Customer_MobileDevice record. +
              #### [getOperatingSystem](/reference/services/SoftLayer_User_Customer_MobileDevice/getOperatingSystem) Retrieve the operating system this device is using +
              #### [getPushNotificationSubscriptions](/reference/services/SoftLayer_User_Customer_MobileDevice/getPushNotificationSubscriptions) Retrieve notification subscriptions attached to a mobile device. +
              #### [getType](/reference/services/SoftLayer_User_Customer_MobileDevice/getType) Retrieve the type of device this user is using +
              diff --git a/content/reference/services/SoftLayer_User_Customer_MobileDevice/createObject.md b/content/reference/services/SoftLayer_User_Customer_MobileDevice/createObject.md index dd74fb7b69..939406bf4e 100644 --- a/content/reference/services/SoftLayer_User_Customer_MobileDevice/createObject.md +++ b/content/reference/services/SoftLayer_User_Customer_MobileDevice/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_MobileDevice](/reference/services/SoftLayer_User_Customer_MobileDevice)::createObject + Create a new mobile device association for a user. diff --git a/content/reference/services/SoftLayer_User_Customer_MobileDevice/deleteObject.md b/content/reference/services/SoftLayer_User_Customer_MobileDevice/deleteObject.md index 51cd44ae4c..a786d5a09b 100644 --- a/content/reference/services/SoftLayer_User_Customer_MobileDevice/deleteObject.md +++ b/content/reference/services/SoftLayer_User_Customer_MobileDevice/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_MobileDevice](/reference/services/SoftLayer_User_Customer_MobileDevice)::deleteObject + Delete a mobile device association for a user. diff --git a/content/reference/services/SoftLayer_User_Customer_MobileDevice/editObject.md b/content/reference/services/SoftLayer_User_Customer_MobileDevice/editObject.md index bdeb74df93..beb51841bf 100644 --- a/content/reference/services/SoftLayer_User_Customer_MobileDevice/editObject.md +++ b/content/reference/services/SoftLayer_User_Customer_MobileDevice/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_MobileDevice](/reference/services/SoftLayer_User_Customer_MobileDevice)::editObject + Edit the object by passing in a modified instance of the object. diff --git a/content/reference/services/SoftLayer_User_Customer_MobileDevice/getAvailablePushNotificationSubscriptions.md b/content/reference/services/SoftLayer_User_Customer_MobileDevice/getAvailablePushNotificationSubscriptions.md index 4293846e0a..00ae97365c 100644 --- a/content/reference/services/SoftLayer_User_Customer_MobileDevice/getAvailablePushNotificationSubscriptions.md +++ b/content/reference/services/SoftLayer_User_Customer_MobileDevice/getAvailablePushNotificationSubscriptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_MobileDevice](/reference/services/SoftLayer_User_Customer_MobileDevice)::getAvailablePushNotificationSubscriptions + Retrieve notification subscriptions available to a mobile device. diff --git a/content/reference/services/SoftLayer_User_Customer_MobileDevice/getCustomer.md b/content/reference/services/SoftLayer_User_Customer_MobileDevice/getCustomer.md index ce4b203f28..15c13239c9 100644 --- a/content/reference/services/SoftLayer_User_Customer_MobileDevice/getCustomer.md +++ b/content/reference/services/SoftLayer_User_Customer_MobileDevice/getCustomer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_MobileDevice](/reference/services/SoftLayer_User_Customer_MobileDevice)::getCustomer + Retrieve the user this mobile device belongs to. diff --git a/content/reference/services/SoftLayer_User_Customer_MobileDevice/getObject.md b/content/reference/services/SoftLayer_User_Customer_MobileDevice/getObject.md index 8b47c9ae3a..72a351c0d0 100644 --- a/content/reference/services/SoftLayer_User_Customer_MobileDevice/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer_MobileDevice/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_MobileDevice](/reference/services/SoftLayer_User_Customer_MobileDevice)::getObject + Retrieve a SoftLayer_User_Customer_MobileDevice record. diff --git a/content/reference/services/SoftLayer_User_Customer_MobileDevice/getOperatingSystem.md b/content/reference/services/SoftLayer_User_Customer_MobileDevice/getOperatingSystem.md index aa02cba78c..4386de42d7 100644 --- a/content/reference/services/SoftLayer_User_Customer_MobileDevice/getOperatingSystem.md +++ b/content/reference/services/SoftLayer_User_Customer_MobileDevice/getOperatingSystem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_MobileDevice](/reference/services/SoftLayer_User_Customer_MobileDevice)::getOperatingSystem + Retrieve the operating system this device is using diff --git a/content/reference/services/SoftLayer_User_Customer_MobileDevice/getPushNotificationSubscriptions.md b/content/reference/services/SoftLayer_User_Customer_MobileDevice/getPushNotificationSubscriptions.md index a2cc174c28..b260c5b7d7 100644 --- a/content/reference/services/SoftLayer_User_Customer_MobileDevice/getPushNotificationSubscriptions.md +++ b/content/reference/services/SoftLayer_User_Customer_MobileDevice/getPushNotificationSubscriptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_MobileDevice](/reference/services/SoftLayer_User_Customer_MobileDevice)::getPushNotificationSubscriptions + Retrieve notification subscriptions attached to a mobile device. diff --git a/content/reference/services/SoftLayer_User_Customer_MobileDevice/getType.md b/content/reference/services/SoftLayer_User_Customer_MobileDevice/getType.md index 4b827029de..4c30acff52 100644 --- a/content/reference/services/SoftLayer_User_Customer_MobileDevice/getType.md +++ b/content/reference/services/SoftLayer_User_Customer_MobileDevice/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_MobileDevice](/reference/services/SoftLayer_User_Customer_MobileDevice)::getType + Retrieve the type of device this user is using diff --git a/content/reference/services/SoftLayer_User_Customer_MobileDevice_OperatingSystem/_index.md b/content/reference/services/SoftLayer_User_Customer_MobileDevice_OperatingSystem/_index.md index 75f3dc66a0..911b5b4350 100644 --- a/content/reference/services/SoftLayer_User_Customer_MobileDevice_OperatingSystem/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_MobileDevice_OperatingSystem/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_User_Customer_MobileDevice_OperatingSystem/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_User_Customer_MobileDevice_OperatingSystem/getObject) Retrieve a SoftLayer_User_Customer_MobileDevice_OperatingSystem record. +
              diff --git a/content/reference/services/SoftLayer_User_Customer_MobileDevice_OperatingSystem/getAllObjects.md b/content/reference/services/SoftLayer_User_Customer_MobileDevice_OperatingSystem/getAllObjects.md index 2b63f39d92..81c73daffa 100644 --- a/content/reference/services/SoftLayer_User_Customer_MobileDevice_OperatingSystem/getAllObjects.md +++ b/content/reference/services/SoftLayer_User_Customer_MobileDevice_OperatingSystem/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_MobileDevice_OperatingSystem/getObject.md b/content/reference/services/SoftLayer_User_Customer_MobileDevice_OperatingSystem/getObject.md index 77f246bdea..277c6af3d5 100644 --- a/content/reference/services/SoftLayer_User_Customer_MobileDevice_OperatingSystem/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer_MobileDevice_OperatingSystem/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_MobileDevice_OperatingSystem](/reference/services/SoftLayer_User_Customer_MobileDevice_OperatingSystem)::getObject + Retrieve a SoftLayer_User_Customer_MobileDevice_OperatingSystem record. diff --git a/content/reference/services/SoftLayer_User_Customer_MobileDevice_Type/_index.md b/content/reference/services/SoftLayer_User_Customer_MobileDevice_Type/_index.md index 43112c0988..f01d8537c2 100644 --- a/content/reference/services/SoftLayer_User_Customer_MobileDevice_Type/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_MobileDevice_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_User_Customer_MobileDevice_Type/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_User_Customer_MobileDevice_Type/getObject) Retrieve a SoftLayer_User_Customer_MobileDevice_Type record. +
              diff --git a/content/reference/services/SoftLayer_User_Customer_MobileDevice_Type/getAllObjects.md b/content/reference/services/SoftLayer_User_Customer_MobileDevice_Type/getAllObjects.md index e2a8c730c8..d535daba77 100644 --- a/content/reference/services/SoftLayer_User_Customer_MobileDevice_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_User_Customer_MobileDevice_Type/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_MobileDevice_Type/getObject.md b/content/reference/services/SoftLayer_User_Customer_MobileDevice_Type/getObject.md index 0999fcf603..6cb1bc4411 100644 --- a/content/reference/services/SoftLayer_User_Customer_MobileDevice_Type/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer_MobileDevice_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_MobileDevice_Type](/reference/services/SoftLayer_User_Customer_MobileDevice_Type)::getObject + Retrieve a SoftLayer_User_Customer_MobileDevice_Type record. diff --git a/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/_index.md b/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/_index.md index 3632d82cf5..cb72adbf0d 100644 --- a/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + 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. @@ -46,42 +48,49 @@ When a monitoring service on that hardware instance fails and the monitor is set #### [createObject](/reference/services/SoftLayer_User_Customer_Notification_Hardware/createObject) Create a user hardware notification entry +
              #### [createObjects](/reference/services/SoftLayer_User_Customer_Notification_Hardware/createObjects) Create multiple user hardware notification entries at once +
              #### [deleteObjects](/reference/services/SoftLayer_User_Customer_Notification_Hardware/deleteObjects) Delete a group of Customer_Notification_Hardware objects by passing in a collection of them +
              #### [findByHardwareId](/reference/services/SoftLayer_User_Customer_Notification_Hardware/findByHardwareId) Return all hardware notifications associated with the passed hardware ID +
              #### [getHardware](/reference/services/SoftLayer_User_Customer_Notification_Hardware/getHardware) Retrieve the hardware object that will be monitored. +
              #### [getObject](/reference/services/SoftLayer_User_Customer_Notification_Hardware/getObject) Retrieve a SoftLayer_User_Customer_Notification_Hardware record. +
              #### [getUser](/reference/services/SoftLayer_User_Customer_Notification_Hardware/getUser) Retrieve the user that will be notified when the associated hardware object fails a monitoring instance. +
              diff --git a/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/createObject.md b/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/createObject.md index 1a51cefd06..1f7325139c 100644 --- a/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/createObject.md +++ b/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Notification_Hardware](/reference/services/SoftLayer_User_Customer_Notification_Hardware)::createObject + Create a user hardware notification entry diff --git a/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/createObjects.md b/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/createObjects.md index e6ad744c66..3ad8ab0a8e 100644 --- a/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/createObjects.md +++ b/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/createObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Notification_Hardware](/reference/services/SoftLayer_User_Customer_Notification_Hardware)::createObjects + Create multiple user hardware notification entries at once @@ -36,7 +37,7 @@ Passing in a collection of unsaved instances of Customer_Notification_Hardware o * SoftLayer_ObjectMask ### Return Values -* SoftLayer_Dns_Domain[] +* SoftLayer_User_Customer_Notification_Hardware[] diff --git a/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/deleteObjects.md b/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/deleteObjects.md index 8c878e11f7..30b2ecc15c 100644 --- a/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/deleteObjects.md +++ b/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/deleteObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Notification_Hardware](/reference/services/SoftLayer_User_Customer_Notification_Hardware)::deleteObjects + Delete a group of Customer_Notification_Hardware objects by passing in a collection of them diff --git a/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/findByHardwareId.md b/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/findByHardwareId.md index fce23da4f5..4bed3023a1 100644 --- a/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/findByHardwareId.md +++ b/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/findByHardwareId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Notification_Hardware](/reference/services/SoftLayer_User_Customer_Notification_Hardware)::findByHardwareId + Return all hardware notifications associated with the passed hardware ID diff --git a/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/getHardware.md b/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/getHardware.md index e87a873c9f..bd1a8dd9c7 100644 --- a/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/getHardware.md +++ b/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Notification_Hardware](/reference/services/SoftLayer_User_Customer_Notification_Hardware)::getHardware + Retrieve the hardware object that will be monitored. diff --git a/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/getObject.md b/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/getObject.md index 539a757733..cbd793f7d9 100644 --- a/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Notification_Hardware](/reference/services/SoftLayer_User_Customer_Notification_Hardware)::getObject + Retrieve a SoftLayer_User_Customer_Notification_Hardware record. diff --git a/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/getUser.md b/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/getUser.md index 81393a4edf..eb8f74fed8 100644 --- a/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/getUser.md +++ b/content/reference/services/SoftLayer_User_Customer_Notification_Hardware/getUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Notification_Hardware](/reference/services/SoftLayer_User_Customer_Notification_Hardware)::getUser + Retrieve the user that will be notified when the associated hardware object fails a monitoring instance. diff --git a/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/_index.md b/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/_index.md index cf077a2242..03ad856eec 100644 --- a/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/_index.md @@ -20,6 +20,8 @@ classes: ## Description + + 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. @@ -46,42 +48,49 @@ When a monitoring service on that guest instance fails and the monitor is set to #### [createObject](/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/createObject) Create a user virtual guest notification entry +
              #### [createObjects](/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/createObjects) Create multiple user Virtual Guest notification entries at once +
              #### [deleteObjects](/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/deleteObjects) Delete a group of SoftLayer_Customer_Notification_Virtual_Guest objects by passing in a collection of them +
              #### [findByGuestId](/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/findByGuestId) Return all CloudLayer computing instance notifications associated with the passed ID +
              #### [getGuest](/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/getGuest) Retrieve the virtual guest object that will be monitored. +
              #### [getObject](/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/getObject) Retrieve a SoftLayer_User_Customer_Notification_Virtual_Guest record. +
              #### [getUser](/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/getUser) Retrieve the user that will be notified when the associated virtual guest object fails a monitoring instance. +
              diff --git a/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/createObject.md b/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/createObject.md index 10a01761bc..e4e92b1d4c 100644 --- a/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/createObject.md +++ b/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Notification_Virtual_Guest](/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest)::createObject + Create a user virtual guest notification entry diff --git a/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/createObjects.md b/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/createObjects.md index 2746b03189..557343aac7 100644 --- a/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/createObjects.md +++ b/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/createObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Notification_Virtual_Guest](/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest)::createObjects + Create multiple user Virtual Guest notification entries at once diff --git a/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/deleteObjects.md b/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/deleteObjects.md index 161dae8ae8..976918d9ea 100644 --- a/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/deleteObjects.md +++ b/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/deleteObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Notification_Virtual_Guest](/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest)::deleteObjects + Delete a group of SoftLayer_Customer_Notification_Virtual_Guest objects by passing in a collection of them diff --git a/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/findByGuestId.md b/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/findByGuestId.md index a4dc42f866..9f21b181e4 100644 --- a/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/findByGuestId.md +++ b/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/findByGuestId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Notification_Virtual_Guest](/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest)::findByGuestId + Return all CloudLayer computing instance notifications associated with the passed ID diff --git a/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/getGuest.md b/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/getGuest.md index df3cd14c1e..aff1b9e526 100644 --- a/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/getGuest.md +++ b/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/getGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Notification_Virtual_Guest](/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest)::getGuest + Retrieve the virtual guest object that will be monitored. diff --git a/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/getObject.md b/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/getObject.md index 37c63f0d37..c93fd1e830 100644 --- a/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Notification_Virtual_Guest](/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest)::getObject + Retrieve a SoftLayer_User_Customer_Notification_Virtual_Guest record. diff --git a/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/getUser.md b/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/getUser.md index e497072b14..59b6caaabd 100644 --- a/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/getUser.md +++ b/content/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest/getUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Notification_Virtual_Guest](/reference/services/SoftLayer_User_Customer_Notification_Virtual_Guest)::getUser + Retrieve the user that will be notified when the associated virtual guest object fails a monitoring instance. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/_index.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/_index.md index b6e778f60d..e5b571815f 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,816 +44,958 @@ classes: #### [acknowledgeSupportPolicy](/reference/services/SoftLayer_User_Customer_OpenIdConnect/acknowledgeSupportPolicy) +
              #### [activateOpenIdConnectUser](/reference/services/SoftLayer_User_Customer_OpenIdConnect/activateOpenIdConnectUser) Completes invitation process for an OIDC user initiated by the +
              #### [addApiAuthenticationKey](/reference/services/SoftLayer_User_Customer_OpenIdConnect/addApiAuthenticationKey) Create a user's API authentication key. +
              #### [addBulkDedicatedHostAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkDedicatedHostAccess) Grant access to the user for one or more dedicated hosts devices. +
              #### [addBulkHardwareAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkHardwareAccess) Add multiple hardware to a portal user's hardware access list. +
              #### [addBulkPortalPermission](/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkPortalPermission) Add multiple permissions to a portal user's permission set. +
              #### [addBulkRoles](/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkRoles) +
              #### [addBulkVirtualGuestAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkVirtualGuestAccess) Add multiple CloudLayer Computing Instances to a portal user's access list. +
              #### [addDedicatedHostAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect/addDedicatedHostAccess) Grant access to the user for a single dedicated host device. +
              #### [addExternalBinding](/reference/services/SoftLayer_User_Customer_OpenIdConnect/addExternalBinding) +
              #### [addHardwareAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect/addHardwareAccess) Add hardware to a portal user's hardware access list. +
              #### [addNotificationSubscriber](/reference/services/SoftLayer_User_Customer_OpenIdConnect/addNotificationSubscriber) Create a notification subscription record for the user. +
              #### [addPortalPermission](/reference/services/SoftLayer_User_Customer_OpenIdConnect/addPortalPermission) Add a permission to a portal user's permission set. +
              #### [addRole](/reference/services/SoftLayer_User_Customer_OpenIdConnect/addRole) +
              #### [addVirtualGuestAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect/addVirtualGuestAccess) Add a CloudLayer Computing Instance to a portal user's access list. +
              #### [assignNewParentId](/reference/services/SoftLayer_User_Customer_OpenIdConnect/assignNewParentId) Assign a different parent to this user. +
              #### [changePreference](/reference/services/SoftLayer_User_Customer_OpenIdConnect/changePreference) Change preference values for the current user +
              #### [checkExternalAuthenticationStatus](/reference/services/SoftLayer_User_Customer_OpenIdConnect/checkExternalAuthenticationStatus) Checks if an external authentication is complete or not +
              #### [checkPhoneFactorAuthenticationForPasswordSet](/reference/services/SoftLayer_User_Customer_OpenIdConnect/checkPhoneFactorAuthenticationForPasswordSet) Check the status of an outstanding Phone Factor Authentication for Password Set +
              #### [completeInvitationAfterLogin](/reference/services/SoftLayer_User_Customer_OpenIdConnect/completeInvitationAfterLogin) Completes invitation processing after logging on an existing OpenIdConnect user identity and return an access token +
              #### [createNotificationSubscriber](/reference/services/SoftLayer_User_Customer_OpenIdConnect/createNotificationSubscriber) Create a new subscriber for a given resource. +
              #### [createObject](/reference/services/SoftLayer_User_Customer_OpenIdConnect/createObject) Create a new user record. +
              #### [createOpenIdConnectUserAndCompleteInvitation](/reference/services/SoftLayer_User_Customer_OpenIdConnect/createOpenIdConnectUserAndCompleteInvitation) Completes invitation processing when a new OpenIdConnect user must be created. +
              #### [createSubscriberDeliveryMethods](/reference/services/SoftLayer_User_Customer_OpenIdConnect/createSubscriberDeliveryMethods) Create delivery methods for the subscriber. +
              #### [deactivateNotificationSubscriber](/reference/services/SoftLayer_User_Customer_OpenIdConnect/deactivateNotificationSubscriber) Delete a subscriber for a given resource. +
              #### [declineInvitation](/reference/services/SoftLayer_User_Customer_OpenIdConnect/declineInvitation) Sets a customer invitation as declined. +
              #### [editObject](/reference/services/SoftLayer_User_Customer_OpenIdConnect/editObject) Update a user's information. +
              #### [editObjects](/reference/services/SoftLayer_User_Customer_OpenIdConnect/editObjects) Update a collection of users' information +
              #### [findUserPreference](/reference/services/SoftLayer_User_Customer_OpenIdConnect/findUserPreference) +
              #### [getAccount](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAccount) Retrieve the customer account that a user belongs to. +
              #### [getActions](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getActions) +
              #### [getActiveExternalAuthenticationVendors](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getActiveExternalAuthenticationVendors) Get a list of active external authentication vendors for a SoftLayer user. +
              #### [getAdditionalEmails](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAdditionalEmails) Retrieve a portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets. +
              #### [getAgentImpersonationToken](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAgentImpersonationToken) +
              #### [getAllowedDedicatedHostIds](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAllowedDedicatedHostIds) +
              #### [getAllowedHardwareIds](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAllowedHardwareIds) +
              #### [getAllowedVirtualGuestIds](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAllowedVirtualGuestIds) +
              #### [getApiAuthenticationKeys](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getApiAuthenticationKeys) Retrieve a portal user's API Authentication keys. There is a max limit of one API key per user. +
              #### [getAuthenticationToken](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAuthenticationToken) +
              #### [getChildUsers](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getChildUsers) Retrieve a portal user's child users. Some portal users may not have child users. +
              #### [getClosedTickets](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getClosedTickets) Retrieve an user's associated closed tickets. +
              #### [getDedicatedHosts](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getDedicatedHosts) Retrieve the dedicated hosts to which the user has been granted access. +
              #### [getDefaultAccount](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getDefaultAccount) Retrieve the default account for the OpenIdConnect identity that is linked to the current active SoftLayer user identity. +
              #### [getExternalBindings](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getExternalBindings) Retrieve the external authentication bindings that link an external identifier to a SoftLayer user. +
              #### [getHardware](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHardware) Retrieve a portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal. +
              #### [getHardwareCount](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHardwareCount) Retrieve the current number of servers a portal user has access to. +
              #### [getHardwareNotifications](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHardwareNotifications) Retrieve hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'. +
              #### [getHasAcknowledgedSupportPolicyFlag](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasAcknowledgedSupportPolicyFlag) Retrieve whether or not a user has acknowledged the support policy. +
              #### [getHasFullDedicatedHostAccessFlag](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasFullDedicatedHostAccessFlag) Retrieve permission granting the user access to all Dedicated Host devices on the account. +
              #### [getHasFullHardwareAccessFlag](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasFullHardwareAccessFlag) Retrieve whether or not a portal user has access to all hardware on their account. +
              #### [getHasFullVirtualGuestAccessFlag](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasFullVirtualGuestAccessFlag) Retrieve whether or not a portal user has access to all virtual guests on their account. +
              #### [getIbmIdLink](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getIbmIdLink) Retrieve specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link. +
              #### [getImpersonationToken](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getImpersonationToken) +
              #### [getLayoutProfiles](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLayoutProfiles) Retrieve contains the definition of the layout profile. +
              #### [getLocale](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLocale) Retrieve a user's locale. Locale holds user's language and region information. +
              #### [getLoginAccountInfoOpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLoginAccountInfoOpenIdConnect) Get account for an active user logging into the SoftLayer customer portal +
              #### [getLoginAttempts](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLoginAttempts) Retrieve a user's attempts to log into the SoftLayer customer portal. +
              #### [getLoginToken](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLoginToken) Authenticate a user for the SoftLayer customer portal +
              #### [getMappedAccounts](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getMappedAccounts) Retrieve a list of all active accounts that belong to this customer. +
              #### [getMobileDevices](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getMobileDevices) Retrieve a portal user's associated mobile device profiles. +
              #### [getNotificationSubscribers](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getNotificationSubscribers) Retrieve notification subscription records for the user. +
              #### [getObject](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getObject) Retrieve a SoftLayer_User_Customer_OpenIdConnect record. +
              #### [getOpenIdConnectMigrationState](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOpenIdConnectMigrationState) Get the OpenId migration state +
              #### [getOpenIdRegistrationInfoFromCode](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOpenIdRegistrationInfoFromCode) Get OpenId User Registration details from the provided email code +
              #### [getOpenTickets](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOpenTickets) Retrieve an user's associated open tickets. +
              #### [getOverrides](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOverrides) Retrieve a portal user's vpn accessible subnets. +
              #### [getParent](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getParent) Retrieve a portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user. +
              #### [getPasswordRequirements](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPasswordRequirements) +
              #### [getPermissions](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPermissions) Retrieve a portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API. +
              #### [getPortalLoginToken](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPortalLoginToken) Authenticate a user for the SoftLayer customer portal +
              -
              +
              #### [getPortalLoginTokenOpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPortalLoginTokenOpenIdConnect) Authenticate a user for the SoftLayer customer portal via an openIdConnect provider. + +Deprecated + +
              #### [getPreference](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPreference) Get a preference value for the current user +
              #### [getPreferenceTypes](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPreferenceTypes) Get all available preference types +
              #### [getPreferences](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPreferences) Retrieve data type contains a single user preference to a specific preference type. +
              #### [getRequirementsForPasswordSet](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getRequirementsForPasswordSet) Retrieve the authentication requirements for a user when attempting +
              #### [getRoles](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getRoles) +
              #### [getSalesforceUserLink](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSalesforceUserLink) Retrieve [DEPRECATED] +
              #### [getSecurityAnswers](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSecurityAnswers) Retrieve a portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login. +
              #### [getSubscribers](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSubscribers) Retrieve a user's notification subscription records. +
              #### [getSuccessfulLogins](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSuccessfulLogins) Retrieve a user's successful attempts to log into the SoftLayer customer portal. +
              #### [getSupportPolicyAcknowledgementRequiredFlag](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportPolicyAcknowledgementRequiredFlag) Retrieve whether or not a user is required to acknowledge the support policy for portal access. +
              #### [getSupportPolicyDocument](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportPolicyDocument) +
              #### [getSupportPolicyName](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportPolicyName) +
              #### [getSupportedLocales](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportedLocales) Returns all supported locales for the current user +
              #### [getSurveyRequiredFlag](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSurveyRequiredFlag) Retrieve whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal. +
              #### [getSurveys](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSurveys) Retrieve the surveys that a user has taken in the SoftLayer customer portal. +
              #### [getTickets](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getTickets) Retrieve an user's associated tickets. +
              #### [getTimezone](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getTimezone) Retrieve a portal user's time zone. +
              #### [getUnsuccessfulLogins](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUnsuccessfulLogins) Retrieve a user's unsuccessful attempts to log into the SoftLayer customer portal. +
              #### [getUserForUnifiedInvitation](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserForUnifiedInvitation) Get the IMS User Object for the provided OpenIdConnect User ID, or (Optional) IBMid Unique Identifier. +
              #### [getUserIdForPasswordSet](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserIdForPasswordSet) Retrieve a user id using a password request key +
              #### [getUserLinks](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserLinks) Retrieve user customer link with IBMid and IAMid. +
              #### [getUserPreferences](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserPreferences) +
              #### [getUserStatus](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserStatus) Retrieve a portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network. +
              #### [getVirtualGuestCount](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getVirtualGuestCount) Retrieve the current number of CloudLayer Computing Instances a portal user has access to. +
              #### [getVirtualGuests](/reference/services/SoftLayer_User_Customer_OpenIdConnect/getVirtualGuests) Retrieve a portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal. +
              #### [inTerminalStatus](/reference/services/SoftLayer_User_Customer_OpenIdConnect/inTerminalStatus) +
              #### [initiateExternalAuthentication](/reference/services/SoftLayer_User_Customer_OpenIdConnect/initiateExternalAuthentication) Initiates an external authentication using the given authentication container. +
              #### [initiatePortalPasswordChange](/reference/services/SoftLayer_User_Customer_OpenIdConnect/initiatePortalPasswordChange) Request email to allow user to change their password +
              #### [initiatePortalPasswordChangeByBrandAgent](/reference/services/SoftLayer_User_Customer_OpenIdConnect/initiatePortalPasswordChangeByBrandAgent) Allows a Brand Agent to request password reset email to be sent to +
              #### [inviteUserToLinkOpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect/inviteUserToLinkOpenIdConnect) Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect. +
              -
              +
              #### [isMasterUser](/reference/services/SoftLayer_User_Customer_OpenIdConnect/isMasterUser) Determine if a portal user is a master user. + +Deprecated + +
              #### [isValidPortalPassword](/reference/services/SoftLayer_User_Customer_OpenIdConnect/isValidPortalPassword) Determine if a string is a user's portal password. +
              #### [performExternalAuthentication](/reference/services/SoftLayer_User_Customer_OpenIdConnect/performExternalAuthentication) Perform an external authentication using the given authentication container. +
              #### [processPasswordSetRequest](/reference/services/SoftLayer_User_Customer_OpenIdConnect/processPasswordSetRequest) Set the password for a user who has a valid password request key +
              #### [removeAllDedicatedHostAccessForThisUser](/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeAllDedicatedHostAccessForThisUser) Revoke access to all dedicated hosts on the account for this user. +
              #### [removeAllHardwareAccessForThisUser](/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeAllHardwareAccessForThisUser) Remove all hardware from a portal user's hardware access list. +
              #### [removeAllVirtualAccessForThisUser](/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeAllVirtualAccessForThisUser) Remove all cloud computing instances from a portal user's instance access list. +
              #### [removeApiAuthenticationKey](/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeApiAuthenticationKey) Remove a user's API authentication key. +
              #### [removeBulkDedicatedHostAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkDedicatedHostAccess) Revoke access for the user for one or more dedicated hosts devices. +
              #### [removeBulkHardwareAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkHardwareAccess) Remove multiple hardware from a portal user's hardware access list. +
              #### [removeBulkPortalPermission](/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkPortalPermission) Remove multiple permissions from a portal user's permission set. +
              #### [removeBulkRoles](/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkRoles) +
              #### [removeBulkVirtualGuestAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkVirtualGuestAccess) Remove multiple CloudLayer Computing Instances from a portal user's access list. +
              #### [removeDedicatedHostAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeDedicatedHostAccess) Revoke access for the user to a single dedicated hosts device. +
              #### [removeExternalBinding](/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeExternalBinding) Remove an external binding from this user. +
              #### [removeHardwareAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeHardwareAccess) Remove hardware from a portal user's hardware access list. +
              #### [removePortalPermission](/reference/services/SoftLayer_User_Customer_OpenIdConnect/removePortalPermission) Remove a permission from a portal user's permission set. +
              #### [removeRole](/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeRole) +
              #### [removeSecurityAnswers](/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeSecurityAnswers) +
              #### [removeVirtualGuestAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeVirtualGuestAccess) Remove a CloudLayer Computing Instance from a portal user's access list. +
              #### [resetOpenIdConnectLink](/reference/services/SoftLayer_User_Customer_OpenIdConnect/resetOpenIdConnectLink) Change the link of a user for OpenIdConnect managed accounts, provided the +
              #### [resetOpenIdConnectLinkUnifiedUserManagementMode](/reference/services/SoftLayer_User_Customer_OpenIdConnect/resetOpenIdConnectLinkUnifiedUserManagementMode) Change the link of a master user for OpenIdConnect managed accounts, +
              #### [samlAuthenticate](/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlAuthenticate) +
              #### [samlBeginAuthentication](/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlBeginAuthentication) +
              #### [samlBeginLogout](/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlBeginLogout) +
              #### [samlLogout](/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlLogout) +
              #### [selfPasswordChange](/reference/services/SoftLayer_User_Customer_OpenIdConnect/selfPasswordChange) +
              #### [setDefaultAccount](/reference/services/SoftLayer_User_Customer_OpenIdConnect/setDefaultAccount) Sets the default account for the OpenIdConnect identity that is linked to the current SoftLayer user identity. +
              #### [silentlyMigrateUserOpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect/silentlyMigrateUserOpenIdConnect) This api is used to migrate a user to IBMid without sending an invitation. +
              #### [updateNotificationSubscriber](/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateNotificationSubscriber) Update the active status for a notification subscription. +
              #### [updateSecurityAnswers](/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateSecurityAnswers) Update portal login security questions and answers. +
              #### [updateSubscriberDeliveryMethod](/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateSubscriberDeliveryMethod) Update a delivery method for the subscriber. +
              #### [updateVpnPassword](/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateVpnPassword) Update a user's VPN password +
              #### [updateVpnUser](/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateVpnUser) Creates or updates a user's VPN access privileges. +
              #### [validateAuthenticationToken](/reference/services/SoftLayer_User_Customer_OpenIdConnect/validateAuthenticationToken) +
              diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/acknowledgeSupportPolicy.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/acknowledgeSupportPolicy.md index 3226ddb9b2..fd903b406e 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/acknowledgeSupportPolicy.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/acknowledgeSupportPolicy.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/activateOpenIdConnectUser.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/activateOpenIdConnectUser.md index 71315d4dc2..098c2e8322 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/activateOpenIdConnectUser.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/activateOpenIdConnectUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::activateOpenIdConnectUser + Completes invitation process for an OIDC user initiated by the diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addApiAuthenticationKey.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addApiAuthenticationKey.md index 8564be4e57..fc5d109454 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addApiAuthenticationKey.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addApiAuthenticationKey.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::addApiAuthenticationKey + Create a user's API authentication key. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkDedicatedHostAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkDedicatedHostAccess.md index 6ccbd969f4..c78b6e0d9f 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkDedicatedHostAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkDedicatedHostAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::addBulkDedicatedHostAccess + Grant access to the user for one or more dedicated hosts devices. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkHardwareAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkHardwareAccess.md index 0bdae59ba6..7fef2d357b 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkHardwareAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkHardwareAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::addBulkHardwareAccess + Add multiple hardware to a portal user's hardware access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkPortalPermission.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkPortalPermission.md index cec6c5f31b..d5bbf23ef4 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkPortalPermission.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkPortalPermission.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::addBulkPortalPermission + Add multiple permissions to a portal user's permission set. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkRoles.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkRoles.md index b80575547a..8c113b683f 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkRoles.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkRoles.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkVirtualGuestAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkVirtualGuestAccess.md index 977d5a8067..499116e128 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkVirtualGuestAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addBulkVirtualGuestAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::addBulkVirtualGuestAccess + Add multiple CloudLayer Computing Instances to a portal user's access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addDedicatedHostAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addDedicatedHostAccess.md index 5eef6ef830..d1f97773b6 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addDedicatedHostAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addDedicatedHostAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::addDedicatedHostAccess + Grant access to the user for a single dedicated host device. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addExternalBinding.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addExternalBinding.md index 6585922655..e89fcefbda 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addExternalBinding.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addExternalBinding.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addHardwareAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addHardwareAccess.md index c0a8630a08..7d57e9e2ab 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addHardwareAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addHardwareAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::addHardwareAccess + Add hardware to a portal user's hardware access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addNotificationSubscriber.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addNotificationSubscriber.md index 7009482332..c7f70b0741 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addNotificationSubscriber.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addNotificationSubscriber.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::addNotificationSubscriber + Create a notification subscription record for the user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addPortalPermission.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addPortalPermission.md index 8eda4b8ff8..90f1120fda 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addPortalPermission.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addPortalPermission.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::addPortalPermission + Add a permission to a portal user's permission set. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addRole.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addRole.md index f5b29eb2d0..c43f2c5b95 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addRole.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addRole.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addVirtualGuestAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addVirtualGuestAccess.md index 39ff9dad1a..1440c26095 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addVirtualGuestAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/addVirtualGuestAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::addVirtualGuestAccess + Add a CloudLayer Computing Instance to a portal user's access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/assignNewParentId.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/assignNewParentId.md index a8e4e3c288..5797c9879c 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/assignNewParentId.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/assignNewParentId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::assignNewParentId + Assign a different parent to this user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/changePreference.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/changePreference.md index f947464a1c..fc79803f0f 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/changePreference.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/changePreference.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::changePreference + Change preference values for the current user diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/checkExternalAuthenticationStatus.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/checkExternalAuthenticationStatus.md index d5fa05eaf1..181895992a 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/checkExternalAuthenticationStatus.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/checkExternalAuthenticationStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::checkExternalAuthenticationStatus + Checks if an external authentication is complete or not diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/checkPhoneFactorAuthenticationForPasswordSet.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/checkPhoneFactorAuthenticationForPasswordSet.md index 28f7debcc3..e243604c2a 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/checkPhoneFactorAuthenticationForPasswordSet.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/checkPhoneFactorAuthenticationForPasswordSet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::checkPhoneFactorAuthenticationForPasswordSet + Check the status of an outstanding Phone Factor Authentication for Password Set diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/completeInvitationAfterLogin.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/completeInvitationAfterLogin.md index 2d1246b3b3..99588bd019 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/completeInvitationAfterLogin.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/completeInvitationAfterLogin.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::completeInvitationAfterLogin + Completes invitation processing after logging on an existing OpenIdConnect user identity and return an access token diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/createNotificationSubscriber.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/createNotificationSubscriber.md index e7b8afe559..1d4c2fbd30 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/createNotificationSubscriber.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/createNotificationSubscriber.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::createNotificationSubscriber + Create a new subscriber for a given resource. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/createObject.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/createObject.md index ad7f3c28e0..3923eefcc3 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/createObject.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::createObject + Create a new user record. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/createOpenIdConnectUserAndCompleteInvitation.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/createOpenIdConnectUserAndCompleteInvitation.md index 379f7edac9..ff9c3e8894 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/createOpenIdConnectUserAndCompleteInvitation.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/createOpenIdConnectUserAndCompleteInvitation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::createOpenIdConnectUserAndCompleteInvitation + Completes invitation processing when a new OpenIdConnect user must be created. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/createSubscriberDeliveryMethods.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/createSubscriberDeliveryMethods.md index 2745a242f0..4407a166c8 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/createSubscriberDeliveryMethods.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/createSubscriberDeliveryMethods.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::createSubscriberDeliveryMethods + Create delivery methods for the subscriber. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/deactivateNotificationSubscriber.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/deactivateNotificationSubscriber.md index 4cd4a51a52..55eac6a7c5 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/deactivateNotificationSubscriber.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/deactivateNotificationSubscriber.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::deactivateNotificationSubscriber + Delete a subscriber for a given resource. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/declineInvitation.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/declineInvitation.md index 8a35e7a7eb..e80285b883 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/declineInvitation.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/declineInvitation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::declineInvitation + Sets a customer invitation as declined. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/editObject.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/editObject.md index 236302337d..7a8c0d0a61 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/editObject.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::editObject + Update a user's information. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/editObjects.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/editObjects.md index f4396cb885..7a32f36b39 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/editObjects.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/editObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::editObjects + Update a collection of users' information diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/findUserPreference.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/findUserPreference.md index cc023b6048..16dda397cc 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/findUserPreference.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/findUserPreference.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAccount.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAccount.md index 798df448e7..7e4d4a7148 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAccount.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getAccount + Retrieve the customer account that a user belongs to. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getActions.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getActions.md index 4add01712d..300005049d 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getActions.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getActions.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getActiveExternalAuthenticationVendors.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getActiveExternalAuthenticationVendors.md index 8de23cd866..7cc3bae69e 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getActiveExternalAuthenticationVendors.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getActiveExternalAuthenticationVendors.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getActiveExternalAuthenticationVendors + Get a list of active external authentication vendors for a SoftLayer user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAdditionalEmails.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAdditionalEmails.md index 68b16d1d5c..f82aea15cd 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAdditionalEmails.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAdditionalEmails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getAdditionalEmails + Retrieve a portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAgentImpersonationToken.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAgentImpersonationToken.md index eb006753fb..69ecf58284 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAgentImpersonationToken.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAgentImpersonationToken.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAllowedDedicatedHostIds.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAllowedDedicatedHostIds.md index 13a6fc67f6..3a7d06b9fa 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAllowedDedicatedHostIds.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAllowedDedicatedHostIds.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAllowedHardwareIds.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAllowedHardwareIds.md index 5592a41e5f..8b1ffe1e0b 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAllowedHardwareIds.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAllowedHardwareIds.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAllowedVirtualGuestIds.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAllowedVirtualGuestIds.md index 08f86b81ae..031cf2e822 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAllowedVirtualGuestIds.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAllowedVirtualGuestIds.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getApiAuthenticationKeys.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getApiAuthenticationKeys.md index 5e33969d57..7613edde65 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getApiAuthenticationKeys.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getApiAuthenticationKeys.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getApiAuthenticationKeys + Retrieve a portal user's API Authentication keys. There is a max limit of one API key per user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAuthenticationToken.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAuthenticationToken.md index 38086c8e69..c9cfa65f76 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAuthenticationToken.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getAuthenticationToken.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getChildUsers.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getChildUsers.md index 3452458a9e..26c8b83f3c 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getChildUsers.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getChildUsers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getChildUsers + Retrieve a portal user's child users. Some portal users may not have child users. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getClosedTickets.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getClosedTickets.md index bd29c0038a..b77d30e4d6 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getClosedTickets.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getClosedTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getClosedTickets + Retrieve an user's associated closed tickets. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getDedicatedHosts.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getDedicatedHosts.md index e80393e8c9..05990e63db 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getDedicatedHosts.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getDedicatedHosts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getDedicatedHosts + Retrieve the dedicated hosts to which the user has been granted access. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getDefaultAccount.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getDefaultAccount.md index 2878db35d1..5ebeb424e5 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getDefaultAccount.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getDefaultAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getDefaultAccount + Retrieve the default account for the OpenIdConnect identity that is linked to the current active SoftLayer user identity. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getExternalBindings.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getExternalBindings.md index a97ed5d5cd..8480bb9f73 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getExternalBindings.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getExternalBindings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getExternalBindings + Retrieve the external authentication bindings that link an external identifier to a SoftLayer user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHardware.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHardware.md index e1d0d3876a..ca537f7fc2 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHardware.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getHardware + Retrieve a portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHardwareCount.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHardwareCount.md index 00275cf185..4b28c6d8e7 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHardwareCount.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHardwareCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getHardwareCount + Retrieve the current number of servers a portal user has access to. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHardwareNotifications.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHardwareNotifications.md index 3ca6fe5aba..b63935c1a6 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHardwareNotifications.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHardwareNotifications.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getHardwareNotifications + Retrieve hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasAcknowledgedSupportPolicyFlag.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasAcknowledgedSupportPolicyFlag.md index a9cddd1c61..370191d761 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasAcknowledgedSupportPolicyFlag.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasAcknowledgedSupportPolicyFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getHasAcknowledgedSupportPolicyFlag + Retrieve whether or not a user has acknowledged the support policy. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasFullDedicatedHostAccessFlag.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasFullDedicatedHostAccessFlag.md index 04342ddbcc..2119d05c22 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasFullDedicatedHostAccessFlag.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasFullDedicatedHostAccessFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getHasFullDedicatedHostAccessFlag + Retrieve permission granting the user access to all Dedicated Host devices on the account. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasFullHardwareAccessFlag.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasFullHardwareAccessFlag.md index 5ae9a88e58..4e1d1a72f5 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasFullHardwareAccessFlag.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasFullHardwareAccessFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getHasFullHardwareAccessFlag + Retrieve whether or not a portal user has access to all hardware on their account. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasFullVirtualGuestAccessFlag.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasFullVirtualGuestAccessFlag.md index 6b3f77fde1..ef3b16834b 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasFullVirtualGuestAccessFlag.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getHasFullVirtualGuestAccessFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getHasFullVirtualGuestAccessFlag + Retrieve whether or not a portal user has access to all virtual guests on their account. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getIbmIdLink.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getIbmIdLink.md index 6d244131c5..d545e489a0 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getIbmIdLink.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getIbmIdLink.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getIbmIdLink + Retrieve specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getImpersonationToken.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getImpersonationToken.md index 389f2a210b..f013671310 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getImpersonationToken.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getImpersonationToken.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLayoutProfiles.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLayoutProfiles.md index 2f5f8fabd7..634bae3215 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLayoutProfiles.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLayoutProfiles.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getLayoutProfiles + Retrieve contains the definition of the layout profile. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLocale.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLocale.md index 301cb26343..dfc2f788bc 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLocale.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLocale.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getLocale + Retrieve a user's locale. Locale holds user's language and region information. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLoginAccountInfoOpenIdConnect.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLoginAccountInfoOpenIdConnect.md index 5c396dea36..ff8e92e453 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLoginAccountInfoOpenIdConnect.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLoginAccountInfoOpenIdConnect.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getLoginAccountInfoOpenIdConnect + Get account for an active user logging into the SoftLayer customer portal diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLoginAttempts.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLoginAttempts.md index f245c3af32..98a3eb5e0c 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLoginAttempts.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLoginAttempts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getLoginAttempts + Retrieve a user's attempts to log into the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLoginToken.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLoginToken.md index 855bea1062..5240b67703 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLoginToken.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getLoginToken.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getLoginToken + Authenticate a user for the SoftLayer customer portal diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getMappedAccounts.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getMappedAccounts.md index 8fa4ca9a9c..762489089a 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getMappedAccounts.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getMappedAccounts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getMappedAccounts + Retrieve a list of all active accounts that belong to this customer. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getMobileDevices.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getMobileDevices.md index f748628cbc..a38e19a4ca 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getMobileDevices.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getMobileDevices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getMobileDevices + Retrieve a portal user's associated mobile device profiles. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getNotificationSubscribers.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getNotificationSubscribers.md index a7dbcfd792..9991d7d56e 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getNotificationSubscribers.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getNotificationSubscribers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getNotificationSubscribers + Retrieve notification subscription records for the user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getObject.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getObject.md index 01ac8d1c9e..fb93174091 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getObject + Retrieve a SoftLayer_User_Customer_OpenIdConnect record. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOpenIdConnectMigrationState.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOpenIdConnectMigrationState.md index 5a9bd3277a..be3cf874db 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOpenIdConnectMigrationState.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOpenIdConnectMigrationState.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getOpenIdConnectMigrationState + Get the OpenId migration state diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOpenIdRegistrationInfoFromCode.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOpenIdRegistrationInfoFromCode.md index 7e1e9b49ef..678fe71a9f 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOpenIdRegistrationInfoFromCode.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOpenIdRegistrationInfoFromCode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getOpenIdRegistrationInfoFromCode + Get OpenId User Registration details from the provided email code diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOpenTickets.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOpenTickets.md index cbd1734061..3c8f65aca7 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOpenTickets.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOpenTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getOpenTickets + Retrieve an user's associated open tickets. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOverrides.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOverrides.md index 6be49f11f6..6b7a0c52ad 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOverrides.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getOverrides.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getOverrides + Retrieve a portal user's vpn accessible subnets. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getParent.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getParent.md index 9fd28bafda..160387f1a5 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getParent.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getParent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getParent + Retrieve a portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPasswordRequirements.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPasswordRequirements.md index 9652866043..04ba28222e 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPasswordRequirements.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPasswordRequirements.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPermissions.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPermissions.md index 411fd5758a..3b3508adca 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPermissions.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPermissions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getPermissions + Retrieve a portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPortalLoginToken.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPortalLoginToken.md index 17455eab63..7f51db249c 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPortalLoginToken.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPortalLoginToken.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getPortalLoginToken + Authenticate a user for the SoftLayer customer portal diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPortalLoginTokenOpenIdConnect.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPortalLoginTokenOpenIdConnect.md index 355afb0c14..f85a9c22ad 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPortalLoginTokenOpenIdConnect.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPortalLoginTokenOpenIdConnect.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getPortalLoginTokenOpenIdConnect +
              Deprecated
              + Authenticate a user for the SoftLayer customer portal via an openIdConnect provider. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPreference.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPreference.md index 5e27a46a84..4d5b0101e4 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPreference.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPreference.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getPreference + Get a preference value for the current user diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPreferenceTypes.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPreferenceTypes.md index 0d0ebca906..e84c49a8e3 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPreferenceTypes.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPreferenceTypes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getPreferenceTypes + Get all available preference types diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPreferences.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPreferences.md index f3b26aa53a..6e3fa1c80f 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPreferences.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getPreferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getPreferences + Retrieve data type contains a single user preference to a specific preference type. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getRequirementsForPasswordSet.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getRequirementsForPasswordSet.md index 97415809cc..3544ef51a3 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getRequirementsForPasswordSet.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getRequirementsForPasswordSet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getRequirementsForPasswordSet + Retrieve the authentication requirements for a user when attempting diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getRoles.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getRoles.md index 462fe302e7..ebc3947479 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getRoles.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getRoles.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSalesforceUserLink.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSalesforceUserLink.md index de6330f229..971c39cb93 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSalesforceUserLink.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSalesforceUserLink.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getSalesforceUserLink + Retrieve [DEPRECATED] diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSecurityAnswers.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSecurityAnswers.md index cb81675bce..eee75a0bdb 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSecurityAnswers.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSecurityAnswers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getSecurityAnswers + Retrieve a portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSubscribers.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSubscribers.md index ec08f402c2..394e7e714c 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSubscribers.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSubscribers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getSubscribers + Retrieve a user's notification subscription records. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSuccessfulLogins.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSuccessfulLogins.md index 344edd2f3c..1b4b1e053a 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSuccessfulLogins.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSuccessfulLogins.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getSuccessfulLogins + Retrieve a user's successful attempts to log into the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportPolicyAcknowledgementRequiredFlag.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportPolicyAcknowledgementRequiredFlag.md index 9d3a3b8e63..413017512d 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportPolicyAcknowledgementRequiredFlag.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportPolicyAcknowledgementRequiredFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getSupportPolicyAcknowledgementRequiredFlag + Retrieve whether or not a user is required to acknowledge the support policy for portal access. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportPolicyDocument.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportPolicyDocument.md index e90b128779..a681045454 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportPolicyDocument.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportPolicyDocument.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportPolicyName.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportPolicyName.md index c8e65d3bc8..47deb5b621 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportPolicyName.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportPolicyName.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportedLocales.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportedLocales.md index 56372eabf4..14aad59043 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportedLocales.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSupportedLocales.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getSupportedLocales + Returns all supported locales for the current user diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSurveyRequiredFlag.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSurveyRequiredFlag.md index f384cdd81d..7d0f068a8e 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSurveyRequiredFlag.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSurveyRequiredFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getSurveyRequiredFlag + Retrieve whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSurveys.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSurveys.md index 2af63507e5..f988b4d36f 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSurveys.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getSurveys.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getSurveys + Retrieve the surveys that a user has taken in the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getTickets.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getTickets.md index 17459c62d8..9b7a13eefb 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getTickets.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getTickets + Retrieve an user's associated tickets. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getTimezone.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getTimezone.md index 1f98168442..96f685a01c 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getTimezone.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getTimezone.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getTimezone + Retrieve a portal user's time zone. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUnsuccessfulLogins.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUnsuccessfulLogins.md index 815f861c59..5d46c80a76 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUnsuccessfulLogins.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUnsuccessfulLogins.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getUnsuccessfulLogins + Retrieve a user's unsuccessful attempts to log into the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserForUnifiedInvitation.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserForUnifiedInvitation.md index b42475bd3b..8b665ed4da 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserForUnifiedInvitation.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserForUnifiedInvitation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getUserForUnifiedInvitation + Get the IMS User Object for the provided OpenIdConnect User ID, or (Optional) IBMid Unique Identifier. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserIdForPasswordSet.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserIdForPasswordSet.md index 9874336c6f..1a0be2666e 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserIdForPasswordSet.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserIdForPasswordSet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getUserIdForPasswordSet + Retrieve a user id using a password request key diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserLinks.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserLinks.md index 7735368b59..df58e139ce 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserLinks.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserLinks.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getUserLinks + Retrieve user customer link with IBMid and IAMid. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserPreferences.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserPreferences.md index 72014c49c8..561a93bef3 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserPreferences.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserPreferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserStatus.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserStatus.md index 893a207fee..f55ffca321 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserStatus.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getUserStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getUserStatus + Retrieve a portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getVirtualGuestCount.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getVirtualGuestCount.md index 04a828b165..45639f7cf0 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getVirtualGuestCount.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getVirtualGuestCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getVirtualGuestCount + Retrieve the current number of CloudLayer Computing Instances a portal user has access to. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getVirtualGuests.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getVirtualGuests.md index bbae0639df..7ea3f9651d 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getVirtualGuests.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/getVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::getVirtualGuests + Retrieve a portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/inTerminalStatus.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/inTerminalStatus.md index f0dc1d171a..6c2cbf5943 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/inTerminalStatus.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/inTerminalStatus.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/initiateExternalAuthentication.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/initiateExternalAuthentication.md index 47da8d49b2..f2dae014a5 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/initiateExternalAuthentication.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/initiateExternalAuthentication.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::initiateExternalAuthentication + Initiates an external authentication using the given authentication container. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/initiatePortalPasswordChange.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/initiatePortalPasswordChange.md index 98e8075e68..1cece18e53 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/initiatePortalPasswordChange.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/initiatePortalPasswordChange.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::initiatePortalPasswordChange + Request email to allow user to change their password diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/initiatePortalPasswordChangeByBrandAgent.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/initiatePortalPasswordChangeByBrandAgent.md index 57e36ff017..435cbd42fa 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/initiatePortalPasswordChangeByBrandAgent.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/initiatePortalPasswordChangeByBrandAgent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::initiatePortalPasswordChangeByBrandAgent + Allows a Brand Agent to request password reset email to be sent to diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/inviteUserToLinkOpenIdConnect.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/inviteUserToLinkOpenIdConnect.md index a3f8d90cc2..54b8f78fe8 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/inviteUserToLinkOpenIdConnect.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/inviteUserToLinkOpenIdConnect.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::inviteUserToLinkOpenIdConnect + Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/isMasterUser.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/isMasterUser.md index cd91e291b6..c0b3930542 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/isMasterUser.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/isMasterUser.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::isMasterUser +
              Deprecated
              + Determine if a portal user is a master user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/isValidPortalPassword.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/isValidPortalPassword.md index 7910242280..4c8295f1cf 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/isValidPortalPassword.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/isValidPortalPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::isValidPortalPassword + Determine if a string is a user's portal password. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/performExternalAuthentication.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/performExternalAuthentication.md index 28b0de941d..02306d7201 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/performExternalAuthentication.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/performExternalAuthentication.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::performExternalAuthentication + Perform an external authentication using the given authentication container. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/processPasswordSetRequest.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/processPasswordSetRequest.md index 6395bc2c64..5509429509 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/processPasswordSetRequest.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/processPasswordSetRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::processPasswordSetRequest + Set the password for a user who has a valid password request key diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeAllDedicatedHostAccessForThisUser.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeAllDedicatedHostAccessForThisUser.md index af209e927f..a57d8cdd92 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeAllDedicatedHostAccessForThisUser.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeAllDedicatedHostAccessForThisUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::removeAllDedicatedHostAccessForThisUser + Revoke access to all dedicated hosts on the account for this user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeAllHardwareAccessForThisUser.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeAllHardwareAccessForThisUser.md index 1238614824..2a2f403ce6 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeAllHardwareAccessForThisUser.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeAllHardwareAccessForThisUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::removeAllHardwareAccessForThisUser + Remove all hardware from a portal user's hardware access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeAllVirtualAccessForThisUser.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeAllVirtualAccessForThisUser.md index 976208555d..f952aedc92 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeAllVirtualAccessForThisUser.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeAllVirtualAccessForThisUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::removeAllVirtualAccessForThisUser + Remove all cloud computing instances from a portal user's instance access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeApiAuthenticationKey.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeApiAuthenticationKey.md index f3f381ea7b..d4913bb48b 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeApiAuthenticationKey.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeApiAuthenticationKey.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::removeApiAuthenticationKey + Remove a user's API authentication key. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkDedicatedHostAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkDedicatedHostAccess.md index 6fb62d3ecf..6de3e060c5 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkDedicatedHostAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkDedicatedHostAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::removeBulkDedicatedHostAccess + Revoke access for the user for one or more dedicated hosts devices. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkHardwareAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkHardwareAccess.md index 2d402e9d66..a95b8cc3d4 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkHardwareAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkHardwareAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::removeBulkHardwareAccess + Remove multiple hardware from a portal user's hardware access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkPortalPermission.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkPortalPermission.md index cf7c8db185..69086bd0c7 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkPortalPermission.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkPortalPermission.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::removeBulkPortalPermission + Remove multiple permissions from a portal user's permission set. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkRoles.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkRoles.md index a487bf72db..ae4db8d87c 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkRoles.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkRoles.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkVirtualGuestAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkVirtualGuestAccess.md index c8a15d2ecc..2c3d4bda12 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkVirtualGuestAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeBulkVirtualGuestAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::removeBulkVirtualGuestAccess + Remove multiple CloudLayer Computing Instances from a portal user's access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeDedicatedHostAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeDedicatedHostAccess.md index f36afe74b2..9f458e5be9 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeDedicatedHostAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeDedicatedHostAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::removeDedicatedHostAccess + Revoke access for the user to a single dedicated hosts device. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeExternalBinding.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeExternalBinding.md index c5c483d307..a9e886241c 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeExternalBinding.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeExternalBinding.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::removeExternalBinding + Remove an external binding from this user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeHardwareAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeHardwareAccess.md index d2c844b980..1e7b3ba65e 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeHardwareAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeHardwareAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::removeHardwareAccess + Remove hardware from a portal user's hardware access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removePortalPermission.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removePortalPermission.md index 8e6ebd4903..b3713e338f 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removePortalPermission.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removePortalPermission.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::removePortalPermission + Remove a permission from a portal user's permission set. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeRole.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeRole.md index 67e939aa6d..a3b18bcf42 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeRole.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeRole.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeSecurityAnswers.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeSecurityAnswers.md index 924f5c0998..fdaab03958 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeSecurityAnswers.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeSecurityAnswers.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeVirtualGuestAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeVirtualGuestAccess.md index 36e924a39e..69718dd00c 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeVirtualGuestAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/removeVirtualGuestAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::removeVirtualGuestAccess + Remove a CloudLayer Computing Instance from a portal user's access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/resetOpenIdConnectLink.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/resetOpenIdConnectLink.md index e64a41e7b5..92cf7718f7 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/resetOpenIdConnectLink.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/resetOpenIdConnectLink.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::resetOpenIdConnectLink + Change the link of a user for OpenIdConnect managed accounts, provided the diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/resetOpenIdConnectLinkUnifiedUserManagementMode.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/resetOpenIdConnectLinkUnifiedUserManagementMode.md index 13df1a13ae..0b9a4a8691 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/resetOpenIdConnectLinkUnifiedUserManagementMode.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/resetOpenIdConnectLinkUnifiedUserManagementMode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::resetOpenIdConnectLinkUnifiedUserManagementMode + Change the link of a master user for OpenIdConnect managed accounts, diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlAuthenticate.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlAuthenticate.md index e55037a796..5127f781bc 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlAuthenticate.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlAuthenticate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlBeginAuthentication.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlBeginAuthentication.md index a9709b9b04..b8e245e971 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlBeginAuthentication.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlBeginAuthentication.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlBeginLogout.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlBeginLogout.md index f46cbe71a5..294ed65763 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlBeginLogout.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlBeginLogout.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlLogout.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlLogout.md index 910501b07b..47624492ce 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlLogout.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/samlLogout.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/selfPasswordChange.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/selfPasswordChange.md index c2175ffbae..b857355970 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/selfPasswordChange.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/selfPasswordChange.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/setDefaultAccount.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/setDefaultAccount.md index 457d04ceb8..f74d57aa51 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/setDefaultAccount.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/setDefaultAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::setDefaultAccount + Sets the default account for the OpenIdConnect identity that is linked to the current SoftLayer user identity. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/silentlyMigrateUserOpenIdConnect.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/silentlyMigrateUserOpenIdConnect.md index bcc0e84859..fd27b99e97 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/silentlyMigrateUserOpenIdConnect.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/silentlyMigrateUserOpenIdConnect.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::silentlyMigrateUserOpenIdConnect + This api is used to migrate a user to IBMid without sending an invitation. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateNotificationSubscriber.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateNotificationSubscriber.md index d096d225ca..478481ee75 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateNotificationSubscriber.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateNotificationSubscriber.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::updateNotificationSubscriber + Update the active status for a notification subscription. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateSecurityAnswers.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateSecurityAnswers.md index 354d0c0cc0..8a3eee0037 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateSecurityAnswers.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateSecurityAnswers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::updateSecurityAnswers + Update portal login security questions and answers. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateSubscriberDeliveryMethod.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateSubscriberDeliveryMethod.md index 8c8be3514f..d630ac1067 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateSubscriberDeliveryMethod.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateSubscriberDeliveryMethod.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::updateSubscriberDeliveryMethod + Update a delivery method for the subscriber. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateVpnPassword.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateVpnPassword.md index ac7fb49f22..83f0deeb24 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateVpnPassword.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateVpnPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::updateVpnPassword + Update a user's VPN password diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateVpnUser.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateVpnUser.md index 825e763fee..a4be6b8258 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateVpnUser.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/updateVpnUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect)::updateVpnUser + Creates or updates a user's VPN access privileges. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/validateAuthenticationToken.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/validateAuthenticationToken.md index 98cfa58409..fdcab44b55 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/validateAuthenticationToken.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect/validateAuthenticationToken.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/_index.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/_index.md index 79bfa089e6..05a572a0c5 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,816 +44,958 @@ classes: #### [acknowledgeSupportPolicy](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/acknowledgeSupportPolicy) +
              #### [activateOpenIdConnectUser](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/activateOpenIdConnectUser) Completes invitation process for an OIDC user initiated by the +
              #### [addApiAuthenticationKey](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addApiAuthenticationKey) Create a user's API authentication key. +
              #### [addBulkDedicatedHostAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkDedicatedHostAccess) Grant access to the user for one or more dedicated hosts devices. +
              #### [addBulkHardwareAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkHardwareAccess) Add multiple hardware to a portal user's hardware access list. +
              #### [addBulkPortalPermission](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkPortalPermission) Add multiple permissions to a portal user's permission set. +
              #### [addBulkRoles](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkRoles) +
              #### [addBulkVirtualGuestAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkVirtualGuestAccess) Add multiple CloudLayer Computing Instances to a portal user's access list. +
              #### [addDedicatedHostAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addDedicatedHostAccess) Grant access to the user for a single dedicated host device. +
              #### [addExternalBinding](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addExternalBinding) +
              #### [addHardwareAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addHardwareAccess) Add hardware to a portal user's hardware access list. +
              #### [addNotificationSubscriber](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addNotificationSubscriber) Create a notification subscription record for the user. +
              #### [addPortalPermission](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addPortalPermission) Add a permission to a portal user's permission set. +
              #### [addRole](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addRole) +
              #### [addVirtualGuestAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addVirtualGuestAccess) Add a CloudLayer Computing Instance to a portal user's access list. +
              #### [assignNewParentId](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/assignNewParentId) Assign a different parent to this user. +
              #### [changePreference](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/changePreference) Change preference values for the current user +
              #### [checkExternalAuthenticationStatus](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/checkExternalAuthenticationStatus) Checks if an external authentication is complete or not +
              #### [checkPhoneFactorAuthenticationForPasswordSet](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/checkPhoneFactorAuthenticationForPasswordSet) Check the status of an outstanding Phone Factor Authentication for Password Set +
              #### [completeInvitationAfterLogin](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/completeInvitationAfterLogin) Completes invitation processing after logging on an existing OpenIdConnect user identity and return an access token +
              #### [createNotificationSubscriber](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createNotificationSubscriber) Create a new subscriber for a given resource. +
              #### [createObject](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createObject) +
              #### [createOpenIdConnectUserAndCompleteInvitation](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createOpenIdConnectUserAndCompleteInvitation) Completes invitation processing when a new OpenIdConnect user must be created. +
              #### [createSubscriberDeliveryMethods](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createSubscriberDeliveryMethods) Create delivery methods for the subscriber. +
              #### [deactivateNotificationSubscriber](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/deactivateNotificationSubscriber) Delete a subscriber for a given resource. +
              #### [declineInvitation](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/declineInvitation) Sets a customer invitation as declined. +
              #### [editObject](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/editObject) Update a user's information. +
              #### [editObjects](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/editObjects) Update a collection of users' information +
              #### [findUserPreference](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/findUserPreference) +
              #### [getAccount](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAccount) Retrieve the customer account that a user belongs to. +
              #### [getActions](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getActions) +
              #### [getActiveExternalAuthenticationVendors](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getActiveExternalAuthenticationVendors) Get a list of active external authentication vendors for a SoftLayer user. +
              #### [getAdditionalEmails](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAdditionalEmails) Retrieve a portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets. +
              #### [getAgentImpersonationToken](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAgentImpersonationToken) +
              #### [getAllowedDedicatedHostIds](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAllowedDedicatedHostIds) +
              #### [getAllowedHardwareIds](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAllowedHardwareIds) +
              #### [getAllowedVirtualGuestIds](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAllowedVirtualGuestIds) +
              #### [getApiAuthenticationKeys](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getApiAuthenticationKeys) Retrieve a portal user's API Authentication keys. There is a max limit of one API key per user. +
              #### [getAuthenticationToken](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAuthenticationToken) +
              #### [getChildUsers](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getChildUsers) Retrieve a portal user's child users. Some portal users may not have child users. +
              #### [getClosedTickets](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getClosedTickets) Retrieve an user's associated closed tickets. +
              #### [getDedicatedHosts](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getDedicatedHosts) Retrieve the dedicated hosts to which the user has been granted access. +
              #### [getDefaultAccount](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getDefaultAccount) Retrieve the default account for the OpenIdConnect identity that is linked to the current active SoftLayer user identity. +
              #### [getExternalBindings](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getExternalBindings) Retrieve the external authentication bindings that link an external identifier to a SoftLayer user. +
              #### [getHardware](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHardware) Retrieve a portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal. +
              #### [getHardwareCount](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHardwareCount) Retrieve the current number of servers a portal user has access to. +
              #### [getHardwareNotifications](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHardwareNotifications) Retrieve hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'. +
              #### [getHasAcknowledgedSupportPolicyFlag](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasAcknowledgedSupportPolicyFlag) Retrieve whether or not a user has acknowledged the support policy. +
              #### [getHasFullDedicatedHostAccessFlag](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasFullDedicatedHostAccessFlag) Retrieve permission granting the user access to all Dedicated Host devices on the account. +
              #### [getHasFullHardwareAccessFlag](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasFullHardwareAccessFlag) Retrieve whether or not a portal user has access to all hardware on their account. +
              #### [getHasFullVirtualGuestAccessFlag](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasFullVirtualGuestAccessFlag) Retrieve whether or not a portal user has access to all virtual guests on their account. +
              #### [getIbmIdLink](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getIbmIdLink) Retrieve specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link. +
              #### [getImpersonationToken](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getImpersonationToken) +
              #### [getLayoutProfiles](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLayoutProfiles) Retrieve contains the definition of the layout profile. +
              #### [getLocale](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLocale) Retrieve a user's locale. Locale holds user's language and region information. +
              #### [getLoginAccountInfoOpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginAccountInfoOpenIdConnect) Get account for an active user logging into the SoftLayer customer portal +
              #### [getLoginAttempts](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginAttempts) Retrieve a user's attempts to log into the SoftLayer customer portal. +
              #### [getLoginToken](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginToken) Authenticate a user for the SoftLayer customer portal +
              #### [getMappedAccounts](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getMappedAccounts) Retrieve a list of all active accounts that belong to this customer. +
              #### [getMobileDevices](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getMobileDevices) Retrieve a portal user's associated mobile device profiles. +
              #### [getNotificationSubscribers](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getNotificationSubscribers) Retrieve notification subscription records for the user. +
              #### [getObject](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getObject) Retrieve a SoftLayer_User_Customer_OpenIdConnect_TrustedProfile record. +
              #### [getOpenIdConnectMigrationState](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenIdConnectMigrationState) Get the OpenId migration state +
              #### [getOpenIdRegistrationInfoFromCode](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenIdRegistrationInfoFromCode) Get OpenId User Registration details from the provided email code +
              #### [getOpenTickets](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenTickets) Retrieve an user's associated open tickets. +
              #### [getOverrides](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOverrides) Retrieve a portal user's vpn accessible subnets. +
              #### [getParent](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getParent) Retrieve a portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user. +
              #### [getPasswordRequirements](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPasswordRequirements) +
              #### [getPermissions](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPermissions) Retrieve a portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API. +
              #### [getPortalLoginToken](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPortalLoginToken) Authenticate a user for the SoftLayer customer portal +
              -
              +
              #### [getPortalLoginTokenOpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPortalLoginTokenOpenIdConnect) Authenticate a user for the SoftLayer customer portal via an openIdConnect provider. + +Deprecated + +
              #### [getPreference](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPreference) Get a preference value for the current user +
              #### [getPreferenceTypes](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPreferenceTypes) Get all available preference types +
              #### [getPreferences](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPreferences) Retrieve data type contains a single user preference to a specific preference type. +
              #### [getRequirementsForPasswordSet](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getRequirementsForPasswordSet) Retrieve the authentication requirements for a user when attempting +
              #### [getRoles](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getRoles) +
              #### [getSalesforceUserLink](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSalesforceUserLink) Retrieve [DEPRECATED] +
              #### [getSecurityAnswers](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSecurityAnswers) Retrieve a portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login. +
              #### [getSubscribers](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSubscribers) Retrieve a user's notification subscription records. +
              #### [getSuccessfulLogins](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSuccessfulLogins) Retrieve a user's successful attempts to log into the SoftLayer customer portal. +
              #### [getSupportPolicyAcknowledgementRequiredFlag](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportPolicyAcknowledgementRequiredFlag) Retrieve whether or not a user is required to acknowledge the support policy for portal access. +
              #### [getSupportPolicyDocument](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportPolicyDocument) +
              #### [getSupportPolicyName](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportPolicyName) +
              #### [getSupportedLocales](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportedLocales) Returns all supported locales for the current user +
              #### [getSurveyRequiredFlag](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSurveyRequiredFlag) Retrieve whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal. +
              #### [getSurveys](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSurveys) Retrieve the surveys that a user has taken in the SoftLayer customer portal. +
              #### [getTickets](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getTickets) Retrieve an user's associated tickets. +
              #### [getTimezone](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getTimezone) Retrieve a portal user's time zone. +
              #### [getUnsuccessfulLogins](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUnsuccessfulLogins) Retrieve a user's unsuccessful attempts to log into the SoftLayer customer portal. +
              #### [getUserForUnifiedInvitation](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserForUnifiedInvitation) Get the IMS User Object for the provided OpenIdConnect User ID, or (Optional) IBMid Unique Identifier. +
              #### [getUserIdForPasswordSet](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserIdForPasswordSet) Retrieve a user id using a password request key +
              #### [getUserLinks](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserLinks) Retrieve user customer link with IBMid and IAMid. +
              #### [getUserPreferences](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserPreferences) +
              #### [getUserStatus](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserStatus) Retrieve a portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network. +
              #### [getVirtualGuestCount](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getVirtualGuestCount) Retrieve the current number of CloudLayer Computing Instances a portal user has access to. +
              #### [getVirtualGuests](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getVirtualGuests) Retrieve a portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal. +
              #### [inTerminalStatus](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/inTerminalStatus) +
              #### [initiateExternalAuthentication](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/initiateExternalAuthentication) Initiates an external authentication using the given authentication container. +
              #### [initiatePortalPasswordChange](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/initiatePortalPasswordChange) Request email to allow user to change their password +
              #### [initiatePortalPasswordChangeByBrandAgent](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/initiatePortalPasswordChangeByBrandAgent) Allows a Brand Agent to request password reset email to be sent to +
              #### [inviteUserToLinkOpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/inviteUserToLinkOpenIdConnect) Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect. +
              -
              +
              #### [isMasterUser](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/isMasterUser) Determine if a portal user is a master user. + +Deprecated + +
              #### [isValidPortalPassword](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/isValidPortalPassword) Determine if a string is a user's portal password. +
              #### [performExternalAuthentication](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/performExternalAuthentication) Perform an external authentication using the given authentication container. +
              #### [processPasswordSetRequest](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/processPasswordSetRequest) Set the password for a user who has a valid password request key +
              #### [removeAllDedicatedHostAccessForThisUser](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeAllDedicatedHostAccessForThisUser) Revoke access to all dedicated hosts on the account for this user. +
              #### [removeAllHardwareAccessForThisUser](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeAllHardwareAccessForThisUser) Remove all hardware from a portal user's hardware access list. +
              #### [removeAllVirtualAccessForThisUser](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeAllVirtualAccessForThisUser) Remove all cloud computing instances from a portal user's instance access list. +
              #### [removeApiAuthenticationKey](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeApiAuthenticationKey) Remove a user's API authentication key. +
              #### [removeBulkDedicatedHostAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkDedicatedHostAccess) Revoke access for the user for one or more dedicated hosts devices. +
              #### [removeBulkHardwareAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkHardwareAccess) Remove multiple hardware from a portal user's hardware access list. +
              #### [removeBulkPortalPermission](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkPortalPermission) Remove multiple permissions from a portal user's permission set. +
              #### [removeBulkRoles](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkRoles) +
              #### [removeBulkVirtualGuestAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkVirtualGuestAccess) Remove multiple CloudLayer Computing Instances from a portal user's access list. +
              #### [removeDedicatedHostAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeDedicatedHostAccess) Revoke access for the user to a single dedicated hosts device. +
              #### [removeExternalBinding](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeExternalBinding) Remove an external binding from this user. +
              #### [removeHardwareAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeHardwareAccess) Remove hardware from a portal user's hardware access list. +
              #### [removePortalPermission](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removePortalPermission) Remove a permission from a portal user's permission set. +
              #### [removeRole](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeRole) +
              #### [removeSecurityAnswers](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeSecurityAnswers) +
              #### [removeVirtualGuestAccess](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeVirtualGuestAccess) Remove a CloudLayer Computing Instance from a portal user's access list. +
              #### [resetOpenIdConnectLink](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/resetOpenIdConnectLink) Change the link of a user for OpenIdConnect managed accounts, provided the +
              #### [resetOpenIdConnectLinkUnifiedUserManagementMode](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/resetOpenIdConnectLinkUnifiedUserManagementMode) Change the link of a master user for OpenIdConnect managed accounts, +
              #### [samlAuthenticate](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlAuthenticate) +
              #### [samlBeginAuthentication](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlBeginAuthentication) +
              #### [samlBeginLogout](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlBeginLogout) +
              #### [samlLogout](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlLogout) +
              #### [selfPasswordChange](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/selfPasswordChange) +
              #### [setDefaultAccount](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/setDefaultAccount) Sets the default account for the OpenIdConnect identity that is linked to the current SoftLayer user identity. +
              #### [silentlyMigrateUserOpenIdConnect](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/silentlyMigrateUserOpenIdConnect) This api is used to migrate a user to IBMid without sending an invitation. +
              #### [updateNotificationSubscriber](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateNotificationSubscriber) Update the active status for a notification subscription. +
              #### [updateSecurityAnswers](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateSecurityAnswers) Update portal login security questions and answers. +
              #### [updateSubscriberDeliveryMethod](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateSubscriberDeliveryMethod) Update a delivery method for the subscriber. +
              #### [updateVpnPassword](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateVpnPassword) Update a user's VPN password +
              #### [updateVpnUser](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateVpnUser) Creates or updates a user's VPN access privileges. +
              #### [validateAuthenticationToken](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/validateAuthenticationToken) +
              diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/acknowledgeSupportPolicy.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/acknowledgeSupportPolicy.md index 0ca87dfd8b..4cda3c6afe 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/acknowledgeSupportPolicy.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/acknowledgeSupportPolicy.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/activateOpenIdConnectUser.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/activateOpenIdConnectUser.md index e32836c402..224cce831a 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/activateOpenIdConnectUser.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/activateOpenIdConnectUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::activateOpenIdConnectUser + Completes invitation process for an OIDC user initiated by the diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addApiAuthenticationKey.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addApiAuthenticationKey.md index f394f38ba8..49196ef04a 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addApiAuthenticationKey.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addApiAuthenticationKey.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::addApiAuthenticationKey + Create a user's API authentication key. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkDedicatedHostAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkDedicatedHostAccess.md index c390d42e4d..86e0bd588e 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkDedicatedHostAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkDedicatedHostAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::addBulkDedicatedHostAccess + Grant access to the user for one or more dedicated hosts devices. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkHardwareAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkHardwareAccess.md index 01356cb9fb..39f73763a9 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkHardwareAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkHardwareAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::addBulkHardwareAccess + Add multiple hardware to a portal user's hardware access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkPortalPermission.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkPortalPermission.md index 97205dcbe2..7b6a303fac 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkPortalPermission.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkPortalPermission.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::addBulkPortalPermission + Add multiple permissions to a portal user's permission set. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkRoles.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkRoles.md index 88a4a8139b..e91468c391 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkRoles.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkRoles.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkVirtualGuestAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkVirtualGuestAccess.md index eeaa3897a4..11a1939558 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkVirtualGuestAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addBulkVirtualGuestAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::addBulkVirtualGuestAccess + Add multiple CloudLayer Computing Instances to a portal user's access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addDedicatedHostAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addDedicatedHostAccess.md index ccc4f0a258..8537044241 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addDedicatedHostAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addDedicatedHostAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::addDedicatedHostAccess + Grant access to the user for a single dedicated host device. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addExternalBinding.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addExternalBinding.md index 6a4a4c8cb1..bb02fcae42 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addExternalBinding.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addExternalBinding.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addHardwareAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addHardwareAccess.md index 940c80afeb..8f3ff2d569 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addHardwareAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addHardwareAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::addHardwareAccess + Add hardware to a portal user's hardware access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addNotificationSubscriber.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addNotificationSubscriber.md index 4e3d12f801..54dba82d0b 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addNotificationSubscriber.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addNotificationSubscriber.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::addNotificationSubscriber + Create a notification subscription record for the user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addPortalPermission.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addPortalPermission.md index d9a3d5cab4..9060031952 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addPortalPermission.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addPortalPermission.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::addPortalPermission + Add a permission to a portal user's permission set. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addRole.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addRole.md index c671515aca..c18aa35867 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addRole.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addRole.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addVirtualGuestAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addVirtualGuestAccess.md index 9eafcf029c..ab02ad7a09 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addVirtualGuestAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/addVirtualGuestAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::addVirtualGuestAccess + Add a CloudLayer Computing Instance to a portal user's access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/assignNewParentId.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/assignNewParentId.md index e0f358d254..73e8ee31f0 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/assignNewParentId.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/assignNewParentId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::assignNewParentId + Assign a different parent to this user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/changePreference.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/changePreference.md index cf496c8717..492f35f620 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/changePreference.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/changePreference.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::changePreference + Change preference values for the current user diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/checkExternalAuthenticationStatus.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/checkExternalAuthenticationStatus.md index 363a54f7e2..26e7d33319 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/checkExternalAuthenticationStatus.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/checkExternalAuthenticationStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::checkExternalAuthenticationStatus + Checks if an external authentication is complete or not diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/checkPhoneFactorAuthenticationForPasswordSet.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/checkPhoneFactorAuthenticationForPasswordSet.md index 30c971a306..db45a66898 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/checkPhoneFactorAuthenticationForPasswordSet.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/checkPhoneFactorAuthenticationForPasswordSet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::checkPhoneFactorAuthenticationForPasswordSet + Check the status of an outstanding Phone Factor Authentication for Password Set diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/completeInvitationAfterLogin.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/completeInvitationAfterLogin.md index 8c17238d9f..2abe562932 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/completeInvitationAfterLogin.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/completeInvitationAfterLogin.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::completeInvitationAfterLogin + Completes invitation processing after logging on an existing OpenIdConnect user identity and return an access token diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createNotificationSubscriber.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createNotificationSubscriber.md index e9305b8ee1..cb9c1d3a3a 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createNotificationSubscriber.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createNotificationSubscriber.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::createNotificationSubscriber + Create a new subscriber for a given resource. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createObject.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createObject.md index 1e81f0bcb9..20273f5a34 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createObject.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createOpenIdConnectUserAndCompleteInvitation.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createOpenIdConnectUserAndCompleteInvitation.md index 47841299bc..8121bc9eb2 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createOpenIdConnectUserAndCompleteInvitation.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createOpenIdConnectUserAndCompleteInvitation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::createOpenIdConnectUserAndCompleteInvitation + Completes invitation processing when a new OpenIdConnect user must be created. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createSubscriberDeliveryMethods.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createSubscriberDeliveryMethods.md index b9b9ddc55a..efa785bc13 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createSubscriberDeliveryMethods.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/createSubscriberDeliveryMethods.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::createSubscriberDeliveryMethods + Create delivery methods for the subscriber. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/deactivateNotificationSubscriber.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/deactivateNotificationSubscriber.md index d660fbd1a2..168c4c29ba 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/deactivateNotificationSubscriber.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/deactivateNotificationSubscriber.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::deactivateNotificationSubscriber + Delete a subscriber for a given resource. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/declineInvitation.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/declineInvitation.md index 87dcbe7868..ff4fbfd6a5 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/declineInvitation.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/declineInvitation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::declineInvitation + Sets a customer invitation as declined. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/editObject.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/editObject.md index 5e28eacc00..2a09ab981c 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/editObject.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::editObject + Update a user's information. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/editObjects.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/editObjects.md index 4d9425efc2..15c2761c6d 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/editObjects.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/editObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::editObjects + Update a collection of users' information diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/findUserPreference.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/findUserPreference.md index ef786580fe..3296e63998 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/findUserPreference.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/findUserPreference.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAccount.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAccount.md index 4fe1083d4a..e11fd0d6ce 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAccount.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getAccount + Retrieve the customer account that a user belongs to. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getActions.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getActions.md index 5e137404aa..486da40f63 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getActions.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getActions.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getActiveExternalAuthenticationVendors.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getActiveExternalAuthenticationVendors.md index 93317b6be6..f7b731b02c 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getActiveExternalAuthenticationVendors.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getActiveExternalAuthenticationVendors.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getActiveExternalAuthenticationVendors + Get a list of active external authentication vendors for a SoftLayer user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAdditionalEmails.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAdditionalEmails.md index 74980d2cbf..3232227df4 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAdditionalEmails.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAdditionalEmails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getAdditionalEmails + Retrieve a portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAgentImpersonationToken.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAgentImpersonationToken.md index e4b81627ad..020a920925 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAgentImpersonationToken.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAgentImpersonationToken.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAllowedDedicatedHostIds.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAllowedDedicatedHostIds.md index f8fbe3aa6c..b718e88c83 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAllowedDedicatedHostIds.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAllowedDedicatedHostIds.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAllowedHardwareIds.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAllowedHardwareIds.md index 584c8ecde8..c58e67fd0d 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAllowedHardwareIds.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAllowedHardwareIds.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAllowedVirtualGuestIds.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAllowedVirtualGuestIds.md index d3816f1cbb..199f7b0c2f 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAllowedVirtualGuestIds.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAllowedVirtualGuestIds.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getApiAuthenticationKeys.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getApiAuthenticationKeys.md index dda11c5bd0..09754a42bc 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getApiAuthenticationKeys.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getApiAuthenticationKeys.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getApiAuthenticationKeys + Retrieve a portal user's API Authentication keys. There is a max limit of one API key per user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAuthenticationToken.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAuthenticationToken.md index b9b5cbad34..4138d373f5 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAuthenticationToken.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getAuthenticationToken.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getChildUsers.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getChildUsers.md index 12a526178f..b1a5d7875f 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getChildUsers.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getChildUsers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getChildUsers + Retrieve a portal user's child users. Some portal users may not have child users. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getClosedTickets.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getClosedTickets.md index e682216df5..c7731cb81c 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getClosedTickets.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getClosedTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getClosedTickets + Retrieve an user's associated closed tickets. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getDedicatedHosts.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getDedicatedHosts.md index ab78cf27dc..d664009a66 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getDedicatedHosts.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getDedicatedHosts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getDedicatedHosts + Retrieve the dedicated hosts to which the user has been granted access. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getDefaultAccount.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getDefaultAccount.md index 8d9c7ceadc..4438d3235d 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getDefaultAccount.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getDefaultAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getDefaultAccount + Retrieve the default account for the OpenIdConnect identity that is linked to the current active SoftLayer user identity. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getExternalBindings.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getExternalBindings.md index 35715e8717..576fcc3cec 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getExternalBindings.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getExternalBindings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getExternalBindings + Retrieve the external authentication bindings that link an external identifier to a SoftLayer user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHardware.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHardware.md index df318598fc..128479fd13 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHardware.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getHardware + Retrieve a portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHardwareCount.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHardwareCount.md index 401a42eac0..810acff64a 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHardwareCount.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHardwareCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getHardwareCount + Retrieve the current number of servers a portal user has access to. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHardwareNotifications.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHardwareNotifications.md index d9aba12b2b..bf77383de6 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHardwareNotifications.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHardwareNotifications.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getHardwareNotifications + Retrieve hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasAcknowledgedSupportPolicyFlag.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasAcknowledgedSupportPolicyFlag.md index e21831d303..5241177f27 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasAcknowledgedSupportPolicyFlag.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasAcknowledgedSupportPolicyFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getHasAcknowledgedSupportPolicyFlag + Retrieve whether or not a user has acknowledged the support policy. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasFullDedicatedHostAccessFlag.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasFullDedicatedHostAccessFlag.md index 80f5e95a06..fff03d0f12 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasFullDedicatedHostAccessFlag.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasFullDedicatedHostAccessFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getHasFullDedicatedHostAccessFlag + Retrieve permission granting the user access to all Dedicated Host devices on the account. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasFullHardwareAccessFlag.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasFullHardwareAccessFlag.md index c215d4a0dd..f1c7a55b60 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasFullHardwareAccessFlag.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasFullHardwareAccessFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getHasFullHardwareAccessFlag + Retrieve whether or not a portal user has access to all hardware on their account. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasFullVirtualGuestAccessFlag.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasFullVirtualGuestAccessFlag.md index 6c535ea20b..276394d65c 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasFullVirtualGuestAccessFlag.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getHasFullVirtualGuestAccessFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getHasFullVirtualGuestAccessFlag + Retrieve whether or not a portal user has access to all virtual guests on their account. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getIbmIdLink.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getIbmIdLink.md index 292a5c7012..77626fe182 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getIbmIdLink.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getIbmIdLink.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getIbmIdLink + Retrieve specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getImpersonationToken.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getImpersonationToken.md index 7ca290c04c..1c259af368 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getImpersonationToken.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getImpersonationToken.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLayoutProfiles.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLayoutProfiles.md index 0c6d088460..eecacc576a 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLayoutProfiles.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLayoutProfiles.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getLayoutProfiles + Retrieve contains the definition of the layout profile. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLocale.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLocale.md index 0f7f438212..4c0335e197 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLocale.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLocale.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getLocale + Retrieve a user's locale. Locale holds user's language and region information. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginAccountInfoOpenIdConnect.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginAccountInfoOpenIdConnect.md index 4a47bc7aa2..c0ed616507 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginAccountInfoOpenIdConnect.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginAccountInfoOpenIdConnect.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getLoginAccountInfoOpenIdConnect + Get account for an active user logging into the SoftLayer customer portal diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginAttempts.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginAttempts.md index e12b7aab97..d027ca2941 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginAttempts.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginAttempts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getLoginAttempts + Retrieve a user's attempts to log into the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginToken.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginToken.md index 6c8de6f046..eae0b3314f 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginToken.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getLoginToken.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getLoginToken + Authenticate a user for the SoftLayer customer portal diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getMappedAccounts.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getMappedAccounts.md index e179a19780..2cd3da6220 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getMappedAccounts.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getMappedAccounts.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getMappedAccounts + Retrieve a list of all active accounts that belong to this customer. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getMobileDevices.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getMobileDevices.md index 042c790ce4..2097fe0bce 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getMobileDevices.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getMobileDevices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getMobileDevices + Retrieve a portal user's associated mobile device profiles. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getNotificationSubscribers.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getNotificationSubscribers.md index e2fbbca0dc..52e1690bac 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getNotificationSubscribers.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getNotificationSubscribers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getNotificationSubscribers + Retrieve notification subscription records for the user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getObject.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getObject.md index 42d2b12876..fe25c8ec2b 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getObject + Retrieve a SoftLayer_User_Customer_OpenIdConnect_TrustedProfile record. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenIdConnectMigrationState.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenIdConnectMigrationState.md index 0c2d780938..18a405b5dc 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenIdConnectMigrationState.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenIdConnectMigrationState.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getOpenIdConnectMigrationState + Get the OpenId migration state diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenIdRegistrationInfoFromCode.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenIdRegistrationInfoFromCode.md index fa4cc8ca3b..35ce10088b 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenIdRegistrationInfoFromCode.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenIdRegistrationInfoFromCode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getOpenIdRegistrationInfoFromCode + Get OpenId User Registration details from the provided email code diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenTickets.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenTickets.md index 62b40cffbb..e042567339 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenTickets.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOpenTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getOpenTickets + Retrieve an user's associated open tickets. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOverrides.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOverrides.md index 11f3bf469f..ad7aab1560 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOverrides.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getOverrides.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getOverrides + Retrieve a portal user's vpn accessible subnets. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getParent.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getParent.md index 9a4d3094b9..07d521a612 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getParent.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getParent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getParent + Retrieve a portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPasswordRequirements.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPasswordRequirements.md index c0caa5a6da..5d8ac75806 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPasswordRequirements.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPasswordRequirements.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPermissions.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPermissions.md index 4e533c8d7b..50639c4c2d 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPermissions.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPermissions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getPermissions + Retrieve a portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPortalLoginToken.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPortalLoginToken.md index 9955e6ef55..857cf7d484 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPortalLoginToken.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPortalLoginToken.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getPortalLoginToken + Authenticate a user for the SoftLayer customer portal diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPortalLoginTokenOpenIdConnect.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPortalLoginTokenOpenIdConnect.md index 85c6933a9b..ddcee04380 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPortalLoginTokenOpenIdConnect.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPortalLoginTokenOpenIdConnect.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getPortalLoginTokenOpenIdConnect +
              Deprecated
              + Authenticate a user for the SoftLayer customer portal via an openIdConnect provider. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPreference.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPreference.md index 64ca847514..8b6283ce91 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPreference.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPreference.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getPreference + Get a preference value for the current user diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPreferenceTypes.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPreferenceTypes.md index aabac65497..29f3d3e815 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPreferenceTypes.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPreferenceTypes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getPreferenceTypes + Get all available preference types diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPreferences.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPreferences.md index 7f9aa42a92..f46c0a85aa 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPreferences.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getPreferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getPreferences + Retrieve data type contains a single user preference to a specific preference type. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getRequirementsForPasswordSet.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getRequirementsForPasswordSet.md index 822a60adb8..07f9747b92 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getRequirementsForPasswordSet.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getRequirementsForPasswordSet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getRequirementsForPasswordSet + Retrieve the authentication requirements for a user when attempting diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getRoles.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getRoles.md index f473692de1..44f59c9d49 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getRoles.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getRoles.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSalesforceUserLink.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSalesforceUserLink.md index f9dff24c0e..f304b63b37 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSalesforceUserLink.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSalesforceUserLink.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getSalesforceUserLink + Retrieve [DEPRECATED] diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSecurityAnswers.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSecurityAnswers.md index 2696ef9bba..025bc7a733 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSecurityAnswers.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSecurityAnswers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getSecurityAnswers + Retrieve a portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSubscribers.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSubscribers.md index 7f54ecdbb3..c098d4a2e6 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSubscribers.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSubscribers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getSubscribers + Retrieve a user's notification subscription records. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSuccessfulLogins.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSuccessfulLogins.md index 9dfc5d356d..420b7f5053 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSuccessfulLogins.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSuccessfulLogins.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getSuccessfulLogins + Retrieve a user's successful attempts to log into the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportPolicyAcknowledgementRequiredFlag.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportPolicyAcknowledgementRequiredFlag.md index 71ee037f88..96198bbb45 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportPolicyAcknowledgementRequiredFlag.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportPolicyAcknowledgementRequiredFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getSupportPolicyAcknowledgementRequiredFlag + Retrieve whether or not a user is required to acknowledge the support policy for portal access. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportPolicyDocument.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportPolicyDocument.md index b0e4b234b4..54bd291033 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportPolicyDocument.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportPolicyDocument.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportPolicyName.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportPolicyName.md index 29d3be147a..f563c0bbe0 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportPolicyName.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportPolicyName.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportedLocales.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportedLocales.md index 2507713115..1ff695d519 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportedLocales.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSupportedLocales.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getSupportedLocales + Returns all supported locales for the current user diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSurveyRequiredFlag.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSurveyRequiredFlag.md index 8c98bfbf4b..431f7bfda0 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSurveyRequiredFlag.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSurveyRequiredFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getSurveyRequiredFlag + Retrieve whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSurveys.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSurveys.md index 771b5710ae..b634979cb9 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSurveys.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getSurveys.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getSurveys + Retrieve the surveys that a user has taken in the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getTickets.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getTickets.md index bdabed2b06..38554bafbc 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getTickets.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getTickets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getTickets + Retrieve an user's associated tickets. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getTimezone.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getTimezone.md index a7f5e7253f..3d44746d47 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getTimezone.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getTimezone.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getTimezone + Retrieve a portal user's time zone. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUnsuccessfulLogins.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUnsuccessfulLogins.md index d64213c542..23a3281efd 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUnsuccessfulLogins.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUnsuccessfulLogins.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getUnsuccessfulLogins + Retrieve a user's unsuccessful attempts to log into the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserForUnifiedInvitation.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserForUnifiedInvitation.md index b8c0ae878d..9ebe9e6564 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserForUnifiedInvitation.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserForUnifiedInvitation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getUserForUnifiedInvitation + Get the IMS User Object for the provided OpenIdConnect User ID, or (Optional) IBMid Unique Identifier. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserIdForPasswordSet.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserIdForPasswordSet.md index 998863a912..f6511ef085 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserIdForPasswordSet.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserIdForPasswordSet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getUserIdForPasswordSet + Retrieve a user id using a password request key diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserLinks.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserLinks.md index 9b10441b31..e04a7180af 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserLinks.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserLinks.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getUserLinks + Retrieve user customer link with IBMid and IAMid. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserPreferences.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserPreferences.md index 6ec2b10521..f8c42f99e5 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserPreferences.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserPreferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserStatus.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserStatus.md index f71e49ab8d..aa06437f7d 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserStatus.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getUserStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getUserStatus + Retrieve a portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getVirtualGuestCount.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getVirtualGuestCount.md index f08ee46ece..4405463a13 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getVirtualGuestCount.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getVirtualGuestCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getVirtualGuestCount + Retrieve the current number of CloudLayer Computing Instances a portal user has access to. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getVirtualGuests.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getVirtualGuests.md index 3c177e5789..d11143cc1b 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getVirtualGuests.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/getVirtualGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::getVirtualGuests + Retrieve a portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/inTerminalStatus.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/inTerminalStatus.md index 8f03987424..799a60980d 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/inTerminalStatus.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/inTerminalStatus.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/initiateExternalAuthentication.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/initiateExternalAuthentication.md index 7799183e15..1a1933a915 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/initiateExternalAuthentication.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/initiateExternalAuthentication.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::initiateExternalAuthentication + Initiates an external authentication using the given authentication container. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/initiatePortalPasswordChange.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/initiatePortalPasswordChange.md index 9192731b4b..6bdbd1ede7 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/initiatePortalPasswordChange.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/initiatePortalPasswordChange.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::initiatePortalPasswordChange + Request email to allow user to change their password diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/initiatePortalPasswordChangeByBrandAgent.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/initiatePortalPasswordChangeByBrandAgent.md index ec598edede..0b97957b2a 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/initiatePortalPasswordChangeByBrandAgent.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/initiatePortalPasswordChangeByBrandAgent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::initiatePortalPasswordChangeByBrandAgent + Allows a Brand Agent to request password reset email to be sent to diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/inviteUserToLinkOpenIdConnect.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/inviteUserToLinkOpenIdConnect.md index 14bdaf3b84..380d99ba7c 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/inviteUserToLinkOpenIdConnect.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/inviteUserToLinkOpenIdConnect.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::inviteUserToLinkOpenIdConnect + Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/isMasterUser.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/isMasterUser.md index cc5ef3cdef..4144b2a719 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/isMasterUser.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/isMasterUser.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::isMasterUser +
              Deprecated
              + Determine if a portal user is a master user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/isValidPortalPassword.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/isValidPortalPassword.md index b0f0095ee6..d020d4af4b 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/isValidPortalPassword.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/isValidPortalPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::isValidPortalPassword + Determine if a string is a user's portal password. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/performExternalAuthentication.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/performExternalAuthentication.md index 0a85703312..09f306cd3a 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/performExternalAuthentication.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/performExternalAuthentication.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::performExternalAuthentication + Perform an external authentication using the given authentication container. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/processPasswordSetRequest.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/processPasswordSetRequest.md index 6e517756fd..2bf8c86bc1 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/processPasswordSetRequest.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/processPasswordSetRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::processPasswordSetRequest + Set the password for a user who has a valid password request key diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeAllDedicatedHostAccessForThisUser.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeAllDedicatedHostAccessForThisUser.md index 3001736a4d..c69c247bf4 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeAllDedicatedHostAccessForThisUser.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeAllDedicatedHostAccessForThisUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::removeAllDedicatedHostAccessForThisUser + Revoke access to all dedicated hosts on the account for this user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeAllHardwareAccessForThisUser.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeAllHardwareAccessForThisUser.md index acfc81d2b2..9b98d1922f 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeAllHardwareAccessForThisUser.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeAllHardwareAccessForThisUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::removeAllHardwareAccessForThisUser + Remove all hardware from a portal user's hardware access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeAllVirtualAccessForThisUser.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeAllVirtualAccessForThisUser.md index c6cd79bc61..a50f95d177 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeAllVirtualAccessForThisUser.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeAllVirtualAccessForThisUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::removeAllVirtualAccessForThisUser + Remove all cloud computing instances from a portal user's instance access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeApiAuthenticationKey.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeApiAuthenticationKey.md index c8e54fb5f3..b3c878dfa4 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeApiAuthenticationKey.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeApiAuthenticationKey.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::removeApiAuthenticationKey + Remove a user's API authentication key. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkDedicatedHostAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkDedicatedHostAccess.md index e17fcfa963..b4c81dbc05 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkDedicatedHostAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkDedicatedHostAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::removeBulkDedicatedHostAccess + Revoke access for the user for one or more dedicated hosts devices. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkHardwareAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkHardwareAccess.md index acfa80ae58..04b11866ec 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkHardwareAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkHardwareAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::removeBulkHardwareAccess + Remove multiple hardware from a portal user's hardware access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkPortalPermission.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkPortalPermission.md index ba9347ba79..80f054ee53 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkPortalPermission.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkPortalPermission.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::removeBulkPortalPermission + Remove multiple permissions from a portal user's permission set. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkRoles.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkRoles.md index 34b2d2b728..b197bcc9b2 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkRoles.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkRoles.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkVirtualGuestAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkVirtualGuestAccess.md index e8f6749d16..722dde00fa 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkVirtualGuestAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeBulkVirtualGuestAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::removeBulkVirtualGuestAccess + Remove multiple CloudLayer Computing Instances from a portal user's access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeDedicatedHostAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeDedicatedHostAccess.md index a9390cc231..6df93e7cea 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeDedicatedHostAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeDedicatedHostAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::removeDedicatedHostAccess + Revoke access for the user to a single dedicated hosts device. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeExternalBinding.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeExternalBinding.md index d5e4ddf50e..25726c928c 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeExternalBinding.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeExternalBinding.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::removeExternalBinding + Remove an external binding from this user. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeHardwareAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeHardwareAccess.md index 6f0066e56c..ab95fd9c29 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeHardwareAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeHardwareAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::removeHardwareAccess + Remove hardware from a portal user's hardware access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removePortalPermission.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removePortalPermission.md index c2c12eae47..560f908bd2 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removePortalPermission.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removePortalPermission.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::removePortalPermission + Remove a permission from a portal user's permission set. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeRole.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeRole.md index de180dc2c8..f1119c6332 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeRole.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeRole.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeSecurityAnswers.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeSecurityAnswers.md index 0effe5ac37..0aeea76ce1 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeSecurityAnswers.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeSecurityAnswers.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeVirtualGuestAccess.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeVirtualGuestAccess.md index 32e62e97e2..0b57058c77 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeVirtualGuestAccess.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/removeVirtualGuestAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::removeVirtualGuestAccess + Remove a CloudLayer Computing Instance from a portal user's access list. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/resetOpenIdConnectLink.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/resetOpenIdConnectLink.md index c0804cdc9c..fcfaea419b 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/resetOpenIdConnectLink.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/resetOpenIdConnectLink.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::resetOpenIdConnectLink + Change the link of a user for OpenIdConnect managed accounts, provided the diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/resetOpenIdConnectLinkUnifiedUserManagementMode.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/resetOpenIdConnectLinkUnifiedUserManagementMode.md index 0646038588..e6c5120e7a 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/resetOpenIdConnectLinkUnifiedUserManagementMode.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/resetOpenIdConnectLinkUnifiedUserManagementMode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::resetOpenIdConnectLinkUnifiedUserManagementMode + Change the link of a master user for OpenIdConnect managed accounts, diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlAuthenticate.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlAuthenticate.md index 48b9337ced..ed4ad1d90d 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlAuthenticate.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlAuthenticate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlBeginAuthentication.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlBeginAuthentication.md index 9bdedd4b75..91f1b79ccf 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlBeginAuthentication.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlBeginAuthentication.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlBeginLogout.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlBeginLogout.md index 7bae8c1635..0cc423080d 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlBeginLogout.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlBeginLogout.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlLogout.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlLogout.md index 6440f9a485..d939475db5 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlLogout.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/samlLogout.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/selfPasswordChange.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/selfPasswordChange.md index 674ca9c067..62eac24fb1 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/selfPasswordChange.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/selfPasswordChange.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/setDefaultAccount.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/setDefaultAccount.md index 9d7745033a..d2a421a314 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/setDefaultAccount.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/setDefaultAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::setDefaultAccount + Sets the default account for the OpenIdConnect identity that is linked to the current SoftLayer user identity. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/silentlyMigrateUserOpenIdConnect.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/silentlyMigrateUserOpenIdConnect.md index 8213135c52..14b6fbb8cf 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/silentlyMigrateUserOpenIdConnect.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/silentlyMigrateUserOpenIdConnect.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::silentlyMigrateUserOpenIdConnect + This api is used to migrate a user to IBMid without sending an invitation. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateNotificationSubscriber.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateNotificationSubscriber.md index e3d1261534..c3093d16b4 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateNotificationSubscriber.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateNotificationSubscriber.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::updateNotificationSubscriber + Update the active status for a notification subscription. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateSecurityAnswers.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateSecurityAnswers.md index c0506ba18c..70415cd40b 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateSecurityAnswers.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateSecurityAnswers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::updateSecurityAnswers + Update portal login security questions and answers. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateSubscriberDeliveryMethod.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateSubscriberDeliveryMethod.md index a41eec67f8..59a9077b33 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateSubscriberDeliveryMethod.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateSubscriberDeliveryMethod.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::updateSubscriberDeliveryMethod + Update a delivery method for the subscriber. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateVpnPassword.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateVpnPassword.md index eb65427641..06b3f38330 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateVpnPassword.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateVpnPassword.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::updateVpnPassword + Update a user's VPN password diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateVpnUser.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateVpnUser.md index 6c975749bc..c8c62253f7 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateVpnUser.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/updateVpnUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_OpenIdConnect_TrustedProfile](/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile)::updateVpnUser + Creates or updates a user's VPN access privileges. diff --git a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/validateAuthenticationToken.md b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/validateAuthenticationToken.md index 7f4d2ade6b..1438ddd3f9 100644 --- a/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/validateAuthenticationToken.md +++ b/content/reference/services/SoftLayer_User_Customer_OpenIdConnect_TrustedProfile/validateAuthenticationToken.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Customer_Profile_Event_HyperWarp/_index.md b/content/reference/services/SoftLayer_User_Customer_Profile_Event_HyperWarp/_index.md index e4392af09d..7b747b43b0 100644 --- a/content/reference/services/SoftLayer_User_Customer_Profile_Event_HyperWarp/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_Profile_Event_HyperWarp/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,6 +44,7 @@ classes: #### [receiveEventDirect](/reference/services/SoftLayer_User_Customer_Profile_Event_HyperWarp/receiveEventDirect) Modifies linked Paas user data based on changes initiated by Bluemix. +
              diff --git a/content/reference/services/SoftLayer_User_Customer_Profile_Event_HyperWarp/receiveEventDirect.md b/content/reference/services/SoftLayer_User_Customer_Profile_Event_HyperWarp/receiveEventDirect.md index 73057715e4..13ac1a7858 100644 --- a/content/reference/services/SoftLayer_User_Customer_Profile_Event_HyperWarp/receiveEventDirect.md +++ b/content/reference/services/SoftLayer_User_Customer_Profile_Event_HyperWarp/receiveEventDirect.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Profile_Event_HyperWarp](/reference/services/SoftLayer_User_Customer_Profile_Event_HyperWarp)::receiveEventDirect + Modifies linked Paas user data based on changes initiated by Bluemix. diff --git a/content/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/_index.md b/content/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/_index.md index cab59bde47..443fc1995d 100644 --- a/content/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,18 +44,21 @@ classes: #### [enroll](/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/enroll) Creates a new Service Provider Enrollment +
              #### [getCompanyType](/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/getCompanyType) Retrieve catalyst company types. +
              #### [getObject](/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/getObject) Retrieve a SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest record. +
              diff --git a/content/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/enroll.md b/content/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/enroll.md index 15757a2524..7e4f36e794 100644 --- a/content/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/enroll.md +++ b/content/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/enroll.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest](/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest)::enroll + Creates a new Service Provider Enrollment diff --git a/content/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/getCompanyType.md b/content/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/getCompanyType.md index b0eb56c4b4..e36cda307f 100644 --- a/content/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/getCompanyType.md +++ b/content/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/getCompanyType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest](/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest)::getCompanyType + Retrieve catalyst company types. diff --git a/content/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/getObject.md b/content/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/getObject.md index 0bef5562d2..4772283812 100644 --- a/content/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest](/reference/services/SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest)::getObject + Retrieve a SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest record. diff --git a/content/reference/services/SoftLayer_User_Customer_Security_Answer/_index.md b/content/reference/services/SoftLayer_User_Customer_Security_Answer/_index.md index a43d2b6555..c97eb61f75 100644 --- a/content/reference/services/SoftLayer_User_Customer_Security_Answer/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_Security_Answer/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,18 +44,21 @@ An account's user have security answers for secondary security measures. These q #### [getObject](/reference/services/SoftLayer_User_Customer_Security_Answer/getObject) Retrieve a SoftLayer_User_Customer_Security_Answer record. +
              #### [getQuestion](/reference/services/SoftLayer_User_Customer_Security_Answer/getQuestion) Retrieve the question the security answer is associated with. +
              #### [getUser](/reference/services/SoftLayer_User_Customer_Security_Answer/getUser) Retrieve the user who the security answer belongs to. +
              diff --git a/content/reference/services/SoftLayer_User_Customer_Security_Answer/getObject.md b/content/reference/services/SoftLayer_User_Customer_Security_Answer/getObject.md index bfa983f362..03e11b5594 100644 --- a/content/reference/services/SoftLayer_User_Customer_Security_Answer/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer_Security_Answer/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Security_Answer](/reference/services/SoftLayer_User_Customer_Security_Answer)::getObject + Retrieve a SoftLayer_User_Customer_Security_Answer record. diff --git a/content/reference/services/SoftLayer_User_Customer_Security_Answer/getQuestion.md b/content/reference/services/SoftLayer_User_Customer_Security_Answer/getQuestion.md index 7538fc3ab4..19fb8f6a81 100644 --- a/content/reference/services/SoftLayer_User_Customer_Security_Answer/getQuestion.md +++ b/content/reference/services/SoftLayer_User_Customer_Security_Answer/getQuestion.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Security_Answer](/reference/services/SoftLayer_User_Customer_Security_Answer)::getQuestion + Retrieve the question the security answer is associated with. diff --git a/content/reference/services/SoftLayer_User_Customer_Security_Answer/getUser.md b/content/reference/services/SoftLayer_User_Customer_Security_Answer/getUser.md index 6105152e4c..a69c2d299c 100644 --- a/content/reference/services/SoftLayer_User_Customer_Security_Answer/getUser.md +++ b/content/reference/services/SoftLayer_User_Customer_Security_Answer/getUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Security_Answer](/reference/services/SoftLayer_User_Customer_Security_Answer)::getUser + Retrieve the user who the security answer belongs to. diff --git a/content/reference/services/SoftLayer_User_Customer_Status/_index.md b/content/reference/services/SoftLayer_User_Customer_Status/_index.md index 98690cd57c..2f16c756d1 100644 --- a/content/reference/services/SoftLayer_User_Customer_Status/_index.md +++ b/content/reference/services/SoftLayer_User_Customer_Status/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + A User's status. It can be Active, Inactive, Disabled, Delete User, or VPN Only. @@ -42,12 +44,14 @@ A User's status. It can be Active, Inactive, Disabled, Delete User, or VPN Only. #### [getAllObjects](/reference/services/SoftLayer_User_Customer_Status/getAllObjects) Retrieve all user status objects. +
              #### [getObject](/reference/services/SoftLayer_User_Customer_Status/getObject) Retrieve a SoftLayer_User_Customer_Status record. +
              diff --git a/content/reference/services/SoftLayer_User_Customer_Status/getAllObjects.md b/content/reference/services/SoftLayer_User_Customer_Status/getAllObjects.md index 402e3d31b9..ab1af5154c 100644 --- a/content/reference/services/SoftLayer_User_Customer_Status/getAllObjects.md +++ b/content/reference/services/SoftLayer_User_Customer_Status/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Status](/reference/services/SoftLayer_User_Customer_Status)::getAllObjects + Retrieve all user status objects. diff --git a/content/reference/services/SoftLayer_User_Customer_Status/getObject.md b/content/reference/services/SoftLayer_User_Customer_Status/getObject.md index 34f7c9d0eb..499a3b5089 100644 --- a/content/reference/services/SoftLayer_User_Customer_Status/getObject.md +++ b/content/reference/services/SoftLayer_User_Customer_Status/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Customer_Status](/reference/services/SoftLayer_User_Customer_Status)::getObject + Retrieve a SoftLayer_User_Customer_Status record. diff --git a/content/reference/services/SoftLayer_User_External_Binding/_index.md b/content/reference/services/SoftLayer_User_External_Binding/_index.md index b568816ba4..3ac3ee48a8 100644 --- a/content/reference/services/SoftLayer_User_External_Binding/_index.md +++ b/content/reference/services/SoftLayer_User_External_Binding/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + <<< @@ -42,48 +44,56 @@ classes: #### [deleteObject](/reference/services/SoftLayer_User_External_Binding/deleteObject) Delete an external authentication binding. +
              #### [getAttributes](/reference/services/SoftLayer_User_External_Binding/getAttributes) Retrieve attributes of an external authentication binding. +
              #### [getBillingItem](/reference/services/SoftLayer_User_External_Binding/getBillingItem) Retrieve information regarding the billing item for external authentication. +
              #### [getNote](/reference/services/SoftLayer_User_External_Binding/getNote) Retrieve an optional note for identifying the external binding. +
              #### [getObject](/reference/services/SoftLayer_User_External_Binding/getObject) Retrieve a SoftLayer_User_External_Binding record. +
              #### [getType](/reference/services/SoftLayer_User_External_Binding/getType) Retrieve the type of external authentication binding. +
              #### [getVendor](/reference/services/SoftLayer_User_External_Binding/getVendor) Retrieve the vendor of an external authentication binding. +
              #### [updateNote](/reference/services/SoftLayer_User_External_Binding/updateNote) Update the note of an external binding. +
              diff --git a/content/reference/services/SoftLayer_User_External_Binding/deleteObject.md b/content/reference/services/SoftLayer_User_External_Binding/deleteObject.md index d849660c10..de49df8cbd 100644 --- a/content/reference/services/SoftLayer_User_External_Binding/deleteObject.md +++ b/content/reference/services/SoftLayer_User_External_Binding/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_External_Binding](/reference/services/SoftLayer_User_External_Binding)::deleteObject + Delete an external authentication binding. diff --git a/content/reference/services/SoftLayer_User_External_Binding/getAttributes.md b/content/reference/services/SoftLayer_User_External_Binding/getAttributes.md index 91262dca8f..821039a13a 100644 --- a/content/reference/services/SoftLayer_User_External_Binding/getAttributes.md +++ b/content/reference/services/SoftLayer_User_External_Binding/getAttributes.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_External_Binding](/reference/services/SoftLayer_User_External_Binding)::getAttributes + Retrieve attributes of an external authentication binding. diff --git a/content/reference/services/SoftLayer_User_External_Binding/getBillingItem.md b/content/reference/services/SoftLayer_User_External_Binding/getBillingItem.md index f5234464f7..e8f8e231f2 100644 --- a/content/reference/services/SoftLayer_User_External_Binding/getBillingItem.md +++ b/content/reference/services/SoftLayer_User_External_Binding/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_External_Binding](/reference/services/SoftLayer_User_External_Binding)::getBillingItem + Retrieve information regarding the billing item for external authentication. diff --git a/content/reference/services/SoftLayer_User_External_Binding/getNote.md b/content/reference/services/SoftLayer_User_External_Binding/getNote.md index 731f824137..a9261f96b3 100644 --- a/content/reference/services/SoftLayer_User_External_Binding/getNote.md +++ b/content/reference/services/SoftLayer_User_External_Binding/getNote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_External_Binding](/reference/services/SoftLayer_User_External_Binding)::getNote + Retrieve an optional note for identifying the external binding. diff --git a/content/reference/services/SoftLayer_User_External_Binding/getObject.md b/content/reference/services/SoftLayer_User_External_Binding/getObject.md index 06641dfdb6..3d579126e6 100644 --- a/content/reference/services/SoftLayer_User_External_Binding/getObject.md +++ b/content/reference/services/SoftLayer_User_External_Binding/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_External_Binding](/reference/services/SoftLayer_User_External_Binding)::getObject + Retrieve a SoftLayer_User_External_Binding record. diff --git a/content/reference/services/SoftLayer_User_External_Binding/getType.md b/content/reference/services/SoftLayer_User_External_Binding/getType.md index ba6aa4a621..1df89bff4f 100644 --- a/content/reference/services/SoftLayer_User_External_Binding/getType.md +++ b/content/reference/services/SoftLayer_User_External_Binding/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_External_Binding](/reference/services/SoftLayer_User_External_Binding)::getType + Retrieve the type of external authentication binding. diff --git a/content/reference/services/SoftLayer_User_External_Binding/getVendor.md b/content/reference/services/SoftLayer_User_External_Binding/getVendor.md index e797a9a2ba..cf45e47476 100644 --- a/content/reference/services/SoftLayer_User_External_Binding/getVendor.md +++ b/content/reference/services/SoftLayer_User_External_Binding/getVendor.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_External_Binding](/reference/services/SoftLayer_User_External_Binding)::getVendor + Retrieve the vendor of an external authentication binding. diff --git a/content/reference/services/SoftLayer_User_External_Binding/updateNote.md b/content/reference/services/SoftLayer_User_External_Binding/updateNote.md index 151824d3f3..e1b17a7b74 100644 --- a/content/reference/services/SoftLayer_User_External_Binding/updateNote.md +++ b/content/reference/services/SoftLayer_User_External_Binding/updateNote.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_External_Binding](/reference/services/SoftLayer_User_External_Binding)::updateNote + Update the note of an external binding. diff --git a/content/reference/services/SoftLayer_User_External_Binding_Vendor/_index.md b/content/reference/services/SoftLayer_User_External_Binding_Vendor/_index.md index cf525512aa..1a663ec673 100644 --- a/content/reference/services/SoftLayer_User_External_Binding_Vendor/_index.md +++ b/content/reference/services/SoftLayer_User_External_Binding_Vendor/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_User_External_Binding_Vendor service is used to retrieve a list of available 3rd party vendors that SoftLayer supports for external bindings. @@ -42,12 +44,14 @@ The SoftLayer_User_External_Binding_Vendor service is used to retrieve a list of #### [getAllObjects](/reference/services/SoftLayer_User_External_Binding_Vendor/getAllObjects) Get a list of all available external binding vendors that SoftLayer supports. +
              #### [getObject](/reference/services/SoftLayer_User_External_Binding_Vendor/getObject) Retrieve a SoftLayer_User_External_Binding_Vendor record. +
              diff --git a/content/reference/services/SoftLayer_User_External_Binding_Vendor/getAllObjects.md b/content/reference/services/SoftLayer_User_External_Binding_Vendor/getAllObjects.md index 3161be7266..72b8932b96 100644 --- a/content/reference/services/SoftLayer_User_External_Binding_Vendor/getAllObjects.md +++ b/content/reference/services/SoftLayer_User_External_Binding_Vendor/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_External_Binding_Vendor](/reference/services/SoftLayer_User_External_Binding_Vendor)::getAllObjects + Get a list of all available external binding vendors that SoftLayer supports. diff --git a/content/reference/services/SoftLayer_User_External_Binding_Vendor/getObject.md b/content/reference/services/SoftLayer_User_External_Binding_Vendor/getObject.md index 117d6463b5..8f1068d78c 100644 --- a/content/reference/services/SoftLayer_User_External_Binding_Vendor/getObject.md +++ b/content/reference/services/SoftLayer_User_External_Binding_Vendor/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_External_Binding_Vendor](/reference/services/SoftLayer_User_External_Binding_Vendor)::getObject + Retrieve a SoftLayer_User_External_Binding_Vendor record. diff --git a/content/reference/services/SoftLayer_User_Permission_Action/_index.md b/content/reference/services/SoftLayer_User_Permission_Action/_index.md index f752587ed3..27b63c95cf 100644 --- a/content/reference/services/SoftLayer_User_Permission_Action/_index.md +++ b/content/reference/services/SoftLayer_User_Permission_Action/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) 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. @@ -52,12 +54,14 @@ See [SoftLayer_User_Permission_Group]({{
              #### [getObject](/reference/services/SoftLayer_User_Permission_Action/getObject) Retrieve a SoftLayer_User_Permission_Action record. +
              diff --git a/content/reference/services/SoftLayer_User_Permission_Action/getAllObjects.md b/content/reference/services/SoftLayer_User_Permission_Action/getAllObjects.md index a9f73b2bda..6a3354e43c 100644 --- a/content/reference/services/SoftLayer_User_Permission_Action/getAllObjects.md +++ b/content/reference/services/SoftLayer_User_Permission_Action/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Action](/reference/services/SoftLayer_User_Permission_Action)::getAllObjects + Retrieve all customer permission actions in IMS. diff --git a/content/reference/services/SoftLayer_User_Permission_Action/getObject.md b/content/reference/services/SoftLayer_User_Permission_Action/getObject.md index 31cd86c022..66a5c14fd8 100644 --- a/content/reference/services/SoftLayer_User_Permission_Action/getObject.md +++ b/content/reference/services/SoftLayer_User_Permission_Action/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Action](/reference/services/SoftLayer_User_Permission_Action)::getObject + Retrieve a SoftLayer_User_Permission_Action record. diff --git a/content/reference/services/SoftLayer_User_Permission_Group/_index.md b/content/reference/services/SoftLayer_User_Permission_Group/_index.md index 27f48796c6..b87d64728b 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/_index.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}). When a [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. @@ -56,108 +58,126 @@ Resources belonging to the user's account can also be linked to permission group #### [addAction](/reference/services/SoftLayer_User_Permission_Group/addAction) Add a permission action to the group. +
              #### [addBulkActions](/reference/services/SoftLayer_User_Permission_Group/addBulkActions) Adds a list of permission actions to the group. +
              #### [addBulkResourceObjects](/reference/services/SoftLayer_User_Permission_Group/addBulkResourceObjects) Links multiple account device objects of the same resource type to the group. +
              #### [addResourceObject](/reference/services/SoftLayer_User_Permission_Group/addResourceObject) Links a hardware, virtual guest, or dedicated host object on the +
              #### [createObject](/reference/services/SoftLayer_User_Permission_Group/createObject) Create a new customer permission group +
              #### [deleteObject](/reference/services/SoftLayer_User_Permission_Group/deleteObject) Delete a new customer permission group +
              #### [editObject](/reference/services/SoftLayer_User_Permission_Group/editObject) Edit an existing customer permission group +
              #### [getAccount](/reference/services/SoftLayer_User_Permission_Group/getAccount) +
              #### [getActions](/reference/services/SoftLayer_User_Permission_Group/getActions) +
              #### [getObject](/reference/services/SoftLayer_User_Permission_Group/getObject) Retrieve a SoftLayer_User_Permission_Group record. +
              #### [getRoles](/reference/services/SoftLayer_User_Permission_Group/getRoles) +
              #### [getType](/reference/services/SoftLayer_User_Permission_Group/getType) Retrieve the type of the permission group. +
              #### [linkRole](/reference/services/SoftLayer_User_Permission_Group/linkRole) Links a permission role to the group. +
              #### [removeAction](/reference/services/SoftLayer_User_Permission_Group/removeAction) Remove a permission action from the group. +
              #### [removeBulkActions](/reference/services/SoftLayer_User_Permission_Group/removeBulkActions) Remove a list of permission actions from the group. +
              #### [removeBulkResourceObjects](/reference/services/SoftLayer_User_Permission_Group/removeBulkResourceObjects) Unlinks multiple account device objects of the same resource type from the group. +
              #### [removeResourceObject](/reference/services/SoftLayer_User_Permission_Group/removeResourceObject) Unlinks a hardware, virtual guest, or dedicated host object on the +
              #### [unlinkRole](/reference/services/SoftLayer_User_Permission_Group/unlinkRole) Unlinks a permission role from the group. +
              diff --git a/content/reference/services/SoftLayer_User_Permission_Group/addAction.md b/content/reference/services/SoftLayer_User_Permission_Group/addAction.md index d762ed4904..fa5bca224b 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/addAction.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/addAction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Group](/reference/services/SoftLayer_User_Permission_Group)::addAction + Add a permission action to the group. diff --git a/content/reference/services/SoftLayer_User_Permission_Group/addBulkActions.md b/content/reference/services/SoftLayer_User_Permission_Group/addBulkActions.md index c2165d3421..ceaa7126dd 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/addBulkActions.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/addBulkActions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Group](/reference/services/SoftLayer_User_Permission_Group)::addBulkActions + Adds a list of permission actions to the group. diff --git a/content/reference/services/SoftLayer_User_Permission_Group/addBulkResourceObjects.md b/content/reference/services/SoftLayer_User_Permission_Group/addBulkResourceObjects.md index 1c3327e3e0..5651db0f04 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/addBulkResourceObjects.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/addBulkResourceObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Group](/reference/services/SoftLayer_User_Permission_Group)::addBulkResourceObjects + Links multiple account device objects of the same resource type to the group. diff --git a/content/reference/services/SoftLayer_User_Permission_Group/addResourceObject.md b/content/reference/services/SoftLayer_User_Permission_Group/addResourceObject.md index cdc10e212c..3b51de31c5 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/addResourceObject.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/addResourceObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Group](/reference/services/SoftLayer_User_Permission_Group)::addResourceObject + Links a hardware, virtual guest, or dedicated host object on the diff --git a/content/reference/services/SoftLayer_User_Permission_Group/createObject.md b/content/reference/services/SoftLayer_User_Permission_Group/createObject.md index 4f2386e43d..61ef13f2e4 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/createObject.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Group](/reference/services/SoftLayer_User_Permission_Group)::createObject + Create a new customer permission group diff --git a/content/reference/services/SoftLayer_User_Permission_Group/deleteObject.md b/content/reference/services/SoftLayer_User_Permission_Group/deleteObject.md index 47634c7326..f698516a5f 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/deleteObject.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Group](/reference/services/SoftLayer_User_Permission_Group)::deleteObject + Delete a new customer permission group diff --git a/content/reference/services/SoftLayer_User_Permission_Group/editObject.md b/content/reference/services/SoftLayer_User_Permission_Group/editObject.md index 8b1c470a4b..3930c25c88 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/editObject.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Group](/reference/services/SoftLayer_User_Permission_Group)::editObject + Edit an existing customer permission group diff --git a/content/reference/services/SoftLayer_User_Permission_Group/getAccount.md b/content/reference/services/SoftLayer_User_Permission_Group/getAccount.md index d1ec0bb286..c98c8678f5 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/getAccount.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Permission_Group/getActions.md b/content/reference/services/SoftLayer_User_Permission_Group/getActions.md index 1de8b66b45..29cd3fa733 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/getActions.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/getActions.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Permission_Group/getObject.md b/content/reference/services/SoftLayer_User_Permission_Group/getObject.md index 9657fd3e96..6d3c356986 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/getObject.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Group](/reference/services/SoftLayer_User_Permission_Group)::getObject + Retrieve a SoftLayer_User_Permission_Group record. diff --git a/content/reference/services/SoftLayer_User_Permission_Group/getRoles.md b/content/reference/services/SoftLayer_User_Permission_Group/getRoles.md index 4239bd3e25..8824697570 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/getRoles.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/getRoles.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Permission_Group/getType.md b/content/reference/services/SoftLayer_User_Permission_Group/getType.md index 637c4c0fb6..83229f6719 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/getType.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Group](/reference/services/SoftLayer_User_Permission_Group)::getType + Retrieve the type of the permission group. diff --git a/content/reference/services/SoftLayer_User_Permission_Group/linkRole.md b/content/reference/services/SoftLayer_User_Permission_Group/linkRole.md index 903947de6f..dcc4262b49 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/linkRole.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/linkRole.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Group](/reference/services/SoftLayer_User_Permission_Group)::linkRole + Links a permission role to the group. diff --git a/content/reference/services/SoftLayer_User_Permission_Group/removeAction.md b/content/reference/services/SoftLayer_User_Permission_Group/removeAction.md index d9287216f7..8413501ad7 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/removeAction.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/removeAction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Group](/reference/services/SoftLayer_User_Permission_Group)::removeAction + Remove a permission action from the group. diff --git a/content/reference/services/SoftLayer_User_Permission_Group/removeBulkActions.md b/content/reference/services/SoftLayer_User_Permission_Group/removeBulkActions.md index 3145222e19..b0969ce55a 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/removeBulkActions.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/removeBulkActions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Group](/reference/services/SoftLayer_User_Permission_Group)::removeBulkActions + Remove a list of permission actions from the group. diff --git a/content/reference/services/SoftLayer_User_Permission_Group/removeBulkResourceObjects.md b/content/reference/services/SoftLayer_User_Permission_Group/removeBulkResourceObjects.md index 6b1654296e..9831da3ca5 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/removeBulkResourceObjects.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/removeBulkResourceObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Group](/reference/services/SoftLayer_User_Permission_Group)::removeBulkResourceObjects + Unlinks multiple account device objects of the same resource type from the group. diff --git a/content/reference/services/SoftLayer_User_Permission_Group/removeResourceObject.md b/content/reference/services/SoftLayer_User_Permission_Group/removeResourceObject.md index a19e28c8b3..e6208dc662 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/removeResourceObject.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/removeResourceObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Group](/reference/services/SoftLayer_User_Permission_Group)::removeResourceObject + Unlinks a hardware, virtual guest, or dedicated host object on the diff --git a/content/reference/services/SoftLayer_User_Permission_Group/unlinkRole.md b/content/reference/services/SoftLayer_User_Permission_Group/unlinkRole.md index f475e880ed..6d6937d71c 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group/unlinkRole.md +++ b/content/reference/services/SoftLayer_User_Permission_Group/unlinkRole.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Group](/reference/services/SoftLayer_User_Permission_Group)::unlinkRole + Unlinks a permission role from the group. diff --git a/content/reference/services/SoftLayer_User_Permission_Group_Type/_index.md b/content/reference/services/SoftLayer_User_Permission_Group_Type/_index.md index 65195c182f..cdabf9a986 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group_Type/_index.md +++ b/content/reference/services/SoftLayer_User_Permission_Group_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -46,12 +48,14 @@ When a [SoftLayer_User_Customer]({{
              #### [getObject](/reference/services/SoftLayer_User_Permission_Group_Type/getObject) Retrieve a SoftLayer_User_Permission_Group_Type record. +
              diff --git a/content/reference/services/SoftLayer_User_Permission_Group_Type/getGroups.md b/content/reference/services/SoftLayer_User_Permission_Group_Type/getGroups.md index 77731bc7b9..4116d0d080 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group_Type/getGroups.md +++ b/content/reference/services/SoftLayer_User_Permission_Group_Type/getGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Group_Type](/reference/services/SoftLayer_User_Permission_Group_Type)::getGroups + Retrieve the groups that are of this type. diff --git a/content/reference/services/SoftLayer_User_Permission_Group_Type/getObject.md b/content/reference/services/SoftLayer_User_Permission_Group_Type/getObject.md index ae94cc079b..c7f5e0120b 100644 --- a/content/reference/services/SoftLayer_User_Permission_Group_Type/getObject.md +++ b/content/reference/services/SoftLayer_User_Permission_Group_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Group_Type](/reference/services/SoftLayer_User_Permission_Group_Type)::getObject + Retrieve a SoftLayer_User_Permission_Group_Type record. diff --git a/content/reference/services/SoftLayer_User_Permission_Resource_Type/_index.md b/content/reference/services/SoftLayer_User_Permission_Resource_Type/_index.md index 97bf2c2100..822e3f2317 100644 --- a/content/reference/services/SoftLayer_User_Permission_Resource_Type/_index.md +++ b/content/reference/services/SoftLayer_User_Permission_Resource_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -46,12 +48,14 @@ See [SoftLayer_User_Permission_Group]({{
              #### [getObject](/reference/services/SoftLayer_User_Permission_Resource_Type/getObject) Retrieve a SoftLayer_User_Permission_Resource_Type record. +
              diff --git a/content/reference/services/SoftLayer_User_Permission_Resource_Type/getAllObjects.md b/content/reference/services/SoftLayer_User_Permission_Resource_Type/getAllObjects.md index 8229a5e185..88a5cdcbe5 100644 --- a/content/reference/services/SoftLayer_User_Permission_Resource_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_User_Permission_Resource_Type/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Resource_Type](/reference/services/SoftLayer_User_Permission_Resource_Type)::getAllObjects + Retrieve an array of SoftLayer_User_Permission_Resource_Type objects. diff --git a/content/reference/services/SoftLayer_User_Permission_Resource_Type/getObject.md b/content/reference/services/SoftLayer_User_Permission_Resource_Type/getObject.md index f363c1ebe3..1815024cbe 100644 --- a/content/reference/services/SoftLayer_User_Permission_Resource_Type/getObject.md +++ b/content/reference/services/SoftLayer_User_Permission_Resource_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Resource_Type](/reference/services/SoftLayer_User_Permission_Resource_Type)::getObject + Retrieve a SoftLayer_User_Permission_Resource_Type record. diff --git a/content/reference/services/SoftLayer_User_Permission_Role/_index.md b/content/reference/services/SoftLayer_User_Permission_Role/_index.md index cfd5f72f29..bca83653e6 100644 --- a/content/reference/services/SoftLayer_User_Permission_Role/_index.md +++ b/content/reference/services/SoftLayer_User_Permission_Role/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) 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. @@ -52,72 +54,84 @@ The SoftLayer_User_Permission_Action class defines the permissions that are requ #### [addUser](/reference/services/SoftLayer_User_Permission_Role/addUser) Assign a user customer to the role. +
              #### [createObject](/reference/services/SoftLayer_User_Permission_Role/createObject) Create a new customer permission role +
              #### [deleteObject](/reference/services/SoftLayer_User_Permission_Role/deleteObject) Delete a new customer permission role +
              #### [editObject](/reference/services/SoftLayer_User_Permission_Role/editObject) Edit an existing customer permission role +
              #### [getAccount](/reference/services/SoftLayer_User_Permission_Role/getAccount) +
              #### [getActions](/reference/services/SoftLayer_User_Permission_Role/getActions) +
              #### [getGroups](/reference/services/SoftLayer_User_Permission_Role/getGroups) +
              #### [getObject](/reference/services/SoftLayer_User_Permission_Role/getObject) Retrieve a SoftLayer_User_Permission_Role record. +
              #### [getUsers](/reference/services/SoftLayer_User_Permission_Role/getUsers) +
              #### [linkGroup](/reference/services/SoftLayer_User_Permission_Role/linkGroup) Links a permission group to the role. +
              #### [removeUser](/reference/services/SoftLayer_User_Permission_Role/removeUser) Unassign a user customer from the role. +
              #### [unlinkGroup](/reference/services/SoftLayer_User_Permission_Role/unlinkGroup) Unlinks a permission group to the role. +
              diff --git a/content/reference/services/SoftLayer_User_Permission_Role/addUser.md b/content/reference/services/SoftLayer_User_Permission_Role/addUser.md index 5e05460b10..ef1895efca 100644 --- a/content/reference/services/SoftLayer_User_Permission_Role/addUser.md +++ b/content/reference/services/SoftLayer_User_Permission_Role/addUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Role](/reference/services/SoftLayer_User_Permission_Role)::addUser + Assign a user customer to the role. diff --git a/content/reference/services/SoftLayer_User_Permission_Role/createObject.md b/content/reference/services/SoftLayer_User_Permission_Role/createObject.md index 7186ada268..544aca8e28 100644 --- a/content/reference/services/SoftLayer_User_Permission_Role/createObject.md +++ b/content/reference/services/SoftLayer_User_Permission_Role/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Role](/reference/services/SoftLayer_User_Permission_Role)::createObject + Create a new customer permission role diff --git a/content/reference/services/SoftLayer_User_Permission_Role/deleteObject.md b/content/reference/services/SoftLayer_User_Permission_Role/deleteObject.md index 0e4355d9a0..b841e1bd90 100644 --- a/content/reference/services/SoftLayer_User_Permission_Role/deleteObject.md +++ b/content/reference/services/SoftLayer_User_Permission_Role/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Role](/reference/services/SoftLayer_User_Permission_Role)::deleteObject + Delete a new customer permission role diff --git a/content/reference/services/SoftLayer_User_Permission_Role/editObject.md b/content/reference/services/SoftLayer_User_Permission_Role/editObject.md index d95c097c75..93954c0e3a 100644 --- a/content/reference/services/SoftLayer_User_Permission_Role/editObject.md +++ b/content/reference/services/SoftLayer_User_Permission_Role/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Role](/reference/services/SoftLayer_User_Permission_Role)::editObject + Edit an existing customer permission role diff --git a/content/reference/services/SoftLayer_User_Permission_Role/getAccount.md b/content/reference/services/SoftLayer_User_Permission_Role/getAccount.md index 87e848d112..b48e788fc9 100644 --- a/content/reference/services/SoftLayer_User_Permission_Role/getAccount.md +++ b/content/reference/services/SoftLayer_User_Permission_Role/getAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Permission_Role/getActions.md b/content/reference/services/SoftLayer_User_Permission_Role/getActions.md index 2530d5d797..95840e1ad8 100644 --- a/content/reference/services/SoftLayer_User_Permission_Role/getActions.md +++ b/content/reference/services/SoftLayer_User_Permission_Role/getActions.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Permission_Role/getGroups.md b/content/reference/services/SoftLayer_User_Permission_Role/getGroups.md index ec30bac664..8f57f79515 100644 --- a/content/reference/services/SoftLayer_User_Permission_Role/getGroups.md +++ b/content/reference/services/SoftLayer_User_Permission_Role/getGroups.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Permission_Role/getObject.md b/content/reference/services/SoftLayer_User_Permission_Role/getObject.md index 93cebd9957..87e9df0808 100644 --- a/content/reference/services/SoftLayer_User_Permission_Role/getObject.md +++ b/content/reference/services/SoftLayer_User_Permission_Role/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Role](/reference/services/SoftLayer_User_Permission_Role)::getObject + Retrieve a SoftLayer_User_Permission_Role record. diff --git a/content/reference/services/SoftLayer_User_Permission_Role/getUsers.md b/content/reference/services/SoftLayer_User_Permission_Role/getUsers.md index e5d07ce690..12bfd8269c 100644 --- a/content/reference/services/SoftLayer_User_Permission_Role/getUsers.md +++ b/content/reference/services/SoftLayer_User_Permission_Role/getUsers.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_User_Permission_Role/linkGroup.md b/content/reference/services/SoftLayer_User_Permission_Role/linkGroup.md index be94a1f568..9ba4edc5ef 100644 --- a/content/reference/services/SoftLayer_User_Permission_Role/linkGroup.md +++ b/content/reference/services/SoftLayer_User_Permission_Role/linkGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Role](/reference/services/SoftLayer_User_Permission_Role)::linkGroup + Links a permission group to the role. diff --git a/content/reference/services/SoftLayer_User_Permission_Role/removeUser.md b/content/reference/services/SoftLayer_User_Permission_Role/removeUser.md index 9677f9d266..933db3e535 100644 --- a/content/reference/services/SoftLayer_User_Permission_Role/removeUser.md +++ b/content/reference/services/SoftLayer_User_Permission_Role/removeUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Role](/reference/services/SoftLayer_User_Permission_Role)::removeUser + Unassign a user customer from the role. diff --git a/content/reference/services/SoftLayer_User_Permission_Role/unlinkGroup.md b/content/reference/services/SoftLayer_User_Permission_Role/unlinkGroup.md index dc33b2c070..836f449c67 100644 --- a/content/reference/services/SoftLayer_User_Permission_Role/unlinkGroup.md +++ b/content/reference/services/SoftLayer_User_Permission_Role/unlinkGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Permission_Role](/reference/services/SoftLayer_User_Permission_Role)::unlinkGroup + Unlinks a permission group to the role. diff --git a/content/reference/services/SoftLayer_User_Security_Question/_index.md b/content/reference/services/SoftLayer_User_Security_Question/_index.md index b621af66ab..26300a21f5 100644 --- a/content/reference/services/SoftLayer_User_Security_Question/_index.md +++ b/content/reference/services/SoftLayer_User_Security_Question/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + Every user has an option of a secondary security login feature. This SoftLayer_User_Security_Question service provides a list of security questions. @@ -42,12 +44,14 @@ Every user has an option of a secondary security login feature. This SoftLayer_U #### [getAllObjects](/reference/services/SoftLayer_User_Security_Question/getAllObjects) Retrieve all viewable security questions. +
              #### [getObject](/reference/services/SoftLayer_User_Security_Question/getObject) Retrieve a SoftLayer_User_Security_Question record. +
              diff --git a/content/reference/services/SoftLayer_User_Security_Question/getAllObjects.md b/content/reference/services/SoftLayer_User_Security_Question/getAllObjects.md index cba9f997f8..989a676892 100644 --- a/content/reference/services/SoftLayer_User_Security_Question/getAllObjects.md +++ b/content/reference/services/SoftLayer_User_Security_Question/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Security_Question](/reference/services/SoftLayer_User_Security_Question)::getAllObjects + Retrieve all viewable security questions. diff --git a/content/reference/services/SoftLayer_User_Security_Question/getObject.md b/content/reference/services/SoftLayer_User_Security_Question/getObject.md index 35020737d9..f4ecb0b394 100644 --- a/content/reference/services/SoftLayer_User_Security_Question/getObject.md +++ b/content/reference/services/SoftLayer_User_Security_Question/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_User_Security_Question](/reference/services/SoftLayer_User_Security_Question)::getObject + Retrieve a SoftLayer_User_Security_Question record. diff --git a/content/reference/services/SoftLayer_Utility_Network/_index.md b/content/reference/services/SoftLayer_Utility_Network/_index.md index 160a2d7209..f5f61b9fe7 100644 --- a/content/reference/services/SoftLayer_Utility_Network/_index.md +++ b/content/reference/services/SoftLayer_Utility_Network/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Utility_Network service allows users to send network diagnostic requests from SoftLayer's application servers to a given host on the Internet. @@ -42,12 +44,14 @@ The SoftLayer_Utility_Network service allows users to send network diagnostic re #### [nsLookup](/reference/services/SoftLayer_Utility_Network/nsLookup) Perform a nameserver lookup on given address. +
              #### [whois](/reference/services/SoftLayer_Utility_Network/whois) Perform a WHOIS lookup on a given address. +
              diff --git a/content/reference/services/SoftLayer_Utility_Network/nsLookup.md b/content/reference/services/SoftLayer_Utility_Network/nsLookup.md index 5476bfe98c..7861351278 100644 --- a/content/reference/services/SoftLayer_Utility_Network/nsLookup.md +++ b/content/reference/services/SoftLayer_Utility_Network/nsLookup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Utility_Network](/reference/services/SoftLayer_Utility_Network)::nsLookup + Perform a nameserver lookup on given address. diff --git a/content/reference/services/SoftLayer_Utility_Network/whois.md b/content/reference/services/SoftLayer_Utility_Network/whois.md index e47bbbab3e..ac5a84e038 100644 --- a/content/reference/services/SoftLayer_Utility_Network/whois.md +++ b/content/reference/services/SoftLayer_Utility_Network/whois.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Utility_Network](/reference/services/SoftLayer_Utility_Network)::whois + Perform a WHOIS lookup on a given address. diff --git a/content/reference/services/SoftLayer_Virtual_DedicatedHost/_index.md b/content/reference/services/SoftLayer_Virtual_DedicatedHost/_index.md index 07891ac803..831b4eec2c 100644 --- a/content/reference/services/SoftLayer_Virtual_DedicatedHost/_index.md +++ b/content/reference/services/SoftLayer_Virtual_DedicatedHost/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Virtual_DedicatedHost models a single tenant virtual host dedicated to a specific account. @@ -42,90 +44,105 @@ SoftLayer_Virtual_DedicatedHost models a single tenant virtual host dedicated to #### [deleteObject](/reference/services/SoftLayer_Virtual_DedicatedHost/deleteObject) Reclaim a dedicated host to cancel it's use. +
              #### [editObject](/reference/services/SoftLayer_Virtual_DedicatedHost/editObject) Edit a dedicated host's properties. +
              #### [getAccount](/reference/services/SoftLayer_Virtual_DedicatedHost/getAccount) Retrieve the account that the dedicated host belongs to. +
              #### [getAllocationStatus](/reference/services/SoftLayer_Virtual_DedicatedHost/getAllocationStatus) Retrieve the container that represents allocations on the dedicated host. +
              #### [getAvailableRouters](/reference/services/SoftLayer_Virtual_DedicatedHost/getAvailableRouters) Get available backend routers in a datacenter to order a dedicated host. +
              #### [getBackendRouter](/reference/services/SoftLayer_Virtual_DedicatedHost/getBackendRouter) Retrieve the backend router behind dedicated host's pool of resources. +
              #### [getBillingItem](/reference/services/SoftLayer_Virtual_DedicatedHost/getBillingItem) Retrieve the billing item for the dedicated host. +
              #### [getDatacenter](/reference/services/SoftLayer_Virtual_DedicatedHost/getDatacenter) Retrieve the datacenter that the dedicated host resides in. +
              #### [getGuests](/reference/services/SoftLayer_Virtual_DedicatedHost/getGuests) Retrieve the guests associated with the dedicated host. +
              #### [getInternalTagReferences](/reference/services/SoftLayer_Virtual_DedicatedHost/getInternalTagReferences) +
              #### [getObject](/reference/services/SoftLayer_Virtual_DedicatedHost/getObject) Retrieve a SoftLayer_Virtual_DedicatedHost record. +
              #### [getPciDeviceAllocationStatus](/reference/services/SoftLayer_Virtual_DedicatedHost/getPciDeviceAllocationStatus) Retrieve the container that represents PCI device allocations on the dedicated host. +
              #### [getPciDevices](/reference/services/SoftLayer_Virtual_DedicatedHost/getPciDevices) Retrieve a collection of SoftLayer_Virtual_Host_PciDevice objects on the host. +
              #### [getTagReferences](/reference/services/SoftLayer_Virtual_DedicatedHost/getTagReferences) +
              #### [setTags](/reference/services/SoftLayer_Virtual_DedicatedHost/setTags) +
              diff --git a/content/reference/services/SoftLayer_Virtual_DedicatedHost/deleteObject.md b/content/reference/services/SoftLayer_Virtual_DedicatedHost/deleteObject.md index be25483af5..34a4f4265b 100644 --- a/content/reference/services/SoftLayer_Virtual_DedicatedHost/deleteObject.md +++ b/content/reference/services/SoftLayer_Virtual_DedicatedHost/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_DedicatedHost](/reference/services/SoftLayer_Virtual_DedicatedHost)::deleteObject + Reclaim a dedicated host to cancel it's use. diff --git a/content/reference/services/SoftLayer_Virtual_DedicatedHost/editObject.md b/content/reference/services/SoftLayer_Virtual_DedicatedHost/editObject.md index 8ff891527b..f9f89cbec4 100644 --- a/content/reference/services/SoftLayer_Virtual_DedicatedHost/editObject.md +++ b/content/reference/services/SoftLayer_Virtual_DedicatedHost/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_DedicatedHost](/reference/services/SoftLayer_Virtual_DedicatedHost)::editObject + Edit a dedicated host's properties. diff --git a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getAccount.md b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getAccount.md index 307a29639e..d41e31d0b1 100644 --- a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getAccount.md +++ b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_DedicatedHost](/reference/services/SoftLayer_Virtual_DedicatedHost)::getAccount + Retrieve the account that the dedicated host belongs to. diff --git a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getAllocationStatus.md b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getAllocationStatus.md index e69f21a041..afbaffbba4 100644 --- a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getAllocationStatus.md +++ b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getAllocationStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_DedicatedHost](/reference/services/SoftLayer_Virtual_DedicatedHost)::getAllocationStatus + Retrieve the container that represents allocations on the dedicated host. diff --git a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getAvailableRouters.md b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getAvailableRouters.md index e7f84dd7bb..bc80881254 100644 --- a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getAvailableRouters.md +++ b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getAvailableRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_DedicatedHost](/reference/services/SoftLayer_Virtual_DedicatedHost)::getAvailableRouters + Get available backend routers in a datacenter to order a dedicated host. diff --git a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getBackendRouter.md b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getBackendRouter.md index 7b26b9eeb2..da539f76ca 100644 --- a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getBackendRouter.md +++ b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getBackendRouter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_DedicatedHost](/reference/services/SoftLayer_Virtual_DedicatedHost)::getBackendRouter + Retrieve the backend router behind dedicated host's pool of resources. diff --git a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getBillingItem.md b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getBillingItem.md index 978f8e49f8..35e4472fc4 100644 --- a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getBillingItem.md +++ b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_DedicatedHost](/reference/services/SoftLayer_Virtual_DedicatedHost)::getBillingItem + Retrieve the billing item for the dedicated host. diff --git a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getDatacenter.md b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getDatacenter.md index adc61b8f15..c3c0034e53 100644 --- a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getDatacenter.md +++ b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getDatacenter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_DedicatedHost](/reference/services/SoftLayer_Virtual_DedicatedHost)::getDatacenter + Retrieve the datacenter that the dedicated host resides in. diff --git a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getGuests.md b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getGuests.md index 6ece950335..9732e603e8 100644 --- a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getGuests.md +++ b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_DedicatedHost](/reference/services/SoftLayer_Virtual_DedicatedHost)::getGuests + Retrieve the guests associated with the dedicated host. diff --git a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getInternalTagReferences.md b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getInternalTagReferences.md index 1ba6ed0cf1..ad4ef513ce 100644 --- a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getInternalTagReferences.md +++ b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getInternalTagReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getObject.md b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getObject.md index ea8768b0d3..8f2b9a9718 100644 --- a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getObject.md +++ b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_DedicatedHost](/reference/services/SoftLayer_Virtual_DedicatedHost)::getObject + Retrieve a SoftLayer_Virtual_DedicatedHost record. diff --git a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getPciDeviceAllocationStatus.md b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getPciDeviceAllocationStatus.md index 085974fe45..ca908257f1 100644 --- a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getPciDeviceAllocationStatus.md +++ b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getPciDeviceAllocationStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_DedicatedHost](/reference/services/SoftLayer_Virtual_DedicatedHost)::getPciDeviceAllocationStatus + Retrieve the container that represents PCI device allocations on the dedicated host. diff --git a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getPciDevices.md b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getPciDevices.md index 9204030c8f..d4edc19671 100644 --- a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getPciDevices.md +++ b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getPciDevices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_DedicatedHost](/reference/services/SoftLayer_Virtual_DedicatedHost)::getPciDevices + Retrieve a collection of SoftLayer_Virtual_Host_PciDevice objects on the host. diff --git a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getTagReferences.md b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getTagReferences.md index de5d1c0b3e..5e22cff8b3 100644 --- a/content/reference/services/SoftLayer_Virtual_DedicatedHost/getTagReferences.md +++ b/content/reference/services/SoftLayer_Virtual_DedicatedHost/getTagReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_DedicatedHost/setTags.md b/content/reference/services/SoftLayer_Virtual_DedicatedHost/setTags.md index 0032582922..33d3be3fea 100644 --- a/content/reference/services/SoftLayer_Virtual_DedicatedHost/setTags.md +++ b/content/reference/services/SoftLayer_Virtual_DedicatedHost/setTags.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/_index.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/_index.md index b8c9378aa6..21dde62376 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/_index.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,150 +44,175 @@ classes: #### [editObject](/reference/services/SoftLayer_Virtual_Disk_Image/editObject) +
              #### [getAvailableBootModes](/reference/services/SoftLayer_Virtual_Disk_Image/getAvailableBootModes) +
              #### [getBillingItem](/reference/services/SoftLayer_Virtual_Disk_Image/getBillingItem) Retrieve the billing item for a virtual disk image. +
              #### [getBlockDevices](/reference/services/SoftLayer_Virtual_Disk_Image/getBlockDevices) Retrieve the block devices that a disk image is attached to. Block devices connect computing instances to disk images. +
              #### [getBootableVolumeFlag](/reference/services/SoftLayer_Virtual_Disk_Image/getBootableVolumeFlag) +
              #### [getCloudInitFlag](/reference/services/SoftLayer_Virtual_Disk_Image/getCloudInitFlag) Retrieve check if cloud-init is enabled. +
              #### [getCoalescedDiskImages](/reference/services/SoftLayer_Virtual_Disk_Image/getCoalescedDiskImages) +
              #### [getCopyOnWriteFlag](/reference/services/SoftLayer_Virtual_Disk_Image/getCopyOnWriteFlag) +
              #### [getDiskFileExtension](/reference/services/SoftLayer_Virtual_Disk_Image/getDiskFileExtension) Retrieve return disk file extension +
              #### [getDiskImageStorageGroup](/reference/services/SoftLayer_Virtual_Disk_Image/getDiskImageStorageGroup) +
              #### [getImportedDiskType](/reference/services/SoftLayer_Virtual_Disk_Image/getImportedDiskType) Retrieve return imported disk type +
              #### [getIsEncrypted](/reference/services/SoftLayer_Virtual_Disk_Image/getIsEncrypted) Retrieve return if image is encrypted +
              #### [getLocalDiskFlag](/reference/services/SoftLayer_Virtual_Disk_Image/getLocalDiskFlag) +
              #### [getMetadataFlag](/reference/services/SoftLayer_Virtual_Disk_Image/getMetadataFlag) Retrieve whether this disk image is meant for storage of custom user data supplied with a Cloud Computing Instance order. +
              #### [getObject](/reference/services/SoftLayer_Virtual_Disk_Image/getObject) Retrieve a SoftLayer_Virtual_Disk_Image record. +
              #### [getPublicIsoImages](/reference/services/SoftLayer_Virtual_Disk_Image/getPublicIsoImages) Retrieves images from the public ISO repository. +
              #### [getSoftwareReferences](/reference/services/SoftLayer_Virtual_Disk_Image/getSoftwareReferences) Retrieve references to the software that resides on a disk image. +
              #### [getSourceDiskImage](/reference/services/SoftLayer_Virtual_Disk_Image/getSourceDiskImage) Retrieve the original disk image that the current disk image was cloned from. +
              #### [getStorageGroupDetails](/reference/services/SoftLayer_Virtual_Disk_Image/getStorageGroupDetails) Retrieve return storage group details for symantec disk +
              #### [getStorageGroups](/reference/services/SoftLayer_Virtual_Disk_Image/getStorageGroups) Retrieve the storage group for a virtual disk image. +
              #### [getStorageRepository](/reference/services/SoftLayer_Virtual_Disk_Image/getStorageRepository) Retrieve the storage repository that a disk image resides in. +
              #### [getStorageRepositoryType](/reference/services/SoftLayer_Virtual_Disk_Image/getStorageRepositoryType) Retrieve the type of storage repository that a disk image resides in. +
              #### [getSupportedHardware](/reference/services/SoftLayer_Virtual_Disk_Image/getSupportedHardware) Retrieve return supported hardware component IDs for symantec disk +
              #### [getTemplateBlockDevice](/reference/services/SoftLayer_Virtual_Disk_Image/getTemplateBlockDevice) Retrieve the template that attaches a disk image to a [SoftLayer_Virtual_Guest_Block_Device_Template_Group]({{}}). +
              #### [getType](/reference/services/SoftLayer_Virtual_Disk_Image/getType) Retrieve a virtual disk image's type. +
              diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/editObject.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/editObject.md index 969b1578c7..b5ff302fd1 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/editObject.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getAvailableBootModes.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getAvailableBootModes.md index fe4ccde6b0..d015f15874 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getAvailableBootModes.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getAvailableBootModes.md @@ -16,6 +16,7 @@ aliases: + ## Overview Returns a collection of boot modes that are supported for primary disks. diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getBillingItem.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getBillingItem.md index d241b794a0..98d88bec28 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getBillingItem.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Disk_Image](/reference/services/SoftLayer_Virtual_Disk_Image)::getBillingItem + Retrieve the billing item for a virtual disk image. diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getBlockDevices.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getBlockDevices.md index 9690405542..8f44e30a71 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getBlockDevices.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getBlockDevices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Disk_Image](/reference/services/SoftLayer_Virtual_Disk_Image)::getBlockDevices + Retrieve the block devices that a disk image is attached to. Block devices connect computing instances to disk images. diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getBootableVolumeFlag.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getBootableVolumeFlag.md index f2aa20fcc5..f7bb908809 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getBootableVolumeFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getBootableVolumeFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getCloudInitFlag.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getCloudInitFlag.md index 8ebe3d1048..e7045a789e 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getCloudInitFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getCloudInitFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Disk_Image](/reference/services/SoftLayer_Virtual_Disk_Image)::getCloudInitFlag + Retrieve check if cloud-init is enabled. diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getCoalescedDiskImages.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getCoalescedDiskImages.md index af81a707ad..341f8b016c 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getCoalescedDiskImages.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getCoalescedDiskImages.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getCopyOnWriteFlag.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getCopyOnWriteFlag.md index cb29212b9c..9e141172c6 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getCopyOnWriteFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getCopyOnWriteFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getDiskFileExtension.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getDiskFileExtension.md index ec401817ed..847fd204be 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getDiskFileExtension.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getDiskFileExtension.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Disk_Image](/reference/services/SoftLayer_Virtual_Disk_Image)::getDiskFileExtension + Retrieve return disk file extension diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getDiskImageStorageGroup.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getDiskImageStorageGroup.md index f27a0107ae..37261b10be 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getDiskImageStorageGroup.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getDiskImageStorageGroup.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getImportedDiskType.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getImportedDiskType.md index 954afae9d2..16b2cf7b40 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getImportedDiskType.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getImportedDiskType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Disk_Image](/reference/services/SoftLayer_Virtual_Disk_Image)::getImportedDiskType + Retrieve return imported disk type diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getIsEncrypted.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getIsEncrypted.md index 4650535d39..47c37863f1 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getIsEncrypted.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getIsEncrypted.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Disk_Image](/reference/services/SoftLayer_Virtual_Disk_Image)::getIsEncrypted + Retrieve return if image is encrypted diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getLocalDiskFlag.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getLocalDiskFlag.md index a70bd521bf..f27eb0e761 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getLocalDiskFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getLocalDiskFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getMetadataFlag.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getMetadataFlag.md index 30d12b3c7b..abb6b7328e 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getMetadataFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getMetadataFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Disk_Image](/reference/services/SoftLayer_Virtual_Disk_Image)::getMetadataFlag + Retrieve whether this disk image is meant for storage of custom user data supplied with a Cloud Computing Instance order. diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getObject.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getObject.md index 766960a597..5665676e31 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getObject.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Disk_Image](/reference/services/SoftLayer_Virtual_Disk_Image)::getObject + Retrieve a SoftLayer_Virtual_Disk_Image record. diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getPublicIsoImages.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getPublicIsoImages.md index af0128dbc9..4160d77d28 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getPublicIsoImages.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getPublicIsoImages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Disk_Image](/reference/services/SoftLayer_Virtual_Disk_Image)::getPublicIsoImages + Retrieves images from the public ISO repository. diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getSoftwareReferences.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getSoftwareReferences.md index ecc93d6a87..e0bb0a3e47 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getSoftwareReferences.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getSoftwareReferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Disk_Image](/reference/services/SoftLayer_Virtual_Disk_Image)::getSoftwareReferences + Retrieve references to the software that resides on a disk image. diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getSourceDiskImage.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getSourceDiskImage.md index a87e861d3c..79e3225350 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getSourceDiskImage.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getSourceDiskImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Disk_Image](/reference/services/SoftLayer_Virtual_Disk_Image)::getSourceDiskImage + Retrieve the original disk image that the current disk image was cloned from. diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getStorageGroupDetails.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getStorageGroupDetails.md index bc3ac32190..f2348f4e13 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getStorageGroupDetails.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getStorageGroupDetails.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Disk_Image](/reference/services/SoftLayer_Virtual_Disk_Image)::getStorageGroupDetails + Retrieve return storage group details for symantec disk diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getStorageGroups.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getStorageGroups.md index 8136911613..9ff410fb7c 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getStorageGroups.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getStorageGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Disk_Image](/reference/services/SoftLayer_Virtual_Disk_Image)::getStorageGroups + Retrieve the storage group for a virtual disk image. diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getStorageRepository.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getStorageRepository.md index 9dcb16822b..c5eefae789 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getStorageRepository.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getStorageRepository.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Disk_Image](/reference/services/SoftLayer_Virtual_Disk_Image)::getStorageRepository + Retrieve the storage repository that a disk image resides in. diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getStorageRepositoryType.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getStorageRepositoryType.md index 6a055b8ccb..38c761274d 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getStorageRepositoryType.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getStorageRepositoryType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Disk_Image](/reference/services/SoftLayer_Virtual_Disk_Image)::getStorageRepositoryType + Retrieve the type of storage repository that a disk image resides in. diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getSupportedHardware.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getSupportedHardware.md index ddf7d7f036..80c8d4c531 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getSupportedHardware.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getSupportedHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Disk_Image](/reference/services/SoftLayer_Virtual_Disk_Image)::getSupportedHardware + Retrieve return supported hardware component IDs for symantec disk diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getTemplateBlockDevice.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getTemplateBlockDevice.md index be9c94eb4c..d83f30244f 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getTemplateBlockDevice.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getTemplateBlockDevice.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Disk_Image](/reference/services/SoftLayer_Virtual_Disk_Image)::getTemplateBlockDevice + Retrieve the template that attaches a disk image to a [SoftLayer_Virtual_Guest_Block_Device_Template_Group]({{}}). diff --git a/content/reference/services/SoftLayer_Virtual_Disk_Image/getType.md b/content/reference/services/SoftLayer_Virtual_Disk_Image/getType.md index a850fb17a9..5fe1fb924e 100644 --- a/content/reference/services/SoftLayer_Virtual_Disk_Image/getType.md +++ b/content/reference/services/SoftLayer_Virtual_Disk_Image/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Disk_Image](/reference/services/SoftLayer_Virtual_Disk_Image)::getType + Retrieve a virtual disk image's type. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/_index.md b/content/reference/services/SoftLayer_Virtual_Guest/_index.md index 052c83fe46..44567cf3b8 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/_index.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) service's control over physical hardware purchased form SoftLayer. @@ -42,1230 +44,1438 @@ The virtual guest service provides a common interface to any virtualization plat #### [activatePrivatePort](/reference/services/SoftLayer_Virtual_Guest/activatePrivatePort) Activate the private port +
              #### [activatePublicPort](/reference/services/SoftLayer_Virtual_Guest/activatePublicPort) Activate the public port +
              #### [allowAccessToNetworkStorage](/reference/services/SoftLayer_Virtual_Guest/allowAccessToNetworkStorage) Allow access to a SoftLayer_Network_Storage volume from this device. +
              #### [allowAccessToNetworkStorageList](/reference/services/SoftLayer_Virtual_Guest/allowAccessToNetworkStorageList) Allow access to multiple SoftLayer_Network_Storage volumes from this device. +
              #### [attachDiskImage](/reference/services/SoftLayer_Virtual_Guest/attachDiskImage) Attaches a disk image. +
              #### [cancelIsolationForDestructiveAction](/reference/services/SoftLayer_Virtual_Guest/cancelIsolationForDestructiveAction) +
              #### [captureImage](/reference/services/SoftLayer_Virtual_Guest/captureImage) Captures a Flex Image of the hard disk on the virtual machine. +
              #### [checkHostDiskAvailability](/reference/services/SoftLayer_Virtual_Guest/checkHostDiskAvailability) +
              #### [configureMetadataDisk](/reference/services/SoftLayer_Virtual_Guest/configureMetadataDisk) Configures the guest's metadata disk. +
              #### [createArchiveTemplate](/reference/services/SoftLayer_Virtual_Guest/createArchiveTemplate) [SoftLayer_Virtual_Guest_Block_Devices]({{}}) can be grouped together in and backed up in an archive for later use. This method generates a transaction to perform an archive of the provided block devices. +
              -
              +
              #### [createArchiveTransaction](/reference/services/SoftLayer_Virtual_Guest/createArchiveTransaction) [SoftLayer_Virtual_Guest_Block_Device]({{}}) can be grouped together in and backed up in an archive for later use. This method generates a transaction to perform an archive of the provided block devices. + +Deprecated + +
              #### [createObject](/reference/services/SoftLayer_Virtual_Guest/createObject) Create a new computing instance +
              #### [createObjects](/reference/services/SoftLayer_Virtual_Guest/createObjects) Create new computing instances +
              #### [createPostSoftwareInstallTransaction](/reference/services/SoftLayer_Virtual_Guest/createPostSoftwareInstallTransaction) +
              #### [deleteObject](/reference/services/SoftLayer_Virtual_Guest/deleteObject) Delete a computing instance +
              #### [deleteTag](/reference/services/SoftLayer_Virtual_Guest/deleteTag) Delete a tag +
              #### [deleteTransientWebhook](/reference/services/SoftLayer_Virtual_Guest/deleteTransientWebhook) +
              #### [detachDiskImage](/reference/services/SoftLayer_Virtual_Guest/detachDiskImage) Detaches a disk image. +
              #### [editObject](/reference/services/SoftLayer_Virtual_Guest/editObject) Edit a computing instance's properties +
              #### [executeIderaBareMetalRestore](/reference/services/SoftLayer_Virtual_Guest/executeIderaBareMetalRestore) Reboot a guest into the Idera Bare Metal Restore image. +
              #### [executeR1SoftBareMetalRestore](/reference/services/SoftLayer_Virtual_Guest/executeR1SoftBareMetalRestore) Reboot a guest into the R1Soft Bare Metal Restore image. +
              #### [executeRemoteScript](/reference/services/SoftLayer_Virtual_Guest/executeRemoteScript) Download and run remote script from uri on the virtual guest. Requires https for script to be executed after download. +
              #### [executeRescueLayer](/reference/services/SoftLayer_Virtual_Guest/executeRescueLayer) Reboot a Linux guest into the Xen rescue image. +
              #### [findByHostname](/reference/services/SoftLayer_Virtual_Guest/findByHostname) +
              #### [findByIpAddress](/reference/services/SoftLayer_Virtual_Guest/findByIpAddress) Find CCI by its primary public or private IP (ipv4) address. +
              #### [generateOrderTemplate](/reference/services/SoftLayer_Virtual_Guest/generateOrderTemplate) Obtain an order container for a given template object +
              #### [getAccount](/reference/services/SoftLayer_Virtual_Guest/getAccount) Retrieve the account that a virtual guest belongs to. +
              #### [getAccountOwnedPoolFlag](/reference/services/SoftLayer_Virtual_Guest/getAccountOwnedPoolFlag) +
              #### [getActiveNetworkMonitorIncident](/reference/services/SoftLayer_Virtual_Guest/getActiveNetworkMonitorIncident) Retrieve a virtual guest's currently active network monitoring incidents. +
              #### [getActiveTickets](/reference/services/SoftLayer_Virtual_Guest/getActiveTickets) +
              #### [getActiveTransaction](/reference/services/SoftLayer_Virtual_Guest/getActiveTransaction) Retrieve a transaction that is still be performed on a cloud server. +
              #### [getActiveTransactions](/reference/services/SoftLayer_Virtual_Guest/getActiveTransactions) Retrieve any active transaction(s) that are currently running for the server (example: os reload). +
              #### [getAdditionalRequiredPricesForOsReload](/reference/services/SoftLayer_Virtual_Guest/getAdditionalRequiredPricesForOsReload) Return a collection of SoftLayer_Item_Price objects for an OS reload +
              #### [getAllowedHost](/reference/services/SoftLayer_Virtual_Guest/getAllowedHost) Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual Guest to Network Storage volumes that require access control lists. +
              #### [getAllowedNetworkStorage](/reference/services/SoftLayer_Virtual_Guest/getAllowedNetworkStorage) Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to. +
              #### [getAllowedNetworkStorageReplicas](/reference/services/SoftLayer_Virtual_Guest/getAllowedNetworkStorageReplicas) Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to. +
              #### [getAntivirusSpywareSoftwareComponent](/reference/services/SoftLayer_Virtual_Guest/getAntivirusSpywareSoftwareComponent) Retrieve a antivirus / spyware software component object. +
              #### [getApplicationDeliveryController](/reference/services/SoftLayer_Virtual_Guest/getApplicationDeliveryController) +
              #### [getAttachedNetworkStorages](/reference/services/SoftLayer_Virtual_Guest/getAttachedNetworkStorages) Return a list of SoftLayer_Network_Storage volumes authorized to this device. +
              #### [getAttributes](/reference/services/SoftLayer_Virtual_Guest/getAttributes) +
              #### [getAvailableBlockDevicePositions](/reference/services/SoftLayer_Virtual_Guest/getAvailableBlockDevicePositions) +
              #### [getAvailableMonitoring](/reference/services/SoftLayer_Virtual_Guest/getAvailableMonitoring) Retrieve an object that stores the maximum level for the monitoring query types and response types. +
              #### [getAvailableNetworkStorages](/reference/services/SoftLayer_Virtual_Guest/getAvailableNetworkStorages) Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. +
              #### [getAverageDailyPrivateBandwidthUsage](/reference/services/SoftLayer_Virtual_Guest/getAverageDailyPrivateBandwidthUsage) Retrieve the average daily private bandwidth usage for the current billing cycle. +
              #### [getAverageDailyPublicBandwidthUsage](/reference/services/SoftLayer_Virtual_Guest/getAverageDailyPublicBandwidthUsage) Retrieve the average daily public bandwidth usage for the current billing cycle. +
              #### [getBackendNetworkComponents](/reference/services/SoftLayer_Virtual_Guest/getBackendNetworkComponents) Retrieve a guests's backend network components. +
              #### [getBackendRouters](/reference/services/SoftLayer_Virtual_Guest/getBackendRouters) Retrieve a guest's backend or private router. +
              #### [getBandwidthAllocation](/reference/services/SoftLayer_Virtual_Guest/getBandwidthAllocation) Retrieve a computing instance's allotted bandwidth (measured in GB). +
              #### [getBandwidthAllotmentDetail](/reference/services/SoftLayer_Virtual_Guest/getBandwidthAllotmentDetail) Retrieve a computing instance's allotted detail record. Allotment details link bandwidth allocation with allotments. +
              #### [getBandwidthDataByDate](/reference/services/SoftLayer_Virtual_Guest/getBandwidthDataByDate) Retrieve the amount of network traffic that occurred for the specified time frame for a computing instance. +
              #### [getBandwidthForDateRange](/reference/services/SoftLayer_Virtual_Guest/getBandwidthForDateRange) Retrieve bandwidth data from a tracking object. +
              #### [getBandwidthImage](/reference/services/SoftLayer_Virtual_Guest/getBandwidthImage) Retrieve a visual representation of the amount of network traffic that occurred for the specified time frame for a computing instance. +
              #### [getBandwidthImageByDate](/reference/services/SoftLayer_Virtual_Guest/getBandwidthImageByDate) Retrieve a visual representation of the amount of network traffic that occurred for the specified time frame for a computing instance. +
              #### [getBandwidthTotal](/reference/services/SoftLayer_Virtual_Guest/getBandwidthTotal) Retrieve total amount of network traffic that was in use during the time specified by the input parameters for a computing instance. +
              #### [getBillingCycleBandwidthUsage](/reference/services/SoftLayer_Virtual_Guest/getBillingCycleBandwidthUsage) Retrieve the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. +
              #### [getBillingCyclePrivateBandwidthUsage](/reference/services/SoftLayer_Virtual_Guest/getBillingCyclePrivateBandwidthUsage) Retrieve the raw private bandwidth usage data for the current billing cycle. +
              #### [getBillingCyclePublicBandwidthUsage](/reference/services/SoftLayer_Virtual_Guest/getBillingCyclePublicBandwidthUsage) Retrieve the raw public bandwidth usage data for the current billing cycle. +
              #### [getBillingItem](/reference/services/SoftLayer_Virtual_Guest/getBillingItem) Retrieve the billing item for a CloudLayer Compute Instance. +
              #### [getBlockCancelBecauseDisconnectedFlag](/reference/services/SoftLayer_Virtual_Guest/getBlockCancelBecauseDisconnectedFlag) Retrieve determines whether the instance is ineligible for cancellation because it is disconnected. +
              #### [getBlockDeviceTemplateGroup](/reference/services/SoftLayer_Virtual_Guest/getBlockDeviceTemplateGroup) Retrieve the global identifier for the image template that was used to provision or reload a guest. +
              #### [getBlockDevices](/reference/services/SoftLayer_Virtual_Guest/getBlockDevices) Retrieve a computing instance's block devices. Block devices link [SoftLayer_Virtual_Disk_Image]({{}}) to computing instances. +
              #### [getBootMode](/reference/services/SoftLayer_Virtual_Guest/getBootMode) Retrieves the boot mode of the VSI. +
              #### [getBootOrder](/reference/services/SoftLayer_Virtual_Guest/getBootOrder) +
              #### [getBrowserConsoleAccessLogs](/reference/services/SoftLayer_Virtual_Guest/getBrowserConsoleAccessLogs) Retrieve a virtual guest's browser access logs. +
              #### [getConsoleAccessLog](/reference/services/SoftLayer_Virtual_Guest/getConsoleAccessLog) get console access logs +
              #### [getConsoleData](/reference/services/SoftLayer_Virtual_Guest/getConsoleData) Retrieve a container for a guest's console data +
              #### [getConsoleIpAddressFlag](/reference/services/SoftLayer_Virtual_Guest/getConsoleIpAddressFlag) Retrieve a flag indicating a computing instance's console IP address is assigned. +
              #### [getConsoleIpAddressRecord](/reference/services/SoftLayer_Virtual_Guest/getConsoleIpAddressRecord) Retrieve a record containing information about a computing instance's console IP and port number. +
              #### [getContinuousDataProtectionSoftwareComponent](/reference/services/SoftLayer_Virtual_Guest/getContinuousDataProtectionSoftwareComponent) Retrieve a continuous data protection software component object. +
              #### [getControlPanel](/reference/services/SoftLayer_Virtual_Guest/getControlPanel) Retrieve a guest's control panel. +
              #### [getCoreRestrictedOperatingSystemPrice](/reference/services/SoftLayer_Virtual_Guest/getCoreRestrictedOperatingSystemPrice) Return the associated core-restricted operating system item price for the virtual server. +
              #### [getCpuMetricDataByDate](/reference/services/SoftLayer_Virtual_Guest/getCpuMetricDataByDate) Retrieve records containing the percentage of the amount of time that a cpu was in use for the specified time frame for a computing instance. +
              #### [getCpuMetricImage](/reference/services/SoftLayer_Virtual_Guest/getCpuMetricImage) Retrieve a visual representation of the percentage of the amount of time that a cpu was in use for the specified time frame for a computing instance. +
              #### [getCpuMetricImageByDate](/reference/services/SoftLayer_Virtual_Guest/getCpuMetricImageByDate) Retrieve a visual representation of the percentage of the amount of time that a cpu was in use for the specified time frame for a computing instance. +
              #### [getCreateObjectOptions](/reference/services/SoftLayer_Virtual_Guest/getCreateObjectOptions) Determine options available when creating a computing instance +
              #### [getCurrentBandwidthSummary](/reference/services/SoftLayer_Virtual_Guest/getCurrentBandwidthSummary) Retrieve an object that provides commonly used bandwidth summary components for the current billing cycle. +
              #### [getCurrentBillingDetail](/reference/services/SoftLayer_Virtual_Guest/getCurrentBillingDetail) << EOT +
              #### [getCurrentBillingTotal](/reference/services/SoftLayer_Virtual_Guest/getCurrentBillingTotal) Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges. +
              #### [getCustomBandwidthDataByDate](/reference/services/SoftLayer_Virtual_Guest/getCustomBandwidthDataByDate) Retrieve bandwidth graph by date. +
              #### [getCustomMetricDataByDate](/reference/services/SoftLayer_Virtual_Guest/getCustomMetricDataByDate) Retrieve bandwidth graph by date. +
              #### [getDatacenter](/reference/services/SoftLayer_Virtual_Guest/getDatacenter) Retrieve the datacenter that a virtual guest resides in. +
              #### [getDedicatedHost](/reference/services/SoftLayer_Virtual_Guest/getDedicatedHost) Retrieve the dedicated host associated with this guest. +
              #### [getDriveRetentionItemPrice](/reference/services/SoftLayer_Virtual_Guest/getDriveRetentionItemPrice) Return a drive retention SoftLayer_Item_Price object for a guest. +
              #### [getEvaultNetworkStorage](/reference/services/SoftLayer_Virtual_Guest/getEvaultNetworkStorage) Retrieve a guest's associated EVault network storage service account. +
              #### [getFirewallProtectableSubnets](/reference/services/SoftLayer_Virtual_Guest/getFirewallProtectableSubnets) Get the subnets associated with this CloudLayer computing instance that are protectable by a network component firewall. +
              #### [getFirewallServiceComponent](/reference/services/SoftLayer_Virtual_Guest/getFirewallServiceComponent) Retrieve a computing instance's hardware firewall services. +
              #### [getFirstAvailableBlockDevicePosition](/reference/services/SoftLayer_Virtual_Guest/getFirstAvailableBlockDevicePosition) +
              #### [getFrontendNetworkComponents](/reference/services/SoftLayer_Virtual_Guest/getFrontendNetworkComponents) Retrieve a guest's frontend network components. +
              #### [getFrontendRouters](/reference/services/SoftLayer_Virtual_Guest/getFrontendRouters) Retrieve a guest's frontend or public router. +
              #### [getGlobalIdentifier](/reference/services/SoftLayer_Virtual_Guest/getGlobalIdentifier) Retrieve a guest's universally unique identifier. +
              #### [getGpuCount](/reference/services/SoftLayer_Virtual_Guest/getGpuCount) Retrieve the number of GPUs attached to the guest. +
              #### [getGpuType](/reference/services/SoftLayer_Virtual_Guest/getGpuType) Retrieve the name of the GPU type attached to the guest. +
              #### [getGuestBootParameter](/reference/services/SoftLayer_Virtual_Guest/getGuestBootParameter) +
              #### [getHardwareFunctionDescription](/reference/services/SoftLayer_Virtual_Guest/getHardwareFunctionDescription) Retrieve the object's function. +
              #### [getHost](/reference/services/SoftLayer_Virtual_Guest/getHost) Retrieve the virtual host on which a virtual guest resides (available only on private clouds). +
              #### [getHostIpsSoftwareComponent](/reference/services/SoftLayer_Virtual_Guest/getHostIpsSoftwareComponent) Retrieve a host IPS software component object. +
              #### [getHourlyBillingFlag](/reference/services/SoftLayer_Virtual_Guest/getHourlyBillingFlag) Retrieve a guest's hourly billing status. +
              #### [getInboundPrivateBandwidthUsage](/reference/services/SoftLayer_Virtual_Guest/getInboundPrivateBandwidthUsage) Retrieve the total private inbound bandwidth for this computing instance for the current billing cycle. +
              #### [getInboundPublicBandwidthUsage](/reference/services/SoftLayer_Virtual_Guest/getInboundPublicBandwidthUsage) Retrieve the total public inbound bandwidth for this computing instance for the current billing cycle. +
              #### [getInternalTagReferences](/reference/services/SoftLayer_Virtual_Guest/getInternalTagReferences) +
              #### [getIsoBootImage](/reference/services/SoftLayer_Virtual_Guest/getIsoBootImage) +
              #### [getItemPricesFromSoftwareDescriptions](/reference/services/SoftLayer_Virtual_Guest/getItemPricesFromSoftwareDescriptions) Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description +
              #### [getLastKnownPowerState](/reference/services/SoftLayer_Virtual_Guest/getLastKnownPowerState) Retrieve the last known power state of a virtual guest in the event the guest is turned off outside of IMS or has gone offline. +
              #### [getLastOperatingSystemReload](/reference/services/SoftLayer_Virtual_Guest/getLastOperatingSystemReload) Retrieve the last transaction that a cloud server's operating system was loaded. +
              #### [getLastTransaction](/reference/services/SoftLayer_Virtual_Guest/getLastTransaction) Retrieve the last transaction a cloud server had performed. +
              #### [getLatestNetworkMonitorIncident](/reference/services/SoftLayer_Virtual_Guest/getLatestNetworkMonitorIncident) Retrieve a virtual guest's latest network monitoring incident. +
              #### [getLocalDiskFlag](/reference/services/SoftLayer_Virtual_Guest/getLocalDiskFlag) Retrieve a flag indicating that the virtual guest has at least one disk which is local to the host it runs on. This does not include a SWAP device. +
              #### [getLocation](/reference/services/SoftLayer_Virtual_Guest/getLocation) Retrieve where guest is located within SoftLayer's location hierarchy. +
              #### [getManagedResourceFlag](/reference/services/SoftLayer_Virtual_Guest/getManagedResourceFlag) Retrieve a flag indicating that the virtual guest is a managed resource. +
              #### [getMemoryMetricDataByDate](/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricDataByDate) Retrieve records containing the amount memory that was used for the specified time frame for a computing instance. +
              #### [getMemoryMetricImage](/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricImage) Retrieve a visual representation of the amount of memory used for the specified time frame for a computing instance. +
              #### [getMemoryMetricImageByDate](/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricImageByDate) Retrieve a visual representation of the amount of memory used for the specified time frame for a computing instance. +
              #### [getMetricTrackingObject](/reference/services/SoftLayer_Virtual_Guest/getMetricTrackingObject) Retrieve a guest's metric tracking object. +
              #### [getMetricTrackingObjectId](/reference/services/SoftLayer_Virtual_Guest/getMetricTrackingObjectId) Retrieve the metric tracking object id for this guest. +
              #### [getMonitoringRobot](/reference/services/SoftLayer_Virtual_Guest/getMonitoringRobot) +
              #### [getMonitoringServiceComponent](/reference/services/SoftLayer_Virtual_Guest/getMonitoringServiceComponent) Retrieve a virtual guest's network monitoring services. +
              #### [getMonitoringServiceEligibilityFlag](/reference/services/SoftLayer_Virtual_Guest/getMonitoringServiceEligibilityFlag) +
              #### [getMonitoringUserNotification](/reference/services/SoftLayer_Virtual_Guest/getMonitoringUserNotification) Retrieve the monitoring notification objects for this guest. Each object links this guest instance to a user account that will be notified if monitoring on this guest object fails +
              #### [getNetworkComponentFirewallProtectableIpAddresses](/reference/services/SoftLayer_Virtual_Guest/getNetworkComponentFirewallProtectableIpAddresses) Get the IP addresses associated with this CloudLayer computing instance that are protectable by a network component firewall. +
              #### [getNetworkComponents](/reference/services/SoftLayer_Virtual_Guest/getNetworkComponents) Retrieve a guests's network components. +
              #### [getNetworkMonitorIncidents](/reference/services/SoftLayer_Virtual_Guest/getNetworkMonitorIncidents) Retrieve all of a virtual guest's network monitoring incidents. +
              #### [getNetworkMonitors](/reference/services/SoftLayer_Virtual_Guest/getNetworkMonitors) Retrieve a guests's network monitors. +
              #### [getNetworkStorage](/reference/services/SoftLayer_Virtual_Guest/getNetworkStorage) Retrieve a guest's associated network storage accounts. +
              #### [getNetworkVlans](/reference/services/SoftLayer_Virtual_Guest/getNetworkVlans) Retrieve the network Vlans that a guest's network components are associated with. +
              #### [getObject](/reference/services/SoftLayer_Virtual_Guest/getObject) Retrieve a SoftLayer_Virtual_Guest record. +
              #### [getOpenCancellationTicket](/reference/services/SoftLayer_Virtual_Guest/getOpenCancellationTicket) Retrieve an open ticket requesting cancellation of this server, if one exists. +
              #### [getOperatingSystem](/reference/services/SoftLayer_Virtual_Guest/getOperatingSystem) Retrieve a guest's operating system. +
              #### [getOperatingSystemReferenceCode](/reference/services/SoftLayer_Virtual_Guest/getOperatingSystemReferenceCode) Retrieve a guest's operating system software description. +
              #### [getOrderTemplate](/reference/services/SoftLayer_Virtual_Guest/getOrderTemplate) Obtain an order container that is ready to be sent to the [[SoftLayer_Product_Order#placeOrder|SoftLayer_Product_Order::placeOrder]] method. +
              #### [getOrderedPackageId](/reference/services/SoftLayer_Virtual_Guest/getOrderedPackageId) Retrieve the original package id provided with the order for a Cloud Computing Instance. +
              #### [getOutboundPrivateBandwidthUsage](/reference/services/SoftLayer_Virtual_Guest/getOutboundPrivateBandwidthUsage) Retrieve the total private outbound bandwidth for this computing instance for the current billing cycle. +
              #### [getOutboundPublicBandwidthUsage](/reference/services/SoftLayer_Virtual_Guest/getOutboundPublicBandwidthUsage) Retrieve the total public outbound bandwidth for this computing instance for the current billing cycle. +
              #### [getOverBandwidthAllocationFlag](/reference/services/SoftLayer_Virtual_Guest/getOverBandwidthAllocationFlag) Retrieve whether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation. +
              #### [getPendingMaintenanceActions](/reference/services/SoftLayer_Virtual_Guest/getPendingMaintenanceActions) Returns a list of all the pending maintenance actions affecting this guest. +
              #### [getPendingMigrationFlag](/reference/services/SoftLayer_Virtual_Guest/getPendingMigrationFlag) Retrieve when true this virtual guest must be migrated using SoftLayer_Virtual_Guest::migrate. +
              #### [getPlacementGroup](/reference/services/SoftLayer_Virtual_Guest/getPlacementGroup) Retrieve the placement group that a virtual guest belongs to. +
              #### [getPowerState](/reference/services/SoftLayer_Virtual_Guest/getPowerState) Retrieve the current power state of a virtual guest. +
              #### [getPrimaryBackendIpAddress](/reference/services/SoftLayer_Virtual_Guest/getPrimaryBackendIpAddress) Retrieve a guest's primary private IP address. +
              #### [getPrimaryBackendNetworkComponent](/reference/services/SoftLayer_Virtual_Guest/getPrimaryBackendNetworkComponent) Retrieve a guest's primary backend network component. +
              #### [getPrimaryIpAddress](/reference/services/SoftLayer_Virtual_Guest/getPrimaryIpAddress) Retrieve the guest's primary public IP address. +
              #### [getPrimaryNetworkComponent](/reference/services/SoftLayer_Virtual_Guest/getPrimaryNetworkComponent) Retrieve a guest's primary public network component. +
              #### [getPrivateNetworkOnlyFlag](/reference/services/SoftLayer_Virtual_Guest/getPrivateNetworkOnlyFlag) Retrieve whether the computing instance only has access to the private network. +
              #### [getProjectedOverBandwidthAllocationFlag](/reference/services/SoftLayer_Virtual_Guest/getProjectedOverBandwidthAllocationFlag) Retrieve whether the bandwidth usage for this computing instance for the current billing cycle is projected to exceed the allocation. +
              #### [getProjectedPublicBandwidthUsage](/reference/services/SoftLayer_Virtual_Guest/getProjectedPublicBandwidthUsage) Retrieve the projected public outbound bandwidth for this computing instance for the current billing cycle. +
              #### [getProvisionDate](/reference/services/SoftLayer_Virtual_Guest/getProvisionDate) +
              #### [getRecentEvents](/reference/services/SoftLayer_Virtual_Guest/getRecentEvents) Retrieve recent events that impact this computing instance. +
              #### [getRecentMetricData](/reference/services/SoftLayer_Virtual_Guest/getRecentMetricData) Recent metric data for a guest +
              #### [getRegionalGroup](/reference/services/SoftLayer_Virtual_Guest/getRegionalGroup) Retrieve the regional group this guest is in. +
              #### [getRegionalInternetRegistry](/reference/services/SoftLayer_Virtual_Guest/getRegionalInternetRegistry) +
              #### [getReservedCapacityGroup](/reference/services/SoftLayer_Virtual_Guest/getReservedCapacityGroup) Retrieve the reserved capacity group the guest is associated with. +
              #### [getReservedCapacityGroupFlag](/reference/services/SoftLayer_Virtual_Guest/getReservedCapacityGroupFlag) Retrieve flag to indicate whether or not a guest is part of a reserved capacity group. +
              #### [getReservedCapacityGroupInstance](/reference/services/SoftLayer_Virtual_Guest/getReservedCapacityGroupInstance) Retrieve the reserved capacity group instance the guest is associated with. +
              #### [getReverseDomainRecords](/reference/services/SoftLayer_Virtual_Guest/getReverseDomainRecords) Retrieve the reverse domain records associated with a server. +
              #### [getScaleAssets](/reference/services/SoftLayer_Virtual_Guest/getScaleAssets) Retrieve collection of scale assets this guest corresponds to. +
              #### [getScaleMember](/reference/services/SoftLayer_Virtual_Guest/getScaleMember) Retrieve the scale member for this guest, if applicable. +
              #### [getScaledFlag](/reference/services/SoftLayer_Virtual_Guest/getScaledFlag) Retrieve whether or not this guest is a member of a scale group and was automatically created as part of a scale group action. +
              #### [getSecurityScanRequests](/reference/services/SoftLayer_Virtual_Guest/getSecurityScanRequests) Retrieve a guest's vulnerability scan requests. +
              #### [getServerRoom](/reference/services/SoftLayer_Virtual_Guest/getServerRoom) Retrieve the server room that a guest is located at. There may be more than one server room for every data center. +
              #### [getSoftwareComponents](/reference/services/SoftLayer_Virtual_Guest/getSoftwareComponents) Retrieve a guest's installed software. +
              #### [getSshKeys](/reference/services/SoftLayer_Virtual_Guest/getSshKeys) Retrieve sSH keys to be installed on the server during provisioning or an OS reload. +
              #### [getStatus](/reference/services/SoftLayer_Virtual_Guest/getStatus) Retrieve a computing instance's status. +
              #### [getTagReferences](/reference/services/SoftLayer_Virtual_Guest/getTagReferences) +
              #### [getTransientGuestFlag](/reference/services/SoftLayer_Virtual_Guest/getTransientGuestFlag) Retrieve whether or not a computing instance is a Transient Instance. +
              #### [getTransientWebhookURI](/reference/services/SoftLayer_Virtual_Guest/getTransientWebhookURI) Retrieve the endpoint used to notify customers their transient guest is terminating. +
              #### [getType](/reference/services/SoftLayer_Virtual_Guest/getType) Retrieve the type of this virtual guest. +
              #### [getUpgradeItemPrices](/reference/services/SoftLayer_Virtual_Guest/getUpgradeItemPrices) Retrieve a computing instance's upgradeable items. +
              #### [getUpgradeRequest](/reference/services/SoftLayer_Virtual_Guest/getUpgradeRequest) Retrieve a computing instance's associated upgrade request object if any. +
              #### [getUserData](/reference/services/SoftLayer_Virtual_Guest/getUserData) Retrieve a base64 encoded string containing custom user data for a Cloud Computing Instance order. +
              #### [getUsers](/reference/services/SoftLayer_Virtual_Guest/getUsers) Retrieve a list of users that have access to this computing instance. +
              #### [getValidBlockDeviceTemplateGroups](/reference/services/SoftLayer_Virtual_Guest/getValidBlockDeviceTemplateGroups) Return a list of valid block device template groups based on this host +
              #### [getVirtualRack](/reference/services/SoftLayer_Virtual_Guest/getVirtualRack) Retrieve the name of the bandwidth allotment that a hardware belongs too. +
              #### [getVirtualRackId](/reference/services/SoftLayer_Virtual_Guest/getVirtualRackId) Retrieve the id of the bandwidth allotment that a computing instance belongs too. +
              #### [getVirtualRackName](/reference/services/SoftLayer_Virtual_Guest/getVirtualRackName) Retrieve the name of the bandwidth allotment that a computing instance belongs too. +
              #### [isBackendPingable](/reference/services/SoftLayer_Virtual_Guest/isBackendPingable) Verifies if a guest's backend ip address is pingable. +
              #### [isCloudInit](/reference/services/SoftLayer_Virtual_Guest/isCloudInit) Determines if the virtual guest was provisioned from a cloud-init enabled image. +
              #### [isPingable](/reference/services/SoftLayer_Virtual_Guest/isPingable) Verifies if guest is pingable. +
              #### [isolateInstanceForDestructiveAction](/reference/services/SoftLayer_Virtual_Guest/isolateInstanceForDestructiveAction) +
              #### [migrate](/reference/services/SoftLayer_Virtual_Guest/migrate) Creates a transaction to migrate a virtual guest to a new host. NOTE: Will only migrate if SoftLayer_Virtual_Guest property pendingMigrationFlag = true +
              #### [migrateDedicatedHost](/reference/services/SoftLayer_Virtual_Guest/migrateDedicatedHost) Migrate a dedicated instance from one dedicated host to another dedicated host +
              #### [mountIsoImage](/reference/services/SoftLayer_Virtual_Guest/mountIsoImage) +
              #### [pause](/reference/services/SoftLayer_Virtual_Guest/pause) Pause a guest. +
              #### [powerCycle](/reference/services/SoftLayer_Virtual_Guest/powerCycle) Power cycle a guest. +
              #### [powerOff](/reference/services/SoftLayer_Virtual_Guest/powerOff) Power off a guest. +
              #### [powerOffSoft](/reference/services/SoftLayer_Virtual_Guest/powerOffSoft) Cleanly shut down a guest and disable power +
              #### [powerOn](/reference/services/SoftLayer_Virtual_Guest/powerOn) Power on a guest. +
              #### [rebootDefault](/reference/services/SoftLayer_Virtual_Guest/rebootDefault) Power cycle a guest. +
              #### [rebootHard](/reference/services/SoftLayer_Virtual_Guest/rebootHard) Power cycle a guest. +
              #### [rebootSoft](/reference/services/SoftLayer_Virtual_Guest/rebootSoft) Attempt to complete a soft reboot of a guest by shutting down the operating system. +
              #### [reloadCurrentOperatingSystemConfiguration](/reference/services/SoftLayer_Virtual_Guest/reloadCurrentOperatingSystemConfiguration) Perform an OS reload +
              #### [reloadOperatingSystem](/reference/services/SoftLayer_Virtual_Guest/reloadOperatingSystem) Reloads operating system configuration. +
              #### [removeAccessToNetworkStorage](/reference/services/SoftLayer_Virtual_Guest/removeAccessToNetworkStorage) Remove access to a SoftLayer_Network_Storage volume from this device. +
              #### [removeAccessToNetworkStorageList](/reference/services/SoftLayer_Virtual_Guest/removeAccessToNetworkStorageList) Remove access to multiple SoftLayer_Network_Storage volumes from this device. +
              #### [removeTags](/reference/services/SoftLayer_Virtual_Guest/removeTags) Remove a tag reference +
              #### [resume](/reference/services/SoftLayer_Virtual_Guest/resume) Resume a guest. +
              #### [sendTestReclaimScheduledAlert](/reference/services/SoftLayer_Virtual_Guest/sendTestReclaimScheduledAlert) +
              #### [setPrivateNetworkInterfaceSpeed](/reference/services/SoftLayer_Virtual_Guest/setPrivateNetworkInterfaceSpeed) Updates the private network interface (eth0) speed. +
              #### [setPublicNetworkInterfaceSpeed](/reference/services/SoftLayer_Virtual_Guest/setPublicNetworkInterfaceSpeed) Updates the public network interface (eth1) speed. +
              #### [setTags](/reference/services/SoftLayer_Virtual_Guest/setTags) +
              #### [setTransientWebhook](/reference/services/SoftLayer_Virtual_Guest/setTransientWebhook) +
              #### [setUserMetadata](/reference/services/SoftLayer_Virtual_Guest/setUserMetadata) Configures the guest's metadata disk. +
              #### [shutdownPrivatePort](/reference/services/SoftLayer_Virtual_Guest/shutdownPrivatePort) Shuts down the private port +
              #### [shutdownPublicPort](/reference/services/SoftLayer_Virtual_Guest/shutdownPublicPort) Shuts down the public port +
              #### [unmountIsoImage](/reference/services/SoftLayer_Virtual_Guest/unmountIsoImage) +
              #### [validateImageTemplate](/reference/services/SoftLayer_Virtual_Guest/validateImageTemplate) Validates an image template for OS Reload +
              #### [verifyReloadOperatingSystem](/reference/services/SoftLayer_Virtual_Guest/verifyReloadOperatingSystem) Verify that a virtual server can go through the operating system reload process. +
              diff --git a/content/reference/services/SoftLayer_Virtual_Guest/activatePrivatePort.md b/content/reference/services/SoftLayer_Virtual_Guest/activatePrivatePort.md index 401c34f7f3..8448b0106b 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/activatePrivatePort.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/activatePrivatePort.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::activatePrivatePort + Activate the private port diff --git a/content/reference/services/SoftLayer_Virtual_Guest/activatePublicPort.md b/content/reference/services/SoftLayer_Virtual_Guest/activatePublicPort.md index 6a86f9f1cd..791c18261e 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/activatePublicPort.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/activatePublicPort.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::activatePublicPort + Activate the public port diff --git a/content/reference/services/SoftLayer_Virtual_Guest/allowAccessToNetworkStorage.md b/content/reference/services/SoftLayer_Virtual_Guest/allowAccessToNetworkStorage.md index da806b3417..70bffe075d 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/allowAccessToNetworkStorage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/allowAccessToNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::allowAccessToNetworkStorage + Allow access to a SoftLayer_Network_Storage volume from this device. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/allowAccessToNetworkStorageList.md b/content/reference/services/SoftLayer_Virtual_Guest/allowAccessToNetworkStorageList.md index 54e848f799..b4ab12171f 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/allowAccessToNetworkStorageList.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/allowAccessToNetworkStorageList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::allowAccessToNetworkStorageList + Allow access to multiple SoftLayer_Network_Storage volumes from this device. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/attachDiskImage.md b/content/reference/services/SoftLayer_Virtual_Guest/attachDiskImage.md index 1411337c41..406a623051 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/attachDiskImage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/attachDiskImage.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::attachDiskImage + Attaches a disk image. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/cancelIsolationForDestructiveAction.md b/content/reference/services/SoftLayer_Virtual_Guest/cancelIsolationForDestructiveAction.md index 7ad02faa3d..b6a40964c5 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/cancelIsolationForDestructiveAction.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/cancelIsolationForDestructiveAction.md @@ -16,6 +16,7 @@ aliases: + ## Overview Reopens the public and/or private ports to reverse the changes made when the server was isolated for a destructive action. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/captureImage.md b/content/reference/services/SoftLayer_Virtual_Guest/captureImage.md index cd2ff64ec2..a8f5d99ece 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/captureImage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/captureImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::captureImage + Captures a Flex Image of the hard disk on the virtual machine. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/checkHostDiskAvailability.md b/content/reference/services/SoftLayer_Virtual_Guest/checkHostDiskAvailability.md index d40477d129..815e86b5ce 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/checkHostDiskAvailability.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/checkHostDiskAvailability.md @@ -16,6 +16,7 @@ aliases: + ## Overview Checks the associated host for available disk space to determine if guest migration is necessary. This method is only used with local disks. If this method returns false, calling attachDiskImage($imageId) will automatically migrate the destination guest to a new host before attaching the portable volume. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/configureMetadataDisk.md b/content/reference/services/SoftLayer_Virtual_Guest/configureMetadataDisk.md index 28590654f9..9fea075aed 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/configureMetadataDisk.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/configureMetadataDisk.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::configureMetadataDisk + Configures the guest's metadata disk. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/createArchiveTemplate.md b/content/reference/services/SoftLayer_Virtual_Guest/createArchiveTemplate.md index f550feb36a..b23c4b0954 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/createArchiveTemplate.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/createArchiveTemplate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::createArchiveTemplate + [SoftLayer_Virtual_Guest_Block_Devices]({{}}) can be grouped together in and backed up in an archive for later use. This method generates a transaction to perform an archive of the provided block devices. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/createArchiveTransaction.md b/content/reference/services/SoftLayer_Virtual_Guest/createArchiveTransaction.md index e416ac40fa..51cd2cfac3 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/createArchiveTransaction.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/createArchiveTransaction.md @@ -13,6 +13,8 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::createArchiveTransaction +
              Deprecated
              + [SoftLayer_Virtual_Guest_Block_Device]({{}}) can be grouped together in and backed up in an archive for later use. This method generates a transaction to perform an archive of the provided block devices. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/createObject.md b/content/reference/services/SoftLayer_Virtual_Guest/createObject.md index b5987a1525..813611acfc 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/createObject.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::createObject + Create a new computing instance diff --git a/content/reference/services/SoftLayer_Virtual_Guest/createObjects.md b/content/reference/services/SoftLayer_Virtual_Guest/createObjects.md index 15625a1493..43a1135aa2 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/createObjects.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/createObjects.md @@ -14,6 +14,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::createObjects + Create new computing instances diff --git a/content/reference/services/SoftLayer_Virtual_Guest/createPostSoftwareInstallTransaction.md b/content/reference/services/SoftLayer_Virtual_Guest/createPostSoftwareInstallTransaction.md index 78f09735df..dc8221ea18 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/createPostSoftwareInstallTransaction.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/createPostSoftwareInstallTransaction.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/deleteObject.md b/content/reference/services/SoftLayer_Virtual_Guest/deleteObject.md index 34022696b5..ba79875648 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/deleteObject.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::deleteObject + Delete a computing instance diff --git a/content/reference/services/SoftLayer_Virtual_Guest/deleteTag.md b/content/reference/services/SoftLayer_Virtual_Guest/deleteTag.md index f408a408d8..1cbca6a5ab 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/deleteTag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/deleteTag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::deleteTag + Delete a tag diff --git a/content/reference/services/SoftLayer_Virtual_Guest/deleteTransientWebhook.md b/content/reference/services/SoftLayer_Virtual_Guest/deleteTransientWebhook.md index 50ec9f01cf..4a63bf00ad 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/deleteTransientWebhook.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/deleteTransientWebhook.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/detachDiskImage.md b/content/reference/services/SoftLayer_Virtual_Guest/detachDiskImage.md index c46ed1d97a..eb199ed25e 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/detachDiskImage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/detachDiskImage.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::detachDiskImage + Detaches a disk image. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/editObject.md b/content/reference/services/SoftLayer_Virtual_Guest/editObject.md index eb2e101349..6d957d84bb 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/editObject.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::editObject + Edit a computing instance's properties diff --git a/content/reference/services/SoftLayer_Virtual_Guest/executeIderaBareMetalRestore.md b/content/reference/services/SoftLayer_Virtual_Guest/executeIderaBareMetalRestore.md index 96ea7de8d5..74a7bf770e 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/executeIderaBareMetalRestore.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/executeIderaBareMetalRestore.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::executeIderaBareMetalRestore + Reboot a guest into the Idera Bare Metal Restore image. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/executeR1SoftBareMetalRestore.md b/content/reference/services/SoftLayer_Virtual_Guest/executeR1SoftBareMetalRestore.md index dd0e741255..90b5486b28 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/executeR1SoftBareMetalRestore.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/executeR1SoftBareMetalRestore.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::executeR1SoftBareMetalRestore + Reboot a guest into the R1Soft Bare Metal Restore image. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/executeRemoteScript.md b/content/reference/services/SoftLayer_Virtual_Guest/executeRemoteScript.md index 5853d533a7..ba97f203d9 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/executeRemoteScript.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/executeRemoteScript.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::executeRemoteScript + Download and run remote script from uri on the virtual guest. Requires https for script to be executed after download. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/executeRescueLayer.md b/content/reference/services/SoftLayer_Virtual_Guest/executeRescueLayer.md index 57be6452e9..c1384b4764 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/executeRescueLayer.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/executeRescueLayer.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::executeRescueLayer + Reboot a Linux guest into the Xen rescue image. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/findByHostname.md b/content/reference/services/SoftLayer_Virtual_Guest/findByHostname.md index 2b373b10b6..8014648036 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/findByHostname.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/findByHostname.md @@ -16,6 +16,7 @@ aliases: + ## Overview Find VSIs by hostname. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/findByIpAddress.md b/content/reference/services/SoftLayer_Virtual_Guest/findByIpAddress.md index 387f96d589..5c639dcb0a 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/findByIpAddress.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/findByIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::findByIpAddress + Find CCI by its primary public or private IP (ipv4) address. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/generateOrderTemplate.md b/content/reference/services/SoftLayer_Virtual_Guest/generateOrderTemplate.md index 7a252dbb0b..4ed6a61840 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/generateOrderTemplate.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/generateOrderTemplate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::generateOrderTemplate + Obtain an order container for a given template object diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getAccount.md b/content/reference/services/SoftLayer_Virtual_Guest/getAccount.md index ef92ff9a7c..ef00140b7f 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getAccount.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getAccount + Retrieve the account that a virtual guest belongs to. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getAccountOwnedPoolFlag.md b/content/reference/services/SoftLayer_Virtual_Guest/getAccountOwnedPoolFlag.md index 4058a502ec..dcd9c786e1 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getAccountOwnedPoolFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getAccountOwnedPoolFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getActiveNetworkMonitorIncident.md b/content/reference/services/SoftLayer_Virtual_Guest/getActiveNetworkMonitorIncident.md index e6890d35b0..346680dc62 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getActiveNetworkMonitorIncident.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getActiveNetworkMonitorIncident.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getActiveNetworkMonitorIncident + Retrieve a virtual guest's currently active network monitoring incidents. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getActiveTickets.md b/content/reference/services/SoftLayer_Virtual_Guest/getActiveTickets.md index 6190017b7a..3b113df034 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getActiveTickets.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getActiveTickets.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getActiveTransaction.md b/content/reference/services/SoftLayer_Virtual_Guest/getActiveTransaction.md index 63f2a01ef3..9af8a06f5d 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getActiveTransaction.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getActiveTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getActiveTransaction + Retrieve a transaction that is still be performed on a cloud server. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getActiveTransactions.md b/content/reference/services/SoftLayer_Virtual_Guest/getActiveTransactions.md index 189897a25c..0f2dcc37a1 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getActiveTransactions.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getActiveTransactions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getActiveTransactions + Retrieve any active transaction(s) that are currently running for the server (example: os reload). diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getAdditionalRequiredPricesForOsReload.md b/content/reference/services/SoftLayer_Virtual_Guest/getAdditionalRequiredPricesForOsReload.md index 04cbb23479..74ad658b95 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getAdditionalRequiredPricesForOsReload.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getAdditionalRequiredPricesForOsReload.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getAdditionalRequiredPricesForOsReload + Return a collection of SoftLayer_Item_Price objects for an OS reload diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getAllowedHost.md b/content/reference/services/SoftLayer_Virtual_Guest/getAllowedHost.md index b60b569e3a..bf72661387 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getAllowedHost.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getAllowedHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getAllowedHost + Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual Guest to Network Storage volumes that require access control lists. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getAllowedNetworkStorage.md b/content/reference/services/SoftLayer_Virtual_Guest/getAllowedNetworkStorage.md index c0da62ec27..89b28908a6 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getAllowedNetworkStorage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getAllowedNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getAllowedNetworkStorage + Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getAllowedNetworkStorageReplicas.md b/content/reference/services/SoftLayer_Virtual_Guest/getAllowedNetworkStorageReplicas.md index ccfb517487..7a9ab5b6d9 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getAllowedNetworkStorageReplicas.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getAllowedNetworkStorageReplicas.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getAllowedNetworkStorageReplicas + Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getAntivirusSpywareSoftwareComponent.md b/content/reference/services/SoftLayer_Virtual_Guest/getAntivirusSpywareSoftwareComponent.md index faff6446b4..0843c56977 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getAntivirusSpywareSoftwareComponent.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getAntivirusSpywareSoftwareComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getAntivirusSpywareSoftwareComponent + Retrieve a antivirus / spyware software component object. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getApplicationDeliveryController.md b/content/reference/services/SoftLayer_Virtual_Guest/getApplicationDeliveryController.md index ad0f60353b..a8ff1f71b5 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getApplicationDeliveryController.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getApplicationDeliveryController.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getAttachedNetworkStorages.md b/content/reference/services/SoftLayer_Virtual_Guest/getAttachedNetworkStorages.md index 83e0c8af39..a5f87626ba 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getAttachedNetworkStorages.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getAttachedNetworkStorages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getAttachedNetworkStorages + Return a list of SoftLayer_Network_Storage volumes authorized to this device. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getAttributes.md b/content/reference/services/SoftLayer_Virtual_Guest/getAttributes.md index 6ca708a257..ce7ae36cde 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getAttributes.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getAttributes.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getAvailableBlockDevicePositions.md b/content/reference/services/SoftLayer_Virtual_Guest/getAvailableBlockDevicePositions.md index 43b49fb170..b0a358532d 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getAvailableBlockDevicePositions.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getAvailableBlockDevicePositions.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getAvailableMonitoring.md b/content/reference/services/SoftLayer_Virtual_Guest/getAvailableMonitoring.md index b6044e439d..e3276c7c65 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getAvailableMonitoring.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getAvailableMonitoring.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getAvailableMonitoring + Retrieve an object that stores the maximum level for the monitoring query types and response types. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getAvailableNetworkStorages.md b/content/reference/services/SoftLayer_Virtual_Guest/getAvailableNetworkStorages.md index 1fe4644510..751b67d5a3 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getAvailableNetworkStorages.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getAvailableNetworkStorages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getAvailableNetworkStorages + Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getAverageDailyPrivateBandwidthUsage.md b/content/reference/services/SoftLayer_Virtual_Guest/getAverageDailyPrivateBandwidthUsage.md index 6687f063e4..b170fe0a4c 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getAverageDailyPrivateBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getAverageDailyPrivateBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getAverageDailyPrivateBandwidthUsage + Retrieve the average daily private bandwidth usage for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getAverageDailyPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Virtual_Guest/getAverageDailyPublicBandwidthUsage.md index 16b45b3bc5..80fafd36e1 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getAverageDailyPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getAverageDailyPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getAverageDailyPublicBandwidthUsage + Retrieve the average daily public bandwidth usage for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBackendNetworkComponents.md b/content/reference/services/SoftLayer_Virtual_Guest/getBackendNetworkComponents.md index 1136228edf..5b00e91bc2 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBackendNetworkComponents.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBackendNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getBackendNetworkComponents + Retrieve a guests's backend network components. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBackendRouters.md b/content/reference/services/SoftLayer_Virtual_Guest/getBackendRouters.md index 6d3a178385..04d0262155 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBackendRouters.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBackendRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getBackendRouters + Retrieve a guest's backend or private router. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthAllocation.md b/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthAllocation.md index af21f1f797..b9c9f8360e 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthAllocation.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthAllocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getBandwidthAllocation + Retrieve a computing instance's allotted bandwidth (measured in GB). diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthAllotmentDetail.md b/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthAllotmentDetail.md index db2cc3f775..d8ce1f82fd 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthAllotmentDetail.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthAllotmentDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getBandwidthAllotmentDetail + Retrieve a computing instance's allotted detail record. Allotment details link bandwidth allocation with allotments. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthDataByDate.md b/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthDataByDate.md index f5ca27f3e6..715830414d 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthDataByDate.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthDataByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getBandwidthDataByDate + Retrieve the amount of network traffic that occurred for the specified time frame for a computing instance. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthForDateRange.md b/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthForDateRange.md index 6733dc28ba..7e9236c24d 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthForDateRange.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthForDateRange.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getBandwidthForDateRange + Retrieve bandwidth data from a tracking object. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthImage.md b/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthImage.md index 0862ce34ca..368d7b1074 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthImage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getBandwidthImage + Retrieve a visual representation of the amount of network traffic that occurred for the specified time frame for a computing instance. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthImageByDate.md b/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthImageByDate.md index 7b3972977e..89af775e95 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthImageByDate.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthImageByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getBandwidthImageByDate + Retrieve a visual representation of the amount of network traffic that occurred for the specified time frame for a computing instance. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthTotal.md b/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthTotal.md index 33aac072d3..ea3ae30bda 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthTotal.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBandwidthTotal.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getBandwidthTotal + Retrieve total amount of network traffic that was in use during the time specified by the input parameters for a computing instance. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBillingCycleBandwidthUsage.md b/content/reference/services/SoftLayer_Virtual_Guest/getBillingCycleBandwidthUsage.md index dc1ac82292..72545955b9 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBillingCycleBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBillingCycleBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getBillingCycleBandwidthUsage + Retrieve the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBillingCyclePrivateBandwidthUsage.md b/content/reference/services/SoftLayer_Virtual_Guest/getBillingCyclePrivateBandwidthUsage.md index 03903aa49c..4867878b8d 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBillingCyclePrivateBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBillingCyclePrivateBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getBillingCyclePrivateBandwidthUsage + Retrieve the raw private bandwidth usage data for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBillingCyclePublicBandwidthUsage.md b/content/reference/services/SoftLayer_Virtual_Guest/getBillingCyclePublicBandwidthUsage.md index 29ca165897..ee8cbb4759 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBillingCyclePublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBillingCyclePublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getBillingCyclePublicBandwidthUsage + Retrieve the raw public bandwidth usage data for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBillingItem.md b/content/reference/services/SoftLayer_Virtual_Guest/getBillingItem.md index e14625f97d..81b9b52e90 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBillingItem.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getBillingItem + Retrieve the billing item for a CloudLayer Compute Instance. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBlockCancelBecauseDisconnectedFlag.md b/content/reference/services/SoftLayer_Virtual_Guest/getBlockCancelBecauseDisconnectedFlag.md index 1f28318b67..da75223042 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBlockCancelBecauseDisconnectedFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBlockCancelBecauseDisconnectedFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getBlockCancelBecauseDisconnectedFlag + Retrieve determines whether the instance is ineligible for cancellation because it is disconnected. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBlockDeviceTemplateGroup.md b/content/reference/services/SoftLayer_Virtual_Guest/getBlockDeviceTemplateGroup.md index ee33503227..8b32dbcac9 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBlockDeviceTemplateGroup.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBlockDeviceTemplateGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getBlockDeviceTemplateGroup + Retrieve the global identifier for the image template that was used to provision or reload a guest. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBlockDevices.md b/content/reference/services/SoftLayer_Virtual_Guest/getBlockDevices.md index 29b779a421..18df6ee72c 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBlockDevices.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBlockDevices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getBlockDevices + Retrieve a computing instance's block devices. Block devices link [SoftLayer_Virtual_Disk_Image]({{}}) to computing instances. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBootMode.md b/content/reference/services/SoftLayer_Virtual_Guest/getBootMode.md index a4c69462e9..a17c51ee88 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBootMode.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBootMode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getBootMode + Retrieves the boot mode of the VSI. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBootOrder.md b/content/reference/services/SoftLayer_Virtual_Guest/getBootOrder.md index 8e0925c7f8..8f50e048db 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBootOrder.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBootOrder.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getBrowserConsoleAccessLogs.md b/content/reference/services/SoftLayer_Virtual_Guest/getBrowserConsoleAccessLogs.md index 344f0da191..43962f2f2b 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getBrowserConsoleAccessLogs.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getBrowserConsoleAccessLogs.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getBrowserConsoleAccessLogs + Retrieve a virtual guest's browser access logs. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getConsoleAccessLog.md b/content/reference/services/SoftLayer_Virtual_Guest/getConsoleAccessLog.md index 340d71027d..59169df989 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getConsoleAccessLog.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getConsoleAccessLog.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getConsoleAccessLog + get console access logs diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getConsoleData.md b/content/reference/services/SoftLayer_Virtual_Guest/getConsoleData.md index 70765c5874..4c071f3cee 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getConsoleData.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getConsoleData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getConsoleData + Retrieve a container for a guest's console data diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getConsoleIpAddressFlag.md b/content/reference/services/SoftLayer_Virtual_Guest/getConsoleIpAddressFlag.md index 82ac4f15a5..ad8ab814e0 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getConsoleIpAddressFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getConsoleIpAddressFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getConsoleIpAddressFlag + Retrieve a flag indicating a computing instance's console IP address is assigned. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getConsoleIpAddressRecord.md b/content/reference/services/SoftLayer_Virtual_Guest/getConsoleIpAddressRecord.md index 057d190632..7f75af72fa 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getConsoleIpAddressRecord.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getConsoleIpAddressRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getConsoleIpAddressRecord + Retrieve a record containing information about a computing instance's console IP and port number. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getContinuousDataProtectionSoftwareComponent.md b/content/reference/services/SoftLayer_Virtual_Guest/getContinuousDataProtectionSoftwareComponent.md index 0d9ba0e82d..98fcb50e5c 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getContinuousDataProtectionSoftwareComponent.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getContinuousDataProtectionSoftwareComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getContinuousDataProtectionSoftwareComponent + Retrieve a continuous data protection software component object. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getControlPanel.md b/content/reference/services/SoftLayer_Virtual_Guest/getControlPanel.md index 9e60c994ad..33fb9a5a04 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getControlPanel.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getControlPanel.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getControlPanel + Retrieve a guest's control panel. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getCoreRestrictedOperatingSystemPrice.md b/content/reference/services/SoftLayer_Virtual_Guest/getCoreRestrictedOperatingSystemPrice.md index 013d40b1da..f7ce5bec05 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getCoreRestrictedOperatingSystemPrice.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getCoreRestrictedOperatingSystemPrice.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getCoreRestrictedOperatingSystemPrice + Return the associated core-restricted operating system item price for the virtual server. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getCpuMetricDataByDate.md b/content/reference/services/SoftLayer_Virtual_Guest/getCpuMetricDataByDate.md index 653549ff06..0a919a6033 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getCpuMetricDataByDate.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getCpuMetricDataByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getCpuMetricDataByDate + Retrieve records containing the percentage of the amount of time that a cpu was in use for the specified time frame for a computing instance. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getCpuMetricImage.md b/content/reference/services/SoftLayer_Virtual_Guest/getCpuMetricImage.md index 2ad61cff08..6db8e141af 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getCpuMetricImage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getCpuMetricImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getCpuMetricImage + Retrieve a visual representation of the percentage of the amount of time that a cpu was in use for the specified time frame for a computing instance. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getCpuMetricImageByDate.md b/content/reference/services/SoftLayer_Virtual_Guest/getCpuMetricImageByDate.md index 53ca990cdb..ac651bab2c 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getCpuMetricImageByDate.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getCpuMetricImageByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getCpuMetricImageByDate + Retrieve a visual representation of the percentage of the amount of time that a cpu was in use for the specified time frame for a computing instance. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getCreateObjectOptions.md b/content/reference/services/SoftLayer_Virtual_Guest/getCreateObjectOptions.md index 5c577f8690..6eda40ecc7 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getCreateObjectOptions.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getCreateObjectOptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getCreateObjectOptions + Determine options available when creating a computing instance diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getCurrentBandwidthSummary.md b/content/reference/services/SoftLayer_Virtual_Guest/getCurrentBandwidthSummary.md index 002a21a350..2e363ce280 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getCurrentBandwidthSummary.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getCurrentBandwidthSummary.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getCurrentBandwidthSummary + Retrieve an object that provides commonly used bandwidth summary components for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getCurrentBillingDetail.md b/content/reference/services/SoftLayer_Virtual_Guest/getCurrentBillingDetail.md index f01f7baca3..68c20b9626 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getCurrentBillingDetail.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getCurrentBillingDetail.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getCurrentBillingDetail + << EOT diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getCurrentBillingTotal.md b/content/reference/services/SoftLayer_Virtual_Guest/getCurrentBillingTotal.md index 531d5a63c0..8f7c7c1eca 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getCurrentBillingTotal.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getCurrentBillingTotal.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getCurrentBillingTotal + Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getCustomBandwidthDataByDate.md b/content/reference/services/SoftLayer_Virtual_Guest/getCustomBandwidthDataByDate.md index 60de3346d5..2fa9f58474 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getCustomBandwidthDataByDate.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getCustomBandwidthDataByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getCustomBandwidthDataByDate + Retrieve bandwidth graph by date. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getCustomMetricDataByDate.md b/content/reference/services/SoftLayer_Virtual_Guest/getCustomMetricDataByDate.md index 6771fe5df5..4a1f9cca9b 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getCustomMetricDataByDate.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getCustomMetricDataByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getCustomMetricDataByDate + Retrieve bandwidth graph by date. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getDatacenter.md b/content/reference/services/SoftLayer_Virtual_Guest/getDatacenter.md index 7f1f8b4a2e..85ac5136d1 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getDatacenter.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getDatacenter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getDatacenter + Retrieve the datacenter that a virtual guest resides in. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getDedicatedHost.md b/content/reference/services/SoftLayer_Virtual_Guest/getDedicatedHost.md index 363a57e6eb..97c7efb8cb 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getDedicatedHost.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getDedicatedHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getDedicatedHost + Retrieve the dedicated host associated with this guest. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getDriveRetentionItemPrice.md b/content/reference/services/SoftLayer_Virtual_Guest/getDriveRetentionItemPrice.md index 232ac6720c..cdcbcfe4cc 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getDriveRetentionItemPrice.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getDriveRetentionItemPrice.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getDriveRetentionItemPrice + Return a drive retention SoftLayer_Item_Price object for a guest. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getEvaultNetworkStorage.md b/content/reference/services/SoftLayer_Virtual_Guest/getEvaultNetworkStorage.md index 7957e26716..52b296d135 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getEvaultNetworkStorage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getEvaultNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getEvaultNetworkStorage + Retrieve a guest's associated EVault network storage service account. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getFirewallProtectableSubnets.md b/content/reference/services/SoftLayer_Virtual_Guest/getFirewallProtectableSubnets.md index 9e1edd9dc4..23c29c776b 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getFirewallProtectableSubnets.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getFirewallProtectableSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getFirewallProtectableSubnets + Get the subnets associated with this CloudLayer computing instance that are protectable by a network component firewall. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getFirewallServiceComponent.md b/content/reference/services/SoftLayer_Virtual_Guest/getFirewallServiceComponent.md index acf350a209..6f09a3d035 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getFirewallServiceComponent.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getFirewallServiceComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getFirewallServiceComponent + Retrieve a computing instance's hardware firewall services. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getFirstAvailableBlockDevicePosition.md b/content/reference/services/SoftLayer_Virtual_Guest/getFirstAvailableBlockDevicePosition.md index 445c907be7..84ad5937d9 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getFirstAvailableBlockDevicePosition.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getFirstAvailableBlockDevicePosition.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getFrontendNetworkComponents.md b/content/reference/services/SoftLayer_Virtual_Guest/getFrontendNetworkComponents.md index e6d6ed78a5..df8de3187d 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getFrontendNetworkComponents.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getFrontendNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getFrontendNetworkComponents + Retrieve a guest's frontend network components. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getFrontendRouters.md b/content/reference/services/SoftLayer_Virtual_Guest/getFrontendRouters.md index 7270c83715..5000948ccb 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getFrontendRouters.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getFrontendRouters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getFrontendRouters + Retrieve a guest's frontend or public router. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getGlobalIdentifier.md b/content/reference/services/SoftLayer_Virtual_Guest/getGlobalIdentifier.md index e7eddbc91e..e33302e1ab 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getGlobalIdentifier.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getGlobalIdentifier.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getGlobalIdentifier + Retrieve a guest's universally unique identifier. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getGpuCount.md b/content/reference/services/SoftLayer_Virtual_Guest/getGpuCount.md index 20d093fef5..21550f9c8a 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getGpuCount.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getGpuCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getGpuCount + Retrieve the number of GPUs attached to the guest. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getGpuType.md b/content/reference/services/SoftLayer_Virtual_Guest/getGpuType.md index 4025e32955..deba1a4dd4 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getGpuType.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getGpuType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getGpuType + Retrieve the name of the GPU type attached to the guest. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getGuestBootParameter.md b/content/reference/services/SoftLayer_Virtual_Guest/getGuestBootParameter.md index 8f12f9b5d5..cf6cfcdf36 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getGuestBootParameter.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getGuestBootParameter.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getHardwareFunctionDescription.md b/content/reference/services/SoftLayer_Virtual_Guest/getHardwareFunctionDescription.md index 96c7858d6d..c604a32429 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getHardwareFunctionDescription.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getHardwareFunctionDescription.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getHardwareFunctionDescription + Retrieve the object's function. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getHost.md b/content/reference/services/SoftLayer_Virtual_Guest/getHost.md index 42e73d8934..1f1fd5b63c 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getHost.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getHost + Retrieve the virtual host on which a virtual guest resides (available only on private clouds). diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getHostIpsSoftwareComponent.md b/content/reference/services/SoftLayer_Virtual_Guest/getHostIpsSoftwareComponent.md index cbd0d39cd0..a4de6154ff 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getHostIpsSoftwareComponent.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getHostIpsSoftwareComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getHostIpsSoftwareComponent + Retrieve a host IPS software component object. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getHourlyBillingFlag.md b/content/reference/services/SoftLayer_Virtual_Guest/getHourlyBillingFlag.md index 28fa3a4e27..466e207976 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getHourlyBillingFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getHourlyBillingFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getHourlyBillingFlag + Retrieve a guest's hourly billing status. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getInboundPrivateBandwidthUsage.md b/content/reference/services/SoftLayer_Virtual_Guest/getInboundPrivateBandwidthUsage.md index 522002b2c2..8a9f74bdc2 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getInboundPrivateBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getInboundPrivateBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getInboundPrivateBandwidthUsage + Retrieve the total private inbound bandwidth for this computing instance for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getInboundPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Virtual_Guest/getInboundPublicBandwidthUsage.md index 5201c92dac..8bb7acbac0 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getInboundPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getInboundPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getInboundPublicBandwidthUsage + Retrieve the total public inbound bandwidth for this computing instance for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getInternalTagReferences.md b/content/reference/services/SoftLayer_Virtual_Guest/getInternalTagReferences.md index dfcca80120..e322ce2794 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getInternalTagReferences.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getInternalTagReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getIsoBootImage.md b/content/reference/services/SoftLayer_Virtual_Guest/getIsoBootImage.md index 57f56654d4..9dc6c4acd3 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getIsoBootImage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getIsoBootImage.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getItemPricesFromSoftwareDescriptions.md b/content/reference/services/SoftLayer_Virtual_Guest/getItemPricesFromSoftwareDescriptions.md index 019f8288f7..4e30eb3aca 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getItemPricesFromSoftwareDescriptions.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getItemPricesFromSoftwareDescriptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getItemPricesFromSoftwareDescriptions + Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getLastKnownPowerState.md b/content/reference/services/SoftLayer_Virtual_Guest/getLastKnownPowerState.md index 638c80540c..2a9e08b446 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getLastKnownPowerState.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getLastKnownPowerState.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getLastKnownPowerState + Retrieve the last known power state of a virtual guest in the event the guest is turned off outside of IMS or has gone offline. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getLastOperatingSystemReload.md b/content/reference/services/SoftLayer_Virtual_Guest/getLastOperatingSystemReload.md index b13966638a..5a5f30ccce 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getLastOperatingSystemReload.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getLastOperatingSystemReload.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getLastOperatingSystemReload + Retrieve the last transaction that a cloud server's operating system was loaded. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getLastTransaction.md b/content/reference/services/SoftLayer_Virtual_Guest/getLastTransaction.md index e72ee59595..76f71fafeb 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getLastTransaction.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getLastTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getLastTransaction + Retrieve the last transaction a cloud server had performed. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getLatestNetworkMonitorIncident.md b/content/reference/services/SoftLayer_Virtual_Guest/getLatestNetworkMonitorIncident.md index 804c38ad58..60e7e1724d 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getLatestNetworkMonitorIncident.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getLatestNetworkMonitorIncident.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getLatestNetworkMonitorIncident + Retrieve a virtual guest's latest network monitoring incident. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getLocalDiskFlag.md b/content/reference/services/SoftLayer_Virtual_Guest/getLocalDiskFlag.md index 29f3467969..6bb09f8dc8 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getLocalDiskFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getLocalDiskFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getLocalDiskFlag + Retrieve a flag indicating that the virtual guest has at least one disk which is local to the host it runs on. This does not include a SWAP device. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getLocation.md b/content/reference/services/SoftLayer_Virtual_Guest/getLocation.md index 30f820ac1d..5f66b24b08 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getLocation.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getLocation.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getLocation + Retrieve where guest is located within SoftLayer's location hierarchy. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getManagedResourceFlag.md b/content/reference/services/SoftLayer_Virtual_Guest/getManagedResourceFlag.md index 69a87ef865..ca99889e28 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getManagedResourceFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getManagedResourceFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getManagedResourceFlag + Retrieve a flag indicating that the virtual guest is a managed resource. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricDataByDate.md b/content/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricDataByDate.md index f0cfc7cca4..bf53cf67da 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricDataByDate.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricDataByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getMemoryMetricDataByDate + Retrieve records containing the amount memory that was used for the specified time frame for a computing instance. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricImage.md b/content/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricImage.md index d1e0da522a..9349f1b215 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricImage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricImage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getMemoryMetricImage + Retrieve a visual representation of the amount of memory used for the specified time frame for a computing instance. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricImageByDate.md b/content/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricImageByDate.md index 542922422d..e318fc7dc0 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricImageByDate.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricImageByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getMemoryMetricImageByDate + Retrieve a visual representation of the amount of memory used for the specified time frame for a computing instance. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getMetricTrackingObject.md b/content/reference/services/SoftLayer_Virtual_Guest/getMetricTrackingObject.md index 21772988ff..490521e700 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getMetricTrackingObject.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getMetricTrackingObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getMetricTrackingObject + Retrieve a guest's metric tracking object. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getMetricTrackingObjectId.md b/content/reference/services/SoftLayer_Virtual_Guest/getMetricTrackingObjectId.md index 99faea2647..5b8b795868 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getMetricTrackingObjectId.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getMetricTrackingObjectId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getMetricTrackingObjectId + Retrieve the metric tracking object id for this guest. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getMonitoringRobot.md b/content/reference/services/SoftLayer_Virtual_Guest/getMonitoringRobot.md index e89ab26e45..b272daa352 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getMonitoringRobot.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getMonitoringRobot.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getMonitoringServiceComponent.md b/content/reference/services/SoftLayer_Virtual_Guest/getMonitoringServiceComponent.md index f4b0862ffc..7ab4d632b2 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getMonitoringServiceComponent.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getMonitoringServiceComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getMonitoringServiceComponent + Retrieve a virtual guest's network monitoring services. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getMonitoringServiceEligibilityFlag.md b/content/reference/services/SoftLayer_Virtual_Guest/getMonitoringServiceEligibilityFlag.md index a43e1c5554..75d8e86c9b 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getMonitoringServiceEligibilityFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getMonitoringServiceEligibilityFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getMonitoringUserNotification.md b/content/reference/services/SoftLayer_Virtual_Guest/getMonitoringUserNotification.md index e1292a5eff..5d3eb17349 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getMonitoringUserNotification.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getMonitoringUserNotification.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getMonitoringUserNotification + Retrieve the monitoring notification objects for this guest. Each object links this guest instance to a user account that will be notified if monitoring on this guest object fails diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getNetworkComponentFirewallProtectableIpAddresses.md b/content/reference/services/SoftLayer_Virtual_Guest/getNetworkComponentFirewallProtectableIpAddresses.md index 05238d8e13..f38e10a6c0 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getNetworkComponentFirewallProtectableIpAddresses.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getNetworkComponentFirewallProtectableIpAddresses.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getNetworkComponentFirewallProtectableIpAddresses + Get the IP addresses associated with this CloudLayer computing instance that are protectable by a network component firewall. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getNetworkComponents.md b/content/reference/services/SoftLayer_Virtual_Guest/getNetworkComponents.md index e389cd9602..2bd0fe140a 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getNetworkComponents.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getNetworkComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getNetworkComponents + Retrieve a guests's network components. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getNetworkMonitorIncidents.md b/content/reference/services/SoftLayer_Virtual_Guest/getNetworkMonitorIncidents.md index 6723f9ac0e..12de5c0e9d 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getNetworkMonitorIncidents.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getNetworkMonitorIncidents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getNetworkMonitorIncidents + Retrieve all of a virtual guest's network monitoring incidents. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getNetworkMonitors.md b/content/reference/services/SoftLayer_Virtual_Guest/getNetworkMonitors.md index f04d8fa650..7bbdaf6163 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getNetworkMonitors.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getNetworkMonitors.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getNetworkMonitors + Retrieve a guests's network monitors. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getNetworkStorage.md b/content/reference/services/SoftLayer_Virtual_Guest/getNetworkStorage.md index 25ad38006a..23bcb921cf 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getNetworkStorage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getNetworkStorage + Retrieve a guest's associated network storage accounts. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getNetworkVlans.md b/content/reference/services/SoftLayer_Virtual_Guest/getNetworkVlans.md index 8071af0d41..6d5859db47 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getNetworkVlans.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getNetworkVlans.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getNetworkVlans + Retrieve the network Vlans that a guest's network components are associated with. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getObject.md b/content/reference/services/SoftLayer_Virtual_Guest/getObject.md index d6da39b064..a8970042b3 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getObject.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getObject + Retrieve a SoftLayer_Virtual_Guest record. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getOpenCancellationTicket.md b/content/reference/services/SoftLayer_Virtual_Guest/getOpenCancellationTicket.md index d767fa5e42..1459467b66 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getOpenCancellationTicket.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getOpenCancellationTicket.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getOpenCancellationTicket + Retrieve an open ticket requesting cancellation of this server, if one exists. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getOperatingSystem.md b/content/reference/services/SoftLayer_Virtual_Guest/getOperatingSystem.md index 01b0f924a5..87a56f8adc 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getOperatingSystem.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getOperatingSystem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getOperatingSystem + Retrieve a guest's operating system. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getOperatingSystemReferenceCode.md b/content/reference/services/SoftLayer_Virtual_Guest/getOperatingSystemReferenceCode.md index a55ffa0ab7..6708f721d5 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getOperatingSystemReferenceCode.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getOperatingSystemReferenceCode.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getOperatingSystemReferenceCode + Retrieve a guest's operating system software description. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getOrderTemplate.md b/content/reference/services/SoftLayer_Virtual_Guest/getOrderTemplate.md index aa4d045b44..f14131f1c7 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getOrderTemplate.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getOrderTemplate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getOrderTemplate + Obtain an order container that is ready to be sent to the [[SoftLayer_Product_Order#placeOrder|SoftLayer_Product_Order::placeOrder]] method. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getOrderedPackageId.md b/content/reference/services/SoftLayer_Virtual_Guest/getOrderedPackageId.md index df9b10eb2c..483303cd99 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getOrderedPackageId.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getOrderedPackageId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getOrderedPackageId + Retrieve the original package id provided with the order for a Cloud Computing Instance. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getOutboundPrivateBandwidthUsage.md b/content/reference/services/SoftLayer_Virtual_Guest/getOutboundPrivateBandwidthUsage.md index 3fc365ffb4..3fcc0057fe 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getOutboundPrivateBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getOutboundPrivateBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getOutboundPrivateBandwidthUsage + Retrieve the total private outbound bandwidth for this computing instance for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getOutboundPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Virtual_Guest/getOutboundPublicBandwidthUsage.md index 80948e7c96..d860215625 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getOutboundPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getOutboundPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getOutboundPublicBandwidthUsage + Retrieve the total public outbound bandwidth for this computing instance for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getOverBandwidthAllocationFlag.md b/content/reference/services/SoftLayer_Virtual_Guest/getOverBandwidthAllocationFlag.md index c4a571d643..f0ac301d0a 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getOverBandwidthAllocationFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getOverBandwidthAllocationFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getOverBandwidthAllocationFlag + Retrieve whether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getPendingMaintenanceActions.md b/content/reference/services/SoftLayer_Virtual_Guest/getPendingMaintenanceActions.md index eeb970f76c..5d5027a50c 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getPendingMaintenanceActions.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getPendingMaintenanceActions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getPendingMaintenanceActions + Returns a list of all the pending maintenance actions affecting this guest. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getPendingMigrationFlag.md b/content/reference/services/SoftLayer_Virtual_Guest/getPendingMigrationFlag.md index eb01a6eb11..19c6a7c709 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getPendingMigrationFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getPendingMigrationFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getPendingMigrationFlag + Retrieve when true this virtual guest must be migrated using SoftLayer_Virtual_Guest::migrate. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getPlacementGroup.md b/content/reference/services/SoftLayer_Virtual_Guest/getPlacementGroup.md index ed371121b2..6a79cbd958 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getPlacementGroup.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getPlacementGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getPlacementGroup + Retrieve the placement group that a virtual guest belongs to. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getPowerState.md b/content/reference/services/SoftLayer_Virtual_Guest/getPowerState.md index ef518eba2b..457cbaa2ab 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getPowerState.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getPowerState.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getPowerState + Retrieve the current power state of a virtual guest. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getPrimaryBackendIpAddress.md b/content/reference/services/SoftLayer_Virtual_Guest/getPrimaryBackendIpAddress.md index ebf79213c8..80e0612ee4 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getPrimaryBackendIpAddress.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getPrimaryBackendIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getPrimaryBackendIpAddress + Retrieve a guest's primary private IP address. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getPrimaryBackendNetworkComponent.md b/content/reference/services/SoftLayer_Virtual_Guest/getPrimaryBackendNetworkComponent.md index 1c979cadc7..0f6c6a1db7 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getPrimaryBackendNetworkComponent.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getPrimaryBackendNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getPrimaryBackendNetworkComponent + Retrieve a guest's primary backend network component. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getPrimaryIpAddress.md b/content/reference/services/SoftLayer_Virtual_Guest/getPrimaryIpAddress.md index 59a7256068..ae48c2e904 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getPrimaryIpAddress.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getPrimaryIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getPrimaryIpAddress + Retrieve the guest's primary public IP address. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getPrimaryNetworkComponent.md b/content/reference/services/SoftLayer_Virtual_Guest/getPrimaryNetworkComponent.md index e153af483c..edcdb1fb4e 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getPrimaryNetworkComponent.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getPrimaryNetworkComponent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getPrimaryNetworkComponent + Retrieve a guest's primary public network component. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getPrivateNetworkOnlyFlag.md b/content/reference/services/SoftLayer_Virtual_Guest/getPrivateNetworkOnlyFlag.md index 4eaff77714..9fb29b8bf2 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getPrivateNetworkOnlyFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getPrivateNetworkOnlyFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getPrivateNetworkOnlyFlag + Retrieve whether the computing instance only has access to the private network. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getProjectedOverBandwidthAllocationFlag.md b/content/reference/services/SoftLayer_Virtual_Guest/getProjectedOverBandwidthAllocationFlag.md index 8ddaa46203..b9e04ccc1e 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getProjectedOverBandwidthAllocationFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getProjectedOverBandwidthAllocationFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getProjectedOverBandwidthAllocationFlag + Retrieve whether the bandwidth usage for this computing instance for the current billing cycle is projected to exceed the allocation. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getProjectedPublicBandwidthUsage.md b/content/reference/services/SoftLayer_Virtual_Guest/getProjectedPublicBandwidthUsage.md index 115e03aa58..8ff8a5b4b5 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getProjectedPublicBandwidthUsage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getProjectedPublicBandwidthUsage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getProjectedPublicBandwidthUsage + Retrieve the projected public outbound bandwidth for this computing instance for the current billing cycle. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getProvisionDate.md b/content/reference/services/SoftLayer_Virtual_Guest/getProvisionDate.md index a13d7c2cdb..0369cf1115 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getProvisionDate.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getProvisionDate.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getRecentEvents.md b/content/reference/services/SoftLayer_Virtual_Guest/getRecentEvents.md index 6291e3581c..3ab5f45138 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getRecentEvents.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getRecentEvents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getRecentEvents + Retrieve recent events that impact this computing instance. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getRecentMetricData.md b/content/reference/services/SoftLayer_Virtual_Guest/getRecentMetricData.md index cf9c9e9900..80a35c557c 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getRecentMetricData.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getRecentMetricData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getRecentMetricData + Recent metric data for a guest diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getRegionalGroup.md b/content/reference/services/SoftLayer_Virtual_Guest/getRegionalGroup.md index f7686bbf58..afee08f942 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getRegionalGroup.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getRegionalGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getRegionalGroup + Retrieve the regional group this guest is in. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getRegionalInternetRegistry.md b/content/reference/services/SoftLayer_Virtual_Guest/getRegionalInternetRegistry.md index 3855c5f7cc..175e1f9bcc 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getRegionalInternetRegistry.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getRegionalInternetRegistry.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getReservedCapacityGroup.md b/content/reference/services/SoftLayer_Virtual_Guest/getReservedCapacityGroup.md index 98fbd5d15c..4eaad0508b 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getReservedCapacityGroup.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getReservedCapacityGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getReservedCapacityGroup + Retrieve the reserved capacity group the guest is associated with. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getReservedCapacityGroupFlag.md b/content/reference/services/SoftLayer_Virtual_Guest/getReservedCapacityGroupFlag.md index 782c62c7bc..b9375d4c1c 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getReservedCapacityGroupFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getReservedCapacityGroupFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getReservedCapacityGroupFlag + Retrieve flag to indicate whether or not a guest is part of a reserved capacity group. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getReservedCapacityGroupInstance.md b/content/reference/services/SoftLayer_Virtual_Guest/getReservedCapacityGroupInstance.md index 78b9e44bc6..bcfa53b387 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getReservedCapacityGroupInstance.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getReservedCapacityGroupInstance.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getReservedCapacityGroupInstance + Retrieve the reserved capacity group instance the guest is associated with. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getReverseDomainRecords.md b/content/reference/services/SoftLayer_Virtual_Guest/getReverseDomainRecords.md index 9a4c798fdb..ad36e3c5ec 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getReverseDomainRecords.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getReverseDomainRecords.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getReverseDomainRecords + Retrieve the reverse domain records associated with a server. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getScaleAssets.md b/content/reference/services/SoftLayer_Virtual_Guest/getScaleAssets.md index 2dd7386b2f..4fd623d96c 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getScaleAssets.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getScaleAssets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getScaleAssets + Retrieve collection of scale assets this guest corresponds to. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getScaleMember.md b/content/reference/services/SoftLayer_Virtual_Guest/getScaleMember.md index 5f3ffc21a1..f8e69cb783 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getScaleMember.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getScaleMember.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getScaleMember + Retrieve the scale member for this guest, if applicable. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getScaledFlag.md b/content/reference/services/SoftLayer_Virtual_Guest/getScaledFlag.md index 1f5ec408a2..2a0b375a66 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getScaledFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getScaledFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getScaledFlag + Retrieve whether or not this guest is a member of a scale group and was automatically created as part of a scale group action. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getSecurityScanRequests.md b/content/reference/services/SoftLayer_Virtual_Guest/getSecurityScanRequests.md index ebf017acf0..6b4d933c14 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getSecurityScanRequests.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getSecurityScanRequests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getSecurityScanRequests + Retrieve a guest's vulnerability scan requests. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getServerRoom.md b/content/reference/services/SoftLayer_Virtual_Guest/getServerRoom.md index 482ea845ce..8a43069a4c 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getServerRoom.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getServerRoom.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getServerRoom + Retrieve the server room that a guest is located at. There may be more than one server room for every data center. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getSoftwareComponents.md b/content/reference/services/SoftLayer_Virtual_Guest/getSoftwareComponents.md index f256ddd308..7acccd1274 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getSoftwareComponents.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getSoftwareComponents.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getSoftwareComponents + Retrieve a guest's installed software. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getSshKeys.md b/content/reference/services/SoftLayer_Virtual_Guest/getSshKeys.md index aa2532d8fa..bd987f5e15 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getSshKeys.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getSshKeys.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getSshKeys + Retrieve sSH keys to be installed on the server during provisioning or an OS reload. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getStatus.md b/content/reference/services/SoftLayer_Virtual_Guest/getStatus.md index d0ac978849..c2831be4b3 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getStatus.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getStatus + Retrieve a computing instance's status. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getTagReferences.md b/content/reference/services/SoftLayer_Virtual_Guest/getTagReferences.md index 29334b85f8..f3071df61e 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getTagReferences.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getTagReferences.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getTransientGuestFlag.md b/content/reference/services/SoftLayer_Virtual_Guest/getTransientGuestFlag.md index e619026509..b27a8625f3 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getTransientGuestFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getTransientGuestFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getTransientGuestFlag + Retrieve whether or not a computing instance is a Transient Instance. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getTransientWebhookURI.md b/content/reference/services/SoftLayer_Virtual_Guest/getTransientWebhookURI.md index 60e5e949b5..da61273551 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getTransientWebhookURI.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getTransientWebhookURI.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getTransientWebhookURI + Retrieve the endpoint used to notify customers their transient guest is terminating. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getType.md b/content/reference/services/SoftLayer_Virtual_Guest/getType.md index 8e438979dd..5042205e1b 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getType.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getType + Retrieve the type of this virtual guest. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getUpgradeItemPrices.md b/content/reference/services/SoftLayer_Virtual_Guest/getUpgradeItemPrices.md index 38f7f8cc54..827f466eb9 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getUpgradeItemPrices.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getUpgradeItemPrices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getUpgradeItemPrices + Retrieve a computing instance's upgradeable items. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getUpgradeRequest.md b/content/reference/services/SoftLayer_Virtual_Guest/getUpgradeRequest.md index 362053a40a..5efff061aa 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getUpgradeRequest.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getUpgradeRequest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getUpgradeRequest + Retrieve a computing instance's associated upgrade request object if any. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getUserData.md b/content/reference/services/SoftLayer_Virtual_Guest/getUserData.md index 65a0a7c9db..c0af7894a7 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getUserData.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getUserData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getUserData + Retrieve a base64 encoded string containing custom user data for a Cloud Computing Instance order. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getUsers.md b/content/reference/services/SoftLayer_Virtual_Guest/getUsers.md index 49143e0b2f..20ef6721d1 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getUsers.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getUsers.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getUsers + Retrieve a list of users that have access to this computing instance. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getValidBlockDeviceTemplateGroups.md b/content/reference/services/SoftLayer_Virtual_Guest/getValidBlockDeviceTemplateGroups.md index 148c248a8c..2bc9e8011f 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getValidBlockDeviceTemplateGroups.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getValidBlockDeviceTemplateGroups.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getValidBlockDeviceTemplateGroups + Return a list of valid block device template groups based on this host diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getVirtualRack.md b/content/reference/services/SoftLayer_Virtual_Guest/getVirtualRack.md index 08e6932180..52dc8b8915 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getVirtualRack.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getVirtualRack.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getVirtualRack + Retrieve the name of the bandwidth allotment that a hardware belongs too. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getVirtualRackId.md b/content/reference/services/SoftLayer_Virtual_Guest/getVirtualRackId.md index 6a2f328740..32e637277f 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getVirtualRackId.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getVirtualRackId.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getVirtualRackId + Retrieve the id of the bandwidth allotment that a computing instance belongs too. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/getVirtualRackName.md b/content/reference/services/SoftLayer_Virtual_Guest/getVirtualRackName.md index 608442846c..02aa2a9682 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/getVirtualRackName.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/getVirtualRackName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::getVirtualRackName + Retrieve the name of the bandwidth allotment that a computing instance belongs too. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/isBackendPingable.md b/content/reference/services/SoftLayer_Virtual_Guest/isBackendPingable.md index b9ff45e5bb..f056c2b787 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/isBackendPingable.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/isBackendPingable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::isBackendPingable + Verifies if a guest's backend ip address is pingable. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/isCloudInit.md b/content/reference/services/SoftLayer_Virtual_Guest/isCloudInit.md index 97c59cd380..1025d76629 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/isCloudInit.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/isCloudInit.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::isCloudInit + Determines if the virtual guest was provisioned from a cloud-init enabled image. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/isPingable.md b/content/reference/services/SoftLayer_Virtual_Guest/isPingable.md index b2fdbeb89c..486ac4f6c8 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/isPingable.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/isPingable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::isPingable + Verifies if guest is pingable. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/isolateInstanceForDestructiveAction.md b/content/reference/services/SoftLayer_Virtual_Guest/isolateInstanceForDestructiveAction.md index 19fa1ac09a..ce22e725fd 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/isolateInstanceForDestructiveAction.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/isolateInstanceForDestructiveAction.md @@ -16,6 +16,7 @@ aliases: + ## Overview Closes the public or private ports to isolate the instance before a destructive action. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/migrate.md b/content/reference/services/SoftLayer_Virtual_Guest/migrate.md index bf0c6e23a3..8ed57b965b 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/migrate.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/migrate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::migrate + Creates a transaction to migrate a virtual guest to a new host. NOTE: Will only migrate if SoftLayer_Virtual_Guest property pendingMigrationFlag = true diff --git a/content/reference/services/SoftLayer_Virtual_Guest/migrateDedicatedHost.md b/content/reference/services/SoftLayer_Virtual_Guest/migrateDedicatedHost.md index 1f459ca622..515f4870a8 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/migrateDedicatedHost.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/migrateDedicatedHost.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::migrateDedicatedHost + Migrate a dedicated instance from one dedicated host to another dedicated host diff --git a/content/reference/services/SoftLayer_Virtual_Guest/mountIsoImage.md b/content/reference/services/SoftLayer_Virtual_Guest/mountIsoImage.md index 0da4d18e6e..0a4b7a3878 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/mountIsoImage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/mountIsoImage.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/pause.md b/content/reference/services/SoftLayer_Virtual_Guest/pause.md index 9abe3a096a..964bcdf4fa 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/pause.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/pause.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::pause + Pause a guest. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/powerCycle.md b/content/reference/services/SoftLayer_Virtual_Guest/powerCycle.md index a5842dd90c..cef5563d92 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/powerCycle.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/powerCycle.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::powerCycle + Power cycle a guest. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/powerOff.md b/content/reference/services/SoftLayer_Virtual_Guest/powerOff.md index 2c63543a95..46a75ff0c5 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/powerOff.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/powerOff.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::powerOff + Power off a guest. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/powerOffSoft.md b/content/reference/services/SoftLayer_Virtual_Guest/powerOffSoft.md index e371761206..6c19811007 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/powerOffSoft.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/powerOffSoft.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::powerOffSoft + Cleanly shut down a guest and disable power diff --git a/content/reference/services/SoftLayer_Virtual_Guest/powerOn.md b/content/reference/services/SoftLayer_Virtual_Guest/powerOn.md index 7e5ca3d1d1..03f1b3db28 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/powerOn.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/powerOn.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::powerOn + Power on a guest. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/rebootDefault.md b/content/reference/services/SoftLayer_Virtual_Guest/rebootDefault.md index f73c7edf5e..43a8b890fb 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/rebootDefault.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/rebootDefault.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::rebootDefault + Power cycle a guest. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/rebootHard.md b/content/reference/services/SoftLayer_Virtual_Guest/rebootHard.md index ce56d91d70..845aa57832 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/rebootHard.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/rebootHard.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::rebootHard + Power cycle a guest. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/rebootSoft.md b/content/reference/services/SoftLayer_Virtual_Guest/rebootSoft.md index 490e454f6b..a768ac062b 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/rebootSoft.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/rebootSoft.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::rebootSoft + Attempt to complete a soft reboot of a guest by shutting down the operating system. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/reloadCurrentOperatingSystemConfiguration.md b/content/reference/services/SoftLayer_Virtual_Guest/reloadCurrentOperatingSystemConfiguration.md index 9cc5c2c628..b134ac6f0a 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/reloadCurrentOperatingSystemConfiguration.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/reloadCurrentOperatingSystemConfiguration.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::reloadCurrentOperatingSystemConfiguration + Perform an OS reload diff --git a/content/reference/services/SoftLayer_Virtual_Guest/reloadOperatingSystem.md b/content/reference/services/SoftLayer_Virtual_Guest/reloadOperatingSystem.md index f1132de8f8..7d9f0454e5 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/reloadOperatingSystem.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/reloadOperatingSystem.md @@ -15,6 +15,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::reloadOperatingSystem + Reloads operating system configuration. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/removeAccessToNetworkStorage.md b/content/reference/services/SoftLayer_Virtual_Guest/removeAccessToNetworkStorage.md index eef961121c..3c74e167ca 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/removeAccessToNetworkStorage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/removeAccessToNetworkStorage.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::removeAccessToNetworkStorage + Remove access to a SoftLayer_Network_Storage volume from this device. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/removeAccessToNetworkStorageList.md b/content/reference/services/SoftLayer_Virtual_Guest/removeAccessToNetworkStorageList.md index e5e3fa787b..84fe34f1d2 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/removeAccessToNetworkStorageList.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/removeAccessToNetworkStorageList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::removeAccessToNetworkStorageList + Remove access to multiple SoftLayer_Network_Storage volumes from this device. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/removeTags.md b/content/reference/services/SoftLayer_Virtual_Guest/removeTags.md index 93d39ceea2..32c553a068 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/removeTags.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/removeTags.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::removeTags + Remove a tag reference diff --git a/content/reference/services/SoftLayer_Virtual_Guest/resume.md b/content/reference/services/SoftLayer_Virtual_Guest/resume.md index e207511c58..b23b02f555 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/resume.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/resume.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::resume + Resume a guest. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/sendTestReclaimScheduledAlert.md b/content/reference/services/SoftLayer_Virtual_Guest/sendTestReclaimScheduledAlert.md index 15500998e1..a2d115bafe 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/sendTestReclaimScheduledAlert.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/sendTestReclaimScheduledAlert.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/setPrivateNetworkInterfaceSpeed.md b/content/reference/services/SoftLayer_Virtual_Guest/setPrivateNetworkInterfaceSpeed.md index c2940d1ef0..5823ccc8cc 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/setPrivateNetworkInterfaceSpeed.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/setPrivateNetworkInterfaceSpeed.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::setPrivateNetworkInterfaceSpeed + Updates the private network interface (eth0) speed. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/setPublicNetworkInterfaceSpeed.md b/content/reference/services/SoftLayer_Virtual_Guest/setPublicNetworkInterfaceSpeed.md index f9637dfe65..63484b70db 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/setPublicNetworkInterfaceSpeed.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/setPublicNetworkInterfaceSpeed.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::setPublicNetworkInterfaceSpeed + Updates the public network interface (eth1) speed. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/setTags.md b/content/reference/services/SoftLayer_Virtual_Guest/setTags.md index 0edbabb762..794aec5cd9 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/setTags.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/setTags.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/setTransientWebhook.md b/content/reference/services/SoftLayer_Virtual_Guest/setTransientWebhook.md index 0f73d56704..9397a89478 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/setTransientWebhook.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/setTransientWebhook.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/setUserMetadata.md b/content/reference/services/SoftLayer_Virtual_Guest/setUserMetadata.md index 0f9b85ffc5..9ff32e58f5 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/setUserMetadata.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/setUserMetadata.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::setUserMetadata + Configures the guest's metadata disk. diff --git a/content/reference/services/SoftLayer_Virtual_Guest/shutdownPrivatePort.md b/content/reference/services/SoftLayer_Virtual_Guest/shutdownPrivatePort.md index cf8e4c61b9..24a799f37e 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/shutdownPrivatePort.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/shutdownPrivatePort.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::shutdownPrivatePort + Shuts down the private port diff --git a/content/reference/services/SoftLayer_Virtual_Guest/shutdownPublicPort.md b/content/reference/services/SoftLayer_Virtual_Guest/shutdownPublicPort.md index 4205e560b7..350add40b9 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/shutdownPublicPort.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/shutdownPublicPort.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::shutdownPublicPort + Shuts down the public port diff --git a/content/reference/services/SoftLayer_Virtual_Guest/unmountIsoImage.md b/content/reference/services/SoftLayer_Virtual_Guest/unmountIsoImage.md index 7179d8e6c2..62b0774536 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/unmountIsoImage.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/unmountIsoImage.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest/validateImageTemplate.md b/content/reference/services/SoftLayer_Virtual_Guest/validateImageTemplate.md index 2d3ed65bae..df637092e6 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/validateImageTemplate.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/validateImageTemplate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::validateImageTemplate + Validates an image template for OS Reload diff --git a/content/reference/services/SoftLayer_Virtual_Guest/verifyReloadOperatingSystem.md b/content/reference/services/SoftLayer_Virtual_Guest/verifyReloadOperatingSystem.md index ba47b265e1..e49f4195f2 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest/verifyReloadOperatingSystem.md +++ b/content/reference/services/SoftLayer_Virtual_Guest/verifyReloadOperatingSystem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest](/reference/services/SoftLayer_Virtual_Guest)::verifyReloadOperatingSystem + Verify that a virtual server can go through the operating system reload process. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/_index.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/_index.md index 01169ca89e..4b747a6381 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/_index.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,390 +44,455 @@ The virtual guest block device template group service provides a common interfac #### [addByolAttribute](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addByolAttribute) +
              #### [addCloudInitAttribute](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addCloudInitAttribute) +
              #### [addLocations](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addLocations) [SoftLayer_Virtual_Guest_Block_Device]({{}}) can be made available in all storage locations. This method will create transaction(s) to add available locations to an archive image template. +
              #### [addSupportedBootMode](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addSupportedBootMode) +
              #### [copyToExternalSource](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/copyToExternalSource) This method generates a transaction to export/copy a template to an external source. +
              #### [copyToIcos](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/copyToIcos) This method generates a transaction to export/copy a template to IBM Cloud Object Storage (ICOS) +
              #### [createFromExternalSource](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/createFromExternalSource) This method generates a transaction to import a disk image from an external source and create a standard image template. +
              #### [createFromIcos](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/createFromIcos) This method generates a process instance to import a disk image from ICOS and create a standard image template. +
              #### [createPublicArchiveTransaction](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/createPublicArchiveTransaction) [SoftLayer_Virtual_Guest_Block_Device]({{}}) can be published together in a public repository for use by everyone. This method generates a transaction to perform a public image of the provided archived block devices. +
              #### [deleteByolAttribute](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/deleteByolAttribute) +
              #### [deleteCloudInitAttribute](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/deleteCloudInitAttribute) +
              #### [deleteObject](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/deleteObject) Create a transaction that will remove all block device templates from the group and delete the disk images associated with them. +
              #### [denySharingAccess](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/denySharingAccess) Deny another SoftLayer customer account's previously given access to provision CloudLayer Computing Instances from an image template group. Template access should only be removed from the parent template group object, not the child. +
              #### [editObject](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/editObject) Edit an image template group's name and note. +
              #### [findGcImagesByCurrentUser](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/findGcImagesByCurrentUser) Fetch a sorted collection of GC enabled cloudinit images for the account of the current active customer user. +
              #### [getAccount](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAccount) Retrieve a block device template group's [SoftLayer_Account]({{}}). +
              #### [getAccountContacts](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAccountContacts) +
              #### [getAccountReferences](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAccountReferences) Retrieve the accounts which may have read-only access to an image template group. Will only be populated for parent template group objects. +
              #### [getAllAvailableCompatiblePlatformNames](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAllAvailableCompatiblePlatformNames) +
              #### [getBlockDevices](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getBlockDevices) Retrieve the block devices that are part of an image template group +
              #### [getBlockDevicesDiskSpaceTotal](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getBlockDevicesDiskSpaceTotal) Retrieve the total disk space of all images in a image template group. +
              #### [getBootMode](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getBootMode) +
              #### [getByolFlag](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getByolFlag) Retrieve a flag indicating that customer is providing the software licenses. +
              #### [getChildren](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getChildren) Retrieve the image template groups that are clones of an image template group. +
              #### [getCurrentCompatiblePlatformNames](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getCurrentCompatiblePlatformNames) +
              #### [getDatacenter](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getDatacenter) Retrieve the location containing this image template group. Will only be populated for child template group objects. +
              #### [getDatacenters](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getDatacenters) Retrieve a collection of locations containing a copy of this image template group. Will only be populated for parent template group objects. +
              #### [getDefaultBootMode](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getDefaultBootMode) +
              #### [getEncryptionAttributes](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getEncryptionAttributes) +
              #### [getFirstChild](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getFirstChild) Retrieve the first clone of the image template group +
              #### [getFlexImageFlag](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getFlexImageFlag) Retrieve a flag indicating if this is a flex image. +
              #### [getGlobalIdentifier](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getGlobalIdentifier) Retrieve an image template's universally unique identifier. +
              #### [getImageType](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getImageType) Retrieve the virtual disk image type of this template. Value will be populated on parent and child, but only supports object filtering on the parent. +
              #### [getImageTypeKeyName](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getImageTypeKeyName) Retrieve the virtual disk image type keyname (e.g. SYSTEM, DISK_CAPTURE, ISO, etc) of this template. Value will be populated on parent and child, but only supports object filtering on the parent. +
              #### [getNextGenFlag](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getNextGenFlag) Retrieve a flag indicating if this is a next generation image. +
              #### [getObject](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getObject) Retrieve a SoftLayer_Virtual_Guest_Block_Device_Template_Group record. +
              #### [getParent](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getParent) Retrieve the image template group that another image template group was cloned from. +
              #### [getPublicCustomerOwnedImages](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getPublicCustomerOwnedImages) Gets all public customer owned image templates that the user is allowed to see. +
              #### [getPublicImages](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getPublicImages) Gets all public image templates that the user is allowed to see. +
              #### [getRegion](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRegion) +
              #### [getRegions](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRegions) +
              #### [getRiasAccount](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRiasAccount) +
              #### [getSshKeys](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getSshKeys) Retrieve the ssh keys to be implemented on the server when provisioned or reloaded from an image template group. +
              #### [getStatus](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getStatus) Retrieve a template group's status. +
              #### [getStorageLocations](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getStorageLocations) The available locations for public image storage. +
              #### [getStorageRepository](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getStorageRepository) Retrieve the storage repository that an image template group resides on. +
              #### [getSupportedBootModes](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getSupportedBootModes) +
              #### [getTagReferences](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getTagReferences) Retrieve the tags associated with this image template group. +
              #### [getTemplateDataCenterName](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getTemplateDataCenterName) +
              #### [getTransaction](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getTransaction) Retrieve a transaction that is being performed on a image template group. +
              #### [getVhdImportSoftwareDescriptions](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getVhdImportSoftwareDescriptions) Returns the software descriptions supported for VHD imports. +
              #### [isByol](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isByol) +
              #### [isByolCapableOperatingSystem](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isByolCapableOperatingSystem) +
              #### [isByolOnlyOperatingSystem](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isByolOnlyOperatingSystem) +
              #### [isCloudInit](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isCloudInit) +
              #### [isCloudInitOnlyOperatingSystem](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isCloudInitOnlyOperatingSystem) +
              #### [isEncrypted](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isEncrypted) +
              #### [permitSharingAccess](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/permitSharingAccess) Permit another SoftLayer customer account access to provision CloudLayer Computing Instances from an image template group. Template access should only be given to the parent template group object, not the child. +
              #### [removeCompatiblePlatforms](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/removeCompatiblePlatforms) +
              #### [removeLocations](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/removeLocations) [SoftLayer_Virtual_Guest_Block_Device]({{}}) can be made available in all storage locations. This method will create transaction(s) to remove available locations from an archive image template. +
              #### [removeSupportedBootMode](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/removeSupportedBootMode) +
              #### [setAvailableLocations](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setAvailableLocations) This method generates the necessary transaction(s) to set available locations for archived block devices. +
              #### [setBootMode](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setBootMode) +
              #### [setCompatiblePlatforms](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setCompatiblePlatforms) +
              #### [setTags](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setTags) Set the tags for this template group. +
              diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addByolAttribute.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addByolAttribute.md index 75e69e1ff5..02fa1b7414 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addByolAttribute.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addByolAttribute.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method allows you to mark this image template as customer managed software license (BYOL) diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addCloudInitAttribute.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addCloudInitAttribute.md index 2a1c3b7519..d468fe83c6 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addCloudInitAttribute.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addCloudInitAttribute.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method allows you to mark this image template as cloud init diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addLocations.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addLocations.md index 663f2ab76b..dd78f975e2 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addLocations.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addLocations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::addLocations + [SoftLayer_Virtual_Guest_Block_Device]({{}}) can be made available in all storage locations. This method will create transaction(s) to add available locations to an archive image template. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addSupportedBootMode.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addSupportedBootMode.md index 88e9cdbcdd..4a395876cb 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addSupportedBootMode.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/addSupportedBootMode.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method allows you to mark this image's supported boot modes as 'HVM' or 'PV'. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/copyToExternalSource.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/copyToExternalSource.md index 3f12b0361f..4f9d098f9e 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/copyToExternalSource.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/copyToExternalSource.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::copyToExternalSource + This method generates a transaction to export/copy a template to an external source. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/copyToIcos.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/copyToIcos.md index 98794bc1a1..925cb9c058 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/copyToIcos.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/copyToIcos.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::copyToIcos + This method generates a transaction to export/copy a template to IBM Cloud Object Storage (ICOS) diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/createFromExternalSource.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/createFromExternalSource.md index 8aad241e4a..9c4c21b196 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/createFromExternalSource.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/createFromExternalSource.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::createFromExternalSource + This method generates a transaction to import a disk image from an external source and create a standard image template. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/createFromIcos.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/createFromIcos.md index 241b7683a2..1782520cd4 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/createFromIcos.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/createFromIcos.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::createFromIcos + This method generates a process instance to import a disk image from ICOS and create a standard image template. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/createPublicArchiveTransaction.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/createPublicArchiveTransaction.md index 93f7891a57..4fdbbbf509 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/createPublicArchiveTransaction.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/createPublicArchiveTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::createPublicArchiveTransaction + [SoftLayer_Virtual_Guest_Block_Device]({{}}) can be published together in a public repository for use by everyone. This method generates a transaction to perform a public image of the provided archived block devices. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/deleteByolAttribute.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/deleteByolAttribute.md index 70ba75e2c5..8746e72325 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/deleteByolAttribute.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/deleteByolAttribute.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method allows you to remove BYOL attribute for a given image template. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/deleteCloudInitAttribute.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/deleteCloudInitAttribute.md index 4d5b09f007..991b7cd39a 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/deleteCloudInitAttribute.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/deleteCloudInitAttribute.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method allows you to remove cloud init attribute for a given image template. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/deleteObject.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/deleteObject.md index 81d884d8bf..98e36e11b1 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/deleteObject.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::deleteObject + Create a transaction that will remove all block device templates from the group and delete the disk images associated with them. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/denySharingAccess.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/denySharingAccess.md index d418d0be55..18dc526555 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/denySharingAccess.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/denySharingAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::denySharingAccess + Deny another SoftLayer customer account's previously given access to provision CloudLayer Computing Instances from an image template group. Template access should only be removed from the parent template group object, not the child. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/editObject.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/editObject.md index 245ba9c7dd..1919b4e5e8 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/editObject.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::editObject + Edit an image template group's name and note. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/findGcImagesByCurrentUser.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/findGcImagesByCurrentUser.md index 6cb1caa5fc..629fb64a09 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/findGcImagesByCurrentUser.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/findGcImagesByCurrentUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::findGcImagesByCurrentUser + Fetch a sorted collection of GC enabled cloudinit images for the account of the current active customer user. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAccount.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAccount.md index f056395d7f..aad0684830 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAccount.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getAccount + Retrieve a block device template group's [SoftLayer_Account]({{}}). diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAccountContacts.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAccountContacts.md index 3403eb5697..d09a65e85e 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAccountContacts.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAccountContacts.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAccountReferences.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAccountReferences.md index e29a9c02ac..c424bfc077 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAccountReferences.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAccountReferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getAccountReferences + Retrieve the accounts which may have read-only access to an image template group. Will only be populated for parent template group objects. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAllAvailableCompatiblePlatformNames.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAllAvailableCompatiblePlatformNames.md index d6465a2e7f..1f36895ec0 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAllAvailableCompatiblePlatformNames.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getAllAvailableCompatiblePlatformNames.md @@ -16,6 +16,7 @@ aliases: + ## Overview Get all available compatible platform names that can be added to a template group. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getBlockDevices.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getBlockDevices.md index 6ed5322849..cad6d3939c 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getBlockDevices.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getBlockDevices.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getBlockDevices + Retrieve the block devices that are part of an image template group diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getBlockDevicesDiskSpaceTotal.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getBlockDevicesDiskSpaceTotal.md index 650d2e48f2..29b8b8a10f 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getBlockDevicesDiskSpaceTotal.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getBlockDevicesDiskSpaceTotal.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getBlockDevicesDiskSpaceTotal + Retrieve the total disk space of all images in a image template group. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getBootMode.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getBootMode.md index 6f04922c3d..71663f1126 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getBootMode.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getBootMode.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method returns the boot mode, if any, set on a given image template. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getByolFlag.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getByolFlag.md index b8c4a6ea8e..0f7c192390 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getByolFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getByolFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getByolFlag + Retrieve a flag indicating that customer is providing the software licenses. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getChildren.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getChildren.md index 2292d4271d..a1cbfd411f 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getChildren.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getChildren.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getChildren + Retrieve the image template groups that are clones of an image template group. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getCurrentCompatiblePlatformNames.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getCurrentCompatiblePlatformNames.md index f8c781a118..5c85459511 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getCurrentCompatiblePlatformNames.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getCurrentCompatiblePlatformNames.md @@ -16,6 +16,7 @@ aliases: + ## Overview Get compatible platform names currently set on the template group. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getDatacenter.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getDatacenter.md index 1cc8a1e478..2adf19c3bb 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getDatacenter.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getDatacenter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getDatacenter + Retrieve the location containing this image template group. Will only be populated for child template group objects. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getDatacenters.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getDatacenters.md index 770c283a2b..00f2cc87ba 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getDatacenters.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getDatacenters.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getDatacenters + Retrieve a collection of locations containing a copy of this image template group. Will only be populated for parent template group objects. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getDefaultBootMode.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getDefaultBootMode.md index 4bb9243c01..85211ed0ea 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getDefaultBootMode.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getDefaultBootMode.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method returns the default boot mode set by the software description diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getEncryptionAttributes.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getEncryptionAttributes.md index de0f582dce..7b2699321b 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getEncryptionAttributes.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getEncryptionAttributes.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method returns an array of encryption values, or empty array if none are found diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getFirstChild.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getFirstChild.md index ec46b18751..9bdf2c6d5b 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getFirstChild.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getFirstChild.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getFirstChild + Retrieve the first clone of the image template group diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getFlexImageFlag.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getFlexImageFlag.md index 7339557377..66ee488bba 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getFlexImageFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getFlexImageFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getFlexImageFlag + Retrieve a flag indicating if this is a flex image. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getGlobalIdentifier.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getGlobalIdentifier.md index 335d198801..cf7414c1ea 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getGlobalIdentifier.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getGlobalIdentifier.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getGlobalIdentifier + Retrieve an image template's universally unique identifier. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getImageType.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getImageType.md index c375c5831a..06b4e67afa 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getImageType.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getImageType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getImageType + Retrieve the virtual disk image type of this template. Value will be populated on parent and child, but only supports object filtering on the parent. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getImageTypeKeyName.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getImageTypeKeyName.md index e4f45b04cb..b859878103 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getImageTypeKeyName.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getImageTypeKeyName.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getImageTypeKeyName + Retrieve the virtual disk image type keyname (e.g. SYSTEM, DISK_CAPTURE, ISO, etc) of this template. Value will be populated on parent and child, but only supports object filtering on the parent. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getNextGenFlag.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getNextGenFlag.md index 870956f142..f73edbb89d 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getNextGenFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getNextGenFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getNextGenFlag + Retrieve a flag indicating if this is a next generation image. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getObject.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getObject.md index 0d4e7172a6..b04dbdc7dd 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getObject.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getObject + Retrieve a SoftLayer_Virtual_Guest_Block_Device_Template_Group record. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getParent.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getParent.md index 0485476041..e267a8981c 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getParent.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getParent.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getParent + Retrieve the image template group that another image template group was cloned from. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getPublicCustomerOwnedImages.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getPublicCustomerOwnedImages.md index 8ac96247d7..14cf334039 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getPublicCustomerOwnedImages.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getPublicCustomerOwnedImages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getPublicCustomerOwnedImages + Gets all public customer owned image templates that the user is allowed to see. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getPublicImages.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getPublicImages.md index 2154c69046..d3b930eeb0 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getPublicImages.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getPublicImages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getPublicImages + Gets all public image templates that the user is allowed to see. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRegion.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRegion.md index 5010c94669..e2bc997667 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRegion.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRegion.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRegions.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRegions.md index 8084f3710d..fe19bc22b7 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRegions.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRegions.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRiasAccount.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRiasAccount.md index 8b34e39713..5a025a3371 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRiasAccount.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRiasAccount.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getSshKeys.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getSshKeys.md index e22f0cdf80..60282264f2 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getSshKeys.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getSshKeys.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getSshKeys + Retrieve the ssh keys to be implemented on the server when provisioned or reloaded from an image template group. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getStatus.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getStatus.md index 92cda0cef8..7ca1c0cd99 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getStatus.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getStatus.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getStatus + Retrieve a template group's status. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getStorageLocations.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getStorageLocations.md index 8c479d53b3..a0b5a38331 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getStorageLocations.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getStorageLocations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getStorageLocations + The available locations for public image storage. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getStorageRepository.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getStorageRepository.md index 42c37c702e..03e934ea26 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getStorageRepository.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getStorageRepository.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getStorageRepository + Retrieve the storage repository that an image template group resides on. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getSupportedBootModes.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getSupportedBootModes.md index 094da8e25f..6d778fa4f8 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getSupportedBootModes.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getSupportedBootModes.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method indicates which boot modes are supported by the image. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getTagReferences.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getTagReferences.md index e5eff31afa..fb3e59e786 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getTagReferences.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getTagReferences.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getTagReferences + Retrieve the tags associated with this image template group. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getTemplateDataCenterName.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getTemplateDataCenterName.md index 4ae92b5d89..66528584c4 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getTemplateDataCenterName.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getTemplateDataCenterName.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method allows you to grab the first data center that the image(s) reside on so we can pull it from there. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getTransaction.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getTransaction.md index 359dd4572a..398b8c0bb3 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getTransaction.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getTransaction.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getTransaction + Retrieve a transaction that is being performed on a image template group. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getVhdImportSoftwareDescriptions.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getVhdImportSoftwareDescriptions.md index 017b348c85..cf89d1077f 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getVhdImportSoftwareDescriptions.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getVhdImportSoftwareDescriptions.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::getVhdImportSoftwareDescriptions + Returns the software descriptions supported for VHD imports. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isByol.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isByol.md index 9479b15ee2..ad53b22b52 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isByol.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isByol.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method indicates whether or not this image is a customer supplied license image. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isByolCapableOperatingSystem.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isByolCapableOperatingSystem.md index c4c7dcd97f..9148c2aaf9 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isByolCapableOperatingSystem.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isByolCapableOperatingSystem.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method indicates whether or not this image uses an operating system capable of using a customer supplied license image. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isByolOnlyOperatingSystem.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isByolOnlyOperatingSystem.md index ee9265f90b..06b0c52216 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isByolOnlyOperatingSystem.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isByolOnlyOperatingSystem.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method indicates whether or not this image uses an operating system that requires using a customer supplied license image diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isCloudInit.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isCloudInit.md index 640ee31eb7..2fab6f9af1 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isCloudInit.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isCloudInit.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method indicates whether or not this image is a cloud-init image. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isCloudInitOnlyOperatingSystem.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isCloudInitOnlyOperatingSystem.md index f1fbe19dec..33e6492bd6 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isCloudInitOnlyOperatingSystem.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isCloudInitOnlyOperatingSystem.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method indicates whether or not this image uses an operating system that requires cloud init diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isEncrypted.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isEncrypted.md index 5319a89a9d..bcf5fbf668 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isEncrypted.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/isEncrypted.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method indicates whether this image template contains an encrypted disk image. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/permitSharingAccess.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/permitSharingAccess.md index a6af4a78f3..9ab81b9441 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/permitSharingAccess.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/permitSharingAccess.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::permitSharingAccess + Permit another SoftLayer customer account access to provision CloudLayer Computing Instances from an image template group. Template access should only be given to the parent template group object, not the child. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/removeCompatiblePlatforms.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/removeCompatiblePlatforms.md index 491903f4b1..8a3490f425 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/removeCompatiblePlatforms.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/removeCompatiblePlatforms.md @@ -16,6 +16,7 @@ aliases: + ## Overview Removes compatible platforms on the template group. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/removeLocations.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/removeLocations.md index 83c6af1a88..3d0fda43bc 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/removeLocations.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/removeLocations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::removeLocations + [SoftLayer_Virtual_Guest_Block_Device]({{}}) can be made available in all storage locations. This method will create transaction(s) to remove available locations from an archive image template. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/removeSupportedBootMode.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/removeSupportedBootMode.md index 7113e93950..069e85e46e 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/removeSupportedBootMode.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/removeSupportedBootMode.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method allows you to remove a supported boot mode attribute for a given image template. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setAvailableLocations.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setAvailableLocations.md index fb89f397fe..c5d5496849 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setAvailableLocations.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setAvailableLocations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::setAvailableLocations + This method generates the necessary transaction(s) to set available locations for archived block devices. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setBootMode.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setBootMode.md index 2e050cc1f5..648bb05982 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setBootMode.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setBootMode.md @@ -16,6 +16,7 @@ aliases: + ## Overview This method allows you to specify the boot mode for a given image template. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setCompatiblePlatforms.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setCompatiblePlatforms.md index cb04e1854e..6abd4f9f58 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setCompatiblePlatforms.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setCompatiblePlatforms.md @@ -16,6 +16,7 @@ aliases: + ## Overview Sets compatible platforms on the template group. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setTags.md b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setTags.md index 3f97be9337..f8240b9579 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setTags.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/setTags.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Block_Device_Template_Group](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group)::setTags + Set the tags for this template group. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/_index.md b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/_index.md index 5e0ed611c3..84b0ea0c53 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/_index.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,36 +44,42 @@ classes: #### [createObject](/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/createObject) Create a boot parameter record to be used at next boot +
              #### [deleteObject](/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/deleteObject) Removes a boot parameter +
              #### [editObject](/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/editObject) Edits a single boot parameter +
              #### [getGuest](/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/getGuest) +
              #### [getGuestBootParameterType](/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/getGuestBootParameterType) +
              #### [getObject](/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/getObject) Retrieve a SoftLayer_Virtual_Guest_Boot_Parameter record. +
              diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/createObject.md b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/createObject.md index 78326d0881..8e37ee2694 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/createObject.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Boot_Parameter](/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter)::createObject + Create a boot parameter record to be used at next boot diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/deleteObject.md b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/deleteObject.md index fa6ab1fb36..4375009762 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/deleteObject.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/deleteObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Boot_Parameter](/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter)::deleteObject + Removes a boot parameter diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/editObject.md b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/editObject.md index 1dbb1a3bb2..0d6fb5831f 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/editObject.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/editObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Boot_Parameter](/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter)::editObject + Edits a single boot parameter diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/getGuest.md b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/getGuest.md index 3d5f0d91b9..7e4ef124f8 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/getGuest.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/getGuest.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/getGuestBootParameterType.md b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/getGuestBootParameterType.md index 12e6982688..18a3797432 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/getGuestBootParameterType.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/getGuestBootParameterType.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/getObject.md b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/getObject.md index c95430f175..3da1099fb4 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/getObject.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Boot_Parameter](/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter)::getObject + Retrieve a SoftLayer_Virtual_Guest_Boot_Parameter record. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter_Type/_index.md b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter_Type/_index.md index b31924d91d..2ef97ba703 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter_Type/_index.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter_Type/_index.md @@ -22,6 +22,8 @@ classes: + +
              @@ -42,12 +44,14 @@ classes: #### [getAllObjects](/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter_Type/getAllObjects) +
              #### [getObject](/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter_Type/getObject) Retrieve a SoftLayer_Virtual_Guest_Boot_Parameter_Type record. +
              diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter_Type/getAllObjects.md b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter_Type/getAllObjects.md index 412aedee77..6e489544e6 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter_Type/getAllObjects.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter_Type/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter_Type/getObject.md b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter_Type/getObject.md index 52a9aa0dfc..f0714befcc 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter_Type/getObject.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Boot_Parameter_Type](/reference/services/SoftLayer_Virtual_Guest_Boot_Parameter_Type)::getObject + Retrieve a SoftLayer_Virtual_Guest_Boot_Parameter_Type record. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/_index.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/_index.md index 11966f778c..5081fc8f93 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/_index.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The virtual guest network component service provides a common interface to a [SoftLayer_Virtual_Guest]({{}}) network component. Interaction with various third party APIs is not needed when implementing this service to administer your computing instances. @@ -42,108 +44,126 @@ The virtual guest network component service provides a common interface to a [So #### [disable](/reference/services/SoftLayer_Virtual_Guest_Network_Component/disable) Disable a network component to restrict network traffic +
              #### [enable](/reference/services/SoftLayer_Virtual_Guest_Network_Component/enable) Enable a network component to allow network traffic +
              #### [getGuest](/reference/services/SoftLayer_Virtual_Guest_Network_Component/getGuest) Retrieve the computing instance that this network component exists on. +
              #### [getHighAvailabilityFirewallFlag](/reference/services/SoftLayer_Virtual_Guest_Network_Component/getHighAvailabilityFirewallFlag) +
              #### [getIcpBinding](/reference/services/SoftLayer_Virtual_Guest_Network_Component/getIcpBinding) +
              #### [getIpAddressBindings](/reference/services/SoftLayer_Virtual_Guest_Network_Component/getIpAddressBindings) Retrieve the records of all IP addresses bound to a computing instance's network component. +
              #### [getNetworkComponentFirewall](/reference/services/SoftLayer_Virtual_Guest_Network_Component/getNetworkComponentFirewall) Retrieve the upstream network component firewall. +
              #### [getNetworkVlan](/reference/services/SoftLayer_Virtual_Guest_Network_Component/getNetworkVlan) Retrieve the VLAN that a computing instance network component's subnet is associated with. +
              #### [getObject](/reference/services/SoftLayer_Virtual_Guest_Network_Component/getObject) Retrieve a SoftLayer_Virtual_Guest_Network_Component record. +
              #### [getPrimaryIpAddress](/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimaryIpAddress) Retrieve a computing instance network component's primary IP address. +
              #### [getPrimaryIpAddressRecord](/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimaryIpAddressRecord) +
              #### [getPrimarySubnet](/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimarySubnet) Retrieve a network component's subnet for its primary IP address +
              #### [getPrimaryVersion6IpAddressRecord](/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimaryVersion6IpAddressRecord) Retrieve a network component's primary IPv6 IP address record. +
              #### [getRouter](/reference/services/SoftLayer_Virtual_Guest_Network_Component/getRouter) Retrieve a network component's routers. +
              #### [getSecurityGroupBindings](/reference/services/SoftLayer_Virtual_Guest_Network_Component/getSecurityGroupBindings) Retrieve the bindings associating security groups to this network component +
              #### [getSubnets](/reference/services/SoftLayer_Virtual_Guest_Network_Component/getSubnets) Retrieve a network component's subnets. A subnet is a group of IP addresses +
              #### [isPingable](/reference/services/SoftLayer_Virtual_Guest_Network_Component/isPingable) Verifies if network component is pingable. +
              #### [securityGroupsReady](/reference/services/SoftLayer_Virtual_Guest_Network_Component/securityGroupsReady) +
              diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/disable.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/disable.md index 130e41ea16..22d4536e71 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/disable.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/disable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Network_Component](/reference/services/SoftLayer_Virtual_Guest_Network_Component)::disable + Disable a network component to restrict network traffic diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/enable.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/enable.md index 590ee65c62..888e613b4a 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/enable.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/enable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Network_Component](/reference/services/SoftLayer_Virtual_Guest_Network_Component)::enable + Enable a network component to allow network traffic diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getGuest.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getGuest.md index 3c4e7105c7..3539e26c8f 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getGuest.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Network_Component](/reference/services/SoftLayer_Virtual_Guest_Network_Component)::getGuest + Retrieve the computing instance that this network component exists on. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getHighAvailabilityFirewallFlag.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getHighAvailabilityFirewallFlag.md index df7aac11c2..2ed11392b6 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getHighAvailabilityFirewallFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getHighAvailabilityFirewallFlag.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getIcpBinding.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getIcpBinding.md index 8b190a9d75..3bd1ea67d8 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getIcpBinding.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getIcpBinding.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getIpAddressBindings.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getIpAddressBindings.md index da9754b021..6c2e6d33ad 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getIpAddressBindings.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getIpAddressBindings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Network_Component](/reference/services/SoftLayer_Virtual_Guest_Network_Component)::getIpAddressBindings + Retrieve the records of all IP addresses bound to a computing instance's network component. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getNetworkComponentFirewall.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getNetworkComponentFirewall.md index 095b5469a6..9eed577262 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getNetworkComponentFirewall.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getNetworkComponentFirewall.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Network_Component](/reference/services/SoftLayer_Virtual_Guest_Network_Component)::getNetworkComponentFirewall + Retrieve the upstream network component firewall. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getNetworkVlan.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getNetworkVlan.md index a15035cdc1..1238c47d12 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getNetworkVlan.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getNetworkVlan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Network_Component](/reference/services/SoftLayer_Virtual_Guest_Network_Component)::getNetworkVlan + Retrieve the VLAN that a computing instance network component's subnet is associated with. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getObject.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getObject.md index 89c7b62145..d938657d44 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getObject.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Network_Component](/reference/services/SoftLayer_Virtual_Guest_Network_Component)::getObject + Retrieve a SoftLayer_Virtual_Guest_Network_Component record. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimaryIpAddress.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimaryIpAddress.md index 3c9b432160..b91b50e7e5 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimaryIpAddress.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimaryIpAddress.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Network_Component](/reference/services/SoftLayer_Virtual_Guest_Network_Component)::getPrimaryIpAddress + Retrieve a computing instance network component's primary IP address. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimaryIpAddressRecord.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimaryIpAddressRecord.md index 23f75698ab..51be92da82 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimaryIpAddressRecord.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimaryIpAddressRecord.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimarySubnet.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimarySubnet.md index 61e5200536..9b55452096 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimarySubnet.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimarySubnet.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Network_Component](/reference/services/SoftLayer_Virtual_Guest_Network_Component)::getPrimarySubnet + Retrieve a network component's subnet for its primary IP address diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimaryVersion6IpAddressRecord.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimaryVersion6IpAddressRecord.md index 46cbce3030..93ec27a0fa 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimaryVersion6IpAddressRecord.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getPrimaryVersion6IpAddressRecord.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Network_Component](/reference/services/SoftLayer_Virtual_Guest_Network_Component)::getPrimaryVersion6IpAddressRecord + Retrieve a network component's primary IPv6 IP address record. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getRouter.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getRouter.md index fa9463f578..d0717493c1 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getRouter.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getRouter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Network_Component](/reference/services/SoftLayer_Virtual_Guest_Network_Component)::getRouter + Retrieve a network component's routers. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getSecurityGroupBindings.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getSecurityGroupBindings.md index 38c96fe8b7..0bcbe878f4 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getSecurityGroupBindings.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getSecurityGroupBindings.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Network_Component](/reference/services/SoftLayer_Virtual_Guest_Network_Component)::getSecurityGroupBindings + Retrieve the bindings associating security groups to this network component diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getSubnets.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getSubnets.md index 2216c7fe35..a8c436262d 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getSubnets.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/getSubnets.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Network_Component](/reference/services/SoftLayer_Virtual_Guest_Network_Component)::getSubnets + Retrieve a network component's subnets. A subnet is a group of IP addresses diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/isPingable.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/isPingable.md index 529aa72e93..005f90434c 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/isPingable.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/isPingable.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Guest_Network_Component](/reference/services/SoftLayer_Virtual_Guest_Network_Component)::isPingable + Verifies if network component is pingable. diff --git a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/securityGroupsReady.md b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/securityGroupsReady.md index ce2714b8d1..83b583a0b4 100644 --- a/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/securityGroupsReady.md +++ b/content/reference/services/SoftLayer_Virtual_Guest_Network_Component/securityGroupsReady.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Host/_index.md b/content/reference/services/SoftLayer_Virtual_Host/_index.md index e55967b2b0..16210a4118 100644 --- a/content/reference/services/SoftLayer_Virtual_Host/_index.md +++ b/content/reference/services/SoftLayer_Virtual_Host/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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. @@ -42,102 +44,119 @@ The virtual host service provides a common interface to any virtualization platf #### [getAccount](/reference/services/SoftLayer_Virtual_Host/getAccount) Retrieve the account which a virtual host belongs to. +
              #### [getBilledPerGuestFlag](/reference/services/SoftLayer_Virtual_Host/getBilledPerGuestFlag) Retrieve boolean flag indicating whether this virtualization platform gets billed per guest rather than at a fixed rate. +
              #### [getBilledPerMemoryUsageFlag](/reference/services/SoftLayer_Virtual_Host/getBilledPerMemoryUsageFlag) Retrieve boolean flag indicating whether this virtualization platform gets billed per memory usage rather than at a fixed rate. +
              #### [getGuests](/reference/services/SoftLayer_Virtual_Host/getGuests) Retrieve the guests associated with a virtual host. +
              #### [getHardware](/reference/services/SoftLayer_Virtual_Host/getHardware) Retrieve the hardware record which a virtual host resides on. +
              #### [getLiveGuestByUuid](/reference/services/SoftLayer_Virtual_Host/getLiveGuestByUuid) Query a virtualization platform directly to retrieve details regarding a guest. +
              #### [getLiveGuestList](/reference/services/SoftLayer_Virtual_Host/getLiveGuestList) Query a virtualization platform directly to retrieve a list of known guests. +
              #### [getLiveGuestRecentMetricData](/reference/services/SoftLayer_Virtual_Host/getLiveGuestRecentMetricData) Query a virtualization platform directly to retrieve recent metric data for a guest. +
              #### [getMetricTrackingObject](/reference/services/SoftLayer_Virtual_Host/getMetricTrackingObject) Retrieve the metric tracking object for this virtual host. +
              #### [getObject](/reference/services/SoftLayer_Virtual_Host/getObject) Retrieve a SoftLayer_Virtual_Host record. +
              #### [getPciDevices](/reference/services/SoftLayer_Virtual_Host/getPciDevices) +
              #### [pauseLiveGuest](/reference/services/SoftLayer_Virtual_Host/pauseLiveGuest) Pause a guest. +
              #### [powerCycleLiveGuest](/reference/services/SoftLayer_Virtual_Host/powerCycleLiveGuest) Power cycle a guest. +
              #### [powerOffLiveGuest](/reference/services/SoftLayer_Virtual_Host/powerOffLiveGuest) Power off a guest. +
              #### [powerOnLiveGuest](/reference/services/SoftLayer_Virtual_Host/powerOnLiveGuest) Power on a guest. +
              #### [rebootSoftLiveGuest](/reference/services/SoftLayer_Virtual_Host/rebootSoftLiveGuest) Attempt to complete a soft reboot of a guest by shutting down the operating system. +
              #### [resumeLiveGuest](/reference/services/SoftLayer_Virtual_Host/resumeLiveGuest) Resume a guest. +
              diff --git a/content/reference/services/SoftLayer_Virtual_Host/getAccount.md b/content/reference/services/SoftLayer_Virtual_Host/getAccount.md index 5e13c201ec..47cf74acba 100644 --- a/content/reference/services/SoftLayer_Virtual_Host/getAccount.md +++ b/content/reference/services/SoftLayer_Virtual_Host/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Host](/reference/services/SoftLayer_Virtual_Host)::getAccount + Retrieve the account which a virtual host belongs to. diff --git a/content/reference/services/SoftLayer_Virtual_Host/getBilledPerGuestFlag.md b/content/reference/services/SoftLayer_Virtual_Host/getBilledPerGuestFlag.md index 19e70e9b61..241fdde175 100644 --- a/content/reference/services/SoftLayer_Virtual_Host/getBilledPerGuestFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Host/getBilledPerGuestFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Host](/reference/services/SoftLayer_Virtual_Host)::getBilledPerGuestFlag + Retrieve boolean flag indicating whether this virtualization platform gets billed per guest rather than at a fixed rate. diff --git a/content/reference/services/SoftLayer_Virtual_Host/getBilledPerMemoryUsageFlag.md b/content/reference/services/SoftLayer_Virtual_Host/getBilledPerMemoryUsageFlag.md index fb07f26ba9..54f0a96082 100644 --- a/content/reference/services/SoftLayer_Virtual_Host/getBilledPerMemoryUsageFlag.md +++ b/content/reference/services/SoftLayer_Virtual_Host/getBilledPerMemoryUsageFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Host](/reference/services/SoftLayer_Virtual_Host)::getBilledPerMemoryUsageFlag + Retrieve boolean flag indicating whether this virtualization platform gets billed per memory usage rather than at a fixed rate. diff --git a/content/reference/services/SoftLayer_Virtual_Host/getGuests.md b/content/reference/services/SoftLayer_Virtual_Host/getGuests.md index 0ad49da1a1..bb4f9d2b17 100644 --- a/content/reference/services/SoftLayer_Virtual_Host/getGuests.md +++ b/content/reference/services/SoftLayer_Virtual_Host/getGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Host](/reference/services/SoftLayer_Virtual_Host)::getGuests + Retrieve the guests associated with a virtual host. diff --git a/content/reference/services/SoftLayer_Virtual_Host/getHardware.md b/content/reference/services/SoftLayer_Virtual_Host/getHardware.md index c23ae22855..9e9b32b947 100644 --- a/content/reference/services/SoftLayer_Virtual_Host/getHardware.md +++ b/content/reference/services/SoftLayer_Virtual_Host/getHardware.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Host](/reference/services/SoftLayer_Virtual_Host)::getHardware + Retrieve the hardware record which a virtual host resides on. diff --git a/content/reference/services/SoftLayer_Virtual_Host/getLiveGuestByUuid.md b/content/reference/services/SoftLayer_Virtual_Host/getLiveGuestByUuid.md index 9344e95809..621f04f57d 100644 --- a/content/reference/services/SoftLayer_Virtual_Host/getLiveGuestByUuid.md +++ b/content/reference/services/SoftLayer_Virtual_Host/getLiveGuestByUuid.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Host](/reference/services/SoftLayer_Virtual_Host)::getLiveGuestByUuid + Query a virtualization platform directly to retrieve details regarding a guest. diff --git a/content/reference/services/SoftLayer_Virtual_Host/getLiveGuestList.md b/content/reference/services/SoftLayer_Virtual_Host/getLiveGuestList.md index 2069143c90..a4f49a02ea 100644 --- a/content/reference/services/SoftLayer_Virtual_Host/getLiveGuestList.md +++ b/content/reference/services/SoftLayer_Virtual_Host/getLiveGuestList.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Host](/reference/services/SoftLayer_Virtual_Host)::getLiveGuestList + Query a virtualization platform directly to retrieve a list of known guests. diff --git a/content/reference/services/SoftLayer_Virtual_Host/getLiveGuestRecentMetricData.md b/content/reference/services/SoftLayer_Virtual_Host/getLiveGuestRecentMetricData.md index c6b1a0acd3..982e7eb126 100644 --- a/content/reference/services/SoftLayer_Virtual_Host/getLiveGuestRecentMetricData.md +++ b/content/reference/services/SoftLayer_Virtual_Host/getLiveGuestRecentMetricData.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Host](/reference/services/SoftLayer_Virtual_Host)::getLiveGuestRecentMetricData + Query a virtualization platform directly to retrieve recent metric data for a guest. diff --git a/content/reference/services/SoftLayer_Virtual_Host/getMetricTrackingObject.md b/content/reference/services/SoftLayer_Virtual_Host/getMetricTrackingObject.md index ab993480eb..b6944ad9a6 100644 --- a/content/reference/services/SoftLayer_Virtual_Host/getMetricTrackingObject.md +++ b/content/reference/services/SoftLayer_Virtual_Host/getMetricTrackingObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Host](/reference/services/SoftLayer_Virtual_Host)::getMetricTrackingObject + Retrieve the metric tracking object for this virtual host. diff --git a/content/reference/services/SoftLayer_Virtual_Host/getObject.md b/content/reference/services/SoftLayer_Virtual_Host/getObject.md index fbf6a63160..c4df507116 100644 --- a/content/reference/services/SoftLayer_Virtual_Host/getObject.md +++ b/content/reference/services/SoftLayer_Virtual_Host/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Host](/reference/services/SoftLayer_Virtual_Host)::getObject + Retrieve a SoftLayer_Virtual_Host record. diff --git a/content/reference/services/SoftLayer_Virtual_Host/getPciDevices.md b/content/reference/services/SoftLayer_Virtual_Host/getPciDevices.md index 9c512dde41..b3d3b798ad 100644 --- a/content/reference/services/SoftLayer_Virtual_Host/getPciDevices.md +++ b/content/reference/services/SoftLayer_Virtual_Host/getPciDevices.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Host/pauseLiveGuest.md b/content/reference/services/SoftLayer_Virtual_Host/pauseLiveGuest.md index 18ddc76b60..f21d63f0fc 100644 --- a/content/reference/services/SoftLayer_Virtual_Host/pauseLiveGuest.md +++ b/content/reference/services/SoftLayer_Virtual_Host/pauseLiveGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Host](/reference/services/SoftLayer_Virtual_Host)::pauseLiveGuest + Pause a guest. diff --git a/content/reference/services/SoftLayer_Virtual_Host/powerCycleLiveGuest.md b/content/reference/services/SoftLayer_Virtual_Host/powerCycleLiveGuest.md index 28e82e73da..3db5de6e2e 100644 --- a/content/reference/services/SoftLayer_Virtual_Host/powerCycleLiveGuest.md +++ b/content/reference/services/SoftLayer_Virtual_Host/powerCycleLiveGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Host](/reference/services/SoftLayer_Virtual_Host)::powerCycleLiveGuest + Power cycle a guest. diff --git a/content/reference/services/SoftLayer_Virtual_Host/powerOffLiveGuest.md b/content/reference/services/SoftLayer_Virtual_Host/powerOffLiveGuest.md index 9009d3bc8f..96635b160f 100644 --- a/content/reference/services/SoftLayer_Virtual_Host/powerOffLiveGuest.md +++ b/content/reference/services/SoftLayer_Virtual_Host/powerOffLiveGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Host](/reference/services/SoftLayer_Virtual_Host)::powerOffLiveGuest + Power off a guest. diff --git a/content/reference/services/SoftLayer_Virtual_Host/powerOnLiveGuest.md b/content/reference/services/SoftLayer_Virtual_Host/powerOnLiveGuest.md index b229fa4221..24501bc86d 100644 --- a/content/reference/services/SoftLayer_Virtual_Host/powerOnLiveGuest.md +++ b/content/reference/services/SoftLayer_Virtual_Host/powerOnLiveGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Host](/reference/services/SoftLayer_Virtual_Host)::powerOnLiveGuest + Power on a guest. diff --git a/content/reference/services/SoftLayer_Virtual_Host/rebootSoftLiveGuest.md b/content/reference/services/SoftLayer_Virtual_Host/rebootSoftLiveGuest.md index 0834fba921..792e3c573e 100644 --- a/content/reference/services/SoftLayer_Virtual_Host/rebootSoftLiveGuest.md +++ b/content/reference/services/SoftLayer_Virtual_Host/rebootSoftLiveGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Host](/reference/services/SoftLayer_Virtual_Host)::rebootSoftLiveGuest + Attempt to complete a soft reboot of a guest by shutting down the operating system. diff --git a/content/reference/services/SoftLayer_Virtual_Host/resumeLiveGuest.md b/content/reference/services/SoftLayer_Virtual_Host/resumeLiveGuest.md index c0d170122a..69301475cf 100644 --- a/content/reference/services/SoftLayer_Virtual_Host/resumeLiveGuest.md +++ b/content/reference/services/SoftLayer_Virtual_Host/resumeLiveGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Host](/reference/services/SoftLayer_Virtual_Host)::resumeLiveGuest + Resume a guest. diff --git a/content/reference/services/SoftLayer_Virtual_PlacementGroup/_index.md b/content/reference/services/SoftLayer_Virtual_PlacementGroup/_index.md index cae3f4df37..5c2db6b300 100644 --- a/content/reference/services/SoftLayer_Virtual_PlacementGroup/_index.md +++ b/content/reference/services/SoftLayer_Virtual_PlacementGroup/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Virtual_PlacementGroup is a collection of virtual guests to be placed relative to each other according to a rule. @@ -42,54 +44,63 @@ SoftLayer_Virtual_PlacementGroup is a collection of virtual guests to be placed #### [createObject](/reference/services/SoftLayer_Virtual_PlacementGroup/createObject) +
              #### [deleteObject](/reference/services/SoftLayer_Virtual_PlacementGroup/deleteObject) +
              #### [editObject](/reference/services/SoftLayer_Virtual_PlacementGroup/editObject) +
              #### [getAccount](/reference/services/SoftLayer_Virtual_PlacementGroup/getAccount) Retrieve the account that the placement group is implemented on. +
              #### [getAvailableRouters](/reference/services/SoftLayer_Virtual_PlacementGroup/getAvailableRouters) +
              #### [getBackendRouter](/reference/services/SoftLayer_Virtual_PlacementGroup/getBackendRouter) Retrieve the router the placement group is implemented on. +
              #### [getGuests](/reference/services/SoftLayer_Virtual_PlacementGroup/getGuests) Retrieve the virtual guests that are members of the placement group. +
              #### [getObject](/reference/services/SoftLayer_Virtual_PlacementGroup/getObject) Retrieve a SoftLayer_Virtual_PlacementGroup record. +
              #### [getRule](/reference/services/SoftLayer_Virtual_PlacementGroup/getRule) Retrieve the placement rule that the placement group is implementing. +
              diff --git a/content/reference/services/SoftLayer_Virtual_PlacementGroup/createObject.md b/content/reference/services/SoftLayer_Virtual_PlacementGroup/createObject.md index 7ab75c5001..e513bbfb97 100644 --- a/content/reference/services/SoftLayer_Virtual_PlacementGroup/createObject.md +++ b/content/reference/services/SoftLayer_Virtual_PlacementGroup/createObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview Add a placement group to your account for use during VSI provisioning. diff --git a/content/reference/services/SoftLayer_Virtual_PlacementGroup/deleteObject.md b/content/reference/services/SoftLayer_Virtual_PlacementGroup/deleteObject.md index 2fcff713c9..ed5c1ba5e3 100644 --- a/content/reference/services/SoftLayer_Virtual_PlacementGroup/deleteObject.md +++ b/content/reference/services/SoftLayer_Virtual_PlacementGroup/deleteObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview Delete a placement group from your account. diff --git a/content/reference/services/SoftLayer_Virtual_PlacementGroup/editObject.md b/content/reference/services/SoftLayer_Virtual_PlacementGroup/editObject.md index 4c67384f95..79a767d9d1 100644 --- a/content/reference/services/SoftLayer_Virtual_PlacementGroup/editObject.md +++ b/content/reference/services/SoftLayer_Virtual_PlacementGroup/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview Update a placement group. diff --git a/content/reference/services/SoftLayer_Virtual_PlacementGroup/getAccount.md b/content/reference/services/SoftLayer_Virtual_PlacementGroup/getAccount.md index f0b00b54ff..c269076aff 100644 --- a/content/reference/services/SoftLayer_Virtual_PlacementGroup/getAccount.md +++ b/content/reference/services/SoftLayer_Virtual_PlacementGroup/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_PlacementGroup](/reference/services/SoftLayer_Virtual_PlacementGroup)::getAccount + Retrieve the account that the placement group is implemented on. diff --git a/content/reference/services/SoftLayer_Virtual_PlacementGroup/getAvailableRouters.md b/content/reference/services/SoftLayer_Virtual_PlacementGroup/getAvailableRouters.md index 4acde77865..ed4a286ba8 100644 --- a/content/reference/services/SoftLayer_Virtual_PlacementGroup/getAvailableRouters.md +++ b/content/reference/services/SoftLayer_Virtual_PlacementGroup/getAvailableRouters.md @@ -16,6 +16,7 @@ aliases: + ## Overview Returns all routers available for use with placement groups. If a datacenter location ID is provided, this method will further restrict the list of routers to ones contained within that datacenter. diff --git a/content/reference/services/SoftLayer_Virtual_PlacementGroup/getBackendRouter.md b/content/reference/services/SoftLayer_Virtual_PlacementGroup/getBackendRouter.md index 28208b9905..dbb3184fdf 100644 --- a/content/reference/services/SoftLayer_Virtual_PlacementGroup/getBackendRouter.md +++ b/content/reference/services/SoftLayer_Virtual_PlacementGroup/getBackendRouter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_PlacementGroup](/reference/services/SoftLayer_Virtual_PlacementGroup)::getBackendRouter + Retrieve the router the placement group is implemented on. diff --git a/content/reference/services/SoftLayer_Virtual_PlacementGroup/getGuests.md b/content/reference/services/SoftLayer_Virtual_PlacementGroup/getGuests.md index 94b0f90ce1..e6c9534cc1 100644 --- a/content/reference/services/SoftLayer_Virtual_PlacementGroup/getGuests.md +++ b/content/reference/services/SoftLayer_Virtual_PlacementGroup/getGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_PlacementGroup](/reference/services/SoftLayer_Virtual_PlacementGroup)::getGuests + Retrieve the virtual guests that are members of the placement group. diff --git a/content/reference/services/SoftLayer_Virtual_PlacementGroup/getObject.md b/content/reference/services/SoftLayer_Virtual_PlacementGroup/getObject.md index f3050c36fc..1c3ddc8dfd 100644 --- a/content/reference/services/SoftLayer_Virtual_PlacementGroup/getObject.md +++ b/content/reference/services/SoftLayer_Virtual_PlacementGroup/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_PlacementGroup](/reference/services/SoftLayer_Virtual_PlacementGroup)::getObject + Retrieve a SoftLayer_Virtual_PlacementGroup record. diff --git a/content/reference/services/SoftLayer_Virtual_PlacementGroup/getRule.md b/content/reference/services/SoftLayer_Virtual_PlacementGroup/getRule.md index db942f3c92..75dd2692d4 100644 --- a/content/reference/services/SoftLayer_Virtual_PlacementGroup/getRule.md +++ b/content/reference/services/SoftLayer_Virtual_PlacementGroup/getRule.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_PlacementGroup](/reference/services/SoftLayer_Virtual_PlacementGroup)::getRule + Retrieve the placement rule that the placement group is implementing. diff --git a/content/reference/services/SoftLayer_Virtual_PlacementGroup_Rule/_index.md b/content/reference/services/SoftLayer_Virtual_PlacementGroup_Rule/_index.md index b2c7e17dcc..50052805cd 100644 --- a/content/reference/services/SoftLayer_Virtual_PlacementGroup_Rule/_index.md +++ b/content/reference/services/SoftLayer_Virtual_PlacementGroup_Rule/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Virtual_PlacementGroup_Rule is the placement rule that a virtual guest placement group follows. @@ -42,12 +44,14 @@ SoftLayer_Virtual_PlacementGroup_Rule is the placement rule that a virtual guest #### [getAllObjects](/reference/services/SoftLayer_Virtual_PlacementGroup_Rule/getAllObjects) Get all placement group rules. +
              #### [getObject](/reference/services/SoftLayer_Virtual_PlacementGroup_Rule/getObject) Retrieve a SoftLayer_Virtual_PlacementGroup_Rule record. +
              diff --git a/content/reference/services/SoftLayer_Virtual_PlacementGroup_Rule/getAllObjects.md b/content/reference/services/SoftLayer_Virtual_PlacementGroup_Rule/getAllObjects.md index 974a6700c4..c3119b1e44 100644 --- a/content/reference/services/SoftLayer_Virtual_PlacementGroup_Rule/getAllObjects.md +++ b/content/reference/services/SoftLayer_Virtual_PlacementGroup_Rule/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_PlacementGroup_Rule](/reference/services/SoftLayer_Virtual_PlacementGroup_Rule)::getAllObjects + Get all placement group rules. diff --git a/content/reference/services/SoftLayer_Virtual_PlacementGroup_Rule/getObject.md b/content/reference/services/SoftLayer_Virtual_PlacementGroup_Rule/getObject.md index c305fba684..4233515131 100644 --- a/content/reference/services/SoftLayer_Virtual_PlacementGroup_Rule/getObject.md +++ b/content/reference/services/SoftLayer_Virtual_PlacementGroup_Rule/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_PlacementGroup_Rule](/reference/services/SoftLayer_Virtual_PlacementGroup_Rule)::getObject + Retrieve a SoftLayer_Virtual_PlacementGroup_Rule record. diff --git a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/_index.md b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/_index.md index 6ca2999536..7b76f9a160 100644 --- a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/_index.md +++ b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Virtual_ReservedCapacityGroup reserves capacity for a group of guests that have not yet been provisioned. @@ -42,48 +44,56 @@ SoftLayer_Virtual_ReservedCapacityGroup reserves capacity for a group of guests #### [editObject](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/editObject) +
              #### [getAccount](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getAccount) Retrieve the account that the reserved capacity group is implemented on. +
              #### [getAvailableInstances](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getAvailableInstances) Retrieve the instances available for guest provisions on this reserved capacity group. +
              #### [getBackendRouter](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getBackendRouter) Retrieve the router the reserved capacity group is implemented on. +
              #### [getInstances](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getInstances) Retrieve the guest instances that are members of this reserved capacity group. +
              #### [getInstancesCount](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getInstancesCount) Retrieve the number of instances that are members of this reserved capacity group. +
              #### [getObject](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getObject) Retrieve a SoftLayer_Virtual_ReservedCapacityGroup record. +
              #### [getOccupiedInstances](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getOccupiedInstances) Retrieve the instances already occupied by a guest on this reserved capacity group. +
              diff --git a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/editObject.md b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/editObject.md index e98d278b6d..b8f5067057 100644 --- a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/editObject.md +++ b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/editObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview Update a reserved capacity group. diff --git a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getAccount.md b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getAccount.md index e86828511e..e20d716f7c 100644 --- a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getAccount.md +++ b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_ReservedCapacityGroup](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup)::getAccount + Retrieve the account that the reserved capacity group is implemented on. diff --git a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getAvailableInstances.md b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getAvailableInstances.md index cff0a8b6e5..4e809cad83 100644 --- a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getAvailableInstances.md +++ b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getAvailableInstances.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_ReservedCapacityGroup](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup)::getAvailableInstances + Retrieve the instances available for guest provisions on this reserved capacity group. diff --git a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getBackendRouter.md b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getBackendRouter.md index e91507431c..33be093101 100644 --- a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getBackendRouter.md +++ b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getBackendRouter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_ReservedCapacityGroup](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup)::getBackendRouter + Retrieve the router the reserved capacity group is implemented on. diff --git a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getInstances.md b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getInstances.md index ddd8a6cf99..77e35359c8 100644 --- a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getInstances.md +++ b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getInstances.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_ReservedCapacityGroup](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup)::getInstances + Retrieve the guest instances that are members of this reserved capacity group. diff --git a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getInstancesCount.md b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getInstancesCount.md index f6f8262639..c57038cdbe 100644 --- a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getInstancesCount.md +++ b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getInstancesCount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_ReservedCapacityGroup](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup)::getInstancesCount + Retrieve the number of instances that are members of this reserved capacity group. diff --git a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getObject.md b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getObject.md index 3b1e081c0f..3e3195e9e7 100644 --- a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getObject.md +++ b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_ReservedCapacityGroup](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup)::getObject + Retrieve a SoftLayer_Virtual_ReservedCapacityGroup record. diff --git a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getOccupiedInstances.md b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getOccupiedInstances.md index 4af06cf859..98b13b1b50 100644 --- a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getOccupiedInstances.md +++ b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup/getOccupiedInstances.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_ReservedCapacityGroup](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup)::getOccupiedInstances + Retrieve the instances already occupied by a guest on this reserved capacity group. diff --git a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/_index.md b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/_index.md index 67b1bd9c3d..2e5842019d 100644 --- a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/_index.md +++ b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Virtual_ReservedCapacityGroup_Instance reserves capacity for a single instance of a reserved capacity group. @@ -42,30 +44,35 @@ SoftLayer_Virtual_ReservedCapacityGroup_Instance reserves capacity for a single #### [getAvailableFlag](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getAvailableFlag) Retrieve flag to indecate whether or not the reserved instance is available or not. +
              #### [getBillingItem](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getBillingItem) Retrieve the billing item for the reserved capacity group instance. +
              #### [getGuest](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getGuest) Retrieve the virtual guest associated with this reserved capacity group instance. +
              #### [getObject](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getObject) Retrieve a SoftLayer_Virtual_ReservedCapacityGroup_Instance record. +
              #### [getReservedCapacityGroup](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getReservedCapacityGroup) Retrieve the reserved instances that are members of this reserved capacity group. +
              diff --git a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getAvailableFlag.md b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getAvailableFlag.md index 7baf542936..e417119067 100644 --- a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getAvailableFlag.md +++ b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getAvailableFlag.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_ReservedCapacityGroup_Instance](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance)::getAvailableFlag + Retrieve flag to indecate whether or not the reserved instance is available or not. diff --git a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getBillingItem.md b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getBillingItem.md index 2c0c18c655..2de1768094 100644 --- a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getBillingItem.md +++ b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_ReservedCapacityGroup_Instance](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance)::getBillingItem + Retrieve the billing item for the reserved capacity group instance. diff --git a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getGuest.md b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getGuest.md index 6324c706c2..1c950d2f1e 100644 --- a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getGuest.md +++ b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getGuest.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_ReservedCapacityGroup_Instance](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance)::getGuest + Retrieve the virtual guest associated with this reserved capacity group instance. diff --git a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getObject.md b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getObject.md index 4ef876c1cb..aeb95e9be5 100644 --- a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getObject.md +++ b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_ReservedCapacityGroup_Instance](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance)::getObject + Retrieve a SoftLayer_Virtual_ReservedCapacityGroup_Instance record. diff --git a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getReservedCapacityGroup.md b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getReservedCapacityGroup.md index dd8e0b1399..ce20c7e2d7 100644 --- a/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getReservedCapacityGroup.md +++ b/content/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance/getReservedCapacityGroup.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_ReservedCapacityGroup_Instance](/reference/services/SoftLayer_Virtual_ReservedCapacityGroup_Instance)::getReservedCapacityGroup + Retrieve the reserved instances that are members of this reserved capacity group. diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/_index.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/_index.md index 2a7fee8599..7a13dcdc81 100644 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/_index.md +++ b/content/reference/services/SoftLayer_Virtual_Storage_Repository/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + 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]({{}}) and can be attached to more than one [SoftLayer_Virtual_Host]({{}}). @@ -42,96 +44,112 @@ Storage Repositories are storage systems that are accessible through the interne #### [getAccount](/reference/services/SoftLayer_Virtual_Storage_Repository/getAccount) Retrieve the [SoftLayer_Account]({{}}) that a storage repository belongs to. +
              #### [getArchiveDiskUsageRatePerGb](/reference/services/SoftLayer_Virtual_Storage_Repository/getArchiveDiskUsageRatePerGb) The rate that is charged for archiving every 1 gigabyte of data for a computing instance +
              #### [getAverageDiskUsageMetricDataFromInfluxByDate](/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageDiskUsageMetricDataFromInfluxByDate) Returns the average disk usage for the timeframe based on the parameters provided. +
              #### [getAverageUsageMetricDataByDate](/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageUsageMetricDataByDate) Returns the average disk usage for the timeframe based on the parameters provided. +
              #### [getBillingItem](/reference/services/SoftLayer_Virtual_Storage_Repository/getBillingItem) Retrieve the current billing item for a storage repository. +
              #### [getDatacenter](/reference/services/SoftLayer_Virtual_Storage_Repository/getDatacenter) Retrieve the datacenter that a virtual storage repository resides in. +
              #### [getDiskImages](/reference/services/SoftLayer_Virtual_Storage_Repository/getDiskImages) Retrieve the [SoftLayer_Virtual_Disk_Image]({{}}) that are in a storage repository. Disk images are the virtual hard drives for a virtual guest. +
              #### [getGuests](/reference/services/SoftLayer_Virtual_Storage_Repository/getGuests) Retrieve the computing instances that have disk images in a storage repository. +
              #### [getMetricTrackingObject](/reference/services/SoftLayer_Virtual_Storage_Repository/getMetricTrackingObject) +
              #### [getObject](/reference/services/SoftLayer_Virtual_Storage_Repository/getObject) Retrieve a SoftLayer_Virtual_Storage_Repository record. +
              #### [getPublicImageBillingItem](/reference/services/SoftLayer_Virtual_Storage_Repository/getPublicImageBillingItem) Retrieve the current billing item for a public storage repository. +
              #### [getPublicImageDiskUsageRatePerGb](/reference/services/SoftLayer_Virtual_Storage_Repository/getPublicImageDiskUsageRatePerGb) The rate that is charged for publishing every 1 gigabyte of data for an image template +
              #### [getStorageLocations](/reference/services/SoftLayer_Virtual_Storage_Repository/getStorageLocations) The available locations for public image storage. +
              #### [getType](/reference/services/SoftLayer_Virtual_Storage_Repository/getType) Retrieve a storage repository's [SoftLayer_Virtual_Storage_Repository_Type]({{}}). +
              #### [getUsageMetricDataByDate](/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricDataByDate) Retrieve the metric data for disk space usage for a storage repository. +
              #### [getUsageMetricImageByDate](/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricImageByDate) Retrieve an image of the disk usage data on a [SoftLayer_Virtual_Guest]({{}}) image for the time range you provide. +
              diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getAccount.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getAccount.md index 573a5f7c6f..c896d1b8dd 100644 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getAccount.md +++ b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Storage_Repository](/reference/services/SoftLayer_Virtual_Storage_Repository)::getAccount + Retrieve the [SoftLayer_Account]({{}}) that a storage repository belongs to. diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getArchiveDiskUsageRatePerGb.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getArchiveDiskUsageRatePerGb.md index 32e2dfc334..6b6d956cc0 100644 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getArchiveDiskUsageRatePerGb.md +++ b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getArchiveDiskUsageRatePerGb.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Storage_Repository](/reference/services/SoftLayer_Virtual_Storage_Repository)::getArchiveDiskUsageRatePerGb + The rate that is charged for archiving every 1 gigabyte of data for a computing instance diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageDiskUsageMetricDataFromInfluxByDate.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageDiskUsageMetricDataFromInfluxByDate.md index f1da0a8732..1de04010e7 100644 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageDiskUsageMetricDataFromInfluxByDate.md +++ b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageDiskUsageMetricDataFromInfluxByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Storage_Repository](/reference/services/SoftLayer_Virtual_Storage_Repository)::getAverageDiskUsageMetricDataFromInfluxByDate + Returns the average disk usage for the timeframe based on the parameters provided. diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageUsageMetricDataByDate.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageUsageMetricDataByDate.md index 5f432a8341..e2a5ef0705 100644 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageUsageMetricDataByDate.md +++ b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageUsageMetricDataByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Storage_Repository](/reference/services/SoftLayer_Virtual_Storage_Repository)::getAverageUsageMetricDataByDate + Returns the average disk usage for the timeframe based on the parameters provided. diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getBillingItem.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getBillingItem.md index c0e9a4cf03..de804d2316 100644 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getBillingItem.md +++ b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Storage_Repository](/reference/services/SoftLayer_Virtual_Storage_Repository)::getBillingItem + Retrieve the current billing item for a storage repository. diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getDatacenter.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getDatacenter.md index 0d446a307e..0ab738cee6 100644 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getDatacenter.md +++ b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getDatacenter.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Storage_Repository](/reference/services/SoftLayer_Virtual_Storage_Repository)::getDatacenter + Retrieve the datacenter that a virtual storage repository resides in. diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getDiskImages.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getDiskImages.md index 3b17dd74f2..b32b3ac237 100644 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getDiskImages.md +++ b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getDiskImages.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Storage_Repository](/reference/services/SoftLayer_Virtual_Storage_Repository)::getDiskImages + Retrieve the [SoftLayer_Virtual_Disk_Image]({{}}) that are in a storage repository. Disk images are the virtual hard drives for a virtual guest. diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getGuests.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getGuests.md index 6a01d3f6a7..f3201e50d3 100644 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getGuests.md +++ b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getGuests.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Storage_Repository](/reference/services/SoftLayer_Virtual_Storage_Repository)::getGuests + Retrieve the computing instances that have disk images in a storage repository. diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getMetricTrackingObject.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getMetricTrackingObject.md index 9baed4fc6b..af816a0f93 100644 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getMetricTrackingObject.md +++ b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getMetricTrackingObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getObject.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getObject.md index 16917133e7..8a4d5cc435 100644 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getObject.md +++ b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Storage_Repository](/reference/services/SoftLayer_Virtual_Storage_Repository)::getObject + Retrieve a SoftLayer_Virtual_Storage_Repository record. diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getPublicImageBillingItem.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getPublicImageBillingItem.md index 25ff3794cf..4dcb23aaa8 100644 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getPublicImageBillingItem.md +++ b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getPublicImageBillingItem.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Storage_Repository](/reference/services/SoftLayer_Virtual_Storage_Repository)::getPublicImageBillingItem + Retrieve the current billing item for a public storage repository. diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getPublicImageDiskUsageRatePerGb.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getPublicImageDiskUsageRatePerGb.md index bcb89fd7af..1ba43b0414 100644 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getPublicImageDiskUsageRatePerGb.md +++ b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getPublicImageDiskUsageRatePerGb.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Storage_Repository](/reference/services/SoftLayer_Virtual_Storage_Repository)::getPublicImageDiskUsageRatePerGb + The rate that is charged for publishing every 1 gigabyte of data for an image template diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getStorageLocations.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getStorageLocations.md index 22ea083ecf..90d125c608 100644 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getStorageLocations.md +++ b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getStorageLocations.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Storage_Repository](/reference/services/SoftLayer_Virtual_Storage_Repository)::getStorageLocations + The available locations for public image storage. diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getType.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getType.md index 4f8e7fa4e9..f045878d31 100644 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getType.md +++ b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Storage_Repository](/reference/services/SoftLayer_Virtual_Storage_Repository)::getType + Retrieve a storage repository's [SoftLayer_Virtual_Storage_Repository_Type]({{}}). diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricDataByDate.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricDataByDate.md index e22d5784ab..206f0e4dab 100644 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricDataByDate.md +++ b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricDataByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Storage_Repository](/reference/services/SoftLayer_Virtual_Storage_Repository)::getUsageMetricDataByDate + Retrieve the metric data for disk space usage for a storage repository. diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricImageByDate.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricImageByDate.md index 73710cc6a0..de9039f5f7 100644 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricImageByDate.md +++ b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricImageByDate.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Virtual_Storage_Repository](/reference/services/SoftLayer_Virtual_Storage_Repository)::getUsageMetricImageByDate + Retrieve an image of the disk usage data on a [SoftLayer_Virtual_Guest]({{}}) image for the time range you provide. diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Client/_index.md b/content/reference/services/SoftLayer_Workload_Citrix_Client/_index.md index febb10c60d..35dd7b1920 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Client/_index.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Client/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Workload_Citrix_Client data type contains functionality to validate a Citrix account. @@ -42,18 +44,21 @@ The SoftLayer_Workload_Citrix_Client data type contains functionality to validat #### [createResourceLocation](/reference/services/SoftLayer_Workload_Citrix_Client/createResourceLocation) +
              #### [getResourceLocations](/reference/services/SoftLayer_Workload_Citrix_Client/getResourceLocations) +
              #### [validateCitrixCredentials](/reference/services/SoftLayer_Workload_Citrix_Client/validateCitrixCredentials) +
              diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Client/createResourceLocation.md b/content/reference/services/SoftLayer_Workload_Citrix_Client/createResourceLocation.md index c4c4f07848..22f83e68e1 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Client/createResourceLocation.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Client/createResourceLocation.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Client/getResourceLocations.md b/content/reference/services/SoftLayer_Workload_Citrix_Client/getResourceLocations.md index d1d408a372..405300b444 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Client/getResourceLocations.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Client/getResourceLocations.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Client/validateCitrixCredentials.md b/content/reference/services/SoftLayer_Workload_Citrix_Client/validateCitrixCredentials.md index e65f1192da..c526bea259 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Client/validateCitrixCredentials.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Client/validateCitrixCredentials.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/_index.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/_index.md index 9cc0cc66f1..434997c4c8 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/_index.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Workload_Citrix_Deployment service allows viewing the resources ordered for Citrix Virtual Apps and Desktops. The deployment resources include Cloud Connectors, Active Directory domain controller, Bare Metal servers, File Storage, VLAN, Primary/Portable subnets, DHCP server, and Proxy server. @@ -44,54 +46,63 @@ The deployment resources include Cloud Connectors, Active Directory domain contr #### [createObject](/reference/services/SoftLayer_Workload_Citrix_Deployment/createObject) +
              #### [getAccount](/reference/services/SoftLayer_Workload_Citrix_Deployment/getAccount) Retrieve the [SoftLayer_Account]({{}}) to which the deployment belongs. +
              #### [getAllObjects](/reference/services/SoftLayer_Workload_Citrix_Deployment/getAllObjects) +
              #### [getDeployment](/reference/services/SoftLayer_Workload_Citrix_Deployment/getDeployment) +
              #### [getObject](/reference/services/SoftLayer_Workload_Citrix_Deployment/getObject) Retrieve a SoftLayer_Workload_Citrix_Deployment record. +
              #### [getResources](/reference/services/SoftLayer_Workload_Citrix_Deployment/getResources) Retrieve it contains a collection of items under the CVAD deployment. +
              #### [getType](/reference/services/SoftLayer_Workload_Citrix_Deployment/getType) Retrieve it shows if the deployment is for Citrix Hypervisor or VMware. +
              #### [getUser](/reference/services/SoftLayer_Workload_Citrix_Deployment/getUser) Retrieve it is the [SoftLayer_User_Customer]({{}}) who placed the order for CVAD. +
              #### [getVlan](/reference/services/SoftLayer_Workload_Citrix_Deployment/getVlan) Retrieve it is the VLAN resource for the CVAD deployment. +
              diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/createObject.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/createObject.md index 8e4640a213..891890f943 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/createObject.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/createObject.md @@ -16,6 +16,7 @@ aliases: + ## Overview Creates a new Citrix Virtual Apps and Desktops deployment. diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getAccount.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getAccount.md index 47c03a4886..12f08df551 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getAccount.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getAccount.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Workload_Citrix_Deployment](/reference/services/SoftLayer_Workload_Citrix_Deployment)::getAccount + Retrieve the [SoftLayer_Account]({{}}) to which the deployment belongs. diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getAllObjects.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getAllObjects.md index 73ca4d684d..1306762efe 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getAllObjects.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getAllObjects.md @@ -16,6 +16,7 @@ aliases: + ## Overview Get all Citrix Virtual Apps And Desktop deployments. diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getDeployment.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getDeployment.md index c78022d9a1..8b89304336 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getDeployment.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getDeployment.md @@ -16,6 +16,7 @@ aliases: + ## Overview Returns a response object [SoftLayer_Workload_Citrix_Deployment_Response]({{}}) which represents the CVAD deployment [SoftLayer_Workload_Citrix_Deployment]({{}}) together with all the resources ordered under the CVAD order. diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getObject.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getObject.md index 60b7f8bf5f..39c709ce63 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getObject.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Workload_Citrix_Deployment](/reference/services/SoftLayer_Workload_Citrix_Deployment)::getObject + Retrieve a SoftLayer_Workload_Citrix_Deployment record. diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getResources.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getResources.md index 39c248c283..0f69ceaab9 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getResources.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getResources.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Workload_Citrix_Deployment](/reference/services/SoftLayer_Workload_Citrix_Deployment)::getResources + Retrieve it contains a collection of items under the CVAD deployment. diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getType.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getType.md index 48061eb9d9..f8e74a325e 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getType.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getType.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Workload_Citrix_Deployment](/reference/services/SoftLayer_Workload_Citrix_Deployment)::getType + Retrieve it shows if the deployment is for Citrix Hypervisor or VMware. diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getUser.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getUser.md index 4dee770f59..e0643abfa5 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getUser.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getUser.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Workload_Citrix_Deployment](/reference/services/SoftLayer_Workload_Citrix_Deployment)::getUser + Retrieve it is the [SoftLayer_User_Customer]({{}}) who placed the order for CVAD. diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getVlan.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getVlan.md index 4e5f3f359e..af3691bc98 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getVlan.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment/getVlan.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Workload_Citrix_Deployment](/reference/services/SoftLayer_Workload_Citrix_Deployment)::getVlan + Retrieve it is the VLAN resource for the CVAD deployment. diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/_index.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/_index.md index c6d44db6cc..bf227e9438 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/_index.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + SoftLayer_Workload_Citrix_Deployment_Resource represents the resource of Citrix Virtual Apps & Desktops deployment. @@ -42,42 +44,49 @@ SoftLayer_Workload_Citrix_Deployment_Resource represents the resource of Citrix #### [createObject](/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/createObject) Add the resource into CVAD deployment resources. +
              #### [getAllObjects](/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getAllObjects) Get all the Citrix deployment resources. +
              #### [getBillingItem](/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getBillingItem) +
              #### [getDeployment](/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getDeployment) +
              #### [getObject](/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getObject) Retrieve a SoftLayer_Workload_Citrix_Deployment_Resource record. +
              #### [getOrder](/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getOrder) +
              #### [getRole](/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getRole) +
              diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/createObject.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/createObject.md index 6811b88a81..0b33b7462d 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/createObject.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/createObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Workload_Citrix_Deployment_Resource](/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource)::createObject + Add the resource into CVAD deployment resources. diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getAllObjects.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getAllObjects.md index fb2ec22c85..39d26daf0a 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getAllObjects.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getAllObjects.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Workload_Citrix_Deployment_Resource](/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource)::getAllObjects + Get all the Citrix deployment resources. diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getBillingItem.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getBillingItem.md index 60e81d1278..97fbea534c 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getBillingItem.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getBillingItem.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getDeployment.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getDeployment.md index b6d36269c9..8f571393c3 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getDeployment.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getDeployment.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getObject.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getObject.md index 1a74964985..2bedc4a528 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getObject.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Workload_Citrix_Deployment_Resource](/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource)::getObject + Retrieve a SoftLayer_Workload_Citrix_Deployment_Resource record. diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getOrder.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getOrder.md index 6368f5cdb8..0b768c8b60 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getOrder.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getOrder.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getRole.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getRole.md index 23456f57c5..13d37e4300 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getRole.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getRole.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Type/_index.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Type/_index.md index c239ec9c55..4d02df9ef8 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Type/_index.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Type/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Workload_Citrix_Deployment_Type service tells the kind of Citrix Virtual Apps and Desktop deployment order. The Citrix Virtual Apps and Desktop deployment can be in one of the following two types, - Citrix Hypervisor: This type of deployment uses XenServer Hypervisor provided by Citrix to create virtual machines - VMware: This type of deployment uses VMware hypervisor with NFS or VSAN for the storage solution. @@ -44,6 +46,7 @@ The Citrix Virtual Apps and Desktop deployment can be in one of the following tw #### [getObject](/reference/services/SoftLayer_Workload_Citrix_Deployment_Type/getObject) Retrieve a SoftLayer_Workload_Citrix_Deployment_Type record. + diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Type/getObject.md b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Type/getObject.md index 91459057bc..00b02c4e72 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Type/getObject.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Deployment_Type/getObject.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Workload_Citrix_Deployment_Type](/reference/services/SoftLayer_Workload_Citrix_Deployment_Type)::getObject + Retrieve a SoftLayer_Workload_Citrix_Deployment_Type record. diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/_index.md b/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/_index.md index 77409c5545..e64638a526 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/_index.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + This service is used to order an implementation of Citrix Virtual Apps and Desktops running on IBM Cloud @@ -42,30 +44,35 @@ This service is used to order an implementation of Citrix Virtual Apps and Deskt #### [cancelWorkspaceResources](/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/cancelWorkspaceResources) Cancel the orders associated with resources on the provided VLAN +
              #### [getWorkspaceNames](/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/getWorkspaceNames) Get a list of all VLAN names which have 'cvad' tags associated with them. +
              #### [getWorkspaceResources](/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/getWorkspaceResources) List the orders associated with resources on the provided VLAN +
              #### [placeWorkspaceOrder](/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/placeWorkspaceOrder) +
              #### [verifyWorkspaceOrder](/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/verifyWorkspaceOrder) Verify that an order may be successfully placed with the details provided. +
              diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/cancelWorkspaceResources.md b/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/cancelWorkspaceResources.md index f033ea51d0..0290c693d5 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/cancelWorkspaceResources.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/cancelWorkspaceResources.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Workload_Citrix_Workspace_Order](/reference/services/SoftLayer_Workload_Citrix_Workspace_Order)::cancelWorkspaceResources + Cancel the orders associated with resources on the provided VLAN diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/getWorkspaceNames.md b/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/getWorkspaceNames.md index 161798fa08..7561f66795 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/getWorkspaceNames.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/getWorkspaceNames.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Workload_Citrix_Workspace_Order](/reference/services/SoftLayer_Workload_Citrix_Workspace_Order)::getWorkspaceNames + Get a list of all VLAN names which have 'cvad' tags associated with them. diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/getWorkspaceResources.md b/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/getWorkspaceResources.md index 98dd3b6ca1..2be24c41a1 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/getWorkspaceResources.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/getWorkspaceResources.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Workload_Citrix_Workspace_Order](/reference/services/SoftLayer_Workload_Citrix_Workspace_Order)::getWorkspaceResources + List the orders associated with resources on the provided VLAN diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/placeWorkspaceOrder.md b/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/placeWorkspaceOrder.md index e9eceea724..2180d5b9ce 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/placeWorkspaceOrder.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/placeWorkspaceOrder.md @@ -16,6 +16,7 @@ aliases: + ## Overview diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/verifyWorkspaceOrder.md b/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/verifyWorkspaceOrder.md index 06d1a80a2d..aa23a8668f 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/verifyWorkspaceOrder.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/verifyWorkspaceOrder.md @@ -13,6 +13,7 @@ aliases: --- # [SoftLayer_Workload_Citrix_Workspace_Order](/reference/services/SoftLayer_Workload_Citrix_Workspace_Order)::verifyWorkspaceOrder + Verify that an order may be successfully placed with the details provided. diff --git a/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Response/_index.md b/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Response/_index.md index 8626a1ef21..5cab814cce 100644 --- a/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Response/_index.md +++ b/content/reference/services/SoftLayer_Workload_Citrix_Workspace_Response/_index.md @@ -18,6 +18,8 @@ classes: ## Description + + The SoftLayer_Workload_Citrix_Response constructs a response object for [SoftLayer_Workload_Citrix_Order]({{}}).